从C#COM dll到Delphi应用程序的回调会导致内存泄漏

时间:2014-01-23 23:33:19

标签: c# delphi memory-leaks com idispatch

我有一个用C#编写的COM服务器,以及用Delphi编写的COM客户端。我已经实现了一个简单而优雅的回调机制,它就像一个魅力。但是,FastMM4报告我的Delphi客户端正在创建内存泄漏。我已经将应用程序提炼到泄漏源自的本质。我的漏洞是由对象被引用计数的方式引起的(它永远不会变为零,所以永远不会被破坏),所以我试图理解为什么引用计数的工作原理是这样的,并且是因为我在实施中做错了。

我已经尽可能地减少了代码,但是在问题中包含它似乎仍然很多。但我真的不知道怎么解释我在做什么。我有两个项目(C#和Delphi)在一个zip文件中整理得很好而且整洁,但似乎我无法将它附加到任何地方。

我在C#端(ICOMCallbackContainerICOMCallbackTestServer)声明了两个接口,并在那里实现其中一个接口(COMCallbackTestServer)。我正在Delphi端实现其他接口(TCOMCallbackContainer)并将Delphi类传递给C#类。

这是C#COM服务器:

namespace COMCallbackTest
{
    [ComVisible(true)]
    [Guid("2AB7E954-0AAF-4CFE-844C-756E50FE6360")]
    public interface ICOMCallbackContainer
    {
        void Callback(string message);
    }

    [ComVisible(true)]
    [Guid("7717D7AE-B763-48BC-BA0B-0F3525BEE8A4")]
    public interface ICOMCallbackTestServer
    {
        ICOMCallbackContainer CallbackContainer { get; set; }
        void RunCOMProcess();
        void Dispose();
    }

    [ComVisible(true)]
    [Guid("CF33E3A7-0886-4A0D-A740-537D0640C641")]
    public class COMCallbackTestServer : ICOMCallbackTestServer
    {
        ICOMCallbackContainer _callbackContainer;

        ICOMCallbackContainer ICOMCallbackTestServer.CallbackContainer
        {
            get { return _callbackContainer; }
            set { _callbackContainer = value; }
        }

        void ICOMCallbackTestServer.RunCOMProcess()
        {
            if (_callbackContainer != null)
            {
                _callbackContainer.Callback("Step One");
                _callbackContainer.Callback("Step Two");
                _callbackContainer.Callback("Step Three");
            }
        }

        void ICOMCallbackTestServer.Dispose()
        {
            if (_callbackContainer != null)
                _callbackContainer.Callback("Done");
        }
    }
}

这是Delphi CallbackContainer:

type
  TCOMCallbackMethod = reference to procedure(AMessage: string);

  TCOMCallbackContainer = class(TAutoIntfObject, ICOMCallbackContainer)
  private
    FCallbackMethod: TCOMCallbackMethod;
    procedure Callback(const message: WideString); safecall;
  public
    constructor Create(ACallbackMethod: TCOMCallbackMethod);
    destructor Destroy; override;
  end;

//  ...

constructor TCOMCallbackContainer.Create(ACallbackMethod: TCOMCallbackMethod);
var
  typeLib: ITypeLib;
begin
  OleCheck(LoadRegTypeLib(LIBID_COMCallbackTestServer,
                          COMCallbackTestServerMajorVersion,
                          COMCallbackTestServerMinorVersion,
                          0,
                          {out} typeLib));
  inherited Create(typeLib, ICOMCallbackContainer);
  FCallbackMethod := ACallbackMethod;
end;

destructor TCOMCallbackContainer.Destroy;
begin
  FCallbackMethod := nil;

  inherited Destroy;
end;

procedure TCOMCallbackContainer.Callback(const message: WideString);
begin
  if Assigned(FCallbackMethod) then
    FCallbackMethod(message);
end;

TCOMCallbackContainer继承自TAutoIntfObject,因此它实现了IDispatch。我不知道我是否在构造函数中做正确的事情。我不像我想的那样熟悉如何使用IDispatch。

这是Delphi COM客户端:

procedure TfrmMain.FormCreate(Sender: TObject);
begin
  FServer := CoCOMCallbackTestServer_.Create as ICOMCallbackTestServer;

  //  Increments RefCount by 2, expected 1
  FServer.CallbackContainer := TCOMCallbackContainer.Create(Process_Callback);
end;

procedure TfrmMain.FormDestroy(Sender: TObject);
begin
  //  Decrements RefCount by 0, expected 1
  FServer.CallbackContainer := nil;

  FServer.Dispose;
  FServer := nil;
end;

procedure TfrmMain.btnBeginProcessClick(Sender: TObject);
begin
  FServer.RunCOMProcess;
end;

procedure TfrmMain.Process_Callback(AMessage: string);
begin
  mmoProcessMessages.Lines.Add(AMessage);
end;

上面的TCOMCallbackContainer实例永远不会被销毁,因为RefCount永远不会低于2。

所以我的问题是,为什么将我的回调容器对象分配给COM属性会将引用计数增加2,为什么将nil赋值给COM属性根本不会减少引用计数?

修改

我创建了TMyInterfacedObject(与TInterfacedObject相同)并将其用作TCOMCallbackContainer的基类。我在TMyInterfacedObject的每个方法中加入了断点。在每个断点处,我记录了调用堆栈(以及其他一些信息)。对于更新RefCount的每个方法,该行末尾的数字显示RefCount的新值。对于QueryInterface,我包含了IID和相应的接口名称(通过Google找到)和调用结果。

TfrmMain.FormCreate -> TCOMCallbackContainer.Create -> TInterfacedObject.NewInstance:  1
TfrmMain.FormCreate -> TCOMCallbackContainer.Create -> TInterfacedObject.AfterConstruction:  0
CLR -> TInterfacedObject.QueryInterface("00000000-0000-0000-C000-000000000046" {IUnknown}):  S_OK
CLR -> TInterfacedObject.QueryInterface -> TObject.GetInterface -> _AddRef:  1
CLR -> TInterfacedObject.QueryInterface("C3FCC19E-A970-11D2-8B5A-00A0C9B7C9C4" {IManagedObject}):  E_NOINTERFACE
CLR -> TInterfacedObject.QueryInterface("B196B283-BAB4-101A-B69C-00AA00341D07" {IProvideClassInfo}):  E_NOINTERFACE
CLR -> TInterfacedObject._AddRef:  2
CLR -> TInterfacedObject.QueryInterface("ECC8691B-C1DB-4DC0-855E-65F6C551AF49" {INoMarshal}):  E_NOINTERFACE
CLR -> TInterfacedObject.QueryInterface("94EA2B94-E9CC-49E0-C0FF-EE64CA8F5B90" {IAgileObject}):  E_NOINTERFACE
CLR -> TInterfacedObject.QueryInterface("00000003-0000-0000-C000-000000000046" {IMarshal}):  E_NOINTERFACE
CLR -> TInterfacedObject.QueryInterface("00000144-0000-0000-C000-000000000046" {IRpcOptions}):  E_NOINTERFACE
CLR -> TInterfacedObject._Release:  1
CLR -> TInterfacedObject.QueryInterface("2AB7E954-0AAF-4CFE-844C-756E50FE6360" {ICOMCallbackContainer}):  S_OK
CLR -> TInterfacedObject.QueryInterface -> TObject.GetInterface -> _AddRef:  2
CLR -> TInterfacedObject._AddRef:  3
CLR -> TInterfacedObject._Release:  2

列出的所有断点都发生在TfrmMain.Create中的FServer.CallbackContainer := TCOMCallbackContainer.Create(Process_Callback);语句中。在Destroy方法中,特别是在FServer.CallbackContainer := nil;语句中,没有任何断点被击中。

我想,也许是在调用析构函数之前可能正在卸载COM库,所以我将FServer.CallbackContainer := nil;行复制到构造函数的末尾。它没有任何区别。

传递给QueryInterface的调用的接口似乎在Delphi环境中不可用,所以我将尝试将其中一些继承到C#端的ICOMCallbackContainer中以使它们可用(在研究它们是什么之后)应该这样做以及他们应该如何工作。

编辑2

我尝试实现INoMarshal和IAgileObject只是为了看看会发生什么。我尝试了这两个,因为它们都是标记接口,实际上没有任何实现。它改变了一点过程,但没有任何帮助。似乎如果CLR找到了INoMarshal,那么它不会查找IAgileObject或IMarshal,如果它找不到INoMarshal,但是找到了IAgileObject,那么它就不会查找IMarshal。 (这并不重要,甚至对我有意义。)

将INoMarshal添加到TCOMCallbackContainer后:

...
CLR -> TInterfacedObject._AddRef:  2
CLR -> TInterfacedObject.QueryInterface(INoMarshal):  S_OK
CLR -> TInterfacedObject.QueryInterface -> TObject.GetInterface -> _AddRef:  3
CLR -> TInterfacedObject._Release:  2
CLR -> TInterfacedObject.QueryInterface(IRpcOptions):  E_NOINTERFACE
CLR -> TInterfacedObject._Release:  1
...

将IAgileObject添加到TCOMCallbackContainer:

...
CLR -> TInterfacedObject._AddRef:  2
CLR -> TInterfacedObject.QueryInterface(INoMarshal):  E_NOINTERFACE
CLR -> TInterfacedObject.QueryInterface(IAgileObject):  S_OK
CLR -> TInterfacedObject.QueryInterface -> TObject.GetInterface -> _AddRef:  3
CLR -> TInterfacedObject._Release:  2
CLR -> TInterfacedObject.QueryInterface(IRpcOptions):  E_NOINTERFACE
CLR -> TInterfacedObject._Release:  1
...

1 个答案:

答案 0 :(得分:4)

在托管代码中,外部COM接口被包装到Runtime Callable Wrapper(RCW)中。与原始COM接口不同,RCW生命周期由不使用引用计数的垃圾收集器确定。在您的特定情况下,这意味着对null的赋值不会立即减少refCount。

可以通过显式调用Marshal.ReleaseComObject强制COM对象引用版本:

     ICOMCallbackContainer ICOMCallbackTestServer.CallbackContainer
    {
        get { return _callbackContainer; }
        set { 

            if (_callbackContainer != null)
            {
                  Marshal.ReleaseComObject(_callbackContainer); // calls IUnknown.Release()
                  _callbackContainer = null;
            }

            _callbackContainer = value;
        }
    }