4 * Copyright 2002 Marcus Meissner
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
42 #include "wine/unicode.h"
43 #include "wine/winbase16.h"
44 #include "compobj_private.h"
47 #include "wine/debug.h"
49 WINE_DEFAULT_DEBUG_CHANNEL(ole);
51 extern const CLSID CLSID_DfMarshal;
53 /* Marshalling just passes a unique identifier to the remote client,
54 * that makes it possible to find the passed interface again.
56 * So basically we need a set of values that make it unique.
58 * Process Identifier, Object IUnknown ptr, IID
60 * Note that the IUnknown_QI(ob,xiid,&ppv) always returns the SAME ppv value!
64 get_facbuf_for_iid(REFIID riid,IPSFactoryBuffer **facbuf) {
68 if ((hres = CoGetPSClsid(riid,&pxclsid)))
70 return CoGetClassObject(&pxclsid,CLSCTX_INPROC_SERVER,NULL,&IID_IPSFactoryBuffer,(LPVOID*)facbuf);
73 typedef struct _wine_marshal_data {
78 typedef struct _mid2unknown {
83 typedef struct _mid2stub {
90 static mid2stub *stubs = NULL;
91 static int nrofstubs = 0;
93 static mid2unknown *proxies = NULL;
94 static int nrofproxies = 0;
96 void MARSHAL_Invalidate_Stub_From_MID(wine_marshal_id *mid) {
99 for (i=0;i<nrofstubs;i++) {
100 if (!stubs[i].valid) continue;
102 if (MARSHAL_Compare_Mids(mid,&(stubs[i].mid))) {
103 stubs[i].valid = FALSE;
112 MARSHAL_Find_Stub_Buffer(wine_marshal_id *mid,IRpcStubBuffer **stub) {
115 for (i=0;i<nrofstubs;i++) {
116 if (!stubs[i].valid) continue;
118 if (MARSHAL_Compare_Mids(mid,&(stubs[i].mid))) {
119 *stub = stubs[i].stub;
120 IUnknown_AddRef((*stub));
128 MARSHAL_Find_Stub(wine_marshal_id *mid,LPUNKNOWN *pUnk) {
131 for (i=0;i<nrofstubs;i++) {
132 if (!stubs[i].valid) continue;
134 if (MARSHAL_Compare_Mids(mid,&(stubs[i].mid))) {
135 *pUnk = stubs[i].pUnkServer;
136 IUnknown_AddRef((*pUnk));
144 MARSHAL_Register_Stub(wine_marshal_id *mid,LPUNKNOWN pUnk,IRpcStubBuffer *stub) {
146 if (!MARSHAL_Find_Stub(mid,&xPunk)) {
147 FIXME("Already have entry for (%lx/%s)!\n",mid->objectid,debugstr_guid(&(mid->iid)));
151 stubs=HeapReAlloc(GetProcessHeap(),0,stubs,sizeof(stubs[0])*(nrofstubs+1));
153 stubs=HeapAlloc(GetProcessHeap(),0,sizeof(stubs[0]));
154 if (!stubs) return E_OUTOFMEMORY;
155 stubs[nrofstubs].stub = stub;
156 stubs[nrofstubs].pUnkServer = pUnk;
157 memcpy(&(stubs[nrofstubs].mid),mid,sizeof(*mid));
158 stubs[nrofstubs].valid = TRUE; /* set to false when released by ReleaseMarshalData */
164 MARSHAL_Disconnect_Proxies() {
167 TRACE("Disconnecting %d proxies\n", nrofproxies);
169 for (i = 0; i < nrofproxies; i++)
170 IRpcProxyBuffer_Disconnect((IRpcProxyBuffer*)proxies[i].pUnk);
176 MARSHAL_Register_Proxy(wine_marshal_id *mid,LPUNKNOWN punk) {
179 for (i=0;i<nrofproxies;i++) {
180 if (MARSHAL_Compare_Mids(mid,&(proxies[i].mid))) {
181 ERR("Already have mid?\n");
186 proxies = HeapReAlloc(GetProcessHeap(),0,proxies,sizeof(proxies[0])*(nrofproxies+1));
188 proxies = HeapAlloc(GetProcessHeap(),0,sizeof(proxies[0]));
189 memcpy(&(proxies[nrofproxies].mid),mid,sizeof(*mid));
190 proxies[nrofproxies].pUnk = punk;
192 IUnknown_AddRef(punk);
196 /********************** StdMarshal implementation ****************************/
197 typedef struct _StdMarshalImpl {
198 IMarshalVtbl *lpvtbl;
203 LPVOID pvDestContext;
207 static HRESULT WINAPI
208 StdMarshalImpl_QueryInterface(LPMARSHAL iface,REFIID riid,LPVOID *ppv) {
210 if (IsEqualIID(&IID_IUnknown,riid) || IsEqualIID(&IID_IMarshal,riid)) {
212 IUnknown_AddRef(iface);
215 FIXME("No interface for %s.\n",debugstr_guid(riid));
216 return E_NOINTERFACE;
220 StdMarshalImpl_AddRef(LPMARSHAL iface) {
221 StdMarshalImpl *This = (StdMarshalImpl *)iface;
222 return InterlockedIncrement(&This->ref);
226 StdMarshalImpl_Release(LPMARSHAL iface) {
227 StdMarshalImpl *This = (StdMarshalImpl *)iface;
228 ULONG ref = InterlockedDecrement(&This->ref);
230 if (!ref) HeapFree(GetProcessHeap(),0,This);
234 static HRESULT WINAPI
235 StdMarshalImpl_GetUnmarshalClass(
236 LPMARSHAL iface, REFIID riid, void* pv, DWORD dwDestContext,
237 void* pvDestContext, DWORD mshlflags, CLSID* pCid
239 memcpy(pCid,&CLSID_DfMarshal,sizeof(CLSID_DfMarshal));
243 static HRESULT WINAPI
244 StdMarshalImpl_GetMarshalSizeMax(
245 LPMARSHAL iface, REFIID riid, void* pv, DWORD dwDestContext,
246 void* pvDestContext, DWORD mshlflags, DWORD* pSize
248 *pSize = sizeof(wine_marshal_id)+sizeof(wine_marshal_data);
252 static HRESULT WINAPI
253 StdMarshalImpl_MarshalInterface(
254 LPMARSHAL iface, IStream *pStm,REFIID riid, void* pv, DWORD dwDestContext,
255 void* pvDestContext, DWORD mshlflags
258 wine_marshal_data md;
262 IRpcStubBuffer *stub;
263 IPSFactoryBuffer *psfacbuf;
265 TRACE("(...,%s,...)\n",debugstr_guid(riid));
267 IUnknown_QueryInterface((LPUNKNOWN)pv,&IID_IUnknown,(LPVOID*)&pUnk);
268 mid.processid = GetCurrentProcessId();
269 mid.objectid = (DWORD)pUnk; /* FIXME */
270 IUnknown_Release(pUnk);
271 memcpy(&mid.iid,riid,sizeof(mid.iid));
272 md.dwDestContext = dwDestContext;
273 md.mshlflags = mshlflags;
274 hres = IStream_Write(pStm,&mid,sizeof(mid),&res);
275 if (hres) return hres;
276 hres = IStream_Write(pStm,&md,sizeof(md),&res);
277 if (hres) return hres;
279 if (SUCCEEDED(MARSHAL_Find_Stub_Buffer(&mid,&stub))) {
280 /* Find_Stub_Buffer gives us a ref but we want to keep it, as if we'd created a new one */
281 TRACE("Found RpcStubBuffer %p\n", stub);
284 hres = get_facbuf_for_iid(riid,&psfacbuf);
285 if (hres) return hres;
287 hres = IPSFactoryBuffer_CreateStub(psfacbuf,riid,pv,&stub);
288 IPSFactoryBuffer_Release(psfacbuf);
290 FIXME("Failed to create a stub for %s\n",debugstr_guid(riid));
293 IUnknown_QueryInterface((LPUNKNOWN)pv,riid,(LPVOID*)&pUnk);
294 MARSHAL_Register_Stub(&mid,pUnk,stub);
295 IUnknown_Release(pUnk);
299 static HRESULT WINAPI
300 StdMarshalImpl_UnmarshalInterface(
301 LPMARSHAL iface, IStream *pStm, REFIID riid, void **ppv
304 wine_marshal_data md;
307 IPSFactoryBuffer *psfacbuf;
308 IRpcProxyBuffer *rpcproxy;
309 IRpcChannelBuffer *chanbuf;
311 TRACE("(...,%s,....)\n",debugstr_guid(riid));
312 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
313 if (hres) return hres;
314 hres = IStream_Read(pStm,&md,sizeof(md),&res);
315 if (hres) return hres;
316 if (SUCCEEDED(MARSHAL_Find_Stub(&mid,(LPUNKNOWN*)ppv))) {
317 FIXME("Calling back to ourselves for %s!\n",debugstr_guid(riid));
320 if (IsEqualIID(riid, &IID_IUnknown) || IsEqualIID(riid, &IID_NULL)) {
321 /* should return proxy manager IUnknown object */
322 FIXME("Special treatment required for IID of %s\n", debugstr_guid(riid));
324 hres = get_facbuf_for_iid(riid,&psfacbuf);
325 if (hres) return hres;
326 hres = IPSFactoryBuffer_CreateProxy(psfacbuf,NULL,riid,&rpcproxy,ppv);
328 FIXME("Failed to create a proxy for %s\n",debugstr_guid(riid));
332 MARSHAL_Register_Proxy(&mid, (LPUNKNOWN) rpcproxy);
334 hres = PIPE_GetNewPipeBuf(&mid,&chanbuf);
335 IPSFactoryBuffer_Release(psfacbuf);
337 ERR("Failed to get an rpc channel buffer for %s\n",debugstr_guid(riid));
339 /* Connect the channel buffer to the proxy and release the no longer
341 * NOTE: The proxy should have taken an extra reference because it also
342 * aggregates the object, so we can safely release our reference to it. */
343 IRpcProxyBuffer_Connect(rpcproxy,chanbuf);
344 IRpcProxyBuffer_Release(rpcproxy);
345 /* IRpcProxyBuffer takes a reference on the channel buffer and
346 * we no longer need it, so release it */
347 IRpcChannelBuffer_Release(chanbuf);
352 static HRESULT WINAPI
353 StdMarshalImpl_ReleaseMarshalData(LPMARSHAL iface, IStream *pStm) {
357 IRpcStubBuffer *stub = NULL;
360 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
361 if (hres) return hres;
363 for (i=0; i < nrofstubs; i++)
365 if (!stubs[i].valid) continue;
367 if (MARSHAL_Compare_Mids(&mid, &(stubs[i].mid)))
369 stub = stubs[i].stub;
376 FIXME("Could not map MID to stub??\n");
380 res = IRpcStubBuffer_Release(stub);
381 stubs[i].valid = FALSE;
382 TRACE("stub refcount of %p is %ld\n", stub, res);
387 static HRESULT WINAPI
388 StdMarshalImpl_DisconnectObject(LPMARSHAL iface, DWORD dwReserved) {
389 FIXME("(), stub!\n");
393 IMarshalVtbl stdmvtbl = {
394 StdMarshalImpl_QueryInterface,
395 StdMarshalImpl_AddRef,
396 StdMarshalImpl_Release,
397 StdMarshalImpl_GetUnmarshalClass,
398 StdMarshalImpl_GetMarshalSizeMax,
399 StdMarshalImpl_MarshalInterface,
400 StdMarshalImpl_UnmarshalInterface,
401 StdMarshalImpl_ReleaseMarshalData,
402 StdMarshalImpl_DisconnectObject
405 /***********************************************************************
406 * CoGetStandardMarshal [OLE32.@]
408 * When the COM library in the client process receives a marshalled
409 * interface pointer, it looks for a CLSID to be used in creating a proxy
410 * for the purposes of unmarshalling the packet. If the packet does not
411 * contain a CLSID for the proxy, COM calls CoGetStandardMarshal, passing a
413 * This function creates a standard proxy in the client process and returns
414 * a pointer to that proxy's implementation of IMarshal.
415 * COM uses this pointer to call CoUnmarshalInterface to retrieve the pointer
416 * to the requested interface.
419 CoGetStandardMarshal(
420 REFIID riid,IUnknown *pUnk,DWORD dwDestContext,LPVOID pvDestContext,
421 DWORD mshlflags, LPMARSHAL *pMarshal
426 FIXME("(%s,NULL,%lx,%p,%lx,%p), unimplemented yet.\n",
427 debugstr_guid(riid),dwDestContext,pvDestContext,mshlflags,pMarshal
431 TRACE("(%s,%p,%lx,%p,%lx,%p)\n",
432 debugstr_guid(riid),pUnk,dwDestContext,pvDestContext,mshlflags,pMarshal
434 *pMarshal = HeapAlloc(GetProcessHeap(),0,sizeof(StdMarshalImpl));
435 dm = (StdMarshalImpl*) *pMarshal;
436 if (!dm) return E_FAIL;
437 dm->lpvtbl = &stdmvtbl;
440 memcpy(&dm->iid,riid,sizeof(dm->iid));
441 dm->dwDestContext = dwDestContext;
442 dm->pvDestContext = pvDestContext;
443 dm->mshlflags = mshlflags;
447 /* Helper function for getting Marshaler */
448 static HRESULT WINAPI
449 _GetMarshaller(REFIID riid, IUnknown *pUnk,DWORD dwDestContext,
450 void *pvDestContext, DWORD mshlFlags, LPMARSHAL *pMarshal
456 hres = IUnknown_QueryInterface(pUnk,&IID_IMarshal,(LPVOID*)pMarshal);
458 hres = CoGetStandardMarshal(riid,pUnk,dwDestContext,pvDestContext,mshlFlags,pMarshal);
462 /***********************************************************************
463 * CoGetMarshalSizeMax [OLE32.@]
466 CoGetMarshalSizeMax(ULONG *pulSize, REFIID riid, IUnknown *pUnk,
467 DWORD dwDestContext, void *pvDestContext, DWORD mshlFlags
472 hres = _GetMarshaller(riid,pUnk,dwDestContext,pvDestContext,mshlFlags,&pMarshal);
475 hres = IMarshal_GetMarshalSizeMax(pMarshal,riid,pUnk,dwDestContext,pvDestContext,mshlFlags,pulSize);
476 *pulSize += sizeof(wine_marshal_id)+sizeof(wine_marshal_data)+sizeof(CLSID);
477 IMarshal_Release(pMarshal);
482 /***********************************************************************
483 * CoMarshalInterface [OLE32.@]
486 CoMarshalInterface( IStream *pStm, REFIID riid, IUnknown *pUnk,
487 DWORD dwDestContext, void *pvDestContext, DWORD mshlflags
494 wine_marshal_data md;
498 TRACE("(%p, %s, %p, %lx, %p, %lx)\n",
499 pStm,debugstr_guid(riid),pUnk,dwDestContext,pvDestContext,mshlflags
505 STUBMGR_Start(); /* Just to be sure we have one running. */
506 mid.processid = GetCurrentProcessId();
507 IUnknown_QueryInterface(pUnk,&IID_IUnknown,(LPVOID*)&pUnknown);
508 mid.objectid = (DWORD)pUnknown;
509 IUnknown_Release(pUnknown);
510 memcpy(&mid.iid,riid,sizeof(mid.iid));
511 md.dwDestContext = dwDestContext;
512 md.mshlflags = mshlflags;
513 hres = IStream_Write(pStm,&mid,sizeof(mid),&res);
514 if (hres) return hres;
515 hres = IStream_Write(pStm,&md,sizeof(md),&res);
516 if (hres) return hres;
517 hres = _GetMarshaller(riid,pUnk,dwDestContext,pvDestContext,mshlflags,&pMarshal);
519 FIXME("Failed to get marshaller, %lx?\n",hres);
522 hres = IMarshal_GetUnmarshalClass(pMarshal,riid,pUnk,dwDestContext,pvDestContext,mshlflags,&xclsid);
524 FIXME("IMarshal:GetUnmarshalClass failed, %lx\n",hres);
525 goto release_marshal;
527 hres = IStream_Write(pStm,&xclsid,sizeof(xclsid),&writeres);
529 FIXME("Stream write failed, %lx\n",hres);
530 goto release_marshal;
533 TRACE("Calling IMarshal::MarshalInterace\n");
534 hres = IMarshal_MarshalInterface(pMarshal,pStm,riid,pUnk,dwDestContext,pvDestContext,mshlflags);
537 if (IsEqualGUID(riid,&IID_IOleObject)) {
538 ERR("WINE currently cannot marshal IOleObject interfaces. This means you cannot embed/link OLE objects between applications.\n");
540 FIXME("Failed to marshal the interface %s, %lx?\n",debugstr_guid(riid),hres);
544 IMarshal_Release(pMarshal);
549 /***********************************************************************
550 * CoUnmarshalInterface [OLE32.@]
553 CoUnmarshalInterface(IStream *pStm, REFIID riid, LPVOID *ppv) {
556 wine_marshal_data md;
562 TRACE("(%p,%s,%p)\n",pStm,debugstr_guid(riid),ppv);
564 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
566 FIXME("Stream read 1 failed, %lx, (%ld of %d)\n",hres,res,sizeof(mid));
569 hres = IStream_Read(pStm,&md,sizeof(md),&res);
571 FIXME("Stream read 2 failed, %lx, (%ld of %d)\n",hres,res,sizeof(md));
574 hres = IStream_Read(pStm,&xclsid,sizeof(xclsid),&res);
576 FIXME("Stream read 3 failed, %lx, (%ld of %d)\n",hres,res,sizeof(xclsid));
579 hres=CoCreateInstance(&xclsid,NULL,CLSCTX_INPROC_SERVER | CLSCTX_INPROC_HANDLER | CLSCTX_LOCAL_SERVER,&IID_IMarshal,(void**)&pUnk);
581 FIXME("Failed to create instance of unmarshaller %s.\n",debugstr_guid(&xclsid));
584 hres = _GetMarshaller(riid,pUnk,md.dwDestContext,NULL,md.mshlflags,&pMarshal);
586 FIXME("Failed to get unmarshaller, %lx?\n",hres);
589 hres = IMarshal_UnmarshalInterface(pMarshal,pStm,riid,ppv);
591 FIXME("Failed to Unmarshal the interface, %lx?\n",hres);
592 goto release_marshal;
595 IMarshal_Release(pMarshal);
599 /***********************************************************************
600 * CoReleaseMarshalData [OLE32.@]
603 CoReleaseMarshalData(IStream *pStm) {
606 wine_marshal_data md;
612 TRACE("(%p)\n",pStm);
614 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
616 FIXME("Stream read 1 failed, %lx, (%ld of %d)\n",hres,res,sizeof(mid));
619 hres = IStream_Read(pStm,&md,sizeof(md),&res);
621 FIXME("Stream read 2 failed, %lx, (%ld of %d)\n",hres,res,sizeof(md));
624 hres = IStream_Read(pStm,&xclsid,sizeof(xclsid),&res);
626 FIXME("Stream read 3 failed, %lx, (%ld of %d)\n",hres,res,sizeof(xclsid));
629 hres=CoCreateInstance(&xclsid,NULL,CLSCTX_INPROC_SERVER | CLSCTX_INPROC_HANDLER | CLSCTX_LOCAL_SERVER,&IID_IMarshal,(void**)(char*)&pUnk);
631 FIXME("Failed to create instance of unmarshaller %s.\n",debugstr_guid(&xclsid));
634 hres = IUnknown_QueryInterface(pUnk,&IID_IMarshal,(LPVOID*)(char*)&pMarshal);
636 FIXME("Failed to get IMarshal iface, %lx?\n",hres);
639 hres = IMarshal_ReleaseMarshalData(pMarshal,pStm);
641 FIXME("Failed to releasemarshaldata the interface, %lx?\n",hres);
643 IMarshal_Release(pMarshal);
644 IUnknown_Release(pUnk);
649 /***********************************************************************
650 * CoMarshalInterThreadInterfaceInStream [OLE32.@]
652 * Marshal an interface across threads in the same process.
655 * riid [I] Identifier of the interface to be marshalled.
656 * pUnk [I] Pointer to IUnknown-derived interface that will be marshalled.
657 * ppStm [O] Pointer to IStream object that is created and then used to store the marshalled inteface.
661 * Failure: E_OUTOFMEMORY and other COM error codes
664 * CoMarshalInterface(), CoUnmarshalInterface() and CoGetInterfaceAndReleaseStream()
667 CoMarshalInterThreadInterfaceInStream(
668 REFIID riid, LPUNKNOWN pUnk, LPSTREAM * ppStm)
671 LARGE_INTEGER seekto;
674 TRACE("(%s, %p, %p)\n",debugstr_guid(riid), pUnk, ppStm);
676 hres = CreateStreamOnHGlobal(0, TRUE, ppStm);
677 if (FAILED(hres)) return hres;
678 hres = CoMarshalInterface(*ppStm, riid, pUnk, MSHCTX_INPROC, NULL, MSHLFLAGS_NORMAL);
680 /* FIXME: is this needed? */
681 memset(&seekto,0,sizeof(seekto));
682 IStream_Seek(*ppStm,seekto,SEEK_SET,&xpos);
687 /***********************************************************************
688 * CoGetInterfaceAndReleaseStream [OLE32.@]
690 * Unmarshalls an inteface from a stream and then releases the stream.
693 * pStm [I] Stream that contains the marshalled inteface.
694 * riid [I] Interface identifier of the object to unmarshall.
695 * ppv [O] Address of pointer where the requested interface object will be stored.
699 * Failure: A COM error code
702 * CoMarshalInterThreadInterfaceInStream() and CoUnmarshalInteface()
705 CoGetInterfaceAndReleaseStream(LPSTREAM pStm,REFIID riid, LPVOID *ppv)
709 TRACE("(%p, %s, %p)\n", pStm, debugstr_guid(riid), ppv);
711 hres = CoUnmarshalInterface(pStm, riid, ppv);
712 IStream_Release(pStm);
716 static HRESULT WINAPI
717 SMCF_QueryInterface(LPCLASSFACTORY iface,REFIID riid, LPVOID *ppv) {
719 if (IsEqualIID(riid,&IID_IUnknown) || IsEqualIID(riid,&IID_IClassFactory)) {
720 *ppv = (LPVOID)iface;
723 return E_NOINTERFACE;
725 static ULONG WINAPI SMCF_AddRef(LPCLASSFACTORY iface) { return 2; }
726 static ULONG WINAPI SMCF_Release(LPCLASSFACTORY iface) { return 1; }
728 static HRESULT WINAPI
730 LPCLASSFACTORY iface, LPUNKNOWN pUnk, REFIID riid, LPVOID *ppv
732 if (IsEqualIID(riid,&IID_IMarshal)) {
734 dm=(StdMarshalImpl*)HeapAlloc(GetProcessHeap(),0,sizeof(StdMarshalImpl));
737 dm->lpvtbl = &stdmvtbl;
742 FIXME("(%s), not supported.\n",debugstr_guid(riid));
743 return E_NOINTERFACE;
746 static HRESULT WINAPI
747 SMCF_LockServer(LPCLASSFACTORY iface, BOOL fLock) {
748 FIXME("(%d), stub!\n",fLock);
752 static IClassFactoryVtbl dfmarshalcfvtbl = {
759 static IClassFactoryVtbl *pdfmarshalcfvtbl = &dfmarshalcfvtbl;
762 MARSHAL_GetStandardMarshalCF(LPVOID *ppv) {
763 *ppv = &pdfmarshalcfvtbl;