Windows防火墙C++ API——如何正确清理COM资源?

Windows防火墙C++ API——如何正确清理COM资源?,c++,winapi,com,windows-firewall,windows-firewall-api,C++,Winapi,Com,Windows Firewall,Windows Firewall Api,我试图使用基于COM的Windows防火墙API来遍历现有的防火墙规则,并找出其中是否存在一个特定的规则 目前,我很难理解本示例的清理部分中发生了什么: pFwRule指针在每次迭代时都会被覆盖,因此这里我们只显式地释放上面while循环中通过QueryInterface获得的最后一条规则 释放从成功调用QueryInterface获得的指针是合乎逻辑的,因为QueryInterface在返回之前调用AddRef,这在文档中有明确说明 但我无法理解的是: 为什么我们不在查询循环中的下一个规则之前

我试图使用基于COM的Windows防火墙API来遍历现有的防火墙规则,并找出其中是否存在一个特定的规则

目前,我很难理解本示例的清理部分中发生了什么:

pFwRule指针在每次迭代时都会被覆盖,因此这里我们只显式地释放上面while循环中通过QueryInterface获得的最后一条规则

释放从成功调用QueryInterface获得的指针是合乎逻辑的,因为QueryInterface在返回之前调用AddRef,这在文档中有明确说明

但我无法理解的是:

为什么我们不在查询循环中的下一个规则之前释放所有先前遍历的规则?他们是否在某个地方被秘密释放了?QueryInterface调用是否在向其传递非空指针时释放undercover

我们为什么不叫pFwRules释放?INetFwPolicy2::get_Rules函数不是给了我们一个指向COM对象的新指针吗?它在返回给我们之前是AddRef'ed的,因此最终必须由调用方释放

关于从get_uuNewEnum获得的pEnumerator指针的相同问题:我们为什么不同时发布这个指针

代码确实在泄漏COM内存。 对接口的AddRef方法的每个调用都必须有对其Release方法的匹配调用。任何输出接口指针的函数调用都必须在退出前对其调用AddRef,然后调用方必须在退出后对其调用Release

一般规则是,对于向调用者分配和返回内存的任何函数,调用者必须在使用完内存后释放内存

因此,要回答您的问题:

是的,这段代码中缺少要释放的调用,因此有COM接口被泄漏——特别是:pFwRules、pEnumerator和pFwRule没有被正确释放

DumpFWRulesInCollection也正在泄漏COM内存。它不会释放FwRule方法输出的任何BSTR字符串。 而且,当它在循环中调用SafeArrayGetElement时,并没有清除每次迭代的接口限制

否,QueryInterface不会隐式释放非空指针。正如SafeArrayGetElement不会清除要写入的元素一样

代码确实在泄漏COM内存。 对接口的AddRef方法的每个调用都必须有对其Release方法的匹配调用。任何输出接口指针的函数调用都必须在退出前对其调用AddRef,然后调用方必须在退出后对其调用Release

一般规则是,对于向调用者分配和返回内存的任何函数,调用者必须在使用完内存后释放内存

因此,要回答您的问题:

是的,这段代码中缺少要释放的调用,因此有COM接口被泄漏——特别是:pFwRules、pEnumerator和pFwRule没有被正确释放

DumpFWRulesInCollection也正在泄漏COM内存。它不会释放FwRule方法输出的任何BSTR字符串。 而且,当它在循环中调用SafeArrayGetElement时,并没有清除每次迭代的接口限制

否,QueryInterface不会隐式释放非空指针。正如SafeArrayGetElement不会清除要写入的元素一样


在研究示例代码时感到困惑是合理的反应。它确实泄漏了资源

为什么我们不在查询循环中的下一个规则之前释放所有先前遍历的规则?他们是否在某个地方被秘密释放了?QueryInterface调用是否在向其传递非空指针时释放undercover

否。如果COM对象未实现请求的接口,则QueryInterface会使用空指针或指向请求接口的指针,无条件地覆盖其PPVOObject参数指向的值。不调用Release是一种资源泄漏

我们为什么不叫pFwRules释放?INetFwPolicy2::get_Rules函数不是给了我们一个指向COM对象的新指针吗?它在返回给我们之前是AddRef'ed的,因此最终必须由调用方释放

请再说一遍。get_规则返回调用者负责的资源。不在返回的接口上调用Release是一种资源泄漏

关于从get_uuNewEnum获得的pEnumerator指针的相同问题:我们为什么不同时发布这个指针

同样的规则也适用于这里:调用方负责清理它接收到的迭代器。这也是一种资源泄漏

