2 Unix SMB/CIFS implementation.
3 rpc interface definitions
4 Copyright (C) Andrew Tridgell 2003
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.
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.
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.
22 this provides definitions for the libcli/rpc/ MSRPC library
27 this is used by the token store/retrieve code
29 struct ndr_token_list {
30 struct ndr_token_list *next, *prev;
35 /* this is the base structure passed to routines that
36 parse MSRPC formatted data
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
44 uint32_t flags; /* LIBNDR_FLAG_* */
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;
54 /* this is used to ensure we generate unique reference IDs
55 between request and reply */
59 struct ndr_pull_save {
62 struct ndr_pull_save *next;
65 /* structure passed to functions that generate NDR formatted data */
67 uint32_t flags; /* LIBNDR_FLAG_* */
72 struct ndr_token_list *switch_list;
73 struct ndr_token_list *relative_list;
75 /* this is used to ensure we generate unique reference IDs */
79 struct ndr_push_save {
81 struct ndr_push_save *next;
85 /* structure passed to functions that print IDL structures */
87 uint32_t flags; /* LIBNDR_FLAG_* */
89 void (*print)(struct ndr_print *, const char *, ...);
93 #define LIBNDR_FLAG_BIGENDIAN (1<<0)
94 #define LIBNDR_FLAG_NOALIGN (1<<1)
96 #define LIBNDR_FLAG_STR_ASCII (1<<2)
97 #define LIBNDR_FLAG_STR_LEN4 (1<<3)
98 #define LIBNDR_FLAG_STR_SIZE4 (1<<4)
99 #define LIBNDR_FLAG_STR_NOTERM (1<<5)
100 #define LIBNDR_FLAG_STR_NULLTERM (1<<6)
101 #define LIBNDR_FLAG_STR_SIZE2 (1<<7)
102 #define LIBNDR_FLAG_STR_BYTESIZE (1<<8)
103 #define LIBNDR_FLAG_STR_FIXLEN32 (1<<9)
104 #define LIBNDR_FLAG_STR_CONFORMANT (1<<10)
105 #define LIBNDR_FLAG_STR_CHARLEN (1<<11)
106 #define LIBNDR_FLAG_STR_UTF8 (1<<12)
107 #define LIBNDR_FLAG_STR_FIXLEN15 (1<<13)
108 #define LIBNDR_STRING_FLAGS (0x3FFC)
111 #define LIBNDR_FLAG_REF_ALLOC (1<<20)
112 #define LIBNDR_FLAG_REMAINING (1<<21)
113 #define LIBNDR_FLAG_ALIGN2 (1<<22)
114 #define LIBNDR_FLAG_ALIGN4 (1<<23)
115 #define LIBNDR_FLAG_ALIGN8 (1<<24)
117 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
119 #define LIBNDR_PRINT_ARRAY_HEX (1<<25)
120 #define LIBNDR_PRINT_SET_VALUES (1<<26)
122 /* used to force a section of IDL to be little-endian */
123 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
125 /* used to check if alignment padding is zero */
126 #define LIBNDR_FLAG_PAD_CHECK (1<<28)
128 /* used to indicate spoolss style relative pointers (relative to current
130 #define LIBNDR_FLAG_RELATIVE_CURRENT (1<<29)
132 /* set if an object uuid will be present */
133 #define LIBNDR_FLAG_OBJECT_PRESENT (1<<30)
135 /* set to avoid recursion in ndr_size_*() calculation */
136 #define LIBNDR_FLAG_NO_NDR_SIZE (1<<31)
138 /* useful macro for debugging */
139 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
140 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
141 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
142 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
143 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
147 NDR_ERR_CONFORMANT_SIZE,
164 enum ndr_compression_alg {
169 flags passed to control parse flow
171 #define NDR_SCALARS 1
172 #define NDR_BUFFERS 2
175 flags passed to ndr_print_*()
180 #define NDR_SET_VALUES 4
182 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
183 if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
184 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
188 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
190 #define NDR_PULL_ALIGN(ndr, n) do { \
191 if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
192 if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
193 ndr_check_padding(ndr, n); \
195 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
197 if (ndr->offset > ndr->data_size) { \
198 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
202 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
204 #define NDR_PUSH_ALIGN(ndr, n) do { \
205 if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
206 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
207 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
211 /* these are used to make the error checking on each element in libndr
212 less tedious, hopefully making the code more readable */
213 #define NDR_CHECK(call) do { NTSTATUS _status; \
215 if (!NT_STATUS_IS_OK(_status)) \
220 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
221 (s) = talloc_size(ndr, size); \
222 if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
223 "Alloc %u failed\n", \
227 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
230 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
231 (s) = talloc_array_size(ndr, elsize, n); \
232 if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %u failed\n", n, elsize); \
235 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
238 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
239 (s) = talloc_size(ndr, size); \
240 if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed\n", size); \
243 #define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
245 /* these are used when generic fn pointers are needed for ndr push/pull fns */
246 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
247 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
248 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
249 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
250 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
251 typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint32_t, void *);