2 * NDR -Oi,-Oif,-Oicf Interpreter
4 * Copyright 2001 Ove Kåven, TransGaming Technologies
5 * Copyright 2003-5 Robert Shearman (for CodeWeavers)
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 * - Some types of binding handles
27 #include "wine/port.h"
41 #include "wine/exception.h"
42 #include "wine/debug.h"
43 #include "wine/rpcfc.h"
47 #include "ndr_stubless.h"
49 WINE_DEFAULT_DEBUG_CHANNEL(rpc);
51 #define NDR_TABLE_MASK 127
53 static inline void call_buffer_sizer(PMIDL_STUB_MESSAGE pStubMsg, unsigned char *pMemory, PFORMAT_STRING pFormat)
55 NDR_BUFFERSIZE m = NdrBufferSizer[pFormat[0] & NDR_TABLE_MASK];
56 if (m) m(pStubMsg, pMemory, pFormat);
59 FIXME("format type 0x%x not implemented\n", pFormat[0]);
60 RpcRaiseException(RPC_X_BAD_STUB_DATA);
64 static inline unsigned char *call_marshaller(PMIDL_STUB_MESSAGE pStubMsg, unsigned char *pMemory, PFORMAT_STRING pFormat)
66 NDR_MARSHALL m = NdrMarshaller[pFormat[0] & NDR_TABLE_MASK];
67 if (m) return m(pStubMsg, pMemory, pFormat);
70 FIXME("format type 0x%x not implemented\n", pFormat[0]);
71 RpcRaiseException(RPC_X_BAD_STUB_DATA);
76 static inline unsigned char *call_unmarshaller(PMIDL_STUB_MESSAGE pStubMsg, unsigned char **ppMemory, PFORMAT_STRING pFormat, unsigned char fMustAlloc)
78 NDR_UNMARSHALL m = NdrUnmarshaller[pFormat[0] & NDR_TABLE_MASK];
79 if (m) return m(pStubMsg, ppMemory, pFormat, fMustAlloc);
82 FIXME("format type 0x%x not implemented\n", pFormat[0]);
83 RpcRaiseException(RPC_X_BAD_STUB_DATA);
88 static inline void call_freer(PMIDL_STUB_MESSAGE pStubMsg, unsigned char *pMemory, PFORMAT_STRING pFormat)
90 NDR_FREE m = NdrFreer[pFormat[0] & NDR_TABLE_MASK];
91 if (m) m(pStubMsg, pMemory, pFormat);
94 #define STUBLESS_UNMARSHAL 1
95 #define STUBLESS_INITOUT 2
96 #define STUBLESS_CALLSERVER 3
97 #define STUBLESS_CALCSIZE 4
98 #define STUBLESS_GETBUFFER 5
99 #define STUBLESS_MARSHAL 6
100 #define STUBLESS_FREE 7
102 void WINAPI NdrRpcSmSetClientToOsf(PMIDL_STUB_MESSAGE pMessage)
104 #if 0 /* these functions are not defined yet */
105 pMessage->pfnAllocate = NdrRpcSmClientAllocate;
106 pMessage->pfnFree = NdrRpcSmClientFree;
110 static void dump_RPC_FC_PROC_PF(PARAM_ATTRIBUTES param_attributes)
112 if (param_attributes.MustSize) TRACE(" MustSize");
113 if (param_attributes.MustFree) TRACE(" MustFree");
114 if (param_attributes.IsPipe) TRACE(" IsPipe");
115 if (param_attributes.IsIn) TRACE(" IsIn");
116 if (param_attributes.IsOut) TRACE(" IsOut");
117 if (param_attributes.IsReturn) TRACE(" IsReturn");
118 if (param_attributes.IsBasetype) TRACE(" IsBasetype");
119 if (param_attributes.IsByValue) TRACE(" IsByValue");
120 if (param_attributes.IsSimpleRef) TRACE(" IsSimpleRef");
121 if (param_attributes.IsDontCallFreeInst) TRACE(" IsDontCallFreeInst");
122 if (param_attributes.SaveForAsyncFinish) TRACE(" SaveForAsyncFinish");
123 if (param_attributes.ServerAllocSize) TRACE(" ServerAllocSize = %d", param_attributes.ServerAllocSize * 8);
126 static void dump_INTERPRETER_OPT_FLAGS(INTERPRETER_OPT_FLAGS Oi2Flags)
128 if (Oi2Flags.ServerMustSize) TRACE(" ServerMustSize");
129 if (Oi2Flags.ClientMustSize) TRACE(" ClientMustSize");
130 if (Oi2Flags.HasReturn) TRACE(" HasReturn");
131 if (Oi2Flags.HasPipes) TRACE(" HasPipes");
132 if (Oi2Flags.Unused) TRACE(" Unused");
133 if (Oi2Flags.HasAsyncUuid) TRACE(" HasAsyncUuid");
134 if (Oi2Flags.HasExtensions) TRACE(" HasExtensions");
135 if (Oi2Flags.HasAsyncHandle) TRACE(" HasAsyncHandle");
139 #define ARG_FROM_OFFSET(args, offset) ((args) + (offset))
141 static PFORMAT_STRING client_get_handle(
142 PMIDL_STUB_MESSAGE pStubMsg, const NDR_PROC_HEADER *pProcHeader,
143 PFORMAT_STRING pFormat, handle_t *phBinding)
146 switch (pProcHeader->handle_type)
148 /* explicit binding: parse additional section */
149 case RPC_FC_BIND_EXPLICIT:
150 switch (*pFormat) /* handle_type */
152 case RPC_FC_BIND_PRIMITIVE: /* explicit primitive */
154 const NDR_EHD_PRIMITIVE *pDesc = (const NDR_EHD_PRIMITIVE *)pFormat;
156 TRACE("Explicit primitive handle @ %d\n", pDesc->offset);
158 if (pDesc->flag) /* pointer to binding */
159 *phBinding = **(handle_t **)ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
161 *phBinding = *(handle_t *)ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
162 return pFormat + sizeof(NDR_EHD_PRIMITIVE);
164 case RPC_FC_BIND_GENERIC: /* explicit generic */
166 const NDR_EHD_GENERIC *pDesc = (const NDR_EHD_GENERIC *)pFormat;
167 void *pObject = NULL;
169 const GENERIC_BINDING_ROUTINE_PAIR *pGenPair;
171 TRACE("Explicit generic binding handle #%d\n", pDesc->binding_routine_pair_index);
173 if (pDesc->flag_and_size & HANDLE_PARAM_IS_VIA_PTR)
174 pArg = *(void **)ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
176 pArg = ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
177 memcpy(&pObject, pArg, pDesc->flag_and_size & 0xf);
178 pGenPair = &pStubMsg->StubDesc->aGenericBindingRoutinePairs[pDesc->binding_routine_pair_index];
179 *phBinding = pGenPair->pfnBind(pObject);
180 return pFormat + sizeof(NDR_EHD_GENERIC);
182 case RPC_FC_BIND_CONTEXT: /* explicit context */
184 const NDR_EHD_CONTEXT *pDesc = (const NDR_EHD_CONTEXT *)pFormat;
185 NDR_CCONTEXT context_handle;
186 TRACE("Explicit bind context\n");
187 if (pDesc->flags & HANDLE_PARAM_IS_VIA_PTR)
189 TRACE("\tHANDLE_PARAM_IS_VIA_PTR\n");
190 context_handle = **(NDR_CCONTEXT **)ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
193 context_handle = *(NDR_CCONTEXT *)ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
194 if ((pDesc->flags & NDR_CONTEXT_HANDLE_CANNOT_BE_NULL) &&
197 ERR("null context handle isn't allowed\n");
198 RpcRaiseException(RPC_X_SS_IN_NULL_CONTEXT);
201 *phBinding = NDRCContextBinding(context_handle);
202 /* FIXME: should we store this structure in stubMsg.pContext? */
203 return pFormat + sizeof(NDR_EHD_CONTEXT);
206 ERR("bad explicit binding handle type (0x%02x)\n", pProcHeader->handle_type);
207 RpcRaiseException(RPC_X_BAD_STUB_DATA);
210 case RPC_FC_BIND_GENERIC: /* implicit generic */
211 FIXME("RPC_FC_BIND_GENERIC\n");
212 RpcRaiseException(RPC_X_BAD_STUB_DATA); /* FIXME: remove when implemented */
214 case RPC_FC_BIND_PRIMITIVE: /* implicit primitive */
215 TRACE("Implicit primitive handle\n");
216 *phBinding = *pStubMsg->StubDesc->IMPLICIT_HANDLE_INFO.pPrimitiveHandle;
218 case RPC_FC_CALLBACK_HANDLE: /* implicit callback */
219 FIXME("RPC_FC_CALLBACK_HANDLE\n");
221 case RPC_FC_AUTO_HANDLE: /* implicit auto handle */
222 /* strictly speaking, it isn't necessary to set hBinding here
223 * since it isn't actually used (hence the automatic in its name),
224 * but then why does MIDL generate a valid entry in the
225 * MIDL_STUB_DESC for it? */
226 TRACE("Implicit auto handle\n");
227 *phBinding = *pStubMsg->StubDesc->IMPLICIT_HANDLE_INFO.pAutoHandle;
230 ERR("bad implicit binding handle type (0x%02x)\n", pProcHeader->handle_type);
231 RpcRaiseException(RPC_X_BAD_STUB_DATA);
236 static void client_free_handle(
237 PMIDL_STUB_MESSAGE pStubMsg, const NDR_PROC_HEADER *pProcHeader,
238 PFORMAT_STRING pFormat, handle_t hBinding)
241 switch (pProcHeader->handle_type)
243 /* explicit binding: parse additional section */
244 case RPC_FC_BIND_EXPLICIT:
245 switch (*pFormat) /* handle_type */
247 case RPC_FC_BIND_GENERIC: /* explicit generic */
249 const NDR_EHD_GENERIC *pDesc = (const NDR_EHD_GENERIC *)pFormat;
250 void *pObject = NULL;
252 const GENERIC_BINDING_ROUTINE_PAIR *pGenPair;
254 TRACE("Explicit generic binding handle #%d\n", pDesc->binding_routine_pair_index);
256 if (pDesc->flag_and_size & HANDLE_PARAM_IS_VIA_PTR)
257 pArg = *(void **)ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
259 pArg = ARG_FROM_OFFSET(pStubMsg->StackTop, pDesc->offset);
260 memcpy(&pObject, pArg, pDesc->flag_and_size & 0xf);
261 pGenPair = &pStubMsg->StubDesc->aGenericBindingRoutinePairs[pDesc->binding_routine_pair_index];
262 pGenPair->pfnUnbind(pObject, hBinding);
265 case RPC_FC_BIND_CONTEXT: /* explicit context */
266 case RPC_FC_BIND_PRIMITIVE: /* explicit primitive */
269 ERR("bad explicit binding handle type (0x%02x)\n", pProcHeader->handle_type);
270 RpcRaiseException(RPC_X_BAD_STUB_DATA);
273 case RPC_FC_BIND_GENERIC: /* implicit generic */
274 FIXME("RPC_FC_BIND_GENERIC\n");
275 RpcRaiseException(RPC_X_BAD_STUB_DATA); /* FIXME: remove when implemented */
277 case RPC_FC_CALLBACK_HANDLE: /* implicit callback */
278 case RPC_FC_BIND_PRIMITIVE: /* implicit primitive */
279 case RPC_FC_AUTO_HANDLE: /* implicit auto handle */
282 ERR("bad implicit binding handle type (0x%02x)\n", pProcHeader->handle_type);
283 RpcRaiseException(RPC_X_BAD_STUB_DATA);
287 static void client_do_args(PMIDL_STUB_MESSAGE pStubMsg, PFORMAT_STRING pFormat,
288 int phase, unsigned char *args, unsigned short number_of_params,
289 unsigned char *pRetVal)
291 /* current format string offset */
292 int current_offset = 0;
293 /* current stack offset */
294 unsigned short current_stack_offset = 0;
298 for (i = 0; i < number_of_params; i++)
300 const NDR_PARAM_OIF_BASETYPE *pParam =
301 (const NDR_PARAM_OIF_BASETYPE *)&pFormat[current_offset];
302 unsigned char * pArg;
304 current_stack_offset = pParam->stack_offset;
305 pArg = ARG_FROM_OFFSET(args, current_stack_offset);
307 TRACE("param[%d]: new format\n", i);
308 TRACE("\tparam_attributes:"); dump_RPC_FC_PROC_PF(pParam->param_attributes); TRACE("\n");
309 TRACE("\tstack_offset: 0x%x\n", current_stack_offset);
310 TRACE("\tmemory addr (before): %p\n", pArg);
312 if (pParam->param_attributes.IsBasetype)
314 const unsigned char * pTypeFormat =
315 &pParam->type_format_char;
317 if (pParam->param_attributes.IsSimpleRef)
318 pArg = *(unsigned char **)pArg;
320 TRACE("\tbase type: 0x%02x\n", *pTypeFormat);
325 if (pParam->param_attributes.IsIn)
326 call_buffer_sizer(pStubMsg, pArg, pTypeFormat);
329 if (pParam->param_attributes.IsIn)
330 call_marshaller(pStubMsg, pArg, pTypeFormat);
332 case PROXY_UNMARSHAL:
333 if (pParam->param_attributes.IsOut)
335 if (pParam->param_attributes.IsReturn)
336 call_unmarshaller(pStubMsg, &pRetVal, pTypeFormat, 0);
338 call_unmarshaller(pStubMsg, &pArg, pTypeFormat, 0);
339 TRACE("pRetVal = %p\n", pRetVal);
343 RpcRaiseException(RPC_S_INTERNAL_ERROR);
346 current_offset += sizeof(NDR_PARAM_OIF_BASETYPE);
350 const NDR_PARAM_OIF_OTHER *pParamOther =
351 (const NDR_PARAM_OIF_OTHER *)&pFormat[current_offset];
353 const unsigned char * pTypeFormat =
354 &(pStubMsg->StubDesc->pFormatTypes[pParamOther->type_offset]);
356 /* if a simple ref pointer then we have to do the
357 * check for the pointer being non-NULL. */
358 if (pParam->param_attributes.IsSimpleRef)
360 if (!*(unsigned char **)pArg)
361 RpcRaiseException(RPC_X_NULL_REF_POINTER);
364 TRACE("\tcomplex type: 0x%02x\n", *pTypeFormat);
369 if (pParam->param_attributes.IsIn)
371 if (pParam->param_attributes.IsByValue)
372 call_buffer_sizer(pStubMsg, pArg, pTypeFormat);
374 call_buffer_sizer(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
378 if (pParam->param_attributes.IsIn)
380 if (pParam->param_attributes.IsByValue)
381 call_marshaller(pStubMsg, pArg, pTypeFormat);
383 call_marshaller(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
386 case PROXY_UNMARSHAL:
387 if (pParam->param_attributes.IsOut)
389 if (pParam->param_attributes.IsReturn)
390 call_unmarshaller(pStubMsg, &pRetVal, pTypeFormat, 0);
391 else if (pParam->param_attributes.IsByValue)
392 call_unmarshaller(pStubMsg, &pArg, pTypeFormat, 0);
394 call_unmarshaller(pStubMsg, (unsigned char **)pArg, pTypeFormat, 0);
398 RpcRaiseException(RPC_S_INTERNAL_ERROR);
401 current_offset += sizeof(NDR_PARAM_OIF_OTHER);
403 TRACE("\tmemory addr (after): %p\n", pArg);
407 static unsigned int type_stack_size(unsigned char fc)
419 return sizeof(short);
426 return sizeof(float);
428 return sizeof(double);
430 return sizeof(ULONGLONG);
431 case RPC_FC_ERROR_STATUS_T:
432 return sizeof(error_status_t);
434 return sizeof(void *);
436 ERR("invalid base type 0x%x\n", fc);
437 RpcRaiseException(RPC_S_INTERNAL_ERROR);
441 void client_do_args_old_format(PMIDL_STUB_MESSAGE pStubMsg,
442 PFORMAT_STRING pFormat, int phase, unsigned char *args,
443 unsigned short stack_size,
444 unsigned char *pRetVal, BOOL object_proc, BOOL ignore_retval)
446 /* current format string offset */
447 int current_offset = 0;
448 /* current stack offset */
449 unsigned short current_stack_offset = 0;
453 /* NOTE: V1 style format doesn't terminate on the number_of_params
454 * condition as it doesn't have this attribute. Instead it
455 * terminates when the stack size given in the header is exceeded.
457 for (i = 0; TRUE; i++)
459 const NDR_PARAM_OI_BASETYPE *pParam =
460 (const NDR_PARAM_OI_BASETYPE *)&pFormat[current_offset];
461 /* note: current_stack_offset starts after the This pointer
462 * if present, so adjust this */
463 unsigned short current_stack_offset_adjusted = current_stack_offset +
464 (object_proc ? sizeof(void *) : 0);
465 unsigned char * pArg = ARG_FROM_OFFSET(args, current_stack_offset_adjusted);
467 /* no more parameters; exit loop */
468 if (current_stack_offset_adjusted >= stack_size)
471 TRACE("param[%d]: old format\n", i);
472 TRACE("\tparam_direction: 0x%x\n", pParam->param_direction);
473 TRACE("\tstack_offset: 0x%x\n", current_stack_offset_adjusted);
474 TRACE("\tmemory addr (before): %p\n", pArg);
476 if (pParam->param_direction == RPC_FC_IN_PARAM_BASETYPE ||
477 pParam->param_direction == RPC_FC_RETURN_PARAM_BASETYPE)
479 const unsigned char * pTypeFormat =
480 &pParam->type_format_char;
482 TRACE("\tbase type 0x%02x\n", *pTypeFormat);
487 if (pParam->param_direction == RPC_FC_IN_PARAM_BASETYPE)
488 call_buffer_sizer(pStubMsg, pArg, pTypeFormat);
491 if (pParam->param_direction == RPC_FC_IN_PARAM_BASETYPE)
492 call_marshaller(pStubMsg, pArg, pTypeFormat);
494 case PROXY_UNMARSHAL:
495 if (!ignore_retval &&
496 pParam->param_direction == RPC_FC_RETURN_PARAM_BASETYPE)
498 if (pParam->param_direction & RPC_FC_RETURN_PARAM)
499 call_unmarshaller(pStubMsg, &pRetVal, pTypeFormat, 0);
501 call_unmarshaller(pStubMsg, &pArg, pTypeFormat, 0);
505 RpcRaiseException(RPC_S_INTERNAL_ERROR);
508 current_stack_offset += type_stack_size(*pTypeFormat);
509 current_offset += sizeof(NDR_PARAM_OI_BASETYPE);
513 const NDR_PARAM_OI_OTHER *pParamOther =
514 (const NDR_PARAM_OI_OTHER *)&pFormat[current_offset];
516 const unsigned char *pTypeFormat =
517 &pStubMsg->StubDesc->pFormatTypes[pParamOther->type_offset];
519 TRACE("\tcomplex type 0x%02x\n", *pTypeFormat);
524 if (pParam->param_direction == RPC_FC_IN_PARAM ||
525 pParam->param_direction & RPC_FC_IN_OUT_PARAM)
526 call_buffer_sizer(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
529 if (pParam->param_direction == RPC_FC_IN_PARAM ||
530 pParam->param_direction & RPC_FC_IN_OUT_PARAM)
531 call_marshaller(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
533 case PROXY_UNMARSHAL:
534 if (pParam->param_direction == RPC_FC_IN_OUT_PARAM ||
535 pParam->param_direction == RPC_FC_OUT_PARAM)
536 call_unmarshaller(pStubMsg, (unsigned char **)pArg, pTypeFormat, 0);
537 else if (pParam->param_direction == RPC_FC_RETURN_PARAM)
538 call_unmarshaller(pStubMsg, (unsigned char **)pRetVal, pTypeFormat, 0);
541 RpcRaiseException(RPC_S_INTERNAL_ERROR);
544 current_stack_offset += pParamOther->stack_size * sizeof(INT);
545 current_offset += sizeof(NDR_PARAM_OI_OTHER);
547 TRACE("\tmemory addr (after): %p\n", pArg);
551 /* the return type should be CLIENT_CALL_RETURN, but this is incompatible
552 * with the way gcc returns structures. "void *" should be the largest type
553 * that MIDL should allow you to return anyway */
554 LONG_PTR WINAPIV NdrClientCall2(PMIDL_STUB_DESC pStubDesc, PFORMAT_STRING pFormat, ...)
556 /* pointer to start of stack where arguments start */
558 MIDL_STUB_MESSAGE stubMsg;
559 handle_t hBinding = NULL;
560 /* procedure number */
561 unsigned short procedure_number;
563 unsigned short stack_size;
564 /* number of parameters. optional for client to give it to us */
565 unsigned char number_of_params = ~0;
566 /* cache of Oif_flags from v2 procedure header */
567 INTERPRETER_OPT_FLAGS Oif_flags = { 0 };
568 /* cache of extension flags from NDR_PROC_HEADER_EXTS */
569 INTERPRETER_OPT_FLAGS2 ext_flags = { 0 };
570 /* the type of pass we are currently doing */
572 /* header for procedure string */
573 const NDR_PROC_HEADER * pProcHeader = (const NDR_PROC_HEADER *)&pFormat[0];
574 /* -Oif or -Oicf generated format */
575 BOOL bV2Format = FALSE;
576 /* the value to return to the client from the remote procedure */
578 /* the pointer to the object when in OLE mode */
580 PFORMAT_STRING pHandleFormat;
581 /* correlation cache */
582 unsigned long NdrCorrCache[256];
584 TRACE("pStubDesc %p, pFormat %p, ...\n", pStubDesc, pFormat);
586 TRACE("NDR Version: 0x%x\n", pStubDesc->Version);
588 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCFLAGS)
590 const NDR_PROC_HEADER_RPC *pProcHeader = (const NDR_PROC_HEADER_RPC *)&pFormat[0];
591 stack_size = pProcHeader->stack_size;
592 procedure_number = pProcHeader->proc_num;
593 pFormat += sizeof(NDR_PROC_HEADER_RPC);
597 stack_size = pProcHeader->stack_size;
598 procedure_number = pProcHeader->proc_num;
599 pFormat += sizeof(NDR_PROC_HEADER);
601 TRACE("stack size: 0x%x\n", stack_size);
602 TRACE("proc num: %d\n", procedure_number);
604 /* create the full pointer translation tables, if requested */
605 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
606 stubMsg.FullPtrXlatTables = NdrFullPointerXlatInit(0,XLAT_CLIENT);
608 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT)
610 /* object is always the first argument */
611 This = **(void *const **)(&pFormat+1);
612 NdrProxyInitialize(This, &rpcMsg, &stubMsg, pStubDesc, procedure_number);
615 NdrClientInitializeNew(&rpcMsg, &stubMsg, pStubDesc, procedure_number);
617 TRACE("Oi_flags = 0x%02x\n", pProcHeader->Oi_flags);
618 TRACE("MIDL stub version = 0x%x\n", pStubDesc->MIDLVersion);
620 /* needed for conformance of top-level objects */
622 stubMsg.StackTop = *(unsigned char **)(&pFormat+1);
624 # warning Stack not retrieved for your CPU architecture
627 pHandleFormat = pFormat;
629 /* we only need a handle if this isn't an object method */
630 if (!(pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT))
632 pFormat = client_get_handle(&stubMsg, pProcHeader, pHandleFormat, &hBinding);
633 if (!pFormat) return 0;
636 bV2Format = (pStubDesc->Version >= 0x20000);
640 const NDR_PROC_PARTIAL_OIF_HEADER *pOIFHeader =
641 (const NDR_PROC_PARTIAL_OIF_HEADER *)pFormat;
643 Oif_flags = pOIFHeader->Oi2Flags;
644 number_of_params = pOIFHeader->number_of_params;
646 pFormat += sizeof(NDR_PROC_PARTIAL_OIF_HEADER);
649 TRACE("Oif_flags = "); dump_INTERPRETER_OPT_FLAGS(Oif_flags);
651 if (Oif_flags.HasExtensions)
653 const NDR_PROC_HEADER_EXTS *pExtensions =
654 (const NDR_PROC_HEADER_EXTS *)pFormat;
655 ext_flags = pExtensions->Flags2;
656 pFormat += pExtensions->Size;
659 stubMsg.BufferLength = 0;
661 /* store the RPC flags away */
662 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCFLAGS)
663 rpcMsg.RpcFlags = ((const NDR_PROC_HEADER_RPC *)pProcHeader)->rpc_flags;
665 /* use alternate memory allocation routines */
666 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCSSALLOC)
667 NdrRpcSmSetClientToOsf(&stubMsg);
669 if (Oif_flags.HasPipes)
671 FIXME("pipes not supported yet\n");
672 RpcRaiseException(RPC_X_WRONG_STUB_VERSION); /* FIXME: remove when implemented */
673 /* init pipes package */
674 /* NdrPipesInitialize(...) */
676 if (ext_flags.HasNewCorrDesc)
678 /* initialize extra correlation package */
679 NdrCorrelationInitialize(&stubMsg, NdrCorrCache, sizeof(NdrCorrCache), 0);
683 * 1. PROXY_CALCSIZE - calculate the buffer size
684 * 2. PROXY_GETBUFFER - allocate the buffer
685 * 3. PROXY_MARHSAL - marshal [in] params into the buffer
686 * 4. PROXY_SENDRECEIVE - send/receive buffer
687 * 5. PROXY_UNMARHSAL - unmarshal [out] params from buffer
689 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT)
693 for (phase = PROXY_CALCSIZE; phase <= PROXY_UNMARSHAL; phase++)
695 TRACE("phase = %d\n", phase);
698 case PROXY_GETBUFFER:
699 /* allocate the buffer */
700 NdrProxyGetBuffer(This, &stubMsg);
702 case PROXY_SENDRECEIVE:
703 /* send the [in] params and receive the [out] and [retval]
705 NdrProxySendReceive(This, &stubMsg);
707 /* convert strings, floating point values and endianess into our
708 * preferred format */
709 if ((rpcMsg.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)
710 NdrConvert(&stubMsg, pFormat);
715 case PROXY_UNMARSHAL:
717 client_do_args(&stubMsg, pFormat, phase, stubMsg.StackTop,
718 number_of_params, (unsigned char *)&RetVal);
720 client_do_args_old_format(&stubMsg, pFormat, phase,
721 stubMsg.StackTop, stack_size, (unsigned char *)&RetVal,
722 (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT), FALSE);
725 ERR("shouldn't reach here. phase %d\n", phase);
732 RetVal = NdrProxyErrorHandler(GetExceptionCode());
739 * 1. PROXY_CALCSIZE - calculate the buffer size
740 * 2. PROXY_GETBUFFER - allocate the buffer
741 * 3. PROXY_MARHSAL - marshal [in] params into the buffer
742 * 4. PROXY_SENDRECEIVE - send/receive buffer
743 * 5. PROXY_UNMARHSAL - unmarshal [out] params from buffer
745 for (phase = PROXY_CALCSIZE; phase <= PROXY_UNMARSHAL; phase++)
747 TRACE("phase = %d\n", phase);
750 case PROXY_GETBUFFER:
751 /* allocate the buffer */
752 if (Oif_flags.HasPipes)
753 /* NdrGetPipeBuffer(...) */
754 FIXME("pipes not supported yet\n");
757 if (pProcHeader->handle_type == RPC_FC_AUTO_HANDLE)
759 NdrNsGetBuffer(&stubMsg, stubMsg.BufferLength, hBinding);
761 FIXME("using auto handle - call NdrNsGetBuffer when it gets implemented\n");
764 NdrGetBuffer(&stubMsg, stubMsg.BufferLength, hBinding);
767 case PROXY_SENDRECEIVE:
768 /* send the [in] params and receive the [out] and [retval]
770 if (Oif_flags.HasPipes)
771 /* NdrPipesSendReceive(...) */
772 FIXME("pipes not supported yet\n");
775 if (pProcHeader->handle_type == RPC_FC_AUTO_HANDLE)
777 NdrNsSendReceive(&stubMsg, stubMsg.Buffer, pStubDesc->IMPLICIT_HANDLE_INFO.pAutoHandle);
779 FIXME("using auto handle - call NdrNsSendReceive when it gets implemented\n");
782 NdrSendReceive(&stubMsg, stubMsg.Buffer);
785 /* convert strings, floating point values and endianess into our
786 * preferred format */
787 if ((rpcMsg.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)
788 NdrConvert(&stubMsg, pFormat);
793 case PROXY_UNMARSHAL:
795 client_do_args(&stubMsg, pFormat, phase, stubMsg.StackTop,
796 number_of_params, (unsigned char *)&RetVal);
798 client_do_args_old_format(&stubMsg, pFormat, phase,
799 stubMsg.StackTop, stack_size, (unsigned char *)&RetVal,
800 (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT), FALSE);
803 ERR("shouldn't reach here. phase %d\n", phase);
809 if (ext_flags.HasNewCorrDesc)
811 /* free extra correlation package */
812 NdrCorrelationFree(&stubMsg);
815 if (Oif_flags.HasPipes)
817 /* NdrPipesDone(...) */
820 /* free the full pointer translation tables */
821 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
822 NdrFullPointerXlatFree(stubMsg.FullPtrXlatTables);
824 /* free marshalling buffer */
825 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT)
826 NdrProxyFreeBuffer(This, &stubMsg);
829 NdrFreeBuffer(&stubMsg);
830 client_free_handle(&stubMsg, pProcHeader, pHandleFormat, hBinding);
833 TRACE("RetVal = 0x%lx\n", RetVal);
838 /* Calls a function with the specified arguments, restoring the stack
839 * properly afterwards as we don't know the calling convention of the
841 #if defined __i386__ && defined _MSC_VER
842 __declspec(naked) LONG_PTR __cdecl call_server_func(SERVER_ROUTINE func, unsigned char * args, unsigned int stack_size)
847 push edi ; Save registers
850 mov eax, [ebp+16] ; Get stack size
851 sub esp, eax ; Make room in stack for arguments
857 rep movsd ; Copy dword blocks
858 call [ebp+8] ; Call function
859 lea esp, [ebp-8] ; Restore stack
860 pop esi ; Restore registers
866 #elif defined __i386__ && defined __GNUC__
867 LONG_PTR __cdecl call_server_func(SERVER_ROUTINE func, unsigned char * args, unsigned int stack_size);
868 __ASM_GLOBAL_FUNC(call_server_func,
870 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
871 __ASM_CFI(".cfi_rel_offset %ebp,0\n\t")
873 __ASM_CFI(".cfi_def_cfa_register %ebp\n\t")
874 "pushl %edi\n\t" /* Save registers */
875 __ASM_CFI(".cfi_rel_offset %edi,-4\n\t")
877 __ASM_CFI(".cfi_rel_offset %esi,-8\n\t")
878 "movl 16(%ebp), %eax\n\t" /* Get stack size */
879 "subl %eax, %esp\n\t" /* Make room in stack for arguments */
880 "andl $~15, %esp\n\t" /* Make sure stack has 16-byte alignment for Mac OS X */
881 "movl %esp, %edi\n\t"
882 "movl %eax, %ecx\n\t"
883 "movl 12(%ebp), %esi\n\t"
884 "shrl $2, %ecx\n\t" /* divide by 4 */
886 "rep; movsl\n\t" /* Copy dword blocks */
887 "call *8(%ebp)\n\t" /* Call function */
888 "leal -8(%ebp), %esp\n\t" /* Restore stack */
889 "popl %esi\n\t" /* Restore registers */
890 __ASM_CFI(".cfi_same_value %esi\n\t")
892 __ASM_CFI(".cfi_same_value %edi\n\t")
894 __ASM_CFI(".cfi_def_cfa %esp,4\n\t")
895 __ASM_CFI(".cfi_same_value %ebp\n\t")
898 #warning call_server_func not implemented for your architecture
899 LONG_PTR __cdecl call_server_func(SERVER_ROUTINE func, unsigned char * args, unsigned short stack_size)
901 FIXME("Not implemented for your architecture\n");
906 static DWORD calc_arg_size(MIDL_STUB_MESSAGE *pStubMsg, PFORMAT_STRING pFormat)
912 size = *(const WORD*)(pFormat + 2);
915 size = *(const WORD*)(pFormat + 2);
916 ComputeConformance(pStubMsg, NULL, pFormat + 4, 0);
917 size *= pStubMsg->MaxCount;
919 case RPC_FC_SMFARRAY:
920 size = *(const WORD*)(pFormat + 2);
922 case RPC_FC_LGFARRAY:
923 size = *(const DWORD*)(pFormat + 2);
925 case RPC_FC_BOGUS_ARRAY:
926 pFormat = ComputeConformance(pStubMsg, NULL, pFormat + 4, *(const WORD*)&pFormat[2]);
927 TRACE("conformance = %ld\n", pStubMsg->MaxCount);
928 pFormat = ComputeVariance(pStubMsg, NULL, pFormat, pStubMsg->MaxCount);
929 size = ComplexStructSize(pStubMsg, pFormat);
930 size *= pStubMsg->MaxCount;
933 FIXME("Unhandled type %02x\n", *pFormat);
936 size = sizeof(void *);
942 static LONG_PTR *stub_do_args(MIDL_STUB_MESSAGE *pStubMsg,
943 PFORMAT_STRING pFormat, int phase,
945 unsigned short number_of_params)
949 /* current format string offset */
950 int current_offset = 0;
951 /* current stack offset */
952 unsigned short current_stack_offset = 0;
953 /* location to put retval into */
954 LONG_PTR *retval_ptr = NULL;
956 for (i = 0; i < number_of_params; i++)
958 const NDR_PARAM_OIF_BASETYPE *pParam =
959 (const NDR_PARAM_OIF_BASETYPE *)&pFormat[current_offset];
962 current_stack_offset = pParam->stack_offset;
963 pArg = args + current_stack_offset;
965 TRACE("param[%d]: new format\n", i);
966 TRACE("\tparam_attributes:"); dump_RPC_FC_PROC_PF(pParam->param_attributes); TRACE("\n");
967 TRACE("\tstack_offset: 0x%x\n", current_stack_offset);
968 TRACE("\tmemory addr (before): %p -> %p\n", pArg, *(unsigned char **)pArg);
970 if (pParam->param_attributes.IsBasetype)
972 const unsigned char *pTypeFormat =
973 &pParam->type_format_char;
975 TRACE("\tbase type: 0x%02x\n", *pTypeFormat);
977 /* make a note of the address of the return value parameter for later */
978 if (pParam->param_attributes.IsReturn)
979 retval_ptr = (LONG_PTR *)pArg;
983 case STUBLESS_MARSHAL:
984 if (pParam->param_attributes.IsOut || pParam->param_attributes.IsReturn)
986 if (pParam->param_attributes.IsSimpleRef)
987 call_marshaller(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
989 call_marshaller(pStubMsg, pArg, pTypeFormat);
993 if (pParam->param_attributes.ServerAllocSize)
994 HeapFree(GetProcessHeap(), 0, *(void **)pArg);
996 case STUBLESS_INITOUT:
998 case STUBLESS_UNMARSHAL:
999 if (pParam->param_attributes.ServerAllocSize)
1000 *(void **)pArg = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
1001 pParam->param_attributes.ServerAllocSize * 8);
1003 if (pParam->param_attributes.IsIn)
1005 if (pParam->param_attributes.IsSimpleRef)
1006 call_unmarshaller(pStubMsg, (unsigned char **)pArg, pTypeFormat, 0);
1008 call_unmarshaller(pStubMsg, &pArg, pTypeFormat, 0);
1011 case STUBLESS_CALCSIZE:
1012 if (pParam->param_attributes.IsOut || pParam->param_attributes.IsReturn)
1014 if (pParam->param_attributes.IsSimpleRef)
1015 call_buffer_sizer(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
1017 call_buffer_sizer(pStubMsg, pArg, pTypeFormat);
1021 RpcRaiseException(RPC_S_INTERNAL_ERROR);
1024 current_offset += sizeof(NDR_PARAM_OIF_BASETYPE);
1028 const NDR_PARAM_OIF_OTHER *pParamOther =
1029 (const NDR_PARAM_OIF_OTHER *)&pFormat[current_offset];
1031 const unsigned char * pTypeFormat =
1032 &(pStubMsg->StubDesc->pFormatTypes[pParamOther->type_offset]);
1034 TRACE("\tcomplex type 0x%02x\n", *pTypeFormat);
1038 case STUBLESS_MARSHAL:
1039 if (pParam->param_attributes.IsOut || pParam->param_attributes.IsReturn)
1041 if (pParam->param_attributes.IsByValue)
1042 call_marshaller(pStubMsg, pArg, pTypeFormat);
1044 call_marshaller(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
1048 if (pParam->param_attributes.MustFree)
1050 if (pParam->param_attributes.IsByValue)
1051 call_freer(pStubMsg, pArg, pTypeFormat);
1053 call_freer(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
1056 if (pParam->param_attributes.IsOut &&
1057 !pParam->param_attributes.IsIn &&
1058 !pParam->param_attributes.IsByValue &&
1059 !pParam->param_attributes.ServerAllocSize)
1061 pStubMsg->pfnFree(*(void **)pArg);
1064 if (pParam->param_attributes.ServerAllocSize)
1065 HeapFree(GetProcessHeap(), 0, *(void **)pArg);
1067 case STUBLESS_INITOUT:
1068 if (!pParam->param_attributes.IsIn &&
1069 pParam->param_attributes.IsOut &&
1070 !pParam->param_attributes.ServerAllocSize &&
1071 !pParam->param_attributes.IsByValue)
1073 DWORD size = calc_arg_size(pStubMsg, pTypeFormat);
1077 *(void **)pArg = NdrAllocate(pStubMsg, size);
1078 memset(*(void **)pArg, 0, size);
1082 case STUBLESS_UNMARSHAL:
1083 if (pParam->param_attributes.ServerAllocSize)
1084 *(void **)pArg = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
1085 pParam->param_attributes.ServerAllocSize * 8);
1087 if (pParam->param_attributes.IsIn)
1089 if (pParam->param_attributes.IsByValue)
1090 call_unmarshaller(pStubMsg, &pArg, pTypeFormat, 0);
1092 call_unmarshaller(pStubMsg, (unsigned char **)pArg, pTypeFormat, 0);
1095 case STUBLESS_CALCSIZE:
1096 if (pParam->param_attributes.IsOut || pParam->param_attributes.IsReturn)
1098 if (pParam->param_attributes.IsByValue)
1099 call_buffer_sizer(pStubMsg, pArg, pTypeFormat);
1101 call_buffer_sizer(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
1105 RpcRaiseException(RPC_S_INTERNAL_ERROR);
1108 current_offset += sizeof(NDR_PARAM_OIF_OTHER);
1110 TRACE("\tmemory addr (after): %p -> %p\n", pArg, *(unsigned char **)pArg);
1116 static LONG_PTR *stub_do_old_args(MIDL_STUB_MESSAGE *pStubMsg,
1117 PFORMAT_STRING pFormat, int phase,
1118 unsigned char *args,
1119 unsigned short stack_size, BOOL object)
1123 /* current format string offset */
1124 int current_offset = 0;
1125 /* current stack offset */
1126 unsigned short current_stack_offset = 0;
1127 /* location to put retval into */
1128 LONG_PTR *retval_ptr = NULL;
1130 for (i = 0; TRUE; i++)
1132 const NDR_PARAM_OI_BASETYPE *pParam =
1133 (const NDR_PARAM_OI_BASETYPE *)&pFormat[current_offset];
1134 /* note: current_stack_offset starts after the This pointer
1135 * if present, so adjust this */
1136 unsigned short current_stack_offset_adjusted = current_stack_offset +
1137 (object ? sizeof(void *) : 0);
1138 unsigned char *pArg = args + current_stack_offset_adjusted;
1140 /* no more parameters; exit loop */
1141 if (current_stack_offset_adjusted >= stack_size)
1144 TRACE("param[%d]: old format\n", i);
1145 TRACE("\tparam_direction: 0x%x\n", pParam->param_direction);
1146 TRACE("\tstack_offset: 0x%x\n", current_stack_offset_adjusted);
1148 if (pParam->param_direction == RPC_FC_IN_PARAM_BASETYPE ||
1149 pParam->param_direction == RPC_FC_RETURN_PARAM_BASETYPE)
1151 const unsigned char *pTypeFormat =
1152 &pParam->type_format_char;
1154 TRACE("\tbase type 0x%02x\n", *pTypeFormat);
1156 if (pParam->param_direction == RPC_FC_RETURN_PARAM_BASETYPE)
1157 retval_ptr = (LONG_PTR *)pArg;
1161 case STUBLESS_MARSHAL:
1162 if (pParam->param_direction == RPC_FC_RETURN_PARAM_BASETYPE)
1163 call_marshaller(pStubMsg, pArg, pTypeFormat);
1166 if (pParam->param_direction == RPC_FC_IN_PARAM_BASETYPE)
1167 call_freer(pStubMsg, pArg, pTypeFormat);
1169 case STUBLESS_UNMARSHAL:
1170 if (pParam->param_direction == RPC_FC_IN_PARAM_BASETYPE)
1171 call_unmarshaller(pStubMsg, &pArg, pTypeFormat, 0);
1173 case STUBLESS_CALCSIZE:
1174 if (pParam->param_direction == RPC_FC_RETURN_PARAM_BASETYPE)
1175 call_buffer_sizer(pStubMsg, pArg, pTypeFormat);
1178 RpcRaiseException(RPC_S_INTERNAL_ERROR);
1181 current_stack_offset += type_stack_size(*pTypeFormat);
1182 current_offset += sizeof(NDR_PARAM_OI_BASETYPE);
1186 const NDR_PARAM_OI_OTHER *pParamOther =
1187 (const NDR_PARAM_OI_OTHER *)&pFormat[current_offset];
1189 const unsigned char * pTypeFormat =
1190 &pStubMsg->StubDesc->pFormatTypes[pParamOther->type_offset];
1192 TRACE("\tcomplex type 0x%02x\n", *pTypeFormat);
1194 if (pParam->param_direction == RPC_FC_RETURN_PARAM)
1195 retval_ptr = (LONG_PTR *)pArg;
1199 case STUBLESS_MARSHAL:
1200 if (pParam->param_direction == RPC_FC_OUT_PARAM ||
1201 pParam->param_direction == RPC_FC_IN_OUT_PARAM ||
1202 pParam->param_direction == RPC_FC_RETURN_PARAM)
1203 call_marshaller(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
1206 if (pParam->param_direction == RPC_FC_IN_OUT_PARAM ||
1207 pParam->param_direction == RPC_FC_IN_PARAM)
1208 call_freer(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
1209 else if (pParam->param_direction == RPC_FC_OUT_PARAM)
1210 pStubMsg->pfnFree(*(void **)pArg);
1212 case STUBLESS_INITOUT:
1213 if (pParam->param_direction == RPC_FC_OUT_PARAM)
1215 DWORD size = calc_arg_size(pStubMsg, pTypeFormat);
1219 *(void **)pArg = NdrAllocate(pStubMsg, size);
1220 memset(*(void **)pArg, 0, size);
1224 case STUBLESS_UNMARSHAL:
1225 if (pParam->param_direction == RPC_FC_IN_OUT_PARAM ||
1226 pParam->param_direction == RPC_FC_IN_PARAM)
1227 call_unmarshaller(pStubMsg, (unsigned char **)pArg, pTypeFormat, 0);
1229 case STUBLESS_CALCSIZE:
1230 if (pParam->param_direction == RPC_FC_OUT_PARAM ||
1231 pParam->param_direction == RPC_FC_IN_OUT_PARAM ||
1232 pParam->param_direction == RPC_FC_RETURN_PARAM)
1233 call_buffer_sizer(pStubMsg, *(unsigned char **)pArg, pTypeFormat);
1236 RpcRaiseException(RPC_S_INTERNAL_ERROR);
1239 current_stack_offset += pParamOther->stack_size * sizeof(INT);
1240 current_offset += sizeof(NDR_PARAM_OI_OTHER);
1247 /***********************************************************************
1248 * NdrStubCall2 [RPCRT4.@]
1250 * Unmarshals [in] parameters, calls either a method in an object or a server
1251 * function, marshals any [out] parameters and frees any allocated data.
1254 * Used by stubless MIDL-generated code.
1256 LONG WINAPI NdrStubCall2(
1257 struct IRpcStubBuffer * pThis,
1258 struct IRpcChannelBuffer * pChannel,
1259 PRPC_MESSAGE pRpcMsg,
1260 DWORD * pdwStubPhase)
1262 const MIDL_SERVER_INFO *pServerInfo;
1263 const MIDL_STUB_DESC *pStubDesc;
1264 PFORMAT_STRING pFormat;
1265 MIDL_STUB_MESSAGE stubMsg;
1266 /* pointer to start of stack to pass into stub implementation */
1267 unsigned char * args;
1269 unsigned short stack_size;
1270 /* number of parameters. optional for client to give it to us */
1271 unsigned char number_of_params = ~0;
1272 /* cache of Oif_flags from v2 procedure header */
1273 INTERPRETER_OPT_FLAGS Oif_flags = { 0 };
1274 /* cache of extension flags from NDR_PROC_HEADER_EXTS */
1275 INTERPRETER_OPT_FLAGS2 ext_flags = { 0 };
1276 /* the type of pass we are currently doing */
1278 /* header for procedure string */
1279 const NDR_PROC_HEADER *pProcHeader;
1280 /* offset in format string for start of params */
1281 int parameter_start_offset;
1282 /* current format string offset */
1284 /* -Oif or -Oicf generated format */
1285 BOOL bV2Format = FALSE;
1286 /* location to put retval into */
1287 LONG_PTR *retval_ptr = NULL;
1289 TRACE("pThis %p, pChannel %p, pRpcMsg %p, pdwStubPhase %p\n", pThis, pChannel, pRpcMsg, pdwStubPhase);
1292 pServerInfo = CStdStubBuffer_GetServerInfo(pThis);
1294 pServerInfo = ((RPC_SERVER_INTERFACE *)pRpcMsg->RpcInterfaceInformation)->InterpreterInfo;
1296 pStubDesc = pServerInfo->pStubDesc;
1297 pFormat = pServerInfo->ProcString + pServerInfo->FmtStringOffset[pRpcMsg->ProcNum];
1298 pProcHeader = (const NDR_PROC_HEADER *)&pFormat[0];
1300 TRACE("NDR Version: 0x%x\n", pStubDesc->Version);
1302 /* create the full pointer translation tables, if requested */
1303 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
1304 stubMsg.FullPtrXlatTables = NdrFullPointerXlatInit(0,XLAT_SERVER);
1306 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCFLAGS)
1308 const NDR_PROC_HEADER_RPC *pProcHeader = (const NDR_PROC_HEADER_RPC *)&pFormat[0];
1309 stack_size = pProcHeader->stack_size;
1310 current_offset = sizeof(NDR_PROC_HEADER_RPC);
1315 stack_size = pProcHeader->stack_size;
1316 current_offset = sizeof(NDR_PROC_HEADER);
1319 TRACE("Oi_flags = 0x%02x\n", pProcHeader->Oi_flags);
1322 switch (pProcHeader->handle_type)
1324 /* explicit binding: parse additional section */
1325 case RPC_FC_BIND_EXPLICIT:
1326 switch (pFormat[current_offset]) /* handle_type */
1328 case RPC_FC_BIND_PRIMITIVE: /* explicit primitive */
1329 current_offset += sizeof(NDR_EHD_PRIMITIVE);
1331 case RPC_FC_BIND_GENERIC: /* explicit generic */
1332 current_offset += sizeof(NDR_EHD_GENERIC);
1334 case RPC_FC_BIND_CONTEXT: /* explicit context */
1335 current_offset += sizeof(NDR_EHD_CONTEXT);
1338 ERR("bad explicit binding handle type (0x%02x)\n", pProcHeader->handle_type);
1339 RpcRaiseException(RPC_X_BAD_STUB_DATA);
1342 case RPC_FC_BIND_GENERIC: /* implicit generic */
1343 case RPC_FC_BIND_PRIMITIVE: /* implicit primitive */
1344 case RPC_FC_CALLBACK_HANDLE: /* implicit callback */
1345 case RPC_FC_AUTO_HANDLE: /* implicit auto handle */
1348 ERR("bad implicit binding handle type (0x%02x)\n", pProcHeader->handle_type);
1349 RpcRaiseException(RPC_X_BAD_STUB_DATA);
1352 bV2Format = (pStubDesc->Version >= 0x20000);
1356 const NDR_PROC_PARTIAL_OIF_HEADER *pOIFHeader =
1357 (const NDR_PROC_PARTIAL_OIF_HEADER *)&pFormat[current_offset];
1359 Oif_flags = pOIFHeader->Oi2Flags;
1360 number_of_params = pOIFHeader->number_of_params;
1362 current_offset += sizeof(NDR_PROC_PARTIAL_OIF_HEADER);
1365 TRACE("Oif_flags = "); dump_INTERPRETER_OPT_FLAGS(Oif_flags);
1367 if (Oif_flags.HasExtensions)
1369 const NDR_PROC_HEADER_EXTS *pExtensions =
1370 (const NDR_PROC_HEADER_EXTS *)&pFormat[current_offset];
1371 ext_flags = pExtensions->Flags2;
1372 current_offset += pExtensions->Size;
1375 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT)
1376 NdrStubInitialize(pRpcMsg, &stubMsg, pStubDesc, pChannel);
1378 NdrServerInitializeNew(pRpcMsg, &stubMsg, pStubDesc);
1380 /* store the RPC flags away */
1381 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCFLAGS)
1382 pRpcMsg->RpcFlags = ((const NDR_PROC_HEADER_RPC *)pProcHeader)->rpc_flags;
1384 /* use alternate memory allocation routines */
1385 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCSSALLOC)
1387 NdrRpcSsEnableAllocate(&stubMsg);
1389 FIXME("Set RPCSS memory allocation routines\n");
1392 if (Oif_flags.HasPipes)
1394 FIXME("pipes not supported yet\n");
1395 RpcRaiseException(RPC_X_WRONG_STUB_VERSION); /* FIXME: remove when implemented */
1396 /* init pipes package */
1397 /* NdrPipesInitialize(...) */
1399 if (ext_flags.HasNewCorrDesc)
1401 /* initialize extra correlation package */
1402 FIXME("new correlation description not implemented\n");
1403 stubMsg.fHasNewCorrDesc = TRUE;
1406 /* convert strings, floating point values and endianess into our
1407 * preferred format */
1408 if ((pRpcMsg->DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)
1409 NdrConvert(&stubMsg, pFormat);
1411 parameter_start_offset = current_offset;
1413 TRACE("allocating memory for stack of size %x\n", stack_size);
1415 args = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, stack_size);
1416 stubMsg.StackTop = args; /* used by conformance of top-level objects */
1418 /* add the implicit This pointer as the first arg to the function if we
1419 * are calling an object method */
1421 *(void **)args = ((CStdStubBuffer *)pThis)->pvServerObject;
1424 * 1. STUBLESS_UNMARHSAL - unmarshal [in] params from buffer
1425 * 2. STUBLESS_CALLSERVER - send/receive buffer
1426 * 3. STUBLESS_CALCSIZE - get [out] buffer size
1427 * 4. STUBLESS_GETBUFFER - allocate [out] buffer
1428 * 5. STUBLESS_MARHSAL - marshal [out] params to buffer
1430 for (phase = STUBLESS_UNMARSHAL; phase <= STUBLESS_FREE; phase++)
1432 TRACE("phase = %d\n", phase);
1435 case STUBLESS_CALLSERVER:
1436 /* call the server function */
1437 if (pServerInfo->ThunkTable && pServerInfo->ThunkTable[pRpcMsg->ProcNum])
1438 pServerInfo->ThunkTable[pRpcMsg->ProcNum](&stubMsg);
1441 SERVER_ROUTINE func;
1444 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT)
1446 SERVER_ROUTINE *vtbl = *(SERVER_ROUTINE **)((CStdStubBuffer *)pThis)->pvServerObject;
1447 func = vtbl[pRpcMsg->ProcNum];
1450 func = pServerInfo->DispatchTable[pRpcMsg->ProcNum];
1452 /* FIXME: what happens with return values that don't fit into a single register on x86? */
1453 retval = call_server_func(func, args, stack_size);
1457 TRACE("stub implementation returned 0x%lx\n", retval);
1458 *retval_ptr = retval;
1461 TRACE("void stub implementation\n");
1464 stubMsg.Buffer = NULL;
1465 stubMsg.BufferLength = 0;
1468 case STUBLESS_GETBUFFER:
1469 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT)
1470 NdrStubGetBuffer(pThis, pChannel, &stubMsg);
1475 pRpcMsg->BufferLength = stubMsg.BufferLength;
1476 /* allocate buffer for [out] and [ret] params */
1477 Status = I_RpcGetBuffer(pRpcMsg);
1479 RpcRaiseException(Status);
1480 stubMsg.Buffer = pRpcMsg->Buffer;
1483 case STUBLESS_UNMARSHAL:
1484 case STUBLESS_INITOUT:
1485 case STUBLESS_CALCSIZE:
1486 case STUBLESS_MARSHAL:
1489 retval_ptr = stub_do_args(&stubMsg, &pFormat[parameter_start_offset],
1490 phase, args, number_of_params);
1492 retval_ptr = stub_do_old_args(&stubMsg, &pFormat[parameter_start_offset],
1493 phase, args, stack_size,
1494 (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT));
1498 ERR("shouldn't reach here. phase %d\n", phase);
1503 pRpcMsg->BufferLength = (unsigned int)(stubMsg.Buffer - (unsigned char *)pRpcMsg->Buffer);
1505 if (ext_flags.HasNewCorrDesc)
1507 /* free extra correlation package */
1508 /* NdrCorrelationFree(&stubMsg); */
1511 if (Oif_flags.HasPipes)
1513 /* NdrPipesDone(...) */
1516 /* free the full pointer translation tables */
1517 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
1518 NdrFullPointerXlatFree(stubMsg.FullPtrXlatTables);
1520 /* free server function stack */
1521 HeapFree(GetProcessHeap(), 0, args);
1526 /***********************************************************************
1527 * NdrServerCall2 [RPCRT4.@]
1529 void WINAPI NdrServerCall2(PRPC_MESSAGE pRpcMsg)
1532 NdrStubCall2(NULL, NULL, pRpcMsg, &dwPhase);
1535 struct async_call_data
1537 MIDL_STUB_MESSAGE *pStubMsg;
1538 const NDR_PROC_HEADER *pProcHeader;
1539 PFORMAT_STRING pHandleFormat;
1540 PFORMAT_STRING pParamFormat;
1541 RPC_BINDING_HANDLE hBinding;
1543 unsigned short stack_size;
1544 /* number of parameters. optional for client to give it to us */
1545 unsigned char number_of_params;
1546 /* correlation cache */
1547 unsigned long NdrCorrCache[256];
1550 LONG_PTR WINAPIV NdrAsyncClientCall(PMIDL_STUB_DESC pStubDesc,
1551 PFORMAT_STRING pFormat, ...)
1553 /* pointer to start of stack where arguments start */
1554 PRPC_MESSAGE pRpcMsg;
1555 PMIDL_STUB_MESSAGE pStubMsg;
1556 RPC_ASYNC_STATE *pAsync;
1557 struct async_call_data *async_call_data;
1558 /* procedure number */
1559 unsigned short procedure_number;
1560 /* cache of Oif_flags from v2 procedure header */
1561 INTERPRETER_OPT_FLAGS Oif_flags = { 0 };
1562 /* cache of extension flags from NDR_PROC_HEADER_EXTS */
1563 INTERPRETER_OPT_FLAGS2 ext_flags = { 0 };
1564 /* the type of pass we are currently doing */
1566 /* header for procedure string */
1567 const NDR_PROC_HEADER * pProcHeader = (const NDR_PROC_HEADER *)&pFormat[0];
1568 /* -Oif or -Oicf generated format */
1569 BOOL bV2Format = FALSE;
1571 TRACE("pStubDesc %p, pFormat %p, ...\n", pStubDesc, pFormat);
1573 /* Later NDR language versions probably won't be backwards compatible */
1574 if (pStubDesc->Version > 0x50002)
1576 FIXME("Incompatible stub description version: 0x%x\n", pStubDesc->Version);
1577 RpcRaiseException(RPC_X_WRONG_STUB_VERSION);
1580 async_call_data = I_RpcAllocate(sizeof(*async_call_data) + sizeof(MIDL_STUB_MESSAGE) + sizeof(RPC_MESSAGE));
1581 if (!async_call_data) RpcRaiseException(ERROR_OUTOFMEMORY);
1582 async_call_data->number_of_params = ~0;
1583 async_call_data->pProcHeader = pProcHeader;
1585 async_call_data->pStubMsg = pStubMsg = (PMIDL_STUB_MESSAGE)(async_call_data + 1);
1586 pRpcMsg = (PRPC_MESSAGE)(pStubMsg + 1);
1588 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCFLAGS)
1590 const NDR_PROC_HEADER_RPC *pProcHeader = (const NDR_PROC_HEADER_RPC *)&pFormat[0];
1591 async_call_data->stack_size = pProcHeader->stack_size;
1592 procedure_number = pProcHeader->proc_num;
1593 pFormat += sizeof(NDR_PROC_HEADER_RPC);
1597 async_call_data->stack_size = pProcHeader->stack_size;
1598 procedure_number = pProcHeader->proc_num;
1599 pFormat += sizeof(NDR_PROC_HEADER);
1601 TRACE("stack size: 0x%x\n", async_call_data->stack_size);
1602 TRACE("proc num: %d\n", procedure_number);
1604 /* create the full pointer translation tables, if requested */
1605 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
1606 pStubMsg->FullPtrXlatTables = NdrFullPointerXlatInit(0,XLAT_CLIENT);
1608 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT)
1610 ERR("objects not supported\n");
1611 I_RpcFree(async_call_data);
1612 RpcRaiseException(RPC_X_BAD_STUB_DATA);
1615 NdrClientInitializeNew(pRpcMsg, pStubMsg, pStubDesc, procedure_number);
1617 TRACE("Oi_flags = 0x%02x\n", pProcHeader->Oi_flags);
1618 TRACE("MIDL stub version = 0x%x\n", pStubDesc->MIDLVersion);
1620 /* needed for conformance of top-level objects */
1622 pStubMsg->StackTop = I_RpcAllocate(async_call_data->stack_size);
1623 /* FIXME: this may read one more DWORD than is necessary, but it shouldn't hurt */
1624 memcpy(pStubMsg->StackTop, *(unsigned char **)(&pFormat+1), async_call_data->stack_size);
1626 # warning Stack not retrieved for your CPU architecture
1629 pAsync = *(RPC_ASYNC_STATE **)pStubMsg->StackTop;
1630 pAsync->StubInfo = async_call_data;
1631 async_call_data->pHandleFormat = pFormat;
1633 pFormat = client_get_handle(pStubMsg, pProcHeader, async_call_data->pHandleFormat, &async_call_data->hBinding);
1634 if (!pFormat) return 0;
1636 bV2Format = (pStubDesc->Version >= 0x20000);
1640 const NDR_PROC_PARTIAL_OIF_HEADER *pOIFHeader =
1641 (const NDR_PROC_PARTIAL_OIF_HEADER *)pFormat;
1643 Oif_flags = pOIFHeader->Oi2Flags;
1644 async_call_data->number_of_params = pOIFHeader->number_of_params;
1646 pFormat += sizeof(NDR_PROC_PARTIAL_OIF_HEADER);
1649 TRACE("Oif_flags = "); dump_INTERPRETER_OPT_FLAGS(Oif_flags);
1651 if (Oif_flags.HasExtensions)
1653 const NDR_PROC_HEADER_EXTS *pExtensions =
1654 (const NDR_PROC_HEADER_EXTS *)pFormat;
1655 ext_flags = pExtensions->Flags2;
1656 pFormat += pExtensions->Size;
1659 async_call_data->pParamFormat = pFormat;
1661 pStubMsg->BufferLength = 0;
1663 /* store the RPC flags away */
1664 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCFLAGS)
1665 pRpcMsg->RpcFlags = ((const NDR_PROC_HEADER_RPC *)pProcHeader)->rpc_flags;
1667 /* use alternate memory allocation routines */
1668 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCSSALLOC)
1669 NdrRpcSmSetClientToOsf(pStubMsg);
1671 if (Oif_flags.HasPipes)
1673 FIXME("pipes not supported yet\n");
1674 RpcRaiseException(RPC_X_WRONG_STUB_VERSION); /* FIXME: remove when implemented */
1675 /* init pipes package */
1676 /* NdrPipesInitialize(...) */
1678 if (ext_flags.HasNewCorrDesc)
1680 /* initialize extra correlation package */
1681 NdrCorrelationInitialize(pStubMsg, async_call_data->NdrCorrCache, sizeof(async_call_data->NdrCorrCache), 0);
1685 * 1. PROXY_CALCSIZE - calculate the buffer size
1686 * 2. PROXY_GETBUFFER - allocate the buffer
1687 * 3. PROXY_MARHSAL - marshal [in] params into the buffer
1688 * 4. PROXY_SENDRECEIVE - send buffer
1689 * Then in NdrpCompleteAsyncClientCall:
1690 * 1. PROXY_SENDRECEIVE - receive buffer
1691 * 2. PROXY_UNMARHSAL - unmarshal [out] params from buffer
1693 for (phase = PROXY_CALCSIZE; phase <= PROXY_SENDRECEIVE; phase++)
1696 TRACE("phase = %d\n", phase);
1699 case PROXY_GETBUFFER:
1700 /* allocate the buffer */
1701 if (Oif_flags.HasPipes)
1702 /* NdrGetPipeBuffer(...) */
1703 FIXME("pipes not supported yet\n");
1706 if (pProcHeader->handle_type == RPC_FC_AUTO_HANDLE)
1708 NdrNsGetBuffer(pStubMsg, pStubMsg->BufferLength, async_call_data->hBinding);
1710 FIXME("using auto handle - call NdrNsGetBuffer when it gets implemented\n");
1713 NdrGetBuffer(pStubMsg, pStubMsg->BufferLength, async_call_data->hBinding);
1715 pRpcMsg->RpcFlags |= RPC_BUFFER_ASYNC;
1716 status = I_RpcAsyncSetHandle(pRpcMsg, pAsync);
1717 if (status != RPC_S_OK)
1718 RpcRaiseException(status);
1720 case PROXY_SENDRECEIVE:
1721 pRpcMsg->RpcFlags |= RPC_BUFFER_ASYNC;
1722 /* send the [in] params only */
1723 if (Oif_flags.HasPipes)
1724 /* NdrPipesSend(...) */
1725 FIXME("pipes not supported yet\n");
1728 if (pProcHeader->handle_type == RPC_FC_AUTO_HANDLE)
1730 NdrNsSend(&stubMsg, stubMsg.Buffer, pStubDesc->IMPLICIT_HANDLE_INFO.pAutoHandle);
1732 FIXME("using auto handle - call NdrNsSend when it gets implemented\n");
1736 pStubMsg->RpcMsg->BufferLength = pStubMsg->Buffer - (unsigned char *)pStubMsg->RpcMsg->Buffer;
1737 status = I_RpcSend(pStubMsg->RpcMsg);
1738 if (status != RPC_S_OK)
1739 RpcRaiseException(status);
1744 case PROXY_CALCSIZE:
1747 client_do_args(pStubMsg, pFormat, phase, pStubMsg->StackTop,
1748 async_call_data->number_of_params, NULL);
1750 client_do_args_old_format(pStubMsg, pFormat, phase,
1751 pStubMsg->StackTop, async_call_data->stack_size, NULL,
1752 (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_OBJECT), FALSE);
1755 ERR("shouldn't reach here. phase %d\n", phase);
1760 TRACE("returning 0\n");
1764 RPC_STATUS NdrpCompleteAsyncClientCall(RPC_ASYNC_STATE *pAsync, void *Reply)
1766 /* pointer to start of stack where arguments start */
1767 PMIDL_STUB_MESSAGE pStubMsg;
1768 struct async_call_data *async_call_data;
1769 /* the type of pass we are currently doing */
1771 /* header for procedure string */
1772 const NDR_PROC_HEADER * pProcHeader;
1773 /* -Oif or -Oicf generated format */
1775 RPC_STATUS status = RPC_S_OK;
1777 if (!pAsync->StubInfo)
1778 return RPC_S_INVALID_ASYNC_HANDLE;
1780 async_call_data = pAsync->StubInfo;
1781 pStubMsg = async_call_data->pStubMsg;
1782 pProcHeader = async_call_data->pProcHeader;
1784 bV2Format = (pStubMsg->StubDesc->Version >= 0x20000);
1787 * 1. PROXY_CALCSIZE - calculate the buffer size
1788 * 2. PROXY_GETBUFFER - allocate the buffer
1789 * 3. PROXY_MARHSAL - marshal [in] params into the buffer
1790 * 4. PROXY_SENDRECEIVE - send buffer
1791 * Then in NdrpCompleteAsyncClientCall:
1792 * 1. PROXY_SENDRECEIVE - receive buffer
1793 * 2. PROXY_UNMARHSAL - unmarshal [out] params from buffer
1795 for (phase = PROXY_SENDRECEIVE; phase <= PROXY_UNMARSHAL; phase++)
1799 case PROXY_SENDRECEIVE:
1800 pStubMsg->RpcMsg->RpcFlags |= RPC_BUFFER_ASYNC;
1801 /* receive the [out] params */
1802 if (pProcHeader->handle_type == RPC_FC_AUTO_HANDLE)
1804 NdrNsReceive(&stubMsg, stubMsg.Buffer, pStubDesc->IMPLICIT_HANDLE_INFO.pAutoHandle);
1806 FIXME("using auto handle - call NdrNsReceive when it gets implemented\n");
1810 status = I_RpcReceive(pStubMsg->RpcMsg);
1811 if (status != RPC_S_OK)
1813 pStubMsg->BufferLength = pStubMsg->RpcMsg->BufferLength;
1814 pStubMsg->BufferStart = pStubMsg->RpcMsg->Buffer;
1815 pStubMsg->BufferEnd = pStubMsg->BufferStart + pStubMsg->BufferLength;
1816 pStubMsg->Buffer = pStubMsg->BufferStart;
1819 /* convert strings, floating point values and endianess into our
1820 * preferred format */
1822 if ((pStubMsg->RpcMsg.DataRepresentation & 0x0000FFFFUL) != NDR_LOCAL_DATA_REPRESENTATION)
1823 NdrConvert(pStubMsg, pFormat);
1827 case PROXY_UNMARSHAL:
1829 client_do_args(pStubMsg, async_call_data->pParamFormat, phase, pStubMsg->StackTop,
1830 async_call_data->number_of_params, Reply);
1832 client_do_args_old_format(pStubMsg, async_call_data->pParamFormat, phase,
1833 pStubMsg->StackTop, async_call_data->stack_size, Reply, FALSE, FALSE);
1836 ERR("shouldn't reach here. phase %d\n", phase);
1842 if (pStubMsg->fHasNewCorrDesc)
1844 /* free extra correlation package */
1845 NdrCorrelationFree(pStubMsg);
1848 /* free the full pointer translation tables */
1849 if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
1850 NdrFullPointerXlatFree(pStubMsg->FullPtrXlatTables);
1852 /* free marshalling buffer */
1853 NdrFreeBuffer(pStubMsg);
1854 client_free_handle(pStubMsg, pProcHeader, async_call_data->pHandleFormat, async_call_data->hBinding);
1856 I_RpcFree(pStubMsg->StackTop);
1857 I_RpcFree(async_call_data);
1859 TRACE("-- 0x%x\n", status);
1863 RPCRTAPI LONG RPC_ENTRY NdrAsyncStubCall(struct IRpcStubBuffer* pThis,
1864 struct IRpcChannelBuffer* pChannel, PRPC_MESSAGE pRpcMsg,
1865 DWORD * pdwStubPhase)
1867 FIXME("unimplemented, expect crash!\n");