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 /* there can't be any alignment with the structures in this file */
  22 #include "pshpack1.h"
  23
  24 /* From http://msdn.microsoft.com/library/default.asp?url=/library/en-us/rpc/rpc/parameter_descriptors.asp */
  25 typedef struct _NDR_PROC_HEADER
  26 {
  27     /* type of handle to use:
  28      * RPC_FC_BIND_EXPLICIT = 0 - Explicit handle.
  29      *   Handle is passed as a parameter to the function.
  30      *   Indicates that explicit handle information follows the header,
  31      *   which actually describes the handle.
  32      * RPC_FC_BIND_GENERIC = 31 - Implicit handle with custom binding routines
  33      *   (MIDL_STUB_DESC::IMPLICIT_HANDLE_INFO::pGenericBindingInfo)
  34      * RPC_FC_BIND_PRIMITIVE = 32 - Implicit handle using handle_t created by
  35      *   calling application
  36      * RPC_FC_AUTO_HANDLE = 33 - Automatic handle
  37      * RPC_FC_CALLBACK_HANDLE = 34 - undocmented
  38      */
  39     unsigned char handle_type;
  40
  41     /* procedure flags:
  42      * Oi_FULL_PTR_USED = 0x01 - A full pointer can have the value NULL and can
  43      *   change during the call from NULL to non-NULL and supports aliasing
  44      *   and cycles. Indicates that the NdrFullPointerXlatInit function
  45      *   should be called.
  46      * Oi_RPCSS_ALLOC_USED = 0x02 - Use RpcSS allocate/free routines instead of
  47      *   normal allocate/free routines
  48      * Oi_OBJECT_PROC = 0x04 - Indicates a procedure that is part of an OLE
  49      *   interface, rather than a DCE RPC interface.
  50      * Oi_HAS_RPCFLAGS = 0x08 - Indicates that the rpc_flags element is
  51      *   present in the header.
  52      * Oi_HAS_COMM_OR_FAULT = 0x20 - If Oi_OBJECT_PROC not present only then
  53      *   indicates that the procedure has the comm_status or fault_status
  54      *   MIDL attribute.
  55      * Oi_OBJ_USE_V2_INTERPRETER = 0x20 - If Oi_OBJECT_PROC present only
  56      *   then indicates that the format string is in -Oif or -Oicf format
  57      * Oi_USE_NEW_INIT_ROUTINES = 0x40 - Use NdrXInitializeNew instead of
  58      *   NdrXInitialize?
  59      */
  60     unsigned char Oi_flags;
  61
  62     /* the zero-based index of the procedure */
  63     unsigned short proc_num;
  64
  65     /* total size of all parameters on the stack, including any "this"
  66      * pointer and/or return value */
  67     unsigned short stack_size;
  68 } NDR_PROC_HEADER;
  69
  70 /* same as above struct except additional element rpc_flags */
  71 typedef struct _NDR_PROC_HEADER_RPC
  72 {
  73     unsigned char handle_type;
  74     unsigned char Oi_flags;
  75
  76     /*
  77      * RPCF_Idempotent = 0x0001 - [idempotent] MIDL attribute
  78      * RPCF_Broadcast = 0x0002 - [broadcast] MIDL attribute
  79      * RPCF_Maybe = 0x0004 - [maybe] MIDL attribute
  80      * Reserved = 0x0008 - 0x0080
  81      * RPCF_Message = 0x0100 - [message] MIDL attribute
  82      * Reserved = 0x0200 - 0x1000
  83      * RPCF_InputSynchronous = 0x2000 - unknown
  84      * RPCF_Asynchronous = 0x4000 - [async] MIDL attribute
  85      * Reserved = 0x8000
  86      */
  87     unsigned long rpc_flags;
  88     unsigned short proc_num;
  89     unsigned short stack_size;
  90
  91 } NDR_PROC_HEADER_RPC;
  92
  93 typedef struct _NDR_PROC_PARTIAL_OIF_HEADER
  94 {
  95     /* the pre-computed client buffer size so that interpreter can skip all
  96      * or some (if the flag RPC_FC_PROC_OI2F_CLTMUSTSIZE is specified) of the
  97      * sizing pass */
  98     unsigned short constant_client_buffer_size;
  99
 100     /* the pre-computed server buffer size so that interpreter can skip all
 101      * or some (if the flag RPC_FC_PROC_OI2F_SRVMUSTSIZE is specified) of the
 102      * 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 _NDR_PARAM_OIF_BASETYPE
 144 {
 145     PARAM_ATTRIBUTES param_attributes;
 146
 147     /* the offset on the calling stack where the parameter is located */
 148     unsigned short stack_offset;
 149
 150     /* see NDR_PARAM_OI_BASETYPE::type_format_char */
 151     unsigned char type_format_char;
 152
 153     /* always FC_PAD */
 154     unsigned char unused;
 155 } NDR_PARAM_OIF_BASETYPE;
 156
 157 typedef struct _NDR_PARAM_OIF_OTHER
 158 {
 159     PARAM_ATTRIBUTES param_attributes;
 160
 161     /* see NDR_PARAM_OIF_BASETYPE::stack_offset */
 162     unsigned short stack_offset;
 163
 164     /* offset into the provided type format string where the type for this
 165      * parameter starts */
 166     unsigned short type_offset;
 167 } NDR_PARAM_OIF_OTHER;
 168
 169 /* explicit handle description for FC_BIND_PRIMITIVE type */
 170 typedef struct _NDR_EHD_PRIMITIVE
 171 {
 172     /* FC_BIND_PRIMITIVE */
 173     unsigned char handle_type;
 174
 175     /* is the handle passed in via a pointer? */
 176     unsigned char flag;
 177
 178     /* offset from the beginning of the stack to the handle in bytes */
 179     unsigned short offset;
 180 } NDR_EHD_PRIMITIVE;
 181
 182 /* explicit handle description for FC_BIND_GENERIC type */
 183 typedef struct _NDR_EHD_GENERIC
 184 {
 185     /* FC_BIND_GENERIC */
 186     unsigned char handle_type;
 187
 188     /* upper 4bits is a flag indicating whether the handle is passed in
 189      * via a pointer. lower 4bits is the size of the user defined generic
 190      * handle type. the size must be less than or equal to the machine
 191      * register size */
 192     unsigned char flag_and_size;
 193
 194     /* offset from the beginning of the stack to the handle in bytes */
 195     unsigned short offset;
 196
 197     /* the index into the aGenericBindingRoutinesPairs field of MIDL_STUB_DESC
 198      * giving the bind and unbind routines for the handle */
 199     unsigned char binding_routine_pair_index;
 200
 201     /* FC_PAD */
 202     unsigned char unused;
 203 } NDR_EHD_GENERIC;
 204
 205 /* explicit handle description for FC_BIND_CONTEXT type */
 206 typedef struct _NDR_EHD_CONTEXT
 207 {
 208     /* FC_BIND_CONTEXT */
 209     unsigned char handle_type;
 210
 211     /* Any of the following flags:
 212      * NDR_CONTEXT_HANDLE_CANNOT_BE_NULL = 0x01
 213      * NDR_CONTEXT_HANDLE_SERIALIZE = 0x02
 214      * NDR_CONTEXT_HANDLE_NO_SERIALIZE = 0x04
 215      * NDR_STRICT_CONTEXT_HANDLE = 0x08
 216      * HANDLE_PARAM_IS_OUT = 0x20
 217      * HANDLE_PARAM_IS_RETURN = 0x21
 218      * HANDLE_PARAM_IS_IN = 0x40
 219      * HANDLE_PARAM_IS_VIA_PTR = 0x80
 220      */
 221     unsigned char flags;
 222
 223     /* offset from the beginning of the stack to the handle in bytes */
 224     unsigned short offset;
 225
 226     /* zero-based index on rundown routine in apfnNdrRundownRoutines field
 227      * of MIDL_STUB_DESC */
 228     unsigned char context_rundown_routine_index;
 229
 230     /* varies depending on NDR version used.
 231      * V1: zero-based index into parameters
 232      * V2: zero-based index into handles that are parameters */
 233     unsigned char param_num;
 234 } NDR_EHD_CONTEXT;
 235
 236 #include "poppack.h"