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 /* Thread-safety Annotation Legend:
  49  *
  50  * RO    - The value is read only. It never changes after creation, so no
  51  *         locking is required.
  52  * LOCK  - The value is written to only using Interlocked* functions.
  53  * CS    - The value is read or written to inside a critical section.
  54  *         The identifier following "CS" is the specific critical setion that
  55  *         must be used.
  56  * MUTEX - The value is read or written to with a mutex held.
  57  *         The identifier following "MUTEX" is the specific mutex that
  58  *         must be used.
  59  */
  60
  61 typedef enum ifstub_state
  62 {
  63     STUBSTATE_NORMAL_MARSHALED,
  64     STUBSTATE_NORMAL_UNMARSHALED,
  65     STUBSTATE_TABLE_WEAK_MARSHALED,
  66     STUBSTATE_TABLE_WEAK_UNMARSHALED,
  67     STUBSTATE_TABLE_STRONG,
  68 } STUB_STATE;
  69
  70 /* an interface stub */
  71 struct ifstub
  72 {
  73     struct list       entry;      /* entry in stub_manager->ifstubs list (CS stub_manager->lock) */
  74     IRpcStubBuffer   *stubbuffer; /* RO */
  75     IID               iid;        /* RO */
  76     IPID              ipid;       /* RO */
  77     IUnknown         *iface;      /* RO */
  78     MSHLFLAGS         flags;      /* so we can enforce process-local marshalling rules (RO) */
  79     IRpcChannelBuffer*chan;       /* channel passed to IRpcStubBuffer::Invoke (RO) */
  80 };
  81
  82
  83 /* stub managers hold refs on the object and each interface stub */
  84 struct stub_manager
  85 {
  86     struct list       entry;      /* entry in apartment stubmgr list (CS apt->cs) */
  87     struct list       ifstubs;    /* list of active ifstubs for the object (CS lock) */
  88     CRITICAL_SECTION  lock;
  89     APARTMENT        *apt;        /* owning apt (RO) */
  90
  91     ULONG             extrefs;    /* number of 'external' references (CS lock) */
  92     ULONG             refs;       /* internal reference count (CS apt->cs) */
  93     OID               oid;        /* apartment-scoped unique identifier (RO) */
  94     IUnknown         *object;     /* the object we are managing the stub for (RO) */
  95     ULONG             next_ipid;  /* currently unused (LOCK) */
  96
  97     /* We need to keep a count of the outstanding marshals, so we can enforce the
  98      * marshalling rules (ie, you can only unmarshal normal marshals once). Note
  99      * that these counts do NOT include unmarshalled interfaces, once a stream is
 100      * unmarshalled and a proxy set up, this count is decremented.
 101      */
 102
 103     ULONG             norm_refs;  /* refcount of normal marshals (CS lock) */
 104 };
 105
 106 /* imported interface proxy */
 107 struct ifproxy
 108 {
 109   struct list entry;       /* entry in proxy_manager list (CS parent->cs) */
 110   struct proxy_manager *parent; /* owning proxy_manager (RO) */
 111   LPVOID iface;            /* interface pointer (RO) */
 112   STDOBJREF stdobjref;     /* marshal data that represents this object (RO) */
 113   IID iid;                 /* interface ID (RO) */
 114   LPRPCPROXYBUFFER proxy;  /* interface proxy (RO) */
 115   ULONG refs;              /* imported (public) references (LOCK) */
 116   IRpcChannelBuffer *chan; /* channel to object (CS parent->cs) */
 117 };
 118
 119 /* imported object / proxy manager */
 120 struct proxy_manager
 121 {
 122   const IMultiQIVtbl *lpVtbl;
 123   const IMarshalVtbl *lpVtblMarshal;
 124   struct apartment *parent; /* owning apartment (RO) */
 125   struct list entry;        /* entry in apartment (CS parent->cs) */
 126   OXID oxid;                /* object exported ID (RO) */
 127   OID oid;                  /* object ID (RO) */
 128   struct list interfaces;   /* imported interfaces (CS cs) */
 129   LONG refs;                /* proxy reference count (LOCK) */
 130   CRITICAL_SECTION cs;      /* thread safety for this object and children */
 131   ULONG sorflags;           /* STDOBJREF flags (RO) */
 132   IRemUnknown *remunk;      /* proxy to IRemUnknown used for lifecycle management (CS cs) */
 133   HANDLE remoting_mutex;    /* mutex used for synchronizing access to IRemUnknown */
 134   MSHCTX dest_context;      /* context used for activating optimisations (LOCK) */
 135   void *dest_context_data;  /* reserved context value (LOCK) */
 136 };
 137
 138 /* this needs to become a COM object that implements IRemUnknown */
 139 struct apartment
 140 {
 141   struct list entry;
 142
 143   LONG  refs;              /* refcount of the apartment (LOCK) */
 144   BOOL multi_threaded;     /* multi-threaded or single-threaded apartment? (RO) */
 145   DWORD tid;               /* thread id (RO) */
 146   OXID oxid;               /* object exporter ID (RO) */
 147   LONG ipidc;              /* interface pointer ID counter, starts at 1 (LOCK) */
 148   CRITICAL_SECTION cs;     /* thread safety */
 149   struct list proxies;     /* imported objects (CS cs) */
 150   struct list stubmgrs;    /* stub managers for exported objects (CS cs) */
 151   BOOL remunk_exported;    /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
 152   LONG remoting_started;   /* has the RPC system been started for this apartment? (LOCK) */
 153   struct list psclsids;    /* list of registered PS CLSIDs (CS cs) */
 154
 155   /* FIXME: OID's should be given out by RPCSS */
 156   OID oidc;                /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
 157
 158   /* STA-only fields */
 159   HWND win;                /* message window (LOCK) */
 160   LPMESSAGEFILTER filter;  /* message filter (CS cs) */
 161   BOOL main;               /* is this a main-threaded-apartment? (RO) */
 162 };
 163
 164 /* this is what is stored in TEB->ReservedForOle */
 165 struct oletls
 166 {
 167     struct apartment *apt;
 168     IErrorInfo       *errorinfo;   /* see errorinfo.c */
 169     IUnknown         *state;       /* see CoSetState */
 170     DWORD            inits;        /* number of times CoInitializeEx called */
 171     DWORD            ole_inits;    /* number of times OleInitialize called */
 172     GUID             causality_id; /* unique identifier for each COM call */
 173     LONG             pending_call_count_client; /* number of client calls pending */
 174     LONG             pending_call_count_server; /* number of server calls pending */
 175 };
 176
 177
 178 /* Global Interface Table Functions */
 179
 180 extern void* StdGlobalInterfaceTable_Construct(void);
 181 extern HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv);
 182 extern void* StdGlobalInterfaceTableInstance;
 183
 184 /* FIXME: these shouldn't be needed, except for 16-bit functions */
 185 extern HRESULT WINE_StringFromCLSID(const CLSID *id,LPSTR idstr);
 186
 187 HRESULT COM_OpenKeyForCLSID(REFCLSID clsid, LPCWSTR keyname, REGSAM access, HKEY *key);
 188 HRESULT COM_OpenKeyForAppIdFromCLSID(REFCLSID clsid, REGSAM access, HKEY *subkey);
 189 HRESULT MARSHAL_GetStandardMarshalCF(LPVOID *ppv);
 190 HRESULT FTMarshalCF_Create(REFIID riid, LPVOID *ppv);
 191
 192 /* Stub Manager */
 193
 194 ULONG stub_manager_int_addref(struct stub_manager *This);
 195 ULONG stub_manager_int_release(struct stub_manager *This);
 196 struct stub_manager *new_stub_manager(APARTMENT *apt, IUnknown *object);
 197 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs);
 198 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs, BOOL last_unlock_releases);
 199 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, IUnknown *iptr, REFIID iid, MSHLFLAGS flags);
 200 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags);
 201 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid);
 202 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, void *object);
 203 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid);
 204 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid);
 205 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid);
 206 HRESULT ipid_to_stub_manager(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **stubmgr_ret);
 207 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt, IRpcStubBuffer **stub, IRpcChannelBuffer **chan, IID *iid, IUnknown **iface);
 208 HRESULT start_apartment_remote_unknown(void);
 209
 210 HRESULT marshal_object(APARTMENT *apt, STDOBJREF *stdobjref, REFIID riid, IUnknown *obj, MSHLFLAGS mshlflags);
 211
 212 /* RPC Backend */
 213
 214 struct dispatch_params;
 215
 216 void    RPC_StartRemoting(struct apartment *apt);
 217 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
 218                                 DWORD dest_context, void *dest_context_data,
 219                                 IRpcChannelBuffer **chan);
 220 HRESULT RPC_CreateServerChannel(IRpcChannelBuffer **chan);
 221 void    RPC_ExecuteCall(struct dispatch_params *params);
 222 HRESULT RPC_RegisterInterface(REFIID riid);
 223 void    RPC_UnregisterInterface(REFIID riid);
 224 void    RPC_StartLocalServer(REFCLSID clsid, IStream *stream);
 225 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv);
 226 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook);
 227 void    RPC_UnregisterAllChannelHooks(void);
 228
 229 /* This function initialize the Running Object Table */
 230 HRESULT WINAPI RunningObjectTableImpl_Initialize(void);
 231
 232 /* This function uninitialize the Running Object Table */
 233 HRESULT WINAPI RunningObjectTableImpl_UnInitialize(void);
 234
 235 /* This function decomposes a String path to a String Table containing all the elements ("\" or "subDirectory" or "Directory" or "FileName") of the path */
 236 int FileMonikerImpl_DecomposePath(LPCOLESTR str, LPOLESTR** stringTable);
 237
 238
 239 /* Apartment Functions */
 240
 241 APARTMENT *apartment_findfromoxid(OXID oxid, BOOL ref);
 242 APARTMENT *apartment_findfromtid(DWORD tid);
 243 DWORD apartment_addref(struct apartment *apt);
 244 DWORD apartment_release(struct apartment *apt);
 245 HRESULT apartment_disconnectproxies(struct apartment *apt);
 246 void apartment_disconnectobject(struct apartment *apt, void *object);
 247 static inline HRESULT apartment_getoxid(struct apartment *apt, OXID *oxid)
 248 {
 249     *oxid = apt->oxid;
 250     return S_OK;
 251 }
 252 HRESULT apartment_createwindowifneeded(struct apartment *apt);
 253 HWND apartment_getwindow(struct apartment *apt);
 254 void apartment_joinmta(void);
 255
 256
 257 /* DCOM messages used by the apartment window (not compatible with native) */
 258 #define DM_EXECUTERPC   (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
 259 #define DM_HOSTOBJECT   (WM_USER + 1) /* WPARAM = 0, LPARAM = (struct host_object_params *) */
 260
 261 /*
 262  * Per-thread values are stored in the TEB on offset 0xF80,
 263  * see http://www.microsoft.com/msj/1099/bugslayer/bugslayer1099.htm
 264  */
 265
 266 /* will create if necessary */
 267 static inline struct oletls *COM_CurrentInfo(void)
 268 {
 269     if (!NtCurrentTeb()->ReservedForOle)
 270         NtCurrentTeb()->ReservedForOle = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct oletls));
 271
 272     return NtCurrentTeb()->ReservedForOle;
 273 }
 274
 275 static inline APARTMENT* COM_CurrentApt(void)
 276 {
 277     return COM_CurrentInfo()->apt;
 278 }
 279
 280 static inline GUID COM_CurrentCausalityId(void)
 281 {
 282     struct oletls *info = COM_CurrentInfo();
 283     if (!info)
 284         return GUID_NULL;
 285     if (IsEqualGUID(&info->causality_id, &GUID_NULL))
 286         CoCreateGuid(&info->causality_id);
 287     return info->causality_id;
 288 }
 289
 290 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
 291
 292 /* helpers for debugging */
 293 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
 294 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
 295
 296 extern HINSTANCE OLE32_hInstance; /* FIXME: make static */
 297
 298 #define CHARS_IN_GUID 39 /* including NULL */
 299
 300 /* Exported non-interface Data Advise Holder functions */
 301 HRESULT DataAdviseHolder_OnConnect(IDataAdviseHolder *iface, IDataObject *pDelegate);
 302 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder *iface);
 303
 304 #endif /* __WINE_OLE_COMPOBJ_H */