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
40 #include "wine/unicode.h"
41 #include "wine/winbase16.h"
42 #include "compobj_private.h"
45 #include "wine/debug.h"
47 WINE_DEFAULT_DEBUG_CHANNEL(ole);
49 extern const CLSID CLSID_DfMarshal;
51 /* Marshalling just passes a unique identifier to the remote client,
52 * that makes it possible to find the passed interface again.
54 * So basically we need a set of values that make it unique.
56 * Process Identifier, Object IUnknown ptr, IID
58 * Note that the IUnknown_QI(ob,xiid,&ppv) always returns the SAME ppv value!
62 get_facbuf_for_iid(REFIID riid,IPSFactoryBuffer **facbuf) {
66 if ((hres = CoGetPSClsid(riid,&pxclsid)))
68 return CoGetClassObject(&pxclsid,CLSCTX_INPROC_SERVER,NULL,&IID_IPSFactoryBuffer,(LPVOID*)facbuf);
71 typedef struct _wine_marshal_data {
76 typedef struct _mid2unknown {
81 typedef struct _mid2stub {
88 static mid2stub *stubs = NULL;
89 static int nrofstubs = 0;
91 static mid2unknown *proxies = NULL;
92 static int nrofproxies = 0;
94 void MARSHAL_Invalidate_Stub_From_MID(wine_marshal_id *mid) {
97 for (i=0;i<nrofstubs;i++) {
98 if (!stubs[i].valid) continue;
100 if (MARSHAL_Compare_Mids(mid,&(stubs[i].mid))) {
101 stubs[i].valid = FALSE;
110 MARSHAL_Find_Stub_Buffer(wine_marshal_id *mid,IRpcStubBuffer **stub) {
113 for (i=0;i<nrofstubs;i++) {
114 if (!stubs[i].valid) continue;
116 if (MARSHAL_Compare_Mids(mid,&(stubs[i].mid))) {
117 *stub = stubs[i].stub;
118 IUnknown_AddRef((*stub));
126 MARSHAL_Find_Stub(wine_marshal_id *mid,LPUNKNOWN *pUnk) {
129 for (i=0;i<nrofstubs;i++) {
130 if (!stubs[i].valid) continue;
132 if (MARSHAL_Compare_Mids(mid,&(stubs[i].mid))) {
133 *pUnk = stubs[i].pUnkServer;
134 IUnknown_AddRef((*pUnk));
142 MARSHAL_Register_Stub(wine_marshal_id *mid,LPUNKNOWN pUnk,IRpcStubBuffer *stub) {
144 if (!MARSHAL_Find_Stub(mid,&xPunk)) {
145 FIXME("Already have entry for (%lx/%s)!\n",mid->objectid,debugstr_guid(&(mid->iid)));
149 stubs=HeapReAlloc(GetProcessHeap(),0,stubs,sizeof(stubs[0])*(nrofstubs+1));
151 stubs=HeapAlloc(GetProcessHeap(),0,sizeof(stubs[0]));
152 if (!stubs) return E_OUTOFMEMORY;
153 stubs[nrofstubs].stub = stub;
154 stubs[nrofstubs].pUnkServer = pUnk;
155 memcpy(&(stubs[nrofstubs].mid),mid,sizeof(*mid));
156 stubs[nrofstubs].valid = TRUE; /* set to false when released by ReleaseMarshalData */
162 MARSHAL_Disconnect_Proxies() {
165 TRACE("Disconnecting %d proxies\n", nrofproxies);
167 for (i = 0; i < nrofproxies; i++)
168 IRpcProxyBuffer_Disconnect((IRpcProxyBuffer*)proxies[i].pUnk);
174 MARSHAL_Register_Proxy(wine_marshal_id *mid,LPUNKNOWN punk) {
177 for (i=0;i<nrofproxies;i++) {
178 if (MARSHAL_Compare_Mids(mid,&(proxies[i].mid))) {
179 ERR("Already have mid?\n");
184 proxies = HeapReAlloc(GetProcessHeap(),0,proxies,sizeof(proxies[0])*(nrofproxies+1));
186 proxies = HeapAlloc(GetProcessHeap(),0,sizeof(proxies[0]));
187 memcpy(&(proxies[nrofproxies].mid),mid,sizeof(*mid));
188 proxies[nrofproxies].pUnk = punk;
190 IUnknown_AddRef(punk);
194 /********************** StdMarshal implementation ****************************/
195 typedef struct _StdMarshalImpl {
196 IMarshalVtbl *lpvtbl;
201 LPVOID pvDestContext;
205 static HRESULT WINAPI
206 StdMarshalImpl_QueryInterface(LPMARSHAL iface,REFIID riid,LPVOID *ppv) {
208 if (IsEqualIID(&IID_IUnknown,riid) || IsEqualIID(&IID_IMarshal,riid)) {
210 IUnknown_AddRef(iface);
213 FIXME("No interface for %s.\n",debugstr_guid(riid));
214 return E_NOINTERFACE;
218 StdMarshalImpl_AddRef(LPMARSHAL iface) {
219 StdMarshalImpl *This = (StdMarshalImpl *)iface;
225 StdMarshalImpl_Release(LPMARSHAL iface) {
226 StdMarshalImpl *This = (StdMarshalImpl *)iface;
231 HeapFree(GetProcessHeap(),0,This);
235 static HRESULT WINAPI
236 StdMarshalImpl_GetUnmarshalClass(
237 LPMARSHAL iface, REFIID riid, void* pv, DWORD dwDestContext,
238 void* pvDestContext, DWORD mshlflags, CLSID* pCid
240 memcpy(pCid,&CLSID_DfMarshal,sizeof(CLSID_DfMarshal));
244 static HRESULT WINAPI
245 StdMarshalImpl_GetMarshalSizeMax(
246 LPMARSHAL iface, REFIID riid, void* pv, DWORD dwDestContext,
247 void* pvDestContext, DWORD mshlflags, DWORD* pSize
249 *pSize = sizeof(wine_marshal_id)+sizeof(wine_marshal_data);
253 static HRESULT WINAPI
254 StdMarshalImpl_MarshalInterface(
255 LPMARSHAL iface, IStream *pStm,REFIID riid, void* pv, DWORD dwDestContext,
256 void* pvDestContext, DWORD mshlflags
259 wine_marshal_data md;
263 IRpcStubBuffer *stub;
264 IPSFactoryBuffer *psfacbuf;
266 TRACE("(...,%s,...)\n",debugstr_guid(riid));
268 IUnknown_QueryInterface((LPUNKNOWN)pv,&IID_IUnknown,(LPVOID*)&pUnk);
269 mid.processid = GetCurrentProcessId();
270 mid.objectid = (DWORD)pUnk; /* FIXME */
271 IUnknown_Release(pUnk);
272 memcpy(&mid.iid,riid,sizeof(mid.iid));
273 md.dwDestContext = dwDestContext;
274 md.mshlflags = mshlflags;
275 hres = IStream_Write(pStm,&mid,sizeof(mid),&res);
276 if (hres) return hres;
277 hres = IStream_Write(pStm,&md,sizeof(md),&res);
278 if (hres) return hres;
280 if (SUCCEEDED(MARSHAL_Find_Stub_Buffer(&mid,&stub))) {
281 /* Find_Stub_Buffer gives us a ref but we want to keep it, as if we'd created a new one */
282 TRACE("Found RpcStubBuffer %p\n", stub);
285 hres = get_facbuf_for_iid(riid,&psfacbuf);
286 if (hres) return hres;
288 hres = IPSFactoryBuffer_CreateStub(psfacbuf,riid,pv,&stub);
289 IPSFactoryBuffer_Release(psfacbuf);
291 FIXME("Failed to create a stub for %s\n",debugstr_guid(riid));
294 IUnknown_QueryInterface((LPUNKNOWN)pv,riid,(LPVOID*)&pUnk);
295 MARSHAL_Register_Stub(&mid,pUnk,stub);
296 IUnknown_Release(pUnk);
300 static HRESULT WINAPI
301 StdMarshalImpl_UnmarshalInterface(
302 LPMARSHAL iface, IStream *pStm, REFIID riid, void **ppv
305 wine_marshal_data md;
308 IPSFactoryBuffer *psfacbuf;
309 IRpcProxyBuffer *rpcproxy;
310 IRpcChannelBuffer *chanbuf;
312 TRACE("(...,%s,....)\n",debugstr_guid(riid));
313 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
314 if (hres) return hres;
315 hres = IStream_Read(pStm,&md,sizeof(md),&res);
316 if (hres) return hres;
317 if (SUCCEEDED(MARSHAL_Find_Stub(&mid,(LPUNKNOWN*)ppv))) {
318 FIXME("Calling back to ourselves for %s!\n",debugstr_guid(riid));
321 if (IsEqualIID(riid, &IID_IUnknown) || IsEqualIID(riid, &IID_NULL)) {
322 /* should return proxy manager IUnknown object */
323 FIXME("Special treatment required for IID of %s\n", debugstr_guid(riid));
325 hres = get_facbuf_for_iid(riid,&psfacbuf);
326 if (hres) return hres;
327 hres = IPSFactoryBuffer_CreateProxy(psfacbuf,NULL,riid,&rpcproxy,ppv);
329 FIXME("Failed to create a proxy for %s\n",debugstr_guid(riid));
333 MARSHAL_Register_Proxy(&mid, (LPUNKNOWN) rpcproxy);
335 hres = PIPE_GetNewPipeBuf(&mid,&chanbuf);
336 IPSFactoryBuffer_Release(psfacbuf);
338 ERR("Failed to get an rpc channel buffer for %s\n",debugstr_guid(riid));
340 /* Connect the channel buffer to the proxy and release the no longer
342 * NOTE: The proxy should have taken an extra reference because it also
343 * aggregates the object, so we can safely release our reference to it. */
344 IRpcProxyBuffer_Connect(rpcproxy,chanbuf);
345 IRpcProxyBuffer_Release(rpcproxy);
346 /* IRpcProxyBuffer takes a reference on the channel buffer and
347 * we no longer need it, so release it */
348 IRpcChannelBuffer_Release(chanbuf);
353 static HRESULT WINAPI
354 StdMarshalImpl_ReleaseMarshalData(LPMARSHAL iface, IStream *pStm) {
358 IRpcStubBuffer *stub = NULL;
361 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
362 if (hres) return hres;
364 for (i=0; i < nrofstubs; i++)
366 if (!stubs[i].valid) continue;
368 if (MARSHAL_Compare_Mids(&mid, &(stubs[i].mid)))
370 stub = stubs[i].stub;
377 FIXME("Could not map MID to stub??\n");
381 res = IRpcStubBuffer_Release(stub);
382 stubs[i].valid = FALSE;
383 TRACE("stub refcount of %p is %ld\n", stub, res);
388 static HRESULT WINAPI
389 StdMarshalImpl_DisconnectObject(LPMARSHAL iface, DWORD dwReserved) {
390 FIXME("(), stub!\n");
394 IMarshalVtbl stdmvtbl = {
395 StdMarshalImpl_QueryInterface,
396 StdMarshalImpl_AddRef,
397 StdMarshalImpl_Release,
398 StdMarshalImpl_GetUnmarshalClass,
399 StdMarshalImpl_GetMarshalSizeMax,
400 StdMarshalImpl_MarshalInterface,
401 StdMarshalImpl_UnmarshalInterface,
402 StdMarshalImpl_ReleaseMarshalData,
403 StdMarshalImpl_DisconnectObject
406 /***********************************************************************
407 * CoGetStandardMarshal [OLE32.@]
409 * When the COM library in the client process receives a marshalled
410 * interface pointer, it looks for a CLSID to be used in creating a proxy
411 * for the purposes of unmarshalling the packet. If the packet does not
412 * contain a CLSID for the proxy, COM calls CoGetStandardMarshal, passing a
414 * This function creates a standard proxy in the client process and returns
415 * a pointer to that proxy's implementation of IMarshal.
416 * COM uses this pointer to call CoUnmarshalInterface to retrieve the pointer
417 * to the requested interface.
420 CoGetStandardMarshal(
421 REFIID riid,IUnknown *pUnk,DWORD dwDestContext,LPVOID pvDestContext,
422 DWORD mshlflags, LPMARSHAL *pMarshal
427 FIXME("(%s,NULL,%lx,%p,%lx,%p), unimplemented yet.\n",
428 debugstr_guid(riid),dwDestContext,pvDestContext,mshlflags,pMarshal
432 TRACE("(%s,%p,%lx,%p,%lx,%p)\n",
433 debugstr_guid(riid),pUnk,dwDestContext,pvDestContext,mshlflags,pMarshal
435 *pMarshal = HeapAlloc(GetProcessHeap(),0,sizeof(StdMarshalImpl));
436 dm = (StdMarshalImpl*) *pMarshal;
437 if (!dm) return E_FAIL;
438 dm->lpvtbl = &stdmvtbl;
441 memcpy(&dm->iid,riid,sizeof(dm->iid));
442 dm->dwDestContext = dwDestContext;
443 dm->pvDestContext = pvDestContext;
444 dm->mshlflags = mshlflags;
448 /* Helper function for getting Marshaler */
449 static HRESULT WINAPI
450 _GetMarshaller(REFIID riid, IUnknown *pUnk,DWORD dwDestContext,
451 void *pvDestContext, DWORD mshlFlags, LPMARSHAL *pMarshal
457 hres = IUnknown_QueryInterface(pUnk,&IID_IMarshal,(LPVOID*)pMarshal);
459 hres = CoGetStandardMarshal(riid,pUnk,dwDestContext,pvDestContext,mshlFlags,pMarshal);
463 /***********************************************************************
464 * CoGetMarshalSizeMax [OLE32.@]
467 CoGetMarshalSizeMax(ULONG *pulSize, REFIID riid, IUnknown *pUnk,
468 DWORD dwDestContext, void *pvDestContext, DWORD mshlFlags
473 hres = _GetMarshaller(riid,pUnk,dwDestContext,pvDestContext,mshlFlags,&pMarshal);
476 hres = IMarshal_GetMarshalSizeMax(pMarshal,riid,pUnk,dwDestContext,pvDestContext,mshlFlags,pulSize);
477 *pulSize += sizeof(wine_marshal_id)+sizeof(wine_marshal_data)+sizeof(CLSID);
478 IMarshal_Release(pMarshal);
483 /***********************************************************************
484 * CoMarshalInterface [OLE32.@]
487 CoMarshalInterface( IStream *pStm, REFIID riid, IUnknown *pUnk,
488 DWORD dwDestContext, void *pvDestContext, DWORD mshlflags
495 wine_marshal_data md;
499 TRACE("(%p, %s, %p, %lx, %p, %lx)\n",
500 pStm,debugstr_guid(riid),pUnk,dwDestContext,pvDestContext,mshlflags
506 STUBMGR_Start(); /* Just to be sure we have one running. */
507 mid.processid = GetCurrentProcessId();
508 IUnknown_QueryInterface(pUnk,&IID_IUnknown,(LPVOID*)&pUnknown);
509 mid.objectid = (DWORD)pUnknown;
510 IUnknown_Release(pUnknown);
511 memcpy(&mid.iid,riid,sizeof(mid.iid));
512 md.dwDestContext = dwDestContext;
513 md.mshlflags = mshlflags;
514 hres = IStream_Write(pStm,&mid,sizeof(mid),&res);
515 if (hres) return hres;
516 hres = IStream_Write(pStm,&md,sizeof(md),&res);
517 if (hres) return hres;
518 hres = _GetMarshaller(riid,pUnk,dwDestContext,pvDestContext,mshlflags,&pMarshal);
520 FIXME("Failed to get marshaller, %lx?\n",hres);
523 hres = IMarshal_GetUnmarshalClass(pMarshal,riid,pUnk,dwDestContext,pvDestContext,mshlflags,&xclsid);
525 FIXME("IMarshal:GetUnmarshalClass failed, %lx\n",hres);
526 goto release_marshal;
528 hres = IStream_Write(pStm,&xclsid,sizeof(xclsid),&writeres);
530 FIXME("Stream write failed, %lx\n",hres);
531 goto release_marshal;
534 TRACE("Calling IMarshal::MarshalInterace\n");
535 hres = IMarshal_MarshalInterface(pMarshal,pStm,riid,pUnk,dwDestContext,pvDestContext,mshlflags);
538 if (IsEqualGUID(riid,&IID_IOleObject)) {
539 ERR("WINE currently cannot marshal IOleObject interfaces. This means you cannot embed/link OLE objects between applications.\n");
541 FIXME("Failed to marshal the interface %s, %lx?\n",debugstr_guid(riid),hres);
545 IMarshal_Release(pMarshal);
550 /***********************************************************************
551 * CoUnmarshalInterface [OLE32.@]
554 CoUnmarshalInterface(IStream *pStm, REFIID riid, LPVOID *ppv) {
557 wine_marshal_data md;
563 TRACE("(%p,%s,%p)\n",pStm,debugstr_guid(riid),ppv);
565 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
567 FIXME("Stream read 1 failed, %lx, (%ld of %d)\n",hres,res,sizeof(mid));
570 hres = IStream_Read(pStm,&md,sizeof(md),&res);
572 FIXME("Stream read 2 failed, %lx, (%ld of %d)\n",hres,res,sizeof(md));
575 hres = IStream_Read(pStm,&xclsid,sizeof(xclsid),&res);
577 FIXME("Stream read 3 failed, %lx, (%ld of %d)\n",hres,res,sizeof(xclsid));
580 hres=CoCreateInstance(&xclsid,NULL,CLSCTX_INPROC_SERVER | CLSCTX_INPROC_HANDLER | CLSCTX_LOCAL_SERVER,&IID_IMarshal,(void**)&pUnk);
582 FIXME("Failed to create instance of unmarshaller %s.\n",debugstr_guid(&xclsid));
585 hres = _GetMarshaller(riid,pUnk,md.dwDestContext,NULL,md.mshlflags,&pMarshal);
587 FIXME("Failed to get unmarshaller, %lx?\n",hres);
590 hres = IMarshal_UnmarshalInterface(pMarshal,pStm,riid,ppv);
592 FIXME("Failed to Unmarshal the interface, %lx?\n",hres);
593 goto release_marshal;
596 IMarshal_Release(pMarshal);
600 /***********************************************************************
601 * CoReleaseMarshalData [OLE32.@]
604 CoReleaseMarshalData(IStream *pStm) {
607 wine_marshal_data md;
613 TRACE("(%p)\n",pStm);
615 hres = IStream_Read(pStm,&mid,sizeof(mid),&res);
617 FIXME("Stream read 1 failed, %lx, (%ld of %d)\n",hres,res,sizeof(mid));
620 hres = IStream_Read(pStm,&md,sizeof(md),&res);
622 FIXME("Stream read 2 failed, %lx, (%ld of %d)\n",hres,res,sizeof(md));
625 hres = IStream_Read(pStm,&xclsid,sizeof(xclsid),&res);
627 FIXME("Stream read 3 failed, %lx, (%ld of %d)\n",hres,res,sizeof(xclsid));
630 hres=CoCreateInstance(&xclsid,NULL,CLSCTX_INPROC_SERVER | CLSCTX_INPROC_HANDLER | CLSCTX_LOCAL_SERVER,&IID_IMarshal,(void**)(char*)&pUnk);
632 FIXME("Failed to create instance of unmarshaller %s.\n",debugstr_guid(&xclsid));
635 hres = IUnknown_QueryInterface(pUnk,&IID_IMarshal,(LPVOID*)(char*)&pMarshal);
637 FIXME("Failed to get IMarshal iface, %lx?\n",hres);
640 hres = IMarshal_ReleaseMarshalData(pMarshal,pStm);
642 FIXME("Failed to releasemarshaldata the interface, %lx?\n",hres);
644 IMarshal_Release(pMarshal);
645 IUnknown_Release(pUnk);
650 /***********************************************************************
651 * CoMarshalInterThreadInterfaceInStream [OLE32.@]
653 * Marshal an interface across threads in the same process.
656 * riid [I] Identifier of the interface to be marshalled.
657 * pUnk [I] Pointer to IUnknown-derived interface that will be marshalled.
658 * ppStm [O] Pointer to IStream object that is created and then used to store the marshalled inteface.
662 * Failure: E_OUTOFMEMORY and other COM error codes
665 * CoMarshalInterface(), CoUnmarshalInterface() and CoGetInterfaceAndReleaseStream()
668 CoMarshalInterThreadInterfaceInStream(
669 REFIID riid, LPUNKNOWN pUnk, LPSTREAM * ppStm)
672 LARGE_INTEGER seekto;
675 TRACE("(%s, %p, %p)\n",debugstr_guid(riid), pUnk, ppStm);
677 hres = CreateStreamOnHGlobal(0, TRUE, ppStm);
678 if (FAILED(hres)) return hres;
679 hres = CoMarshalInterface(*ppStm, riid, pUnk, MSHCTX_INPROC, NULL, MSHLFLAGS_NORMAL);
681 /* FIXME: is this needed? */
682 memset(&seekto,0,sizeof(seekto));
683 IStream_Seek(*ppStm,seekto,SEEK_SET,&xpos);
688 /***********************************************************************
689 * CoGetInterfaceAndReleaseStream [OLE32.@]
691 * Unmarshalls an inteface from a stream and then releases the stream.
694 * pStm [I] Stream that contains the marshalled inteface.
695 * riid [I] Interface identifier of the object to unmarshall.
696 * ppv [O] Address of pointer where the requested interface object will be stored.
700 * Failure: A COM error code
703 * CoMarshalInterThreadInterfaceInStream() and CoUnmarshalInteface()
706 CoGetInterfaceAndReleaseStream(LPSTREAM pStm,REFIID riid, LPVOID *ppv)
710 TRACE("(%p, %s, %p)\n", pStm, debugstr_guid(riid), ppv);
712 hres = CoUnmarshalInterface(pStm, riid, ppv);
713 IStream_Release(pStm);
717 static HRESULT WINAPI
718 SMCF_QueryInterface(LPCLASSFACTORY iface,REFIID riid, LPVOID *ppv) {
720 if (IsEqualIID(riid,&IID_IUnknown) || IsEqualIID(riid,&IID_IClassFactory)) {
721 *ppv = (LPVOID)iface;
724 return E_NOINTERFACE;
726 static ULONG WINAPI SMCF_AddRef(LPCLASSFACTORY iface) { return 2; }
727 static ULONG WINAPI SMCF_Release(LPCLASSFACTORY iface) { return 1; }
729 static HRESULT WINAPI
731 LPCLASSFACTORY iface, LPUNKNOWN pUnk, REFIID riid, LPVOID *ppv
733 if (IsEqualIID(riid,&IID_IMarshal)) {
735 dm=(StdMarshalImpl*)HeapAlloc(GetProcessHeap(),0,sizeof(StdMarshalImpl));
738 dm->lpvtbl = &stdmvtbl;
743 FIXME("(%s), not supported.\n",debugstr_guid(riid));
744 return E_NOINTERFACE;
747 static HRESULT WINAPI
748 SMCF_LockServer(LPCLASSFACTORY iface, BOOL fLock) {
749 FIXME("(%d), stub!\n",fLock);
753 static IClassFactoryVtbl dfmarshalcfvtbl = {
760 static IClassFactoryVtbl *pdfmarshalcfvtbl = &dfmarshalcfvtbl;
763 MARSHAL_GetStandardMarshalCF(LPVOID *ppv) {
764 *ppv = &pdfmarshalcfvtbl;