{"id":109317,"date":"2024-01-25T07:00:00","date_gmt":"2024-01-25T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=109317"},"modified":"2024-01-24T21:33:54","modified_gmt":"2024-01-25T05:33:54","slug":"20240125-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20240125-00\/?p=109317","title":{"rendered":"How can I give away a COM reference just before my object destructs?"},"content":{"rendered":"

Last time, we noted that most implementations of the IMemory\u00adBuffer\u00adReference.Closed<\/code> event are broken<\/a> because they hand out COM references to themselves after C++ has already committed to destructing the object<\/a>, so calling Add\u00adRef()<\/code> on the COM reference doesn’t actually extend the object’s lifetime.<\/p>\n

So how do you raise this Closed<\/code> event when the last reference is released, if releasing the last reference also commits you to destruction?<\/p>\n

More generally, how can I execute some code when the last reference is released, if that code might try to extend the object’s lifetime?<\/p>\n

One solution is to keep track of two different reference counts, one for “client-visible reference counts” and one for “internal reference counts”, and then raise the Closed<\/code> event when the client-visible reference count goes to zero but before the internal reference count also goes to zero. (You would destruct the object when both<\/i> reference counts go to zero.)<\/p>\n

But I’m going to do things a little differently.<\/p>\n

My trick is to have the object call AddRef()<\/code> on itself at construction, so that the object reference count is 2 when it is given to the caller. Since one of those reference counts is artificial, we relize that when the reference count drops to 1, that means that all “client-visible” references have been released. The only thing keeping the object alive is the artificial reference.<\/p>\n

We can now perform that cleanup operation, passing a COM reference to a proper object which is not yet committed to destruction. After the call returns, we release the artificial reference. If the cleanup operation did not attempt to extend the lifetime of the COM reference, then then our release of the artificial reference will drop the reference count to zero, and the object destructs immediately. But if it used AddRef()<\/code> to extend the lifetime, then our release will not drop the reference count to zero, and the object will remain alive. It’s being cleaned up, but still alive.<\/p>\n

Of course, we have to be careful that when the reference count drops to 1 a second<\/i> time, we don’t get confused and try to clean up a second time and (worse) release the nonexistent artifical reference.<\/p>\n

Here’s how you could implement this pattern in various COM frameworks.<\/p>\n

We start with WRL, which has no real surprises.<\/p>\n

\/\/ C++\/WRL\r\n\r\nstruct ObjectWithSpecialCleanup :\r\n    RuntimeClass<IWhatever>\r\n{\r\n    ObjectWithSpecialCleanup()\r\n    {\r\n        \/\/ WRL does not support aggregation,\r\n        \/\/ so don't need to assert \"not aggregating\"\r\n        InternalAddRef();\r\n    }\r\n\r\n    STDMETHOD_(ULONG, Release)() override\r\n    {\r\n        auto count = RuntimeClass::Release();\r\n\r\n        if (count == 1) {\r\n            if (!m_cleanupStarted.exchange(true, std::memory_order_relaxed)) {\r\n                DoCleanup(this); \/* Might AddRef this object *\/\r\n                count = RuntimeClass::Release();\r\n            }\r\n        }\r\n\r\n        return count;\r\n    }\r\n\r\n    \u27e6 ... \u27e7\r\n\r\n    std::atomic<bool> m_cleanupStarted;\r\n};\r\n<\/pre>\n
Next comes C++\/WinRT:<\/p>\n
\/\/ C++\/WinRT\r\n\r\nstruct ObjectWithSpecialCleanup :\r\n    implements<ObjectWithSpecialCleanup,\r\n               IWhatever>\r\n{\r\n    static_assert(!outer()<\/a>, \"Must not be composable\");\r\n\r\n    ObjectWithSpecialCleanup()\r\n    {\r\n        NonDelegatingAddRef();\r\n    }\r\n\r\n    decltype(std::declval<implements>().Release())\r\n    __stdcall Release() noexcept override\r\n    {\r\n        auto count = NonDelegatingRelease();\r\n\r\n        if (count == 1) {\r\n            if (!m_cleanupStarted.exchange(true, std::memory_order_relaxed)) {\r\n                DoCleanup(this); \/* Might AddRef this object *\/\r\n                count = NonDelegatingRelease();\r\n            }\r\n        }\r\n\r\n        return count;\r\n    }\r\n\r\n    \u27e6 ... \u27e7\r\n\r\n    std::atomic<bool> m_cleanupStarted;\r\n};\r\n<\/pre>\n
In C++\/WinRT, we use the trick we learned a little while ago to  ensure that the C++\/WinRT implementation class is not aggregated<\/a>.<\/p>\n
The biggest pain point is figuring out the correct return value for the overridden Release<\/code> method. The return type depends on whether classic COM interop has been enabled in C++\/WinRT. If so, then the return value of Release()<\/code> needs to be ULONG<\/code>, to match the classic COM Release()<\/code> method. But if not, then the return value needs to be uint32_t<\/code>, to match the C++\/WinRT version. We solve the problem by simply looking at the method we are trying to override and saying that we return whatever that guy returns.<\/p>\n
Next up is manual implementation.<\/p>\n
\/\/ Manually implemented\r\nstruct MyPage : IPage\r\n{\r\n    MyPage()\r\n        \/\/ Bonus refcount is released when count drops to 1\r\n        : m_refCount(2) { }\r\n\r\n    STDMETHOD_(ULONG, Release)() override\r\n    {\r\n        auto count = InterlockedDecrement(&m_refCount);\r\n\r\n        if (count == 1) {\r\n            if (!m_cleanupStarted.exchange(true, std::memory_order_relaxed)) {\r\n                DoCleanup(this); \/* Might AddRef this object *\/\r\n                count = InterlockedDecrement(&m_refCount);\r\n            }\r\n        }\r\n\r\n        return count;\r\n    }\r\n\r\n    LONG m_refCount;\r\n    std::atomic<bool> m_cleanupStarted;\r\n    \u27e6 ... \u27e7\r\n};\r\n<\/pre>\n
The sneaky part here is that instead of incrementing the reference count in the body of the constructor, we just combine the extra reference count into the initial value.<\/p>\n
The final example is ATL.<\/p>\n
\/\/ ATL\r\nclass ObjectWithSpecialCleanup :\r\n    public CComObjectRootEx<CComMultiThreadModel>,\r\n    public CComCoClass<ObjectWithSpecialCleanup>,\r\n    public IWhatever\r\n{\r\npublic:\r\n    \/\/ Prevent this class from being aggregated<\/a>\r\n    static constexpr void* m_pOuterUnknown = nullptr;\r\n\r\n    BEGIN_COM_MAP(Widget)\r\n        COM_INTERFACE_ENTRY(IAgileObject)\r\n    END_COM_MAP()\r\n\r\n    \/\/ NOTE! Requires creation via two-phase initialization<\/a>\r\n    HRESULT InitializeComponent() noexcept\r\n    {\r\n        InternalAddRef();\r\n        m_cleanupNeeded.store(true, std::memory_order_relaxed);\r\n        return S_OK;\r\n    }\r\n\r\n    ULONG InternalRelease()\r\n    {\r\n        auto count = CComObjectRootEx::InternalRelease();\r\n\r\n        if (count == 1) {\r\n            if (m_cleanupNeeded.exchange(false, std::memory_order_relaxed)) {\r\n                DoCleanup(this); \/* Might AddRef this object *\/\r\n                count = CComObjectRootEx::InternalRelease();\r\n            }\r\n        }\r\n\r\n        return count;\r\n    }\r\n\r\n    std::atomic<bool> m_cleanupNeeded;\r\n    \u27e6 ... \u27e7\r\n};\r\n\r\n<\/pre>\n
ATL is the outlier.<\/p>\n
For ATL, we need to use two-phase initialization (which we learned how to do a little while ago<\/a>) because we are not allowed to fiddle with the reference count in the constructor or in the optional FinalConstruct()<\/code> method. We mark the object as needing cleanup only if we make it to the second phase. The sense of the flag is reversed for ATL because it starts out not needing cleanup, and gains the cleanup requirement later. The other libraries don’t have this “nascent state” where the object is constructed but not yet ready.\u00b9<\/p>\n
The memory order for the atomic accesses to the cleanup flag is relaxed because we are counting on the object to protect its own internal state from multithreaded access when necessary.<\/p>\n
\u00b9 ATL uses the policy that objects are created with a reference count of zero, rather than one. This may have made sense at the time, but it creates complications when you write code that runs during this dangerous “zero-refcount” period.<\/p>\n","protected":false},"excerpt":{"rendered":"
You have to do it before committing to destruction.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-109317","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
You have to do it before committing to destruction.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109317","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=109317"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109317\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=109317"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=109317"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=109317"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}