MSDN示例的特别注释:虽然它们是C++标记,但COM的大多数代码示例实际上是用C编写的。与C++不同,C在自动资源管理方面没有多少可提供的。

如果你使用C++,你可以利用自动重新配置。


资源管理,并使用其中一种提供的智能指针类型,例如ATL或Visual C++。

在研究示例代码时感到困惑是合理的反应。它确实泄漏了资源

为什么我们不在查询循环中的下一个规则之前释放所有先前遍历的规则?他们是否在某个地方被秘密释放了?QueryInterface调用是否在向其传递非空指针时释放undercover

否。如果COM对象未实现请求的接口,则QueryInterface会使用空指针或指向请求接口的指针,无条件地覆盖其PPVOObject参数指向的值。不调用Release是一种资源泄漏

我们为什么不叫pFwRules释放?INetFwPolicy2::get_Rules函数不是给了我们一个指向COM对象的新指针吗?它在返回给我们之前是AddRef'ed的,因此最终必须由调用方释放

请再说一遍。get_规则返回调用者负责的资源。不在返回的接口上调用Release是一种资源泄漏

关于从get_uuNewEnum获得的pEnumerator指针的相同问题:我们为什么不同时发布这个指针

同样的规则也适用于这里:调用方负责清理它接收到的迭代器。这也是一种资源泄漏

MSDN示例的特别注释:虽然它们是C++标记,但COM的大多数代码示例实际上是用C编写的。与C++不同,C在自动资源管理方面没有多少可提供的。


如果使用C++,可以利用自动资源管理,并使用提供的智能指针类型之一,例如ATL的或Visual C++。需要调用pFwRule->Release;查询接口后的内部循环正常。需要PuimeRealth->释放调用,但我使用C++包装器,它释放接口指针。不。混合的危险。如果有什么安慰的话,解决这个问题和其他问题。看起来像是泄漏。是的,示例中包含错误。需要调用pFwRule->Release;查询接口后的内部循环正常。需要PuimeRealth->释放调用,但我使用C++包装器,它释放接口指针。不。混合的危险。如果它是任何安慰,来解决这个问题和其他问题。如果你使用C++,你可以利用自动资源管理,并使用一个提供的智能指针类型-这是有趣的,因为这个微软例子确实使用了一些智能变体包装器CCOMVALVIEW和VALIANTYT,因此,它显然是被编译为C++,但是它不能有效地或正确地使用它们,以避免泄漏。是的,没有智能接口包装器被使用。如果你使用C++,你可以利用自动资源管理,并使用一个提供的智能指针类型-这是有趣的,因为这个微软例子确实使用了一些智能变体包装器CCOMVALVY和VALIANTYT,因此,它显然是被编译为C++,但是它不能有效地或正确地使用它们,以避免泄漏。是的,根本没有使用智能界面包装器。

/********************************************************************++
Copyright (C) Microsoft. All Rights Reserved.

Abstract:
    This C++ file includes sample code for enumerating Windows Firewall
    rules using the Microsoft Windows Firewall APIs.

********************************************************************/

#include <windows.h>
#include <stdio.h>
#include <comutil.h>
#include <atlcomcli.h>
#include <netfw.h>

#pragma comment( lib, "ole32.lib" )
#pragma comment( lib, "oleaut32.lib" )

#define NET_FW_IP_PROTOCOL_TCP_NAME L"TCP"
#define NET_FW_IP_PROTOCOL_UDP_NAME L"UDP"

#define NET_FW_RULE_DIR_IN_NAME L"In"
#define NET_FW_RULE_DIR_OUT_NAME L"Out"

#define NET_FW_RULE_ACTION_BLOCK_NAME L"Block"
#define NET_FW_RULE_ACTION_ALLOW_NAME L"Allow"

#define NET_FW_RULE_ENABLE_IN_NAME L"TRUE"
#define NET_FW_RULE_DISABLE_IN_NAME L"FALSE"


// Forward declarations
void        DumpFWRulesInCollection(INetFwRule* FwRule);
HRESULT     WFCOMInitialize(INetFwPolicy2** ppNetFwPolicy2);


