aebd9892ba7a657fffa1b5e966a21737804b36ad
[jelmer/samba4-debian.git] / source / librpc / ndr / libndr.h
1 /* 
2    Unix SMB/CIFS implementation.
3    rpc interface definitions
4    Copyright (C) Andrew Tridgell 2003
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10    
11    This program 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
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21 /*
22   this provides definitions for the libcli/rpc/ MSRPC library
23 */
24
25
26 /*
27   this is used by the token store/retrieve code
28 */
29 struct ndr_token_list {
30         struct ndr_token_list *next, *prev;
31         const void *key;
32         uint32_t value;
33 };
34
35 /* this is the base structure passed to routines that 
36    parse MSRPC formatted data 
37
38    note that in Samba4 we use separate routines and structures for
39    MSRPC marshalling and unmarshalling. Also note that these routines
40    are being kept deliberately very simple, and are not tied to a
41    particular transport
42 */
43 struct ndr_pull {
44         uint32_t flags; /* LIBNDR_FLAG_* */
45         uint8_t *data;
46         uint32_t data_size;
47         uint32_t offset;
48
49         struct ndr_token_list *relative_list;
50         struct ndr_token_list *array_size_list;
51         struct ndr_token_list *array_length_list;
52
53         /* this is used to ensure we generate unique reference IDs
54            between request and reply */
55         uint32_t ptr_count;
56 };
57
58 struct ndr_pull_save {
59         uint32_t data_size;
60         uint32_t offset;
61         struct ndr_pull_save *next;
62 };
63
64 /* structure passed to functions that generate NDR formatted data */
65 struct ndr_push {
66         uint32_t flags; /* LIBNDR_FLAG_* */
67         uint8_t *data;
68         uint32_t alloc_size;
69         uint32_t offset;
70
71         struct ndr_token_list *relative_list;
72
73         /* this is used to ensure we generate unique reference IDs */
74         uint32_t ptr_count;
75 };
76
77 struct ndr_push_save {
78         uint32_t offset;
79         struct ndr_push_save *next;
80 };
81
82
83 /* structure passed to functions that print IDL structures */
84 struct ndr_print {
85         uint32_t flags; /* LIBNDR_FLAG_* */
86         uint32_t depth;
87         void (*print)(struct ndr_print *, const char *, ...);
88         void *private;
89 };
90
91 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
92 #define LIBNDR_FLAG_NOALIGN    (1<<1)
93
94 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
95 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
96 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
97 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
98 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
99 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
100 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
101 #define LIBNDR_FLAG_STR_FIXLEN32        (1<<9)
102 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
103 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
104 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
105 #define LIBNDR_STRING_FLAGS             (0x1FFC)
106
107
108 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
109 #define LIBNDR_FLAG_REMAINING    (1<<21)
110 #define LIBNDR_FLAG_ALIGN2       (1<<22)
111 #define LIBNDR_FLAG_ALIGN4       (1<<23)
112 #define LIBNDR_FLAG_ALIGN8       (1<<24)
113
114 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
115
116 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
117 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
118
119 /* used to force a section of IDL to be little-endian */
120 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
121
122 /* used to check if alignment padding is zero */
123 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
124
125 /* used to indicate spoolss style relative pointers (relative to current
126    offset, not base) */
127 #define LIBNDR_FLAG_RELATIVE_CURRENT  (1<<29)
128
129 /* set if an object uuid will be present */
130 #define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
131
132 /* useful macro for debugging */
133 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
134 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_union_fn_t)ndr_print_ ##type, #p, level, p)
135 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
136 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
137 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
138 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
139
140
141 enum ndr_err_code {
142         NDR_ERR_CONFORMANT_SIZE,
143         NDR_ERR_ARRAY_SIZE,
144         NDR_ERR_BAD_SWITCH,
145         NDR_ERR_OFFSET,
146         NDR_ERR_RELATIVE,
147         NDR_ERR_CHARCNV,
148         NDR_ERR_LENGTH,
149         NDR_ERR_SUBCONTEXT,
150         NDR_ERR_STRING,
151         NDR_ERR_VALIDATE,
152         NDR_ERR_BUFSIZE,
153         NDR_ERR_ALLOC,
154         NDR_ERR_RANGE,
155         NDR_ERR_TOKEN
156 };
157
158 /*
159   flags passed to control parse flow
160 */
161 #define NDR_SCALARS 1
162 #define NDR_BUFFERS 2
163
164 /*
165   flags passed to ndr_print_*()
166 */
167 #define NDR_IN 1
168 #define NDR_OUT 2
169 #define NDR_BOTH 3
170 #define NDR_SET_VALUES 4
171
172 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
173         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
174                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
175         } \
176 } while(0)
177
178 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
179
180 #define NDR_PULL_ALIGN(ndr, n) do { \
181         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
182                 if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
183                         ndr_check_padding(ndr, n); \
184                 } \
185                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
186         } \
187         if (ndr->offset >= ndr->data_size) { \
188                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
189         } \
190 } while(0)
191
192 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
193
194 #define NDR_PUSH_ALIGN(ndr, n) do { \
195         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
196                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
197                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
198         } \
199 } while(0)
200
201 #define NDR_SIZE_ALIGN(t, n, flags) ((flags & LIBNDR_FLAG_NOALIGN)?(t):(((t) + (n-1)) & ~(n-1)))
202 #define ndr_size_uint8(t, p, flags) (NDR_SIZE_ALIGN(t, 1, flags) + 1)
203 #define ndr_size_uint16(t, p, flags) (NDR_SIZE_ALIGN(t, 2, flags) + 2)
204 #define ndr_size_int32(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 4)
205 #define ndr_size_uint32(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 4)
206 #define ndr_size_ptr(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 4)
207 /* 
208  * [u]int64 uses 4 Byte alignment
209  * and HYPER_T uses 8 Byte alignment
210  */
211 #define ndr_size_int64(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 8)
212 #define ndr_size_uint64(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 8)
213 #define ndr_size_HYPER_T(t, p, flags) (NDR_SIZE_ALIGN(t, 8, flags) + 8)
214
215
216 #define ndr_size_NTTIME(t, p, flags) ndr_size_uint64(t, p, flags)
217 #define ndr_size_NTTIME_1sec(t, p, flags) ndr_size_HYPER_T(t, p, flags)
218
219 #define ndr_size_WERROR(t, p, flags) ndr_size_uint32(t, p, flags)
220 #define ndr_size_NTSTATUS(t, p, flags) ndr_size_uint32(t, p, flags)
221
222 /* these are used to make the error checking on each element in libndr
223    less tedious, hopefully making the code more readable */
224 #define NDR_CHECK(call) do { NTSTATUS _status; \
225                              _status = call; \
226                              if (!NT_STATUS_IS_OK(_status)) \
227                                 return _status; \
228                         } while (0)
229
230
231 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
232                                (s) = talloc_size(ndr, size); \
233                                if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
234                                                                "Alloc %u failed\n", \
235                                                                size); \
236                            } while (0)
237
238 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
239
240
241 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
242         (s) = talloc_array(ndr, elsize, n, __location__); \
243         if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %u failed\n", n, elsize); \
244 } while (0)
245
246 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
247
248
249 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
250        (s) = talloc_size(ndr, size); \
251        if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed\n", size); \
252 } while (0)
253
254 #define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
255
256 /* these are used when generic fn pointers are needed for ndr push/pull fns */
257 typedef NTSTATUS (*ndr_push_fn_t)(struct ndr_push *, void *);
258 typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
259
260 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
261 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
262 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
263 typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint32_t, void *);
264 typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint32_t, void *);
265 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
266 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
267 typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint32_t, void *);
268