dlls/rpcrt4/ndr_es.c

   1 /*
   2  * NDR Serialization Services
   3  *
   4  * Copyright (c) 2007 Robert Shearman for CodeWeavers
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <stdarg.h>
  22 #include <stdio.h>
  23
  24 #include "windef.h"
  25 #include "winbase.h"
  26 #include "winerror.h"
  27 #include "rpc.h"
  28 #include "midles.h"
  29 #include "ndrtypes.h"
  30
  31 #include "ndr_misc.h"
  32 #include "ndr_stubless.h"
  33
  34 #include "wine/debug.h"
  35 #include "wine/rpcfc.h"
  36
  37 WINE_DEFAULT_DEBUG_CHANNEL(ole);
  38
  39 static inline void init_MIDL_ES_MESSAGE(MIDL_ES_MESSAGE *pEsMsg)
  40 {
  41     memset(pEsMsg, 0, sizeof(*pEsMsg));
  42     /* even if we are unmarshalling, as we don't want pointers to be pointed
  43      * to buffer memory */
  44     pEsMsg->StubMsg.IsClient = TRUE;
  45 }
  46
  47 /***********************************************************************
  48  *            MesEncodeIncrementalHandleCreate [RPCRT4.@]
  49  */
  50 RPC_STATUS WINAPI MesEncodeIncrementalHandleCreate(
  51     void *UserState, MIDL_ES_ALLOC AllocFn, MIDL_ES_WRITE WriteFn,
  52     handle_t *pHandle)
  53 {
  54     MIDL_ES_MESSAGE *pEsMsg;
  55
  56     TRACE("(%p, %p, %p, %p)\n", UserState, AllocFn, WriteFn, pHandle);
  57
  58     pEsMsg = HeapAlloc(GetProcessHeap(), 0, sizeof(*pEsMsg));
  59     if (!pEsMsg)
  60         return ERROR_OUTOFMEMORY;
  61
  62     init_MIDL_ES_MESSAGE(pEsMsg);
  63
  64     pEsMsg->Operation = MES_ENCODE;
  65     pEsMsg->UserState = UserState;
  66     pEsMsg->HandleStyle = MES_INCREMENTAL_HANDLE;
  67     pEsMsg->Alloc = AllocFn;
  68     pEsMsg->Write = WriteFn;
  69
  70     *pHandle = (handle_t)pEsMsg;
  71
  72     return RPC_S_OK;
  73 }
  74
  75 /***********************************************************************
  76  *            MesDecodeIncrementalHandleCreate [RPCRT4.@]
  77  */
  78 RPC_STATUS WINAPI MesDecodeIncrementalHandleCreate(
  79     void *UserState, MIDL_ES_READ ReadFn, handle_t *pHandle)
  80 {
  81     MIDL_ES_MESSAGE *pEsMsg;
  82
  83     TRACE("(%p, %p, %p)\n", UserState, ReadFn, pHandle);
  84
  85     pEsMsg = HeapAlloc(GetProcessHeap(), 0, sizeof(*pEsMsg));
  86     if (!pEsMsg)
  87         return ERROR_OUTOFMEMORY;
  88
  89     init_MIDL_ES_MESSAGE(pEsMsg);
  90
  91     pEsMsg->Operation = MES_DECODE;
  92     pEsMsg->UserState = UserState;
  93     pEsMsg->HandleStyle = MES_INCREMENTAL_HANDLE;
  94     pEsMsg->Read = ReadFn;
  95
  96     *pHandle = (handle_t)pEsMsg;
  97
  98     return RPC_S_OK;
  99 }
 100
 101 /***********************************************************************
 102  *            MesIncrementalHandleReset [RPCRT4.@]
 103  */
 104 RPC_STATUS WINAPI MesIncrementalHandleReset(
 105     handle_t Handle, void *UserState, MIDL_ES_ALLOC AllocFn,
 106     MIDL_ES_WRITE WriteFn, MIDL_ES_READ ReadFn, MIDL_ES_CODE Operation)
 107 {
 108     MIDL_ES_MESSAGE *pEsMsg = (MIDL_ES_MESSAGE *)Handle;
 109
 110     TRACE("(%p, %p, %p, %p, %p, %d)\n", Handle, UserState, AllocFn,
 111         WriteFn, ReadFn, Operation);
 112
 113     init_MIDL_ES_MESSAGE(pEsMsg);
 114
 115     pEsMsg->Operation = Operation;
 116     pEsMsg->UserState = UserState;
 117     pEsMsg->HandleStyle = MES_INCREMENTAL_HANDLE;
 118     pEsMsg->Alloc = AllocFn;
 119     pEsMsg->Write = WriteFn;
 120     pEsMsg->Read = ReadFn;
 121
 122     return RPC_S_OK;
 123 }
 124
 125 /***********************************************************************
 126  *            MesHandleFree [RPCRT4.@]
 127  */
 128 RPC_STATUS WINAPI MesHandleFree(handle_t Handle)
 129 {
 130     TRACE("(%p)\n", Handle);
 131     HeapFree(GetProcessHeap(), 0, Handle);
 132     return RPC_S_OK;
 133 }
 134
 135 static void es_data_alloc(MIDL_ES_MESSAGE *pEsMsg, ULONG size)
 136 {
 137     if (pEsMsg->HandleStyle == MES_INCREMENTAL_HANDLE)
 138     {
 139         unsigned int tmpsize = size;
 140         TRACE("%d with incremental handle\n", size);
 141         pEsMsg->Alloc(pEsMsg->UserState, (char **)&pEsMsg->StubMsg.Buffer, &tmpsize);
 142         if (tmpsize < size)
 143         {
 144             ERR("not enough bytes allocated - requested %d, got %d\n", size, tmpsize);
 145             RpcRaiseException(ERROR_OUTOFMEMORY);
 146         }
 147     }
 148     pEsMsg->StubMsg.RpcMsg->Buffer = pEsMsg->StubMsg.BufferStart = pEsMsg->StubMsg.Buffer;
 149 }
 150
 151 static void es_data_read(MIDL_ES_MESSAGE *pEsMsg, ULONG size)
 152 {
 153     if (pEsMsg->HandleStyle == MES_INCREMENTAL_HANDLE)
 154     {
 155         unsigned int tmpsize = size;
 156         TRACE("%d from incremental handle\n", size);
 157         pEsMsg->Read(pEsMsg->UserState, (char **)&pEsMsg->StubMsg.Buffer, &tmpsize);
 158         if (tmpsize < size)
 159         {
 160             ERR("not enough bytes read - requested %d, got %d\n", size, tmpsize);
 161             RpcRaiseException(ERROR_OUTOFMEMORY);
 162         }
 163     }
 164     pEsMsg->StubMsg.BufferLength = size;
 165     pEsMsg->StubMsg.RpcMsg->Buffer = pEsMsg->StubMsg.BufferStart = pEsMsg->StubMsg.Buffer;
 166     pEsMsg->StubMsg.BufferEnd = pEsMsg->StubMsg.Buffer + size;
 167 }
 168
 169 static void es_data_write(MIDL_ES_MESSAGE *pEsMsg, ULONG size)
 170 {
 171     if (pEsMsg->HandleStyle == MES_INCREMENTAL_HANDLE)
 172     {
 173         TRACE("%d to incremental handle\n", size);
 174         pEsMsg->Write(pEsMsg->UserState, (char *)pEsMsg->StubMsg.BufferStart, size);
 175     }
 176 }
 177
 178 static inline ULONG mes_proc_header_buffer_size(void)
 179 {
 180     return 4 + 2*sizeof(RPC_SYNTAX_IDENTIFIER) + 12;
 181 }
 182
 183 static void mes_proc_header_marshal(MIDL_ES_MESSAGE *pEsMsg)
 184 {
 185     const RPC_CLIENT_INTERFACE *client_interface = pEsMsg->StubMsg.StubDesc->RpcInterfaceInformation;
 186     *(WORD *)pEsMsg->StubMsg.Buffer = 0x0101;
 187     pEsMsg->StubMsg.Buffer += 2;
 188     *(WORD *)pEsMsg->StubMsg.Buffer = 0xcccc;
 189     pEsMsg->StubMsg.Buffer += 2;
 190     memcpy(pEsMsg->StubMsg.Buffer, &client_interface->TransferSyntax, sizeof(RPC_SYNTAX_IDENTIFIER));
 191     pEsMsg->StubMsg.Buffer += sizeof(RPC_SYNTAX_IDENTIFIER);
 192     memcpy(pEsMsg->StubMsg.Buffer, &pEsMsg->InterfaceId, sizeof(RPC_SYNTAX_IDENTIFIER));
 193     pEsMsg->StubMsg.Buffer += sizeof(RPC_SYNTAX_IDENTIFIER);
 194     *(DWORD *)pEsMsg->StubMsg.Buffer = pEsMsg->ProcNumber;
 195     pEsMsg->StubMsg.Buffer += 4;
 196     *(DWORD *)pEsMsg->StubMsg.Buffer = 0x00000001;
 197     pEsMsg->StubMsg.Buffer += 4;
 198     *(DWORD *)pEsMsg->StubMsg.Buffer = pEsMsg->ByteCount;
 199     pEsMsg->StubMsg.Buffer += 4;
 200 }
 201
 202 static void mes_proc_header_unmarshal(MIDL_ES_MESSAGE *pEsMsg)
 203 {
 204     const RPC_CLIENT_INTERFACE *client_interface = pEsMsg->StubMsg.StubDesc->RpcInterfaceInformation;
 205
 206     es_data_read(pEsMsg, mes_proc_header_buffer_size());
 207
 208     if (*(WORD *)pEsMsg->StubMsg.Buffer != 0x0101)
 209     {
 210         FIXME("unknown value at Buffer[0] 0x%04x\n", *(WORD *)pEsMsg->StubMsg.Buffer);
 211         RpcRaiseException(RPC_X_WRONG_ES_VERSION);
 212     }
 213     pEsMsg->StubMsg.Buffer += 2;
 214     if (*(WORD *)pEsMsg->StubMsg.Buffer != 0xcccc)
 215         FIXME("unknown value at Buffer[2] 0x%04x\n", *(WORD *)pEsMsg->StubMsg.Buffer);
 216     pEsMsg->StubMsg.Buffer += 2;
 217     if (memcmp(pEsMsg->StubMsg.Buffer, &client_interface->TransferSyntax, sizeof(RPC_SYNTAX_IDENTIFIER)))
 218     {
 219         const RPC_SYNTAX_IDENTIFIER *AlienTransferSyntax = (const RPC_SYNTAX_IDENTIFIER *)pEsMsg->StubMsg.Buffer;
 220         ERR("bad transfer syntax %s {%d.%d}\n", debugstr_guid(&AlienTransferSyntax->SyntaxGUID),
 221             AlienTransferSyntax->SyntaxVersion.MajorVersion,
 222             AlienTransferSyntax->SyntaxVersion.MinorVersion);
 223         RpcRaiseException(RPC_S_UNSUPPORTED_TRANS_SYN);
 224     }
 225     pEsMsg->StubMsg.Buffer += sizeof(RPC_SYNTAX_IDENTIFIER);
 226     memcpy(&pEsMsg->InterfaceId, pEsMsg->StubMsg.Buffer, sizeof(RPC_SYNTAX_IDENTIFIER));
 227     pEsMsg->StubMsg.Buffer += sizeof(RPC_SYNTAX_IDENTIFIER);
 228     pEsMsg->ProcNumber = *(DWORD *)pEsMsg->StubMsg.Buffer;
 229     pEsMsg->StubMsg.Buffer += 4;
 230     if (*(DWORD *)pEsMsg->StubMsg.Buffer != 0x00000001)
 231         FIXME("unknown value 0x%08x, expected 0x00000001\n", *(DWORD *)pEsMsg->StubMsg.Buffer);
 232     pEsMsg->StubMsg.Buffer += 4;
 233     pEsMsg->ByteCount = *(DWORD *)pEsMsg->StubMsg.Buffer;
 234     pEsMsg->StubMsg.Buffer += 4;
 235     if (pEsMsg->ByteCount + mes_proc_header_buffer_size() < pEsMsg->ByteCount)
 236         RpcRaiseException(RPC_S_INVALID_BOUND);
 237 }
 238
 239 /***********************************************************************
 240  *            NdrMesProcEncodeDecode [RPCRT4.@]
 241  */
 242 void WINAPIV NdrMesProcEncodeDecode(handle_t Handle, const MIDL_STUB_DESC * pStubDesc, PFORMAT_STRING pFormat, ...)
 243 {
 244     /* pointer to start of stack where arguments start */
 245     RPC_MESSAGE rpcMsg;
 246     MIDL_ES_MESSAGE *pEsMsg = (MIDL_ES_MESSAGE *)Handle;
 247     /* size of stack */
 248     unsigned short stack_size;
 249     /* header for procedure string */
 250     const NDR_PROC_HEADER *pProcHeader = (const NDR_PROC_HEADER *)&pFormat[0];
 251     /* the value to return to the client from the remote procedure */
 252     LONG_PTR RetVal = 0;
 253     const RPC_CLIENT_INTERFACE *client_interface;
 254
 255     TRACE("Handle %p, pStubDesc %p, pFormat %p, ...\n", Handle, pStubDesc, pFormat);
 256
 257     /* Later NDR language versions probably won't be backwards compatible */
 258     if (pStubDesc->Version > 0x50002)
 259     {
 260         FIXME("Incompatible stub description version: 0x%x\n", pStubDesc->Version);
 261         RpcRaiseException(RPC_X_WRONG_STUB_VERSION);
 262     }
 263
 264     client_interface = pStubDesc->RpcInterfaceInformation;
 265     pEsMsg->InterfaceId = client_interface->InterfaceId;
 266
 267     if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_RPCFLAGS)
 268     {
 269         const NDR_PROC_HEADER_RPC *pProcHeader = (const NDR_PROC_HEADER_RPC *)&pFormat[0];
 270         stack_size = pProcHeader->stack_size;
 271         pEsMsg->ProcNumber = pProcHeader->proc_num;
 272         pFormat += sizeof(NDR_PROC_HEADER_RPC);
 273     }
 274     else
 275     {
 276         stack_size = pProcHeader->stack_size;
 277         pEsMsg->ProcNumber = pProcHeader->proc_num;
 278         pFormat += sizeof(NDR_PROC_HEADER);
 279     }
 280
 281     if (pProcHeader->handle_type == RPC_FC_BIND_EXPLICIT)
 282     {
 283         switch (*pFormat) /* handle_type */
 284         {
 285         case RPC_FC_BIND_PRIMITIVE: /* explicit primitive */
 286             pFormat += sizeof(NDR_EHD_PRIMITIVE);
 287             break;
 288         case RPC_FC_BIND_GENERIC: /* explicit generic */
 289             pFormat += sizeof(NDR_EHD_GENERIC);
 290             break;
 291         case RPC_FC_BIND_CONTEXT: /* explicit context */
 292             pFormat += sizeof(NDR_EHD_CONTEXT);
 293             break;
 294         default:
 295             ERR("bad explicit binding handle type (0x%02x)\n", pProcHeader->handle_type);
 296             RpcRaiseException(RPC_X_BAD_STUB_DATA);
 297         }
 298     }
 299
 300     TRACE("stack size: 0x%x\n", stack_size);
 301     TRACE("proc num: %d\n", pEsMsg->ProcNumber);
 302
 303     memset(&rpcMsg, 0, sizeof(rpcMsg));
 304     pEsMsg->StubMsg.RpcMsg = &rpcMsg;
 305     pEsMsg->StubMsg.StubDesc = pStubDesc;
 306     pEsMsg->StubMsg.pfnAllocate = pStubDesc->pfnAllocate;
 307     pEsMsg->StubMsg.pfnFree = pStubDesc->pfnFree;
 308
 309     /* create the full pointer translation tables, if requested */
 310     if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
 311         pEsMsg->StubMsg.FullPtrXlatTables = NdrFullPointerXlatInit(0,XLAT_CLIENT);
 312
 313     TRACE("Oi_flags = 0x%02x\n", pProcHeader->Oi_flags);
 314     TRACE("stubdesc version = 0x%x\n", pStubDesc->Version);
 315     TRACE("MIDL stub version = 0x%x\n", pStubDesc->MIDLVersion);
 316
 317     /* needed for conformance of top-level objects */
 318 #ifdef __i386__
 319     pEsMsg->StubMsg.StackTop = *(unsigned char **)(&pFormat+1);
 320 #else
 321 # warning Stack not retrieved for your CPU architecture
 322 #endif
 323
 324     switch (pEsMsg->Operation)
 325     {
 326     case MES_ENCODE:
 327         pEsMsg->StubMsg.BufferLength = mes_proc_header_buffer_size();
 328
 329         client_do_args_old_format(&pEsMsg->StubMsg, pFormat, PROXY_CALCSIZE,
 330             pEsMsg->StubMsg.StackTop, stack_size, (unsigned char *)&RetVal,
 331             FALSE /* object_proc */);
 332
 333         pEsMsg->ByteCount = pEsMsg->StubMsg.BufferLength - mes_proc_header_buffer_size();
 334         es_data_alloc(pEsMsg, pEsMsg->StubMsg.BufferLength);
 335
 336         mes_proc_header_marshal(pEsMsg);
 337
 338         client_do_args_old_format(&pEsMsg->StubMsg, pFormat, PROXY_MARSHAL,
 339             pEsMsg->StubMsg.StackTop, stack_size, (unsigned char *)&RetVal,
 340             FALSE /* object_proc */);
 341
 342         es_data_write(pEsMsg, pEsMsg->ByteCount);
 343         break;
 344     case MES_DECODE:
 345         mes_proc_header_unmarshal(pEsMsg);
 346
 347         es_data_read(pEsMsg, pEsMsg->ByteCount);
 348
 349         client_do_args_old_format(&pEsMsg->StubMsg, pFormat, PROXY_UNMARSHAL,
 350             pEsMsg->StubMsg.StackTop, stack_size, (unsigned char *)&RetVal,
 351             FALSE /* object_proc */);
 352         break;
 353     default:
 354         RpcRaiseException(RPC_S_INTERNAL_ERROR);
 355         return;
 356     }
 357     /* free the full pointer translation tables */
 358     if (pProcHeader->Oi_flags & RPC_FC_PROC_OIF_FULLPTR)
 359         NdrFullPointerXlatFree(pEsMsg->StubMsg.FullPtrXlatTables);
 360 }