dlls/ole32/git.c

   1 /*
   2  * Implementation of the StdGlobalInterfaceTable object
   3  *
   4  * The GlobalInterfaceTable (GIT) object is used to marshal interfaces between
   5  * threading apartments (contexts). When you want to pass an interface but not
   6  * as a parameter, it wouldn't get marshalled automatically, so you can use this
   7  * object to insert the interface into a table, and you get back a cookie.
   8  * Then when it's retrieved, it'll be unmarshalled into the right apartment.
   9  *
  10  * Copyright 2003 Mike Hearn <mike@theoretic.com>
  11  *
  12  * This library is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public
  14  * License as published by the Free Software Foundation; either
  15  * version 2.1 of the License, or (at your option) any later version.
  16  *
  17  * This library is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with this library; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  25  */
  26
  27 #include <stdarg.h>
  28
  29 #define COBJMACROS
  30 #define NONAMELESSUNION
  31 #define NONAMELESSSTRUCT
  32
  33 #include "windef.h"
  34 #include "winbase.h"
  35 #include "winuser.h"
  36 #include "objbase.h"
  37 #include "ole2.h"
  38 #include "winerror.h"
  39
  40 #include "compobj_private.h"
  41
  42 #include "wine/list.h"
  43 #include "wine/debug.h"
  44
  45 WINE_DEFAULT_DEBUG_CHANNEL(ole);
  46
  47 /****************************************************************************
  48  * StdGlobalInterfaceTable definition
  49  *
  50  * This class implements IGlobalInterfaceTable and is a process-wide singleton
  51  * used for marshalling interfaces between threading apartments using cookies.
  52  */
  53
  54 /* Each entry in the linked list of GIT entries */
  55 typedef struct StdGITEntry
  56 {
  57   DWORD cookie;
  58   IID iid;         /* IID of the interface */
  59   IStream* stream; /* Holds the marshalled interface */
  60
  61   struct list entry;
  62 } StdGITEntry;
  63
  64 /* Class data */
  65 typedef struct StdGlobalInterfaceTableImpl
  66 {
  67   IGlobalInterfaceTable IGlobalInterfaceTable_iface;
  68
  69   struct list list;
  70   ULONG nextCookie;
  71
  72 } StdGlobalInterfaceTableImpl;
  73
  74 static IGlobalInterfaceTable *std_git;
  75
  76 static CRITICAL_SECTION git_section;
  77 static CRITICAL_SECTION_DEBUG critsect_debug =
  78 {
  79     0, 0, &git_section,
  80     { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
  81       0, 0, { (DWORD_PTR)(__FILE__ ": global interface table") }
  82 };
  83 static CRITICAL_SECTION git_section = { &critsect_debug, -1, 0, 0, 0, 0 };
  84
  85
  86 static inline StdGlobalInterfaceTableImpl *impl_from_IGlobalInterfaceTable(IGlobalInterfaceTable *iface)
  87 {
  88   return CONTAINING_RECORD(iface, StdGlobalInterfaceTableImpl, IGlobalInterfaceTable_iface);
  89 }
  90
  91 /***
  92  * A helper function to traverse the list and find the entry that matches the cookie.
  93  * Returns NULL if not found. Must be called inside git_section critical section.
  94  */
  95 static StdGITEntry* StdGlobalInterfaceTable_FindEntry(StdGlobalInterfaceTableImpl* This,
  96                 DWORD cookie)
  97 {
  98   StdGITEntry* e;
  99
 100   TRACE("This=%p, cookie=0x%x\n", This, cookie);
 101
 102   LIST_FOR_EACH_ENTRY(e, &This->list, StdGITEntry, entry) {
 103     if (e->cookie == cookie)
 104       return e;
 105   }
 106
 107   TRACE("Entry not found\n");
 108   return NULL;
 109 }
 110
 111 /***
 112  * Here's the boring boilerplate stuff for IUnknown
 113  */
 114
 115 static HRESULT WINAPI
 116 StdGlobalInterfaceTable_QueryInterface(IGlobalInterfaceTable* iface,
 117                REFIID riid, void** ppvObject)
 118 {
 119   /* Make sure silly coders can't crash us */
 120   if (ppvObject == 0) return E_INVALIDARG;
 121
 122   *ppvObject = 0; /* assume we don't have the interface */
 123
 124   /* Do we implement that interface? */
 125   if (IsEqualIID(&IID_IUnknown, riid) ||
 126       IsEqualIID(&IID_IGlobalInterfaceTable, riid))
 127     *ppvObject = iface;
 128   else
 129     return E_NOINTERFACE;
 130
 131   /* Now inc the refcount */
 132   IGlobalInterfaceTable_AddRef(iface);
 133   return S_OK;
 134 }
 135
 136 static ULONG WINAPI
 137 StdGlobalInterfaceTable_AddRef(IGlobalInterfaceTable* iface)
 138 {
 139   return 1;
 140 }
 141
 142 static ULONG WINAPI
 143 StdGlobalInterfaceTable_Release(IGlobalInterfaceTable* iface)
 144 {
 145   return 1;
 146 }
 147
 148 /***
 149  * Now implement the actual IGlobalInterfaceTable interface
 150  */
 151
 152 static HRESULT WINAPI
 153 StdGlobalInterfaceTable_RegisterInterfaceInGlobal(
 154                IGlobalInterfaceTable* iface, IUnknown* pUnk,
 155                REFIID riid, DWORD* pdwCookie)
 156 {
 157   StdGlobalInterfaceTableImpl* const This = impl_from_IGlobalInterfaceTable(iface);
 158   IStream* stream = NULL;
 159   HRESULT hres;
 160   StdGITEntry* entry;
 161   LARGE_INTEGER zero;
 162
 163   TRACE("iface=%p, pUnk=%p, riid=%s, pdwCookie=0x%p\n", iface, pUnk, debugstr_guid(riid), pdwCookie);
 164
 165   if (pUnk == NULL) return E_INVALIDARG;
 166
 167   /* marshal the interface */
 168   TRACE("About to marshal the interface\n");
 169
 170   hres = CreateStreamOnHGlobal(0, TRUE, &stream);
 171   if (hres != S_OK) return hres;
 172   hres = CoMarshalInterface(stream, riid, pUnk, MSHCTX_INPROC, NULL, MSHLFLAGS_TABLESTRONG);
 173   if (hres != S_OK)
 174   {
 175     IStream_Release(stream);
 176     return hres;
 177   }
 178
 179   zero.QuadPart = 0;
 180   IStream_Seek(stream, zero, STREAM_SEEK_SET, NULL);
 181
 182   entry = HeapAlloc(GetProcessHeap(), 0, sizeof(StdGITEntry));
 183   if (!entry)
 184   {
 185       CoReleaseMarshalData(stream);
 186       IStream_Release(stream);
 187       return E_OUTOFMEMORY;
 188   }
 189
 190   EnterCriticalSection(&git_section);
 191
 192   entry->iid = *riid;
 193   entry->stream = stream;
 194   entry->cookie = This->nextCookie;
 195   This->nextCookie++; /* inc the cookie count */
 196
 197   /* insert the new entry at the end of the list */
 198   list_add_tail(&This->list, &entry->entry);
 199
 200   /* and return the cookie */
 201   *pdwCookie = entry->cookie;
 202
 203   LeaveCriticalSection(&git_section);
 204
 205   TRACE("Cookie is 0x%x\n", entry->cookie);
 206   return S_OK;
 207 }
 208
 209 static HRESULT WINAPI
 210 StdGlobalInterfaceTable_RevokeInterfaceFromGlobal(
 211                IGlobalInterfaceTable* iface, DWORD dwCookie)
 212 {
 213   StdGlobalInterfaceTableImpl* This = impl_from_IGlobalInterfaceTable(iface);
 214   StdGITEntry* entry;
 215   HRESULT hr;
 216
 217   TRACE("iface=%p, dwCookie=0x%x\n", iface, dwCookie);
 218
 219   EnterCriticalSection(&git_section);
 220
 221   entry = StdGlobalInterfaceTable_FindEntry(This, dwCookie);
 222   if (entry == NULL) {
 223     TRACE("Entry not found\n");
 224     LeaveCriticalSection(&git_section);
 225     return E_INVALIDARG; /* not found */
 226   }
 227
 228   list_remove(&entry->entry);
 229
 230   LeaveCriticalSection(&git_section);
 231
 232   /* Free the stream */
 233   hr = CoReleaseMarshalData(entry->stream);
 234   if (hr != S_OK)
 235   {
 236     WARN("Failed to release marshal data, hr = 0x%08x\n", hr);
 237     return hr;
 238   }
 239   IStream_Release(entry->stream);
 240
 241   HeapFree(GetProcessHeap(), 0, entry);
 242   return S_OK;
 243 }
 244
 245 static HRESULT WINAPI
 246 StdGlobalInterfaceTable_GetInterfaceFromGlobal(
 247                IGlobalInterfaceTable* iface, DWORD dwCookie,
 248                REFIID riid, void **ppv)
 249 {
 250   StdGlobalInterfaceTableImpl* This = impl_from_IGlobalInterfaceTable(iface);
 251   StdGITEntry* entry;
 252   HRESULT hres;
 253   IStream *stream;
 254
 255   TRACE("dwCookie=0x%x, riid=%s, ppv=%p\n", dwCookie, debugstr_guid(riid), ppv);
 256
 257   EnterCriticalSection(&git_section);
 258
 259   entry = StdGlobalInterfaceTable_FindEntry(This, dwCookie);
 260   if (entry == NULL) {
 261     WARN("Entry for cookie 0x%x not found\n", dwCookie);
 262     LeaveCriticalSection(&git_section);
 263     return E_INVALIDARG;
 264   }
 265
 266   TRACE("entry=%p\n", entry);
 267
 268   hres = IStream_Clone(entry->stream, &stream);
 269
 270   LeaveCriticalSection(&git_section);
 271
 272   if (hres != S_OK) {
 273     WARN("Failed to clone stream with error 0x%08x\n", hres);
 274     return hres;
 275   }
 276
 277   /* unmarshal the interface */
 278   hres = CoUnmarshalInterface(stream, riid, ppv);
 279   IStream_Release(stream);
 280
 281   if (hres != S_OK) {
 282     WARN("Failed to unmarshal stream\n");
 283     return hres;
 284   }
 285
 286   TRACE("ppv=%p\n", *ppv);
 287   return S_OK;
 288 }
 289
 290 /* Classfactory definition - despite what MSDN says, some programs need this */
 291
 292 static HRESULT WINAPI
 293 GITCF_QueryInterface(LPCLASSFACTORY iface,REFIID riid, LPVOID *ppv)
 294 {
 295   *ppv = NULL;
 296   if (IsEqualIID(riid, &IID_IUnknown) ||
 297       IsEqualIID(riid, &IID_IClassFactory))
 298   {
 299     *ppv = iface;
 300     return S_OK;
 301   }
 302   return E_NOINTERFACE;
 303 }
 304
 305 static ULONG WINAPI GITCF_AddRef(LPCLASSFACTORY iface)
 306 {
 307   return 2;
 308 }
 309
 310 static ULONG WINAPI GITCF_Release(LPCLASSFACTORY iface)
 311 {
 312   return 1;
 313 }
 314
 315 static HRESULT WINAPI
 316 GITCF_CreateInstance(LPCLASSFACTORY iface, LPUNKNOWN pUnk,
 317                      REFIID riid, LPVOID *ppv)
 318 {
 319   if (IsEqualIID(riid,&IID_IGlobalInterfaceTable)) {
 320     IGlobalInterfaceTable *git = get_std_git();
 321     return IGlobalInterfaceTable_QueryInterface(git, riid, ppv);
 322   }
 323
 324   FIXME("(%s), not supported.\n",debugstr_guid(riid));
 325   return E_NOINTERFACE;
 326 }
 327
 328 static HRESULT WINAPI GITCF_LockServer(LPCLASSFACTORY iface, BOOL fLock)
 329 {
 330     FIXME("(%d), stub!\n",fLock);
 331     return S_OK;
 332 }
 333
 334 static const IClassFactoryVtbl GITClassFactoryVtbl = {
 335     GITCF_QueryInterface,
 336     GITCF_AddRef,
 337     GITCF_Release,
 338     GITCF_CreateInstance,
 339     GITCF_LockServer
 340 };
 341
 342 static IClassFactory git_classfactory = { &GITClassFactoryVtbl };
 343
 344 HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv)
 345 {
 346   *ppv = &git_classfactory;
 347   TRACE("Returning GIT classfactory\n");
 348   return S_OK;
 349 }
 350
 351 /* Virtual function table */
 352 static const IGlobalInterfaceTableVtbl StdGlobalInterfaceTableImpl_Vtbl =
 353 {
 354   StdGlobalInterfaceTable_QueryInterface,
 355   StdGlobalInterfaceTable_AddRef,
 356   StdGlobalInterfaceTable_Release,
 357   StdGlobalInterfaceTable_RegisterInterfaceInGlobal,
 358   StdGlobalInterfaceTable_RevokeInterfaceFromGlobal,
 359   StdGlobalInterfaceTable_GetInterfaceFromGlobal
 360 };
 361
 362 IGlobalInterfaceTable* get_std_git(void)
 363 {
 364   if (!std_git)
 365   {
 366     StdGlobalInterfaceTableImpl* newGIT;
 367
 368     newGIT = HeapAlloc(GetProcessHeap(), 0, sizeof(StdGlobalInterfaceTableImpl));
 369     if (!newGIT) return NULL;
 370
 371     newGIT->IGlobalInterfaceTable_iface.lpVtbl = &StdGlobalInterfaceTableImpl_Vtbl;
 372     list_init(&newGIT->list);
 373     newGIT->nextCookie = 0xf100; /* that's where windows starts, so that's where we start */
 374
 375     if (InterlockedCompareExchangePointer((void**)&std_git, &newGIT->IGlobalInterfaceTable_iface, NULL))
 376     {
 377       HeapFree(GetProcessHeap(), 0, newGIT);
 378     }
 379     else
 380       TRACE("Created the GIT at %p\n", newGIT);
 381   }
 382
 383   return std_git;
 384 }
 385
 386 void release_std_git(void)
 387 {
 388   StdGlobalInterfaceTableImpl *git;
 389   StdGITEntry *entry, *entry2;
 390
 391   if (!std_git) return;
 392
 393   git = impl_from_IGlobalInterfaceTable(std_git);
 394   LIST_FOR_EACH_ENTRY_SAFE(entry, entry2, &git->list, StdGITEntry, entry)
 395   {
 396       list_remove(&entry->entry);
 397
 398       CoReleaseMarshalData(entry->stream);
 399       IStream_Release(entry->stream);
 400       HeapFree(GetProcessHeap(), 0, entry);
 401   }
 402
 403   HeapFree(GetProcessHeap(), 0, git);
 404 }