4 * Copyright 2001 Ove Kåven, TransGaming Technologies
5 * Copyright 2002 Marcus Meissner
6 * Copyright 2005 Mike Hearn, Rob Shearman for CodeWeavers
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 #include "wine/port.h"
30 #define NONAMELESSUNION
31 #define NONAMELESSSTRUCT
42 #include "wine/unicode.h"
44 #include "compobj_private.h"
46 #include "wine/debug.h"
48 WINE_DEFAULT_DEBUG_CHANNEL(ole);
50 static void __RPC_STUB dispatch_rpc(RPC_MESSAGE *msg);
52 /* we only use one function to dispatch calls for all methods - we use the
53 * RPC_IF_OLE flag to tell the RPC runtime that this is the case */
54 static RPC_DISPATCH_FUNCTION rpc_dispatch_table[1] = { dispatch_rpc }; /* (RO) */
55 static RPC_DISPATCH_TABLE rpc_dispatch = { 1, rpc_dispatch_table }; /* (RO) */
57 static struct list registered_interfaces = LIST_INIT(registered_interfaces); /* (CS csRegIf) */
58 static CRITICAL_SECTION csRegIf;
59 static CRITICAL_SECTION_DEBUG csRegIf_debug =
62 { &csRegIf_debug.ProcessLocksList, &csRegIf_debug.ProcessLocksList },
63 0, 0, { (DWORD_PTR)(__FILE__ ": dcom registered server interfaces") }
65 static CRITICAL_SECTION csRegIf = { &csRegIf_debug, -1, 0, 0, 0, 0 };
67 static struct list channel_hooks = LIST_INIT(channel_hooks); /* (CS csChannelHook) */
68 static CRITICAL_SECTION csChannelHook;
69 static CRITICAL_SECTION_DEBUG csChannelHook_debug =
72 { &csChannelHook_debug.ProcessLocksList, &csChannelHook_debug.ProcessLocksList },
73 0, 0, { (DWORD_PTR)(__FILE__ ": channel hooks") }
75 static CRITICAL_SECTION csChannelHook = { &csChannelHook_debug, -1, 0, 0, 0, 0 };
77 static WCHAR wszRpcTransport[] = {'n','c','a','l','r','p','c',0};
83 DWORD refs; /* ref count */
84 RPC_SERVER_INTERFACE If; /* interface registered with the RPC runtime */
87 /* get the pipe endpoint specified of the specified apartment */
88 static inline void get_rpc_endpoint(LPWSTR endpoint, const OXID *oxid)
90 /* FIXME: should get endpoint from rpcss */
91 static const WCHAR wszEndpointFormat[] = {'\\','p','i','p','e','\\','O','L','E','_','%','0','8','l','x','%','0','8','l','x',0};
92 wsprintfW(endpoint, wszEndpointFormat, (DWORD)(*oxid >> 32),(DWORD)*oxid);
97 const IRpcChannelBufferVtbl *lpVtbl;
103 RpcChannelBuffer super; /* superclass */
105 RPC_BINDING_HANDLE bind; /* handle to the remote server */
106 OXID oxid; /* apartment in which the channel is valid */
107 DWORD server_pid; /* id of server process */
108 DWORD dest_context; /* returned from GetDestCtx */
109 LPVOID dest_context_data; /* returned from GetDestCtx */
110 HANDLE event; /* cached event handle */
111 } ClientRpcChannelBuffer;
113 struct dispatch_params
115 RPCOLEMESSAGE *msg; /* message */
116 IRpcStubBuffer *stub; /* stub buffer, if applicable */
117 IRpcChannelBuffer *chan; /* server channel buffer, if applicable */
118 IID iid; /* ID of interface being called */
119 IUnknown *iface; /* interface being called */
120 HANDLE handle; /* handle that will become signaled when call finishes */
121 RPC_STATUS status; /* status (out) */
122 HRESULT hr; /* hresult (out) */
127 RPC_BINDING_HANDLE binding_handle;
128 ULONG prefix_data_len;
129 SChannelHookCallInfo channel_hook_info;
134 ULONG conformance; /* NDR */
137 /* [size_is((size+7)&~7)] */ unsigned char data[1];
140 struct channel_hook_entry
147 struct channel_hook_buffer_data
150 ULONG extension_size;
154 static HRESULT unmarshal_ORPCTHAT(RPC_MESSAGE *msg, ORPCTHAT *orpcthat,
155 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent);
157 /* Channel Hook Functions */
159 static ULONG ChannelHooks_ClientGetSize(SChannelHookCallInfo *info,
160 struct channel_hook_buffer_data **data, unsigned int *hook_count,
161 ULONG *extension_count)
163 struct channel_hook_entry *entry;
164 ULONG total_size = 0;
165 unsigned int hook_index = 0;
168 *extension_count = 0;
170 EnterCriticalSection(&csChannelHook);
172 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
176 *data = HeapAlloc(GetProcessHeap(), 0, *hook_count * sizeof(struct channel_hook_buffer_data));
180 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
182 ULONG extension_size = 0;
184 IChannelHook_ClientGetSize(entry->hook, &entry->id, &info->iid, &extension_size);
186 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
188 extension_size = (extension_size+7)&~7;
189 (*data)[hook_index].id = entry->id;
190 (*data)[hook_index].extension_size = extension_size;
192 /* an extension is only put onto the wire if it has data to write */
195 total_size += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[extension_size]);
196 (*extension_count)++;
202 LeaveCriticalSection(&csChannelHook);
207 static unsigned char * ChannelHooks_ClientFillBuffer(SChannelHookCallInfo *info,
208 unsigned char *buffer, struct channel_hook_buffer_data *data,
209 unsigned int hook_count)
211 struct channel_hook_entry *entry;
213 EnterCriticalSection(&csChannelHook);
215 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
218 ULONG extension_size = 0;
219 WIRE_ORPC_EXTENT *wire_orpc_extent = (WIRE_ORPC_EXTENT *)buffer;
221 for (i = 0; i < hook_count; i++)
222 if (IsEqualGUID(&entry->id, &data[i].id))
223 extension_size = data[i].extension_size;
225 /* an extension is only put onto the wire if it has data to write */
229 IChannelHook_ClientFillBuffer(entry->hook, &entry->id, &info->iid,
230 &extension_size, buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]));
232 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
234 /* FIXME: set unused portion of wire_orpc_extent->data to 0? */
236 wire_orpc_extent->conformance = (extension_size+7)&~7;
237 wire_orpc_extent->size = extension_size;
238 memcpy(&wire_orpc_extent->id, &entry->id, sizeof(wire_orpc_extent->id));
239 buffer += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[wire_orpc_extent->conformance]);
242 LeaveCriticalSection(&csChannelHook);
244 HeapFree(GetProcessHeap(), 0, data);
249 static void ChannelHooks_ServerNotify(SChannelHookCallInfo *info,
250 DWORD lDataRep, WIRE_ORPC_EXTENT *first_wire_orpc_extent,
251 ULONG extension_count)
253 struct channel_hook_entry *entry;
256 EnterCriticalSection(&csChannelHook);
258 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
260 WIRE_ORPC_EXTENT *wire_orpc_extent;
261 for (i = 0, wire_orpc_extent = first_wire_orpc_extent;
263 i++, wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance])
265 if (IsEqualGUID(&entry->id, &wire_orpc_extent->id))
268 if (i == extension_count) wire_orpc_extent = NULL;
270 IChannelHook_ServerNotify(entry->hook, &entry->id, &info->iid,
271 wire_orpc_extent ? wire_orpc_extent->size : 0,
272 wire_orpc_extent ? wire_orpc_extent->data : NULL,
276 LeaveCriticalSection(&csChannelHook);
279 static ULONG ChannelHooks_ServerGetSize(SChannelHookCallInfo *info,
280 struct channel_hook_buffer_data **data, unsigned int *hook_count,
281 ULONG *extension_count)
283 struct channel_hook_entry *entry;
284 ULONG total_size = 0;
285 unsigned int hook_index = 0;
288 *extension_count = 0;
290 EnterCriticalSection(&csChannelHook);
292 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
296 *data = HeapAlloc(GetProcessHeap(), 0, *hook_count * sizeof(struct channel_hook_buffer_data));
300 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
302 ULONG extension_size = 0;
304 IChannelHook_ServerGetSize(entry->hook, &entry->id, &info->iid, S_OK,
307 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
309 extension_size = (extension_size+7)&~7;
310 (*data)[hook_index].id = entry->id;
311 (*data)[hook_index].extension_size = extension_size;
313 /* an extension is only put onto the wire if it has data to write */
316 total_size += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[extension_size]);
317 (*extension_count)++;
323 LeaveCriticalSection(&csChannelHook);
328 static unsigned char * ChannelHooks_ServerFillBuffer(SChannelHookCallInfo *info,
329 unsigned char *buffer, struct channel_hook_buffer_data *data,
330 unsigned int hook_count)
332 struct channel_hook_entry *entry;
334 EnterCriticalSection(&csChannelHook);
336 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
339 ULONG extension_size = 0;
340 WIRE_ORPC_EXTENT *wire_orpc_extent = (WIRE_ORPC_EXTENT *)buffer;
342 for (i = 0; i < hook_count; i++)
343 if (IsEqualGUID(&entry->id, &data[i].id))
344 extension_size = data[i].extension_size;
346 /* an extension is only put onto the wire if it has data to write */
350 IChannelHook_ServerFillBuffer(entry->hook, &entry->id, &info->iid,
351 &extension_size, buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]),
354 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
356 /* FIXME: set unused portion of wire_orpc_extent->data to 0? */
358 wire_orpc_extent->conformance = (extension_size+7)&~7;
359 wire_orpc_extent->size = extension_size;
360 memcpy(&wire_orpc_extent->id, &entry->id, sizeof(wire_orpc_extent->id));
361 buffer += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[wire_orpc_extent->conformance]);
364 LeaveCriticalSection(&csChannelHook);
366 HeapFree(GetProcessHeap(), 0, data);
371 static void ChannelHooks_ClientNotify(SChannelHookCallInfo *info,
372 DWORD lDataRep, WIRE_ORPC_EXTENT *first_wire_orpc_extent,
373 ULONG extension_count, HRESULT hrFault)
375 struct channel_hook_entry *entry;
378 EnterCriticalSection(&csChannelHook);
380 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
382 WIRE_ORPC_EXTENT *wire_orpc_extent;
383 for (i = 0, wire_orpc_extent = first_wire_orpc_extent;
385 i++, wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance])
387 if (IsEqualGUID(&entry->id, &wire_orpc_extent->id))
390 if (i == extension_count) wire_orpc_extent = NULL;
392 IChannelHook_ClientNotify(entry->hook, &entry->id, &info->iid,
393 wire_orpc_extent ? wire_orpc_extent->size : 0,
394 wire_orpc_extent ? wire_orpc_extent->data : NULL,
398 LeaveCriticalSection(&csChannelHook);
401 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook)
403 struct channel_hook_entry *entry;
405 TRACE("(%s, %p)\n", debugstr_guid(rguid), hook);
407 entry = HeapAlloc(GetProcessHeap(), 0, sizeof(*entry));
409 return E_OUTOFMEMORY;
411 memcpy(&entry->id, rguid, sizeof(entry->id));
413 IChannelHook_AddRef(hook);
415 EnterCriticalSection(&csChannelHook);
416 list_add_tail(&channel_hooks, &entry->entry);
417 LeaveCriticalSection(&csChannelHook);
422 void RPC_UnregisterAllChannelHooks(void)
424 struct channel_hook_entry *cursor;
425 struct channel_hook_entry *cursor2;
427 EnterCriticalSection(&csChannelHook);
428 LIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, &channel_hooks, struct channel_hook_entry, entry)
429 HeapFree(GetProcessHeap(), 0, cursor);
430 LeaveCriticalSection(&csChannelHook);
433 /* RPC Channel Buffer Functions */
435 static HRESULT WINAPI RpcChannelBuffer_QueryInterface(LPRPCCHANNELBUFFER iface, REFIID riid, LPVOID *ppv)
438 if (IsEqualIID(riid,&IID_IRpcChannelBuffer) || IsEqualIID(riid,&IID_IUnknown))
440 *ppv = (LPVOID)iface;
441 IUnknown_AddRef(iface);
444 return E_NOINTERFACE;
447 static ULONG WINAPI RpcChannelBuffer_AddRef(LPRPCCHANNELBUFFER iface)
449 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
450 return InterlockedIncrement(&This->refs);
453 static ULONG WINAPI ServerRpcChannelBuffer_Release(LPRPCCHANNELBUFFER iface)
455 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
458 ref = InterlockedDecrement(&This->refs);
462 HeapFree(GetProcessHeap(), 0, This);
466 static ULONG WINAPI ClientRpcChannelBuffer_Release(LPRPCCHANNELBUFFER iface)
468 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
471 ref = InterlockedDecrement(&This->super.refs);
475 if (This->event) CloseHandle(This->event);
476 RpcBindingFree(&This->bind);
477 HeapFree(GetProcessHeap(), 0, This);
481 static HRESULT WINAPI ServerRpcChannelBuffer_GetBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg, REFIID riid)
483 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
484 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
487 struct message_state *message_state;
488 ULONG extensions_size;
489 struct channel_hook_buffer_data *channel_hook_data;
490 unsigned int channel_hook_count;
491 ULONG extension_count;
493 TRACE("(%p)->(%p,%s)\n", This, olemsg, debugstr_guid(riid));
495 message_state = (struct message_state *)msg->Handle;
496 /* restore the binding handle and the real start of data */
497 msg->Handle = message_state->binding_handle;
498 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
500 extensions_size = ChannelHooks_ServerGetSize(&message_state->channel_hook_info,
501 &channel_hook_data, &channel_hook_count, &extension_count);
503 msg->BufferLength += FIELD_OFFSET(ORPCTHAT, extensions) + 4;
506 msg->BufferLength += FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent) + 2*sizeof(DWORD) + extensions_size;
507 if (extension_count & 1)
508 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
511 status = I_RpcGetBuffer(msg);
513 orpcthat = (ORPCTHAT *)msg->Buffer;
514 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHAT, extensions);
516 orpcthat->flags = ORPCF_NULL /* FIXME? */;
518 /* NDR representation of orpcthat->extensions */
519 *(DWORD *)msg->Buffer = extensions_size ? 1 : 0;
520 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
524 ORPC_EXTENT_ARRAY *orpc_extent_array = msg->Buffer;
525 orpc_extent_array->size = extension_count;
526 orpc_extent_array->reserved = 0;
527 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent);
528 /* NDR representation of orpc_extent_array->extent */
529 *(DWORD *)msg->Buffer = 1;
530 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
531 /* NDR representation of [size_is] attribute of orpc_extent_array->extent */
532 *(DWORD *)msg->Buffer = (extension_count + 1) & ~1;
533 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
535 msg->Buffer = ChannelHooks_ServerFillBuffer(&message_state->channel_hook_info,
536 msg->Buffer, channel_hook_data, channel_hook_count);
538 /* we must add a dummy extension if there is an odd extension
539 * count to meet the contract specified by the size_is attribute */
540 if (extension_count & 1)
542 WIRE_ORPC_EXTENT *wire_orpc_extent = msg->Buffer;
543 wire_orpc_extent->conformance = 0;
544 memcpy(&wire_orpc_extent->id, &GUID_NULL, sizeof(wire_orpc_extent->id));
545 wire_orpc_extent->size = 0;
546 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
550 /* store the prefixed data length so that we can restore the real buffer
552 message_state->prefix_data_len = (char *)msg->Buffer - (char *)orpcthat;
553 msg->BufferLength -= message_state->prefix_data_len;
554 /* save away the message state again */
555 msg->Handle = message_state;
557 TRACE("-- %ld\n", status);
559 return HRESULT_FROM_WIN32(status);
562 static HRESULT WINAPI ClientRpcChannelBuffer_GetBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg, REFIID riid)
564 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
565 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
566 RPC_CLIENT_INTERFACE *cif;
569 struct message_state *message_state;
570 ULONG extensions_size;
571 struct channel_hook_buffer_data *channel_hook_data;
572 unsigned int channel_hook_count;
573 ULONG extension_count;
575 TRACE("(%p)->(%p,%s)\n", This, olemsg, debugstr_guid(riid));
577 cif = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RPC_CLIENT_INTERFACE));
579 return E_OUTOFMEMORY;
581 message_state = HeapAlloc(GetProcessHeap(), 0, sizeof(*message_state));
584 HeapFree(GetProcessHeap(), 0, cif);
585 return E_OUTOFMEMORY;
588 cif->Length = sizeof(RPC_CLIENT_INTERFACE);
589 /* RPC interface ID = COM interface ID */
590 cif->InterfaceId.SyntaxGUID = *riid;
591 /* COM objects always have a version of 0.0 */
592 cif->InterfaceId.SyntaxVersion.MajorVersion = 0;
593 cif->InterfaceId.SyntaxVersion.MinorVersion = 0;
594 msg->Handle = This->bind;
595 msg->RpcInterfaceInformation = cif;
597 message_state->channel_hook_info.iid = *riid;
598 message_state->channel_hook_info.cbSize = sizeof(message_state->channel_hook_info);
599 message_state->channel_hook_info.uCausality = COM_CurrentCausalityId();
600 message_state->channel_hook_info.dwServerPid = This->server_pid;
601 message_state->channel_hook_info.iMethod = msg->ProcNum;
602 message_state->channel_hook_info.pObject = NULL; /* only present on server-side */
604 extensions_size = ChannelHooks_ClientGetSize(&message_state->channel_hook_info,
605 &channel_hook_data, &channel_hook_count, &extension_count);
607 msg->BufferLength += FIELD_OFFSET(ORPCTHIS, extensions) + 4;
610 msg->BufferLength += FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent) + 2*sizeof(DWORD) + extensions_size;
611 if (extension_count & 1)
612 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
615 status = I_RpcGetBuffer(msg);
617 message_state->prefix_data_len = 0;
618 message_state->binding_handle = This->bind;
619 msg->Handle = message_state;
621 if (status == RPC_S_OK)
623 orpcthis = (ORPCTHIS *)msg->Buffer;
624 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHIS, extensions);
626 orpcthis->version.MajorVersion = COM_MAJOR_VERSION;
627 orpcthis->version.MinorVersion = COM_MINOR_VERSION;
628 orpcthis->flags = message_state->channel_hook_info.dwServerPid ? ORPCF_LOCAL : ORPCF_NULL;
629 orpcthis->reserved1 = 0;
630 orpcthis->cid = message_state->channel_hook_info.uCausality;
632 /* NDR representation of orpcthis->extensions */
633 *(DWORD *)msg->Buffer = extensions_size ? 1 : 0;
634 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
638 ORPC_EXTENT_ARRAY *orpc_extent_array = msg->Buffer;
639 orpc_extent_array->size = extension_count;
640 orpc_extent_array->reserved = 0;
641 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent);
642 /* NDR representation of orpc_extent_array->extent */
643 *(DWORD *)msg->Buffer = 1;
644 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
645 /* NDR representation of [size_is] attribute of orpc_extent_array->extent */
646 *(DWORD *)msg->Buffer = (extension_count + 1) & ~1;
647 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
649 msg->Buffer = ChannelHooks_ClientFillBuffer(&message_state->channel_hook_info,
650 msg->Buffer, channel_hook_data, channel_hook_count);
652 /* we must add a dummy extension if there is an odd extension
653 * count to meet the contract specified by the size_is attribute */
654 if (extension_count & 1)
656 WIRE_ORPC_EXTENT *wire_orpc_extent = msg->Buffer;
657 wire_orpc_extent->conformance = 0;
658 memcpy(&wire_orpc_extent->id, &GUID_NULL, sizeof(wire_orpc_extent->id));
659 wire_orpc_extent->size = 0;
660 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
664 /* store the prefixed data length so that we can restore the real buffer
665 * pointer in ClientRpcChannelBuffer_SendReceive. */
666 message_state->prefix_data_len = (char *)msg->Buffer - (char *)orpcthis;
667 msg->BufferLength -= message_state->prefix_data_len;
670 TRACE("-- %ld\n", status);
672 return HRESULT_FROM_WIN32(status);
675 static HRESULT WINAPI ServerRpcChannelBuffer_SendReceive(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE *olemsg, ULONG *pstatus)
681 static HANDLE ClientRpcChannelBuffer_GetEventHandle(ClientRpcChannelBuffer *This)
683 HANDLE event = InterlockedExchangePointer(&This->event, NULL);
685 /* Note: must be auto-reset event so we can reuse it without a call
687 if (!event) event = CreateEventW(NULL, FALSE, FALSE, NULL);
692 static void ClientRpcChannelBuffer_ReleaseEventHandle(ClientRpcChannelBuffer *This, HANDLE event)
694 if (InterlockedCompareExchangePointer(&This->event, event, NULL))
695 /* already a handle cached in This */
699 /* this thread runs an outgoing RPC */
700 static DWORD WINAPI rpc_sendreceive_thread(LPVOID param)
702 struct dispatch_params *data = (struct dispatch_params *) param;
704 /* Note: I_RpcSendReceive doesn't raise exceptions like the higher-level
705 * RPC functions do */
706 data->status = I_RpcSendReceive((RPC_MESSAGE *)data->msg);
708 TRACE("completed with status 0x%lx\n", data->status);
710 SetEvent(data->handle);
715 static inline HRESULT ClientRpcChannelBuffer_IsCorrectApartment(ClientRpcChannelBuffer *This, APARTMENT *apt)
720 if (apartment_getoxid(apt, &oxid) != S_OK)
722 if (This->oxid != oxid)
727 static HRESULT WINAPI ClientRpcChannelBuffer_SendReceive(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE *olemsg, ULONG *pstatus)
729 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
731 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
734 struct dispatch_params *params;
735 APARTMENT *apt = NULL;
737 struct message_state *message_state;
739 ORPC_EXTENT_ARRAY orpc_ext_array;
740 WIRE_ORPC_EXTENT *first_wire_orpc_extent = NULL;
741 HRESULT hrFault = S_OK;
743 TRACE("(%p) iMethod=%d\n", olemsg, olemsg->iMethod);
745 hr = ClientRpcChannelBuffer_IsCorrectApartment(This, COM_CurrentApt());
748 ERR("called from wrong apartment, should have been 0x%s\n",
749 wine_dbgstr_longlong(This->oxid));
750 return RPC_E_WRONG_THREAD;
752 /* this situation should be impossible in multi-threaded apartments,
753 * because the calling thread isn't re-entrable.
754 * Note: doing a COM call during the processing of a sent message is
755 * only disallowed if a client call is already being waited for
757 if (!COM_CurrentApt()->multi_threaded &&
758 COM_CurrentInfo()->pending_call_count_client &&
761 ERR("can't make an outgoing COM call in response to a sent message\n");
762 return RPC_E_CANTCALLOUT_ININPUTSYNCCALL;
765 params = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*params));
766 if (!params) return E_OUTOFMEMORY;
768 message_state = (struct message_state *)msg->Handle;
769 /* restore the binding handle and the real start of data */
770 msg->Handle = message_state->binding_handle;
771 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
772 msg->BufferLength += message_state->prefix_data_len;
774 params->msg = olemsg;
775 params->status = RPC_S_OK;
778 /* Note: this is an optimization in the Microsoft OLE runtime that we need
779 * to copy, as shown by the test_no_couninitialize_client test. without
780 * short-circuiting the RPC runtime in the case below, the test will
781 * deadlock on the loader lock due to the RPC runtime needing to create
782 * a thread to process the RPC when this function is called indirectly
785 RpcBindingInqObject(message_state->binding_handle, &ipid);
786 hr = ipid_get_dispatch_params(&ipid, &apt, ¶ms->stub, ¶ms->chan,
787 ¶ms->iid, ¶ms->iface);
788 params->handle = ClientRpcChannelBuffer_GetEventHandle(This);
789 if ((hr == S_OK) && !apt->multi_threaded)
791 TRACE("Calling apartment thread 0x%08x...\n", apt->tid);
793 if (!PostMessageW(apartment_getwindow(apt), DM_EXECUTERPC, 0, (LPARAM)params))
795 ERR("PostMessage failed with error %u\n", GetLastError());
796 hr = HRESULT_FROM_WIN32(GetLastError());
803 /* otherwise, we go via RPC runtime so the stub and channel aren't
805 IRpcStubBuffer_Release(params->stub);
807 IRpcChannelBuffer_Release(params->chan);
811 /* we use a separate thread here because we need to be able to
812 * pump the message loop in the application thread: if we do not,
813 * any windows created by this thread will hang and RPCs that try
814 * and re-enter this STA from an incoming server thread will
815 * deadlock. InstallShield is an example of that.
817 if (!QueueUserWorkItem(rpc_sendreceive_thread, params, WT_EXECUTEDEFAULT))
819 ERR("QueueUserWorkItem failed with error %u\n", GetLastError());
825 if (apt) apartment_release(apt);
829 if (WaitForSingleObject(params->handle, 0))
831 COM_CurrentInfo()->pending_call_count_client++;
832 hr = CoWaitForMultipleHandles(0, INFINITE, 1, ¶ms->handle, &index);
833 COM_CurrentInfo()->pending_call_count_client--;
836 ClientRpcChannelBuffer_ReleaseEventHandle(This, params->handle);
838 /* for WM shortcut, faults are returned in params->hr */
840 hrFault = params->hr;
842 status = params->status;
843 HeapFree(GetProcessHeap(), 0, params);
846 orpcthat.flags = ORPCF_NULL;
847 orpcthat.extensions = NULL;
849 /* for normal RPC calls, faults are returned in first 4 bytes of the
851 TRACE("RPC call status: 0x%lx\n", status);
852 if (status == RPC_S_CALL_FAILED)
853 hrFault = *(HRESULT *)olemsg->Buffer;
854 else if (status != RPC_S_OK)
855 hr = HRESULT_FROM_WIN32(status);
857 TRACE("hrFault = 0x%08x\n", hrFault);
859 /* FIXME: this condition should be
860 * "hr == S_OK && (!hrFault || msg->BufferLength > FIELD_OFFSET(ORPCTHAT, extensions) + 4)"
861 * but we don't currently reset the message length for PostMessage
862 * dispatched calls */
863 if (hr == S_OK && hrFault == S_OK)
866 char *original_buffer = msg->Buffer;
868 /* handle ORPCTHAT and client extensions */
870 hr2 = unmarshal_ORPCTHAT(msg, &orpcthat, &orpc_ext_array, &first_wire_orpc_extent);
874 message_state->prefix_data_len = (char *)msg->Buffer - original_buffer;
875 msg->BufferLength -= message_state->prefix_data_len;
878 message_state->prefix_data_len = 0;
882 ChannelHooks_ClientNotify(&message_state->channel_hook_info,
883 msg->DataRepresentation,
884 first_wire_orpc_extent,
885 orpcthat.extensions && first_wire_orpc_extent ? orpcthat.extensions->size : 0,
889 /* save away the message state again */
890 msg->Handle = message_state;
892 if (pstatus) *pstatus = status;
897 TRACE("-- 0x%08x\n", hr);
902 static HRESULT WINAPI ServerRpcChannelBuffer_FreeBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg)
904 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
906 struct message_state *message_state;
908 TRACE("(%p)\n", msg);
910 message_state = (struct message_state *)msg->Handle;
911 /* restore the binding handle and the real start of data */
912 msg->Handle = message_state->binding_handle;
913 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
914 msg->BufferLength += message_state->prefix_data_len;
915 message_state->prefix_data_len = 0;
917 status = I_RpcFreeBuffer(msg);
919 msg->Handle = message_state;
921 TRACE("-- %ld\n", status);
923 return HRESULT_FROM_WIN32(status);
926 static HRESULT WINAPI ClientRpcChannelBuffer_FreeBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg)
928 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
930 struct message_state *message_state;
932 TRACE("(%p)\n", msg);
934 message_state = (struct message_state *)msg->Handle;
935 /* restore the binding handle and the real start of data */
936 msg->Handle = message_state->binding_handle;
937 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
938 msg->BufferLength += message_state->prefix_data_len;
940 status = I_RpcFreeBuffer(msg);
942 HeapFree(GetProcessHeap(), 0, msg->RpcInterfaceInformation);
943 msg->RpcInterfaceInformation = NULL;
944 HeapFree(GetProcessHeap(), 0, message_state);
946 TRACE("-- %ld\n", status);
948 return HRESULT_FROM_WIN32(status);
951 static HRESULT WINAPI ClientRpcChannelBuffer_GetDestCtx(LPRPCCHANNELBUFFER iface, DWORD* pdwDestContext, void** ppvDestContext)
953 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
955 TRACE("(%p,%p)\n", pdwDestContext, ppvDestContext);
957 *pdwDestContext = This->dest_context;
958 *ppvDestContext = This->dest_context_data;
963 static HRESULT WINAPI ServerRpcChannelBuffer_GetDestCtx(LPRPCCHANNELBUFFER iface, DWORD* pdwDestContext, void** ppvDestContext)
965 FIXME("(%p,%p), stub!\n", pdwDestContext, ppvDestContext);
969 static HRESULT WINAPI RpcChannelBuffer_IsConnected(LPRPCCHANNELBUFFER iface)
972 /* native does nothing too */
976 static const IRpcChannelBufferVtbl ClientRpcChannelBufferVtbl =
978 RpcChannelBuffer_QueryInterface,
979 RpcChannelBuffer_AddRef,
980 ClientRpcChannelBuffer_Release,
981 ClientRpcChannelBuffer_GetBuffer,
982 ClientRpcChannelBuffer_SendReceive,
983 ClientRpcChannelBuffer_FreeBuffer,
984 ClientRpcChannelBuffer_GetDestCtx,
985 RpcChannelBuffer_IsConnected
988 static const IRpcChannelBufferVtbl ServerRpcChannelBufferVtbl =
990 RpcChannelBuffer_QueryInterface,
991 RpcChannelBuffer_AddRef,
992 ServerRpcChannelBuffer_Release,
993 ServerRpcChannelBuffer_GetBuffer,
994 ServerRpcChannelBuffer_SendReceive,
995 ServerRpcChannelBuffer_FreeBuffer,
996 ServerRpcChannelBuffer_GetDestCtx,
997 RpcChannelBuffer_IsConnected
1000 /* returns a channel buffer for proxies */
1001 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
1002 const OXID_INFO *oxid_info,
1003 DWORD dest_context, void *dest_context_data,
1004 IRpcChannelBuffer **chan)
1006 ClientRpcChannelBuffer *This;
1007 WCHAR endpoint[200];
1008 RPC_BINDING_HANDLE bind;
1010 LPWSTR string_binding;
1012 /* FIXME: get the endpoint from oxid_info->psa instead */
1013 get_rpc_endpoint(endpoint, oxid);
1015 TRACE("proxy pipe: connecting to endpoint: %s\n", debugstr_w(endpoint));
1017 status = RpcStringBindingComposeW(
1025 if (status == RPC_S_OK)
1027 status = RpcBindingFromStringBindingW(string_binding, &bind);
1029 if (status == RPC_S_OK)
1031 IPID ipid2 = *ipid; /* why can't RpcBindingSetObject take a const? */
1032 status = RpcBindingSetObject(bind, &ipid2);
1033 if (status != RPC_S_OK)
1034 RpcBindingFree(&bind);
1037 RpcStringFreeW(&string_binding);
1040 if (status != RPC_S_OK)
1042 ERR("Couldn't get binding for endpoint %s, status = %ld\n", debugstr_w(endpoint), status);
1043 return HRESULT_FROM_WIN32(status);
1046 This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
1049 RpcBindingFree(&bind);
1050 return E_OUTOFMEMORY;
1053 This->super.lpVtbl = &ClientRpcChannelBufferVtbl;
1054 This->super.refs = 1;
1056 apartment_getoxid(COM_CurrentApt(), &This->oxid);
1057 This->server_pid = oxid_info->dwPid;
1058 This->dest_context = dest_context;
1059 This->dest_context_data = dest_context_data;
1062 *chan = (IRpcChannelBuffer*)This;
1067 HRESULT RPC_CreateServerChannel(IRpcChannelBuffer **chan)
1069 RpcChannelBuffer *This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
1071 return E_OUTOFMEMORY;
1073 This->lpVtbl = &ServerRpcChannelBufferVtbl;
1076 *chan = (IRpcChannelBuffer*)This;
1081 /* unmarshals ORPC_EXTENT_ARRAY according to NDR rules, but doesn't allocate
1083 static HRESULT unmarshal_ORPC_EXTENT_ARRAY(RPC_MESSAGE *msg, const char *end,
1084 ORPC_EXTENT_ARRAY *extensions,
1085 WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1090 memcpy(extensions, msg->Buffer, FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent));
1091 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent);
1093 if ((const char *)msg->Buffer + 2 * sizeof(DWORD) > end)
1094 return RPC_E_INVALID_HEADER;
1096 pointer_id = *(DWORD *)msg->Buffer;
1097 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1098 extensions->extent = NULL;
1102 WIRE_ORPC_EXTENT *wire_orpc_extent;
1105 if (*(DWORD *)msg->Buffer != ((extensions->size+1)&~1))
1106 return RPC_S_INVALID_BOUND;
1108 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1110 /* arbritary limit for security (don't know what native does) */
1111 if (extensions->size > 256)
1113 ERR("too many extensions: %ld\n", extensions->size);
1114 return RPC_S_INVALID_BOUND;
1117 *first_wire_orpc_extent = wire_orpc_extent = (WIRE_ORPC_EXTENT *)msg->Buffer;
1118 for (i = 0; i < ((extensions->size+1)&~1); i++)
1120 if ((const char *)&wire_orpc_extent->data[0] > end)
1121 return RPC_S_INVALID_BOUND;
1122 if (wire_orpc_extent->conformance != ((wire_orpc_extent->size+7)&~7))
1123 return RPC_S_INVALID_BOUND;
1124 if ((const char *)&wire_orpc_extent->data[wire_orpc_extent->conformance] > end)
1125 return RPC_S_INVALID_BOUND;
1126 TRACE("size %u, guid %s\n", wire_orpc_extent->size, debugstr_guid(&wire_orpc_extent->id));
1127 wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance];
1129 msg->Buffer = wire_orpc_extent;
1135 /* unmarshals ORPCTHIS according to NDR rules, but doesn't allocate any memory */
1136 static HRESULT unmarshal_ORPCTHIS(RPC_MESSAGE *msg, ORPCTHIS *orpcthis,
1137 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1139 const char *end = (char *)msg->Buffer + msg->BufferLength;
1141 *first_wire_orpc_extent = NULL;
1143 if (msg->BufferLength < FIELD_OFFSET(ORPCTHIS, extensions) + 4)
1145 ERR("invalid buffer length\n");
1146 return RPC_E_INVALID_HEADER;
1149 memcpy(orpcthis, msg->Buffer, FIELD_OFFSET(ORPCTHIS, extensions));
1150 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHIS, extensions);
1152 if ((const char *)msg->Buffer + sizeof(DWORD) > end)
1153 return RPC_E_INVALID_HEADER;
1155 if (*(DWORD *)msg->Buffer)
1156 orpcthis->extensions = orpc_ext_array;
1158 orpcthis->extensions = NULL;
1160 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1162 if (orpcthis->extensions)
1164 HRESULT hr = unmarshal_ORPC_EXTENT_ARRAY(msg, end, orpc_ext_array,
1165 first_wire_orpc_extent);
1170 if ((orpcthis->version.MajorVersion != COM_MAJOR_VERSION) ||
1171 (orpcthis->version.MinorVersion > COM_MINOR_VERSION))
1173 ERR("COM version {%d, %d} not supported\n",
1174 orpcthis->version.MajorVersion, orpcthis->version.MinorVersion);
1175 return RPC_E_VERSION_MISMATCH;
1178 if (orpcthis->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4))
1180 ERR("invalid flags 0x%lx\n", orpcthis->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4));
1181 return RPC_E_INVALID_HEADER;
1187 static HRESULT unmarshal_ORPCTHAT(RPC_MESSAGE *msg, ORPCTHAT *orpcthat,
1188 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1190 const char *end = (char *)msg->Buffer + msg->BufferLength;
1192 *first_wire_orpc_extent = NULL;
1194 if (msg->BufferLength < FIELD_OFFSET(ORPCTHAT, extensions) + 4)
1196 ERR("invalid buffer length\n");
1197 return RPC_E_INVALID_HEADER;
1200 memcpy(orpcthat, msg->Buffer, FIELD_OFFSET(ORPCTHAT, extensions));
1201 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHAT, extensions);
1203 if ((const char *)msg->Buffer + sizeof(DWORD) > end)
1204 return RPC_E_INVALID_HEADER;
1206 if (*(DWORD *)msg->Buffer)
1207 orpcthat->extensions = orpc_ext_array;
1209 orpcthat->extensions = NULL;
1211 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1213 if (orpcthat->extensions)
1215 HRESULT hr = unmarshal_ORPC_EXTENT_ARRAY(msg, end, orpc_ext_array,
1216 first_wire_orpc_extent);
1221 if (orpcthat->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4))
1223 ERR("invalid flags 0x%lx\n", orpcthat->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4));
1224 return RPC_E_INVALID_HEADER;
1230 void RPC_ExecuteCall(struct dispatch_params *params)
1232 struct message_state *message_state = NULL;
1233 RPC_MESSAGE *msg = (RPC_MESSAGE *)params->msg;
1234 char *original_buffer = msg->Buffer;
1236 ORPC_EXTENT_ARRAY orpc_ext_array;
1237 WIRE_ORPC_EXTENT *first_wire_orpc_extent;
1238 GUID old_causality_id;
1240 /* handle ORPCTHIS and server extensions */
1242 params->hr = unmarshal_ORPCTHIS(msg, &orpcthis, &orpc_ext_array, &first_wire_orpc_extent);
1243 if (params->hr != S_OK)
1245 msg->Buffer = original_buffer;
1249 message_state = HeapAlloc(GetProcessHeap(), 0, sizeof(*message_state));
1252 params->hr = E_OUTOFMEMORY;
1253 msg->Buffer = original_buffer;
1257 message_state->prefix_data_len = (char *)msg->Buffer - original_buffer;
1258 message_state->binding_handle = msg->Handle;
1260 message_state->channel_hook_info.iid = params->iid;
1261 message_state->channel_hook_info.cbSize = sizeof(message_state->channel_hook_info);
1262 message_state->channel_hook_info.uCausality = orpcthis.cid;
1263 message_state->channel_hook_info.dwServerPid = GetCurrentProcessId();
1264 message_state->channel_hook_info.iMethod = msg->ProcNum;
1265 message_state->channel_hook_info.pObject = params->iface;
1267 if (orpcthis.extensions && first_wire_orpc_extent &&
1268 orpcthis.extensions->size)
1269 ChannelHooks_ServerNotify(&message_state->channel_hook_info, msg->DataRepresentation, first_wire_orpc_extent, orpcthis.extensions->size);
1271 msg->Handle = message_state;
1272 msg->BufferLength -= message_state->prefix_data_len;
1274 /* call message filter */
1276 if (COM_CurrentApt()->filter)
1279 INTERFACEINFO interface_info;
1282 interface_info.pUnk = params->iface;
1283 interface_info.iid = params->iid;
1284 interface_info.wMethod = msg->ProcNum;
1286 if (IsEqualGUID(&orpcthis.cid, &COM_CurrentInfo()->causality_id))
1287 calltype = CALLTYPE_NESTED;
1288 else if (COM_CurrentInfo()->pending_call_count_server == 0)
1289 calltype = CALLTYPE_TOPLEVEL;
1291 calltype = CALLTYPE_TOPLEVEL_CALLPENDING;
1293 handlecall = IMessageFilter_HandleInComingCall(COM_CurrentApt()->filter,
1295 (HTASK)GetCurrentProcessId(),
1298 TRACE("IMessageFilter_HandleInComingCall returned %d\n", handlecall);
1301 case SERVERCALL_REJECTED:
1302 params->hr = RPC_E_CALL_REJECTED;
1303 goto exit_reset_state;
1304 case SERVERCALL_RETRYLATER:
1305 #if 0 /* FIXME: handle retries on the client side before enabling this code */
1306 params->hr = RPC_E_RETRY;
1307 goto exit_reset_state;
1309 FIXME("retry call later not implemented\n");
1312 case SERVERCALL_ISHANDLED:
1318 /* invoke the method */
1320 /* save the old causality ID - note: any calls executed while processing
1321 * messages received during the SendReceive will appear to originate from
1322 * this call - this should be checked with what Windows does */
1323 old_causality_id = COM_CurrentInfo()->causality_id;
1324 COM_CurrentInfo()->causality_id = orpcthis.cid;
1325 COM_CurrentInfo()->pending_call_count_server++;
1326 params->hr = IRpcStubBuffer_Invoke(params->stub, params->msg, params->chan);
1327 COM_CurrentInfo()->pending_call_count_server--;
1328 COM_CurrentInfo()->causality_id = old_causality_id;
1331 message_state = (struct message_state *)msg->Handle;
1332 msg->Handle = message_state->binding_handle;
1333 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
1334 msg->BufferLength += message_state->prefix_data_len;
1337 HeapFree(GetProcessHeap(), 0, message_state);
1338 IRpcStubBuffer_Release(params->stub);
1339 IRpcChannelBuffer_Release(params->chan);
1340 if (params->handle) SetEvent(params->handle);
1343 static void __RPC_STUB dispatch_rpc(RPC_MESSAGE *msg)
1345 struct dispatch_params *params;
1350 RpcBindingInqObject(msg->Handle, &ipid);
1352 TRACE("ipid = %s, iMethod = %d\n", debugstr_guid(&ipid), msg->ProcNum);
1354 params = HeapAlloc(GetProcessHeap(), 0, sizeof(*params));
1355 if (!params) return RpcRaiseException(E_OUTOFMEMORY);
1357 hr = ipid_get_dispatch_params(&ipid, &apt, ¶ms->stub, ¶ms->chan,
1358 ¶ms->iid, ¶ms->iface);
1361 ERR("no apartment found for ipid %s\n", debugstr_guid(&ipid));
1362 HeapFree(GetProcessHeap(), 0, params);
1363 return RpcRaiseException(hr);
1366 params->msg = (RPCOLEMESSAGE *)msg;
1367 params->status = RPC_S_OK;
1369 params->handle = NULL;
1371 /* Note: this is the important difference between STAs and MTAs - we
1372 * always execute RPCs to STAs in the thread that originally created the
1373 * apartment (i.e. the one that pumps messages to the window) */
1374 if (!apt->multi_threaded)
1376 params->handle = CreateEventW(NULL, FALSE, FALSE, NULL);
1378 TRACE("Calling apartment thread 0x%08x...\n", apt->tid);
1380 if (PostMessageW(apartment_getwindow(apt), DM_EXECUTERPC, 0, (LPARAM)params))
1381 WaitForSingleObject(params->handle, INFINITE);
1384 ERR("PostMessage failed with error %u\n", GetLastError());
1385 IRpcChannelBuffer_Release(params->chan);
1386 IRpcStubBuffer_Release(params->stub);
1388 CloseHandle(params->handle);
1392 BOOL joined = FALSE;
1393 if (!COM_CurrentInfo()->apt)
1395 apartment_joinmta();
1398 RPC_ExecuteCall(params);
1401 apartment_release(COM_CurrentInfo()->apt);
1402 COM_CurrentInfo()->apt = NULL;
1407 HeapFree(GetProcessHeap(), 0, params);
1409 apartment_release(apt);
1411 /* if IRpcStubBuffer_Invoke fails, we should raise an exception to tell
1412 * the RPC runtime that the call failed */
1413 if (hr) RpcRaiseException(hr);
1416 /* stub registration */
1417 HRESULT RPC_RegisterInterface(REFIID riid)
1419 struct registered_if *rif;
1423 TRACE("(%s)\n", debugstr_guid(riid));
1425 EnterCriticalSection(&csRegIf);
1426 LIST_FOR_EACH_ENTRY(rif, ®istered_interfaces, struct registered_if, entry)
1428 if (IsEqualGUID(&rif->If.InterfaceId.SyntaxGUID, riid))
1437 TRACE("Creating new interface\n");
1439 rif = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*rif));
1445 rif->If.Length = sizeof(RPC_SERVER_INTERFACE);
1446 /* RPC interface ID = COM interface ID */
1447 rif->If.InterfaceId.SyntaxGUID = *riid;
1448 rif->If.DispatchTable = &rpc_dispatch;
1449 /* all other fields are 0, including the version asCOM objects
1450 * always have a version of 0.0 */
1451 status = RpcServerRegisterIfEx(
1452 (RPC_IF_HANDLE)&rif->If,
1454 RPC_IF_OLE | RPC_IF_AUTOLISTEN,
1455 RPC_C_LISTEN_MAX_CALLS_DEFAULT,
1457 if (status == RPC_S_OK)
1458 list_add_tail(®istered_interfaces, &rif->entry);
1461 ERR("RpcServerRegisterIfEx failed with error %ld\n", status);
1462 HeapFree(GetProcessHeap(), 0, rif);
1463 hr = HRESULT_FROM_WIN32(status);
1469 LeaveCriticalSection(&csRegIf);
1473 /* stub unregistration */
1474 void RPC_UnregisterInterface(REFIID riid)
1476 struct registered_if *rif;
1477 EnterCriticalSection(&csRegIf);
1478 LIST_FOR_EACH_ENTRY(rif, ®istered_interfaces, struct registered_if, entry)
1480 if (IsEqualGUID(&rif->If.InterfaceId.SyntaxGUID, riid))
1484 RpcServerUnregisterIf((RPC_IF_HANDLE)&rif->If, NULL, TRUE);
1485 list_remove(&rif->entry);
1486 HeapFree(GetProcessHeap(), 0, rif);
1491 LeaveCriticalSection(&csRegIf);
1494 /* get the info for an OXID, including the IPID for the rem unknown interface
1495 * and the string binding */
1496 HRESULT RPC_ResolveOxid(OXID oxid, OXID_INFO *oxid_info)
1498 TRACE("%s\n", wine_dbgstr_longlong(oxid));
1500 oxid_info->dwTid = 0;
1501 oxid_info->dwPid = 0;
1502 oxid_info->dwAuthnHint = RPC_C_AUTHN_LEVEL_NONE;
1503 /* FIXME: this is a hack around not having an OXID resolver yet -
1504 * this function should contact the machine's OXID resolver and then it
1505 * should give us the IPID of the IRemUnknown interface */
1506 oxid_info->ipidRemUnknown.Data1 = 0xffffffff;
1507 oxid_info->ipidRemUnknown.Data2 = 0xffff;
1508 oxid_info->ipidRemUnknown.Data3 = 0xffff;
1509 memcpy(&oxid_info->ipidRemUnknown.Data4, &oxid, sizeof(OXID));
1510 oxid_info->psa = NULL /* FIXME */;
1515 /* make the apartment reachable by other threads and processes and create the
1516 * IRemUnknown object */
1517 void RPC_StartRemoting(struct apartment *apt)
1519 if (!InterlockedExchange(&apt->remoting_started, TRUE))
1521 WCHAR endpoint[200];
1524 get_rpc_endpoint(endpoint, &apt->oxid);
1526 status = RpcServerUseProtseqEpW(
1528 RPC_C_PROTSEQ_MAX_REQS_DEFAULT,
1531 if (status != RPC_S_OK)
1532 ERR("Couldn't register endpoint %s\n", debugstr_w(endpoint));
1534 /* FIXME: move remote unknown exporting into this function */
1536 start_apartment_remote_unknown();
1540 static HRESULT create_server(REFCLSID rclsid)
1542 static const WCHAR wszLocalServer32[] = { 'L','o','c','a','l','S','e','r','v','e','r','3','2',0 };
1543 static const WCHAR embedding[] = { ' ', '-','E','m','b','e','d','d','i','n','g',0 };
1546 WCHAR command[MAX_PATH+sizeof(embedding)/sizeof(WCHAR)];
1547 DWORD size = (MAX_PATH+1) * sizeof(WCHAR);
1549 PROCESS_INFORMATION pinfo;
1551 hres = COM_OpenKeyForCLSID(rclsid, wszLocalServer32, KEY_READ, &key);
1553 ERR("class %s not registered\n", debugstr_guid(rclsid));
1557 hres = RegQueryValueExW(key, NULL, NULL, NULL, (LPBYTE)command, &size);
1560 WARN("No default value for LocalServer32 key\n");
1561 return REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1564 memset(&sinfo,0,sizeof(sinfo));
1565 sinfo.cb = sizeof(sinfo);
1567 /* EXE servers are started with the -Embedding switch. */
1569 strcatW(command, embedding);
1571 TRACE("activating local server %s for %s\n", debugstr_w(command), debugstr_guid(rclsid));
1573 /* FIXME: Win2003 supports a ServerExecutable value that is passed into
1575 if (!CreateProcessW(NULL, command, NULL, NULL, FALSE, 0, NULL, NULL, &sinfo, &pinfo)) {
1576 WARN("failed to run local server %s\n", debugstr_w(command));
1577 return HRESULT_FROM_WIN32(GetLastError());
1579 CloseHandle(pinfo.hProcess);
1580 CloseHandle(pinfo.hThread);
1586 * start_local_service() - start a service given its name and parameters
1588 static DWORD start_local_service(LPCWSTR name, DWORD num, LPCWSTR *params)
1590 SC_HANDLE handle, hsvc;
1591 DWORD r = ERROR_FUNCTION_FAILED;
1593 TRACE("Starting service %s %d params\n", debugstr_w(name), num);
1595 handle = OpenSCManagerW(NULL, NULL, SC_MANAGER_CONNECT);
1598 hsvc = OpenServiceW(handle, name, SERVICE_START);
1601 if(StartServiceW(hsvc, num, params))
1605 if (r == ERROR_SERVICE_ALREADY_RUNNING)
1607 CloseServiceHandle(hsvc);
1611 CloseServiceHandle(handle);
1613 TRACE("StartService returned error %u (%s)\n", r, (r == ERROR_SUCCESS) ? "ok":"failed");
1619 * create_local_service() - start a COM server in a service
1621 * To start a Local Service, we read the AppID value under
1622 * the class's CLSID key, then open the HKCR\\AppId key specified
1623 * there and check for a LocalService value.
1625 * Note: Local Services are not supported under Windows 9x
1627 static HRESULT create_local_service(REFCLSID rclsid)
1630 WCHAR buf[CHARS_IN_GUID];
1631 static const WCHAR szLocalService[] = { 'L','o','c','a','l','S','e','r','v','i','c','e',0 };
1632 static const WCHAR szServiceParams[] = {'S','e','r','v','i','c','e','P','a','r','a','m','s',0};
1637 TRACE("Attempting to start Local service for %s\n", debugstr_guid(rclsid));
1639 hres = COM_OpenKeyForAppIdFromCLSID(rclsid, KEY_READ, &hkey);
1643 /* read the LocalService and ServiceParameters values from the AppID key */
1645 r = RegQueryValueExW(hkey, szLocalService, NULL, &type, (LPBYTE)buf, &sz);
1646 if (r==ERROR_SUCCESS && type==REG_SZ)
1649 LPWSTR args[1] = { NULL };
1652 * FIXME: I'm not really sure how to deal with the service parameters.
1653 * I suspect that the string returned from RegQueryValueExW
1654 * should be split into a number of arguments by spaces.
1655 * It would make more sense if ServiceParams contained a
1656 * REG_MULTI_SZ here, but it's a REG_SZ for the services
1657 * that I'm interested in for the moment.
1659 r = RegQueryValueExW(hkey, szServiceParams, NULL, &type, NULL, &sz);
1660 if (r == ERROR_SUCCESS && type == REG_SZ && sz)
1662 args[0] = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sz);
1664 RegQueryValueExW(hkey, szServiceParams, NULL, &type, (LPBYTE)args[0], &sz);
1666 r = start_local_service(buf, num_args, (LPCWSTR *)args);
1667 if (r != ERROR_SUCCESS)
1668 hres = REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1669 HeapFree(GetProcessHeap(),0,args[0]);
1673 WARN("No LocalService value\n");
1674 hres = REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1682 static void get_localserver_pipe_name(WCHAR *pipefn, REFCLSID rclsid)
1684 static const WCHAR wszPipeRef[] = {'\\','\\','.','\\','p','i','p','e','\\',0};
1685 strcpyW(pipefn, wszPipeRef);
1686 StringFromGUID2(rclsid, pipefn + sizeof(wszPipeRef)/sizeof(wszPipeRef[0]) - 1, CHARS_IN_GUID);
1689 /* FIXME: should call to rpcss instead */
1690 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv)
1695 DWORD res, bufferlen;
1696 char marshalbuffer[200];
1698 LARGE_INTEGER seekto;
1699 ULARGE_INTEGER newpos;
1702 static const int MAXTRIES = 30; /* 30 seconds */
1704 TRACE("rclsid=%s, iid=%s\n", debugstr_guid(rclsid), debugstr_guid(iid));
1706 get_localserver_pipe_name(pipefn, rclsid);
1708 while (tries++ < MAXTRIES) {
1709 TRACE("waiting for %s\n", debugstr_w(pipefn));
1711 WaitNamedPipeW( pipefn, NMPWAIT_WAIT_FOREVER );
1712 hPipe = CreateFileW(pipefn, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, 0);
1713 if (hPipe == INVALID_HANDLE_VALUE) {
1715 if ( (hres = create_local_service(rclsid)) &&
1716 (hres = create_server(rclsid)) )
1720 WARN("Connecting to %s, no response yet, retrying: le is %u\n", debugstr_w(pipefn), GetLastError());
1726 if (!ReadFile(hPipe,marshalbuffer,sizeof(marshalbuffer),&bufferlen,NULL)) {
1727 FIXME("Failed to read marshal id from classfactory of %s.\n",debugstr_guid(rclsid));
1731 TRACE("read marshal id from pipe\n");
1736 if (tries >= MAXTRIES)
1737 return E_NOINTERFACE;
1739 hres = CreateStreamOnHGlobal(0,TRUE,&pStm);
1740 if (hres) return hres;
1741 hres = IStream_Write(pStm,marshalbuffer,bufferlen,&res);
1743 seekto.u.LowPart = 0;seekto.u.HighPart = 0;
1744 hres = IStream_Seek(pStm,seekto,SEEK_SET,&newpos);
1746 TRACE("unmarshalling classfactory\n");
1747 hres = CoUnmarshalInterface(pStm,&IID_IClassFactory,ppv);
1749 IStream_Release(pStm);
1754 struct local_server_params
1763 /* FIXME: should call to rpcss instead */
1764 static DWORD WINAPI local_server_thread(LPVOID param)
1766 struct local_server_params * lsp = (struct local_server_params *)param;
1770 IStream *pStm = lsp->stream;
1772 unsigned char *buffer;
1774 LARGE_INTEGER seekto;
1775 ULARGE_INTEGER newpos;
1777 BOOL multi_use = lsp->multi_use;
1779 TRACE("Starting threader for %s.\n",debugstr_guid(&lsp->clsid));
1781 get_localserver_pipe_name(pipefn, &lsp->clsid);
1783 hPipe = CreateNamedPipeW( pipefn, PIPE_ACCESS_DUPLEX,
1784 PIPE_TYPE_BYTE|PIPE_WAIT, PIPE_UNLIMITED_INSTANCES,
1785 4096, 4096, 500 /* 0.5 second timeout */, NULL );
1788 SetEvent(lsp->ready_event);
1790 HeapFree(GetProcessHeap(), 0, lsp);
1792 if (hPipe == INVALID_HANDLE_VALUE)
1794 FIXME("pipe creation failed for %s, le is %u\n", debugstr_w(pipefn), GetLastError());
1799 if (!ConnectNamedPipe(hPipe,NULL))
1801 DWORD error = GetLastError();
1802 /* client already connected isn't an error */
1803 if (error != ERROR_PIPE_CONNECTED)
1805 /* if error wasn't caused by RPC_StopLocalServer closing the
1807 if (error != ERROR_INVALID_HANDLE)
1809 ERR("Failure during ConnectNamedPipe %u\n", error);
1816 TRACE("marshalling IClassFactory to client\n");
1818 hres = IStream_Stat(pStm,&ststg,0);
1819 if (hres) return hres;
1821 seekto.u.LowPart = 0;
1822 seekto.u.HighPart = 0;
1823 hres = IStream_Seek(pStm,seekto,SEEK_SET,&newpos);
1825 FIXME("IStream_Seek failed, %x\n",hres);
1829 buflen = ststg.cbSize.u.LowPart;
1830 buffer = HeapAlloc(GetProcessHeap(),0,buflen);
1832 hres = IStream_Read(pStm,buffer,buflen,&res);
1834 FIXME("Stream Read failed, %x\n",hres);
1835 HeapFree(GetProcessHeap(),0,buffer);
1839 WriteFile(hPipe,buffer,buflen,&res,NULL);
1840 HeapFree(GetProcessHeap(),0,buffer);
1842 FlushFileBuffers(hPipe);
1843 DisconnectNamedPipe(hPipe);
1845 TRACE("done marshalling IClassFactory\n");
1849 TRACE("single use object, shutting down pipe %s\n", debugstr_w(pipefn));
1854 IStream_Release(pStm);
1858 /* starts listening for a local server */
1859 HRESULT RPC_StartLocalServer(REFCLSID clsid, IStream *stream, BOOL multi_use, void **registration)
1862 HANDLE thread, ready_event;
1863 struct local_server_params *lsp = HeapAlloc(GetProcessHeap(), 0, sizeof(*lsp));
1865 lsp->clsid = *clsid;
1866 lsp->stream = stream;
1867 IStream_AddRef(stream);
1868 lsp->ready_event = ready_event = CreateEventW(NULL, FALSE, FALSE, NULL);
1869 lsp->multi_use = multi_use;
1871 thread = CreateThread(NULL, 0, local_server_thread, lsp, 0, &tid);
1873 return HRESULT_FROM_WIN32(GetLastError());
1874 CloseHandle(thread);
1876 WaitForSingleObject(ready_event, INFINITE);
1877 CloseHandle(ready_event);
1879 *registration = lsp->pipe;
1883 /* stops listening for a local server */
1884 void RPC_StopLocalServer(void *registration)
1886 HANDLE pipe = registration;