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 IRpcChannelBuffer IRpcChannelBuffer_iface;
100 DWORD dest_context; /* returned from GetDestCtx */
101 void *dest_context_data; /* returned from GetDestCtx */
106 RpcChannelBuffer super; /* superclass */
108 RPC_BINDING_HANDLE bind; /* handle to the remote server */
109 OXID oxid; /* apartment in which the channel is valid */
110 DWORD server_pid; /* id of server process */
111 HANDLE event; /* cached event handle */
112 } ClientRpcChannelBuffer;
114 struct dispatch_params
116 RPCOLEMESSAGE *msg; /* message */
117 IRpcStubBuffer *stub; /* stub buffer, if applicable */
118 IRpcChannelBuffer *chan; /* server channel buffer, if applicable */
119 IID iid; /* ID of interface being called */
120 IUnknown *iface; /* interface being called */
121 HANDLE handle; /* handle that will become signaled when call finishes */
122 BOOL bypass_rpcrt; /* bypass RPC runtime? */
123 RPC_STATUS status; /* status (out) */
124 HRESULT hr; /* hresult (out) */
129 RPC_BINDING_HANDLE binding_handle;
130 ULONG prefix_data_len;
131 SChannelHookCallInfo channel_hook_info;
137 struct dispatch_params params;
142 ULONG conformance; /* NDR */
145 /* [size_is((size+7)&~7)] */ unsigned char data[1];
152 unsigned char extent[1];
153 } WIRE_ORPC_EXTENT_ARRAY;
161 unsigned char extensions[1];
167 unsigned char extensions[1];
170 struct channel_hook_entry
177 struct channel_hook_buffer_data
180 ULONG extension_size;
184 static HRESULT unmarshal_ORPCTHAT(RPC_MESSAGE *msg, ORPCTHAT *orpcthat,
185 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent);
187 /* Channel Hook Functions */
189 static ULONG ChannelHooks_ClientGetSize(SChannelHookCallInfo *info,
190 struct channel_hook_buffer_data **data, unsigned int *hook_count,
191 ULONG *extension_count)
193 struct channel_hook_entry *entry;
194 ULONG total_size = 0;
195 unsigned int hook_index = 0;
198 *extension_count = 0;
200 EnterCriticalSection(&csChannelHook);
202 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
206 *data = HeapAlloc(GetProcessHeap(), 0, *hook_count * sizeof(struct channel_hook_buffer_data));
210 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
212 ULONG extension_size = 0;
214 IChannelHook_ClientGetSize(entry->hook, &entry->id, &info->iid, &extension_size);
216 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
218 extension_size = (extension_size+7)&~7;
219 (*data)[hook_index].id = entry->id;
220 (*data)[hook_index].extension_size = extension_size;
222 /* an extension is only put onto the wire if it has data to write */
225 total_size += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[extension_size]);
226 (*extension_count)++;
232 LeaveCriticalSection(&csChannelHook);
237 static unsigned char * ChannelHooks_ClientFillBuffer(SChannelHookCallInfo *info,
238 unsigned char *buffer, struct channel_hook_buffer_data *data,
239 unsigned int hook_count)
241 struct channel_hook_entry *entry;
243 EnterCriticalSection(&csChannelHook);
245 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
248 ULONG extension_size = 0;
249 WIRE_ORPC_EXTENT *wire_orpc_extent = (WIRE_ORPC_EXTENT *)buffer;
251 for (i = 0; i < hook_count; i++)
252 if (IsEqualGUID(&entry->id, &data[i].id))
253 extension_size = data[i].extension_size;
255 /* an extension is only put onto the wire if it has data to write */
259 IChannelHook_ClientFillBuffer(entry->hook, &entry->id, &info->iid,
260 &extension_size, buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]));
262 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
264 /* FIXME: set unused portion of wire_orpc_extent->data to 0? */
266 wire_orpc_extent->conformance = (extension_size+7)&~7;
267 wire_orpc_extent->size = extension_size;
268 wire_orpc_extent->id = entry->id;
269 buffer += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[wire_orpc_extent->conformance]);
272 LeaveCriticalSection(&csChannelHook);
277 static void ChannelHooks_ServerNotify(SChannelHookCallInfo *info,
278 DWORD lDataRep, WIRE_ORPC_EXTENT *first_wire_orpc_extent,
279 ULONG extension_count)
281 struct channel_hook_entry *entry;
284 EnterCriticalSection(&csChannelHook);
286 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
288 WIRE_ORPC_EXTENT *wire_orpc_extent;
289 for (i = 0, wire_orpc_extent = first_wire_orpc_extent;
291 i++, wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance])
293 if (IsEqualGUID(&entry->id, &wire_orpc_extent->id))
296 if (i == extension_count) wire_orpc_extent = NULL;
298 IChannelHook_ServerNotify(entry->hook, &entry->id, &info->iid,
299 wire_orpc_extent ? wire_orpc_extent->size : 0,
300 wire_orpc_extent ? wire_orpc_extent->data : NULL,
304 LeaveCriticalSection(&csChannelHook);
307 static ULONG ChannelHooks_ServerGetSize(SChannelHookCallInfo *info,
308 struct channel_hook_buffer_data **data, unsigned int *hook_count,
309 ULONG *extension_count)
311 struct channel_hook_entry *entry;
312 ULONG total_size = 0;
313 unsigned int hook_index = 0;
316 *extension_count = 0;
318 EnterCriticalSection(&csChannelHook);
320 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
324 *data = HeapAlloc(GetProcessHeap(), 0, *hook_count * sizeof(struct channel_hook_buffer_data));
328 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
330 ULONG extension_size = 0;
332 IChannelHook_ServerGetSize(entry->hook, &entry->id, &info->iid, S_OK,
335 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
337 extension_size = (extension_size+7)&~7;
338 (*data)[hook_index].id = entry->id;
339 (*data)[hook_index].extension_size = extension_size;
341 /* an extension is only put onto the wire if it has data to write */
344 total_size += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[extension_size]);
345 (*extension_count)++;
351 LeaveCriticalSection(&csChannelHook);
356 static unsigned char * ChannelHooks_ServerFillBuffer(SChannelHookCallInfo *info,
357 unsigned char *buffer, struct channel_hook_buffer_data *data,
358 unsigned int hook_count)
360 struct channel_hook_entry *entry;
362 EnterCriticalSection(&csChannelHook);
364 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
367 ULONG extension_size = 0;
368 WIRE_ORPC_EXTENT *wire_orpc_extent = (WIRE_ORPC_EXTENT *)buffer;
370 for (i = 0; i < hook_count; i++)
371 if (IsEqualGUID(&entry->id, &data[i].id))
372 extension_size = data[i].extension_size;
374 /* an extension is only put onto the wire if it has data to write */
378 IChannelHook_ServerFillBuffer(entry->hook, &entry->id, &info->iid,
379 &extension_size, buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]),
382 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
384 /* FIXME: set unused portion of wire_orpc_extent->data to 0? */
386 wire_orpc_extent->conformance = (extension_size+7)&~7;
387 wire_orpc_extent->size = extension_size;
388 wire_orpc_extent->id = entry->id;
389 buffer += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[wire_orpc_extent->conformance]);
392 LeaveCriticalSection(&csChannelHook);
397 static void ChannelHooks_ClientNotify(SChannelHookCallInfo *info,
398 DWORD lDataRep, WIRE_ORPC_EXTENT *first_wire_orpc_extent,
399 ULONG extension_count, HRESULT hrFault)
401 struct channel_hook_entry *entry;
404 EnterCriticalSection(&csChannelHook);
406 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
408 WIRE_ORPC_EXTENT *wire_orpc_extent;
409 for (i = 0, wire_orpc_extent = first_wire_orpc_extent;
411 i++, wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance])
413 if (IsEqualGUID(&entry->id, &wire_orpc_extent->id))
416 if (i == extension_count) wire_orpc_extent = NULL;
418 IChannelHook_ClientNotify(entry->hook, &entry->id, &info->iid,
419 wire_orpc_extent ? wire_orpc_extent->size : 0,
420 wire_orpc_extent ? wire_orpc_extent->data : NULL,
424 LeaveCriticalSection(&csChannelHook);
427 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook)
429 struct channel_hook_entry *entry;
431 TRACE("(%s, %p)\n", debugstr_guid(rguid), hook);
433 entry = HeapAlloc(GetProcessHeap(), 0, sizeof(*entry));
435 return E_OUTOFMEMORY;
439 IChannelHook_AddRef(hook);
441 EnterCriticalSection(&csChannelHook);
442 list_add_tail(&channel_hooks, &entry->entry);
443 LeaveCriticalSection(&csChannelHook);
448 void RPC_UnregisterAllChannelHooks(void)
450 struct channel_hook_entry *cursor;
451 struct channel_hook_entry *cursor2;
453 EnterCriticalSection(&csChannelHook);
454 LIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, &channel_hooks, struct channel_hook_entry, entry)
455 HeapFree(GetProcessHeap(), 0, cursor);
456 LeaveCriticalSection(&csChannelHook);
457 DeleteCriticalSection(&csChannelHook);
458 DeleteCriticalSection(&csRegIf);
461 /* RPC Channel Buffer Functions */
463 static HRESULT WINAPI RpcChannelBuffer_QueryInterface(IRpcChannelBuffer *iface, REFIID riid, LPVOID *ppv)
466 if (IsEqualIID(riid,&IID_IRpcChannelBuffer) || IsEqualIID(riid,&IID_IUnknown))
469 IRpcChannelBuffer_AddRef(iface);
472 return E_NOINTERFACE;
475 static ULONG WINAPI RpcChannelBuffer_AddRef(LPRPCCHANNELBUFFER iface)
477 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
478 return InterlockedIncrement(&This->refs);
481 static ULONG WINAPI ServerRpcChannelBuffer_Release(LPRPCCHANNELBUFFER iface)
483 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
486 ref = InterlockedDecrement(&This->refs);
490 HeapFree(GetProcessHeap(), 0, This);
494 static ULONG WINAPI ClientRpcChannelBuffer_Release(LPRPCCHANNELBUFFER iface)
496 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
499 ref = InterlockedDecrement(&This->super.refs);
503 if (This->event) CloseHandle(This->event);
504 RpcBindingFree(&This->bind);
505 HeapFree(GetProcessHeap(), 0, This);
509 static HRESULT WINAPI ServerRpcChannelBuffer_GetBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg, REFIID riid)
511 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
512 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
515 struct message_state *message_state;
516 ULONG extensions_size;
517 struct channel_hook_buffer_data *channel_hook_data;
518 unsigned int channel_hook_count;
519 ULONG extension_count;
521 TRACE("(%p)->(%p,%s)\n", This, olemsg, debugstr_guid(riid));
523 message_state = msg->Handle;
524 /* restore the binding handle and the real start of data */
525 msg->Handle = message_state->binding_handle;
526 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
528 extensions_size = ChannelHooks_ServerGetSize(&message_state->channel_hook_info,
529 &channel_hook_data, &channel_hook_count, &extension_count);
531 msg->BufferLength += FIELD_OFFSET(WIRE_ORPCTHAT, extensions) + sizeof(DWORD);
534 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT_ARRAY, extent[2*sizeof(DWORD) + extensions_size]);
535 if (extension_count & 1)
536 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
539 if (message_state->bypass_rpcrt)
541 msg->Buffer = HeapAlloc(GetProcessHeap(), 0, msg->BufferLength);
546 HeapFree(GetProcessHeap(), 0, channel_hook_data);
547 return E_OUTOFMEMORY;
551 status = I_RpcGetBuffer(msg);
553 orpcthat = msg->Buffer;
554 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPCTHAT, extensions);
556 orpcthat->flags = ORPCF_NULL /* FIXME? */;
558 /* NDR representation of orpcthat->extensions */
559 *(DWORD *)msg->Buffer = extensions_size ? 1 : 0;
560 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
564 WIRE_ORPC_EXTENT_ARRAY *orpc_extent_array = msg->Buffer;
565 orpc_extent_array->size = extension_count;
566 orpc_extent_array->reserved = 0;
567 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT_ARRAY, extent);
568 /* NDR representation of orpc_extent_array->extent */
569 *(DWORD *)msg->Buffer = 1;
570 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
571 /* NDR representation of [size_is] attribute of orpc_extent_array->extent */
572 *(DWORD *)msg->Buffer = (extension_count + 1) & ~1;
573 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
575 msg->Buffer = ChannelHooks_ServerFillBuffer(&message_state->channel_hook_info,
576 msg->Buffer, channel_hook_data, channel_hook_count);
578 /* we must add a dummy extension if there is an odd extension
579 * count to meet the contract specified by the size_is attribute */
580 if (extension_count & 1)
582 WIRE_ORPC_EXTENT *wire_orpc_extent = msg->Buffer;
583 wire_orpc_extent->conformance = 0;
584 wire_orpc_extent->id = GUID_NULL;
585 wire_orpc_extent->size = 0;
586 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
590 HeapFree(GetProcessHeap(), 0, channel_hook_data);
592 /* store the prefixed data length so that we can restore the real buffer
594 message_state->prefix_data_len = (char *)msg->Buffer - (char *)orpcthat;
595 msg->BufferLength -= message_state->prefix_data_len;
596 /* save away the message state again */
597 msg->Handle = message_state;
599 TRACE("-- %d\n", status);
601 return HRESULT_FROM_WIN32(status);
604 static HANDLE ClientRpcChannelBuffer_GetEventHandle(ClientRpcChannelBuffer *This)
606 HANDLE event = InterlockedExchangePointer(&This->event, NULL);
608 /* Note: must be auto-reset event so we can reuse it without a call
610 if (!event) event = CreateEventW(NULL, FALSE, FALSE, NULL);
615 static void ClientRpcChannelBuffer_ReleaseEventHandle(ClientRpcChannelBuffer *This, HANDLE event)
617 if (InterlockedCompareExchangePointer(&This->event, event, NULL))
618 /* already a handle cached in This */
622 static HRESULT WINAPI ClientRpcChannelBuffer_GetBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg, REFIID riid)
624 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
625 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
626 RPC_CLIENT_INTERFACE *cif;
629 struct message_state *message_state;
630 ULONG extensions_size;
631 struct channel_hook_buffer_data *channel_hook_data;
632 unsigned int channel_hook_count;
633 ULONG extension_count;
636 APARTMENT *apt = NULL;
638 TRACE("(%p)->(%p,%s)\n", This, olemsg, debugstr_guid(riid));
640 cif = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RPC_CLIENT_INTERFACE));
642 return E_OUTOFMEMORY;
644 message_state = HeapAlloc(GetProcessHeap(), 0, sizeof(*message_state));
647 HeapFree(GetProcessHeap(), 0, cif);
648 return E_OUTOFMEMORY;
651 cif->Length = sizeof(RPC_CLIENT_INTERFACE);
652 /* RPC interface ID = COM interface ID */
653 cif->InterfaceId.SyntaxGUID = *riid;
654 /* COM objects always have a version of 0.0 */
655 cif->InterfaceId.SyntaxVersion.MajorVersion = 0;
656 cif->InterfaceId.SyntaxVersion.MinorVersion = 0;
657 msg->Handle = This->bind;
658 msg->RpcInterfaceInformation = cif;
660 message_state->prefix_data_len = 0;
661 message_state->binding_handle = This->bind;
663 message_state->channel_hook_info.iid = *riid;
664 message_state->channel_hook_info.cbSize = sizeof(message_state->channel_hook_info);
665 message_state->channel_hook_info.uCausality = COM_CurrentCausalityId();
666 message_state->channel_hook_info.dwServerPid = This->server_pid;
667 message_state->channel_hook_info.iMethod = msg->ProcNum;
668 message_state->channel_hook_info.pObject = NULL; /* only present on server-side */
669 message_state->target_hwnd = NULL;
670 message_state->target_tid = 0;
671 memset(&message_state->params, 0, sizeof(message_state->params));
673 extensions_size = ChannelHooks_ClientGetSize(&message_state->channel_hook_info,
674 &channel_hook_data, &channel_hook_count, &extension_count);
676 msg->BufferLength += FIELD_OFFSET(WIRE_ORPCTHIS, extensions) + sizeof(DWORD);
679 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT_ARRAY, extent[2*sizeof(DWORD) + extensions_size]);
680 if (extension_count & 1)
681 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
684 RpcBindingInqObject(message_state->binding_handle, &ipid);
685 hr = ipid_get_dispatch_params(&ipid, &apt, &message_state->params.stub,
686 &message_state->params.chan,
687 &message_state->params.iid,
688 &message_state->params.iface);
691 /* stub, chan, iface and iid are unneeded in multi-threaded case as we go
692 * via the RPC runtime */
693 if (apt->multi_threaded)
695 IRpcStubBuffer_Release(message_state->params.stub);
696 message_state->params.stub = NULL;
697 IRpcChannelBuffer_Release(message_state->params.chan);
698 message_state->params.chan = NULL;
699 message_state->params.iface = NULL;
703 message_state->params.bypass_rpcrt = TRUE;
704 message_state->target_hwnd = apartment_getwindow(apt);
705 message_state->target_tid = apt->tid;
706 /* we assume later on that this being non-NULL is the indicator that
707 * means call directly instead of going through RPC runtime */
708 if (!message_state->target_hwnd)
709 ERR("window for apartment %s is NULL\n", wine_dbgstr_longlong(apt->oxid));
712 if (apt) apartment_release(apt);
713 message_state->params.handle = ClientRpcChannelBuffer_GetEventHandle(This);
714 /* Note: message_state->params.msg is initialised in
715 * ClientRpcChannelBuffer_SendReceive */
717 /* shortcut the RPC runtime */
718 if (message_state->target_hwnd)
720 msg->Buffer = HeapAlloc(GetProcessHeap(), 0, msg->BufferLength);
724 status = ERROR_OUTOFMEMORY;
727 status = I_RpcGetBuffer(msg);
729 msg->Handle = message_state;
731 if (status == RPC_S_OK)
733 orpcthis = msg->Buffer;
734 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPCTHIS, extensions);
736 orpcthis->version.MajorVersion = COM_MAJOR_VERSION;
737 orpcthis->version.MinorVersion = COM_MINOR_VERSION;
738 orpcthis->flags = message_state->channel_hook_info.dwServerPid ? ORPCF_LOCAL : ORPCF_NULL;
739 orpcthis->reserved1 = 0;
740 orpcthis->cid = message_state->channel_hook_info.uCausality;
742 /* NDR representation of orpcthis->extensions */
743 *(DWORD *)msg->Buffer = extensions_size ? 1 : 0;
744 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
748 ORPC_EXTENT_ARRAY *orpc_extent_array = msg->Buffer;
749 orpc_extent_array->size = extension_count;
750 orpc_extent_array->reserved = 0;
751 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT_ARRAY, extent);
752 /* NDR representation of orpc_extent_array->extent */
753 *(DWORD *)msg->Buffer = 1;
754 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
755 /* NDR representation of [size_is] attribute of orpc_extent_array->extent */
756 *(DWORD *)msg->Buffer = (extension_count + 1) & ~1;
757 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
759 msg->Buffer = ChannelHooks_ClientFillBuffer(&message_state->channel_hook_info,
760 msg->Buffer, channel_hook_data, channel_hook_count);
762 /* we must add a dummy extension if there is an odd extension
763 * count to meet the contract specified by the size_is attribute */
764 if (extension_count & 1)
766 WIRE_ORPC_EXTENT *wire_orpc_extent = msg->Buffer;
767 wire_orpc_extent->conformance = 0;
768 wire_orpc_extent->id = GUID_NULL;
769 wire_orpc_extent->size = 0;
770 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
774 /* store the prefixed data length so that we can restore the real buffer
775 * pointer in ClientRpcChannelBuffer_SendReceive. */
776 message_state->prefix_data_len = (char *)msg->Buffer - (char *)orpcthis;
777 msg->BufferLength -= message_state->prefix_data_len;
780 HeapFree(GetProcessHeap(), 0, channel_hook_data);
782 TRACE("-- %d\n", status);
784 return HRESULT_FROM_WIN32(status);
787 static HRESULT WINAPI ServerRpcChannelBuffer_SendReceive(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE *olemsg, ULONG *pstatus)
793 /* this thread runs an outgoing RPC */
794 static DWORD WINAPI rpc_sendreceive_thread(LPVOID param)
796 struct dispatch_params *data = param;
798 /* Note: I_RpcSendReceive doesn't raise exceptions like the higher-level
799 * RPC functions do */
800 data->status = I_RpcSendReceive((RPC_MESSAGE *)data->msg);
802 TRACE("completed with status 0x%x\n", data->status);
804 SetEvent(data->handle);
809 static inline HRESULT ClientRpcChannelBuffer_IsCorrectApartment(ClientRpcChannelBuffer *This, APARTMENT *apt)
814 if (apartment_getoxid(apt, &oxid) != S_OK)
816 if (This->oxid != oxid)
821 static HRESULT WINAPI ClientRpcChannelBuffer_SendReceive(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE *olemsg, ULONG *pstatus)
823 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
825 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
828 struct message_state *message_state;
830 ORPC_EXTENT_ARRAY orpc_ext_array;
831 WIRE_ORPC_EXTENT *first_wire_orpc_extent = NULL;
832 HRESULT hrFault = S_OK;
834 TRACE("(%p) iMethod=%d\n", olemsg, olemsg->iMethod);
836 hr = ClientRpcChannelBuffer_IsCorrectApartment(This, COM_CurrentApt());
839 ERR("called from wrong apartment, should have been 0x%s\n",
840 wine_dbgstr_longlong(This->oxid));
841 return RPC_E_WRONG_THREAD;
843 /* This situation should be impossible in multi-threaded apartments,
844 * because the calling thread isn't re-enterable.
845 * Note: doing a COM call during the processing of a sent message is
846 * only disallowed if a client call is already being waited for
848 if (!COM_CurrentApt()->multi_threaded &&
849 COM_CurrentInfo()->pending_call_count_client &&
852 ERR("can't make an outgoing COM call in response to a sent message\n");
853 return RPC_E_CANTCALLOUT_ININPUTSYNCCALL;
856 message_state = msg->Handle;
857 /* restore the binding handle and the real start of data */
858 msg->Handle = message_state->binding_handle;
859 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
860 msg->BufferLength += message_state->prefix_data_len;
862 /* Note: this is an optimization in the Microsoft OLE runtime that we need
863 * to copy, as shown by the test_no_couninitialize_client test. without
864 * short-circuiting the RPC runtime in the case below, the test will
865 * deadlock on the loader lock due to the RPC runtime needing to create
866 * a thread to process the RPC when this function is called indirectly
869 message_state->params.msg = olemsg;
870 if (message_state->params.bypass_rpcrt)
872 TRACE("Calling apartment thread 0x%08x...\n", message_state->target_tid);
874 msg->ProcNum &= ~RPC_FLAGS_VALID_BIT;
876 if (!PostMessageW(message_state->target_hwnd, DM_EXECUTERPC, 0,
877 (LPARAM)&message_state->params))
879 ERR("PostMessage failed with error %u\n", GetLastError());
881 /* Note: message_state->params.iface doesn't have a reference and
882 * so doesn't need to be released */
884 hr = HRESULT_FROM_WIN32(GetLastError());
889 /* we use a separate thread here because we need to be able to
890 * pump the message loop in the application thread: if we do not,
891 * any windows created by this thread will hang and RPCs that try
892 * and re-enter this STA from an incoming server thread will
893 * deadlock. InstallShield is an example of that.
895 if (!QueueUserWorkItem(rpc_sendreceive_thread, &message_state->params, WT_EXECUTEDEFAULT))
897 ERR("QueueUserWorkItem failed with error %u\n", GetLastError());
906 if (WaitForSingleObject(message_state->params.handle, 0))
908 COM_CurrentInfo()->pending_call_count_client++;
909 hr = CoWaitForMultipleHandles(0, INFINITE, 1, &message_state->params.handle, &index);
910 COM_CurrentInfo()->pending_call_count_client--;
913 ClientRpcChannelBuffer_ReleaseEventHandle(This, message_state->params.handle);
915 /* for WM shortcut, faults are returned in params->hr */
917 hrFault = message_state->params.hr;
919 status = message_state->params.status;
921 orpcthat.flags = ORPCF_NULL;
922 orpcthat.extensions = NULL;
924 TRACE("RPC call status: 0x%x\n", status);
925 if (status != RPC_S_OK)
926 hr = HRESULT_FROM_WIN32(status);
928 TRACE("hrFault = 0x%08x\n", hrFault);
930 /* FIXME: this condition should be
931 * "hr == S_OK && (!hrFault || msg->BufferLength > FIELD_OFFSET(ORPCTHAT, extensions) + 4)"
932 * but we don't currently reset the message length for PostMessage
933 * dispatched calls */
934 if (hr == S_OK && hrFault == S_OK)
937 char *original_buffer = msg->Buffer;
939 /* handle ORPCTHAT and client extensions */
941 hr2 = unmarshal_ORPCTHAT(msg, &orpcthat, &orpc_ext_array, &first_wire_orpc_extent);
945 message_state->prefix_data_len = (char *)msg->Buffer - original_buffer;
946 msg->BufferLength -= message_state->prefix_data_len;
949 message_state->prefix_data_len = 0;
953 ChannelHooks_ClientNotify(&message_state->channel_hook_info,
954 msg->DataRepresentation,
955 first_wire_orpc_extent,
956 orpcthat.extensions && first_wire_orpc_extent ? orpcthat.extensions->size : 0,
960 /* save away the message state again */
961 msg->Handle = message_state;
963 if (pstatus) *pstatus = status;
968 TRACE("-- 0x%08x\n", hr);
973 static HRESULT WINAPI ServerRpcChannelBuffer_FreeBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg)
975 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
977 struct message_state *message_state;
979 TRACE("(%p)\n", msg);
981 message_state = msg->Handle;
982 /* restore the binding handle and the real start of data */
983 msg->Handle = message_state->binding_handle;
984 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
985 msg->BufferLength += message_state->prefix_data_len;
986 message_state->prefix_data_len = 0;
988 if (message_state->bypass_rpcrt)
990 HeapFree(GetProcessHeap(), 0, msg->Buffer);
994 status = I_RpcFreeBuffer(msg);
996 msg->Handle = message_state;
998 TRACE("-- %d\n", status);
1000 return HRESULT_FROM_WIN32(status);
1003 static HRESULT WINAPI ClientRpcChannelBuffer_FreeBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg)
1005 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
1007 struct message_state *message_state;
1009 TRACE("(%p)\n", msg);
1011 message_state = msg->Handle;
1012 /* restore the binding handle and the real start of data */
1013 msg->Handle = message_state->binding_handle;
1014 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
1015 msg->BufferLength += message_state->prefix_data_len;
1017 if (message_state->params.bypass_rpcrt)
1019 HeapFree(GetProcessHeap(), 0, msg->Buffer);
1023 status = I_RpcFreeBuffer(msg);
1025 HeapFree(GetProcessHeap(), 0, msg->RpcInterfaceInformation);
1026 msg->RpcInterfaceInformation = NULL;
1028 if (message_state->params.stub)
1029 IRpcStubBuffer_Release(message_state->params.stub);
1030 if (message_state->params.chan)
1031 IRpcChannelBuffer_Release(message_state->params.chan);
1032 HeapFree(GetProcessHeap(), 0, message_state);
1034 TRACE("-- %d\n", status);
1036 return HRESULT_FROM_WIN32(status);
1039 static HRESULT WINAPI ClientRpcChannelBuffer_GetDestCtx(LPRPCCHANNELBUFFER iface, DWORD* pdwDestContext, void** ppvDestContext)
1041 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
1043 TRACE("(%p,%p)\n", pdwDestContext, ppvDestContext);
1045 *pdwDestContext = This->super.dest_context;
1046 *ppvDestContext = This->super.dest_context_data;
1051 static HRESULT WINAPI ServerRpcChannelBuffer_GetDestCtx(LPRPCCHANNELBUFFER iface, DWORD* dest_context, void** dest_context_data)
1053 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
1055 TRACE("(%p,%p)\n", dest_context, dest_context_data);
1057 *dest_context = This->dest_context;
1058 *dest_context_data = This->dest_context_data;
1062 static HRESULT WINAPI RpcChannelBuffer_IsConnected(LPRPCCHANNELBUFFER iface)
1065 /* native does nothing too */
1069 static const IRpcChannelBufferVtbl ClientRpcChannelBufferVtbl =
1071 RpcChannelBuffer_QueryInterface,
1072 RpcChannelBuffer_AddRef,
1073 ClientRpcChannelBuffer_Release,
1074 ClientRpcChannelBuffer_GetBuffer,
1075 ClientRpcChannelBuffer_SendReceive,
1076 ClientRpcChannelBuffer_FreeBuffer,
1077 ClientRpcChannelBuffer_GetDestCtx,
1078 RpcChannelBuffer_IsConnected
1081 static const IRpcChannelBufferVtbl ServerRpcChannelBufferVtbl =
1083 RpcChannelBuffer_QueryInterface,
1084 RpcChannelBuffer_AddRef,
1085 ServerRpcChannelBuffer_Release,
1086 ServerRpcChannelBuffer_GetBuffer,
1087 ServerRpcChannelBuffer_SendReceive,
1088 ServerRpcChannelBuffer_FreeBuffer,
1089 ServerRpcChannelBuffer_GetDestCtx,
1090 RpcChannelBuffer_IsConnected
1093 /* returns a channel buffer for proxies */
1094 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
1095 const OXID_INFO *oxid_info,
1096 DWORD dest_context, void *dest_context_data,
1097 IRpcChannelBuffer **chan)
1099 ClientRpcChannelBuffer *This;
1100 WCHAR endpoint[200];
1101 RPC_BINDING_HANDLE bind;
1103 LPWSTR string_binding;
1105 /* FIXME: get the endpoint from oxid_info->psa instead */
1106 get_rpc_endpoint(endpoint, oxid);
1108 TRACE("proxy pipe: connecting to endpoint: %s\n", debugstr_w(endpoint));
1110 status = RpcStringBindingComposeW(
1118 if (status == RPC_S_OK)
1120 status = RpcBindingFromStringBindingW(string_binding, &bind);
1122 if (status == RPC_S_OK)
1124 IPID ipid2 = *ipid; /* why can't RpcBindingSetObject take a const? */
1125 status = RpcBindingSetObject(bind, &ipid2);
1126 if (status != RPC_S_OK)
1127 RpcBindingFree(&bind);
1130 RpcStringFreeW(&string_binding);
1133 if (status != RPC_S_OK)
1135 ERR("Couldn't get binding for endpoint %s, status = %d\n", debugstr_w(endpoint), status);
1136 return HRESULT_FROM_WIN32(status);
1139 This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
1142 RpcBindingFree(&bind);
1143 return E_OUTOFMEMORY;
1146 This->super.IRpcChannelBuffer_iface.lpVtbl = &ClientRpcChannelBufferVtbl;
1147 This->super.refs = 1;
1148 This->super.dest_context = dest_context;
1149 This->super.dest_context_data = dest_context_data;
1151 apartment_getoxid(COM_CurrentApt(), &This->oxid);
1152 This->server_pid = oxid_info->dwPid;
1155 *chan = &This->super.IRpcChannelBuffer_iface;
1160 HRESULT RPC_CreateServerChannel(DWORD dest_context, void *dest_context_data, IRpcChannelBuffer **chan)
1162 RpcChannelBuffer *This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
1164 return E_OUTOFMEMORY;
1166 This->IRpcChannelBuffer_iface.lpVtbl = &ServerRpcChannelBufferVtbl;
1168 This->dest_context = dest_context;
1169 This->dest_context_data = dest_context_data;
1171 *chan = &This->IRpcChannelBuffer_iface;
1176 /* unmarshals ORPC_EXTENT_ARRAY according to NDR rules, but doesn't allocate
1178 static HRESULT unmarshal_ORPC_EXTENT_ARRAY(RPC_MESSAGE *msg, const char *end,
1179 ORPC_EXTENT_ARRAY *extensions,
1180 WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1185 memcpy(extensions, msg->Buffer, FIELD_OFFSET(WIRE_ORPC_EXTENT_ARRAY, extent));
1186 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT_ARRAY, extent);
1188 if ((const char *)msg->Buffer + 2 * sizeof(DWORD) > end)
1189 return RPC_E_INVALID_HEADER;
1191 pointer_id = *(DWORD *)msg->Buffer;
1192 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1193 extensions->extent = NULL;
1197 WIRE_ORPC_EXTENT *wire_orpc_extent;
1200 if (*(DWORD *)msg->Buffer != ((extensions->size+1)&~1))
1201 return RPC_S_INVALID_BOUND;
1203 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1205 /* arbitrary limit for security (don't know what native does) */
1206 if (extensions->size > 256)
1208 ERR("too many extensions: %d\n", extensions->size);
1209 return RPC_S_INVALID_BOUND;
1212 *first_wire_orpc_extent = wire_orpc_extent = msg->Buffer;
1213 for (i = 0; i < ((extensions->size+1)&~1); i++)
1215 if ((const char *)&wire_orpc_extent->data[0] > end)
1216 return RPC_S_INVALID_BOUND;
1217 if (wire_orpc_extent->conformance != ((wire_orpc_extent->size+7)&~7))
1218 return RPC_S_INVALID_BOUND;
1219 if ((const char *)&wire_orpc_extent->data[wire_orpc_extent->conformance] > end)
1220 return RPC_S_INVALID_BOUND;
1221 TRACE("size %u, guid %s\n", wire_orpc_extent->size, debugstr_guid(&wire_orpc_extent->id));
1222 wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance];
1224 msg->Buffer = wire_orpc_extent;
1230 /* unmarshals ORPCTHIS according to NDR rules, but doesn't allocate any memory */
1231 static HRESULT unmarshal_ORPCTHIS(RPC_MESSAGE *msg, ORPCTHIS *orpcthis,
1232 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1234 const char *end = (char *)msg->Buffer + msg->BufferLength;
1236 *first_wire_orpc_extent = NULL;
1238 if (msg->BufferLength < FIELD_OFFSET(WIRE_ORPCTHIS, extensions) + sizeof(DWORD))
1240 ERR("invalid buffer length\n");
1241 return RPC_E_INVALID_HEADER;
1244 memcpy(orpcthis, msg->Buffer, FIELD_OFFSET(WIRE_ORPCTHIS, extensions));
1245 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPCTHIS, extensions);
1247 if ((const char *)msg->Buffer + sizeof(DWORD) > end)
1248 return RPC_E_INVALID_HEADER;
1250 if (*(DWORD *)msg->Buffer)
1251 orpcthis->extensions = orpc_ext_array;
1253 orpcthis->extensions = NULL;
1255 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1257 if (orpcthis->extensions)
1259 HRESULT hr = unmarshal_ORPC_EXTENT_ARRAY(msg, end, orpc_ext_array,
1260 first_wire_orpc_extent);
1265 if ((orpcthis->version.MajorVersion != COM_MAJOR_VERSION) ||
1266 (orpcthis->version.MinorVersion > COM_MINOR_VERSION))
1268 ERR("COM version {%d, %d} not supported\n",
1269 orpcthis->version.MajorVersion, orpcthis->version.MinorVersion);
1270 return RPC_E_VERSION_MISMATCH;
1273 if (orpcthis->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4))
1275 ERR("invalid flags 0x%x\n", orpcthis->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4));
1276 return RPC_E_INVALID_HEADER;
1282 static HRESULT unmarshal_ORPCTHAT(RPC_MESSAGE *msg, ORPCTHAT *orpcthat,
1283 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1285 const char *end = (char *)msg->Buffer + msg->BufferLength;
1287 *first_wire_orpc_extent = NULL;
1289 if (msg->BufferLength < FIELD_OFFSET(WIRE_ORPCTHAT, extensions) + sizeof(DWORD))
1291 ERR("invalid buffer length\n");
1292 return RPC_E_INVALID_HEADER;
1295 memcpy(orpcthat, msg->Buffer, FIELD_OFFSET(WIRE_ORPCTHAT, extensions));
1296 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPCTHAT, extensions);
1298 if ((const char *)msg->Buffer + sizeof(DWORD) > end)
1299 return RPC_E_INVALID_HEADER;
1301 if (*(DWORD *)msg->Buffer)
1302 orpcthat->extensions = orpc_ext_array;
1304 orpcthat->extensions = NULL;
1306 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1308 if (orpcthat->extensions)
1310 HRESULT hr = unmarshal_ORPC_EXTENT_ARRAY(msg, end, orpc_ext_array,
1311 first_wire_orpc_extent);
1316 if (orpcthat->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4))
1318 ERR("invalid flags 0x%x\n", orpcthat->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4));
1319 return RPC_E_INVALID_HEADER;
1325 void RPC_ExecuteCall(struct dispatch_params *params)
1327 struct message_state *message_state = NULL;
1328 RPC_MESSAGE *msg = (RPC_MESSAGE *)params->msg;
1329 char *original_buffer = msg->Buffer;
1331 ORPC_EXTENT_ARRAY orpc_ext_array;
1332 WIRE_ORPC_EXTENT *first_wire_orpc_extent;
1333 GUID old_causality_id;
1335 /* handle ORPCTHIS and server extensions */
1337 params->hr = unmarshal_ORPCTHIS(msg, &orpcthis, &orpc_ext_array, &first_wire_orpc_extent);
1338 if (params->hr != S_OK)
1340 msg->Buffer = original_buffer;
1344 message_state = HeapAlloc(GetProcessHeap(), 0, sizeof(*message_state));
1347 params->hr = E_OUTOFMEMORY;
1348 msg->Buffer = original_buffer;
1352 message_state->prefix_data_len = (char *)msg->Buffer - original_buffer;
1353 message_state->binding_handle = msg->Handle;
1354 message_state->bypass_rpcrt = params->bypass_rpcrt;
1356 message_state->channel_hook_info.iid = params->iid;
1357 message_state->channel_hook_info.cbSize = sizeof(message_state->channel_hook_info);
1358 message_state->channel_hook_info.uCausality = orpcthis.cid;
1359 message_state->channel_hook_info.dwServerPid = GetCurrentProcessId();
1360 message_state->channel_hook_info.iMethod = msg->ProcNum;
1361 message_state->channel_hook_info.pObject = params->iface;
1363 if (orpcthis.extensions && first_wire_orpc_extent &&
1364 orpcthis.extensions->size)
1365 ChannelHooks_ServerNotify(&message_state->channel_hook_info, msg->DataRepresentation, first_wire_orpc_extent, orpcthis.extensions->size);
1367 msg->Handle = message_state;
1368 msg->BufferLength -= message_state->prefix_data_len;
1370 /* call message filter */
1372 if (COM_CurrentApt()->filter)
1375 INTERFACEINFO interface_info;
1378 interface_info.pUnk = params->iface;
1379 interface_info.iid = params->iid;
1380 interface_info.wMethod = msg->ProcNum;
1382 if (IsEqualGUID(&orpcthis.cid, &COM_CurrentInfo()->causality_id))
1383 calltype = CALLTYPE_NESTED;
1384 else if (COM_CurrentInfo()->pending_call_count_server == 0)
1385 calltype = CALLTYPE_TOPLEVEL;
1387 calltype = CALLTYPE_TOPLEVEL_CALLPENDING;
1389 handlecall = IMessageFilter_HandleInComingCall(COM_CurrentApt()->filter,
1391 UlongToHandle(GetCurrentProcessId()),
1394 TRACE("IMessageFilter_HandleInComingCall returned %d\n", handlecall);
1397 case SERVERCALL_REJECTED:
1398 params->hr = RPC_E_CALL_REJECTED;
1399 goto exit_reset_state;
1400 case SERVERCALL_RETRYLATER:
1401 #if 0 /* FIXME: handle retries on the client side before enabling this code */
1402 params->hr = RPC_E_RETRY;
1403 goto exit_reset_state;
1405 FIXME("retry call later not implemented\n");
1408 case SERVERCALL_ISHANDLED:
1414 /* invoke the method */
1416 /* save the old causality ID - note: any calls executed while processing
1417 * messages received during the SendReceive will appear to originate from
1418 * this call - this should be checked with what Windows does */
1419 old_causality_id = COM_CurrentInfo()->causality_id;
1420 COM_CurrentInfo()->causality_id = orpcthis.cid;
1421 COM_CurrentInfo()->pending_call_count_server++;
1422 params->hr = IRpcStubBuffer_Invoke(params->stub, params->msg, params->chan);
1423 COM_CurrentInfo()->pending_call_count_server--;
1424 COM_CurrentInfo()->causality_id = old_causality_id;
1426 /* the invoke allocated a new buffer, so free the old one */
1427 if (message_state->bypass_rpcrt && original_buffer != msg->Buffer)
1428 HeapFree(GetProcessHeap(), 0, original_buffer);
1431 message_state = msg->Handle;
1432 msg->Handle = message_state->binding_handle;
1433 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
1434 msg->BufferLength += message_state->prefix_data_len;
1437 HeapFree(GetProcessHeap(), 0, message_state);
1438 if (params->handle) SetEvent(params->handle);
1441 static void __RPC_STUB dispatch_rpc(RPC_MESSAGE *msg)
1443 struct dispatch_params *params;
1448 RpcBindingInqObject(msg->Handle, &ipid);
1450 TRACE("ipid = %s, iMethod = %d\n", debugstr_guid(&ipid), msg->ProcNum);
1452 params = HeapAlloc(GetProcessHeap(), 0, sizeof(*params));
1455 RpcRaiseException(E_OUTOFMEMORY);
1459 hr = ipid_get_dispatch_params(&ipid, &apt, ¶ms->stub, ¶ms->chan,
1460 ¶ms->iid, ¶ms->iface);
1463 ERR("no apartment found for ipid %s\n", debugstr_guid(&ipid));
1464 HeapFree(GetProcessHeap(), 0, params);
1465 RpcRaiseException(hr);
1469 params->msg = (RPCOLEMESSAGE *)msg;
1470 params->status = RPC_S_OK;
1472 params->handle = NULL;
1473 params->bypass_rpcrt = FALSE;
1475 /* Note: this is the important difference between STAs and MTAs - we
1476 * always execute RPCs to STAs in the thread that originally created the
1477 * apartment (i.e. the one that pumps messages to the window) */
1478 if (!apt->multi_threaded)
1480 params->handle = CreateEventW(NULL, FALSE, FALSE, NULL);
1482 TRACE("Calling apartment thread 0x%08x...\n", apt->tid);
1484 if (PostMessageW(apartment_getwindow(apt), DM_EXECUTERPC, 0, (LPARAM)params))
1485 WaitForSingleObject(params->handle, INFINITE);
1488 ERR("PostMessage failed with error %u\n", GetLastError());
1489 IRpcChannelBuffer_Release(params->chan);
1490 IRpcStubBuffer_Release(params->stub);
1492 CloseHandle(params->handle);
1496 BOOL joined = FALSE;
1497 if (!COM_CurrentInfo()->apt)
1499 apartment_joinmta();
1502 RPC_ExecuteCall(params);
1505 apartment_release(COM_CurrentInfo()->apt);
1506 COM_CurrentInfo()->apt = NULL;
1512 IRpcChannelBuffer_Release(params->chan);
1514 IRpcStubBuffer_Release(params->stub);
1515 HeapFree(GetProcessHeap(), 0, params);
1517 apartment_release(apt);
1519 /* if IRpcStubBuffer_Invoke fails, we should raise an exception to tell
1520 * the RPC runtime that the call failed */
1521 if (hr) RpcRaiseException(hr);
1524 /* stub registration */
1525 HRESULT RPC_RegisterInterface(REFIID riid)
1527 struct registered_if *rif;
1531 TRACE("(%s)\n", debugstr_guid(riid));
1533 EnterCriticalSection(&csRegIf);
1534 LIST_FOR_EACH_ENTRY(rif, ®istered_interfaces, struct registered_if, entry)
1536 if (IsEqualGUID(&rif->If.InterfaceId.SyntaxGUID, riid))
1545 TRACE("Creating new interface\n");
1547 rif = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*rif));
1553 rif->If.Length = sizeof(RPC_SERVER_INTERFACE);
1554 /* RPC interface ID = COM interface ID */
1555 rif->If.InterfaceId.SyntaxGUID = *riid;
1556 rif->If.DispatchTable = &rpc_dispatch;
1557 /* all other fields are 0, including the version asCOM objects
1558 * always have a version of 0.0 */
1559 status = RpcServerRegisterIfEx(
1560 (RPC_IF_HANDLE)&rif->If,
1562 RPC_IF_OLE | RPC_IF_AUTOLISTEN,
1563 RPC_C_LISTEN_MAX_CALLS_DEFAULT,
1565 if (status == RPC_S_OK)
1566 list_add_tail(®istered_interfaces, &rif->entry);
1569 ERR("RpcServerRegisterIfEx failed with error %d\n", status);
1570 HeapFree(GetProcessHeap(), 0, rif);
1571 hr = HRESULT_FROM_WIN32(status);
1577 LeaveCriticalSection(&csRegIf);
1581 /* stub unregistration */
1582 void RPC_UnregisterInterface(REFIID riid)
1584 struct registered_if *rif;
1585 EnterCriticalSection(&csRegIf);
1586 LIST_FOR_EACH_ENTRY(rif, ®istered_interfaces, struct registered_if, entry)
1588 if (IsEqualGUID(&rif->If.InterfaceId.SyntaxGUID, riid))
1592 RpcServerUnregisterIf((RPC_IF_HANDLE)&rif->If, NULL, TRUE);
1593 list_remove(&rif->entry);
1594 HeapFree(GetProcessHeap(), 0, rif);
1599 LeaveCriticalSection(&csRegIf);
1602 /* get the info for an OXID, including the IPID for the rem unknown interface
1603 * and the string binding */
1604 HRESULT RPC_ResolveOxid(OXID oxid, OXID_INFO *oxid_info)
1606 TRACE("%s\n", wine_dbgstr_longlong(oxid));
1608 oxid_info->dwTid = 0;
1609 oxid_info->dwPid = 0;
1610 oxid_info->dwAuthnHint = RPC_C_AUTHN_LEVEL_NONE;
1611 /* FIXME: this is a hack around not having an OXID resolver yet -
1612 * this function should contact the machine's OXID resolver and then it
1613 * should give us the IPID of the IRemUnknown interface */
1614 oxid_info->ipidRemUnknown.Data1 = 0xffffffff;
1615 oxid_info->ipidRemUnknown.Data2 = 0xffff;
1616 oxid_info->ipidRemUnknown.Data3 = 0xffff;
1617 memcpy(oxid_info->ipidRemUnknown.Data4, &oxid, sizeof(OXID));
1618 oxid_info->psa = NULL /* FIXME */;
1623 /* make the apartment reachable by other threads and processes and create the
1624 * IRemUnknown object */
1625 void RPC_StartRemoting(struct apartment *apt)
1627 if (!InterlockedExchange(&apt->remoting_started, TRUE))
1629 WCHAR endpoint[200];
1632 get_rpc_endpoint(endpoint, &apt->oxid);
1634 status = RpcServerUseProtseqEpW(
1636 RPC_C_PROTSEQ_MAX_REQS_DEFAULT,
1639 if (status != RPC_S_OK)
1640 ERR("Couldn't register endpoint %s\n", debugstr_w(endpoint));
1642 /* FIXME: move remote unknown exporting into this function */
1644 start_apartment_remote_unknown();
1648 static HRESULT create_server(REFCLSID rclsid, HANDLE *process)
1650 static const WCHAR wszLocalServer32[] = { 'L','o','c','a','l','S','e','r','v','e','r','3','2',0 };
1651 static const WCHAR embedding[] = { ' ', '-','E','m','b','e','d','d','i','n','g',0 };
1654 WCHAR command[MAX_PATH+sizeof(embedding)/sizeof(WCHAR)];
1655 DWORD size = (MAX_PATH+1) * sizeof(WCHAR);
1657 PROCESS_INFORMATION pinfo;
1659 hres = COM_OpenKeyForCLSID(rclsid, wszLocalServer32, KEY_READ, &key);
1661 ERR("class %s not registered\n", debugstr_guid(rclsid));
1665 hres = RegQueryValueExW(key, NULL, NULL, NULL, (LPBYTE)command, &size);
1668 WARN("No default value for LocalServer32 key\n");
1669 return REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1672 memset(&sinfo,0,sizeof(sinfo));
1673 sinfo.cb = sizeof(sinfo);
1675 /* EXE servers are started with the -Embedding switch. */
1677 strcatW(command, embedding);
1679 TRACE("activating local server %s for %s\n", debugstr_w(command), debugstr_guid(rclsid));
1681 /* FIXME: Win2003 supports a ServerExecutable value that is passed into
1683 if (!CreateProcessW(NULL, command, NULL, NULL, FALSE, 0, NULL, NULL, &sinfo, &pinfo)) {
1684 WARN("failed to run local server %s\n", debugstr_w(command));
1685 return HRESULT_FROM_WIN32(GetLastError());
1687 *process = pinfo.hProcess;
1688 CloseHandle(pinfo.hThread);
1694 * start_local_service() - start a service given its name and parameters
1696 static DWORD start_local_service(LPCWSTR name, DWORD num, LPCWSTR *params)
1698 SC_HANDLE handle, hsvc;
1699 DWORD r = ERROR_FUNCTION_FAILED;
1701 TRACE("Starting service %s %d params\n", debugstr_w(name), num);
1703 handle = OpenSCManagerW(NULL, NULL, SC_MANAGER_CONNECT);
1706 hsvc = OpenServiceW(handle, name, SERVICE_START);
1709 if(StartServiceW(hsvc, num, params))
1713 if (r == ERROR_SERVICE_ALREADY_RUNNING)
1715 CloseServiceHandle(hsvc);
1719 CloseServiceHandle(handle);
1721 TRACE("StartService returned error %u (%s)\n", r, (r == ERROR_SUCCESS) ? "ok":"failed");
1727 * create_local_service() - start a COM server in a service
1729 * To start a Local Service, we read the AppID value under
1730 * the class's CLSID key, then open the HKCR\\AppId key specified
1731 * there and check for a LocalService value.
1733 * Note: Local Services are not supported under Windows 9x
1735 static HRESULT create_local_service(REFCLSID rclsid)
1738 WCHAR buf[CHARS_IN_GUID];
1739 static const WCHAR szLocalService[] = { 'L','o','c','a','l','S','e','r','v','i','c','e',0 };
1740 static const WCHAR szServiceParams[] = {'S','e','r','v','i','c','e','P','a','r','a','m','s',0};
1745 TRACE("Attempting to start Local service for %s\n", debugstr_guid(rclsid));
1747 hres = COM_OpenKeyForAppIdFromCLSID(rclsid, KEY_READ, &hkey);
1751 /* read the LocalService and ServiceParameters values from the AppID key */
1753 r = RegQueryValueExW(hkey, szLocalService, NULL, &type, (LPBYTE)buf, &sz);
1754 if (r==ERROR_SUCCESS && type==REG_SZ)
1757 LPWSTR args[1] = { NULL };
1760 * FIXME: I'm not really sure how to deal with the service parameters.
1761 * I suspect that the string returned from RegQueryValueExW
1762 * should be split into a number of arguments by spaces.
1763 * It would make more sense if ServiceParams contained a
1764 * REG_MULTI_SZ here, but it's a REG_SZ for the services
1765 * that I'm interested in for the moment.
1767 r = RegQueryValueExW(hkey, szServiceParams, NULL, &type, NULL, &sz);
1768 if (r == ERROR_SUCCESS && type == REG_SZ && sz)
1770 args[0] = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sz);
1772 RegQueryValueExW(hkey, szServiceParams, NULL, &type, (LPBYTE)args[0], &sz);
1774 r = start_local_service(buf, num_args, (LPCWSTR *)args);
1775 if (r != ERROR_SUCCESS)
1776 hres = REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1777 HeapFree(GetProcessHeap(),0,args[0]);
1781 WARN("No LocalService value\n");
1782 hres = REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1790 static void get_localserver_pipe_name(WCHAR *pipefn, REFCLSID rclsid)
1792 static const WCHAR wszPipeRef[] = {'\\','\\','.','\\','p','i','p','e','\\',0};
1793 strcpyW(pipefn, wszPipeRef);
1794 StringFromGUID2(rclsid, pipefn + sizeof(wszPipeRef)/sizeof(wszPipeRef[0]) - 1, CHARS_IN_GUID);
1797 /* FIXME: should call to rpcss instead */
1798 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv)
1803 DWORD res, bufferlen;
1804 char marshalbuffer[200];
1806 LARGE_INTEGER seekto;
1807 ULARGE_INTEGER newpos;
1810 static const int MAXTRIES = 30; /* 30 seconds */
1812 TRACE("rclsid=%s, iid=%s\n", debugstr_guid(rclsid), debugstr_guid(iid));
1814 get_localserver_pipe_name(pipefn, rclsid);
1816 while (tries++ < MAXTRIES) {
1817 TRACE("waiting for %s\n", debugstr_w(pipefn));
1819 WaitNamedPipeW( pipefn, NMPWAIT_WAIT_FOREVER );
1820 hPipe = CreateFileW(pipefn, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, 0);
1821 if (hPipe == INVALID_HANDLE_VALUE) {
1826 if ( (hres = create_local_service(rclsid)) &&
1827 (hres = create_server(rclsid, &process)) )
1830 WARN("Connecting to %s, no response yet, retrying: le is %u\n", debugstr_w(pipefn), GetLastError());
1832 /* wait for one second, even if messages arrive */
1833 start_ticks = GetTickCount();
1835 if (SUCCEEDED(CoWaitForMultipleHandles(0, 1000, (process != 0),
1836 &process, &index)) && process && !index)
1838 WARN( "server for %s failed to start\n", debugstr_guid(rclsid) );
1839 CloseHandle( hPipe );
1840 CloseHandle( process );
1841 return E_NOINTERFACE;
1843 } while (GetTickCount() - start_ticks < 1000);
1844 if (process) CloseHandle( process );
1848 if (!ReadFile(hPipe,marshalbuffer,sizeof(marshalbuffer),&bufferlen,NULL)) {
1849 FIXME("Failed to read marshal id from classfactory of %s.\n",debugstr_guid(rclsid));
1853 TRACE("read marshal id from pipe\n");
1858 if (tries >= MAXTRIES)
1859 return E_NOINTERFACE;
1861 hres = CreateStreamOnHGlobal(0,TRUE,&pStm);
1862 if (hres) return hres;
1863 hres = IStream_Write(pStm,marshalbuffer,bufferlen,&res);
1865 seekto.u.LowPart = 0;seekto.u.HighPart = 0;
1866 hres = IStream_Seek(pStm,seekto,STREAM_SEEK_SET,&newpos);
1868 TRACE("unmarshalling classfactory\n");
1869 hres = CoUnmarshalInterface(pStm,&IID_IClassFactory,ppv);
1871 IStream_Release(pStm);
1876 struct local_server_params
1886 /* FIXME: should call to rpcss instead */
1887 static DWORD WINAPI local_server_thread(LPVOID param)
1889 struct local_server_params * lsp = param;
1892 IStream *pStm = lsp->stream;
1894 unsigned char *buffer;
1896 LARGE_INTEGER seekto;
1897 ULARGE_INTEGER newpos;
1899 BOOL multi_use = lsp->multi_use;
1901 HANDLE pipe_event, hPipe, new_pipe;
1904 TRACE("Starting threader for %s.\n",debugstr_guid(&lsp->clsid));
1906 memset(&ovl, 0, sizeof(ovl));
1907 get_localserver_pipe_name(pipefn, &lsp->clsid);
1908 ovl.hEvent = pipe_event = CreateEventW(NULL, FALSE, FALSE, NULL);
1910 hPipe = CreateNamedPipeW( pipefn, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
1911 PIPE_TYPE_BYTE|PIPE_WAIT, PIPE_UNLIMITED_INSTANCES,
1912 4096, 4096, 500 /* 0.5 second timeout */, NULL );
1913 if (hPipe == INVALID_HANDLE_VALUE)
1915 FIXME("pipe creation failed for %s, le is %u\n", debugstr_w(pipefn), GetLastError());
1916 CloseHandle(pipe_event);
1920 SetEvent(lsp->ready_event);
1923 if (!ConnectNamedPipe(hPipe, &ovl))
1925 DWORD error = GetLastError();
1926 if (error == ERROR_IO_PENDING)
1928 HANDLE handles[2] = { pipe_event, lsp->stop_event };
1930 ret = WaitForMultipleObjects(2, handles, FALSE, INFINITE);
1931 if (ret != WAIT_OBJECT_0)
1937 /* client already connected isn't an error */
1938 else if (error != ERROR_PIPE_CONNECTED)
1940 ERR("ConnectNamedPipe failed with error %d\n", GetLastError());
1946 TRACE("marshalling IClassFactory to client\n");
1948 hres = IStream_Stat(pStm,&ststg,STATFLAG_NONAME);
1952 CloseHandle(pipe_event);
1956 seekto.u.LowPart = 0;
1957 seekto.u.HighPart = 0;
1958 hres = IStream_Seek(pStm,seekto,STREAM_SEEK_SET,&newpos);
1960 FIXME("IStream_Seek failed, %x\n",hres);
1962 CloseHandle(pipe_event);
1966 buflen = ststg.cbSize.u.LowPart;
1967 buffer = HeapAlloc(GetProcessHeap(),0,buflen);
1969 hres = IStream_Read(pStm,buffer,buflen,&res);
1971 FIXME("Stream Read failed, %x\n",hres);
1973 CloseHandle(pipe_event);
1974 HeapFree(GetProcessHeap(),0,buffer);
1978 WriteFile(hPipe,buffer,buflen,&res,&ovl);
1979 GetOverlappedResult(hPipe, &ovl, &bytes, TRUE);
1980 HeapFree(GetProcessHeap(),0,buffer);
1982 FlushFileBuffers(hPipe);
1983 DisconnectNamedPipe(hPipe);
1984 TRACE("done marshalling IClassFactory\n");
1988 TRACE("single use object, shutting down pipe %s\n", debugstr_w(pipefn));
1992 new_pipe = CreateNamedPipeW( pipefn, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
1993 PIPE_TYPE_BYTE|PIPE_WAIT, PIPE_UNLIMITED_INSTANCES,
1994 4096, 4096, 500 /* 0.5 second timeout */, NULL );
1996 if (new_pipe == INVALID_HANDLE_VALUE)
1998 FIXME("pipe creation failed for %s, le is %u\n", debugstr_w(pipefn), GetLastError());
1999 CloseHandle(pipe_event);
2004 CloseHandle(pipe_event);
2008 /* starts listening for a local server */
2009 HRESULT RPC_StartLocalServer(REFCLSID clsid, IStream *stream, BOOL multi_use, void **registration)
2012 struct local_server_params *lsp;
2014 lsp = HeapAlloc(GetProcessHeap(), 0, sizeof(*lsp));
2016 return E_OUTOFMEMORY;
2018 lsp->clsid = *clsid;
2019 lsp->stream = stream;
2020 IStream_AddRef(stream);
2021 lsp->ready_event = CreateEventW(NULL, FALSE, FALSE, NULL);
2022 if (!lsp->ready_event)
2024 HeapFree(GetProcessHeap(), 0, lsp);
2025 return HRESULT_FROM_WIN32(GetLastError());
2027 lsp->stop_event = CreateEventW(NULL, FALSE, FALSE, NULL);
2028 if (!lsp->stop_event)
2030 CloseHandle(lsp->ready_event);
2031 HeapFree(GetProcessHeap(), 0, lsp);
2032 return HRESULT_FROM_WIN32(GetLastError());
2034 lsp->multi_use = multi_use;
2036 lsp->thread = CreateThread(NULL, 0, local_server_thread, lsp, 0, &tid);
2039 CloseHandle(lsp->ready_event);
2040 CloseHandle(lsp->stop_event);
2041 HeapFree(GetProcessHeap(), 0, lsp);
2042 return HRESULT_FROM_WIN32(GetLastError());
2045 WaitForSingleObject(lsp->ready_event, INFINITE);
2046 CloseHandle(lsp->ready_event);
2047 lsp->ready_event = NULL;
2049 *registration = lsp;
2053 /* stops listening for a local server */
2054 void RPC_StopLocalServer(void *registration)
2056 struct local_server_params *lsp = registration;
2058 /* signal local_server_thread to stop */
2059 SetEvent(lsp->stop_event);
2060 /* wait for it to exit */
2061 WaitForSingleObject(lsp->thread, INFINITE);
2063 IStream_Release(lsp->stream);
2064 CloseHandle(lsp->stop_event);
2065 CloseHandle(lsp->thread);
2066 HeapFree(GetProcessHeap(), 0, lsp);