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
  44 DEFINE_OLEGUID( CLSID_DfMarshal, 0x0000030b, 0, 0 );
  45 DEFINE_OLEGUID( CLSID_PSFactoryBuffer, 0x00000320, 0, 0 );
  46 DEFINE_OLEGUID( CLSID_InProcFreeMarshaler, 0x0000033a, 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 setion 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     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     /* We need to keep a count of the outstanding marshals, so we can enforce the
 102      * marshalling rules (ie, you can only unmarshal normal marshals once). Note
 103      * that these counts do NOT include unmarshalled interfaces, once a stream is
 104      * unmarshalled and a proxy set up, this count is decremented.
 105      */
 106
 107     ULONG             norm_refs;  /* refcount of normal marshals (CS lock) */
 108 };
 109
 110 /* imported interface proxy */
 111 struct ifproxy
 112 {
 113   struct list entry;       /* entry in proxy_manager list (CS parent->cs) */
 114   struct proxy_manager *parent; /* owning proxy_manager (RO) */
 115   LPVOID iface;            /* interface pointer (RO) */
 116   STDOBJREF stdobjref;     /* marshal data that represents this object (RO) */
 117   IID iid;                 /* interface ID (RO) */
 118   LPRPCPROXYBUFFER proxy;  /* interface proxy (RO) */
 119   ULONG refs;              /* imported (public) references (LOCK) */
 120   IRpcChannelBuffer *chan; /* channel to object (CS parent->cs) */
 121 };
 122
 123 /* imported object / proxy manager */
 124 struct proxy_manager
 125 {
 126   const IMultiQIVtbl *lpVtbl;
 127   const IMarshalVtbl *lpVtblMarshal;
 128   const IClientSecurityVtbl *lpVtblCliSec;
 129   struct apartment *parent; /* owning apartment (RO) */
 130   struct list entry;        /* entry in apartment (CS parent->cs) */
 131   OXID oxid;                /* object exported ID (RO) */
 132   OXID_INFO oxid_info;      /* string binding, ipid of rem unknown and other information (RO) */
 133   OID oid;                  /* object ID (RO) */
 134   struct list interfaces;   /* imported interfaces (CS cs) */
 135   LONG refs;                /* proxy reference count (LOCK) */
 136   CRITICAL_SECTION cs;      /* thread safety for this object and children */
 137   ULONG sorflags;           /* STDOBJREF flags (RO) */
 138   IRemUnknown *remunk;      /* proxy to IRemUnknown used for lifecycle management (CS cs) */
 139   HANDLE remoting_mutex;    /* mutex used for synchronizing access to IRemUnknown */
 140   MSHCTX dest_context;      /* context used for activating optimisations (LOCK) */
 141   void *dest_context_data;  /* reserved context value (LOCK) */
 142 };
 143
 144 /* this needs to become a COM object that implements IRemUnknown */
 145 struct apartment
 146 {
 147   struct list entry;
 148
 149   LONG  refs;              /* refcount of the apartment (LOCK) */
 150   BOOL multi_threaded;     /* multi-threaded or single-threaded apartment? (RO) */
 151   DWORD tid;               /* thread id (RO) */
 152   OXID oxid;               /* object exporter ID (RO) */
 153   LONG ipidc;              /* interface pointer ID counter, starts at 1 (LOCK) */
 154   CRITICAL_SECTION cs;     /* thread safety */
 155   struct list proxies;     /* imported objects (CS cs) */
 156   struct list stubmgrs;    /* stub managers for exported objects (CS cs) */
 157   BOOL remunk_exported;    /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
 158   LONG remoting_started;   /* has the RPC system been started for this apartment? (LOCK) */
 159   struct list psclsids;    /* list of registered PS CLSIDs (CS cs) */
 160   struct list loaded_dlls; /* list of dlls loaded by this apartment (CS cs) */
 161   DWORD host_apt_tid;      /* thread ID of apartment hosting objects of differing threading model (CS cs) */
 162   HWND host_apt_hwnd;      /* handle to apartment window of host apartment (CS cs) */
 163
 164   /* FIXME: OID's should be given out by RPCSS */
 165   OID oidc;                /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
 166
 167   /* STA-only fields */
 168   HWND win;                /* message window (LOCK) */
 169   LPMESSAGEFILTER filter;  /* message filter (CS cs) */
 170   BOOL main;               /* is this a main-threaded-apartment? (RO) */
 171 };
 172
 173 /* this is what is stored in TEB->ReservedForOle */
 174 struct oletls
 175 {
 176     struct apartment *apt;
 177     IErrorInfo       *errorinfo;   /* see errorinfo.c */
 178     IUnknown         *state;       /* see CoSetState */
 179     DWORD            inits;        /* number of times CoInitializeEx called */
 180     DWORD            ole_inits;    /* number of times OleInitialize called */
 181     GUID             causality_id; /* unique identifier for each COM call */
 182     LONG             pending_call_count_client; /* number of client calls pending */
 183     LONG             pending_call_count_server; /* number of server calls pending */
 184 };
 185
 186
 187 /* Global Interface Table Functions */
 188
 189 extern void* StdGlobalInterfaceTable_Construct(void);
 190 extern HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv);
 191 extern void* StdGlobalInterfaceTableInstance;
 192
 193 /* FIXME: these shouldn't be needed, except for 16-bit functions */
 194 extern HRESULT WINE_StringFromCLSID(const CLSID *id,LPSTR idstr);
 195
 196 HRESULT COM_OpenKeyForCLSID(REFCLSID clsid, LPCWSTR keyname, REGSAM access, HKEY *key);
 197 HRESULT COM_OpenKeyForAppIdFromCLSID(REFCLSID clsid, REGSAM access, HKEY *subkey);
 198 HRESULT MARSHAL_GetStandardMarshalCF(LPVOID *ppv);
 199 HRESULT FTMarshalCF_Create(REFIID riid, LPVOID *ppv);
 200
 201 /* Stub Manager */
 202
 203 ULONG stub_manager_int_addref(struct stub_manager *This);
 204 ULONG stub_manager_int_release(struct stub_manager *This);
 205 struct stub_manager *new_stub_manager(APARTMENT *apt, IUnknown *object);
 206 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs);
 207 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs, BOOL last_unlock_releases);
 208 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, IUnknown *iptr, REFIID iid, MSHLFLAGS flags);
 209 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags);
 210 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid);
 211 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, void *object);
 212 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid);
 213 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid);
 214 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid);
 215 HRESULT ipid_to_stub_manager(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **stubmgr_ret);
 216 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt, IRpcStubBuffer **stub, IRpcChannelBuffer **chan, IID *iid, IUnknown **iface);
 217 HRESULT start_apartment_remote_unknown(void);
 218
 219 HRESULT marshal_object(APARTMENT *apt, STDOBJREF *stdobjref, REFIID riid, IUnknown *obj, MSHLFLAGS mshlflags);
 220
 221 /* RPC Backend */
 222
 223 struct dispatch_params;
 224
 225 void    RPC_StartRemoting(struct apartment *apt);
 226 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
 227                                 const OXID_INFO *oxid_info,
 228                                 DWORD dest_context, void *dest_context_data,
 229                                 IRpcChannelBuffer **chan);
 230 HRESULT RPC_CreateServerChannel(IRpcChannelBuffer **chan);
 231 void    RPC_ExecuteCall(struct dispatch_params *params);
 232 HRESULT RPC_RegisterInterface(REFIID riid);
 233 void    RPC_UnregisterInterface(REFIID riid);
 234 HRESULT RPC_StartLocalServer(REFCLSID clsid, IStream *stream, BOOL multi_use, void **registration);
 235 void    RPC_StopLocalServer(void *registration);
 236 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv);
 237 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook);
 238 void    RPC_UnregisterAllChannelHooks(void);
 239 HRESULT RPC_ResolveOxid(OXID oxid, OXID_INFO *oxid_info);
 240
 241 /* This function initialize the Running Object Table */
 242 HRESULT WINAPI RunningObjectTableImpl_Initialize(void);
 243
 244 /* This function uninitialize the Running Object Table */
 245 HRESULT WINAPI RunningObjectTableImpl_UnInitialize(void);
 246
 247 /* Drag and drop */
 248 void OLEDD_UnInitialize(void);
 249
 250 /* Apartment Functions */
 251
 252 APARTMENT *apartment_findfromoxid(OXID oxid, BOOL ref);
 253 APARTMENT *apartment_findfromtid(DWORD tid);
 254 DWORD apartment_addref(struct apartment *apt);
 255 DWORD apartment_release(struct apartment *apt);
 256 HRESULT apartment_disconnectproxies(struct apartment *apt);
 257 void apartment_disconnectobject(struct apartment *apt, void *object);
 258 static inline HRESULT apartment_getoxid(const struct apartment *apt, OXID *oxid)
 259 {
 260     *oxid = apt->oxid;
 261     return S_OK;
 262 }
 263 HRESULT apartment_createwindowifneeded(struct apartment *apt);
 264 HWND apartment_getwindow(const struct apartment *apt);
 265 void apartment_joinmta(void);
 266
 267
 268 /* DCOM messages used by the apartment window (not compatible with native) */
 269 #define DM_EXECUTERPC   (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
 270 #define DM_HOSTOBJECT   (WM_USER + 1) /* WPARAM = 0, LPARAM = (struct host_object_params *) */
 271
 272 /*
 273  * Per-thread values are stored in the TEB on offset 0xF80,
 274  * see http://www.microsoft.com/msj/1099/bugslayer/bugslayer1099.htm
 275  */
 276
 277 /* will create if necessary */
 278 static inline struct oletls *COM_CurrentInfo(void)
 279 {
 280     if (!NtCurrentTeb()->ReservedForOle)
 281         NtCurrentTeb()->ReservedForOle = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct oletls));
 282
 283     return NtCurrentTeb()->ReservedForOle;
 284 }
 285
 286 static inline APARTMENT* COM_CurrentApt(void)
 287 {
 288     return COM_CurrentInfo()->apt;
 289 }
 290
 291 static inline GUID COM_CurrentCausalityId(void)
 292 {
 293     struct oletls *info = COM_CurrentInfo();
 294     if (!info)
 295         return GUID_NULL;
 296     if (IsEqualGUID(&info->causality_id, &GUID_NULL))
 297         CoCreateGuid(&info->causality_id);
 298     return info->causality_id;
 299 }
 300
 301 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
 302
 303 /* helpers for debugging */
 304 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
 305 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
 306
 307 extern HINSTANCE OLE32_hInstance; /* FIXME: make static */
 308
 309 #define CHARS_IN_GUID 39 /* including NULL */
 310
 311 /* Exported non-interface Data Advise Holder functions */
 312 HRESULT DataAdviseHolder_OnConnect(IDataAdviseHolder *iface, IDataObject *pDelegate);
 313 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder *iface);
 314
 315 #endif /* __WINE_OLE_COMPOBJ_H */