server: Add functions for conversions between server user handles and pointer-style...
[wine] / include / wine / rpcfc.h
1 /*
2  * RPC format chars, as found by studying MIDL output.
3  * Some, but not all, usage of these are explained on MSDN.
4  */
5
6 #ifndef __WINE_RPCFC_H
7 #define __WINE_RPCFC_H
8
9 /* base types */
10 #define RPC_FC_BYTE                     0x01
11 #define RPC_FC_CHAR                     0x02
12 #define RPC_FC_SMALL                    0x03
13 #define RPC_FC_USMALL                   0x04
14 #define RPC_FC_WCHAR                    0x05
15 #define RPC_FC_SHORT                    0x06
16 #define RPC_FC_USHORT                   0x07
17 #define RPC_FC_LONG                     0x08
18 #define RPC_FC_ULONG                    0x09
19 #define RPC_FC_FLOAT                    0x0a
20 #define RPC_FC_HYPER                    0x0b
21 #define RPC_FC_DOUBLE                   0x0c
22 #define RPC_FC_ENUM16                   0x0d
23 #define RPC_FC_ENUM32                   0x0e
24 #define RPC_FC_IGNORE                   0x0f
25 #define RPC_FC_ERROR_STATUS_T           0x10
26
27 /* other stuff */
28 #define RPC_FC_RP                       0x11 /* reference pointer */
29 #define RPC_FC_UP                       0x12 /* unique pointer */
30 #define RPC_FC_OP                       0x13 /* unique pointer in object ? */
31 #define RPC_FC_FP                       0x14 /* full pointer */
32
33 #define RPC_FC_STRUCT                   0x15 /* simple structure */
34 /* FC_STRUCT: align-1, NdrFcShort(size), fields */
35
36 #define RPC_FC_PSTRUCT                  0x16 /* simple structure w/ pointers */
37 /* FC_PTRUCT: align-1, NdrFcShort(size), ptrs, fields */
38
39 #define RPC_FC_CSTRUCT                  0x17 /* conformant structure */
40
41 #define RPC_FC_CPSTRUCT                 0x18 /* conformant structure w/ pointers */
42
43 #define RPC_FC_CVSTRUCT                 0x19 /* conformant varying struct */
44
45 #define RPC_FC_BOGUS_STRUCT             0x1a /* complex structure */
46
47 #define RPC_FC_CARRAY                   0x1b /* conformant array */
48 /* FC_CARRAY: align-1, NdrFcShort(size), conformance, ptrs, fields */
49 #define RPC_FC_CVARRAY                  0x1c /* conformant varying array */
50 /* FC_CARRAY: align-1, NdrFcShort(size), conformance, variance, ptrs, fields */
51 #define RPC_FC_SMFARRAY                 0x1d /* small (<64K) fixed array */
52 /* FC_SMFARRAY: align-1, NdrFcShort(size), ptrs, fields */
53
54 #define RPC_FC_LGFARRAY                 0x1e /* large (>= 64k) fixed array */
55
56 #define RPC_FC_SMVARRAY                 0x1f /* small (<64k) varying array */
57
58 #define RPC_FC_LGVARRAY                 0x20 /* large (>= 64k) varying array */
59
60 #define RPC_FC_BOGUS_ARRAY              0x21 /* complex array */
61
62 #define RPC_FC_C_CSTRING                0x22
63 #define RPC_FC_C_SSTRING                0x24
64 #define RPC_FC_C_WSTRING                0x25
65 #define RPC_FC_CSTRING                  0x26
66 #define RPC_FC_SSTRING                  0x28
67 #define RPC_FC_WSTRING                  0x29
68
69 #define RPC_FC_ENCAPSULATED_UNION       0x2a
70 #define RPC_FC_NON_ENCAPSULATED_UNION   0x2b
71
72 #define RPC_FC_BYTE_COUNT_POINTER       0x2c /* [byte_count] ACF attribute */
73
74 #define RPC_FC_TRANSMIT_AS              0x2d
75 #define RPC_FC_REPRESENT_AS             0x2e
76
77 #define RPC_FC_IP                       0x2f /* interface pointer */
78 /* FC_IP: FC_CONSTANT_IID iid */
79 /* FC_IP: FC_PAD correlation */
80
81 #define RPC_FC_BIND_CONTEXT             0x30
82
83 #define RPC_FC_BIND_GENERIC             0x31
84 #define RPC_FC_BIND_PRIMITIVE           0x32
85 #define RPC_FC_AUTO_HANDLE              0x33
86 #define RPC_FC_CALLBACK_HANDLE          0x34
87
88 #define RPC_FC_POINTER                  0x36
89
90 #define RPC_FC_ALIGNM4                  0x38
91 #define RPC_FC_ALIGNM8                  0x39
92
93 #define RPC_FC_STRUCTPAD1               0x3d
94 #define RPC_FC_STRUCTPAD2               0x3e
95 #define RPC_FC_STRUCTPAD3               0x3f
96 #define RPC_FC_STRUCTPAD4       0x40
97 #define RPC_FC_STRUCTPAD5       0x41
98 #define RPC_FC_STRUCTPAD6       0x42
99 #define RPC_FC_STRUCTPAD7       0x43
100
101 #define RPC_FC_STRING_SIZED             0x44
102
103 #define RPC_FC_NO_REPEAT                0x46
104 #define RPC_FC_FIXED_REPEAT             0x47
105 #define RPC_FC_VARIABLE_REPEAT          0x48
106 #define RPC_FC_FIXED_OFFSET             0x49
107 #define RPC_FC_VARIABLE_OFFSET          0x4a
108
109 #define RPC_FC_PP                       0x4b /* pointer layout */
110 /* FC_PP: FC_PAD layouts */
111 /* layouts: FC_NO_REPEAT FC_PAD instance */
112 /* instance: NdrFcShort(memofs), NdrFcShort(bufofs), desc */
113
114 #define RPC_FC_EMBEDDED_COMPLEX         0x4c
115 /* FC_EMBEDDED_COMPLEX: padding, NdrFcShort(typeofs) */
116
117 #define RPC_FC_IN_PARAM                 0x4d
118 /* FC_IN_PARAM: stacksiz, NdrFcShort(typeofs) */
119 #define RPC_FC_IN_PARAM_BASETYPE        0x4e
120 /* FC_IN_PARAM_BASETYPE: basetype */
121 #define RPC_FC_IN_PARAM_NO_FREE_INST    0x4f
122 #define RPC_FC_IN_OUT_PARAM             0x50
123 /* FC_IN_OUT_PARAM: stacksiz, NdrFcShort(typeofs) */
124 #define RPC_FC_OUT_PARAM                0x51
125 /* FC_OUT_PARAM: stacksiz, NdrFcShort(typeofs) */
126 #define RPC_FC_RETURN_PARAM             0x52
127 /* FC_RETURN_PARAM: stacksiz, NdrFcShort(typeofs) */
128 #define RPC_FC_RETURN_PARAM_BASETYPE    0x53
129 /* FC_RETURN_PARAM_BASETYPE: basetype */
130
131 #define RPC_FC_DEREFERENCE              0x54
132 #define RPC_FC_DIV_2                    0x55
133 #define RPC_FC_MULT_2                   0x56
134 #define RPC_FC_ADD_1                    0x57
135 #define RPC_FC_SUB_1                    0x58
136
137 #define RPC_FC_CALLBACK                 0x59
138
139 #define RPC_FC_CONSTANT_IID             0x5a
140 /* FC_CONSTANT_IID: NdrFcLong(), NdrFcShort(), NdrFcShort(), 8x () */
141
142 #define RPC_FC_END                      0x5b
143 #define RPC_FC_PAD                      0x5c
144
145 #define RPC_FC_USER_MARSHAL             0xb4
146
147 #define RPC_FC_RANGE                    0xb7
148
149 #define RPC_FC_INT3264                  0xb8
150 #define RPC_FC_UINT3264                 0xb9
151
152 /* FC_RP/UP/OP/FP: flags, NdrFcShort(typeofs)/basetype */
153 #define RPC_FC_P_ALLOCALLNODES          0x01
154 #define RPC_FC_P_DONTFREE               0x02
155 #define RPC_FC_P_ONSTACK                0x04 /* [alloced_on_stack] */
156 #define RPC_FC_P_SIMPLEPOINTER          0x08 /* [simple_pointer] */
157 #define RPC_FC_P_DEREF                  0x10
158
159 #define RPC_FC_BIND_EXPLICIT            0x00
160
161 /* proc header: oiflags, NdrFcLong(rpcflags), NdrFcShort(procnum), NdrFcShort(stacksiz),
162  *  oi2 header: NdrFcShort(clientbuf), NdrFcShort(servbuf), oi2flags, parmcount
163  * oi2 parameters: NdrFcShort(flags), NdrFcShort(stackofs), NdrFcShort(typeofs)/basetype */
164 #define RPC_FC_PROC_OIF_FULLPTR         0x01
165 #define RPC_FC_PROC_OIF_RPCSSALLOC      0x02
166 #define RPC_FC_PROC_OIF_OBJECT          0x04
167 #define RPC_FC_PROC_OIF_RPCFLAGS        0x08
168 #define RPC_FC_PROC_OIF_OBJ_V2          0x20
169 #define RPC_FC_PROC_OIF_NEWINIT         0x40
170
171 #define RPC_FC_PROC_PF_MUSTSIZE         0x0001
172 #define RPC_FC_PROC_PF_MUSTFREE         0x0002
173 #define RPC_FC_PROC_PF_PIPE             0x0004
174 #define RPC_FC_PROC_PF_IN               0x0008
175 #define RPC_FC_PROC_PF_OUT              0x0010
176 #define RPC_FC_PROC_PF_RETURN           0x0020
177 #define RPC_FC_PROC_PF_BASETYPE         0x0040
178 #define RPC_FC_PROC_PF_BYVAL            0x0080
179 #define RPC_FC_PROC_PF_SIMPLEREF        0x0100
180 #define RPC_FC_PROC_PF_DONTFREEINST     0x0200
181 #define RPC_FC_PROC_PF_SAVEASYNC        0x0400
182 #define RPC_FC_PROC_PF_SRVALLOCSIZE     0xe000 /* in 8 byte units */
183
184 /* correlation types */
185 #define RPC_FC_NORMAL_CONFORMANCE               0x00
186 #define RPC_FC_POINTER_CONFORMANCE              0x10
187 #define RPC_FC_TOP_LEVEL_CONFORMANCE            0x20
188 #define RPC_FC_CONSTANT_CONFORMANCE             0x40
189 #define RPC_FC_TOP_LEVEL_MULTID_CONFORMANCE     0x80
190
191 /* user marshal flags */
192 #define USER_MARSHAL_UNIQUE     0x80
193 #define USER_MARSHAL_REF        0x40
194 #define USER_MARSHAL_POINTER    0xc0
195 #define USER_MARSHAL_IID        0x20
196
197 /* context handle flags */
198 #define NDR_CONTEXT_HANDLE_CANNOT_BE_NULL   0x01
199 #define NDR_CONTEXT_HANDLE_SERIALIZE        0x02
200 #define NDR_CONTEXT_HANDLE_NO_SERIALIZE     0x04
201 #define NDR_STRICT_CONTEXT_HANDLE           0x08
202
203 #endif /* __WINE_RPCFC_H */