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 BOOL bypass_rpcrt; /* bypass RPC runtime? */
122 RPC_STATUS status; /* status (out) */
123 HRESULT hr; /* hresult (out) */
128 RPC_BINDING_HANDLE binding_handle;
129 ULONG prefix_data_len;
130 SChannelHookCallInfo channel_hook_info;
136 struct dispatch_params params;
141 ULONG conformance; /* NDR */
144 /* [size_is((size+7)&~7)] */ unsigned char data[1];
147 struct channel_hook_entry
154 struct channel_hook_buffer_data
157 ULONG extension_size;
161 static HRESULT unmarshal_ORPCTHAT(RPC_MESSAGE *msg, ORPCTHAT *orpcthat,
162 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent);
164 /* Channel Hook Functions */
166 static ULONG ChannelHooks_ClientGetSize(SChannelHookCallInfo *info,
167 struct channel_hook_buffer_data **data, unsigned int *hook_count,
168 ULONG *extension_count)
170 struct channel_hook_entry *entry;
171 ULONG total_size = 0;
172 unsigned int hook_index = 0;
175 *extension_count = 0;
177 EnterCriticalSection(&csChannelHook);
179 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
183 *data = HeapAlloc(GetProcessHeap(), 0, *hook_count * sizeof(struct channel_hook_buffer_data));
187 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
189 ULONG extension_size = 0;
191 IChannelHook_ClientGetSize(entry->hook, &entry->id, &info->iid, &extension_size);
193 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
195 extension_size = (extension_size+7)&~7;
196 (*data)[hook_index].id = entry->id;
197 (*data)[hook_index].extension_size = extension_size;
199 /* an extension is only put onto the wire if it has data to write */
202 total_size += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[extension_size]);
203 (*extension_count)++;
209 LeaveCriticalSection(&csChannelHook);
214 static unsigned char * ChannelHooks_ClientFillBuffer(SChannelHookCallInfo *info,
215 unsigned char *buffer, struct channel_hook_buffer_data *data,
216 unsigned int hook_count)
218 struct channel_hook_entry *entry;
220 EnterCriticalSection(&csChannelHook);
222 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
225 ULONG extension_size = 0;
226 WIRE_ORPC_EXTENT *wire_orpc_extent = (WIRE_ORPC_EXTENT *)buffer;
228 for (i = 0; i < hook_count; i++)
229 if (IsEqualGUID(&entry->id, &data[i].id))
230 extension_size = data[i].extension_size;
232 /* an extension is only put onto the wire if it has data to write */
236 IChannelHook_ClientFillBuffer(entry->hook, &entry->id, &info->iid,
237 &extension_size, buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]));
239 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
241 /* FIXME: set unused portion of wire_orpc_extent->data to 0? */
243 wire_orpc_extent->conformance = (extension_size+7)&~7;
244 wire_orpc_extent->size = extension_size;
245 wire_orpc_extent->id = entry->id;
246 buffer += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[wire_orpc_extent->conformance]);
249 LeaveCriticalSection(&csChannelHook);
254 static void ChannelHooks_ServerNotify(SChannelHookCallInfo *info,
255 DWORD lDataRep, WIRE_ORPC_EXTENT *first_wire_orpc_extent,
256 ULONG extension_count)
258 struct channel_hook_entry *entry;
261 EnterCriticalSection(&csChannelHook);
263 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
265 WIRE_ORPC_EXTENT *wire_orpc_extent;
266 for (i = 0, wire_orpc_extent = first_wire_orpc_extent;
268 i++, wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance])
270 if (IsEqualGUID(&entry->id, &wire_orpc_extent->id))
273 if (i == extension_count) wire_orpc_extent = NULL;
275 IChannelHook_ServerNotify(entry->hook, &entry->id, &info->iid,
276 wire_orpc_extent ? wire_orpc_extent->size : 0,
277 wire_orpc_extent ? wire_orpc_extent->data : NULL,
281 LeaveCriticalSection(&csChannelHook);
284 static ULONG ChannelHooks_ServerGetSize(SChannelHookCallInfo *info,
285 struct channel_hook_buffer_data **data, unsigned int *hook_count,
286 ULONG *extension_count)
288 struct channel_hook_entry *entry;
289 ULONG total_size = 0;
290 unsigned int hook_index = 0;
293 *extension_count = 0;
295 EnterCriticalSection(&csChannelHook);
297 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
301 *data = HeapAlloc(GetProcessHeap(), 0, *hook_count * sizeof(struct channel_hook_buffer_data));
305 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
307 ULONG extension_size = 0;
309 IChannelHook_ServerGetSize(entry->hook, &entry->id, &info->iid, S_OK,
312 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
314 extension_size = (extension_size+7)&~7;
315 (*data)[hook_index].id = entry->id;
316 (*data)[hook_index].extension_size = extension_size;
318 /* an extension is only put onto the wire if it has data to write */
321 total_size += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[extension_size]);
322 (*extension_count)++;
328 LeaveCriticalSection(&csChannelHook);
333 static unsigned char * ChannelHooks_ServerFillBuffer(SChannelHookCallInfo *info,
334 unsigned char *buffer, struct channel_hook_buffer_data *data,
335 unsigned int hook_count)
337 struct channel_hook_entry *entry;
339 EnterCriticalSection(&csChannelHook);
341 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
344 ULONG extension_size = 0;
345 WIRE_ORPC_EXTENT *wire_orpc_extent = (WIRE_ORPC_EXTENT *)buffer;
347 for (i = 0; i < hook_count; i++)
348 if (IsEqualGUID(&entry->id, &data[i].id))
349 extension_size = data[i].extension_size;
351 /* an extension is only put onto the wire if it has data to write */
355 IChannelHook_ServerFillBuffer(entry->hook, &entry->id, &info->iid,
356 &extension_size, buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]),
359 TRACE("%s: extension_size = %u\n", debugstr_guid(&entry->id), extension_size);
361 /* FIXME: set unused portion of wire_orpc_extent->data to 0? */
363 wire_orpc_extent->conformance = (extension_size+7)&~7;
364 wire_orpc_extent->size = extension_size;
365 wire_orpc_extent->id = entry->id;
366 buffer += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[wire_orpc_extent->conformance]);
369 LeaveCriticalSection(&csChannelHook);
374 static void ChannelHooks_ClientNotify(SChannelHookCallInfo *info,
375 DWORD lDataRep, WIRE_ORPC_EXTENT *first_wire_orpc_extent,
376 ULONG extension_count, HRESULT hrFault)
378 struct channel_hook_entry *entry;
381 EnterCriticalSection(&csChannelHook);
383 LIST_FOR_EACH_ENTRY(entry, &channel_hooks, struct channel_hook_entry, entry)
385 WIRE_ORPC_EXTENT *wire_orpc_extent;
386 for (i = 0, wire_orpc_extent = first_wire_orpc_extent;
388 i++, wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance])
390 if (IsEqualGUID(&entry->id, &wire_orpc_extent->id))
393 if (i == extension_count) wire_orpc_extent = NULL;
395 IChannelHook_ClientNotify(entry->hook, &entry->id, &info->iid,
396 wire_orpc_extent ? wire_orpc_extent->size : 0,
397 wire_orpc_extent ? wire_orpc_extent->data : NULL,
401 LeaveCriticalSection(&csChannelHook);
404 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook)
406 struct channel_hook_entry *entry;
408 TRACE("(%s, %p)\n", debugstr_guid(rguid), hook);
410 entry = HeapAlloc(GetProcessHeap(), 0, sizeof(*entry));
412 return E_OUTOFMEMORY;
416 IChannelHook_AddRef(hook);
418 EnterCriticalSection(&csChannelHook);
419 list_add_tail(&channel_hooks, &entry->entry);
420 LeaveCriticalSection(&csChannelHook);
425 void RPC_UnregisterAllChannelHooks(void)
427 struct channel_hook_entry *cursor;
428 struct channel_hook_entry *cursor2;
430 EnterCriticalSection(&csChannelHook);
431 LIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, &channel_hooks, struct channel_hook_entry, entry)
432 HeapFree(GetProcessHeap(), 0, cursor);
433 LeaveCriticalSection(&csChannelHook);
436 /* RPC Channel Buffer Functions */
438 static HRESULT WINAPI RpcChannelBuffer_QueryInterface(LPRPCCHANNELBUFFER iface, REFIID riid, LPVOID *ppv)
441 if (IsEqualIID(riid,&IID_IRpcChannelBuffer) || IsEqualIID(riid,&IID_IUnknown))
443 *ppv = (LPVOID)iface;
444 IUnknown_AddRef(iface);
447 return E_NOINTERFACE;
450 static ULONG WINAPI RpcChannelBuffer_AddRef(LPRPCCHANNELBUFFER iface)
452 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
453 return InterlockedIncrement(&This->refs);
456 static ULONG WINAPI ServerRpcChannelBuffer_Release(LPRPCCHANNELBUFFER iface)
458 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
461 ref = InterlockedDecrement(&This->refs);
465 HeapFree(GetProcessHeap(), 0, This);
469 static ULONG WINAPI ClientRpcChannelBuffer_Release(LPRPCCHANNELBUFFER iface)
471 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
474 ref = InterlockedDecrement(&This->super.refs);
478 if (This->event) CloseHandle(This->event);
479 RpcBindingFree(&This->bind);
480 HeapFree(GetProcessHeap(), 0, This);
484 static HRESULT WINAPI ServerRpcChannelBuffer_GetBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg, REFIID riid)
486 RpcChannelBuffer *This = (RpcChannelBuffer *)iface;
487 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
490 struct message_state *message_state;
491 ULONG extensions_size;
492 struct channel_hook_buffer_data *channel_hook_data;
493 unsigned int channel_hook_count;
494 ULONG extension_count;
496 TRACE("(%p)->(%p,%s)\n", This, olemsg, debugstr_guid(riid));
498 message_state = (struct message_state *)msg->Handle;
499 /* restore the binding handle and the real start of data */
500 msg->Handle = message_state->binding_handle;
501 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
503 extensions_size = ChannelHooks_ServerGetSize(&message_state->channel_hook_info,
504 &channel_hook_data, &channel_hook_count, &extension_count);
506 msg->BufferLength += FIELD_OFFSET(ORPCTHAT, extensions) + 4;
509 msg->BufferLength += FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent) + 2*sizeof(DWORD) + extensions_size;
510 if (extension_count & 1)
511 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
514 if (message_state->bypass_rpcrt)
516 msg->Buffer = HeapAlloc(GetProcessHeap(), 0, msg->BufferLength);
520 status = ERROR_OUTOFMEMORY;
523 status = I_RpcGetBuffer(msg);
525 orpcthat = (ORPCTHAT *)msg->Buffer;
526 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHAT, extensions);
528 orpcthat->flags = ORPCF_NULL /* FIXME? */;
530 /* NDR representation of orpcthat->extensions */
531 *(DWORD *)msg->Buffer = extensions_size ? 1 : 0;
532 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
536 ORPC_EXTENT_ARRAY *orpc_extent_array = msg->Buffer;
537 orpc_extent_array->size = extension_count;
538 orpc_extent_array->reserved = 0;
539 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent);
540 /* NDR representation of orpc_extent_array->extent */
541 *(DWORD *)msg->Buffer = 1;
542 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
543 /* NDR representation of [size_is] attribute of orpc_extent_array->extent */
544 *(DWORD *)msg->Buffer = (extension_count + 1) & ~1;
545 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
547 msg->Buffer = ChannelHooks_ServerFillBuffer(&message_state->channel_hook_info,
548 msg->Buffer, channel_hook_data, channel_hook_count);
550 /* we must add a dummy extension if there is an odd extension
551 * count to meet the contract specified by the size_is attribute */
552 if (extension_count & 1)
554 WIRE_ORPC_EXTENT *wire_orpc_extent = msg->Buffer;
555 wire_orpc_extent->conformance = 0;
556 wire_orpc_extent->id = GUID_NULL;
557 wire_orpc_extent->size = 0;
558 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
562 HeapFree(GetProcessHeap(), 0, channel_hook_data);
564 /* store the prefixed data length so that we can restore the real buffer
566 message_state->prefix_data_len = (char *)msg->Buffer - (char *)orpcthat;
567 msg->BufferLength -= message_state->prefix_data_len;
568 /* save away the message state again */
569 msg->Handle = message_state;
571 TRACE("-- %ld\n", status);
573 return HRESULT_FROM_WIN32(status);
576 static HANDLE ClientRpcChannelBuffer_GetEventHandle(ClientRpcChannelBuffer *This)
578 HANDLE event = InterlockedExchangePointer(&This->event, NULL);
580 /* Note: must be auto-reset event so we can reuse it without a call
582 if (!event) event = CreateEventW(NULL, FALSE, FALSE, NULL);
587 static void ClientRpcChannelBuffer_ReleaseEventHandle(ClientRpcChannelBuffer *This, HANDLE event)
589 if (InterlockedCompareExchangePointer(&This->event, event, NULL))
590 /* already a handle cached in This */
594 static HRESULT WINAPI ClientRpcChannelBuffer_GetBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg, REFIID riid)
596 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
597 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
598 RPC_CLIENT_INTERFACE *cif;
601 struct message_state *message_state;
602 ULONG extensions_size;
603 struct channel_hook_buffer_data *channel_hook_data;
604 unsigned int channel_hook_count;
605 ULONG extension_count;
608 APARTMENT *apt = NULL;
610 TRACE("(%p)->(%p,%s)\n", This, olemsg, debugstr_guid(riid));
612 cif = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RPC_CLIENT_INTERFACE));
614 return E_OUTOFMEMORY;
616 message_state = HeapAlloc(GetProcessHeap(), 0, sizeof(*message_state));
619 HeapFree(GetProcessHeap(), 0, cif);
620 return E_OUTOFMEMORY;
623 cif->Length = sizeof(RPC_CLIENT_INTERFACE);
624 /* RPC interface ID = COM interface ID */
625 cif->InterfaceId.SyntaxGUID = *riid;
626 /* COM objects always have a version of 0.0 */
627 cif->InterfaceId.SyntaxVersion.MajorVersion = 0;
628 cif->InterfaceId.SyntaxVersion.MinorVersion = 0;
629 msg->Handle = This->bind;
630 msg->RpcInterfaceInformation = cif;
632 message_state->prefix_data_len = 0;
633 message_state->binding_handle = This->bind;
635 message_state->channel_hook_info.iid = *riid;
636 message_state->channel_hook_info.cbSize = sizeof(message_state->channel_hook_info);
637 message_state->channel_hook_info.uCausality = COM_CurrentCausalityId();
638 message_state->channel_hook_info.dwServerPid = This->server_pid;
639 message_state->channel_hook_info.iMethod = msg->ProcNum;
640 message_state->channel_hook_info.pObject = NULL; /* only present on server-side */
641 message_state->target_hwnd = NULL;
642 message_state->target_tid = 0;
643 memset(&message_state->params, 0, sizeof(message_state->params));
645 extensions_size = ChannelHooks_ClientGetSize(&message_state->channel_hook_info,
646 &channel_hook_data, &channel_hook_count, &extension_count);
648 msg->BufferLength += FIELD_OFFSET(ORPCTHIS, extensions) + 4;
651 msg->BufferLength += FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent) + 2*sizeof(DWORD) + extensions_size;
652 if (extension_count & 1)
653 msg->BufferLength += FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
656 RpcBindingInqObject(message_state->binding_handle, &ipid);
657 hr = ipid_get_dispatch_params(&ipid, &apt, &message_state->params.stub,
658 &message_state->params.chan,
659 &message_state->params.iid,
660 &message_state->params.iface);
663 /* stub, chan, iface and iid are unneeded in multi-threaded case as we go
664 * via the RPC runtime */
665 if (apt->multi_threaded)
667 IRpcStubBuffer_Release(message_state->params.stub);
668 message_state->params.stub = NULL;
669 IRpcChannelBuffer_Release(message_state->params.chan);
670 message_state->params.chan = NULL;
671 message_state->params.iface = NULL;
675 message_state->params.bypass_rpcrt = TRUE;
676 message_state->target_hwnd = apartment_getwindow(apt);
677 message_state->target_tid = apt->tid;
678 /* we assume later on that this being non-NULL is the indicator that
679 * means call directly instead of going through RPC runtime */
680 if (!message_state->target_hwnd)
681 ERR("window for apartment %s is NULL\n", wine_dbgstr_longlong(apt->oxid));
684 if (apt) apartment_release(apt);
685 message_state->params.handle = ClientRpcChannelBuffer_GetEventHandle(This);
686 /* Note: message_state->params.msg is initialised in
687 * ClientRpcChannelBuffer_SendReceive */
689 /* shortcut the RPC runtime */
690 if (message_state->target_hwnd)
692 msg->Buffer = HeapAlloc(GetProcessHeap(), 0, msg->BufferLength);
696 status = ERROR_OUTOFMEMORY;
699 status = I_RpcGetBuffer(msg);
701 msg->Handle = message_state;
703 if (status == RPC_S_OK)
705 orpcthis = (ORPCTHIS *)msg->Buffer;
706 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHIS, extensions);
708 orpcthis->version.MajorVersion = COM_MAJOR_VERSION;
709 orpcthis->version.MinorVersion = COM_MINOR_VERSION;
710 orpcthis->flags = message_state->channel_hook_info.dwServerPid ? ORPCF_LOCAL : ORPCF_NULL;
711 orpcthis->reserved1 = 0;
712 orpcthis->cid = message_state->channel_hook_info.uCausality;
714 /* NDR representation of orpcthis->extensions */
715 *(DWORD *)msg->Buffer = extensions_size ? 1 : 0;
716 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
720 ORPC_EXTENT_ARRAY *orpc_extent_array = msg->Buffer;
721 orpc_extent_array->size = extension_count;
722 orpc_extent_array->reserved = 0;
723 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent);
724 /* NDR representation of orpc_extent_array->extent */
725 *(DWORD *)msg->Buffer = 1;
726 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
727 /* NDR representation of [size_is] attribute of orpc_extent_array->extent */
728 *(DWORD *)msg->Buffer = (extension_count + 1) & ~1;
729 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
731 msg->Buffer = ChannelHooks_ClientFillBuffer(&message_state->channel_hook_info,
732 msg->Buffer, channel_hook_data, channel_hook_count);
734 /* we must add a dummy extension if there is an odd extension
735 * count to meet the contract specified by the size_is attribute */
736 if (extension_count & 1)
738 WIRE_ORPC_EXTENT *wire_orpc_extent = msg->Buffer;
739 wire_orpc_extent->conformance = 0;
740 wire_orpc_extent->id = GUID_NULL;
741 wire_orpc_extent->size = 0;
742 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(WIRE_ORPC_EXTENT, data[0]);
746 /* store the prefixed data length so that we can restore the real buffer
747 * pointer in ClientRpcChannelBuffer_SendReceive. */
748 message_state->prefix_data_len = (char *)msg->Buffer - (char *)orpcthis;
749 msg->BufferLength -= message_state->prefix_data_len;
752 HeapFree(GetProcessHeap(), 0, channel_hook_data);
754 TRACE("-- %ld\n", status);
756 return HRESULT_FROM_WIN32(status);
759 static HRESULT WINAPI ServerRpcChannelBuffer_SendReceive(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE *olemsg, ULONG *pstatus)
765 /* this thread runs an outgoing RPC */
766 static DWORD WINAPI rpc_sendreceive_thread(LPVOID param)
768 struct dispatch_params *data = (struct dispatch_params *) param;
770 /* Note: I_RpcSendReceive doesn't raise exceptions like the higher-level
771 * RPC functions do */
772 data->status = I_RpcSendReceive((RPC_MESSAGE *)data->msg);
774 TRACE("completed with status 0x%lx\n", data->status);
776 SetEvent(data->handle);
781 static inline HRESULT ClientRpcChannelBuffer_IsCorrectApartment(ClientRpcChannelBuffer *This, APARTMENT *apt)
786 if (apartment_getoxid(apt, &oxid) != S_OK)
788 if (This->oxid != oxid)
793 static HRESULT WINAPI ClientRpcChannelBuffer_SendReceive(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE *olemsg, ULONG *pstatus)
795 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
797 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
800 struct message_state *message_state;
802 ORPC_EXTENT_ARRAY orpc_ext_array;
803 WIRE_ORPC_EXTENT *first_wire_orpc_extent = NULL;
804 HRESULT hrFault = S_OK;
806 TRACE("(%p) iMethod=%d\n", olemsg, olemsg->iMethod);
808 hr = ClientRpcChannelBuffer_IsCorrectApartment(This, COM_CurrentApt());
811 ERR("called from wrong apartment, should have been 0x%s\n",
812 wine_dbgstr_longlong(This->oxid));
813 return RPC_E_WRONG_THREAD;
815 /* This situation should be impossible in multi-threaded apartments,
816 * because the calling thread isn't re-enterable.
817 * Note: doing a COM call during the processing of a sent message is
818 * only disallowed if a client call is already being waited for
820 if (!COM_CurrentApt()->multi_threaded &&
821 COM_CurrentInfo()->pending_call_count_client &&
824 ERR("can't make an outgoing COM call in response to a sent message\n");
825 return RPC_E_CANTCALLOUT_ININPUTSYNCCALL;
828 message_state = (struct message_state *)msg->Handle;
829 /* restore the binding handle and the real start of data */
830 msg->Handle = message_state->binding_handle;
831 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
832 msg->BufferLength += message_state->prefix_data_len;
834 /* Note: this is an optimization in the Microsoft OLE runtime that we need
835 * to copy, as shown by the test_no_couninitialize_client test. without
836 * short-circuiting the RPC runtime in the case below, the test will
837 * deadlock on the loader lock due to the RPC runtime needing to create
838 * a thread to process the RPC when this function is called indirectly
841 message_state->params.msg = olemsg;
842 if (message_state->params.bypass_rpcrt)
844 TRACE("Calling apartment thread 0x%08x...\n", message_state->target_tid);
846 msg->ProcNum &= ~RPC_FLAGS_VALID_BIT;
848 if (!PostMessageW(message_state->target_hwnd, DM_EXECUTERPC, 0,
849 (LPARAM)&message_state->params))
851 ERR("PostMessage failed with error %u\n", GetLastError());
853 /* Note: message_state->params.iface doesn't have a reference and
854 * so doesn't need to be released */
856 hr = HRESULT_FROM_WIN32(GetLastError());
861 /* we use a separate thread here because we need to be able to
862 * pump the message loop in the application thread: if we do not,
863 * any windows created by this thread will hang and RPCs that try
864 * and re-enter this STA from an incoming server thread will
865 * deadlock. InstallShield is an example of that.
867 if (!QueueUserWorkItem(rpc_sendreceive_thread, &message_state->params, WT_EXECUTEDEFAULT))
869 ERR("QueueUserWorkItem failed with error %u\n", GetLastError());
878 if (WaitForSingleObject(message_state->params.handle, 0))
880 COM_CurrentInfo()->pending_call_count_client++;
881 hr = CoWaitForMultipleHandles(0, INFINITE, 1, &message_state->params.handle, &index);
882 COM_CurrentInfo()->pending_call_count_client--;
885 ClientRpcChannelBuffer_ReleaseEventHandle(This, message_state->params.handle);
887 /* for WM shortcut, faults are returned in params->hr */
889 hrFault = message_state->params.hr;
891 status = message_state->params.status;
893 orpcthat.flags = ORPCF_NULL;
894 orpcthat.extensions = NULL;
896 TRACE("RPC call status: 0x%lx\n", status);
897 if (status != RPC_S_OK)
898 hr = HRESULT_FROM_WIN32(status);
900 TRACE("hrFault = 0x%08x\n", hrFault);
902 /* FIXME: this condition should be
903 * "hr == S_OK && (!hrFault || msg->BufferLength > FIELD_OFFSET(ORPCTHAT, extensions) + 4)"
904 * but we don't currently reset the message length for PostMessage
905 * dispatched calls */
906 if (hr == S_OK && hrFault == S_OK)
909 char *original_buffer = msg->Buffer;
911 /* handle ORPCTHAT and client extensions */
913 hr2 = unmarshal_ORPCTHAT(msg, &orpcthat, &orpc_ext_array, &first_wire_orpc_extent);
917 message_state->prefix_data_len = (char *)msg->Buffer - original_buffer;
918 msg->BufferLength -= message_state->prefix_data_len;
921 message_state->prefix_data_len = 0;
925 ChannelHooks_ClientNotify(&message_state->channel_hook_info,
926 msg->DataRepresentation,
927 first_wire_orpc_extent,
928 orpcthat.extensions && first_wire_orpc_extent ? orpcthat.extensions->size : 0,
932 /* save away the message state again */
933 msg->Handle = message_state;
935 if (pstatus) *pstatus = status;
940 TRACE("-- 0x%08x\n", hr);
945 static HRESULT WINAPI ServerRpcChannelBuffer_FreeBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg)
947 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
949 struct message_state *message_state;
951 TRACE("(%p)\n", msg);
953 message_state = (struct message_state *)msg->Handle;
954 /* restore the binding handle and the real start of data */
955 msg->Handle = message_state->binding_handle;
956 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
957 msg->BufferLength += message_state->prefix_data_len;
958 message_state->prefix_data_len = 0;
960 if (message_state->bypass_rpcrt)
962 HeapFree(GetProcessHeap(), 0, msg->Buffer);
966 status = I_RpcFreeBuffer(msg);
968 msg->Handle = message_state;
970 TRACE("-- %ld\n", status);
972 return HRESULT_FROM_WIN32(status);
975 static HRESULT WINAPI ClientRpcChannelBuffer_FreeBuffer(LPRPCCHANNELBUFFER iface, RPCOLEMESSAGE* olemsg)
977 RPC_MESSAGE *msg = (RPC_MESSAGE *)olemsg;
979 struct message_state *message_state;
981 TRACE("(%p)\n", msg);
983 message_state = (struct message_state *)msg->Handle;
984 /* restore the binding handle and the real start of data */
985 msg->Handle = message_state->binding_handle;
986 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
987 msg->BufferLength += message_state->prefix_data_len;
989 if (message_state->params.bypass_rpcrt)
991 HeapFree(GetProcessHeap(), 0, msg->Buffer);
995 status = I_RpcFreeBuffer(msg);
997 HeapFree(GetProcessHeap(), 0, msg->RpcInterfaceInformation);
998 msg->RpcInterfaceInformation = NULL;
1000 if (message_state->params.stub)
1001 IRpcStubBuffer_Release(message_state->params.stub);
1002 if (message_state->params.chan)
1003 IRpcChannelBuffer_Release(message_state->params.chan);
1004 HeapFree(GetProcessHeap(), 0, message_state);
1006 TRACE("-- %ld\n", status);
1008 return HRESULT_FROM_WIN32(status);
1011 static HRESULT WINAPI ClientRpcChannelBuffer_GetDestCtx(LPRPCCHANNELBUFFER iface, DWORD* pdwDestContext, void** ppvDestContext)
1013 ClientRpcChannelBuffer *This = (ClientRpcChannelBuffer *)iface;
1015 TRACE("(%p,%p)\n", pdwDestContext, ppvDestContext);
1017 *pdwDestContext = This->dest_context;
1018 *ppvDestContext = This->dest_context_data;
1023 static HRESULT WINAPI ServerRpcChannelBuffer_GetDestCtx(LPRPCCHANNELBUFFER iface, DWORD* pdwDestContext, void** ppvDestContext)
1025 WARN("(%p,%p), stub!\n", pdwDestContext, ppvDestContext);
1027 /* FIXME: implement this by storing the dwDestContext and pvDestContext
1028 * values passed into IMarshal_MarshalInterface and returning them here */
1029 *pdwDestContext = MSHCTX_DIFFERENTMACHINE;
1030 *ppvDestContext = NULL;
1034 static HRESULT WINAPI RpcChannelBuffer_IsConnected(LPRPCCHANNELBUFFER iface)
1037 /* native does nothing too */
1041 static const IRpcChannelBufferVtbl ClientRpcChannelBufferVtbl =
1043 RpcChannelBuffer_QueryInterface,
1044 RpcChannelBuffer_AddRef,
1045 ClientRpcChannelBuffer_Release,
1046 ClientRpcChannelBuffer_GetBuffer,
1047 ClientRpcChannelBuffer_SendReceive,
1048 ClientRpcChannelBuffer_FreeBuffer,
1049 ClientRpcChannelBuffer_GetDestCtx,
1050 RpcChannelBuffer_IsConnected
1053 static const IRpcChannelBufferVtbl ServerRpcChannelBufferVtbl =
1055 RpcChannelBuffer_QueryInterface,
1056 RpcChannelBuffer_AddRef,
1057 ServerRpcChannelBuffer_Release,
1058 ServerRpcChannelBuffer_GetBuffer,
1059 ServerRpcChannelBuffer_SendReceive,
1060 ServerRpcChannelBuffer_FreeBuffer,
1061 ServerRpcChannelBuffer_GetDestCtx,
1062 RpcChannelBuffer_IsConnected
1065 /* returns a channel buffer for proxies */
1066 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
1067 const OXID_INFO *oxid_info,
1068 DWORD dest_context, void *dest_context_data,
1069 IRpcChannelBuffer **chan)
1071 ClientRpcChannelBuffer *This;
1072 WCHAR endpoint[200];
1073 RPC_BINDING_HANDLE bind;
1075 LPWSTR string_binding;
1077 /* FIXME: get the endpoint from oxid_info->psa instead */
1078 get_rpc_endpoint(endpoint, oxid);
1080 TRACE("proxy pipe: connecting to endpoint: %s\n", debugstr_w(endpoint));
1082 status = RpcStringBindingComposeW(
1090 if (status == RPC_S_OK)
1092 status = RpcBindingFromStringBindingW(string_binding, &bind);
1094 if (status == RPC_S_OK)
1096 IPID ipid2 = *ipid; /* why can't RpcBindingSetObject take a const? */
1097 status = RpcBindingSetObject(bind, &ipid2);
1098 if (status != RPC_S_OK)
1099 RpcBindingFree(&bind);
1102 RpcStringFreeW(&string_binding);
1105 if (status != RPC_S_OK)
1107 ERR("Couldn't get binding for endpoint %s, status = %ld\n", debugstr_w(endpoint), status);
1108 return HRESULT_FROM_WIN32(status);
1111 This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
1114 RpcBindingFree(&bind);
1115 return E_OUTOFMEMORY;
1118 This->super.lpVtbl = &ClientRpcChannelBufferVtbl;
1119 This->super.refs = 1;
1121 apartment_getoxid(COM_CurrentApt(), &This->oxid);
1122 This->server_pid = oxid_info->dwPid;
1123 This->dest_context = dest_context;
1124 This->dest_context_data = dest_context_data;
1127 *chan = (IRpcChannelBuffer*)This;
1132 HRESULT RPC_CreateServerChannel(IRpcChannelBuffer **chan)
1134 RpcChannelBuffer *This = HeapAlloc(GetProcessHeap(), 0, sizeof(*This));
1136 return E_OUTOFMEMORY;
1138 This->lpVtbl = &ServerRpcChannelBufferVtbl;
1141 *chan = (IRpcChannelBuffer*)This;
1146 /* unmarshals ORPC_EXTENT_ARRAY according to NDR rules, but doesn't allocate
1148 static HRESULT unmarshal_ORPC_EXTENT_ARRAY(RPC_MESSAGE *msg, const char *end,
1149 ORPC_EXTENT_ARRAY *extensions,
1150 WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1155 memcpy(extensions, msg->Buffer, FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent));
1156 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPC_EXTENT_ARRAY, extent);
1158 if ((const char *)msg->Buffer + 2 * sizeof(DWORD) > end)
1159 return RPC_E_INVALID_HEADER;
1161 pointer_id = *(DWORD *)msg->Buffer;
1162 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1163 extensions->extent = NULL;
1167 WIRE_ORPC_EXTENT *wire_orpc_extent;
1170 if (*(DWORD *)msg->Buffer != ((extensions->size+1)&~1))
1171 return RPC_S_INVALID_BOUND;
1173 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1175 /* arbitrary limit for security (don't know what native does) */
1176 if (extensions->size > 256)
1178 ERR("too many extensions: %ld\n", extensions->size);
1179 return RPC_S_INVALID_BOUND;
1182 *first_wire_orpc_extent = wire_orpc_extent = (WIRE_ORPC_EXTENT *)msg->Buffer;
1183 for (i = 0; i < ((extensions->size+1)&~1); i++)
1185 if ((const char *)&wire_orpc_extent->data[0] > end)
1186 return RPC_S_INVALID_BOUND;
1187 if (wire_orpc_extent->conformance != ((wire_orpc_extent->size+7)&~7))
1188 return RPC_S_INVALID_BOUND;
1189 if ((const char *)&wire_orpc_extent->data[wire_orpc_extent->conformance] > end)
1190 return RPC_S_INVALID_BOUND;
1191 TRACE("size %u, guid %s\n", wire_orpc_extent->size, debugstr_guid(&wire_orpc_extent->id));
1192 wire_orpc_extent = (WIRE_ORPC_EXTENT *)&wire_orpc_extent->data[wire_orpc_extent->conformance];
1194 msg->Buffer = wire_orpc_extent;
1200 /* unmarshals ORPCTHIS according to NDR rules, but doesn't allocate any memory */
1201 static HRESULT unmarshal_ORPCTHIS(RPC_MESSAGE *msg, ORPCTHIS *orpcthis,
1202 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1204 const char *end = (char *)msg->Buffer + msg->BufferLength;
1206 *first_wire_orpc_extent = NULL;
1208 if (msg->BufferLength < FIELD_OFFSET(ORPCTHIS, extensions) + 4)
1210 ERR("invalid buffer length\n");
1211 return RPC_E_INVALID_HEADER;
1214 memcpy(orpcthis, msg->Buffer, FIELD_OFFSET(ORPCTHIS, extensions));
1215 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHIS, extensions);
1217 if ((const char *)msg->Buffer + sizeof(DWORD) > end)
1218 return RPC_E_INVALID_HEADER;
1220 if (*(DWORD *)msg->Buffer)
1221 orpcthis->extensions = orpc_ext_array;
1223 orpcthis->extensions = NULL;
1225 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1227 if (orpcthis->extensions)
1229 HRESULT hr = unmarshal_ORPC_EXTENT_ARRAY(msg, end, orpc_ext_array,
1230 first_wire_orpc_extent);
1235 if ((orpcthis->version.MajorVersion != COM_MAJOR_VERSION) ||
1236 (orpcthis->version.MinorVersion > COM_MINOR_VERSION))
1238 ERR("COM version {%d, %d} not supported\n",
1239 orpcthis->version.MajorVersion, orpcthis->version.MinorVersion);
1240 return RPC_E_VERSION_MISMATCH;
1243 if (orpcthis->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4))
1245 ERR("invalid flags 0x%lx\n", orpcthis->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4));
1246 return RPC_E_INVALID_HEADER;
1252 static HRESULT unmarshal_ORPCTHAT(RPC_MESSAGE *msg, ORPCTHAT *orpcthat,
1253 ORPC_EXTENT_ARRAY *orpc_ext_array, WIRE_ORPC_EXTENT **first_wire_orpc_extent)
1255 const char *end = (char *)msg->Buffer + msg->BufferLength;
1257 *first_wire_orpc_extent = NULL;
1259 if (msg->BufferLength < FIELD_OFFSET(ORPCTHAT, extensions) + 4)
1261 ERR("invalid buffer length\n");
1262 return RPC_E_INVALID_HEADER;
1265 memcpy(orpcthat, msg->Buffer, FIELD_OFFSET(ORPCTHAT, extensions));
1266 msg->Buffer = (char *)msg->Buffer + FIELD_OFFSET(ORPCTHAT, extensions);
1268 if ((const char *)msg->Buffer + sizeof(DWORD) > end)
1269 return RPC_E_INVALID_HEADER;
1271 if (*(DWORD *)msg->Buffer)
1272 orpcthat->extensions = orpc_ext_array;
1274 orpcthat->extensions = NULL;
1276 msg->Buffer = (char *)msg->Buffer + sizeof(DWORD);
1278 if (orpcthat->extensions)
1280 HRESULT hr = unmarshal_ORPC_EXTENT_ARRAY(msg, end, orpc_ext_array,
1281 first_wire_orpc_extent);
1286 if (orpcthat->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4))
1288 ERR("invalid flags 0x%lx\n", orpcthat->flags & ~(ORPCF_LOCAL|ORPCF_RESERVED1|ORPCF_RESERVED2|ORPCF_RESERVED3|ORPCF_RESERVED4));
1289 return RPC_E_INVALID_HEADER;
1295 void RPC_ExecuteCall(struct dispatch_params *params)
1297 struct message_state *message_state = NULL;
1298 RPC_MESSAGE *msg = (RPC_MESSAGE *)params->msg;
1299 char *original_buffer = msg->Buffer;
1301 ORPC_EXTENT_ARRAY orpc_ext_array;
1302 WIRE_ORPC_EXTENT *first_wire_orpc_extent;
1303 GUID old_causality_id;
1305 /* handle ORPCTHIS and server extensions */
1307 params->hr = unmarshal_ORPCTHIS(msg, &orpcthis, &orpc_ext_array, &first_wire_orpc_extent);
1308 if (params->hr != S_OK)
1310 msg->Buffer = original_buffer;
1314 message_state = HeapAlloc(GetProcessHeap(), 0, sizeof(*message_state));
1317 params->hr = E_OUTOFMEMORY;
1318 msg->Buffer = original_buffer;
1322 message_state->prefix_data_len = (char *)msg->Buffer - original_buffer;
1323 message_state->binding_handle = msg->Handle;
1324 message_state->bypass_rpcrt = params->bypass_rpcrt;
1326 message_state->channel_hook_info.iid = params->iid;
1327 message_state->channel_hook_info.cbSize = sizeof(message_state->channel_hook_info);
1328 message_state->channel_hook_info.uCausality = orpcthis.cid;
1329 message_state->channel_hook_info.dwServerPid = GetCurrentProcessId();
1330 message_state->channel_hook_info.iMethod = msg->ProcNum;
1331 message_state->channel_hook_info.pObject = params->iface;
1333 if (orpcthis.extensions && first_wire_orpc_extent &&
1334 orpcthis.extensions->size)
1335 ChannelHooks_ServerNotify(&message_state->channel_hook_info, msg->DataRepresentation, first_wire_orpc_extent, orpcthis.extensions->size);
1337 msg->Handle = message_state;
1338 msg->BufferLength -= message_state->prefix_data_len;
1340 /* call message filter */
1342 if (COM_CurrentApt()->filter)
1345 INTERFACEINFO interface_info;
1348 interface_info.pUnk = params->iface;
1349 interface_info.iid = params->iid;
1350 interface_info.wMethod = msg->ProcNum;
1352 if (IsEqualGUID(&orpcthis.cid, &COM_CurrentInfo()->causality_id))
1353 calltype = CALLTYPE_NESTED;
1354 else if (COM_CurrentInfo()->pending_call_count_server == 0)
1355 calltype = CALLTYPE_TOPLEVEL;
1357 calltype = CALLTYPE_TOPLEVEL_CALLPENDING;
1359 handlecall = IMessageFilter_HandleInComingCall(COM_CurrentApt()->filter,
1361 (HTASK)GetCurrentProcessId(),
1364 TRACE("IMessageFilter_HandleInComingCall returned %d\n", handlecall);
1367 case SERVERCALL_REJECTED:
1368 params->hr = RPC_E_CALL_REJECTED;
1369 goto exit_reset_state;
1370 case SERVERCALL_RETRYLATER:
1371 #if 0 /* FIXME: handle retries on the client side before enabling this code */
1372 params->hr = RPC_E_RETRY;
1373 goto exit_reset_state;
1375 FIXME("retry call later not implemented\n");
1378 case SERVERCALL_ISHANDLED:
1384 /* invoke the method */
1386 /* save the old causality ID - note: any calls executed while processing
1387 * messages received during the SendReceive will appear to originate from
1388 * this call - this should be checked with what Windows does */
1389 old_causality_id = COM_CurrentInfo()->causality_id;
1390 COM_CurrentInfo()->causality_id = orpcthis.cid;
1391 COM_CurrentInfo()->pending_call_count_server++;
1392 params->hr = IRpcStubBuffer_Invoke(params->stub, params->msg, params->chan);
1393 COM_CurrentInfo()->pending_call_count_server--;
1394 COM_CurrentInfo()->causality_id = old_causality_id;
1396 /* the invoke allocated a new buffer, so free the old one */
1397 if (message_state->bypass_rpcrt && original_buffer != msg->Buffer)
1398 HeapFree(GetProcessHeap(), 0, original_buffer);
1401 message_state = (struct message_state *)msg->Handle;
1402 msg->Handle = message_state->binding_handle;
1403 msg->Buffer = (char *)msg->Buffer - message_state->prefix_data_len;
1404 msg->BufferLength += message_state->prefix_data_len;
1407 HeapFree(GetProcessHeap(), 0, message_state);
1408 if (params->handle) SetEvent(params->handle);
1411 static void __RPC_STUB dispatch_rpc(RPC_MESSAGE *msg)
1413 struct dispatch_params *params;
1418 RpcBindingInqObject(msg->Handle, &ipid);
1420 TRACE("ipid = %s, iMethod = %d\n", debugstr_guid(&ipid), msg->ProcNum);
1422 params = HeapAlloc(GetProcessHeap(), 0, sizeof(*params));
1425 RpcRaiseException(E_OUTOFMEMORY);
1429 hr = ipid_get_dispatch_params(&ipid, &apt, ¶ms->stub, ¶ms->chan,
1430 ¶ms->iid, ¶ms->iface);
1433 ERR("no apartment found for ipid %s\n", debugstr_guid(&ipid));
1434 HeapFree(GetProcessHeap(), 0, params);
1435 RpcRaiseException(hr);
1439 params->msg = (RPCOLEMESSAGE *)msg;
1440 params->status = RPC_S_OK;
1442 params->handle = NULL;
1443 params->bypass_rpcrt = FALSE;
1445 /* Note: this is the important difference between STAs and MTAs - we
1446 * always execute RPCs to STAs in the thread that originally created the
1447 * apartment (i.e. the one that pumps messages to the window) */
1448 if (!apt->multi_threaded)
1450 params->handle = CreateEventW(NULL, FALSE, FALSE, NULL);
1452 TRACE("Calling apartment thread 0x%08x...\n", apt->tid);
1454 if (PostMessageW(apartment_getwindow(apt), DM_EXECUTERPC, 0, (LPARAM)params))
1455 WaitForSingleObject(params->handle, INFINITE);
1458 ERR("PostMessage failed with error %u\n", GetLastError());
1459 IRpcChannelBuffer_Release(params->chan);
1460 IRpcStubBuffer_Release(params->stub);
1462 CloseHandle(params->handle);
1466 BOOL joined = FALSE;
1467 if (!COM_CurrentInfo()->apt)
1469 apartment_joinmta();
1472 RPC_ExecuteCall(params);
1475 apartment_release(COM_CurrentInfo()->apt);
1476 COM_CurrentInfo()->apt = NULL;
1482 IRpcChannelBuffer_Release(params->chan);
1484 IRpcStubBuffer_Release(params->stub);
1485 HeapFree(GetProcessHeap(), 0, params);
1487 apartment_release(apt);
1489 /* if IRpcStubBuffer_Invoke fails, we should raise an exception to tell
1490 * the RPC runtime that the call failed */
1491 if (hr) RpcRaiseException(hr);
1494 /* stub registration */
1495 HRESULT RPC_RegisterInterface(REFIID riid)
1497 struct registered_if *rif;
1501 TRACE("(%s)\n", debugstr_guid(riid));
1503 EnterCriticalSection(&csRegIf);
1504 LIST_FOR_EACH_ENTRY(rif, ®istered_interfaces, struct registered_if, entry)
1506 if (IsEqualGUID(&rif->If.InterfaceId.SyntaxGUID, riid))
1515 TRACE("Creating new interface\n");
1517 rif = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*rif));
1523 rif->If.Length = sizeof(RPC_SERVER_INTERFACE);
1524 /* RPC interface ID = COM interface ID */
1525 rif->If.InterfaceId.SyntaxGUID = *riid;
1526 rif->If.DispatchTable = &rpc_dispatch;
1527 /* all other fields are 0, including the version asCOM objects
1528 * always have a version of 0.0 */
1529 status = RpcServerRegisterIfEx(
1530 (RPC_IF_HANDLE)&rif->If,
1532 RPC_IF_OLE | RPC_IF_AUTOLISTEN,
1533 RPC_C_LISTEN_MAX_CALLS_DEFAULT,
1535 if (status == RPC_S_OK)
1536 list_add_tail(®istered_interfaces, &rif->entry);
1539 ERR("RpcServerRegisterIfEx failed with error %ld\n", status);
1540 HeapFree(GetProcessHeap(), 0, rif);
1541 hr = HRESULT_FROM_WIN32(status);
1547 LeaveCriticalSection(&csRegIf);
1551 /* stub unregistration */
1552 void RPC_UnregisterInterface(REFIID riid)
1554 struct registered_if *rif;
1555 EnterCriticalSection(&csRegIf);
1556 LIST_FOR_EACH_ENTRY(rif, ®istered_interfaces, struct registered_if, entry)
1558 if (IsEqualGUID(&rif->If.InterfaceId.SyntaxGUID, riid))
1562 RpcServerUnregisterIf((RPC_IF_HANDLE)&rif->If, NULL, TRUE);
1563 list_remove(&rif->entry);
1564 HeapFree(GetProcessHeap(), 0, rif);
1569 LeaveCriticalSection(&csRegIf);
1572 /* get the info for an OXID, including the IPID for the rem unknown interface
1573 * and the string binding */
1574 HRESULT RPC_ResolveOxid(OXID oxid, OXID_INFO *oxid_info)
1576 TRACE("%s\n", wine_dbgstr_longlong(oxid));
1578 oxid_info->dwTid = 0;
1579 oxid_info->dwPid = 0;
1580 oxid_info->dwAuthnHint = RPC_C_AUTHN_LEVEL_NONE;
1581 /* FIXME: this is a hack around not having an OXID resolver yet -
1582 * this function should contact the machine's OXID resolver and then it
1583 * should give us the IPID of the IRemUnknown interface */
1584 oxid_info->ipidRemUnknown.Data1 = 0xffffffff;
1585 oxid_info->ipidRemUnknown.Data2 = 0xffff;
1586 oxid_info->ipidRemUnknown.Data3 = 0xffff;
1587 memcpy(oxid_info->ipidRemUnknown.Data4, &oxid, sizeof(OXID));
1588 oxid_info->psa = NULL /* FIXME */;
1593 /* make the apartment reachable by other threads and processes and create the
1594 * IRemUnknown object */
1595 void RPC_StartRemoting(struct apartment *apt)
1597 if (!InterlockedExchange(&apt->remoting_started, TRUE))
1599 WCHAR endpoint[200];
1602 get_rpc_endpoint(endpoint, &apt->oxid);
1604 status = RpcServerUseProtseqEpW(
1606 RPC_C_PROTSEQ_MAX_REQS_DEFAULT,
1609 if (status != RPC_S_OK)
1610 ERR("Couldn't register endpoint %s\n", debugstr_w(endpoint));
1612 /* FIXME: move remote unknown exporting into this function */
1614 start_apartment_remote_unknown();
1618 static HRESULT create_server(REFCLSID rclsid)
1620 static const WCHAR wszLocalServer32[] = { 'L','o','c','a','l','S','e','r','v','e','r','3','2',0 };
1621 static const WCHAR embedding[] = { ' ', '-','E','m','b','e','d','d','i','n','g',0 };
1624 WCHAR command[MAX_PATH+sizeof(embedding)/sizeof(WCHAR)];
1625 DWORD size = (MAX_PATH+1) * sizeof(WCHAR);
1627 PROCESS_INFORMATION pinfo;
1629 hres = COM_OpenKeyForCLSID(rclsid, wszLocalServer32, KEY_READ, &key);
1631 ERR("class %s not registered\n", debugstr_guid(rclsid));
1635 hres = RegQueryValueExW(key, NULL, NULL, NULL, (LPBYTE)command, &size);
1638 WARN("No default value for LocalServer32 key\n");
1639 return REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1642 memset(&sinfo,0,sizeof(sinfo));
1643 sinfo.cb = sizeof(sinfo);
1645 /* EXE servers are started with the -Embedding switch. */
1647 strcatW(command, embedding);
1649 TRACE("activating local server %s for %s\n", debugstr_w(command), debugstr_guid(rclsid));
1651 /* FIXME: Win2003 supports a ServerExecutable value that is passed into
1653 if (!CreateProcessW(NULL, command, NULL, NULL, FALSE, 0, NULL, NULL, &sinfo, &pinfo)) {
1654 WARN("failed to run local server %s\n", debugstr_w(command));
1655 return HRESULT_FROM_WIN32(GetLastError());
1657 CloseHandle(pinfo.hProcess);
1658 CloseHandle(pinfo.hThread);
1664 * start_local_service() - start a service given its name and parameters
1666 static DWORD start_local_service(LPCWSTR name, DWORD num, LPCWSTR *params)
1668 SC_HANDLE handle, hsvc;
1669 DWORD r = ERROR_FUNCTION_FAILED;
1671 TRACE("Starting service %s %d params\n", debugstr_w(name), num);
1673 handle = OpenSCManagerW(NULL, NULL, SC_MANAGER_CONNECT);
1676 hsvc = OpenServiceW(handle, name, SERVICE_START);
1679 if(StartServiceW(hsvc, num, params))
1683 if (r == ERROR_SERVICE_ALREADY_RUNNING)
1685 CloseServiceHandle(hsvc);
1689 CloseServiceHandle(handle);
1691 TRACE("StartService returned error %u (%s)\n", r, (r == ERROR_SUCCESS) ? "ok":"failed");
1697 * create_local_service() - start a COM server in a service
1699 * To start a Local Service, we read the AppID value under
1700 * the class's CLSID key, then open the HKCR\\AppId key specified
1701 * there and check for a LocalService value.
1703 * Note: Local Services are not supported under Windows 9x
1705 static HRESULT create_local_service(REFCLSID rclsid)
1708 WCHAR buf[CHARS_IN_GUID];
1709 static const WCHAR szLocalService[] = { 'L','o','c','a','l','S','e','r','v','i','c','e',0 };
1710 static const WCHAR szServiceParams[] = {'S','e','r','v','i','c','e','P','a','r','a','m','s',0};
1715 TRACE("Attempting to start Local service for %s\n", debugstr_guid(rclsid));
1717 hres = COM_OpenKeyForAppIdFromCLSID(rclsid, KEY_READ, &hkey);
1721 /* read the LocalService and ServiceParameters values from the AppID key */
1723 r = RegQueryValueExW(hkey, szLocalService, NULL, &type, (LPBYTE)buf, &sz);
1724 if (r==ERROR_SUCCESS && type==REG_SZ)
1727 LPWSTR args[1] = { NULL };
1730 * FIXME: I'm not really sure how to deal with the service parameters.
1731 * I suspect that the string returned from RegQueryValueExW
1732 * should be split into a number of arguments by spaces.
1733 * It would make more sense if ServiceParams contained a
1734 * REG_MULTI_SZ here, but it's a REG_SZ for the services
1735 * that I'm interested in for the moment.
1737 r = RegQueryValueExW(hkey, szServiceParams, NULL, &type, NULL, &sz);
1738 if (r == ERROR_SUCCESS && type == REG_SZ && sz)
1740 args[0] = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sz);
1742 RegQueryValueExW(hkey, szServiceParams, NULL, &type, (LPBYTE)args[0], &sz);
1744 r = start_local_service(buf, num_args, (LPCWSTR *)args);
1745 if (r != ERROR_SUCCESS)
1746 hres = REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1747 HeapFree(GetProcessHeap(),0,args[0]);
1751 WARN("No LocalService value\n");
1752 hres = REGDB_E_CLASSNOTREG; /* FIXME: check retval */
1760 static void get_localserver_pipe_name(WCHAR *pipefn, REFCLSID rclsid)
1762 static const WCHAR wszPipeRef[] = {'\\','\\','.','\\','p','i','p','e','\\',0};
1763 strcpyW(pipefn, wszPipeRef);
1764 StringFromGUID2(rclsid, pipefn + sizeof(wszPipeRef)/sizeof(wszPipeRef[0]) - 1, CHARS_IN_GUID);
1767 /* FIXME: should call to rpcss instead */
1768 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv)
1773 DWORD res, bufferlen;
1774 char marshalbuffer[200];
1776 LARGE_INTEGER seekto;
1777 ULARGE_INTEGER newpos;
1780 static const int MAXTRIES = 30; /* 30 seconds */
1782 TRACE("rclsid=%s, iid=%s\n", debugstr_guid(rclsid), debugstr_guid(iid));
1784 get_localserver_pipe_name(pipefn, rclsid);
1786 while (tries++ < MAXTRIES) {
1787 TRACE("waiting for %s\n", debugstr_w(pipefn));
1789 WaitNamedPipeW( pipefn, NMPWAIT_WAIT_FOREVER );
1790 hPipe = CreateFileW(pipefn, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, 0);
1791 if (hPipe == INVALID_HANDLE_VALUE) {
1795 if ( (hres = create_local_service(rclsid)) &&
1796 (hres = create_server(rclsid)) )
1799 WARN("Connecting to %s, no response yet, retrying: le is %u\n", debugstr_w(pipefn), GetLastError());
1801 /* wait for one second, even if messages arrive */
1802 start_ticks = GetTickCount();
1804 CoWaitForMultipleHandles(0, 1000, 0, NULL, &index);
1805 } while (GetTickCount() - start_ticks < 1000);
1809 if (!ReadFile(hPipe,marshalbuffer,sizeof(marshalbuffer),&bufferlen,NULL)) {
1810 FIXME("Failed to read marshal id from classfactory of %s.\n",debugstr_guid(rclsid));
1814 TRACE("read marshal id from pipe\n");
1819 if (tries >= MAXTRIES)
1820 return E_NOINTERFACE;
1822 hres = CreateStreamOnHGlobal(0,TRUE,&pStm);
1823 if (hres) return hres;
1824 hres = IStream_Write(pStm,marshalbuffer,bufferlen,&res);
1826 seekto.u.LowPart = 0;seekto.u.HighPart = 0;
1827 hres = IStream_Seek(pStm,seekto,STREAM_SEEK_SET,&newpos);
1829 TRACE("unmarshalling classfactory\n");
1830 hres = CoUnmarshalInterface(pStm,&IID_IClassFactory,ppv);
1832 IStream_Release(pStm);
1837 struct local_server_params
1847 /* FIXME: should call to rpcss instead */
1848 static DWORD WINAPI local_server_thread(LPVOID param)
1850 struct local_server_params * lsp = (struct local_server_params *)param;
1854 IStream *pStm = lsp->stream;
1856 unsigned char *buffer;
1858 LARGE_INTEGER seekto;
1859 ULARGE_INTEGER newpos;
1861 BOOL multi_use = lsp->multi_use;
1865 TRACE("Starting threader for %s.\n",debugstr_guid(&lsp->clsid));
1867 memset(&ovl, 0, sizeof(ovl));
1868 get_localserver_pipe_name(pipefn, &lsp->clsid);
1870 hPipe = CreateNamedPipeW( pipefn, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
1871 PIPE_TYPE_BYTE|PIPE_WAIT, PIPE_UNLIMITED_INSTANCES,
1872 4096, 4096, 500 /* 0.5 second timeout */, NULL );
1874 SetEvent(lsp->ready_event);
1876 if (hPipe == INVALID_HANDLE_VALUE)
1878 FIXME("pipe creation failed for %s, le is %u\n", debugstr_w(pipefn), GetLastError());
1882 ovl.hEvent = pipe_event = CreateEventW(NULL, FALSE, FALSE, NULL);
1885 if (!ConnectNamedPipe(hPipe, &ovl))
1887 DWORD error = GetLastError();
1888 if (error == ERROR_IO_PENDING)
1890 HANDLE handles[2] = { pipe_event, lsp->stop_event };
1892 ret = WaitForMultipleObjects(2, handles, FALSE, INFINITE);
1893 if (ret != WAIT_OBJECT_0)
1896 /* client already connected isn't an error */
1897 else if (error != ERROR_PIPE_CONNECTED)
1899 ERR("ConnectNamedPipe failed with error %d\n", GetLastError());
1904 TRACE("marshalling IClassFactory to client\n");
1906 hres = IStream_Stat(pStm,&ststg,0);
1907 if (hres) return hres;
1909 seekto.u.LowPart = 0;
1910 seekto.u.HighPart = 0;
1911 hres = IStream_Seek(pStm,seekto,STREAM_SEEK_SET,&newpos);
1913 FIXME("IStream_Seek failed, %x\n",hres);
1915 CloseHandle(pipe_event);
1919 buflen = ststg.cbSize.u.LowPart;
1920 buffer = HeapAlloc(GetProcessHeap(),0,buflen);
1922 hres = IStream_Read(pStm,buffer,buflen,&res);
1924 FIXME("Stream Read failed, %x\n",hres);
1926 CloseHandle(pipe_event);
1927 HeapFree(GetProcessHeap(),0,buffer);
1931 WriteFile(hPipe,buffer,buflen,&res,&ovl);
1932 GetOverlappedResult(hPipe, &ovl, NULL, TRUE);
1933 HeapFree(GetProcessHeap(),0,buffer);
1935 FlushFileBuffers(hPipe);
1936 DisconnectNamedPipe(hPipe);
1938 TRACE("done marshalling IClassFactory\n");
1942 TRACE("single use object, shutting down pipe %s\n", debugstr_w(pipefn));
1947 CloseHandle(pipe_event);
1951 /* starts listening for a local server */
1952 HRESULT RPC_StartLocalServer(REFCLSID clsid, IStream *stream, BOOL multi_use, void **registration)
1955 struct local_server_params *lsp;
1957 lsp = HeapAlloc(GetProcessHeap(), 0, sizeof(*lsp));
1959 return E_OUTOFMEMORY;
1961 lsp->clsid = *clsid;
1962 lsp->stream = stream;
1963 IStream_AddRef(stream);
1964 lsp->ready_event = CreateEventW(NULL, FALSE, FALSE, NULL);
1965 if (!lsp->ready_event)
1967 HeapFree(GetProcessHeap(), 0, lsp);
1968 return HRESULT_FROM_WIN32(GetLastError());
1970 lsp->stop_event = CreateEventW(NULL, FALSE, FALSE, NULL);
1971 if (!lsp->stop_event)
1973 CloseHandle(lsp->ready_event);
1974 HeapFree(GetProcessHeap(), 0, lsp);
1975 return HRESULT_FROM_WIN32(GetLastError());
1977 lsp->multi_use = multi_use;
1979 lsp->thread = CreateThread(NULL, 0, local_server_thread, lsp, 0, &tid);
1982 CloseHandle(lsp->ready_event);
1983 CloseHandle(lsp->stop_event);
1984 HeapFree(GetProcessHeap(), 0, lsp);
1985 return HRESULT_FROM_WIN32(GetLastError());
1988 WaitForSingleObject(lsp->ready_event, INFINITE);
1989 CloseHandle(lsp->ready_event);
1990 lsp->ready_event = NULL;
1992 *registration = lsp;
1996 /* stops listening for a local server */
1997 void RPC_StopLocalServer(void *registration)
1999 struct local_server_params *lsp = registration;
2001 /* signal local_server_thread to stop */
2002 SetEvent(lsp->stop_event);
2003 /* wait for it to exit */
2004 WaitForSingleObject(lsp->thread, INFINITE);
2006 IStream_Release(lsp->stream);
2007 CloseHandle(lsp->stop_event);
2008 CloseHandle(lsp->thread);
2009 HeapFree(GetProcessHeap(), 0, lsp);