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
26 /* offset lists are used to allow a push/pull function to find the
27 start of an encapsulating structure */
30 struct ndr_ofs_list *next;
34 /* this is the base structure passed to routines that
35 parse MSRPC formatted data
37 note that in Samba4 we use separate routines and structures for
38 MSRPC marshalling and unmarshalling. Also note that these routines
39 are being kept deliberately very simple, and are not tied to a
43 uint32 flags; /* LIBNDR_FLAG_* */
49 /* this points at a list of offsets to the structures being processed.
50 The first element in the list is the current structure */
51 struct ndr_ofs_list *ofs_list;
54 struct ndr_pull_save {
57 struct ndr_pull_save *next;
60 /* structure passed to functions that generate NDR formatted data */
62 uint32 flags; /* LIBNDR_FLAG_* */
68 /* this points at a list of offsets to the structures being processed.
69 The first element in the list is the current structure */
70 struct ndr_ofs_list *ofs_list;
72 /* this list is used by the [relative] code to find the offsets */
73 struct ndr_ofs_list *relative_list;
76 struct ndr_push_save {
78 struct ndr_push_save *next;
82 /* structure passed to functions that print IDL structures */
84 uint32 flags; /* LIBNDR_FLAG_* */
87 void (*print)(struct ndr_print *, const char *, ...);
91 #define LIBNDR_FLAG_BIGENDIAN 1
94 /* useful macro for debugging */
95 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
96 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_union_fn_t)ndr_print_ ##type, #p, level, p)
100 NDR_ERR_CONFORMANT_SIZE,
110 flags passed to control parse flow
112 #define NDR_SCALARS 1
113 #define NDR_BUFFERS 2
115 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
116 if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
117 return NT_STATUS_BUFFER_TOO_SMALL; \
121 #define NDR_PULL_ALIGN(ndr, n) do { \
122 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
123 if (ndr->offset >= ndr->data_size) { \
124 return NT_STATUS_BUFFER_TOO_SMALL; \
128 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
130 #define NDR_PUSH_ALIGN(ndr, n) do { \
131 uint32 _pad = (ndr->offset & (n-1)); \
132 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
136 /* these are used to make the error checking on each element in libndr
137 less tedious, hopefully making the code more readable */
138 #define NDR_CHECK(call) do { NTSTATUS _status; \
140 if (!NT_STATUS_IS_OK(_status)) \
145 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
146 (s) = talloc(ndr->mem_ctx, size); \
147 if (!(s)) return NT_STATUS_NO_MEMORY; \
150 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
153 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
157 (s) = talloc(ndr->mem_ctx, (n) * elsize); \
158 if (!(s)) return NT_STATUS_NO_MEMORY; \
162 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
164 /* these are used when generic fn pointers are needed for ndr push/pull fns */
165 typedef NTSTATUS (*ndr_push_fn_t)(struct ndr_push *, void *);
166 typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
168 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
169 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
170 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
171 typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint16, void *);
172 typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint16 *, void *);
173 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
174 typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint16, void *);
176 /* now pull in the individual parsers */
177 #include "librpc/ndr/ndr_basic.h"
178 #include "librpc/ndr/ndr_sec.h"
179 #include "librpc/ndr/ndr_misc.h"
180 #include "librpc/ndr/ndr_echo.h"
181 #include "librpc/ndr/ndr_lsa.h"
182 #include "librpc/ndr/ndr_dfs.h"
183 #include "librpc/ndr/ndr_spoolss.h"
184 #include "librpc/ndr/ndr_spoolss_buf.h"
185 #include "librpc/ndr/ndr_samr.h"