int __cdecl main()
{
    HRESULT hrComInit = S_OK;
    HRESULT hr = S_OK;

    ULONG cFetched = 0; 
    CComVariant var;

    IUnknown *pEnumerator;
    IEnumVARIANT* pVariant = NULL;

    INetFwPolicy2 *pNetFwPolicy2 = NULL;
    INetFwRules *pFwRules = NULL;
    INetFwRule *pFwRule = NULL;

    long fwRuleCount;

    // Initialize COM.
    hrComInit = CoInitializeEx(
                    0,
                    COINIT_APARTMENTTHREADED
                    );

    // Ignore RPC_E_CHANGED_MODE; this just means that COM has already been
    // initialized with a different mode. Since we don't care what the mode is,
    // we'll just use the existing mode.
    if (hrComInit != RPC_E_CHANGED_MODE)
    {
        if (FAILED(hrComInit))
        {
            wprintf(L"CoInitializeEx failed: 0x%08lx\n", hrComInit);
            goto Cleanup;
        }
    }

    // Retrieve INetFwPolicy2
    hr = WFCOMInitialize(&pNetFwPolicy2);
    if (FAILED(hr))
    {
        goto Cleanup;
    }

    // Retrieve INetFwRules
    hr = pNetFwPolicy2->get_Rules(&pFwRules);
    if (FAILED(hr))
    {
        wprintf(L"get_Rules failed: 0x%08lx\n", hr);
        goto Cleanup;
    }

    // Obtain the number of Firewall rules
    hr = pFwRules->get_Count(&fwRuleCount);
    if (FAILED(hr))
    {
        wprintf(L"get_Count failed: 0x%08lx\n", hr);
        goto Cleanup;
    }

    wprintf(L"The number of rules in the Windows Firewall are %d\n", fwRuleCount);

    // Iterate through all of the rules in pFwRules
    pFwRules->get__NewEnum(&pEnumerator);

    if(pEnumerator)
    {
        hr = pEnumerator->QueryInterface(__uuidof(IEnumVARIANT), (void **) &pVariant);
    }

    while(SUCCEEDED(hr) && hr != S_FALSE)
    {
        var.Clear();
        hr = pVariant->Next(1, &var, &cFetched);

        if (S_FALSE != hr)
        {
            if (SUCCEEDED(hr))
            {
                hr = var.ChangeType(VT_DISPATCH);
            }
            if (SUCCEEDED(hr))
            {
                hr = (V_DISPATCH(&var))->QueryInterface(__uuidof(INetFwRule), reinterpret_cast<void**>(&pFwRule));
            }

            if (SUCCEEDED(hr))
            {
                // Output the properties of this rule
                DumpFWRulesInCollection(pFwRule);
            }
        }
    }

Cleanup:

    // Release pFwRule
    if (pFwRule != NULL)
    {
        pFwRule->Release();
    }

    // Release INetFwPolicy2
    if (pNetFwPolicy2 != NULL)
    {
        pNetFwPolicy2->Release();
    }

    // Uninitialize COM.
    if (SUCCEEDED(hrComInit))
    {
        CoUninitialize();
    }

    return 0;
}


