dlls/rpcrt4/ndr_stubless.h

   1 /*
   2  * NDR -Oi,-Oif,-Oicf Interpreter
   3  *
   4  * Copyright 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 "ndrtypes.h"
  22
  23 /* there can't be any alignment with the structures in this file */
  24 #include "pshpack1.h"
  25
  26 typedef struct _NDR_PROC_HEADER
  27 {
  28     /* type of handle to use:
  29      * 0 - Explicit handle.
  30      *   Handle is passed as a parameter to the function.
  31      *   Indicates that explicit handle information follows the header,
  32      *   which actually describes the handle.
  33      * FC_BIND_GENERIC = 31 - Implicit handle with custom binding routines
  34      *   (MIDL_STUB_DESC::IMPLICIT_HANDLE_INFO::pGenericBindingInfo)
  35      * FC_BIND_PRIMITIVE = 32 - Implicit handle using handle_t created by
  36      *   calling application
  37      * FC_AUTO_HANDLE = 33 - Automatic handle
  38      * FC_CALLBACK_HANDLE = 34 - Implicit handle used for a callback: current handle
  39      *   from last remote call
  40      */
  41     unsigned char handle_type;
  42
  43     /* procedure flags:
  44      * Oi_FULL_PTR_USED = 0x01 - A full pointer can have the value NULL and can
  45      *   change during the call from NULL to non-NULL and supports aliasing
  46      *   and cycles. Indicates that the NdrFullPointerXlatInit function
  47      *   should be called.
  48      * Oi_RPCSS_ALLOC_USED = 0x02 - Use RpcSS allocate/free routines instead of
  49      *   normal allocate/free routines
  50      * Oi_OBJECT_PROC = 0x04 - Indicates a procedure that is part of an OLE
  51      *   interface, rather than a DCE RPC interface.
  52      * Oi_HAS_RPCFLAGS = 0x08 - Indicates that the rpc_flags element is
  53      *   present in the header.
  54      * Oi_HAS_COMM_OR_FAULT = 0x20 - If Oi_OBJECT_PROC not present only then
  55      *   indicates that the procedure has the comm_status or fault_status
  56      *   MIDL attribute.
  57      * Oi_OBJ_USE_V2_INTERPRETER = 0x20 - If Oi_OBJECT_PROC present only
  58      *   then indicates that the format string is in -Oif or -Oicf format
  59      * Oi_USE_NEW_INIT_ROUTINES = 0x40 - Use NdrXInitializeNew instead of
  60      *   NdrXInitialize?
  61      */
  62     unsigned char Oi_flags;
  63
  64     /* the zero-based index of the procedure */
  65     unsigned short proc_num;
  66
  67     /* total size of all parameters on the stack, including any "this"
  68      * pointer and/or return value */
  69     unsigned short stack_size;
  70 } NDR_PROC_HEADER;
  71
  72 /* same as above struct except additional element rpc_flags */
  73 typedef struct _NDR_PROC_HEADER_RPC
  74 {
  75     unsigned char handle_type;
  76     unsigned char Oi_flags;
  77
  78     /*
  79      * RPCF_Idempotent = 0x0001 - [idempotent] MIDL attribute
  80      * RPCF_Broadcast = 0x0002 - [broadcast] MIDL attribute
  81      * RPCF_Maybe = 0x0004 - [maybe] MIDL attribute
  82      * Reserved = 0x0008 - 0x0080
  83      * RPCF_Message = 0x0100 - [message] MIDL attribute
  84      * Reserved = 0x0200 - 0x1000
  85      * RPCF_InputSynchronous = 0x2000 - unknown
  86      * RPCF_Asynchronous = 0x4000 - [async] MIDL attribute
  87      * Reserved = 0x8000
  88      */
  89     unsigned int rpc_flags;
  90     unsigned short proc_num;
  91     unsigned short stack_size;
  92
  93 } NDR_PROC_HEADER_RPC;
  94
  95 typedef struct _NDR_PROC_PARTIAL_OIF_HEADER
  96 {
  97     /* the pre-computed client buffer size so that interpreter can skip all
  98      * or some (if the flag ClientMustSize is specified) of the sizing pass */
  99     unsigned short constant_client_buffer_size;
 100
 101     /* the pre-computed server buffer size so that interpreter can skip all
 102      * or some (if the flag ServerMustSize is specified) of the sizing pass */
 103     unsigned short constant_server_buffer_size;
 104
 105     INTERPRETER_OPT_FLAGS Oi2Flags;
 106
 107     /* number of params */
 108     unsigned char number_of_params;
 109 } NDR_PROC_PARTIAL_OIF_HEADER;
 110
 111 typedef struct _NDR_PARAM_OI_BASETYPE
 112 {
 113     /* parameter direction. One of:
 114      * FC_IN_PARAM_BASETYPE = 0x4e - an in param
 115      * FC_RETURN_PARAM_BASETYPE = 0x53 - a return param
 116      */
 117     unsigned char param_direction;
 118
 119     /* One of: FC_BYTE,FC_CHAR,FC_SMALL,FC_USMALL,FC_WCHAR,FC_SHORT,FC_USHORT,
 120      * FC_LONG,FC_ULONG,FC_FLOAT,FC_HYPER,FC_DOUBLE,FC_ENUM16,FC_ENUM32,
 121      * FC_ERROR_STATUS_T,FC_INT3264,FC_UINT3264 */
 122     unsigned char type_format_char;
 123 } NDR_PARAM_OI_BASETYPE;
 124
 125 typedef struct _NDR_PARAM_OI_OTHER
 126 {
 127     /* One of:
 128      * FC_IN_PARAM = 0x4d - An in param
 129      * FC_IN_OUT_PARAM = 0x50 - An in/out param
 130      * FC_OUT_PARAM = 0x51 - An out param
 131      * FC_RETURN_PARAM = 0x52 - A return value
 132      * FC_IN_PARAM_NO_FREE_INST = 0x4f - A param for which no freeing is done
 133      */
 134     unsigned char param_direction;
 135
 136     /* Size of param on stack in NUMBERS OF INTS */
 137     unsigned char stack_size;
 138
 139     /* offset in the type format string table */
 140     unsigned short type_offset;
 141 } NDR_PARAM_OI_OTHER;
 142
 143 typedef struct
 144 {
 145     PARAM_ATTRIBUTES attr;
 146     /* the offset on the calling stack where the parameter is located */
 147     unsigned short stack_offset;
 148     union
 149     {
 150         /* see NDR_PARAM_OI_BASETYPE::type_format_char */
 151         unsigned char type_format_char;
 152         /* offset into the provided type format string where the type for this
 153          * parameter starts */
 154         unsigned short type_offset;
 155     } u;
 156 } NDR_PARAM_OIF;
 157
 158 /* explicit handle description for FC_BIND_PRIMITIVE type */
 159 typedef struct _NDR_EHD_PRIMITIVE
 160 {
 161     /* FC_BIND_PRIMITIVE */
 162     unsigned char handle_type;
 163
 164     /* is the handle passed in via a pointer? */
 165     unsigned char flag;
 166
 167     /* offset from the beginning of the stack to the handle in bytes */
 168     unsigned short offset;
 169 } NDR_EHD_PRIMITIVE;
 170
 171 /* explicit handle description for FC_BIND_GENERIC type */
 172 typedef struct _NDR_EHD_GENERIC
 173 {
 174     /* FC_BIND_GENERIC */
 175     unsigned char handle_type;
 176
 177     /* upper 4bits is a flag indicating whether the handle is passed in
 178      * via a pointer. lower 4bits is the size of the user defined generic
 179      * handle type. the size must be less than or equal to the machine
 180      * register size */
 181     unsigned char flag_and_size;
 182
 183     /* offset from the beginning of the stack to the handle in bytes */
 184     unsigned short offset;
 185
 186     /* the index into the aGenericBindingRoutinesPairs field of MIDL_STUB_DESC
 187      * giving the bind and unbind routines for the handle */
 188     unsigned char binding_routine_pair_index;
 189
 190     /* FC_PAD */
 191     unsigned char unused;
 192 } NDR_EHD_GENERIC;
 193
 194 /* explicit handle description for FC_BIND_CONTEXT type */
 195 typedef struct _NDR_EHD_CONTEXT
 196 {
 197     /* FC_BIND_CONTEXT */
 198     unsigned char handle_type;
 199
 200     /* Any of the following flags:
 201      * NDR_CONTEXT_HANDLE_CANNOT_BE_NULL = 0x01
 202      * NDR_CONTEXT_HANDLE_SERIALIZE = 0x02
 203      * NDR_CONTEXT_HANDLE_NO_SERIALIZE = 0x04
 204      * NDR_STRICT_CONTEXT_HANDLE = 0x08
 205      * HANDLE_PARAM_IS_RETURN = 0x10
 206      * HANDLE_PARAM_IS_OUT = 0x20
 207      * HANDLE_PARAM_IS_IN = 0x40
 208      * HANDLE_PARAM_IS_VIA_PTR = 0x80
 209      */
 210     unsigned char flags;
 211
 212     /* offset from the beginning of the stack to the handle in bytes */
 213     unsigned short offset;
 214
 215     /* zero-based index on rundown routine in apfnNdrRundownRoutines field
 216      * of MIDL_STUB_DESC */
 217     unsigned char context_rundown_routine_index;
 218
 219     /* varies depending on NDR version used.
 220      * V1: zero-based index into parameters
 221      * V2: zero-based index into handles that are parameters */
 222     unsigned char param_num;
 223 } NDR_EHD_CONTEXT;
 224
 225 #include "poppack.h"
 226
 227 struct async_call_data
 228 {
 229     MIDL_STUB_MESSAGE *pStubMsg;
 230     const NDR_PROC_HEADER *pProcHeader;
 231     PFORMAT_STRING pHandleFormat;
 232     PFORMAT_STRING pParamFormat;
 233     RPC_BINDING_HANDLE hBinding;
 234     /* size of stack */
 235     unsigned short stack_size;
 236     /* number of parameters. optional for client to give it to us */
 237     unsigned int number_of_params;
 238     /* location to put retval into */
 239     LONG_PTR *retval_ptr;
 240     /* correlation cache */
 241     ULONG_PTR NdrCorrCache[256];
 242 };
 243
 244 enum stubless_phase
 245 {
 246     STUBLESS_UNMARSHAL,
 247     STUBLESS_INITOUT,
 248     STUBLESS_CALLSERVER,
 249     STUBLESS_CALCSIZE,
 250     STUBLESS_GETBUFFER,
 251     STUBLESS_MARSHAL,
 252     STUBLESS_MUSTFREE,
 253     STUBLESS_FREE
 254 };
 255
 256 LONG_PTR CDECL ndr_client_call( PMIDL_STUB_DESC pStubDesc, PFORMAT_STRING pFormat,
 257                                 void **stack_top, void **fpu_stack ) DECLSPEC_HIDDEN;
 258 LONG_PTR CDECL ndr_async_client_call( PMIDL_STUB_DESC pStubDesc, PFORMAT_STRING pFormat,
 259                                       void **stack_top ) DECLSPEC_HIDDEN;
 260 void client_do_args( PMIDL_STUB_MESSAGE pStubMsg, PFORMAT_STRING pFormat, enum stubless_phase phase,
 261                      void **fpu_args, unsigned short number_of_params, unsigned char *pRetVal ) DECLSPEC_HIDDEN;
 262 PFORMAT_STRING convert_old_args( PMIDL_STUB_MESSAGE pStubMsg, PFORMAT_STRING pFormat,
 263                                  unsigned int stack_size, BOOL object_proc,
 264                                  void *buffer, unsigned int size, unsigned int *count ) DECLSPEC_HIDDEN;
 265 RPC_STATUS NdrpCompleteAsyncClientCall(RPC_ASYNC_STATE *pAsync, void *Reply) DECLSPEC_HIDDEN;
 266 RPC_STATUS NdrpCompleteAsyncServerCall(RPC_ASYNC_STATE *pAsync, void *Reply) DECLSPEC_HIDDEN;