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