// Output properties of a Firewall rule 
void DumpFWRulesInCollection(INetFwRule* FwRule)
{
    variant_t InterfaceArray;
    variant_t InterfaceString;  

    VARIANT_BOOL bEnabled;
    BSTR bstrVal;

    long lVal = 0;
    long lProfileBitmask = 0;

    NET_FW_RULE_DIRECTION fwDirection;
    NET_FW_ACTION fwAction;

    struct ProfileMapElement 
    {
        NET_FW_PROFILE_TYPE2 Id;
        LPCWSTR Name;
    };

    ProfileMapElement ProfileMap[3];
    ProfileMap[0].Id = NET_FW_PROFILE2_DOMAIN;
    ProfileMap[0].Name = L"Domain";
    ProfileMap[1].Id = NET_FW_PROFILE2_PRIVATE;
    ProfileMap[1].Name = L"Private";
    ProfileMap[2].Id = NET_FW_PROFILE2_PUBLIC;
    ProfileMap[2].Name = L"Public";

    wprintf(L"---------------------------------------------\n");

    if (SUCCEEDED(FwRule->get_Name(&bstrVal)))
    {
        wprintf(L"Name:             %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_Description(&bstrVal)))
    {
        wprintf(L"Description:      %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_ApplicationName(&bstrVal)))
    {
        wprintf(L"Application Name: %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_ServiceName(&bstrVal)))
    {
        wprintf(L"Service Name:     %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_Protocol(&lVal)))
    {
        switch(lVal)
        {
            case NET_FW_IP_PROTOCOL_TCP: 

                wprintf(L"IP Protocol:      %s\n", NET_FW_IP_PROTOCOL_TCP_NAME);
                break;

            case NET_FW_IP_PROTOCOL_UDP: 

                wprintf(L"IP Protocol:      %s\n", NET_FW_IP_PROTOCOL_UDP_NAME);
                break;

            default:

                break;
        }

        if(lVal != NET_FW_IP_VERSION_V4 && lVal != NET_FW_IP_VERSION_V6)
        {
            if (SUCCEEDED(FwRule->get_LocalPorts(&bstrVal)))
            {
                wprintf(L"Local Ports:      %s\n", bstrVal);
            }

            if (SUCCEEDED(FwRule->get_RemotePorts(&bstrVal)))
            {
                wprintf(L"Remote Ports:      %s\n", bstrVal);
            }
        }
        else
        {
            if (SUCCEEDED(FwRule->get_IcmpTypesAndCodes(&bstrVal)))
            {
                wprintf(L"ICMP TypeCode:      %s\n", bstrVal);
            }
        }
    }

    if (SUCCEEDED(FwRule->get_LocalAddresses(&bstrVal)))
    {
        wprintf(L"LocalAddresses:   %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_RemoteAddresses(&bstrVal)))
    {
        wprintf(L"RemoteAddresses:  %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_Profiles(&lProfileBitmask)))
    {
        // The returned bitmask can have more than 1 bit set if multiple profiles 
        //   are active or current at the same time

        for (int i=0; i<3; i++)
        {
            if ( lProfileBitmask & ProfileMap[i].Id  )
            {
                wprintf(L"Profile:  %s\n", ProfileMap[i].Name);
            }
        }
    }

    if (SUCCEEDED(FwRule->get_Direction(&fwDirection)))
    {
        switch(fwDirection)
        {
            case NET_FW_RULE_DIR_IN:

                wprintf(L"Direction:        %s\n", NET_FW_RULE_DIR_IN_NAME);
                break;

            case NET_FW_RULE_DIR_OUT:

                wprintf(L"Direction:        %s\n", NET_FW_RULE_DIR_OUT_NAME);
                break;

            default:

                break;
        }
    }

    if (SUCCEEDED(FwRule->get_Action(&fwAction)))
    {
        switch(fwAction)
        {
            case NET_FW_ACTION_BLOCK:

                wprintf(L"Action:           %s\n", NET_FW_RULE_ACTION_BLOCK_NAME);
                break;

            case NET_FW_ACTION_ALLOW:

                wprintf(L"Action:           %s\n", NET_FW_RULE_ACTION_ALLOW_NAME);
                break;

            default:

                break;
        }
    }

    if (SUCCEEDED(FwRule->get_Interfaces(&InterfaceArray)))
    {
        if(InterfaceArray.vt != VT_EMPTY)
        {
            SAFEARRAY    *pSa = NULL;

            pSa = InterfaceArray.parray;

            for(long index= pSa->rgsabound->lLbound; index < (long)pSa->rgsabound->cElements; index++)
            {
                SafeArrayGetElement(pSa, &index, &InterfaceString);
                wprintf(L"Interfaces:       %s\n", (BSTR)InterfaceString.bstrVal);
            }
        }
    }

    if (SUCCEEDED(FwRule->get_InterfaceTypes(&bstrVal)))
    {
        wprintf(L"Interface Types:  %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_Enabled(&bEnabled)))
    {
        if (bEnabled)
        {
            wprintf(L"Enabled:          %s\n", NET_FW_RULE_ENABLE_IN_NAME);
        }
        else
        {
            wprintf(L"Enabled:          %s\n", NET_FW_RULE_DISABLE_IN_NAME);
        }
    }

    if (SUCCEEDED(FwRule->get_Grouping(&bstrVal)))
    {
        wprintf(L"Grouping:         %s\n", bstrVal);
    }

    if (SUCCEEDED(FwRule->get_EdgeTraversal(&bEnabled)))
    {
        if (bEnabled)
        {
            wprintf(L"Edge Traversal:   %s\n", NET_FW_RULE_ENABLE_IN_NAME);
        }
        else
        {
            wprintf(L"Edge Traversal:   %s\n", NET_FW_RULE_DISABLE_IN_NAME);
        }
    }
}


// Instantiate INetFwPolicy2
HRESULT WFCOMInitialize(INetFwPolicy2** ppNetFwPolicy2)
{
    HRESULT hr = S_OK;

    hr = CoCreateInstance(
        __uuidof(NetFwPolicy2), 
        NULL, 
        CLSCTX_INPROC_SERVER, 
        __uuidof(INetFwPolicy2), 
        (void**)ppNetFwPolicy2);

    if (FAILED(hr))
    {
        wprintf(L"CoCreateInstance for INetFwPolicy2 failed: 0x%08lx\n", hr);
        goto Cleanup;        
    }

Cleanup:
    return hr;
}
    // Release pFwRule
    if (pFwRule != NULL)
    {
        pFwRule->Release();
    }