dlls/ole32/compobj_private.h

   1 /*
   2  * Copyright 1995 Martin von Loewis
   3  * Copyright 1998 Justin Bradford
   4  * Copyright 1999 Francis Beaudet
   5  * Copyright 1999 Sylvain St-Germain
   6  * Copyright 2002 Marcus Meissner
   7  * Copyright 2003 Ove Kåven, TransGaming Technologies
   8  * Copyright 2004 Mike Hearn, Rob Shearman, CodeWeavers Inc
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  23  */
  24
  25 #ifndef __WINE_OLE_COMPOBJ_H
  26 #define __WINE_OLE_COMPOBJ_H
  27
  28 /* All private prototype functions used by OLE will be added to this header file */
  29
  30 #include <stdarg.h>
  31
  32 #include "wine/list.h"
  33
  34 #include "windef.h"
  35 #include "winbase.h"
  36 #include "wtypes.h"
  37 #include "dcom.h"
  38 #include "winreg.h"
  39 #include "winternl.h"
  40
  41 struct apartment;
  42 typedef struct apartment APARTMENT;
  43 typedef struct LocalServer LocalServer;
  44
  45 DEFINE_OLEGUID( CLSID_DfMarshal, 0x0000030b, 0, 0 );
  46
  47 /* signal to stub manager that this is a rem unknown object */
  48 #define MSHLFLAGSP_REMUNKNOWN   0x80000000
  49
  50 /* Thread-safety Annotation Legend:
  51  *
  52  * RO    - The value is read only. It never changes after creation, so no
  53  *         locking is required.
  54  * LOCK  - The value is written to only using Interlocked* functions.
  55  * CS    - The value is read or written to inside a critical section.
  56  *         The identifier following "CS" is the specific critical section that
  57  *         must be used.
  58  * MUTEX - The value is read or written to with a mutex held.
  59  *         The identifier following "MUTEX" is the specific mutex that
  60  *         must be used.
  61  */
  62
  63 typedef enum ifstub_state
  64 {
  65     STUBSTATE_NORMAL_MARSHALED,
  66     STUBSTATE_NORMAL_UNMARSHALED,
  67     STUBSTATE_TABLE_WEAK_MARSHALED,
  68     STUBSTATE_TABLE_WEAK_UNMARSHALED,
  69     STUBSTATE_TABLE_STRONG,
  70 } STUB_STATE;
  71
  72 /* an interface stub */
  73 struct ifstub
  74 {
  75     struct list       entry;      /* entry in stub_manager->ifstubs list (CS stub_manager->lock) */
  76     IRpcStubBuffer   *stubbuffer; /* RO */
  77     IID               iid;        /* RO */
  78     IPID              ipid;       /* RO */
  79     IUnknown         *iface;      /* RO */
  80     MSHLFLAGS         flags;      /* so we can enforce process-local marshalling rules (RO) */
  81     IRpcChannelBuffer*chan;       /* channel passed to IRpcStubBuffer::Invoke (RO) */
  82 };
  83
  84
  85 /* stub managers hold refs on the object and each interface stub */
  86 struct stub_manager
  87 {
  88     struct list       entry;      /* entry in apartment stubmgr list (CS apt->cs) */
  89     struct list       ifstubs;    /* list of active ifstubs for the object (CS lock) */
  90     CRITICAL_SECTION  lock;
  91     APARTMENT        *apt;        /* owning apt (RO) */
  92
  93     ULONG             extrefs;    /* number of 'external' references (CS lock) */
  94     ULONG             refs;       /* internal reference count (CS apt->cs) */
  95     ULONG             weakrefs;   /* number of weak references (CS lock) */
  96     OID               oid;        /* apartment-scoped unique identifier (RO) */
  97     IUnknown         *object;     /* the object we are managing the stub for (RO) */
  98     ULONG             next_ipid;  /* currently unused (LOCK) */
  99     OXID_INFO         oxid_info;  /* string binding, ipid of rem unknown and other information (RO) */
 100
 101     IExternalConnection *extern_conn;
 102
 103     /* We need to keep a count of the outstanding marshals, so we can enforce the
 104      * marshalling rules (ie, you can only unmarshal normal marshals once). Note
 105      * that these counts do NOT include unmarshalled interfaces, once a stream is
 106      * unmarshalled and a proxy set up, this count is decremented.
 107      */
 108
 109     ULONG             norm_refs;  /* refcount of normal marshals (CS lock) */
 110     BOOL              disconnected; /* CoDisconnectObject has been called (CS lock) */
 111 };
 112
 113 /* imported interface proxy */
 114 struct ifproxy
 115 {
 116   struct list entry;       /* entry in proxy_manager list (CS parent->cs) */
 117   struct proxy_manager *parent; /* owning proxy_manager (RO) */
 118   LPVOID iface;            /* interface pointer (RO) */
 119   STDOBJREF stdobjref;     /* marshal data that represents this object (RO) */
 120   IID iid;                 /* interface ID (RO) */
 121   LPRPCPROXYBUFFER proxy;  /* interface proxy (RO) */
 122   ULONG refs;              /* imported (public) references (LOCK) */
 123   IRpcChannelBuffer *chan; /* channel to object (CS parent->cs) */
 124 };
 125
 126 struct apartment
 127 {
 128   struct list entry;
 129
 130   LONG  refs;              /* refcount of the apartment (LOCK) */
 131   BOOL multi_threaded;     /* multi-threaded or single-threaded apartment? (RO) */
 132   DWORD tid;               /* thread id (RO) */
 133   OXID oxid;               /* object exporter ID (RO) */
 134   LONG ipidc;              /* interface pointer ID counter, starts at 1 (LOCK) */
 135   CRITICAL_SECTION cs;     /* thread safety */
 136   struct list proxies;     /* imported objects (CS cs) */
 137   struct list stubmgrs;    /* stub managers for exported objects (CS cs) */
 138   BOOL remunk_exported;    /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
 139   LONG remoting_started;   /* has the RPC system been started for this apartment? (LOCK) */
 140   struct list loaded_dlls; /* list of dlls loaded by this apartment (CS cs) */
 141   DWORD host_apt_tid;      /* thread ID of apartment hosting objects of differing threading model (CS cs) */
 142   HWND host_apt_hwnd;      /* handle to apartment window of host apartment (CS cs) */
 143   LocalServer *local_server; /* A marshallable object exposing local servers (CS cs) */
 144
 145   /* FIXME: OIDs should be given out by RPCSS */
 146   OID oidc;                /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
 147
 148   /* STA-only fields */
 149   HWND win;                /* message window (LOCK) */
 150   LPMESSAGEFILTER filter;  /* message filter (CS cs) */
 151   BOOL main;               /* is this a main-threaded-apartment? (RO) */
 152 };
 153
 154 /* this is what is stored in TEB->ReservedForOle */
 155 struct oletls
 156 {
 157     struct apartment *apt;
 158     IErrorInfo       *errorinfo;   /* see errorinfo.c */
 159     IUnknown         *state;       /* see CoSetState */
 160     DWORD             apt_mask;    /* apartment mask (+0Ch on x86) */
 161     IInitializeSpy   *spy;         /* The "SPY" from CoInitializeSpy */
 162     DWORD            inits;        /* number of times CoInitializeEx called */
 163     DWORD            ole_inits;    /* number of times OleInitialize called */
 164     GUID             causality_id; /* unique identifier for each COM call */
 165     LONG             pending_call_count_client; /* number of client calls pending */
 166     LONG             pending_call_count_server; /* number of server calls pending */
 167     DWORD            unknown;
 168     IObjContext     *context_token; /* (+38h on x86) */
 169     IUnknown        *call_state;    /* current call context (+3Ch on x86) */
 170     DWORD            unknown2[46];
 171     IUnknown        *cancel_object; /* cancel object set by CoSetCancelObject (+F8h on x86) */
 172 };
 173
 174
 175 /* Global Interface Table Functions */
 176 extern IGlobalInterfaceTable *get_std_git(void) DECLSPEC_HIDDEN;
 177 extern void release_std_git(void) DECLSPEC_HIDDEN;
 178 extern HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv) DECLSPEC_HIDDEN;
 179
 180 HRESULT COM_OpenKeyForCLSID(REFCLSID clsid, LPCWSTR keyname, REGSAM access, HKEY *key) DECLSPEC_HIDDEN;
 181 HRESULT COM_OpenKeyForAppIdFromCLSID(REFCLSID clsid, REGSAM access, HKEY *subkey) DECLSPEC_HIDDEN;
 182 HRESULT MARSHAL_GetStandardMarshalCF(LPVOID *ppv) DECLSPEC_HIDDEN;
 183 HRESULT FTMarshalCF_Create(REFIID riid, LPVOID *ppv) DECLSPEC_HIDDEN;
 184
 185 /* Stub Manager */
 186
 187 ULONG stub_manager_int_release(struct stub_manager *This) DECLSPEC_HIDDEN;
 188 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs, BOOL tableweak) DECLSPEC_HIDDEN;
 189 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs, BOOL tableweak, BOOL last_unlock_releases) DECLSPEC_HIDDEN;
 190 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, REFIID iid,
 191      DWORD dest_context, void *dest_context_data, MSHLFLAGS flags) DECLSPEC_HIDDEN;
 192 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags) DECLSPEC_HIDDEN;
 193 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid) DECLSPEC_HIDDEN;
 194 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, IUnknown *object, BOOL alloc) DECLSPEC_HIDDEN;
 195 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid) DECLSPEC_HIDDEN;
 196 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid) DECLSPEC_HIDDEN;
 197 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid, BOOL tableweak) DECLSPEC_HIDDEN;
 198 void stub_manager_disconnect(struct stub_manager *m) DECLSPEC_HIDDEN;
 199 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **manager, IRpcStubBuffer **stub,
 200                                  IRpcChannelBuffer **chan, IID *iid, IUnknown **iface) DECLSPEC_HIDDEN;
 201 HRESULT start_apartment_remote_unknown(void) DECLSPEC_HIDDEN;
 202
 203 HRESULT marshal_object(APARTMENT *apt, STDOBJREF *stdobjref, REFIID riid, IUnknown *obj, DWORD dest_context, void *dest_context_data, MSHLFLAGS mshlflags) DECLSPEC_HIDDEN;
 204
 205 /* RPC Backend */
 206
 207 struct dispatch_params;
 208
 209 void    RPC_StartRemoting(struct apartment *apt) DECLSPEC_HIDDEN;
 210 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
 211                                 const OXID_INFO *oxid_info,
 212                                 DWORD dest_context, void *dest_context_data,
 213                                 IRpcChannelBuffer **chan) DECLSPEC_HIDDEN;
 214 HRESULT RPC_CreateServerChannel(DWORD dest_context, void *dest_context_data, IRpcChannelBuffer **chan) DECLSPEC_HIDDEN;
 215 void    RPC_ExecuteCall(struct dispatch_params *params) DECLSPEC_HIDDEN;
 216 HRESULT RPC_RegisterInterface(REFIID riid) DECLSPEC_HIDDEN;
 217 void    RPC_UnregisterInterface(REFIID riid, BOOL wait) DECLSPEC_HIDDEN;
 218 HRESULT RPC_StartLocalServer(REFCLSID clsid, IStream *stream, BOOL multi_use, void **registration) DECLSPEC_HIDDEN;
 219 void    RPC_StopLocalServer(void *registration) DECLSPEC_HIDDEN;
 220 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv) DECLSPEC_HIDDEN;
 221 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook) DECLSPEC_HIDDEN;
 222 void    RPC_UnregisterAllChannelHooks(void) DECLSPEC_HIDDEN;
 223 HRESULT RPC_ResolveOxid(OXID oxid, OXID_INFO *oxid_info) DECLSPEC_HIDDEN;
 224
 225 /* This function initialize the Running Object Table */
 226 HRESULT WINAPI RunningObjectTableImpl_Initialize(void) DECLSPEC_HIDDEN;
 227
 228 /* This function uninitialize the Running Object Table */
 229 HRESULT WINAPI RunningObjectTableImpl_UnInitialize(void) DECLSPEC_HIDDEN;
 230
 231 /* Drag and drop */
 232 void OLEDD_UnInitialize(void) DECLSPEC_HIDDEN;
 233
 234 /* Apartment Functions */
 235
 236 APARTMENT *apartment_findfromoxid(OXID oxid, BOOL ref) DECLSPEC_HIDDEN;
 237 APARTMENT *apartment_findfromtid(DWORD tid) DECLSPEC_HIDDEN;
 238 DWORD apartment_release(struct apartment *apt) DECLSPEC_HIDDEN;
 239 HRESULT apartment_disconnectproxies(struct apartment *apt) DECLSPEC_HIDDEN;
 240 static inline HRESULT apartment_getoxid(const struct apartment *apt, OXID *oxid)
 241 {
 242     *oxid = apt->oxid;
 243     return S_OK;
 244 }
 245 HRESULT apartment_createwindowifneeded(struct apartment *apt) DECLSPEC_HIDDEN;
 246 HWND apartment_getwindow(const struct apartment *apt) DECLSPEC_HIDDEN;
 247 HRESULT enter_apartment(struct oletls *info, DWORD model) DECLSPEC_HIDDEN;
 248 void leave_apartment(struct oletls *info) DECLSPEC_HIDDEN;
 249
 250 /* DCOM messages used by the apartment window (not compatible with native) */
 251 #define DM_EXECUTERPC   (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
 252 #define DM_HOSTOBJECT   (WM_USER + 1) /* WPARAM = 0, LPARAM = (struct host_object_params *) */
 253
 254 /*
 255  * Per-thread values are stored in the TEB on offset 0xF80
 256  */
 257
 258 /* will create if necessary */
 259 static inline struct oletls *COM_CurrentInfo(void)
 260 {
 261     if (!NtCurrentTeb()->ReservedForOle)
 262         NtCurrentTeb()->ReservedForOle = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct oletls));
 263
 264     return NtCurrentTeb()->ReservedForOle;
 265 }
 266
 267 static inline APARTMENT* COM_CurrentApt(void)
 268 {
 269     return COM_CurrentInfo()->apt;
 270 }
 271
 272 static inline GUID COM_CurrentCausalityId(void)
 273 {
 274     struct oletls *info = COM_CurrentInfo();
 275     if (!info)
 276         return GUID_NULL;
 277     if (IsEqualGUID(&info->causality_id, &GUID_NULL))
 278         CoCreateGuid(&info->causality_id);
 279     return info->causality_id;
 280 }
 281
 282 /* helpers for debugging */
 283 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
 284 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
 285
 286 #define CHARS_IN_GUID 39 /* including NULL */
 287
 288 #define WINE_CLSCTX_DONT_HOST   0x80000000
 289
 290 /* from dlldata.c */
 291 extern HINSTANCE hProxyDll DECLSPEC_HIDDEN;
 292 extern HRESULT WINAPI OLE32_DllGetClassObject(REFCLSID rclsid, REFIID iid,LPVOID *ppv) DECLSPEC_HIDDEN;
 293 extern HRESULT WINAPI OLE32_DllRegisterServer(void) DECLSPEC_HIDDEN;
 294 extern HRESULT WINAPI OLE32_DllUnregisterServer(void) DECLSPEC_HIDDEN;
 295
 296 extern HRESULT Handler_DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv) DECLSPEC_HIDDEN;
 297 extern HRESULT HandlerCF_Create(REFCLSID rclsid, REFIID riid, LPVOID *ppv) DECLSPEC_HIDDEN;
 298
 299 extern HRESULT WINAPI GlobalOptions_CreateInstance(IClassFactory *iface, IUnknown *pUnk,
 300                                                    REFIID riid, void **ppv) DECLSPEC_HIDDEN;
 301 extern IClassFactory GlobalOptionsCF DECLSPEC_HIDDEN;
 302
 303 /* Exported non-interface Data Advise Holder functions */
 304 HRESULT DataAdviseHolder_OnConnect(IDataAdviseHolder *iface, IDataObject *pDelegate) DECLSPEC_HIDDEN;
 305 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder *iface) DECLSPEC_HIDDEN;
 306
 307 extern UINT ownerlink_clipboard_format DECLSPEC_HIDDEN;
 308 extern UINT filename_clipboard_format DECLSPEC_HIDDEN;
 309 extern UINT filenameW_clipboard_format DECLSPEC_HIDDEN;
 310 extern UINT dataobject_clipboard_format DECLSPEC_HIDDEN;
 311 extern UINT embedded_object_clipboard_format DECLSPEC_HIDDEN;
 312 extern UINT embed_source_clipboard_format DECLSPEC_HIDDEN;
 313 extern UINT custom_link_source_clipboard_format DECLSPEC_HIDDEN;
 314 extern UINT link_source_clipboard_format DECLSPEC_HIDDEN;
 315 extern UINT object_descriptor_clipboard_format DECLSPEC_HIDDEN;
 316 extern UINT link_source_descriptor_clipboard_format DECLSPEC_HIDDEN;
 317 extern UINT ole_private_data_clipboard_format DECLSPEC_HIDDEN;
 318
 319 extern LSTATUS create_classes_key(HKEY, const WCHAR *, REGSAM, HKEY *) DECLSPEC_HIDDEN;
 320 extern LSTATUS open_classes_key(HKEY, const WCHAR *, REGSAM, HKEY *) DECLSPEC_HIDDEN;
 321
 322 extern BOOL actctx_get_miscstatus(const CLSID*, DWORD, DWORD*) DECLSPEC_HIDDEN;
 323
 324 extern const char *debugstr_formatetc(const FORMATETC *formatetc) DECLSPEC_HIDDEN;
 325
 326 static inline void* __WINE_ALLOC_SIZE(1) heap_alloc(size_t len)
 327 {
 328     return HeapAlloc(GetProcessHeap(), 0, len);
 329 }
 330
 331 static inline BOOL heap_free(void *mem)
 332 {
 333     return HeapFree(GetProcessHeap(), 0, mem);
 334 }
 335
 336 static inline HRESULT copy_formatetc(FORMATETC *dst, const FORMATETC *src)
 337 {
 338     *dst = *src;
 339     if (src->ptd)
 340     {
 341         dst->ptd = CoTaskMemAlloc( src->ptd->tdSize );
 342         if (!dst->ptd) return E_OUTOFMEMORY;
 343         memcpy( dst->ptd, src->ptd, src->ptd->tdSize );
 344     }
 345     return S_OK;
 346 }
 347
 348 extern HRESULT EnumSTATDATA_Construct(IUnknown *holder, ULONG index, DWORD array_len, STATDATA *data,
 349                                       BOOL copy, IEnumSTATDATA **ppenum) DECLSPEC_HIDDEN;
 350
 351 #endif /* __WINE_OLE_COMPOBJ_H */