dd775d62ad145b97f9a7acc1c2e988e11e24e493
[samba.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         struct ndr_token_list *switch_list;
53
54         /* this is used to ensure we generate unique reference IDs
55            between request and reply */
56         uint32_t ptr_count;
57 };
58
59 struct ndr_pull_save {
60         uint32_t data_size;
61         uint32_t offset;
62         struct ndr_pull_save *next;
63 };
64
65 /* structure passed to functions that generate NDR formatted data */
66 struct ndr_push {
67         uint32_t flags; /* LIBNDR_FLAG_* */
68         uint8_t *data;
69         uint32_t alloc_size;
70         uint32_t offset;
71
72         struct ndr_token_list *switch_list;
73         struct ndr_token_list *relative_list;
74
75         /* this is used to ensure we generate unique reference IDs */
76         uint32_t ptr_count;
77 };
78
79 struct ndr_push_save {
80         uint32_t offset;
81         struct ndr_push_save *next;
82 };
83
84
85 /* structure passed to functions that print IDL structures */
86 struct ndr_print {
87         uint32_t flags; /* LIBNDR_FLAG_* */
88         uint32_t depth;
89         struct ndr_token_list *switch_list;
90         void (*print)(struct ndr_print *, const char *, ...);
91         void *private;
92 };
93
94 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
95 #define LIBNDR_FLAG_NOALIGN    (1<<1)
96
97 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
98 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
99 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
100 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
101 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
102 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
103 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
104 #define LIBNDR_FLAG_STR_FIXLEN32        (1<<9)
105 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
106 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
107 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
108 #define LIBNDR_FLAG_STR_FIXLEN15        (1<<13)
109 #define LIBNDR_STRING_FLAGS             (0x3FFC)
110
111
112 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
113 #define LIBNDR_FLAG_REMAINING    (1<<21)
114 #define LIBNDR_FLAG_ALIGN2       (1<<22)
115 #define LIBNDR_FLAG_ALIGN4       (1<<23)
116 #define LIBNDR_FLAG_ALIGN8       (1<<24)
117
118 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
119
120 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
121 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
122
123 /* used to force a section of IDL to be little-endian */
124 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
125
126 /* used to check if alignment padding is zero */
127 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
128
129 /* used to indicate spoolss style relative pointers (relative to current
130    offset, not base) */
131 #define LIBNDR_FLAG_RELATIVE_CURRENT  (1<<29)
132
133 /* set if an object uuid will be present */
134 #define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
135
136 /* set to avoid recursion in ndr_size_*() calculation */
137 #define LIBNDR_FLAG_NO_NDR_SIZE         (1<<31)
138
139 /* useful macro for debugging */
140 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
141 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
142 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
143 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
144 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
145
146
147 enum ndr_err_code {
148         NDR_ERR_CONFORMANT_SIZE,
149         NDR_ERR_ARRAY_SIZE,
150         NDR_ERR_BAD_SWITCH,
151         NDR_ERR_OFFSET,
152         NDR_ERR_RELATIVE,
153         NDR_ERR_CHARCNV,
154         NDR_ERR_LENGTH,
155         NDR_ERR_SUBCONTEXT,
156         NDR_ERR_COMPRESSION,
157         NDR_ERR_STRING,
158         NDR_ERR_VALIDATE,
159         NDR_ERR_BUFSIZE,
160         NDR_ERR_ALLOC,
161         NDR_ERR_RANGE,
162         NDR_ERR_TOKEN
163 };
164
165 enum ndr_compression_alg {
166         NDR_COMPRESSION_MSZIP
167 };
168
169 /*
170   flags passed to control parse flow
171 */
172 #define NDR_SCALARS 1
173 #define NDR_BUFFERS 2
174
175 /*
176   flags passed to ndr_print_*()
177 */
178 #define NDR_IN 1
179 #define NDR_OUT 2
180 #define NDR_BOTH 3
181 #define NDR_SET_VALUES 4
182
183 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
184         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
185                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
186         } \
187 } while(0)
188
189 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
190
191 #define NDR_PULL_ALIGN(ndr, n) do { \
192         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
193                 if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
194                         ndr_check_padding(ndr, n); \
195                 } \
196                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
197         } \
198         if (ndr->offset > ndr->data_size) { \
199                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
200         } \
201 } while(0)
202
203 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
204
205 #define NDR_PUSH_ALIGN(ndr, n) do { \
206         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
207                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
208                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
209         } \
210 } while(0)
211
212 /* these are used to make the error checking on each element in libndr
213    less tedious, hopefully making the code more readable */
214 #define NDR_CHECK(call) do { NTSTATUS _status; \
215                              _status = call; \
216                              if (!NT_STATUS_IS_OK(_status)) \
217                                 return _status; \
218                         } while (0)
219
220
221 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
222                                (s) = talloc_size(ndr, size); \
223                                if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
224                                                                "Alloc %u failed\n", \
225                                                                size); \
226                            } while (0)
227
228 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
229
230
231 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
232         (s) = talloc_array_size(ndr, elsize, n); \
233         if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %u failed\n", n, elsize); \
234 } while (0)
235
236 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
237
238
239 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
240        (s) = talloc_size(ndr, size); \
241        if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed\n", size); \
242 } while (0)
243
244 #define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
245
246 /* these are used when generic fn pointers are needed for ndr push/pull fns */
247 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
248 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
249 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
250 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
251 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
252