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);
46 /* generates an ipid in the following format (similar to native version):
47 * Data1 = apartment-local ipid counter
48 * Data2 = apartment creator thread ID
50 * Data4 = random value
52 static inline HRESULT generate_ipid(struct stub_manager *m, IPID *ipid)
55 hr = UuidCreate(ipid);
58 ERR("couldn't create IPID for stub manager %p\n", m);
63 ipid->Data1 = InterlockedIncrement(&m->apt->ipidc);
64 ipid->Data2 = (USHORT)m->apt->tid;
65 ipid->Data3 = (USHORT)GetCurrentProcessId();
69 /* registers a new interface stub COM object with the stub manager and returns registration record */
70 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, IUnknown *iptr, REFIID iid, DWORD dest_context,
71 void *dest_context_data, MSHLFLAGS flags)
76 TRACE("oid=%s, stubbuffer=%p, iptr=%p, iid=%s\n",
77 wine_dbgstr_longlong(m->oid), sb, iptr, debugstr_guid(iid));
79 stub = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct ifstub));
80 if (!stub) return NULL;
82 hr = RPC_CreateServerChannel(dest_context, dest_context_data, &stub->chan);
85 HeapFree(GetProcessHeap(), 0, stub);
89 stub->stubbuffer = sb;
90 if (sb) IRpcStubBuffer_AddRef(sb);
92 IUnknown_AddRef(iptr);
97 /* FIXME: find a cleaner way of identifying that we are creating an ifstub
98 * for the remunknown interface */
99 if (flags & MSHLFLAGSP_REMUNKNOWN)
100 stub->ipid = m->oxid_info.ipidRemUnknown;
102 generate_ipid(m, &stub->ipid);
104 EnterCriticalSection(&m->lock);
105 list_add_head(&m->ifstubs, &stub->entry);
106 /* every normal marshal is counted so we don't allow more than we should */
107 if (flags & MSHLFLAGS_NORMAL) m->norm_refs++;
108 LeaveCriticalSection(&m->lock);
110 TRACE("ifstub %p created with ipid %s\n", stub, debugstr_guid(&stub->ipid));
115 static void stub_manager_delete_ifstub(struct stub_manager *m, struct ifstub *ifstub)
117 TRACE("m=%p, m->oid=%s, ipid=%s\n", m, wine_dbgstr_longlong(m->oid), debugstr_guid(&ifstub->ipid));
119 list_remove(&ifstub->entry);
121 RPC_UnregisterInterface(&ifstub->iid);
123 if (ifstub->stubbuffer) IRpcStubBuffer_Release(ifstub->stubbuffer);
124 IUnknown_Release(ifstub->iface);
125 IRpcChannelBuffer_Release(ifstub->chan);
127 HeapFree(GetProcessHeap(), 0, ifstub);
130 static struct ifstub *stub_manager_ipid_to_ifstub(struct stub_manager *m, const IPID *ipid)
133 struct ifstub *result = NULL;
135 EnterCriticalSection(&m->lock);
136 LIST_FOR_EACH( cursor, &m->ifstubs )
138 struct ifstub *ifstub = LIST_ENTRY( cursor, struct ifstub, entry );
140 if (IsEqualGUID(ipid, &ifstub->ipid))
146 LeaveCriticalSection(&m->lock);
151 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags)
153 struct ifstub *result = NULL;
154 struct ifstub *ifstub;
156 EnterCriticalSection(&m->lock);
157 LIST_FOR_EACH_ENTRY( ifstub, &m->ifstubs, struct ifstub, entry )
159 if (IsEqualIID(iid, &ifstub->iid) && (ifstub->flags == flags))
165 LeaveCriticalSection(&m->lock);
170 /* creates a new stub manager and adds it into the apartment. caller must
171 * release stub manager when it is no longer required. the apartment and
172 * external refs together take one implicit ref */
173 struct stub_manager *new_stub_manager(APARTMENT *apt, IUnknown *object)
175 struct stub_manager *sm;
179 sm = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct stub_manager));
180 if (!sm) return NULL;
182 list_init(&sm->ifstubs);
184 InitializeCriticalSection(&sm->lock);
185 DEBUG_SET_CRITSEC_NAME(&sm->lock, "stub_manager");
187 IUnknown_AddRef(object);
191 /* start off with 2 references because the stub is in the apartment
192 * and the caller will also hold a reference */
196 sm->oxid_info.dwPid = GetCurrentProcessId();
197 sm->oxid_info.dwTid = GetCurrentThreadId();
199 * FIXME: this is a hack for marshalling IRemUnknown. In real
200 * DCOM, the IPID of the IRemUnknown interface is generated like
201 * any other and passed to the OXID resolver which then returns it
202 * when queried. We don't have an OXID resolver yet so instead we
203 * use a magic IPID reserved for IRemUnknown.
205 sm->oxid_info.ipidRemUnknown.Data1 = 0xffffffff;
206 sm->oxid_info.ipidRemUnknown.Data2 = 0xffff;
207 sm->oxid_info.ipidRemUnknown.Data3 = 0xffff;
208 assert(sizeof(sm->oxid_info.ipidRemUnknown.Data4) == sizeof(apt->oxid));
209 memcpy(sm->oxid_info.ipidRemUnknown.Data4, &apt->oxid, sizeof(OXID));
210 sm->oxid_info.dwAuthnHint = RPC_C_AUTHN_LEVEL_NONE;
211 sm->oxid_info.psa = NULL /* FIXME */;
213 /* Yes, that's right, this starts at zero. that's zero EXTERNAL
214 * refs, i.e., nobody has unmarshalled anything yet. We can't have
215 * negative refs because the stub manager cannot be explicitly
216 * killed, it has to die by somebody unmarshalling then releasing
217 * the marshalled ifptr.
221 EnterCriticalSection(&apt->cs);
222 sm->oid = apt->oidc++;
223 list_add_head(&apt->stubmgrs, &sm->entry);
224 LeaveCriticalSection(&apt->cs);
226 TRACE("Created new stub manager (oid=%s) at %p for object with IUnknown %p\n", wine_dbgstr_longlong(sm->oid), sm, object);
231 /* caller must remove stub manager from apartment prior to calling this function */
232 static void stub_manager_delete(struct stub_manager *m)
236 TRACE("destroying %p (oid=%s)\n", m, wine_dbgstr_longlong(m->oid));
238 /* release every ifstub */
239 while ((cursor = list_head(&m->ifstubs)))
241 struct ifstub *ifstub = LIST_ENTRY(cursor, struct ifstub, entry);
242 stub_manager_delete_ifstub(m, ifstub);
245 CoTaskMemFree(m->oxid_info.psa);
246 IUnknown_Release(m->object);
248 DEBUG_CLEAR_CRITSEC_NAME(&m->lock);
249 DeleteCriticalSection(&m->lock);
251 HeapFree(GetProcessHeap(), 0, m);
254 /* increments the internal refcount */
255 static ULONG stub_manager_int_addref(struct stub_manager *This)
259 EnterCriticalSection(&This->apt->cs);
261 LeaveCriticalSection(&This->apt->cs);
263 TRACE("before %d\n", refs - 1);
268 /* decrements the internal refcount */
269 ULONG stub_manager_int_release(struct stub_manager *This)
272 APARTMENT *apt = This->apt;
274 EnterCriticalSection(&apt->cs);
277 TRACE("after %d\n", refs);
279 /* remove from apartment so no other thread can access it... */
281 list_remove(&This->entry);
283 LeaveCriticalSection(&apt->cs);
285 /* ... so now we can delete it without being inside the apartment critsec */
287 stub_manager_delete(This);
292 /* gets the stub manager associated with an object - caller must have
293 * a reference to the apartment while a reference to the stub manager is held.
294 * it must also call release on the stub manager when it is no longer needed */
295 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, void *object)
297 struct stub_manager *result = NULL;
300 EnterCriticalSection(&apt->cs);
301 LIST_FOR_EACH( cursor, &apt->stubmgrs )
303 struct stub_manager *m = LIST_ENTRY( cursor, struct stub_manager, entry );
305 if (m->object == object)
308 stub_manager_int_addref(result);
312 LeaveCriticalSection(&apt->cs);
315 TRACE("found %p for object %p\n", result, object);
317 TRACE("not found for object %p\n", object);
322 /* removes the apartment reference to an object, destroying it when no other
323 * threads have a reference to it */
324 void apartment_disconnectobject(struct apartment *apt, void *object)
327 struct stub_manager *stubmgr;
329 EnterCriticalSection(&apt->cs);
330 LIST_FOR_EACH_ENTRY( stubmgr, &apt->stubmgrs, struct stub_manager, entry )
332 if (stubmgr->object == object)
335 stub_manager_int_release(stubmgr);
339 LeaveCriticalSection(&apt->cs);
342 TRACE("disconnect object %p\n", object);
344 WARN("couldn't find object %p\n", object);
347 /* gets the stub manager associated with an object id - caller must have
348 * a reference to the apartment while a reference to the stub manager is held.
349 * it must also call release on the stub manager when it is no longer needed */
350 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid)
352 struct stub_manager *result = NULL;
355 EnterCriticalSection(&apt->cs);
356 LIST_FOR_EACH( cursor, &apt->stubmgrs )
358 struct stub_manager *m = LIST_ENTRY( cursor, struct stub_manager, entry );
363 stub_manager_int_addref(result);
367 LeaveCriticalSection(&apt->cs);
370 TRACE("found %p for oid %s\n", result, wine_dbgstr_longlong(oid));
372 TRACE("not found for oid %s\n", wine_dbgstr_longlong(oid));
377 /* add some external references (ie from a client that unmarshaled an ifptr) */
378 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs, BOOL tableweak)
382 EnterCriticalSection(&m->lock);
384 /* make sure we don't overflow extrefs */
385 refs = min(refs, (ULONG_MAX-1 - m->extrefs));
386 rc = (m->extrefs += refs);
391 LeaveCriticalSection(&m->lock);
393 TRACE("added %u refs to %p (oid %s), rc is now %u\n", refs, m, wine_dbgstr_longlong(m->oid), rc);
398 /* remove some external references */
399 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs, BOOL tableweak, BOOL last_unlock_releases)
403 EnterCriticalSection(&m->lock);
405 /* make sure we don't underflow extrefs */
406 refs = min(refs, m->extrefs);
407 rc = (m->extrefs -= refs);
411 if (!last_unlock_releases)
414 LeaveCriticalSection(&m->lock);
416 TRACE("removed %u refs from %p (oid %s), rc is now %u\n", refs, m, wine_dbgstr_longlong(m->oid), rc);
419 stub_manager_int_release(m);
424 /* gets the stub manager associated with an ipid - caller must have
425 * a reference to the apartment while a reference to the stub manager is held.
426 * it must also call release on the stub manager when it is no longer needed */
427 static struct stub_manager *get_stub_manager_from_ipid(APARTMENT *apt, const IPID *ipid)
429 struct stub_manager *result = NULL;
432 EnterCriticalSection(&apt->cs);
433 LIST_FOR_EACH( cursor, &apt->stubmgrs )
435 struct stub_manager *m = LIST_ENTRY( cursor, struct stub_manager, entry );
437 if (stub_manager_ipid_to_ifstub(m, ipid))
440 stub_manager_int_addref(result);
444 LeaveCriticalSection(&apt->cs);
447 TRACE("found %p for ipid %s\n", result, debugstr_guid(ipid));
449 ERR("not found for ipid %s\n", debugstr_guid(ipid));
454 static HRESULT ipid_to_stub_manager(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **stubmgr_ret)
456 /* FIXME: hack for IRemUnknown */
457 if (ipid->Data2 == 0xffff)
458 *stub_apt = apartment_findfromoxid(*(const OXID *)ipid->Data4, TRUE);
460 *stub_apt = apartment_findfromtid(ipid->Data2);
463 TRACE("Couldn't find apartment corresponding to TID 0x%04x\n", ipid->Data2);
464 return RPC_E_INVALID_OBJECT;
466 *stubmgr_ret = get_stub_manager_from_ipid(*stub_apt, ipid);
469 apartment_release(*stub_apt);
471 return RPC_E_INVALID_OBJECT;
476 /* gets the apartment, stub and channel of an object. the caller must
477 * release the references to all objects (except iface) if the function
478 * returned success, otherwise no references are returned. */
479 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt,
480 IRpcStubBuffer **stub, IRpcChannelBuffer **chan,
481 IID *iid, IUnknown **iface)
483 struct stub_manager *stubmgr;
484 struct ifstub *ifstub;
488 hr = ipid_to_stub_manager(ipid, &apt, &stubmgr);
489 if (hr != S_OK) return RPC_E_DISCONNECTED;
491 ifstub = stub_manager_ipid_to_ifstub(stubmgr, ipid);
494 *stub = ifstub->stubbuffer;
495 IRpcStubBuffer_AddRef(*stub);
496 *chan = ifstub->chan;
497 IRpcChannelBuffer_AddRef(*chan);
500 *iface = ifstub->iface;
502 stub_manager_int_release(stubmgr);
507 stub_manager_int_release(stubmgr);
508 apartment_release(apt);
509 return RPC_E_DISCONNECTED;
513 /* returns TRUE if it is possible to unmarshal, FALSE otherwise. */
514 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid)
517 struct ifstub *ifstub;
519 if (!(ifstub = stub_manager_ipid_to_ifstub(m, ipid)))
521 ERR("attempted unmarshal of unknown IPID %s\n", debugstr_guid(ipid));
525 EnterCriticalSection(&m->lock);
527 /* track normal marshals so we can enforce rules whilst in-process */
528 if (ifstub->flags & MSHLFLAGS_NORMAL)
534 ERR("attempted invalid normal unmarshal, norm_refs is zero\n");
539 LeaveCriticalSection(&m->lock);
544 /* handles refcounting for CoReleaseMarshalData */
545 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid, BOOL tableweak)
547 struct ifstub *ifstub;
549 if (!(ifstub = stub_manager_ipid_to_ifstub(m, ipid)))
552 if (ifstub->flags & MSHLFLAGS_TABLEWEAK)
554 else if (ifstub->flags & MSHLFLAGS_TABLESTRONG)
557 stub_manager_ext_release(m, refs, tableweak, FALSE);
560 /* is an ifstub table marshaled? */
561 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid)
563 struct ifstub *ifstub = stub_manager_ipid_to_ifstub(m, ipid);
567 return ifstub->flags & (MSHLFLAGS_TABLESTRONG | MSHLFLAGS_TABLEWEAK);
571 /*****************************************************************************
573 * IRemUnknown implementation
576 * Note: this object is not related to the lifetime of a stub_manager, but it
577 * interacts with stub managers.
580 typedef struct rem_unknown
582 IRemUnknown IRemUnknown_iface;
586 static const IRemUnknownVtbl RemUnknown_Vtbl;
588 static inline RemUnknown *impl_from_IRemUnknown(IRemUnknown *iface)
590 return CONTAINING_RECORD(iface, RemUnknown, IRemUnknown_iface);
594 /* construct an IRemUnknown object with one outstanding reference */
595 static HRESULT RemUnknown_Construct(IRemUnknown **ppRemUnknown)
597 RemUnknown *This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
599 if (!This) return E_OUTOFMEMORY;
601 This->IRemUnknown_iface.lpVtbl = &RemUnknown_Vtbl;
604 *ppRemUnknown = &This->IRemUnknown_iface;
608 static HRESULT WINAPI RemUnknown_QueryInterface(IRemUnknown *iface, REFIID riid, void **ppv)
610 TRACE("(%p)->(%s, %p)\n", iface, debugstr_guid(riid), ppv);
612 if (IsEqualIID(riid, &IID_IUnknown) ||
613 IsEqualIID(riid, &IID_IRemUnknown))
616 IRemUnknown_AddRef(iface);
620 FIXME("No interface for iid %s\n", debugstr_guid(riid));
623 return E_NOINTERFACE;
626 static ULONG WINAPI RemUnknown_AddRef(IRemUnknown *iface)
629 RemUnknown *This = impl_from_IRemUnknown(iface);
631 refs = InterlockedIncrement(&This->refs);
633 TRACE("%p before: %d\n", iface, refs-1);
637 static ULONG WINAPI RemUnknown_Release(IRemUnknown *iface)
640 RemUnknown *This = impl_from_IRemUnknown(iface);
642 refs = InterlockedDecrement(&This->refs);
644 HeapFree(GetProcessHeap(), 0, This);
646 TRACE("%p after: %d\n", iface, refs);
650 static HRESULT WINAPI RemUnknown_RemQueryInterface(IRemUnknown *iface,
651 REFIPID ripid, ULONG cRefs, USHORT cIids, IID *iids /* [size_is(cIids)] */,
652 REMQIRESULT **ppQIResults /* [size_is(,cIids)] */)
656 USHORT successful_qis = 0;
658 struct stub_manager *stubmgr;
660 TRACE("(%p)->(%s, %d, %d, %p, %p)\n", iface, debugstr_guid(ripid), cRefs, cIids, iids, ppQIResults);
662 hr = ipid_to_stub_manager(ripid, &apt, &stubmgr);
663 if (hr != S_OK) return hr;
665 *ppQIResults = CoTaskMemAlloc(sizeof(REMQIRESULT) * cIids);
667 for (i = 0; i < cIids; i++)
669 HRESULT hrobj = marshal_object(apt, &(*ppQIResults)[i].std, &iids[i],
670 stubmgr->object, MSHCTX_DIFFERENTMACHINE, NULL, MSHLFLAGS_NORMAL);
673 (*ppQIResults)[i].hResult = hrobj;
676 stub_manager_int_release(stubmgr);
677 apartment_release(apt);
679 if (successful_qis == cIids)
680 return S_OK; /* we got all requested interfaces */
681 else if (successful_qis == 0)
682 return E_NOINTERFACE; /* we didn't get any interfaces */
684 return S_FALSE; /* we got some interfaces */
687 static HRESULT WINAPI RemUnknown_RemAddRef(IRemUnknown *iface,
688 USHORT cInterfaceRefs,
689 REMINTERFACEREF* InterfaceRefs /* [size_is(cInterfaceRefs)] */,
690 HRESULT *pResults /* [size_is(cInterfaceRefs)] */)
695 TRACE("(%p)->(%d, %p, %p)\n", iface, cInterfaceRefs, InterfaceRefs, pResults);
697 for (i = 0; i < cInterfaceRefs; i++)
700 struct stub_manager *stubmgr;
702 pResults[i] = ipid_to_stub_manager(&InterfaceRefs[i].ipid, &apt, &stubmgr);
703 if (pResults[i] != S_OK)
709 stub_manager_ext_addref(stubmgr, InterfaceRefs[i].cPublicRefs, FALSE);
710 if (InterfaceRefs[i].cPrivateRefs)
711 FIXME("Adding %d refs securely not implemented\n", InterfaceRefs[i].cPrivateRefs);
713 stub_manager_int_release(stubmgr);
714 apartment_release(apt);
720 static HRESULT WINAPI RemUnknown_RemRelease(IRemUnknown *iface,
721 USHORT cInterfaceRefs,
722 REMINTERFACEREF* InterfaceRefs /* [size_is(cInterfaceRefs)] */)
727 TRACE("(%p)->(%d, %p)\n", iface, cInterfaceRefs, InterfaceRefs);
729 for (i = 0; i < cInterfaceRefs; i++)
732 struct stub_manager *stubmgr;
734 hr = ipid_to_stub_manager(&InterfaceRefs[i].ipid, &apt, &stubmgr);
738 /* FIXME: we should undo any changes already made in this function */
742 stub_manager_ext_release(stubmgr, InterfaceRefs[i].cPublicRefs, FALSE, TRUE);
743 if (InterfaceRefs[i].cPrivateRefs)
744 FIXME("Releasing %d refs securely not implemented\n", InterfaceRefs[i].cPrivateRefs);
746 stub_manager_int_release(stubmgr);
747 apartment_release(apt);
753 static const IRemUnknownVtbl RemUnknown_Vtbl =
755 RemUnknown_QueryInterface,
758 RemUnknown_RemQueryInterface,
759 RemUnknown_RemAddRef,
760 RemUnknown_RemRelease
763 /* starts the IRemUnknown listener for the current apartment */
764 HRESULT start_apartment_remote_unknown(void)
766 IRemUnknown *pRemUnknown;
768 APARTMENT *apt = COM_CurrentApt();
770 EnterCriticalSection(&apt->cs);
771 if (!apt->remunk_exported)
773 /* create the IRemUnknown object */
774 hr = RemUnknown_Construct(&pRemUnknown);
777 STDOBJREF stdobjref; /* dummy - not used */
778 /* register it with the stub manager */
779 hr = marshal_object(apt, &stdobjref, &IID_IRemUnknown, (IUnknown *)pRemUnknown, MSHCTX_DIFFERENTMACHINE, NULL, MSHLFLAGS_NORMAL|MSHLFLAGSP_REMUNKNOWN);
780 /* release our reference to the object as the stub manager will manage the life cycle for us */
781 IRemUnknown_Release(pRemUnknown);
783 apt->remunk_exported = TRUE;
786 LeaveCriticalSection(&apt->cs);