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
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.
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.
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
25 #ifndef __WINE_OLE_COMPOBJ_H
26 #define __WINE_OLE_COMPOBJ_H
28 /* All private prototype functions used by OLE will be added to this header file */
32 #include "wine/list.h"
42 typedef struct apartment APARTMENT
;
44 DEFINE_OLEGUID( CLSID_DfMarshal
, 0x0000030b, 0, 0 );
45 DEFINE_OLEGUID( CLSID_PSFactoryBuffer
, 0x00000320, 0, 0 );
47 /* signal to stub manager that this is a rem unknown object */
48 #define MSHLFLAGSP_REMUNKNOWN 0x80000000
50 /* Thread-safety Annotation Legend:
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
58 * MUTEX - The value is read or written to with a mutex held.
59 * The identifier following "MUTEX" is the specific mutex that
63 typedef enum ifstub_state
65 STUBSTATE_NORMAL_MARSHALED
,
66 STUBSTATE_NORMAL_UNMARSHALED
,
67 STUBSTATE_TABLE_WEAK_MARSHALED
,
68 STUBSTATE_TABLE_WEAK_UNMARSHALED
,
69 STUBSTATE_TABLE_STRONG
,
72 /* an interface stub */
75 struct list entry
; /* entry in stub_manager->ifstubs list (CS stub_manager->lock) */
76 IRpcStubBuffer
*stubbuffer
; /* 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) */
85 /* stub managers hold refs on the object and each interface stub */
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) */
93 ULONG extrefs
; /* number of 'external' references (CS lock) */
94 ULONG refs
; /* internal reference count (CS apt->cs) */
95 OID oid
; /* apartment-scoped unique identifier (RO) */
96 IUnknown
*object
; /* the object we are managing the stub for (RO) */
97 ULONG next_ipid
; /* currently unused (LOCK) */
98 OXID_INFO oxid_info
; /* string binding, ipid of rem unknown and other information (RO) */
100 /* We need to keep a count of the outstanding marshals, so we can enforce the
101 * marshalling rules (ie, you can only unmarshal normal marshals once). Note
102 * that these counts do NOT include unmarshalled interfaces, once a stream is
103 * unmarshalled and a proxy set up, this count is decremented.
106 ULONG norm_refs
; /* refcount of normal marshals (CS lock) */
109 /* imported interface proxy */
112 struct list entry
; /* entry in proxy_manager list (CS parent->cs) */
113 struct proxy_manager
*parent
; /* owning proxy_manager (RO) */
114 LPVOID iface
; /* interface pointer (RO) */
115 STDOBJREF stdobjref
; /* marshal data that represents this object (RO) */
116 IID iid
; /* interface ID (RO) */
117 LPRPCPROXYBUFFER proxy
; /* interface proxy (RO) */
118 ULONG refs
; /* imported (public) references (LOCK) */
119 IRpcChannelBuffer
*chan
; /* channel to object (CS parent->cs) */
122 /* imported object / proxy manager */
125 const IMultiQIVtbl
*lpVtbl
;
126 const IMarshalVtbl
*lpVtblMarshal
;
127 const IClientSecurityVtbl
*lpVtblCliSec
;
128 struct apartment
*parent
; /* owning apartment (RO) */
129 struct list entry
; /* entry in apartment (CS parent->cs) */
130 OXID oxid
; /* object exported ID (RO) */
131 OXID_INFO oxid_info
; /* string binding, ipid of rem unknown and other information (RO) */
132 OID oid
; /* object ID (RO) */
133 struct list interfaces
; /* imported interfaces (CS cs) */
134 LONG refs
; /* proxy reference count (LOCK) */
135 CRITICAL_SECTION cs
; /* thread safety for this object and children */
136 ULONG sorflags
; /* STDOBJREF flags (RO) */
137 IRemUnknown
*remunk
; /* proxy to IRemUnknown used for lifecycle management (CS cs) */
138 HANDLE remoting_mutex
; /* mutex used for synchronizing access to IRemUnknown */
139 MSHCTX dest_context
; /* context used for activating optimisations (LOCK) */
140 void *dest_context_data
; /* reserved context value (LOCK) */
147 LONG refs
; /* refcount of the apartment (LOCK) */
148 BOOL multi_threaded
; /* multi-threaded or single-threaded apartment? (RO) */
149 DWORD tid
; /* thread id (RO) */
150 OXID oxid
; /* object exporter ID (RO) */
151 LONG ipidc
; /* interface pointer ID counter, starts at 1 (LOCK) */
152 CRITICAL_SECTION cs
; /* thread safety */
153 struct list proxies
; /* imported objects (CS cs) */
154 struct list stubmgrs
; /* stub managers for exported objects (CS cs) */
155 BOOL remunk_exported
; /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
156 LONG remoting_started
; /* has the RPC system been started for this apartment? (LOCK) */
157 struct list psclsids
; /* list of registered PS CLSIDs (CS cs) */
158 struct list loaded_dlls
; /* list of dlls loaded by this apartment (CS cs) */
159 DWORD host_apt_tid
; /* thread ID of apartment hosting objects of differing threading model (CS cs) */
160 HWND host_apt_hwnd
; /* handle to apartment window of host apartment (CS cs) */
162 /* FIXME: OID's should be given out by RPCSS */
163 OID oidc
; /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
165 /* STA-only fields */
166 HWND win
; /* message window (LOCK) */
167 LPMESSAGEFILTER filter
; /* message filter (CS cs) */
168 BOOL main
; /* is this a main-threaded-apartment? (RO) */
171 /* this is what is stored in TEB->ReservedForOle */
174 struct apartment
*apt
;
175 IErrorInfo
*errorinfo
; /* see errorinfo.c */
176 IUnknown
*state
; /* see CoSetState */
177 DWORD inits
; /* number of times CoInitializeEx called */
178 DWORD ole_inits
; /* number of times OleInitialize called */
179 GUID causality_id
; /* unique identifier for each COM call */
180 LONG pending_call_count_client
; /* number of client calls pending */
181 LONG pending_call_count_server
; /* number of server calls pending */
185 /* Global Interface Table Functions */
187 extern void* StdGlobalInterfaceTable_Construct(void);
188 extern HRESULT
StdGlobalInterfaceTable_GetFactory(LPVOID
*ppv
);
189 extern void* StdGlobalInterfaceTableInstance
;
191 /* FIXME: these shouldn't be needed, except for 16-bit functions */
192 extern HRESULT
WINE_StringFromCLSID(const CLSID
*id
,LPSTR idstr
);
194 HRESULT
COM_OpenKeyForCLSID(REFCLSID clsid
, LPCWSTR keyname
, REGSAM access
, HKEY
*key
);
195 HRESULT
COM_OpenKeyForAppIdFromCLSID(REFCLSID clsid
, REGSAM access
, HKEY
*subkey
);
196 HRESULT
MARSHAL_GetStandardMarshalCF(LPVOID
*ppv
);
197 HRESULT
FTMarshalCF_Create(REFIID riid
, LPVOID
*ppv
);
201 ULONG
stub_manager_int_addref(struct stub_manager
*This
);
202 ULONG
stub_manager_int_release(struct stub_manager
*This
);
203 struct stub_manager
*new_stub_manager(APARTMENT
*apt
, IUnknown
*object
);
204 ULONG
stub_manager_ext_addref(struct stub_manager
*m
, ULONG refs
);
205 ULONG
stub_manager_ext_release(struct stub_manager
*m
, ULONG refs
, BOOL last_unlock_releases
);
206 struct ifstub
*stub_manager_new_ifstub(struct stub_manager
*m
, IRpcStubBuffer
*sb
, IUnknown
*iptr
, REFIID iid
, MSHLFLAGS flags
);
207 struct ifstub
*stub_manager_find_ifstub(struct stub_manager
*m
, REFIID iid
, MSHLFLAGS flags
);
208 struct stub_manager
*get_stub_manager(APARTMENT
*apt
, OID oid
);
209 struct stub_manager
*get_stub_manager_from_object(APARTMENT
*apt
, void *object
);
210 BOOL
stub_manager_notify_unmarshal(struct stub_manager
*m
, const IPID
*ipid
);
211 BOOL
stub_manager_is_table_marshaled(struct stub_manager
*m
, const IPID
*ipid
);
212 void stub_manager_release_marshal_data(struct stub_manager
*m
, ULONG refs
, const IPID
*ipid
);
213 HRESULT
ipid_to_stub_manager(const IPID
*ipid
, APARTMENT
**stub_apt
, struct stub_manager
**stubmgr_ret
);
214 HRESULT
ipid_get_dispatch_params(const IPID
*ipid
, APARTMENT
**stub_apt
, IRpcStubBuffer
**stub
, IRpcChannelBuffer
**chan
, IID
*iid
, IUnknown
**iface
);
215 HRESULT
start_apartment_remote_unknown(void);
217 HRESULT
marshal_object(APARTMENT
*apt
, STDOBJREF
*stdobjref
, REFIID riid
, IUnknown
*obj
, MSHLFLAGS mshlflags
);
221 struct dispatch_params
;
223 void RPC_StartRemoting(struct apartment
*apt
);
224 HRESULT
RPC_CreateClientChannel(const OXID
*oxid
, const IPID
*ipid
,
225 const OXID_INFO
*oxid_info
,
226 DWORD dest_context
, void *dest_context_data
,
227 IRpcChannelBuffer
**chan
);
228 HRESULT
RPC_CreateServerChannel(IRpcChannelBuffer
**chan
);
229 void RPC_ExecuteCall(struct dispatch_params
*params
);
230 HRESULT
RPC_RegisterInterface(REFIID riid
);
231 void RPC_UnregisterInterface(REFIID riid
);
232 HRESULT
RPC_StartLocalServer(REFCLSID clsid
, IStream
*stream
, BOOL multi_use
, void **registration
);
233 void RPC_StopLocalServer(void *registration
);
234 HRESULT
RPC_GetLocalClassObject(REFCLSID rclsid
, REFIID iid
, LPVOID
*ppv
);
235 HRESULT
RPC_RegisterChannelHook(REFGUID rguid
, IChannelHook
*hook
);
236 void RPC_UnregisterAllChannelHooks(void);
237 HRESULT
RPC_ResolveOxid(OXID oxid
, OXID_INFO
*oxid_info
);
239 /* This function initialize the Running Object Table */
240 HRESULT WINAPI
RunningObjectTableImpl_Initialize(void);
242 /* This function uninitialize the Running Object Table */
243 HRESULT WINAPI
RunningObjectTableImpl_UnInitialize(void);
246 void OLEDD_UnInitialize(void);
248 /* Apartment Functions */
250 APARTMENT
*apartment_findfromoxid(OXID oxid
, BOOL ref
);
251 APARTMENT
*apartment_findfromtid(DWORD tid
);
252 DWORD
apartment_addref(struct apartment
*apt
);
253 DWORD
apartment_release(struct apartment
*apt
);
254 HRESULT
apartment_disconnectproxies(struct apartment
*apt
);
255 void apartment_disconnectobject(struct apartment
*apt
, void *object
);
256 static inline HRESULT
apartment_getoxid(const struct apartment
*apt
, OXID
*oxid
)
261 HRESULT
apartment_createwindowifneeded(struct apartment
*apt
);
262 HWND
apartment_getwindow(const struct apartment
*apt
);
263 void apartment_joinmta(void);
266 /* DCOM messages used by the apartment window (not compatible with native) */
267 #define DM_EXECUTERPC (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
268 #define DM_HOSTOBJECT (WM_USER + 1) /* WPARAM = 0, LPARAM = (struct host_object_params *) */
271 * Per-thread values are stored in the TEB on offset 0xF80
274 /* will create if necessary */
275 static inline struct oletls
*COM_CurrentInfo(void)
277 if (!NtCurrentTeb()->ReservedForOle
)
278 NtCurrentTeb()->ReservedForOle
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, sizeof(struct oletls
));
280 return NtCurrentTeb()->ReservedForOle
;
283 static inline APARTMENT
* COM_CurrentApt(void)
285 return COM_CurrentInfo()->apt
;
288 static inline GUID
COM_CurrentCausalityId(void)
290 struct oletls
*info
= COM_CurrentInfo();
293 if (IsEqualGUID(&info
->causality_id
, &GUID_NULL
))
294 CoCreateGuid(&info
->causality_id
);
295 return info
->causality_id
;
298 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
300 /* helpers for debugging */
301 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
302 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
304 extern HINSTANCE OLE32_hInstance
; /* FIXME: make static */
306 #define CHARS_IN_GUID 39 /* including NULL */
308 #define WINE_CLSCTX_DONT_HOST 0x80000000
310 /* Exported non-interface Data Advise Holder functions */
311 HRESULT
DataAdviseHolder_OnConnect(IDataAdviseHolder
*iface
, IDataObject
*pDelegate
);
312 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder
*iface
);
314 #endif /* __WINE_OLE_COMPOBJ_H */