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 BOOL being_destroyed; /* is currently being destroyed */
146
147 /* FIXME: OIDs should be given out by RPCSS */
148 OID oidc; /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
149
150 /* STA-only fields */
151 HWND win; /* message window (LOCK) */
152 LPMESSAGEFILTER filter; /* message filter (CS cs) */
153 BOOL main; /* is this a main-threaded-apartment? (RO) */
154 };
155
156 struct init_spy
157 {
158 struct list entry;
159 IInitializeSpy *spy;
160 unsigned int id;
161 };
162
163 /* this is what is stored in TEB->ReservedForOle */
164 struct oletls
165 {
166 struct apartment *apt;
167 IErrorInfo *errorinfo; /* see errorinfo.c */
168 IUnknown *state; /* see CoSetState */
169 DWORD apt_mask; /* apartment mask (+0Ch on x86) */
170 void *unknown0;
171 DWORD inits; /* number of times CoInitializeEx called */
172 DWORD ole_inits; /* number of times OleInitialize called */
173 GUID causality_id; /* unique identifier for each COM call */
174 LONG pending_call_count_client; /* number of client calls pending */
175 LONG pending_call_count_server; /* number of server calls pending */
176 DWORD unknown;
177 IObjContext *context_token; /* (+38h on x86) */
178 IUnknown *call_state; /* current call context (+3Ch on x86) */
179 DWORD unknown2[46];
180 IUnknown *cancel_object; /* cancel object set by CoSetCancelObject (+F8h on x86) */
181 struct list spies; /* Spies installed with CoRegisterInitializeSpy */
182 DWORD spies_lock;
183 };
184
185
186 /* Global Interface Table Functions */
187 extern IGlobalInterfaceTable *get_std_git(void) DECLSPEC_HIDDEN;
188 extern void release_std_git(void) DECLSPEC_HIDDEN;
189 extern HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv) DECLSPEC_HIDDEN;
190
191 HRESULT COM_OpenKeyForCLSID(REFCLSID clsid, LPCWSTR keyname, REGSAM access, HKEY *key) DECLSPEC_HIDDEN;
192 HRESULT COM_OpenKeyForAppIdFromCLSID(REFCLSID clsid, REGSAM access, HKEY *subkey) DECLSPEC_HIDDEN;
193 HRESULT MARSHAL_GetStandardMarshalCF(LPVOID *ppv) DECLSPEC_HIDDEN;
194 HRESULT FTMarshalCF_Create(REFIID riid, LPVOID *ppv) DECLSPEC_HIDDEN;
195
196 /* Stub Manager */
197
198 ULONG stub_manager_int_release(struct stub_manager *This) DECLSPEC_HIDDEN;
199 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs, BOOL tableweak) DECLSPEC_HIDDEN;
200 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs, BOOL tableweak, BOOL last_unlock_releases) DECLSPEC_HIDDEN;
201 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, REFIID iid,
202 DWORD dest_context, void *dest_context_data, MSHLFLAGS flags) DECLSPEC_HIDDEN;
203 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags) DECLSPEC_HIDDEN;
204 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid) DECLSPEC_HIDDEN;
205 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, IUnknown *object, BOOL alloc) DECLSPEC_HIDDEN;
206 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid) DECLSPEC_HIDDEN;
207 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid) DECLSPEC_HIDDEN;
208 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid, BOOL tableweak) DECLSPEC_HIDDEN;
209 void stub_manager_disconnect(struct stub_manager *m) DECLSPEC_HIDDEN;
210 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **manager, IRpcStubBuffer **stub,
211 IRpcChannelBuffer **chan, IID *iid, IUnknown **iface) DECLSPEC_HIDDEN;
212 HRESULT start_apartment_remote_unknown(APARTMENT *apt) DECLSPEC_HIDDEN;
213
214 HRESULT marshal_object(APARTMENT *apt, STDOBJREF *stdobjref, REFIID riid, IUnknown *obj, DWORD dest_context, void *dest_context_data, MSHLFLAGS mshlflags) DECLSPEC_HIDDEN;
215
216 /* RPC Backend */
217
218 struct dispatch_params;
219
220 void RPC_StartRemoting(struct apartment *apt) DECLSPEC_HIDDEN;
221 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
222 const OXID_INFO *oxid_info, const IID *iid,
223 DWORD dest_context, void *dest_context_data,
224 IRpcChannelBuffer **chan, APARTMENT *apt) DECLSPEC_HIDDEN;
225 HRESULT RPC_CreateServerChannel(DWORD dest_context, void *dest_context_data, IRpcChannelBuffer **chan) DECLSPEC_HIDDEN;
226 void RPC_ExecuteCall(struct dispatch_params *params) DECLSPEC_HIDDEN;
227 HRESULT RPC_RegisterInterface(REFIID riid) DECLSPEC_HIDDEN;
228 void RPC_UnregisterInterface(REFIID riid, BOOL wait) DECLSPEC_HIDDEN;
229 HRESULT RPC_StartLocalServer(REFCLSID clsid, IStream *stream, BOOL multi_use, void **registration) DECLSPEC_HIDDEN;
230 void RPC_StopLocalServer(void *registration) DECLSPEC_HIDDEN;
231 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv) DECLSPEC_HIDDEN;
232 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook) DECLSPEC_HIDDEN;
233 void RPC_UnregisterAllChannelHooks(void) DECLSPEC_HIDDEN;
234 HRESULT RPC_ResolveOxid(OXID oxid, OXID_INFO *oxid_info) DECLSPEC_HIDDEN;
235
236 /* This function initialize the Running Object Table */
237 HRESULT WINAPI RunningObjectTableImpl_Initialize(void) DECLSPEC_HIDDEN;
238
239 /* This function uninitialize the Running Object Table */
240 HRESULT WINAPI RunningObjectTableImpl_UnInitialize(void) DECLSPEC_HIDDEN;
241
242 /* Drag and drop */
243 void OLEDD_UnInitialize(void) DECLSPEC_HIDDEN;
244
245 /* Apartment Functions */
246
247 APARTMENT *apartment_findfromoxid(OXID oxid, BOOL ref) DECLSPEC_HIDDEN;
248 APARTMENT *apartment_findfromtid(DWORD tid) DECLSPEC_HIDDEN;
249 DWORD apartment_release(struct apartment *apt) DECLSPEC_HIDDEN;
250 HRESULT apartment_disconnectproxies(struct apartment *apt) DECLSPEC_HIDDEN;
apartment_getoxid(const struct apartment * apt,OXID * oxid)251 static inline HRESULT apartment_getoxid(const struct apartment *apt, OXID *oxid)
252 {
253 *oxid = apt->oxid;
254 return S_OK;
255 }
256 HRESULT apartment_createwindowifneeded(struct apartment *apt) DECLSPEC_HIDDEN;
257 HWND apartment_getwindow(const struct apartment *apt) DECLSPEC_HIDDEN;
258 HRESULT enter_apartment(struct oletls *info, DWORD model) DECLSPEC_HIDDEN;
259 void leave_apartment(struct oletls *info) DECLSPEC_HIDDEN;
260 APARTMENT *apartment_get_current_or_mta(void) DECLSPEC_HIDDEN;
261
262 /* DCOM messages used by the apartment window (not compatible with native) */
263 #define DM_EXECUTERPC (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
264 #define DM_HOSTOBJECT (WM_USER + 1) /* WPARAM = 0, LPARAM = (struct host_object_params *) */
265
266 /*
267 * Per-thread values are stored in the TEB on offset 0xF80
268 */
269
270 /* will create if necessary */
COM_CurrentInfo(void)271 static inline struct oletls *COM_CurrentInfo(void)
272 {
273 if (!NtCurrentTeb()->ReservedForOle)
274 {
275 struct oletls *oletls = heap_alloc_zero(sizeof(*oletls));
276 if (oletls)
277 list_init(&oletls->spies);
278 NtCurrentTeb()->ReservedForOle = oletls;
279 }
280
281 return NtCurrentTeb()->ReservedForOle;
282 }
283
COM_CurrentApt(void)284 static inline APARTMENT* COM_CurrentApt(void)
285 {
286 return COM_CurrentInfo()->apt;
287 }
288
COM_CurrentCausalityId(void)289 static inline GUID COM_CurrentCausalityId(void)
290 {
291 struct oletls *info = COM_CurrentInfo();
292 if (!info)
293 return GUID_NULL;
294 if (IsEqualGUID(&info->causality_id, &GUID_NULL))
295 CoCreateGuid(&info->causality_id);
296 return info->causality_id;
297 }
298
299 /* helpers for debugging */
300 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
301 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
302
303 #define CHARS_IN_GUID 39 /* including NULL */
304
305 #define WINE_CLSCTX_DONT_HOST 0x80000000
306
307 /* from dlldata.c */
308 extern HINSTANCE hProxyDll DECLSPEC_HIDDEN;
309 extern HRESULT WINAPI OLE32_DllGetClassObject(REFCLSID rclsid, REFIID iid,LPVOID *ppv) DECLSPEC_HIDDEN;
310 extern HRESULT WINAPI OLE32_DllRegisterServer(void) DECLSPEC_HIDDEN;
311 extern HRESULT WINAPI OLE32_DllUnregisterServer(void) DECLSPEC_HIDDEN;
312
313 extern HRESULT Handler_DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv) DECLSPEC_HIDDEN;
314 extern HRESULT HandlerCF_Create(REFCLSID rclsid, REFIID riid, LPVOID *ppv) DECLSPEC_HIDDEN;
315
316 extern HRESULT WINAPI GlobalOptions_CreateInstance(IClassFactory *iface, IUnknown *pUnk,
317 REFIID riid, void **ppv) DECLSPEC_HIDDEN;
318 extern IClassFactory GlobalOptionsCF DECLSPEC_HIDDEN;
319
320 /* Exported non-interface Data Advise Holder functions */
321 HRESULT DataAdviseHolder_OnConnect(IDataAdviseHolder *iface, IDataObject *pDelegate) DECLSPEC_HIDDEN;
322 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder *iface) DECLSPEC_HIDDEN;
323
324 extern UINT ownerlink_clipboard_format DECLSPEC_HIDDEN;
325 extern UINT filename_clipboard_format DECLSPEC_HIDDEN;
326 extern UINT filenameW_clipboard_format DECLSPEC_HIDDEN;
327 extern UINT dataobject_clipboard_format DECLSPEC_HIDDEN;
328 extern UINT embedded_object_clipboard_format DECLSPEC_HIDDEN;
329 extern UINT embed_source_clipboard_format DECLSPEC_HIDDEN;
330 extern UINT custom_link_source_clipboard_format DECLSPEC_HIDDEN;
331 extern UINT link_source_clipboard_format DECLSPEC_HIDDEN;
332 extern UINT object_descriptor_clipboard_format DECLSPEC_HIDDEN;
333 extern UINT link_source_descriptor_clipboard_format DECLSPEC_HIDDEN;
334 extern UINT ole_private_data_clipboard_format DECLSPEC_HIDDEN;
335
336 extern LSTATUS create_classes_key(HKEY, const WCHAR *, REGSAM, HKEY *) DECLSPEC_HIDDEN;
337 extern LSTATUS open_classes_key(HKEY, const WCHAR *, REGSAM, HKEY *) DECLSPEC_HIDDEN;
338
339 extern BOOL actctx_get_miscstatus(const CLSID*, DWORD, DWORD*) DECLSPEC_HIDDEN;
340
341 extern const char *debugstr_formatetc(const FORMATETC *formatetc) DECLSPEC_HIDDEN;
342
copy_formatetc(FORMATETC * dst,const FORMATETC * src)343 static inline HRESULT copy_formatetc(FORMATETC *dst, const FORMATETC *src)
344 {
345 *dst = *src;
346 if (src->ptd)
347 {
348 dst->ptd = CoTaskMemAlloc( src->ptd->tdSize );
349 if (!dst->ptd) return E_OUTOFMEMORY;
350 memcpy( dst->ptd, src->ptd, src->ptd->tdSize );
351 }
352 return S_OK;
353 }
354
355 extern HRESULT EnumSTATDATA_Construct(IUnknown *holder, ULONG index, DWORD array_len, STATDATA *data,
356 BOOL copy, IEnumSTATDATA **ppenum) DECLSPEC_HIDDEN;
357
358 #endif /* __WINE_OLE_COMPOBJ_H */
359