2 * A stub manager is an object that controls interface stubs. It is
3 * identified by an OID (object identifier) and acts as the network
4 * identity of the object. There can be many stub managers in a
5 * process or apartment.
7 * Copyright 2002 Marcus Meissner
8 * Copyright 2004 Mike Hearn for CodeWeavers
9 * Copyright 2004 Robert Shearman (for CodeWeavers)
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
27 #define NONAMELESSUNION
28 #define NONAMELESSSTRUCT
40 #include "wine/debug.h"
41 #include "compobj_private.h"
43 WINE_DEFAULT_DEBUG_CHANNEL(ole);
45 static void stub_manager_delete_ifstub(struct stub_manager *m, struct ifstub *ifstub);
46 static struct ifstub *stub_manager_ipid_to_ifstub(struct stub_manager *m, const IPID *ipid);
48 /* creates a new stub manager and adds it into the apartment. caller must
49 * release stub manager when it is no longer required. the apartment and
50 * external refs together take one implicit ref */
51 struct stub_manager *new_stub_manager(APARTMENT *apt, IUnknown *object)
53 struct stub_manager *sm;
57 sm = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct stub_manager));
60 list_init(&sm->ifstubs);
62 InitializeCriticalSection(&sm->lock);
63 DEBUG_SET_CRITSEC_NAME(&sm->lock, "stub_manager");
65 IUnknown_AddRef(object);
69 /* start off with 2 references because the stub is in the apartment
70 * and the caller will also hold a reference */
73 /* yes, that's right, this starts at zero. that's zero EXTERNAL
74 * refs, ie nobody has unmarshalled anything yet. we can't have
75 * negative refs because the stub manager cannot be explicitly
76 * killed, it has to die by somebody unmarshalling then releasing
77 * the marshalled ifptr.
81 EnterCriticalSection(&apt->cs);
82 sm->oid = apt->oidc++;
83 list_add_head(&apt->stubmgrs, &sm->entry);
84 LeaveCriticalSection(&apt->cs);
86 TRACE("Created new stub manager (oid=%s) at %p for object with IUnknown %p\n", wine_dbgstr_longlong(sm->oid), sm, object);
91 /* caller must remove stub manager from apartment prior to calling this function */
92 static void stub_manager_delete(struct stub_manager *m)
96 TRACE("destroying %p (oid=%s)\n", m, wine_dbgstr_longlong(m->oid));
98 /* release every ifstub */
99 while ((cursor = list_head(&m->ifstubs)))
101 struct ifstub *ifstub = LIST_ENTRY(cursor, struct ifstub, entry);
102 stub_manager_delete_ifstub(m, ifstub);
105 IUnknown_Release(m->object);
107 DEBUG_CLEAR_CRITSEC_NAME(&m->lock);
108 DeleteCriticalSection(&m->lock);
110 HeapFree(GetProcessHeap(), 0, m);
113 /* gets the stub manager associated with an object - caller must have
114 * a reference to the apartment while a reference to the stub manager is held.
115 * it must also call release on the stub manager when it is no longer needed */
116 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, void *object)
118 struct stub_manager *result = NULL;
121 EnterCriticalSection(&apt->cs);
122 LIST_FOR_EACH( cursor, &apt->stubmgrs )
124 struct stub_manager *m = LIST_ENTRY( cursor, struct stub_manager, entry );
126 if (m->object == object)
129 stub_manager_int_addref(result);
133 LeaveCriticalSection(&apt->cs);
136 TRACE("found %p for object %p\n", result, object);
138 TRACE("not found for object %p\n", object);
143 /* removes the apartment reference to an object, destroying it when no other
144 * threads have a reference to it */
145 void apartment_disconnectobject(struct apartment *apt, void *object)
148 struct stub_manager *stubmgr;
150 EnterCriticalSection(&apt->cs);
151 LIST_FOR_EACH_ENTRY( stubmgr, &apt->stubmgrs, struct stub_manager, entry )
153 if (stubmgr->object == object)
156 stub_manager_int_release(stubmgr);
160 LeaveCriticalSection(&apt->cs);
163 TRACE("disconnect object %p\n", object);
165 WARN("couldn't find object %p\n", object);
168 /* gets the stub manager associated with an object id - caller must have
169 * a reference to the apartment while a reference to the stub manager is held.
170 * it must also call release on the stub manager when it is no longer needed */
171 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid)
173 struct stub_manager *result = NULL;
176 EnterCriticalSection(&apt->cs);
177 LIST_FOR_EACH( cursor, &apt->stubmgrs )
179 struct stub_manager *m = LIST_ENTRY( cursor, struct stub_manager, entry );
184 stub_manager_int_addref(result);
188 LeaveCriticalSection(&apt->cs);
191 TRACE("found %p for oid %s\n", result, wine_dbgstr_longlong(oid));
193 TRACE("not found for oid %s\n", wine_dbgstr_longlong(oid));
198 /* increments the internal refcount */
199 ULONG stub_manager_int_addref(struct stub_manager *This)
203 EnterCriticalSection(&This->apt->cs);
205 LeaveCriticalSection(&This->apt->cs);
207 TRACE("before %d\n", refs - 1);
212 /* decrements the internal refcount */
213 ULONG stub_manager_int_release(struct stub_manager *This)
216 APARTMENT *apt = This->apt;
218 EnterCriticalSection(&apt->cs);
221 TRACE("after %d\n", refs);
223 /* remove from apartment so no other thread can access it... */
225 list_remove(&This->entry);
227 LeaveCriticalSection(&apt->cs);
229 /* ... so now we can delete it without being inside the apartment critsec */
231 stub_manager_delete(This);
236 /* add some external references (ie from a client that unmarshaled an ifptr) */
237 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs)
241 EnterCriticalSection(&m->lock);
243 /* make sure we don't overflow extrefs */
244 refs = min(refs, (ULONG_MAX-1 - m->extrefs));
245 rc = (m->extrefs += refs);
247 LeaveCriticalSection(&m->lock);
249 TRACE("added %u refs to %p (oid %s), rc is now %u\n", refs, m, wine_dbgstr_longlong(m->oid), rc);
254 /* remove some external references */
255 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs, BOOL last_unlock_releases)
259 EnterCriticalSection(&m->lock);
261 /* make sure we don't underflow extrefs */
262 refs = min(refs, m->extrefs);
263 rc = (m->extrefs -= refs);
265 LeaveCriticalSection(&m->lock);
267 TRACE("removed %u refs from %p (oid %s), rc is now %u\n", refs, m, wine_dbgstr_longlong(m->oid), rc);
269 if (rc == 0 && last_unlock_releases)
270 stub_manager_int_release(m);
275 static struct ifstub *stub_manager_ipid_to_ifstub(struct stub_manager *m, const IPID *ipid)
278 struct ifstub *result = NULL;
280 EnterCriticalSection(&m->lock);
281 LIST_FOR_EACH( cursor, &m->ifstubs )
283 struct ifstub *ifstub = LIST_ENTRY( cursor, struct ifstub, entry );
285 if (IsEqualGUID(ipid, &ifstub->ipid))
291 LeaveCriticalSection(&m->lock);
296 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags)
298 struct ifstub *result = NULL;
299 struct ifstub *ifstub;
301 EnterCriticalSection(&m->lock);
302 LIST_FOR_EACH_ENTRY( ifstub, &m->ifstubs, struct ifstub, entry )
304 if (IsEqualIID(iid, &ifstub->iid) && (ifstub->flags == flags))
310 LeaveCriticalSection(&m->lock);
315 /* gets the stub manager associated with an ipid - caller must have
316 * a reference to the apartment while a reference to the stub manager is held.
317 * it must also call release on the stub manager when it is no longer needed */
318 static struct stub_manager *get_stub_manager_from_ipid(APARTMENT *apt, const IPID *ipid)
320 struct stub_manager *result = NULL;
323 EnterCriticalSection(&apt->cs);
324 LIST_FOR_EACH( cursor, &apt->stubmgrs )
326 struct stub_manager *m = LIST_ENTRY( cursor, struct stub_manager, entry );
328 if (stub_manager_ipid_to_ifstub(m, ipid))
331 stub_manager_int_addref(result);
335 LeaveCriticalSection(&apt->cs);
338 TRACE("found %p for ipid %s\n", result, debugstr_guid(ipid));
340 ERR("not found for ipid %s\n", debugstr_guid(ipid));
345 HRESULT ipid_to_stub_manager(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **stubmgr_ret)
347 /* FIXME: hack for IRemUnknown */
348 if (ipid->Data2 == 0xffff)
349 *stub_apt = apartment_findfromoxid(*(OXID *)ipid->Data4, TRUE);
351 *stub_apt = apartment_findfromtid(ipid->Data2);
354 TRACE("Couldn't find apartment corresponding to TID 0x%04x\n", ipid->Data2);
355 return RPC_E_INVALID_OBJECT;
357 *stubmgr_ret = get_stub_manager_from_ipid(*stub_apt, ipid);
360 apartment_release(*stub_apt);
362 return RPC_E_INVALID_OBJECT;
367 /* gets the apartment, stub and channel of an object. the caller must
368 * release the references to all objects (except iface) if the function
369 * returned success, otherwise no references are returned. */
370 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt,
371 IRpcStubBuffer **stub, IRpcChannelBuffer **chan,
372 IID *iid, IUnknown **iface)
374 struct stub_manager *stubmgr;
375 struct ifstub *ifstub;
379 hr = ipid_to_stub_manager(ipid, &apt, &stubmgr);
380 if (hr != S_OK) return RPC_E_DISCONNECTED;
382 ifstub = stub_manager_ipid_to_ifstub(stubmgr, ipid);
385 *stub = ifstub->stubbuffer;
386 IRpcStubBuffer_AddRef(*stub);
387 *chan = ifstub->chan;
388 IRpcChannelBuffer_AddRef(*chan);
391 *iface = ifstub->iface;
393 stub_manager_int_release(stubmgr);
398 stub_manager_int_release(stubmgr);
399 apartment_release(apt);
400 return RPC_E_DISCONNECTED;
404 /* generates an ipid in the following format (similar to native version):
405 * Data1 = apartment-local ipid counter
406 * Data2 = apartment creator thread ID
408 * Data4 = random value
410 static inline HRESULT generate_ipid(struct stub_manager *m, IPID *ipid)
413 hr = UuidCreate(ipid);
416 ERR("couldn't create IPID for stub manager %p\n", m);
421 ipid->Data1 = InterlockedIncrement(&m->apt->ipidc);
422 ipid->Data2 = (USHORT)m->apt->tid;
423 ipid->Data3 = (USHORT)GetCurrentProcessId();
427 /* registers a new interface stub COM object with the stub manager and returns registration record */
428 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, IUnknown *iptr, REFIID iid, MSHLFLAGS flags)
433 TRACE("oid=%s, stubbuffer=%p, iptr=%p, iid=%s\n",
434 wine_dbgstr_longlong(m->oid), sb, iptr, debugstr_guid(iid));
436 stub = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct ifstub));
437 if (!stub) return NULL;
439 hr = RPC_CreateServerChannel(&stub->chan);
442 HeapFree(GetProcessHeap(), 0, stub);
446 stub->stubbuffer = sb;
447 if (sb) IRpcStubBuffer_AddRef(sb);
449 IUnknown_AddRef(iptr);
455 * FIXME: this is a hack for marshalling IRemUnknown. In real
456 * DCOM, the IPID of the IRemUnknown interface is generated like
457 * any other and passed to the OXID resolver which then returns it
458 * when queried. We don't have an OXID resolver yet so instead we
459 * use a magic IPID reserved for IRemUnknown.
461 if (IsEqualIID(iid, &IID_IRemUnknown))
463 stub->ipid.Data1 = 0xffffffff;
464 stub->ipid.Data2 = 0xffff;
465 stub->ipid.Data3 = 0xffff;
466 assert(sizeof(stub->ipid.Data4) == sizeof(m->apt->oxid));
467 memcpy(&stub->ipid.Data4, &m->apt->oxid, sizeof(OXID));
470 generate_ipid(m, &stub->ipid);
472 EnterCriticalSection(&m->lock);
473 list_add_head(&m->ifstubs, &stub->entry);
474 /* every normal marshal is counted so we don't allow more than we should */
475 if (flags & MSHLFLAGS_NORMAL) m->norm_refs++;
476 LeaveCriticalSection(&m->lock);
478 TRACE("ifstub %p created with ipid %s\n", stub, debugstr_guid(&stub->ipid));
483 static void stub_manager_delete_ifstub(struct stub_manager *m, struct ifstub *ifstub)
485 TRACE("m=%p, m->oid=%s, ipid=%s\n", m, wine_dbgstr_longlong(m->oid), debugstr_guid(&ifstub->ipid));
487 list_remove(&ifstub->entry);
489 RPC_UnregisterInterface(&ifstub->iid);
491 if (ifstub->stubbuffer) IUnknown_Release(ifstub->stubbuffer);
492 IUnknown_Release(ifstub->iface);
493 IRpcChannelBuffer_Release(ifstub->chan);
495 HeapFree(GetProcessHeap(), 0, ifstub);
498 /* returns TRUE if it is possible to unmarshal, FALSE otherwise. */
499 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid)
502 struct ifstub *ifstub;
504 if (!(ifstub = stub_manager_ipid_to_ifstub(m, ipid)))
506 ERR("attempted unmarshal of unknown IPID %s\n", debugstr_guid(ipid));
510 EnterCriticalSection(&m->lock);
512 /* track normal marshals so we can enforce rules whilst in-process */
513 if (ifstub->flags & MSHLFLAGS_NORMAL)
519 ERR("attempted invalid normal unmarshal, norm_refs is zero\n");
524 LeaveCriticalSection(&m->lock);
529 /* handles refcounting for CoReleaseMarshalData */
530 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid)
532 struct ifstub *ifstub;
534 if (!(ifstub = stub_manager_ipid_to_ifstub(m, ipid)))
537 if (ifstub->flags & MSHLFLAGS_TABLEWEAK)
539 else if (ifstub->flags & MSHLFLAGS_TABLESTRONG)
542 stub_manager_ext_release(m, refs, TRUE);
545 /* is an ifstub table marshaled? */
546 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid)
548 struct ifstub *ifstub = stub_manager_ipid_to_ifstub(m, ipid);
552 return ifstub->flags & (MSHLFLAGS_TABLESTRONG | MSHLFLAGS_TABLEWEAK);
556 /*****************************************************************************
558 * IRemUnknown implementation
561 * Note: this object is not related to the lifetime of a stub_manager, but it
562 * interacts with stub managers.
565 typedef struct rem_unknown
567 const IRemUnknownVtbl *lpVtbl;
571 static const IRemUnknownVtbl RemUnknown_Vtbl;
574 /* construct an IRemUnknown object with one outstanding reference */
575 static HRESULT RemUnknown_Construct(IRemUnknown **ppRemUnknown)
577 RemUnknown *This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
579 if (!This) return E_OUTOFMEMORY;
581 This->lpVtbl = &RemUnknown_Vtbl;
584 *ppRemUnknown = (IRemUnknown *)This;
588 static HRESULT WINAPI RemUnknown_QueryInterface(IRemUnknown *iface, REFIID riid, void **ppv)
590 TRACE("(%p)->(%s, %p)\n", iface, debugstr_guid(riid), ppv);
592 if (IsEqualIID(riid, &IID_IUnknown) ||
593 IsEqualIID(riid, &IID_IRemUnknown))
595 *ppv = (LPVOID)iface;
596 IRemUnknown_AddRef(iface);
600 FIXME("No interface for iid %s\n", debugstr_guid(riid));
603 return E_NOINTERFACE;
606 static ULONG WINAPI RemUnknown_AddRef(IRemUnknown *iface)
609 RemUnknown *This = (RemUnknown *)iface;
611 refs = InterlockedIncrement(&This->refs);
613 TRACE("%p before: %d\n", iface, refs-1);
617 static ULONG WINAPI RemUnknown_Release(IRemUnknown *iface)
620 RemUnknown *This = (RemUnknown *)iface;
622 refs = InterlockedDecrement(&This->refs);
624 HeapFree(GetProcessHeap(), 0, This);
626 TRACE("%p after: %d\n", iface, refs);
630 static HRESULT WINAPI RemUnknown_RemQueryInterface(IRemUnknown *iface,
631 REFIPID ripid, ULONG cRefs, USHORT cIids, IID *iids /* [size_is(cIids)] */,
632 REMQIRESULT **ppQIResults /* [size_is(,cIids)] */)
636 USHORT successful_qis = 0;
638 struct stub_manager *stubmgr;
640 TRACE("(%p)->(%s, %d, %d, %p, %p)\n", iface, debugstr_guid(ripid), cRefs, cIids, iids, ppQIResults);
642 hr = ipid_to_stub_manager(ripid, &apt, &stubmgr);
643 if (hr != S_OK) return hr;
645 *ppQIResults = CoTaskMemAlloc(sizeof(REMQIRESULT) * cIids);
647 for (i = 0; i < cIids; i++)
649 HRESULT hrobj = marshal_object(apt, &(*ppQIResults)[i].std, &iids[i],
650 stubmgr->object, MSHLFLAGS_NORMAL);
653 (*ppQIResults)[i].hResult = hrobj;
656 stub_manager_int_release(stubmgr);
657 apartment_release(apt);
659 if (successful_qis == cIids)
660 return S_OK; /* we got all requested interfaces */
661 else if (successful_qis == 0)
662 return E_NOINTERFACE; /* we didn't get any interfaces */
664 return S_FALSE; /* we got some interfaces */
667 static HRESULT WINAPI RemUnknown_RemAddRef(IRemUnknown *iface,
668 USHORT cInterfaceRefs,
669 REMINTERFACEREF* InterfaceRefs /* [size_is(cInterfaceRefs)] */,
670 HRESULT *pResults /* [size_is(cInterfaceRefs)] */)
675 TRACE("(%p)->(%d, %p, %p)\n", iface, cInterfaceRefs, InterfaceRefs, pResults);
677 for (i = 0; i < cInterfaceRefs; i++)
680 struct stub_manager *stubmgr;
682 pResults[i] = ipid_to_stub_manager(&InterfaceRefs[i].ipid, &apt, &stubmgr);
683 if (pResults[i] != S_OK)
689 stub_manager_ext_addref(stubmgr, InterfaceRefs[i].cPublicRefs);
690 if (InterfaceRefs[i].cPrivateRefs)
691 FIXME("Adding %ld refs securely not implemented\n", InterfaceRefs[i].cPrivateRefs);
693 stub_manager_int_release(stubmgr);
694 apartment_release(apt);
700 static HRESULT WINAPI RemUnknown_RemRelease(IRemUnknown *iface,
701 USHORT cInterfaceRefs,
702 REMINTERFACEREF* InterfaceRefs /* [size_is(cInterfaceRefs)] */)
707 TRACE("(%p)->(%d, %p)\n", iface, cInterfaceRefs, InterfaceRefs);
709 for (i = 0; i < cInterfaceRefs; i++)
712 struct stub_manager *stubmgr;
714 hr = ipid_to_stub_manager(&InterfaceRefs[i].ipid, &apt, &stubmgr);
718 /* FIXME: we should undo any changes already made in this function */
722 stub_manager_ext_release(stubmgr, InterfaceRefs[i].cPublicRefs, TRUE);
723 if (InterfaceRefs[i].cPrivateRefs)
724 FIXME("Releasing %ld refs securely not implemented\n", InterfaceRefs[i].cPrivateRefs);
726 stub_manager_int_release(stubmgr);
727 apartment_release(apt);
733 static const IRemUnknownVtbl RemUnknown_Vtbl =
735 RemUnknown_QueryInterface,
738 RemUnknown_RemQueryInterface,
739 RemUnknown_RemAddRef,
740 RemUnknown_RemRelease
743 /* starts the IRemUnknown listener for the current apartment */
744 HRESULT start_apartment_remote_unknown(void)
746 IRemUnknown *pRemUnknown;
748 APARTMENT *apt = COM_CurrentApt();
750 EnterCriticalSection(&apt->cs);
751 if (!apt->remunk_exported)
753 /* create the IRemUnknown object */
754 hr = RemUnknown_Construct(&pRemUnknown);
757 STDOBJREF stdobjref; /* dummy - not used */
758 /* register it with the stub manager */
759 hr = marshal_object(apt, &stdobjref, &IID_IRemUnknown, (IUnknown *)pRemUnknown, MSHLFLAGS_NORMAL);
760 /* release our reference to the object as the stub manager will manage the life cycle for us */
761 IRemUnknown_Release(pRemUnknown);
763 apt->remunk_exported = TRUE;
766 LeaveCriticalSection(&apt->cs);