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