4 * Copyright 2002 Marcus Meissner
5 * Copyright 2004 Mike Hearn, for CodeWeavers
6 * Copyright 2004 Rob Shearman, for CodeWeavers
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
35 #include "wine/unicode.h"
37 #include "compobj_private.h"
39 #include "wine/debug.h"
41 WINE_DEFAULT_DEBUG_CHANNEL(ole
);
43 extern const CLSID CLSID_DfMarshal
;
45 /* number of refs given out for normal marshaling */
46 #define NORMALEXTREFS 5
48 /* private flag indicating that the caller does not want to notify the stub
49 * when the proxy disconnects or is destroyed */
50 #define SORFP_NOLIFETIMEMGMT SORF_OXRES1
52 static HRESULT
unmarshal_object(const STDOBJREF
*stdobjref
, APARTMENT
*apt
,
53 MSHCTX dest_context
, void *dest_context_data
,
54 REFIID riid
, const OXID_INFO
*oxid_info
,
57 /* Marshalling just passes a unique identifier to the remote client,
58 * that makes it possible to find the passed interface again.
60 * So basically we need a set of values that make it unique.
62 * Note that the IUnknown_QI(ob,xiid,&ppv) always returns the SAME ppv value!
64 * A triple is used: OXID (apt id), OID (stub manager id),
65 * IPID (interface ptr/stub id).
67 * OXIDs identify an apartment and are network scoped
68 * OIDs identify a stub manager and are apartment scoped
69 * IPIDs identify an interface stub and are apartment scoped
72 static inline HRESULT
get_facbuf_for_iid(REFIID riid
, IPSFactoryBuffer
**facbuf
)
77 if ((hr
= CoGetPSClsid(riid
, &clsid
)))
79 return CoGetClassObject(&clsid
, CLSCTX_INPROC_SERVER
, NULL
,
80 &IID_IPSFactoryBuffer
, (LPVOID
*)facbuf
);
83 /* marshals an object into a STDOBJREF structure */
84 HRESULT
marshal_object(APARTMENT
*apt
, STDOBJREF
*stdobjref
, REFIID riid
, IUnknown
*object
, MSHLFLAGS mshlflags
)
86 struct stub_manager
*manager
;
87 struct ifstub
*ifstub
;
89 IRpcStubBuffer
*stub
= NULL
;
91 IUnknown
*iobject
= NULL
; /* object of type riid */
93 hr
= apartment_getoxid(apt
, &stdobjref
->oxid
);
97 hr
= apartment_createwindowifneeded(apt
);
101 hr
= IUnknown_QueryInterface(object
, riid
, (void **)&iobject
);
104 ERR("object doesn't expose interface %s, failing with error 0x%08x\n",
105 debugstr_guid(riid
), hr
);
106 return E_NOINTERFACE
;
109 /* IUnknown doesn't require a stub buffer, because it never goes out on
111 if (!IsEqualIID(riid
, &IID_IUnknown
))
113 IPSFactoryBuffer
*psfb
;
115 hr
= get_facbuf_for_iid(riid
, &psfb
);
118 ERR("couldn't get IPSFactory buffer for interface %s\n", debugstr_guid(riid
));
119 IUnknown_Release(iobject
);
123 hr
= IPSFactoryBuffer_CreateStub(psfb
, riid
, iobject
, &stub
);
124 IPSFactoryBuffer_Release(psfb
);
127 ERR("Failed to create an IRpcStubBuffer from IPSFactory for %s with error 0x%08x\n",
128 debugstr_guid(riid
), hr
);
129 IUnknown_Release(iobject
);
134 if (mshlflags
& MSHLFLAGS_NOPING
)
135 stdobjref
->flags
= SORF_NOPING
;
137 stdobjref
->flags
= SORF_NULL
;
139 if ((manager
= get_stub_manager_from_object(apt
, object
)))
140 TRACE("registering new ifstub on pre-existing manager\n");
143 TRACE("constructing new stub manager\n");
145 manager
= new_stub_manager(apt
, object
);
148 if (stub
) IRpcStubBuffer_Release(stub
);
149 IUnknown_Release(iobject
);
150 return E_OUTOFMEMORY
;
153 stdobjref
->oid
= manager
->oid
;
155 tablemarshal
= ((mshlflags
& MSHLFLAGS_TABLESTRONG
) || (mshlflags
& MSHLFLAGS_TABLEWEAK
));
157 /* make sure ifstub that we are creating is unique */
158 ifstub
= stub_manager_find_ifstub(manager
, riid
, mshlflags
);
160 ifstub
= stub_manager_new_ifstub(manager
, stub
, iobject
, riid
, mshlflags
);
162 if (stub
) IRpcStubBuffer_Release(stub
);
163 IUnknown_Release(iobject
);
167 stub_manager_int_release(manager
);
168 /* destroy the stub manager if it has no ifstubs by releasing
169 * zero external references */
170 stub_manager_ext_release(manager
, 0, TRUE
);
171 return E_OUTOFMEMORY
;
176 stdobjref
->cPublicRefs
= NORMALEXTREFS
;
177 stub_manager_ext_addref(manager
, stdobjref
->cPublicRefs
);
181 stdobjref
->cPublicRefs
= 0;
182 if (mshlflags
& MSHLFLAGS_TABLESTRONG
)
183 stub_manager_ext_addref(manager
, 1);
186 /* FIXME: check return value */
187 RPC_RegisterInterface(riid
);
189 stdobjref
->ipid
= ifstub
->ipid
;
191 stub_manager_int_release(manager
);
197 /* Client-side identity of the server object */
199 static HRESULT
proxy_manager_get_remunknown(struct proxy_manager
* This
, IRemUnknown
**remunk
);
200 static void proxy_manager_destroy(struct proxy_manager
* This
);
201 static HRESULT
proxy_manager_find_ifproxy(struct proxy_manager
* This
, REFIID riid
, struct ifproxy
** ifproxy_found
);
202 static HRESULT
proxy_manager_query_local_interface(struct proxy_manager
* This
, REFIID riid
, void ** ppv
);
204 static HRESULT WINAPI
ClientIdentity_QueryInterface(IMultiQI
* iface
, REFIID riid
, void ** ppv
)
209 TRACE("%s\n", debugstr_guid(riid
));
212 hr
= IMultiQI_QueryMultipleInterfaces(iface
, 1, &mqi
);
213 *ppv
= (void *)mqi
.pItf
;
218 static ULONG WINAPI
ClientIdentity_AddRef(IMultiQI
* iface
)
220 struct proxy_manager
* This
= (struct proxy_manager
*)iface
;
221 TRACE("%p - before %d\n", iface
, This
->refs
);
222 return InterlockedIncrement(&This
->refs
);
225 static ULONG WINAPI
ClientIdentity_Release(IMultiQI
* iface
)
227 struct proxy_manager
* This
= (struct proxy_manager
*)iface
;
228 ULONG refs
= InterlockedDecrement(&This
->refs
);
229 TRACE("%p - after %d\n", iface
, refs
);
231 proxy_manager_destroy(This
);
235 static HRESULT WINAPI
ClientIdentity_QueryMultipleInterfaces(IMultiQI
*iface
, ULONG cMQIs
, MULTI_QI
*pMQIs
)
237 struct proxy_manager
* This
= (struct proxy_manager
*)iface
;
238 REMQIRESULT
*qiresults
= NULL
;
239 ULONG nonlocal_mqis
= 0;
241 ULONG successful_mqis
= 0;
242 IID
*iids
= HeapAlloc(GetProcessHeap(), 0, cMQIs
* sizeof(*iids
));
243 /* mapping of RemQueryInterface index to QueryMultipleInterfaces index */
244 ULONG
*mapping
= HeapAlloc(GetProcessHeap(), 0, cMQIs
* sizeof(*mapping
));
246 TRACE("cMQIs: %d\n", cMQIs
);
248 /* try to get a local interface - this includes already active proxy
249 * interfaces and also interfaces exposed by the proxy manager */
250 for (i
= 0; i
< cMQIs
; i
++)
252 TRACE("iid[%d] = %s\n", i
, debugstr_guid(pMQIs
[i
].pIID
));
253 pMQIs
[i
].hr
= proxy_manager_query_local_interface(This
, pMQIs
[i
].pIID
, (void **)&pMQIs
[i
].pItf
);
254 if (pMQIs
[i
].hr
== S_OK
)
258 iids
[nonlocal_mqis
] = *pMQIs
[i
].pIID
;
259 mapping
[nonlocal_mqis
] = i
;
264 TRACE("%d interfaces not found locally\n", nonlocal_mqis
);
266 /* if we have more than one interface not found locally then we must try
267 * to query the remote object for it */
268 if (nonlocal_mqis
!= 0)
274 /* get the ipid of the first entry */
275 /* FIXME: should we implement ClientIdentity on the ifproxies instead
276 * of the proxy_manager so we use the correct ipid here? */
277 ipid
= &LIST_ENTRY(list_head(&This
->interfaces
), struct ifproxy
, entry
)->stdobjref
.ipid
;
279 /* get IRemUnknown proxy so we can communicate with the remote object */
280 hr
= proxy_manager_get_remunknown(This
, &remunk
);
284 hr
= IRemUnknown_RemQueryInterface(remunk
, ipid
, NORMALEXTREFS
,
285 nonlocal_mqis
, iids
, &qiresults
);
287 ERR("IRemUnknown_RemQueryInterface failed with error 0x%08x\n", hr
);
290 /* IRemUnknown_RemQueryInterface can return S_FALSE if only some of
291 * the interfaces were returned */
294 /* try to unmarshal each object returned to us */
295 for (i
= 0; i
< nonlocal_mqis
; i
++)
297 ULONG index
= mapping
[i
];
298 HRESULT hrobj
= qiresults
[i
].hResult
;
300 hrobj
= unmarshal_object(&qiresults
[i
].std
, This
->parent
,
302 This
->dest_context_data
,
303 pMQIs
[index
].pIID
, &This
->oxid_info
,
304 (void **)&pMQIs
[index
].pItf
);
309 ERR("Failed to get pointer to interface %s\n", debugstr_guid(pMQIs
[index
].pIID
));
310 pMQIs
[index
].hr
= hrobj
;
314 /* free the memory allocated by the proxy */
315 CoTaskMemFree(qiresults
);
318 TRACE("%d/%d successfully queried\n", successful_mqis
, cMQIs
);
320 HeapFree(GetProcessHeap(), 0, iids
);
321 HeapFree(GetProcessHeap(), 0, mapping
);
323 if (successful_mqis
== cMQIs
)
324 return S_OK
; /* we got all requested interfaces */
325 else if (successful_mqis
== 0)
326 return E_NOINTERFACE
; /* we didn't get any interfaces */
328 return S_FALSE
; /* we got some interfaces */
331 static const IMultiQIVtbl ClientIdentity_Vtbl
=
333 ClientIdentity_QueryInterface
,
334 ClientIdentity_AddRef
,
335 ClientIdentity_Release
,
336 ClientIdentity_QueryMultipleInterfaces
339 /* FIXME: remove these */
340 static HRESULT WINAPI
StdMarshalImpl_GetUnmarshalClass(LPMARSHAL iface
, REFIID riid
, void* pv
, DWORD dwDestContext
, void* pvDestContext
, DWORD mshlflags
, CLSID
* pCid
);
341 static HRESULT WINAPI
StdMarshalImpl_GetMarshalSizeMax(LPMARSHAL iface
, REFIID riid
, void* pv
, DWORD dwDestContext
, void* pvDestContext
, DWORD mshlflags
, DWORD
* pSize
);
342 static HRESULT WINAPI
StdMarshalImpl_UnmarshalInterface(LPMARSHAL iface
, IStream
*pStm
, REFIID riid
, void **ppv
);
343 static HRESULT WINAPI
StdMarshalImpl_ReleaseMarshalData(LPMARSHAL iface
, IStream
*pStm
);
344 static HRESULT WINAPI
StdMarshalImpl_DisconnectObject(LPMARSHAL iface
, DWORD dwReserved
);
346 static HRESULT WINAPI
Proxy_QueryInterface(IMarshal
*iface
, REFIID riid
, void **ppvObject
)
348 ICOM_THIS_MULTI(struct proxy_manager
, lpVtblMarshal
, iface
);
349 return IMultiQI_QueryInterface((IMultiQI
*)&This
->lpVtbl
, riid
, ppvObject
);
352 static ULONG WINAPI
Proxy_AddRef(IMarshal
*iface
)
354 ICOM_THIS_MULTI(struct proxy_manager
, lpVtblMarshal
, iface
);
355 return IMultiQI_AddRef((IMultiQI
*)&This
->lpVtbl
);
358 static ULONG WINAPI
Proxy_Release(IMarshal
*iface
)
360 ICOM_THIS_MULTI(struct proxy_manager
, lpVtblMarshal
, iface
);
361 return IMultiQI_Release((IMultiQI
*)&This
->lpVtbl
);
364 static HRESULT WINAPI
Proxy_MarshalInterface(
365 LPMARSHAL iface
, IStream
*pStm
, REFIID riid
, void* pv
, DWORD dwDestContext
,
366 void* pvDestContext
, DWORD mshlflags
)
368 ICOM_THIS_MULTI(struct proxy_manager
, lpVtblMarshal
, iface
);
370 struct ifproxy
*ifproxy
;
372 TRACE("(...,%s,...)\n", debugstr_guid(riid
));
374 hr
= proxy_manager_find_ifproxy(This
, riid
, &ifproxy
);
377 STDOBJREF stdobjref
= ifproxy
->stdobjref
;
378 ULONG cPublicRefs
= ifproxy
->refs
;
379 ULONG cPublicRefsOld
;
381 /* optimization - share out proxy's public references if possible
382 * instead of making new proxy do a roundtrip through the server */
385 ULONG cPublicRefsNew
;
386 cPublicRefsOld
= cPublicRefs
;
387 stdobjref
.cPublicRefs
= cPublicRefs
/ 2;
388 cPublicRefsNew
= cPublicRefs
- stdobjref
.cPublicRefs
;
389 cPublicRefs
= InterlockedCompareExchange(
390 (LONG
*)&ifproxy
->refs
, cPublicRefsNew
, cPublicRefsOld
);
391 } while (cPublicRefs
!= cPublicRefsOld
);
393 if (!stdobjref
.cPublicRefs
)
396 hr
= proxy_manager_get_remunknown(This
, &remunk
);
399 HRESULT hrref
= S_OK
;
401 rif
.ipid
= ifproxy
->stdobjref
.ipid
;
402 rif
.cPublicRefs
= NORMALEXTREFS
;
403 rif
.cPrivateRefs
= 0;
404 hr
= IRemUnknown_RemAddRef(remunk
, 1, &rif
, &hrref
);
405 if (hr
== S_OK
&& hrref
== S_OK
)
406 stdobjref
.cPublicRefs
= rif
.cPublicRefs
;
408 ERR("IRemUnknown_RemAddRef returned with 0x%08x, hrref = 0x%08x\n", hr
, hrref
);
414 TRACE("writing stdobjref:\n\tflags = %04lx\n\tcPublicRefs = %ld\n\toxid = %s\n\toid = %s\n\tipid = %s\n",
415 stdobjref
.flags
, stdobjref
.cPublicRefs
,
416 wine_dbgstr_longlong(stdobjref
.oxid
),
417 wine_dbgstr_longlong(stdobjref
.oid
),
418 debugstr_guid(&stdobjref
.ipid
));
419 hr
= IStream_Write(pStm
, &stdobjref
, sizeof(stdobjref
), NULL
);
424 /* we don't have the interface already unmarshaled so we have to
425 * request the object from the server */
428 REMQIRESULT
*qiresults
= NULL
;
431 /* get the ipid of the first entry */
432 /* FIXME: should we implement ClientIdentity on the ifproxies instead
433 * of the proxy_manager so we use the correct ipid here? */
434 ipid
= &LIST_ENTRY(list_head(&This
->interfaces
), struct ifproxy
, entry
)->stdobjref
.ipid
;
436 /* get IRemUnknown proxy so we can communicate with the remote object */
437 hr
= proxy_manager_get_remunknown(This
, &remunk
);
441 hr
= IRemUnknown_RemQueryInterface(remunk
, ipid
, NORMALEXTREFS
,
442 1, &iid
, &qiresults
);
445 hr
= IStream_Write(pStm
, &qiresults
->std
, sizeof(qiresults
->std
), NULL
);
449 rif
.ipid
= qiresults
->std
.ipid
;
450 rif
.cPublicRefs
= qiresults
->std
.cPublicRefs
;
451 rif
.cPrivateRefs
= 0;
452 IRemUnknown_RemRelease(remunk
, 1, &rif
);
454 CoTaskMemFree(qiresults
);
457 ERR("IRemUnknown_RemQueryInterface failed with error 0x%08x\n", hr
);
464 static const IMarshalVtbl ProxyMarshal_Vtbl
=
466 Proxy_QueryInterface
,
469 StdMarshalImpl_GetUnmarshalClass
,
470 StdMarshalImpl_GetMarshalSizeMax
,
471 Proxy_MarshalInterface
,
472 StdMarshalImpl_UnmarshalInterface
,
473 StdMarshalImpl_ReleaseMarshalData
,
474 StdMarshalImpl_DisconnectObject
477 static HRESULT WINAPI
ProxyCliSec_QueryInterface(IClientSecurity
*iface
, REFIID riid
, void **ppvObject
)
479 ICOM_THIS_MULTI(struct proxy_manager
, lpVtblCliSec
, iface
);
480 return IMultiQI_QueryInterface((IMultiQI
*)&This
->lpVtbl
, riid
, ppvObject
);
483 static ULONG WINAPI
ProxyCliSec_AddRef(IClientSecurity
*iface
)
485 ICOM_THIS_MULTI(struct proxy_manager
, lpVtblCliSec
, iface
);
486 return IMultiQI_AddRef((IMultiQI
*)&This
->lpVtbl
);
489 static ULONG WINAPI
ProxyCliSec_Release(IClientSecurity
*iface
)
491 ICOM_THIS_MULTI(struct proxy_manager
, lpVtblCliSec
, iface
);
492 return IMultiQI_Release((IMultiQI
*)&This
->lpVtbl
);
495 static HRESULT WINAPI
ProxyCliSec_QueryBlanket(IClientSecurity
*iface
,
499 OLECHAR
**pServerPrincName
,
503 DWORD
*pCapabilities
)
505 FIXME("(%p, %p, %p, %p, %p, %p, %p, %p): stub\n", pProxy
, pAuthnSvc
,
506 pAuthzSvc
, pServerPrincName
, pAuthnLevel
, pImpLevel
, pAuthInfo
,
511 static HRESULT WINAPI
ProxyCliSec_SetBlanket(IClientSecurity
*iface
,
512 IUnknown
*pProxy
, DWORD AuthnSvc
,
514 OLECHAR
*pServerPrincName
,
515 DWORD AuthnLevel
, DWORD ImpLevel
,
519 FIXME("(%p, %d, %d, %s, %d, %d, %p, 0x%x): stub\n", pProxy
, AuthnSvc
,
520 AuthzSvc
, debugstr_w(pServerPrincName
), AuthnLevel
, ImpLevel
,
521 pAuthInfo
, Capabilities
);
525 static HRESULT WINAPI
ProxyCliSec_CopyProxy(IClientSecurity
*iface
,
526 IUnknown
*pProxy
, IUnknown
**ppCopy
)
528 FIXME("(%p, %p): stub\n", pProxy
, ppCopy
);
533 static const IClientSecurityVtbl ProxyCliSec_Vtbl
=
535 ProxyCliSec_QueryInterface
,
538 ProxyCliSec_QueryBlanket
,
539 ProxyCliSec_SetBlanket
,
540 ProxyCliSec_CopyProxy
543 static HRESULT
ifproxy_get_public_ref(struct ifproxy
* This
)
547 if (WAIT_OBJECT_0
!= WaitForSingleObject(This
->parent
->remoting_mutex
, INFINITE
))
549 ERR("Wait failed for ifproxy %p\n", This
);
555 IRemUnknown
*remunk
= NULL
;
557 TRACE("getting public ref for ifproxy %p\n", This
);
559 hr
= proxy_manager_get_remunknown(This
->parent
, &remunk
);
562 HRESULT hrref
= S_OK
;
564 rif
.ipid
= This
->stdobjref
.ipid
;
565 rif
.cPublicRefs
= NORMALEXTREFS
;
566 rif
.cPrivateRefs
= 0;
567 hr
= IRemUnknown_RemAddRef(remunk
, 1, &rif
, &hrref
);
568 if (hr
== S_OK
&& hrref
== S_OK
)
569 InterlockedExchangeAdd((LONG
*)&This
->refs
, NORMALEXTREFS
);
571 ERR("IRemUnknown_RemAddRef returned with 0x%08x, hrref = 0x%08x\n", hr
, hrref
);
574 ReleaseMutex(This
->parent
->remoting_mutex
);
579 static HRESULT
ifproxy_release_public_refs(struct ifproxy
* This
)
584 if (WAIT_OBJECT_0
!= WaitForSingleObject(This
->parent
->remoting_mutex
, INFINITE
))
586 ERR("Wait failed for ifproxy %p\n", This
);
590 public_refs
= This
->refs
;
593 IRemUnknown
*remunk
= NULL
;
595 TRACE("releasing %d refs\n", public_refs
);
597 hr
= proxy_manager_get_remunknown(This
->parent
, &remunk
);
601 rif
.ipid
= This
->stdobjref
.ipid
;
602 rif
.cPublicRefs
= public_refs
;
603 rif
.cPrivateRefs
= 0;
604 hr
= IRemUnknown_RemRelease(remunk
, 1, &rif
);
606 InterlockedExchangeAdd((LONG
*)&This
->refs
, -public_refs
);
607 else if (hr
== RPC_E_DISCONNECTED
)
608 WARN("couldn't release references because object was "
609 "disconnected: oxid = %s, oid = %s\n",
610 wine_dbgstr_longlong(This
->parent
->oxid
),
611 wine_dbgstr_longlong(This
->parent
->oid
));
613 ERR("IRemUnknown_RemRelease failed with error 0x%08x\n", hr
);
616 ReleaseMutex(This
->parent
->remoting_mutex
);
621 /* should be called inside This->parent->cs critical section */
622 static void ifproxy_disconnect(struct ifproxy
* This
)
624 ifproxy_release_public_refs(This
);
625 if (This
->proxy
) IRpcProxyBuffer_Disconnect(This
->proxy
);
627 IRpcChannelBuffer_Release(This
->chan
);
631 /* should be called in This->parent->cs critical section if it is an entry in parent's list */
632 static void ifproxy_destroy(struct ifproxy
* This
)
636 /* release public references to this object so that the stub can know
637 * when to destroy itself */
638 ifproxy_release_public_refs(This
);
640 list_remove(&This
->entry
);
644 IRpcChannelBuffer_Release(This
->chan
);
648 if (This
->proxy
) IRpcProxyBuffer_Release(This
->proxy
);
650 HeapFree(GetProcessHeap(), 0, This
);
653 static HRESULT
proxy_manager_construct(
654 APARTMENT
* apt
, ULONG sorflags
, OXID oxid
, OID oid
,
655 const OXID_INFO
*oxid_info
, struct proxy_manager
** proxy_manager
)
657 struct proxy_manager
* This
= HeapAlloc(GetProcessHeap(), 0, sizeof(*This
));
658 if (!This
) return E_OUTOFMEMORY
;
660 This
->remoting_mutex
= CreateMutexW(NULL
, FALSE
, NULL
);
661 if (!This
->remoting_mutex
)
663 HeapFree(GetProcessHeap(), 0, This
);
664 return HRESULT_FROM_WIN32(GetLastError());
669 This
->oxid_info
.dwPid
= oxid_info
->dwPid
;
670 This
->oxid_info
.dwTid
= oxid_info
->dwTid
;
671 This
->oxid_info
.ipidRemUnknown
= oxid_info
->ipidRemUnknown
;
672 This
->oxid_info
.dwAuthnHint
= oxid_info
->dwAuthnHint
;
673 This
->oxid_info
.psa
= NULL
/* FIXME: copy from oxid_info */;
677 HRESULT hr
= RPC_ResolveOxid(oxid
, &This
->oxid_info
);
680 CloseHandle(This
->remoting_mutex
);
681 HeapFree(GetProcessHeap(), 0, This
);
686 This
->lpVtbl
= &ClientIdentity_Vtbl
;
687 This
->lpVtblMarshal
= &ProxyMarshal_Vtbl
;
688 This
->lpVtblCliSec
= &ProxyCliSec_Vtbl
;
690 list_init(&This
->entry
);
691 list_init(&This
->interfaces
);
693 InitializeCriticalSection(&This
->cs
);
694 DEBUG_SET_CRITSEC_NAME(&This
->cs
, "proxy_manager");
696 /* the apartment the object was unmarshaled into */
699 /* the source apartment and id of the object */
705 /* the DCOM draft specification states that the SORF_NOPING flag is
706 * proxy manager specific, not ifproxy specific, so this implies that we
707 * should store the STDOBJREF flags here in the proxy manager. */
708 This
->sorflags
= sorflags
;
710 /* we create the IRemUnknown proxy on demand */
713 /* initialise these values to the weakest values and they will be
714 * overwritten in proxy_manager_set_context */
715 This
->dest_context
= MSHCTX_INPROC
;
716 This
->dest_context_data
= NULL
;
718 EnterCriticalSection(&apt
->cs
);
719 /* FIXME: we are dependent on the ordering in here to make sure a proxy's
720 * IRemUnknown proxy doesn't get destroyed before the regual proxy does
721 * because we need the IRemUnknown proxy during the destruction of the
722 * regular proxy. Ideally, we should maintain a separate list for the
723 * IRemUnknown proxies that need late destruction */
724 list_add_tail(&apt
->proxies
, &This
->entry
);
725 LeaveCriticalSection(&apt
->cs
);
727 TRACE("%p created for OXID %s, OID %s\n", This
,
728 wine_dbgstr_longlong(oxid
), wine_dbgstr_longlong(oid
));
730 *proxy_manager
= This
;
734 static inline void proxy_manager_set_context(struct proxy_manager
*This
, MSHCTX dest_context
, void *dest_context_data
)
736 MSHCTX old_dest_context
= This
->dest_context
;
737 MSHCTX new_dest_context
;
741 new_dest_context
= old_dest_context
;
742 /* "stronger" values overwrite "weaker" values. stronger values are
743 * ones that disable more optimisations */
744 switch (old_dest_context
)
747 new_dest_context
= dest_context
;
749 case MSHCTX_CROSSCTX
:
750 switch (dest_context
)
755 new_dest_context
= dest_context
;
759 switch (dest_context
)
762 case MSHCTX_CROSSCTX
:
765 new_dest_context
= dest_context
;
768 case MSHCTX_NOSHAREDMEM
:
769 switch (dest_context
)
771 case MSHCTX_DIFFERENTMACHINE
:
772 new_dest_context
= dest_context
;
782 if (old_dest_context
== new_dest_context
) break;
784 old_dest_context
= InterlockedCompareExchange((PLONG
)&This
->dest_context
, new_dest_context
, old_dest_context
);
785 } while (new_dest_context
!= old_dest_context
);
787 if (dest_context_data
)
788 InterlockedExchangePointer(&This
->dest_context_data
, dest_context_data
);
791 static HRESULT
proxy_manager_query_local_interface(struct proxy_manager
* This
, REFIID riid
, void ** ppv
)
794 struct ifproxy
* ifproxy
;
796 TRACE("%s\n", debugstr_guid(riid
));
798 if (IsEqualIID(riid
, &IID_IUnknown
) ||
799 IsEqualIID(riid
, &IID_IMultiQI
))
801 *ppv
= (void *)&This
->lpVtbl
;
802 IUnknown_AddRef((IUnknown
*)*ppv
);
805 if (IsEqualIID(riid
, &IID_IMarshal
))
807 *ppv
= (void *)&This
->lpVtblMarshal
;
808 IUnknown_AddRef((IUnknown
*)*ppv
);
811 if (IsEqualIID(riid
, &IID_IClientSecurity
))
813 *ppv
= (void *)&This
->lpVtblCliSec
;
814 IUnknown_AddRef((IUnknown
*)*ppv
);
818 hr
= proxy_manager_find_ifproxy(This
, riid
, &ifproxy
);
821 *ppv
= ifproxy
->iface
;
822 IUnknown_AddRef((IUnknown
*)*ppv
);
827 return E_NOINTERFACE
;
830 static HRESULT
proxy_manager_create_ifproxy(
831 struct proxy_manager
* This
, const STDOBJREF
*stdobjref
, REFIID riid
,
832 IRpcChannelBuffer
* channel
, struct ifproxy
** iif_out
)
835 IPSFactoryBuffer
* psfb
;
836 struct ifproxy
* ifproxy
= HeapAlloc(GetProcessHeap(), 0, sizeof(*ifproxy
));
837 if (!ifproxy
) return E_OUTOFMEMORY
;
839 list_init(&ifproxy
->entry
);
841 ifproxy
->parent
= This
;
842 ifproxy
->stdobjref
= *stdobjref
;
843 ifproxy
->iid
= *riid
;
845 ifproxy
->proxy
= NULL
;
848 ifproxy
->chan
= channel
; /* FIXME: we should take the binding strings and construct the channel in this function */
850 /* the IUnknown interface is special because it does not have a
851 * proxy associated with the ifproxy as we handle IUnknown ourselves */
852 if (IsEqualIID(riid
, &IID_IUnknown
))
854 ifproxy
->iface
= (void *)&This
->lpVtbl
;
855 IMultiQI_AddRef((IMultiQI
*)&This
->lpVtbl
);
860 hr
= get_facbuf_for_iid(riid
, &psfb
);
863 /* important note: the outer unknown is set to the proxy manager.
864 * This ensures the COM identity rules are not violated, by having a
865 * one-to-one mapping of objects on the proxy side to objects on the
866 * stub side, no matter which interface you view the object through */
867 hr
= IPSFactoryBuffer_CreateProxy(psfb
, (IUnknown
*)&This
->lpVtbl
, riid
,
868 &ifproxy
->proxy
, &ifproxy
->iface
);
869 IPSFactoryBuffer_Release(psfb
);
871 ERR("Could not create proxy for interface %s, error 0x%08x\n",
872 debugstr_guid(riid
), hr
);
875 ERR("Could not get IPSFactoryBuffer for interface %s, error 0x%08x\n",
876 debugstr_guid(riid
), hr
);
879 hr
= IRpcProxyBuffer_Connect(ifproxy
->proxy
, ifproxy
->chan
);
884 EnterCriticalSection(&This
->cs
);
885 list_add_tail(&This
->interfaces
, &ifproxy
->entry
);
886 LeaveCriticalSection(&This
->cs
);
889 TRACE("ifproxy %p created for IPID %s, interface %s with %lu public refs\n",
890 ifproxy
, debugstr_guid(&stdobjref
->ipid
), debugstr_guid(riid
), stdobjref
->cPublicRefs
);
893 ifproxy_destroy(ifproxy
);
898 static HRESULT
proxy_manager_find_ifproxy(struct proxy_manager
* This
, REFIID riid
, struct ifproxy
** ifproxy_found
)
900 HRESULT hr
= E_NOINTERFACE
; /* assume not found */
901 struct list
* cursor
;
903 EnterCriticalSection(&This
->cs
);
904 LIST_FOR_EACH(cursor
, &This
->interfaces
)
906 struct ifproxy
* ifproxy
= LIST_ENTRY(cursor
, struct ifproxy
, entry
);
907 if (IsEqualIID(riid
, &ifproxy
->iid
))
909 *ifproxy_found
= ifproxy
;
914 LeaveCriticalSection(&This
->cs
);
919 static void proxy_manager_disconnect(struct proxy_manager
* This
)
921 struct list
* cursor
;
923 TRACE("oxid = %s, oid = %s\n", wine_dbgstr_longlong(This
->oxid
),
924 wine_dbgstr_longlong(This
->oid
));
926 EnterCriticalSection(&This
->cs
);
928 /* SORFP_NOLIFTIMEMGMT proxies (for IRemUnknown) shouldn't be
929 * disconnected - it won't do anything anyway, except cause
930 * problems for other objects that depend on this proxy always
932 if (!(This
->sorflags
& SORFP_NOLIFETIMEMGMT
))
934 LIST_FOR_EACH(cursor
, &This
->interfaces
)
936 struct ifproxy
* ifproxy
= LIST_ENTRY(cursor
, struct ifproxy
, entry
);
937 ifproxy_disconnect(ifproxy
);
941 /* apartment is being destroyed so don't keep a pointer around to it */
944 LeaveCriticalSection(&This
->cs
);
947 static HRESULT
proxy_manager_get_remunknown(struct proxy_manager
* This
, IRemUnknown
**remunk
)
951 /* we don't want to try and unmarshal or use IRemUnknown if we don't want
952 * lifetime management */
953 if (This
->sorflags
& SORFP_NOLIFETIMEMGMT
)
956 EnterCriticalSection(&This
->cs
);
958 /* already created - return existing object */
959 *remunk
= This
->remunk
;
960 else if (!This
->parent
)
961 /* disconnected - we can't create IRemUnknown */
966 /* Don't want IRemUnknown lifetime management as this is IRemUnknown!
967 * We also don't care about whether or not the stub is still alive */
968 stdobjref
.flags
= SORFP_NOLIFETIMEMGMT
| SORF_NOPING
;
969 stdobjref
.cPublicRefs
= 1;
970 /* oxid of destination object */
971 stdobjref
.oxid
= This
->oxid
;
972 /* FIXME: what should be used for the oid? The DCOM draft doesn't say */
973 stdobjref
.oid
= (OID
)-1;
974 stdobjref
.ipid
= This
->oxid_info
.ipidRemUnknown
;
976 /* do the unmarshal */
977 hr
= unmarshal_object(&stdobjref
, This
->parent
, This
->dest_context
,
978 This
->dest_context_data
, &IID_IRemUnknown
,
979 &This
->oxid_info
, (void**)&This
->remunk
);
981 *remunk
= This
->remunk
;
983 LeaveCriticalSection(&This
->cs
);
985 TRACE("got IRemUnknown* pointer %p, hr = 0x%08x\n", *remunk
, hr
);
990 /* destroys a proxy manager, freeing the memory it used.
991 * Note: this function should not be called from a list iteration in the
992 * apartment, due to the fact that it removes itself from the apartment and
993 * it could add a proxy to IRemUnknown into the apartment. */
994 static void proxy_manager_destroy(struct proxy_manager
* This
)
996 struct list
* cursor
;
998 TRACE("oxid = %s, oid = %s\n", wine_dbgstr_longlong(This
->oxid
),
999 wine_dbgstr_longlong(This
->oid
));
1003 EnterCriticalSection(&This
->parent
->cs
);
1005 /* remove ourself from the list of proxy objects in the apartment */
1006 LIST_FOR_EACH(cursor
, &This
->parent
->proxies
)
1008 if (cursor
== &This
->entry
)
1010 list_remove(&This
->entry
);
1015 LeaveCriticalSection(&This
->parent
->cs
);
1018 /* destroy all of the interface proxies */
1019 while ((cursor
= list_head(&This
->interfaces
)))
1021 struct ifproxy
* ifproxy
= LIST_ENTRY(cursor
, struct ifproxy
, entry
);
1022 ifproxy_destroy(ifproxy
);
1025 if (This
->remunk
) IRemUnknown_Release(This
->remunk
);
1026 CoTaskMemFree(This
->oxid_info
.psa
);
1028 DEBUG_CLEAR_CRITSEC_NAME(&This
->cs
);
1029 DeleteCriticalSection(&This
->cs
);
1031 CloseHandle(This
->remoting_mutex
);
1033 HeapFree(GetProcessHeap(), 0, This
);
1036 /* finds the proxy manager corresponding to a given OXID and OID that has
1037 * been unmarshaled in the specified apartment. The caller must release the
1038 * reference to the proxy_manager when the object is no longer used. */
1039 static BOOL
find_proxy_manager(APARTMENT
* apt
, OXID oxid
, OID oid
, struct proxy_manager
** proxy_found
)
1042 struct list
* cursor
;
1044 EnterCriticalSection(&apt
->cs
);
1045 LIST_FOR_EACH(cursor
, &apt
->proxies
)
1047 struct proxy_manager
* proxy
= LIST_ENTRY(cursor
, struct proxy_manager
, entry
);
1048 if ((oxid
== proxy
->oxid
) && (oid
== proxy
->oid
))
1050 *proxy_found
= proxy
;
1051 ClientIdentity_AddRef((IMultiQI
*)&proxy
->lpVtbl
);
1056 LeaveCriticalSection(&apt
->cs
);
1060 HRESULT
apartment_disconnectproxies(struct apartment
*apt
)
1062 struct list
* cursor
;
1064 LIST_FOR_EACH(cursor
, &apt
->proxies
)
1066 struct proxy_manager
* proxy
= LIST_ENTRY(cursor
, struct proxy_manager
, entry
);
1067 proxy_manager_disconnect(proxy
);
1073 /********************** StdMarshal implementation ****************************/
1074 typedef struct _StdMarshalImpl
1076 const IMarshalVtbl
*lpvtbl
;
1080 DWORD dwDestContext
;
1081 LPVOID pvDestContext
;
1085 static HRESULT WINAPI
1086 StdMarshalImpl_QueryInterface(LPMARSHAL iface
, REFIID riid
, LPVOID
*ppv
)
1089 if (IsEqualIID(&IID_IUnknown
, riid
) || IsEqualIID(&IID_IMarshal
, riid
))
1092 IUnknown_AddRef(iface
);
1095 FIXME("No interface for %s.\n", debugstr_guid(riid
));
1096 return E_NOINTERFACE
;
1100 StdMarshalImpl_AddRef(LPMARSHAL iface
)
1102 StdMarshalImpl
*This
= (StdMarshalImpl
*)iface
;
1103 return InterlockedIncrement(&This
->ref
);
1107 StdMarshalImpl_Release(LPMARSHAL iface
)
1109 StdMarshalImpl
*This
= (StdMarshalImpl
*)iface
;
1110 ULONG ref
= InterlockedDecrement(&This
->ref
);
1112 if (!ref
) HeapFree(GetProcessHeap(),0,This
);
1116 static HRESULT WINAPI
1117 StdMarshalImpl_GetUnmarshalClass(
1118 LPMARSHAL iface
, REFIID riid
, void* pv
, DWORD dwDestContext
,
1119 void* pvDestContext
, DWORD mshlflags
, CLSID
* pCid
)
1121 *pCid
= CLSID_DfMarshal
;
1125 static HRESULT WINAPI
1126 StdMarshalImpl_GetMarshalSizeMax(
1127 LPMARSHAL iface
, REFIID riid
, void* pv
, DWORD dwDestContext
,
1128 void* pvDestContext
, DWORD mshlflags
, DWORD
* pSize
)
1130 *pSize
= sizeof(STDOBJREF
);
1134 static HRESULT WINAPI
1135 StdMarshalImpl_MarshalInterface(
1136 LPMARSHAL iface
, IStream
*pStm
,REFIID riid
, void* pv
, DWORD dwDestContext
,
1137 void* pvDestContext
, DWORD mshlflags
)
1139 STDOBJREF stdobjref
;
1142 APARTMENT
*apt
= COM_CurrentApt();
1144 TRACE("(...,%s,...)\n", debugstr_guid(riid
));
1148 ERR("Apartment not initialized\n");
1149 return CO_E_NOTINITIALIZED
;
1152 /* make sure this apartment can be reached from other threads / processes */
1153 RPC_StartRemoting(apt
);
1155 hres
= marshal_object(apt
, &stdobjref
, riid
, (IUnknown
*)pv
, mshlflags
);
1158 ERR("Failed to create ifstub, hres=0x%x\n", hres
);
1162 hres
= IStream_Write(pStm
, &stdobjref
, sizeof(stdobjref
), &res
);
1163 if (hres
) return hres
;
1168 /* helper for StdMarshalImpl_UnmarshalInterface - does the unmarshaling with
1169 * no questions asked about the rules surrounding same-apartment unmarshals
1170 * and table marshaling */
1171 static HRESULT
unmarshal_object(const STDOBJREF
*stdobjref
, APARTMENT
*apt
,
1172 MSHCTX dest_context
, void *dest_context_data
,
1173 REFIID riid
, const OXID_INFO
*oxid_info
,
1176 struct proxy_manager
*proxy_manager
= NULL
;
1181 TRACE("stdobjref:\n\tflags = %04lx\n\tcPublicRefs = %ld\n\toxid = %s\n\toid = %s\n\tipid = %s\n",
1182 stdobjref
->flags
, stdobjref
->cPublicRefs
,
1183 wine_dbgstr_longlong(stdobjref
->oxid
),
1184 wine_dbgstr_longlong(stdobjref
->oid
),
1185 debugstr_guid(&stdobjref
->ipid
));
1187 /* create a new proxy manager if one doesn't already exist for the
1189 if (!find_proxy_manager(apt
, stdobjref
->oxid
, stdobjref
->oid
, &proxy_manager
))
1191 hr
= proxy_manager_construct(apt
, stdobjref
->flags
,
1192 stdobjref
->oxid
, stdobjref
->oid
, oxid_info
,
1196 TRACE("proxy manager already created, using\n");
1200 struct ifproxy
* ifproxy
;
1202 proxy_manager_set_context(proxy_manager
, dest_context
, dest_context_data
);
1204 hr
= proxy_manager_find_ifproxy(proxy_manager
, riid
, &ifproxy
);
1205 if (hr
== E_NOINTERFACE
)
1207 IRpcChannelBuffer
*chanbuf
;
1208 hr
= RPC_CreateClientChannel(&stdobjref
->oxid
, &stdobjref
->ipid
,
1209 &proxy_manager
->oxid_info
,
1210 proxy_manager
->dest_context
,
1211 proxy_manager
->dest_context_data
,
1214 hr
= proxy_manager_create_ifproxy(proxy_manager
, stdobjref
,
1215 riid
, chanbuf
, &ifproxy
);
1218 IUnknown_AddRef((IUnknown
*)ifproxy
->iface
);
1222 InterlockedExchangeAdd((LONG
*)&ifproxy
->refs
, stdobjref
->cPublicRefs
);
1223 /* get at least one external reference to the object to keep it alive */
1224 hr
= ifproxy_get_public_ref(ifproxy
);
1226 ifproxy_destroy(ifproxy
);
1230 *object
= ifproxy
->iface
;
1233 /* release our reference to the proxy manager - the client/apartment
1234 * will hold on to the remaining reference for us */
1235 if (proxy_manager
) ClientIdentity_Release((IMultiQI
*)&proxy_manager
->lpVtbl
);
1240 static HRESULT WINAPI
1241 StdMarshalImpl_UnmarshalInterface(LPMARSHAL iface
, IStream
*pStm
, REFIID riid
, void **ppv
)
1243 StdMarshalImpl
*This
= (StdMarshalImpl
*)iface
;
1244 struct stub_manager
*stubmgr
= NULL
;
1245 STDOBJREF stdobjref
;
1248 APARTMENT
*apt
= COM_CurrentApt();
1249 APARTMENT
*stub_apt
;
1252 TRACE("(...,%s,....)\n", debugstr_guid(riid
));
1254 /* we need an apartment to unmarshal into */
1257 ERR("Apartment not initialized\n");
1258 return CO_E_NOTINITIALIZED
;
1261 /* read STDOBJREF from wire */
1262 hres
= IStream_Read(pStm
, &stdobjref
, sizeof(stdobjref
), &res
);
1263 if (hres
) return STG_E_READFAULT
;
1265 hres
= apartment_getoxid(apt
, &oxid
);
1266 if (hres
) return hres
;
1268 /* check if we're marshalling back to ourselves */
1269 if ((oxid
== stdobjref
.oxid
) && (stubmgr
= get_stub_manager(apt
, stdobjref
.oid
)))
1271 TRACE("Unmarshalling object marshalled in same apartment for iid %s, "
1272 "returning original object %p\n", debugstr_guid(riid
), stubmgr
->object
);
1274 hres
= IUnknown_QueryInterface(stubmgr
->object
, riid
, ppv
);
1276 /* unref the ifstub. FIXME: only do this on success? */
1277 if (!stub_manager_is_table_marshaled(stubmgr
, &stdobjref
.ipid
))
1278 stub_manager_ext_release(stubmgr
, stdobjref
.cPublicRefs
, TRUE
);
1280 stub_manager_int_release(stubmgr
);
1284 /* notify stub manager about unmarshal if process-local object.
1285 * note: if the oxid is not found then we and native will quite happily
1286 * ignore table marshaling and normal marshaling rules regarding number of
1287 * unmarshals, etc, but if you abuse these rules then your proxy could end
1288 * up returning RPC_E_DISCONNECTED. */
1289 if ((stub_apt
= apartment_findfromoxid(stdobjref
.oxid
, TRUE
)))
1291 if ((stubmgr
= get_stub_manager(stub_apt
, stdobjref
.oid
)))
1293 if (!stub_manager_notify_unmarshal(stubmgr
, &stdobjref
.ipid
))
1294 hres
= CO_E_OBJNOTCONNECTED
;
1298 WARN("Couldn't find object for OXID %s, OID %s, assuming disconnected\n",
1299 wine_dbgstr_longlong(stdobjref
.oxid
),
1300 wine_dbgstr_longlong(stdobjref
.oid
));
1301 hres
= CO_E_OBJNOTCONNECTED
;
1305 TRACE("Treating unmarshal from OXID %s as inter-process\n",
1306 wine_dbgstr_longlong(stdobjref
.oxid
));
1309 hres
= unmarshal_object(&stdobjref
, apt
, This
->dwDestContext
,
1310 This
->pvDestContext
, riid
,
1311 stubmgr
? &stubmgr
->oxid_info
: NULL
, ppv
);
1313 if (stubmgr
) stub_manager_int_release(stubmgr
);
1314 if (stub_apt
) apartment_release(stub_apt
);
1316 if (hres
) WARN("Failed with error 0x%08x\n", hres
);
1317 else TRACE("Successfully created proxy %p\n", *ppv
);
1322 static HRESULT WINAPI
1323 StdMarshalImpl_ReleaseMarshalData(LPMARSHAL iface
, IStream
*pStm
)
1325 STDOBJREF stdobjref
;
1328 struct stub_manager
*stubmgr
;
1331 TRACE("iface=%p, pStm=%p\n", iface
, pStm
);
1333 hres
= IStream_Read(pStm
, &stdobjref
, sizeof(stdobjref
), &res
);
1334 if (hres
) return STG_E_READFAULT
;
1336 TRACE("oxid = %s, oid = %s, ipid = %s\n",
1337 wine_dbgstr_longlong(stdobjref
.oxid
),
1338 wine_dbgstr_longlong(stdobjref
.oid
),
1339 wine_dbgstr_guid(&stdobjref
.ipid
));
1341 if (!(apt
= apartment_findfromoxid(stdobjref
.oxid
, TRUE
)))
1343 WARN("Could not map OXID %s to apartment object\n",
1344 wine_dbgstr_longlong(stdobjref
.oxid
));
1345 return RPC_E_INVALID_OBJREF
;
1348 if (!(stubmgr
= get_stub_manager(apt
, stdobjref
.oid
)))
1350 ERR("could not map object ID to stub manager, oxid=%s, oid=%s\n",
1351 wine_dbgstr_longlong(stdobjref
.oxid
), wine_dbgstr_longlong(stdobjref
.oid
));
1352 return RPC_E_INVALID_OBJREF
;
1355 stub_manager_release_marshal_data(stubmgr
, stdobjref
.cPublicRefs
, &stdobjref
.ipid
);
1357 stub_manager_int_release(stubmgr
);
1358 apartment_release(apt
);
1363 static HRESULT WINAPI
1364 StdMarshalImpl_DisconnectObject(LPMARSHAL iface
, DWORD dwReserved
)
1366 FIXME("(), stub!\n");
1370 static const IMarshalVtbl VT_StdMarshal
=
1372 StdMarshalImpl_QueryInterface
,
1373 StdMarshalImpl_AddRef
,
1374 StdMarshalImpl_Release
,
1375 StdMarshalImpl_GetUnmarshalClass
,
1376 StdMarshalImpl_GetMarshalSizeMax
,
1377 StdMarshalImpl_MarshalInterface
,
1378 StdMarshalImpl_UnmarshalInterface
,
1379 StdMarshalImpl_ReleaseMarshalData
,
1380 StdMarshalImpl_DisconnectObject
1383 static HRESULT
StdMarshalImpl_Construct(REFIID riid
, void** ppvObject
)
1385 StdMarshalImpl
* pStdMarshal
=
1386 HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, sizeof(StdMarshalImpl
));
1388 return E_OUTOFMEMORY
;
1389 pStdMarshal
->lpvtbl
= &VT_StdMarshal
;
1390 pStdMarshal
->ref
= 0;
1391 return IMarshal_QueryInterface((IMarshal
*)pStdMarshal
, riid
, ppvObject
);
1394 /***********************************************************************
1395 * CoGetStandardMarshal [OLE32.@]
1397 * Gets or creates a standard marshal object.
1400 * riid [I] Interface identifier of the pUnk object.
1401 * pUnk [I] Optional. Object to get the marshal object for.
1402 * dwDestContext [I] Destination. Used to enable or disable optimizations.
1403 * pvDestContext [I] Reserved. Must be NULL.
1404 * mshlflags [I] Flags affecting the marshaling process.
1405 * ppMarshal [O] Address where marshal object will be stored.
1409 * Failure: HRESULT code.
1413 * The function retrieves the IMarshal object associated with an object if
1414 * that object is currently an active stub, otherwise a new marshal object is
1417 HRESULT WINAPI
CoGetStandardMarshal(REFIID riid
, IUnknown
*pUnk
,
1418 DWORD dwDestContext
, LPVOID pvDestContext
,
1419 DWORD mshlflags
, LPMARSHAL
*ppMarshal
)
1425 FIXME("(%s,NULL,%x,%p,%x,%p), unimplemented yet.\n",
1426 debugstr_guid(riid
),dwDestContext
,pvDestContext
,mshlflags
,ppMarshal
);
1429 TRACE("(%s,%p,%x,%p,%x,%p)\n",
1430 debugstr_guid(riid
),pUnk
,dwDestContext
,pvDestContext
,mshlflags
,ppMarshal
);
1431 *ppMarshal
= HeapAlloc(GetProcessHeap(),0,sizeof(StdMarshalImpl
));
1432 dm
= (StdMarshalImpl
*) *ppMarshal
;
1433 if (!dm
) return E_FAIL
;
1434 dm
->lpvtbl
= &VT_StdMarshal
;
1438 dm
->dwDestContext
= dwDestContext
;
1439 dm
->pvDestContext
= pvDestContext
;
1440 dm
->mshlflags
= mshlflags
;
1444 /***********************************************************************
1445 * get_marshaler [internal]
1447 * Retrieves an IMarshal interface for an object.
1449 static HRESULT
get_marshaler(REFIID riid
, IUnknown
*pUnk
, DWORD dwDestContext
,
1450 void *pvDestContext
, DWORD mshlFlags
,
1451 LPMARSHAL
*pMarshal
)
1457 hr
= IUnknown_QueryInterface(pUnk
, &IID_IMarshal
, (LPVOID
*)pMarshal
);
1459 hr
= CoGetStandardMarshal(riid
, pUnk
, dwDestContext
, pvDestContext
,
1460 mshlFlags
, pMarshal
);
1464 /***********************************************************************
1465 * get_unmarshaler_from_stream [internal]
1467 * Creates an IMarshal* object according to the data marshaled to the stream.
1468 * The function leaves the stream pointer at the start of the data written
1469 * to the stream by the IMarshal* object.
1471 static HRESULT
get_unmarshaler_from_stream(IStream
*stream
, IMarshal
**marshal
, IID
*iid
)
1477 /* read common OBJREF header */
1478 hr
= IStream_Read(stream
, &objref
, FIELD_OFFSET(OBJREF
, u_objref
), &res
);
1479 if (hr
|| (res
!= FIELD_OFFSET(OBJREF
, u_objref
)))
1481 ERR("Failed to read common OBJREF header, 0x%08x\n", hr
);
1482 return STG_E_READFAULT
;
1485 /* sanity check on header */
1486 if (objref
.signature
!= OBJREF_SIGNATURE
)
1488 ERR("Bad OBJREF signature 0x%08lx\n", objref
.signature
);
1489 return RPC_E_INVALID_OBJREF
;
1492 if (iid
) *iid
= objref
.iid
;
1494 /* FIXME: handler marshaling */
1495 if (objref
.flags
& OBJREF_STANDARD
)
1497 TRACE("Using standard unmarshaling\n");
1498 hr
= StdMarshalImpl_Construct(&IID_IMarshal
, (LPVOID
*)marshal
);
1500 else if (objref
.flags
& OBJREF_CUSTOM
)
1502 ULONG custom_header_size
= FIELD_OFFSET(OBJREF
, u_objref
.u_custom
.pData
) -
1503 FIELD_OFFSET(OBJREF
, u_objref
.u_custom
);
1504 TRACE("Using custom unmarshaling\n");
1505 /* read constant sized OR_CUSTOM data from stream */
1506 hr
= IStream_Read(stream
, &objref
.u_objref
.u_custom
,
1507 custom_header_size
, &res
);
1508 if (hr
|| (res
!= custom_header_size
))
1510 ERR("Failed to read OR_CUSTOM header, 0x%08x\n", hr
);
1511 return STG_E_READFAULT
;
1513 /* now create the marshaler specified in the stream */
1514 hr
= CoCreateInstance(&objref
.u_objref
.u_custom
.clsid
, NULL
,
1515 CLSCTX_INPROC_SERVER
, &IID_IMarshal
,
1520 FIXME("Invalid or unimplemented marshaling type specified: %lx\n",
1522 return RPC_E_INVALID_OBJREF
;
1526 ERR("Failed to create marshal, 0x%08x\n", hr
);
1531 /***********************************************************************
1532 * CoGetMarshalSizeMax [OLE32.@]
1534 * Gets the maximum amount of data that will be needed by a marshal.
1537 * pulSize [O] Address where maximum marshal size will be stored.
1538 * riid [I] Identifier of the interface to marshal.
1539 * pUnk [I] Pointer to the object to marshal.
1540 * dwDestContext [I] Destination. Used to enable or disable optimizations.
1541 * pvDestContext [I] Reserved. Must be NULL.
1542 * mshlFlags [I] Flags that affect the marshaling. See CoMarshalInterface().
1546 * Failure: HRESULT code.
1549 * CoMarshalInterface().
1551 HRESULT WINAPI
CoGetMarshalSizeMax(ULONG
*pulSize
, REFIID riid
, IUnknown
*pUnk
,
1552 DWORD dwDestContext
, void *pvDestContext
,
1557 CLSID marshaler_clsid
;
1559 hr
= get_marshaler(riid
, pUnk
, dwDestContext
, pvDestContext
, mshlFlags
, &pMarshal
);
1563 hr
= IMarshal_GetUnmarshalClass(pMarshal
, riid
, pUnk
, dwDestContext
,
1564 pvDestContext
, mshlFlags
, &marshaler_clsid
);
1567 ERR("IMarshal::GetUnmarshalClass failed, 0x%08x\n", hr
);
1568 IMarshal_Release(pMarshal
);
1572 hr
= IMarshal_GetMarshalSizeMax(pMarshal
, riid
, pUnk
, dwDestContext
,
1573 pvDestContext
, mshlFlags
, pulSize
);
1574 if (IsEqualCLSID(&marshaler_clsid
, &CLSID_DfMarshal
))
1575 /* add on the size of the common header */
1576 *pulSize
+= FIELD_OFFSET(OBJREF
, u_objref
);
1578 /* custom marshaling: add on the size of the whole OBJREF structure
1579 * like native does */
1580 *pulSize
+= sizeof(OBJREF
);
1582 IMarshal_Release(pMarshal
);
1587 static void dump_MSHLFLAGS(MSHLFLAGS flags
)
1589 if (flags
& MSHLFLAGS_TABLESTRONG
)
1590 TRACE(" MSHLFLAGS_TABLESTRONG");
1591 if (flags
& MSHLFLAGS_TABLEWEAK
)
1592 TRACE(" MSHLFLAGS_TABLEWEAK");
1593 if (!(flags
& (MSHLFLAGS_TABLESTRONG
|MSHLFLAGS_TABLEWEAK
)))
1594 TRACE(" MSHLFLAGS_NORMAL");
1595 if (flags
& MSHLFLAGS_NOPING
)
1596 TRACE(" MSHLFLAGS_NOPING");
1599 /***********************************************************************
1600 * CoMarshalInterface [OLE32.@]
1602 * Marshals an interface into a stream so that the object can then be
1603 * unmarshaled from another COM apartment and used remotely.
1606 * pStream [I] Stream the object will be marshaled into.
1607 * riid [I] Identifier of the interface to marshal.
1608 * pUnk [I] Pointer to the object to marshal.
1609 * dwDestContext [I] Destination. Used to enable or disable optimizations.
1610 * pvDestContext [I] Reserved. Must be NULL.
1611 * mshlFlags [I] Flags that affect the marshaling. See notes.
1615 * Failure: HRESULT code.
1619 * The mshlFlags parameter can take one or more of the following flags:
1620 *| MSHLFLAGS_NORMAL - Unmarshal once, releases stub on last proxy release.
1621 *| MSHLFLAGS_TABLESTRONG - Unmarshal many, release when CoReleaseMarshalData() called.
1622 *| MSHLFLAGS_TABLEWEAK - Unmarshal many, releases stub on last proxy release.
1623 *| MSHLFLAGS_NOPING - No automatic garbage collection (and so reduces network traffic).
1625 * If a marshaled object is not unmarshaled, then CoReleaseMarshalData() must
1626 * be called in order to release the resources used in the marshaling.
1629 * CoUnmarshalInterface(), CoReleaseMarshalData().
1631 HRESULT WINAPI
CoMarshalInterface(IStream
*pStream
, REFIID riid
, IUnknown
*pUnk
,
1632 DWORD dwDestContext
, void *pvDestContext
,
1636 CLSID marshaler_clsid
;
1640 TRACE("(%p, %s, %p, %x, %p,", pStream
, debugstr_guid(riid
), pUnk
,
1641 dwDestContext
, pvDestContext
);
1642 dump_MSHLFLAGS(mshlFlags
);
1645 if (!pUnk
|| !pStream
)
1646 return E_INVALIDARG
;
1648 objref
.signature
= OBJREF_SIGNATURE
;
1651 /* get the marshaler for the specified interface */
1652 hr
= get_marshaler(riid
, pUnk
, dwDestContext
, pvDestContext
, mshlFlags
, &pMarshal
);
1655 ERR("Failed to get marshaller, 0x%08x\n", hr
);
1659 hr
= IMarshal_GetUnmarshalClass(pMarshal
, riid
, pUnk
, dwDestContext
,
1660 pvDestContext
, mshlFlags
, &marshaler_clsid
);
1663 ERR("IMarshal::GetUnmarshalClass failed, 0x%08x\n", hr
);
1667 /* FIXME: implement handler marshaling too */
1668 if (IsEqualCLSID(&marshaler_clsid
, &CLSID_DfMarshal
))
1670 TRACE("Using standard marshaling\n");
1671 objref
.flags
= OBJREF_STANDARD
;
1673 /* write the common OBJREF header to the stream */
1674 hr
= IStream_Write(pStream
, &objref
, FIELD_OFFSET(OBJREF
, u_objref
), NULL
);
1677 ERR("Failed to write OBJREF header to stream, 0x%08x\n", hr
);
1683 TRACE("Using custom marshaling\n");
1684 objref
.flags
= OBJREF_CUSTOM
;
1685 objref
.u_objref
.u_custom
.clsid
= marshaler_clsid
;
1686 objref
.u_objref
.u_custom
.cbExtension
= 0;
1687 objref
.u_objref
.u_custom
.size
= 0;
1688 hr
= IMarshal_GetMarshalSizeMax(pMarshal
, riid
, pUnk
, dwDestContext
,
1689 pvDestContext
, mshlFlags
,
1690 &objref
.u_objref
.u_custom
.size
);
1693 ERR("Failed to get max size of marshal data, error 0x%08x\n", hr
);
1696 /* write constant sized common header and OR_CUSTOM data into stream */
1697 hr
= IStream_Write(pStream
, &objref
,
1698 FIELD_OFFSET(OBJREF
, u_objref
.u_custom
.pData
), NULL
);
1701 ERR("Failed to write OR_CUSTOM header to stream with 0x%08x\n", hr
);
1706 TRACE("Calling IMarshal::MarshalInterace\n");
1707 /* call helper object to do the actual marshaling */
1708 hr
= IMarshal_MarshalInterface(pMarshal
, pStream
, riid
, pUnk
, dwDestContext
,
1709 pvDestContext
, mshlFlags
);
1713 ERR("Failed to marshal the interface %s, %x\n", debugstr_guid(riid
), hr
);
1718 IMarshal_Release(pMarshal
);
1720 TRACE("completed with hr 0x%08x\n", hr
);
1725 /***********************************************************************
1726 * CoUnmarshalInterface [OLE32.@]
1728 * Unmarshals an object from a stream by creating a proxy to the remote
1729 * object, if necessary.
1733 * pStream [I] Stream containing the marshaled object.
1734 * riid [I] Interface identifier of the object to create a proxy to.
1735 * ppv [O] Address where proxy will be stored.
1740 * Failure: HRESULT code.
1743 * CoMarshalInterface().
1745 HRESULT WINAPI
CoUnmarshalInterface(IStream
*pStream
, REFIID riid
, LPVOID
*ppv
)
1752 TRACE("(%p, %s, %p)\n", pStream
, debugstr_guid(riid
), ppv
);
1754 if (!pStream
|| !ppv
)
1755 return E_INVALIDARG
;
1757 hr
= get_unmarshaler_from_stream(pStream
, &pMarshal
, &iid
);
1761 /* call the helper object to do the actual unmarshaling */
1762 hr
= IMarshal_UnmarshalInterface(pMarshal
, pStream
, &iid
, (LPVOID
*)&object
);
1764 ERR("IMarshal::UnmarshalInterface failed, 0x%08x\n", hr
);
1768 /* IID_NULL means use the interface ID of the marshaled object */
1769 if (!IsEqualIID(riid
, &IID_NULL
) && !IsEqualIID(riid
, &iid
))
1771 TRACE("requested interface != marshalled interface, additional QI needed\n");
1772 hr
= IUnknown_QueryInterface(object
, riid
, ppv
);
1774 ERR("Couldn't query for interface %s, hr = 0x%08x\n",
1775 debugstr_guid(riid
), hr
);
1776 IUnknown_Release(object
);
1784 IMarshal_Release(pMarshal
);
1786 TRACE("completed with hr 0x%x\n", hr
);
1791 /***********************************************************************
1792 * CoReleaseMarshalData [OLE32.@]
1794 * Releases resources associated with an object that has been marshaled into
1799 * pStream [I] The stream that the object has been marshaled into.
1803 * Failure: HRESULT error code.
1807 * Call this function to release resources associated with a normal or
1808 * table-weak marshal that will not be unmarshaled, and all table-strong
1809 * marshals when they are no longer needed.
1812 * CoMarshalInterface(), CoUnmarshalInterface().
1814 HRESULT WINAPI
CoReleaseMarshalData(IStream
*pStream
)
1819 TRACE("(%p)\n", pStream
);
1821 hr
= get_unmarshaler_from_stream(pStream
, &pMarshal
, NULL
);
1825 /* call the helper object to do the releasing of marshal data */
1826 hr
= IMarshal_ReleaseMarshalData(pMarshal
, pStream
);
1828 ERR("IMarshal::ReleaseMarshalData failed with error 0x%08x\n", hr
);
1830 IMarshal_Release(pMarshal
);
1835 /***********************************************************************
1836 * CoMarshalInterThreadInterfaceInStream [OLE32.@]
1838 * Marshal an interface across threads in the same process.
1841 * riid [I] Identifier of the interface to be marshalled.
1842 * pUnk [I] Pointer to IUnknown-derived interface that will be marshalled.
1843 * ppStm [O] Pointer to IStream object that is created and then used to store the marshalled interface.
1847 * Failure: E_OUTOFMEMORY and other COM error codes
1850 * CoMarshalInterface(), CoUnmarshalInterface() and CoGetInterfaceAndReleaseStream()
1852 HRESULT WINAPI
CoMarshalInterThreadInterfaceInStream(
1853 REFIID riid
, LPUNKNOWN pUnk
, LPSTREAM
* ppStm
)
1855 ULARGE_INTEGER xpos
;
1856 LARGE_INTEGER seekto
;
1859 TRACE("(%s, %p, %p)\n",debugstr_guid(riid
), pUnk
, ppStm
);
1861 hres
= CreateStreamOnHGlobal(NULL
, TRUE
, ppStm
);
1862 if (FAILED(hres
)) return hres
;
1863 hres
= CoMarshalInterface(*ppStm
, riid
, pUnk
, MSHCTX_INPROC
, NULL
, MSHLFLAGS_NORMAL
);
1865 if (SUCCEEDED(hres
))
1867 memset(&seekto
, 0, sizeof(seekto
));
1868 IStream_Seek(*ppStm
, seekto
, STREAM_SEEK_SET
, &xpos
);
1872 IStream_Release(*ppStm
);
1879 /***********************************************************************
1880 * CoGetInterfaceAndReleaseStream [OLE32.@]
1882 * Unmarshalls an interface from a stream and then releases the stream.
1885 * pStm [I] Stream that contains the marshalled interface.
1886 * riid [I] Interface identifier of the object to unmarshall.
1887 * ppv [O] Address of pointer where the requested interface object will be stored.
1891 * Failure: A COM error code
1894 * CoMarshalInterThreadInterfaceInStream() and CoUnmarshalInterface()
1896 HRESULT WINAPI
CoGetInterfaceAndReleaseStream(LPSTREAM pStm
, REFIID riid
,
1901 TRACE("(%p, %s, %p)\n", pStm
, debugstr_guid(riid
), ppv
);
1903 if(!pStm
) return E_INVALIDARG
;
1904 hres
= CoUnmarshalInterface(pStm
, riid
, ppv
);
1905 IStream_Release(pStm
);
1909 static HRESULT WINAPI
StdMarshalCF_QueryInterface(LPCLASSFACTORY iface
,
1910 REFIID riid
, LPVOID
*ppv
)
1913 if (IsEqualIID(riid
, &IID_IUnknown
) || IsEqualIID(riid
, &IID_IClassFactory
))
1915 *ppv
= (LPVOID
)iface
;
1918 return E_NOINTERFACE
;
1921 static ULONG WINAPI
StdMarshalCF_AddRef(LPCLASSFACTORY iface
)
1923 return 2; /* non-heap based object */
1926 static ULONG WINAPI
StdMarshalCF_Release(LPCLASSFACTORY iface
)
1928 return 1; /* non-heap based object */
1931 static HRESULT WINAPI
StdMarshalCF_CreateInstance(LPCLASSFACTORY iface
,
1932 LPUNKNOWN pUnk
, REFIID riid
, LPVOID
*ppv
)
1934 if (IsEqualIID(riid
, &IID_IUnknown
) || IsEqualIID(riid
, &IID_IMarshal
))
1935 return StdMarshalImpl_Construct(riid
, ppv
);
1937 FIXME("(%s), not supported.\n",debugstr_guid(riid
));
1938 return E_NOINTERFACE
;
1941 static HRESULT WINAPI
StdMarshalCF_LockServer(LPCLASSFACTORY iface
, BOOL fLock
)
1943 FIXME("(%d), stub!\n",fLock
);
1947 static const IClassFactoryVtbl StdMarshalCFVtbl
=
1949 StdMarshalCF_QueryInterface
,
1950 StdMarshalCF_AddRef
,
1951 StdMarshalCF_Release
,
1952 StdMarshalCF_CreateInstance
,
1953 StdMarshalCF_LockServer
1955 static const IClassFactoryVtbl
*StdMarshalCF
= &StdMarshalCFVtbl
;
1957 HRESULT
MARSHAL_GetStandardMarshalCF(LPVOID
*ppv
)
1959 *ppv
= &StdMarshalCF
;
1963 /***********************************************************************
1964 * CoMarshalHresult [OLE32.@]
1966 * Marshals an HRESULT value into a stream.
1969 * pStm [I] Stream that hresult will be marshalled into.
1970 * hresult [I] HRESULT to be marshalled.
1974 * Failure: A COM error code
1977 * CoUnmarshalHresult().
1979 HRESULT WINAPI
CoMarshalHresult(LPSTREAM pStm
, HRESULT hresult
)
1981 return IStream_Write(pStm
, &hresult
, sizeof(hresult
), NULL
);
1984 /***********************************************************************
1985 * CoUnmarshalHresult [OLE32.@]
1987 * Unmarshals an HRESULT value from a stream.
1990 * pStm [I] Stream that hresult will be unmarshalled from.
1991 * phresult [I] Pointer to HRESULT where the value will be unmarshalled to.
1995 * Failure: A COM error code
1998 * CoMarshalHresult().
2000 HRESULT WINAPI
CoUnmarshalHresult(LPSTREAM pStm
, HRESULT
* phresult
)
2002 return IStream_Read(pStm
, phresult
, sizeof(*phresult
), NULL
);