xref: /illumos-gate/usr/src/lib/libmlrpc/common/ndr.h (revision ce8560ee)
1da6c28aaSamw /*
2da6c28aaSamw  * CDDL HEADER START
3da6c28aaSamw  *
4da6c28aaSamw  * The contents of this file are subject to the terms of the
5da6c28aaSamw  * Common Development and Distribution License (the "License").
6da6c28aaSamw  * You may not use this file except in compliance with the License.
7da6c28aaSamw  *
8da6c28aaSamw  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9da6c28aaSamw  * or http://www.opensolaris.org/os/licensing.
10da6c28aaSamw  * See the License for the specific language governing permissions
11da6c28aaSamw  * and limitations under the License.
12da6c28aaSamw  *
13da6c28aaSamw  * When distributing Covered Code, include this CDDL HEADER in each
14da6c28aaSamw  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15da6c28aaSamw  * If applicable, add the following below this CDDL HEADER, with the
16da6c28aaSamw  * fields enclosed by brackets "[]" replaced with your own identifying
17da6c28aaSamw  * information: Portions Copyright [yyyy] [name of copyright owner]
18da6c28aaSamw  *
19da6c28aaSamw  * CDDL HEADER END
20da6c28aaSamw  */
21da6c28aaSamw /*
22b1352070SAlan Wright  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23da6c28aaSamw  * Use is subject to license terms.
24b819cea2SGordon Ross  *
25*ce8560eeSMatt Barden  * Copyright 2020 Tintri by DDN, Inc. All rights reserved.
26da6c28aaSamw  */
27da6c28aaSamw 
28da6c28aaSamw #ifndef _SMBSRV_NDR_H
29da6c28aaSamw #define	_SMBSRV_NDR_H
30da6c28aaSamw 
31da6c28aaSamw /*
32da6c28aaSamw  * Network Data Representation (NDR) is a compatible subset of DCE RPC
33da6c28aaSamw  * and MSRPC NDR.  NDR is used to move parameters consisting of
34da6c28aaSamw  * complicated trees of data constructs between an RPC client and server.
35da6c28aaSamw  *
36da6c28aaSamw  * CAE Specification (1997)
37da6c28aaSamw  * DCE 1.1: Remote Procedure Call
38da6c28aaSamw  * Document Number: C706
39da6c28aaSamw  * The Open Group
40da6c28aaSamw  * ogspecs@opengroup.org
41da6c28aaSamw  */
42da6c28aaSamw 
433db3f65cSamw #include <sys/types.h>
443db3f65cSamw #include <sys/uio.h>
45da6c28aaSamw #include <stdlib.h>
46da6c28aaSamw #include <string.h>
473299f39fSGordon Ross 
483299f39fSGordon Ross #include <smb/wintypes.h>
493299f39fSGordon Ross #include <libmlrpc/ndrtypes.ndl>
503299f39fSGordon Ross #include <libmlrpc/rpcpdu.ndl>
51da6c28aaSamw 
52da6c28aaSamw #ifdef __cplusplus
53da6c28aaSamw extern "C" {
54da6c28aaSamw #endif
55da6c28aaSamw 
56da6c28aaSamw /*
57da6c28aaSamw  * Normal sequence:
58da6c28aaSamw  *	- Application calls client-side stub w/ TOP-MOST arg structure
59da6c28aaSamw  *	- client stub performs NDR_M_OP_MARSHALL+NDR_DIR_IN
60da6c28aaSamw  *	- PDU conveyed (request, aka call, aka query)
61da6c28aaSamw  *	- server stub performs NDR_M_OP_UNMARSHALL+NDR_DIR_IN
62da6c28aaSamw  *	- server function called w/ TOP-MOST arg structure
63da6c28aaSamw  *	- server function returns w/ TOP-MOST arg structure modified
64da6c28aaSamw  *	- server stub performs NDR_M_OP_MARSHALL+NDR_DIR_OUT
65da6c28aaSamw  *	- PDU conveyed (reply, aka result, aka response)
66da6c28aaSamw  *	- client stub performs NDR_M_OP_UNMARSHALL+NDR_DIR_OUT
67da6c28aaSamw  *	- return to Application w/ TOP-MOST arg structure modified
68da6c28aaSamw  *
69da6c28aaSamw  * An interface is a sequence of top-most constructs.  Each top-most
70da6c28aaSamw  * construct corresponds to one parameter, either argument or return
71da6c28aaSamw  * value.
72da6c28aaSamw  *
73da6c28aaSamw  * A top-most construct is a sequence of outer constructs.  The first
74da6c28aaSamw  * outer construct is the referent of the argument, and the subsequent
75da6c28aaSamw  * outer constructs are descendents referenced by pointers from prior
76da6c28aaSamw  * constructs.
77da6c28aaSamw  *
78da6c28aaSamw  * An outer construct is a sequence of variable-sized info, fixed-sized
79da6c28aaSamw  * data, and variable-sized data.
80da6c28aaSamw  */
81da6c28aaSamw 
82da6c28aaSamw /*
83da6c28aaSamw  * Terminology
84da6c28aaSamw  *
85da6c28aaSamw  * The ALL UPPER CASE terms recur in the DCE/RPC documentation.
86da6c28aaSamw  * The mixed-case names have been introduced as a reading aid.
87da6c28aaSamw  *
88da6c28aaSamw  * Size		The size of an array in elements. Think of this
89da6c28aaSamw  *		as the amount to malloc().
90da6c28aaSamw  *
91da6c28aaSamw  * Length	The number of elements of an array which are significant
92da6c28aaSamw  *		Think of this as the amount to bcopy().
93da6c28aaSamw  *
94da6c28aaSamw  * Known	Size/length is known at build time.
95da6c28aaSamw  *
96da6c28aaSamw  * Determined	Size/length is determined at run time.
97da6c28aaSamw  *
98da6c28aaSamw  * FIXED	The Size and Length are Known.
99da6c28aaSamw  *		Think of this as a string constant or a DOS 8.3 file name.
100da6c28aaSamw  *		char array[] = "A Constant Size/Length";
101da6c28aaSamw  *
102da6c28aaSamw  * CONFORMANT	The Size is Determined. Length is the same as Size.
103da6c28aaSamw  *		Think of this as strdup().
104da6c28aaSamw  *		char *array = strdup("Something");
105da6c28aaSamw  *
106da6c28aaSamw  * VARYING	The Size is Known. The Length is determined.
107da6c28aaSamw  *		Think of this as a strcpy() of a variable length string
108da6c28aaSamw  *		into a fixed length buffer:
109da6c28aaSamw  *		char array[100];
110da6c28aaSamw  *		strcpy(array, "very short string");
111da6c28aaSamw  *
112da6c28aaSamw  * VARYING/CONFORMANT
113da6c28aaSamw  *		The Size is Determined. The Length is separately Determined.
114da6c28aaSamw  *		Think of this like:
115da6c28aaSamw  *		char *array = malloc(size);
116da6c28aaSamw  *		strcpy(array, "short string");
117da6c28aaSamw  *
118da6c28aaSamw  * STRING	Strings can be CONFORMANT, VARYING, or CONFORMANT/VARYING.
119da6c28aaSamw  *		A string is fundamentally an array with the last
120da6c28aaSamw  *		significant element some sort of NULL.
121da6c28aaSamw  */
122da6c28aaSamw 
123da6c28aaSamw #define	NDR_F_NONE		0x0000	/* no flags */
124da6c28aaSamw #define	NDR_F_PARAMS_MASK	0x00FF
125da6c28aaSamw #define	NDR_F_SIZE_IS		0x0001	/* [size_is(X)] required/given */
126da6c28aaSamw #define	NDR_F_LENGTH_IS		0x0002	/* not implemented */
127da6c28aaSamw #define	NDR_F_SWITCH_IS		0x0004	/* [switch_is(X)] req./given */
128da6c28aaSamw #define	NDR_F_IS_STRING		0x0008	/* [string] req./given */
129da6c28aaSamw #define	NDR_F_IS_POINTER	0x0010	/* TYPE * ... req./given */
130da6c28aaSamw #define	NDR_F_IS_REFERENCE	0x0020	/* TYPE & ... req./given */
131da6c28aaSamw #define	NDR_F_DIMENSION_IS	0x0040	/* TYPE [N] req./given */
132da6c28aaSamw 
133da6c28aaSamw #define	NDR_F_WHENCE_MASK	0x00F0
134da6c28aaSamw #define	NDR_F_BACKPTR		0x0010	/* ref cause by pointer */
135da6c28aaSamw #define	NDR_F_OUTER		0x0020	/* ref caused by outer */
136da6c28aaSamw #define	NDR_F_TOPMOST		0x0040	/* ref caused by topmost */
137da6c28aaSamw 
138da6c28aaSamw #define	NDR_F_TYPEOP_MASK	0x0F00
139da6c28aaSamw #define	NDR_F_ARRAY		0x0100	/* type is array of somethings */
140da6c28aaSamw #define	NDR_F_POINTER		0x0200	/* type is pointer to something(s) */
141da6c28aaSamw #define	NDR_F_STRING		0x0300	/* type is string of somethings */
142da6c28aaSamw #define	NDR_F_UNION		0x0400	/* type is a union */
143da6c28aaSamw #define	NDR_F_STRUCT		0x0500	/* type is a structure */
144da6c28aaSamw #define	NDR_F_OPERATION		0x0600	/* type is a structure, special */
145da6c28aaSamw #define	NDR_F_INTERFACE		0x0700	/* type is a union, special */
146da6c28aaSamw #define	NDR_F_CONFORMANT	0x1000	/* struct conforming (var-size tail) */
147da6c28aaSamw #define	NDR_F_VARYING		0x2000	/* not implemented */
148*ce8560eeSMatt Barden #define	NDR_F_FAKE		0x4000	/* not a real struct */
149da6c28aaSamw 
1508d7e4166Sjose borrego struct ndr_heap;
1518d7e4166Sjose borrego struct ndr_stream;
152da6c28aaSamw struct ndr_reference;
153da6c28aaSamw 
154a0aa776eSAlan Wright typedef uint16_t ndr_wchar_t;
155a0aa776eSAlan Wright 
1568d7e4166Sjose borrego typedef struct ndr_typeinfo {
157da6c28aaSamw 	unsigned char		version;	/* sanity check */
158da6c28aaSamw 	unsigned char		alignment;	/* mask */
159da6c28aaSamw 	unsigned short		type_flags;	/* NDR_F_... */
1608d7e4166Sjose borrego 	int			(*ndr_func)(struct ndr_reference *);
161da6c28aaSamw 	unsigned short		pdu_size_fixed_part;
162da6c28aaSamw 	unsigned short		pdu_size_variable_part;
163da6c28aaSamw 	unsigned short		c_size_fixed_part;
164da6c28aaSamw 	unsigned short		c_size_variable_part;
1658d7e4166Sjose borrego } ndr_typeinfo_t;
166da6c28aaSamw 
1678d7e4166Sjose borrego typedef struct ndr_reference {
168da6c28aaSamw 	struct ndr_reference	*next;		/* queue list (outer only) */
169da6c28aaSamw 	struct ndr_reference	*enclosing;	/* e.g. struct for this memb */
1708d7e4166Sjose borrego 	struct ndr_stream	*stream;	/* root of NDR */
1718d7e4166Sjose borrego 	ndr_typeinfo_t		*ti;		/* type of data referenced */
172da6c28aaSamw 	char			*name;		/* name of this member */
173da6c28aaSamw 	unsigned long		pdu_offset;	/* referent in stub data */
174da6c28aaSamw 	char			*datum;		/* referent in local memory */
175da6c28aaSamw 	char			**backptr;	/* referer to set */
176da6c28aaSamw 	unsigned short		outer_flags;	/* XXX_is() from top level */
177da6c28aaSamw 	unsigned short		inner_flags;	/* XXX_is() in encapsulated */
178da6c28aaSamw 	unsigned short		type_flags;	/* "requires" */
179da6c28aaSamw 	unsigned short		packed_alignment;
180da6c28aaSamw 	unsigned long		size_is;	/* conforming constructs */
181da6c28aaSamw 	unsigned long		strlen_is;	/* strings */
182da6c28aaSamw 	unsigned long		switch_is;	/* union arg selector */
183da6c28aaSamw 	unsigned long		dimension_is;	/* fixed-len array size */
184da6c28aaSamw 	unsigned long		pdu_end_offset;	/* offset for limit of PDU */
1858d7e4166Sjose borrego } ndr_ref_t;
186da6c28aaSamw 
187da6c28aaSamw /*
1888d7e4166Sjose borrego  * For all operations, the ndr_stream, which is the root of NDR processing,
1898d7e4166Sjose borrego  * is the primary object.  When available, the appropriate ndr_ref_t
190da6c28aaSamw  * is passed, NULL otherwise.  Functions that return 'int' should return
191da6c28aaSamw  * TRUE (!0) or FALSE (0).  When functions return FALSE, including
1928d7e4166Sjose borrego  * ndo_malloc() returning NULL, they should set the stream->error to an
193da6c28aaSamw  * appropriate indicator of what went wrong.
194da6c28aaSamw  *
1958d7e4166Sjose borrego  * Functions ndo_get_pdu(), ndo_put_pdu(), and ndo_pad_pdu() must
196da6c28aaSamw  * never grow the PDU data.  A request for out-of-bounds data is an error.
197da6c28aaSamw  * The swap_bytes flag is 1 if NDR knows that the byte-order in the PDU
1988d7e4166Sjose borrego  * is different from the local system.  ndo_pad_pdu() advised that the
199da6c28aaSamw  * affected bytes should be zero filled.
200da6c28aaSamw  */
2018d7e4166Sjose borrego typedef struct ndr_stream_ops {
2028d7e4166Sjose borrego 	char *(*ndo_malloc)(struct ndr_stream *, unsigned, ndr_ref_t *);
2038d7e4166Sjose borrego 	int (*ndo_free)(struct ndr_stream *, char *, ndr_ref_t *);
2048d7e4166Sjose borrego 	int (*ndo_grow_pdu)(struct ndr_stream *, unsigned long, ndr_ref_t *);
2058d7e4166Sjose borrego 	int (*ndo_pad_pdu)(struct ndr_stream *, unsigned long,
2068d7e4166Sjose borrego 	    unsigned long, ndr_ref_t *);
2078d7e4166Sjose borrego 	int (*ndo_get_pdu)(struct ndr_stream *, unsigned long,
2088d7e4166Sjose borrego 	    unsigned long, char *, int, ndr_ref_t *);
2098d7e4166Sjose borrego 	int (*ndo_put_pdu)(struct ndr_stream *, unsigned long,
2108d7e4166Sjose borrego 	    unsigned long, char *, int, ndr_ref_t *);
2118d7e4166Sjose borrego 	void (*ndo_tattle)(struct ndr_stream *, char *, ndr_ref_t *);
2128d7e4166Sjose borrego 	void (*ndo_tattle_error)(struct ndr_stream *, ndr_ref_t *);
2138d7e4166Sjose borrego 	int (*ndo_reset)(struct ndr_stream *);
2148d7e4166Sjose borrego 	void (*ndo_destruct)(struct ndr_stream *);
2158d7e4166Sjose borrego } ndr_stream_ops_t;
2168d7e4166Sjose borrego 
2178d7e4166Sjose borrego #define	NDS_MALLOC(NDS, LEN, REF) \
2188d7e4166Sjose borrego 	(*(NDS)->ndo->ndo_malloc)(NDS, LEN, REF)
2198d7e4166Sjose borrego #define	NDS_GROW_PDU(NDS, WANT_END_OFF, REF) \
2208d7e4166Sjose borrego 	(*(NDS)->ndo->ndo_grow_pdu)(NDS, WANT_END_OFF, REF)
2218d7e4166Sjose borrego #define	NDS_PAD_PDU(NDS, PDU_OFFSET, N_BYTES, REF) \
2228d7e4166Sjose borrego 	(*(NDS)->ndo->ndo_pad_pdu)(NDS, PDU_OFFSET, N_BYTES, REF)
2238d7e4166Sjose borrego #define	NDS_GET_PDU(NDS, PDU_OFFSET, N_BYTES, BUF, SWAP, REF) \
2248d7e4166Sjose borrego 	(*(NDS)->ndo->ndo_get_pdu)(NDS, PDU_OFFSET, N_BYTES, BUF, SWAP, REF)
2258d7e4166Sjose borrego #define	NDS_PUT_PDU(NDS, PDU_OFFSET, N_BYTES, BUF, SWAP, REF) \
2268d7e4166Sjose borrego 	(*(NDS)->ndo->ndo_put_pdu)(NDS, PDU_OFFSET, N_BYTES, BUF, SWAP, REF)
2278d7e4166Sjose borrego #define	NDS_TATTLE(NDS, WHAT, REF) \
2288d7e4166Sjose borrego 	(*(NDS)->ndo->ndo_tattle)(NDS, WHAT, REF)
2298d7e4166Sjose borrego #define	NDS_TATTLE_ERROR(NDS, WHAT, REF) \
2308d7e4166Sjose borrego 	(*(NDS)->ndo->ndo_tattle_error)(NDS, REF)
2318d7e4166Sjose borrego #define	NDS_RESET(NDS)		(*(NDS)->ndo->ndo_reset)(NDS)
2328d7e4166Sjose borrego #define	NDS_DESTRUCT(NDS)	(*(NDS)->ndo->ndo_destruct)(NDS)
233da6c28aaSamw 
234*ce8560eeSMatt Barden /*
235*ce8560eeSMatt Barden  * The ndr_stream_t tracks the state for a particular RPC call or response.
236*ce8560eeSMatt Barden  * A single call/response may be transmitted as multiple fragments, where
237*ce8560eeSMatt Barden  * each fragment has its own header and sec_trailer. For the layout of
238*ce8560eeSMatt Barden  * a fragment, see the comment at the top of ndr_marshal.c.
239*ce8560eeSMatt Barden  *
240*ce8560eeSMatt Barden  * pdu_base_addr is the buffer in which marshalled/received data is stored.
241*ce8560eeSMatt Barden  *
242*ce8560eeSMatt Barden  * pdu_base_offset is pdu_base_addr with a different type.
243*ce8560eeSMatt Barden  *
244*ce8560eeSMatt Barden  * pdu_max_size is the size of the buffer in pdu_base_addr.
245*ce8560eeSMatt Barden  *
246*ce8560eeSMatt Barden  * pdu_size represents the total amount of data stored in pdu_base_addr.
247*ce8560eeSMatt Barden  * It is typically less than pdu_max_size, and may contain more than one
248*ce8560eeSMatt Barden  * fragment (when reconstructing fragmented calls/responses, for example).
249*ce8560eeSMatt Barden  *
250*ce8560eeSMatt Barden  * pdu_body_offset points to the offset from pdu_base_addr of the PDU body
251*ce8560eeSMatt Barden  * of the currently encoded/decoded fragment.
252*ce8560eeSMatt Barden  *
253*ce8560eeSMatt Barden  * pdu_body_size is the size of the PDU body in the currently encoded/decoded
254*ce8560eeSMatt Barden  * fragment.
255*ce8560eeSMatt Barden  * For what constitutes the PDU Body, see ndr_marshal.c.
256*ce8560eeSMatt Barden  *
257*ce8560eeSMatt Barden  * pdu_hdr_size is the size of the header for the currently encoded/decoded
258*ce8560eeSMatt Barden  * fragment.
259*ce8560eeSMatt Barden  *
260*ce8560eeSMatt Barden  * pdu_scan_offset points to the next valid byte in pdu_base_addr
261*ce8560eeSMatt Barden  * (the next free space for encode, and the next unread byte for decode).
262*ce8560eeSMatt Barden  */
2638d7e4166Sjose borrego typedef struct ndr_stream {
264da6c28aaSamw 	unsigned long		pdu_size;
265da6c28aaSamw 	unsigned long		pdu_max_size;
266da6c28aaSamw 	unsigned long		pdu_base_offset;
267da6c28aaSamw 	unsigned long		pdu_scan_offset;
268*ce8560eeSMatt Barden 	unsigned long		pdu_body_offset;
269*ce8560eeSMatt Barden 	unsigned long		pdu_body_size;
270*ce8560eeSMatt Barden 	unsigned long		pdu_hdr_size;
271da6c28aaSamw 	unsigned char		*pdu_base_addr;
272da6c28aaSamw 
2738d7e4166Sjose borrego 	ndr_stream_ops_t	*ndo;
274da6c28aaSamw 
275da6c28aaSamw 	unsigned char		m_op;
276da6c28aaSamw 	unsigned char		dir;
277da6c28aaSamw 	unsigned char		swap;		/* native/net endian swap */
27855bf511dSas 	unsigned char		flags;
279da6c28aaSamw 	short			error;
280da6c28aaSamw 	short			error_ref;
281da6c28aaSamw 
2828d7e4166Sjose borrego 	ndr_ref_t *outer_queue_head;
2838d7e4166Sjose borrego 	ndr_ref_t **outer_queue_tailp;
2848d7e4166Sjose borrego 	ndr_ref_t *outer_current;
2858d7e4166Sjose borrego 	struct ndr_heap *heap;
2868d7e4166Sjose borrego } ndr_stream_t;
287da6c28aaSamw 
288da6c28aaSamw #define	NDR_M_OP_NONE		0x00
289da6c28aaSamw #define	NDR_M_OP_MARSHALL	0x01	/* data moving from datum to PDU */
290da6c28aaSamw #define	NDR_M_OP_UNMARSHALL	0x02	/* data moving from PDU to datum */
291da6c28aaSamw 
292da6c28aaSamw #define	NDR_DIR_NONE		0x00
293da6c28aaSamw #define	NDR_DIR_IN		0x10	/* data moving from caller to callee */
294da6c28aaSamw #define	NDR_DIR_OUT		0x20	/* data moving from callee to caller */
295da6c28aaSamw 
296da6c28aaSamw #define	NDR_MODE_CALL_SEND	(NDR_M_OP_MARSHALL + NDR_DIR_IN)
297da6c28aaSamw #define	NDR_MODE_CALL_RECV	(NDR_M_OP_UNMARSHALL + NDR_DIR_IN)
298da6c28aaSamw #define	NDR_MODE_RETURN_SEND	(NDR_M_OP_MARSHALL + NDR_DIR_OUT)
299da6c28aaSamw #define	NDR_MODE_RETURN_RECV	(NDR_M_OP_UNMARSHALL + NDR_DIR_OUT)
300b1352070SAlan Wright #define	NDR_MODE_BUF_ENCODE	NDR_MODE_CALL_SEND
301b1352070SAlan Wright #define	NDR_MODE_BUF_DECODE	NDR_MODE_RETURN_RECV
302da6c28aaSamw 
3038d7e4166Sjose borrego #define	NDR_MODE_TO_M_OP(MODE)	((MODE) & 0x0F)
3048d7e4166Sjose borrego #define	NDR_MODE_TO_DIR(MODE)	((MODE) & 0xF0)
305da6c28aaSamw #define	NDR_M_OP_AND_DIR_TO_MODE(M_OP, DIR)	((M_OP)|(DIR))
306da6c28aaSamw 
3078d7e4166Sjose borrego #define	NDR_MODE_MATCH(NDS, MODE) \
3088d7e4166Sjose borrego 	(NDR_M_OP_AND_DIR_TO_MODE((NDS)->m_op, (NDS)->dir) == (MODE))
309da6c28aaSamw 
310b1352070SAlan Wright #define	NDR_IS_FIRST_FRAG(F)	((F) & NDR_PFC_FIRST_FRAG)
311b1352070SAlan Wright #define	NDR_IS_LAST_FRAG(F)	((F) & NDR_PFC_LAST_FRAG)
312b1352070SAlan Wright #define	NDR_IS_SINGLE_FRAG(F)	\
313b1352070SAlan Wright 	(NDR_IS_FIRST_FRAG((F)) && NDR_IS_LAST_FRAG((F)))
314b1352070SAlan Wright 
3158d7e4166Sjose borrego #define	NDS_F_NONE		0x00
3168d7e4166Sjose borrego #define	NDS_F_NOTERM		0x01	/* strings are not null terminated */
317fe1c642dSBill Krier #define	NDS_F_NONULL		0x02	/* strings: no null on size_is */
3188d7e4166Sjose borrego #define	NDS_SETF(S, F)		((S)->flags |= (F))
3198d7e4166Sjose borrego #define	NDS_CLEARF(S, F)	((S)->flags &= ~(F))
320da6c28aaSamw 
321da6c28aaSamw #define	NDR_ERR_MALLOC_FAILED		-1
322da6c28aaSamw #define	NDR_ERR_M_OP_INVALID		-2
323da6c28aaSamw #define	NDR_ERR_UNDERFLOW		-3
324da6c28aaSamw #define	NDR_ERR_GROW_FAILED		-4	/* overflow */
325da6c28aaSamw #define	NDR_ERR_PAD_FAILED		-5	/* couldn't possibly happen */
326da6c28aaSamw #define	NDR_ERR_OUTER_HEADER_BAD	-6
327da6c28aaSamw #define	NDR_ERR_SWITCH_VALUE_ILLEGAL	-7
328da6c28aaSamw #define	NDR_ERR_SWITCH_VALUE_INVALID	-8
329da6c28aaSamw #define	NDR_ERR_SWITCH_VALUE_MISSING	-9
330da6c28aaSamw #define	NDR_ERR_SIZE_IS_MISMATCH_PDU	-10
331da6c28aaSamw #define	NDR_ERR_SIZE_IS_MISMATCH_AFTER	-11
332da6c28aaSamw #define	NDR_ERR_SIZE_IS_UNEXPECTED	-12
333da6c28aaSamw #define	NDR_ERR_SIZE_IS_DUPLICATED	-13
334da6c28aaSamw #define	NDR_ERR_OUTER_PARAMS_MISMATCH	-14
335da6c28aaSamw #define	NDR_ERR_ARRAY_VARLEN_ILLEGAL	-15
336da6c28aaSamw #define	NDR_ERR_ARRAY_UNION_ILLEGAL	-16
337da6c28aaSamw #define	NDR_ERR_OUTER_PARAMS_BAD	-17
338da6c28aaSamw #define	NDR_ERR_OUTER_UNION_ILLEGAL	-18
339da6c28aaSamw #define	NDR_ERR_TOPMOST_UNION_ILLEGAL	-19
340da6c28aaSamw #define	NDR_ERR_TOPMOST_VARLEN_ILLEGAL	-20
341da6c28aaSamw #define	NDR_ERR_INNER_PARAMS_BAD	-21
342da6c28aaSamw #define	NDR_ERR_UNIMPLEMENTED		-22
343da6c28aaSamw #define	NDR_ERR_NOT_AN_INTERFACE	-23
344da6c28aaSamw #define	NDR_ERR_STRLEN			-24
345da6c28aaSamw #define	NDR_ERR_STRING_SIZING		-25
346da6c28aaSamw #define	NDR_ERR_BOUNDS_CHECK		-26
347da6c28aaSamw 
348da6c28aaSamw #define	NDR_SET_ERROR(REF, ERROR)			\
349da6c28aaSamw 	((REF)->stream->error = (ERROR),		\
350da6c28aaSamw 	(REF)->stream->error_ref = __LINE__,		\
3518d7e4166Sjose borrego 	NDS_TATTLE_ERROR((REF)->stream, 0, REF))
352da6c28aaSamw 
353da6c28aaSamw #define	NDR_TATTLE(REF, WHAT) \
3548d7e4166Sjose borrego 	(*(REF)->stream->ndo->ndo_tattle)((REF)->stream, WHAT, REF)
355da6c28aaSamw 
356da6c28aaSamw #define	MEMBER_STR(MEMBER) #MEMBER
357da6c28aaSamw 
358da6c28aaSamw #define	NDR_DIR_IS_IN  (encl_ref->stream->dir == NDR_DIR_IN)
359da6c28aaSamw #define	NDR_DIR_IS_OUT (encl_ref->stream->dir == NDR_DIR_OUT)
360da6c28aaSamw 
361*ce8560eeSMatt Barden #define	NDR_MEMBER_PTR_WITH_ARG(TYPE, MEMBER, OFFSET, \
362*ce8560eeSMatt Barden 		ARGFLAGS, ARGMEM, ARGVAL) { \
363*ce8560eeSMatt Barden 		myref.pdu_offset = encl_ref->pdu_offset + (OFFSET);	\
364*ce8560eeSMatt Barden 		myref.name = MEMBER_STR(MEMBER);			\
365*ce8560eeSMatt Barden 		myref.datum = (char *)val->MEMBER;			\
366*ce8560eeSMatt Barden 		myref.inner_flags = ARGFLAGS;				\
367*ce8560eeSMatt Barden 		myref.ti = &ndt_##TYPE;					\
368*ce8560eeSMatt Barden 		myref.ARGMEM = ARGVAL;					\
369*ce8560eeSMatt Barden 		if (!ndr_inner(&myref))					\
370*ce8560eeSMatt Barden 			return (0);					\
371*ce8560eeSMatt Barden 	}
372*ce8560eeSMatt Barden 
373*ce8560eeSMatt Barden #define	NDR_MEMBER_PTR_WITH_DIMENSION(TYPE, MEMBER, OFFSET, SIZE_IS)	\
374*ce8560eeSMatt Barden 	NDR_MEMBER_PTR_WITH_ARG(TYPE, MEMBER, OFFSET, \
375*ce8560eeSMatt Barden 		NDR_F_DIMENSION_IS, dimension_is, SIZE_IS)
376*ce8560eeSMatt Barden 
377da6c28aaSamw #define	NDR_MEMBER_WITH_ARG(TYPE, MEMBER, OFFSET, \
378da6c28aaSamw 		ARGFLAGS, ARGMEM, ARGVAL) { \
379da6c28aaSamw 		myref.pdu_offset = encl_ref->pdu_offset + (OFFSET);	\
380da6c28aaSamw 		myref.name = MEMBER_STR(MEMBER);			\
381da6c28aaSamw 		myref.datum = (char *)&val->MEMBER;			\
382da6c28aaSamw 		myref.inner_flags = ARGFLAGS;				\
383da6c28aaSamw 		myref.ti = &ndt_##TYPE;					\
384da6c28aaSamw 		myref.ARGMEM = ARGVAL;					\
3858d7e4166Sjose borrego 		if (!ndr_inner(&myref))					\
386da6c28aaSamw 			return (0);					\
387da6c28aaSamw 	}
388da6c28aaSamw 
389da6c28aaSamw #define	NDR_MEMBER(TYPE, MEMBER, OFFSET) \
390da6c28aaSamw 	NDR_MEMBER_WITH_ARG(TYPE, MEMBER, OFFSET, \
391da6c28aaSamw 		NDR_F_NONE, size_is, 0)
392da6c28aaSamw 
393da6c28aaSamw #define	NDR_MEMBER_ARR_WITH_SIZE_IS(TYPE, MEMBER, OFFSET, SIZE_IS) \
394da6c28aaSamw 	NDR_MEMBER_WITH_ARG(TYPE, MEMBER, OFFSET, \
395da6c28aaSamw 		NDR_F_SIZE_IS, size_is, SIZE_IS)
396da6c28aaSamw 
397da6c28aaSamw #define	NDR_MEMBER_ARR_WITH_DIMENSION(TYPE, MEMBER, OFFSET, SIZE_IS) \
398da6c28aaSamw 	NDR_MEMBER_WITH_ARG(TYPE, MEMBER, OFFSET, \
399da6c28aaSamw 		NDR_F_DIMENSION_IS, dimension_is, SIZE_IS)
400da6c28aaSamw 
401da6c28aaSamw #define	NDR_MEMBER_PTR_WITH_SIZE_IS(TYPE, MEMBER, OFFSET, SIZE_IS) \
402da6c28aaSamw 	NDR_MEMBER_WITH_ARG(TYPE, MEMBER, OFFSET, \
403da6c28aaSamw 		NDR_F_SIZE_IS+NDR_F_IS_POINTER, size_is, SIZE_IS)
404da6c28aaSamw 
405da6c28aaSamw #define	NDR_MEMBER_PTR(TYPE, MEMBER, OFFSET)		\
406da6c28aaSamw 	NDR_MEMBER_WITH_ARG(TYPE, MEMBER, OFFSET,	\
407da6c28aaSamw 		NDR_F_IS_POINTER, size_is, 0)
408da6c28aaSamw 
409da6c28aaSamw #define	NDR_MEMBER_WITH_SWITCH_IS(TYPE, MEMBER, OFFSET, SWITCH_IS)	\
410da6c28aaSamw 	NDR_MEMBER_WITH_ARG(TYPE, MEMBER, OFFSET,			\
411da6c28aaSamw 		NDR_F_SWITCH_IS, switch_is, SWITCH_IS)
412da6c28aaSamw 
413da6c28aaSamw 
414da6c28aaSamw #define	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER, \
415da6c28aaSamw 		ARGFLAGS, ARGMEM, ARGVAL) { \
416da6c28aaSamw 		myref.pdu_offset = -1;					\
417da6c28aaSamw 		myref.name = MEMBER_STR(MEMBER);			\
418da6c28aaSamw 		myref.datum = (char *)&val->MEMBER;			\
419da6c28aaSamw 		myref.inner_flags = ARGFLAGS;				\
420da6c28aaSamw 		myref.ti = &ndt_##TYPE;					\
421da6c28aaSamw 		myref.ARGMEM = ARGVAL;					\
4228d7e4166Sjose borrego 		if (!ndr_topmost(&myref))				\
423da6c28aaSamw 			return (0);					\
424da6c28aaSamw 	}
425da6c28aaSamw 
426*ce8560eeSMatt Barden #define	NDR_TOPMOST_MEMBER(TYPE, MEMBER)				\
427da6c28aaSamw 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,			\
428da6c28aaSamw 		NDR_F_NONE, size_is, 0)
429da6c28aaSamw 
430da6c28aaSamw #define	NDR_TOPMOST_MEMBER_ARR_WITH_SIZE_IS(TYPE, MEMBER, SIZE_IS)	\
431*ce8560eeSMatt Barden 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,			\
432da6c28aaSamw 		NDR_F_SIZE_IS, size_is, SIZE_IS)
433da6c28aaSamw 
434da6c28aaSamw #define	NDR_TOPMOST_MEMBER_ARR_WITH_DIMENSION(TYPE, MEMBER, SIZE_IS)	\
435*ce8560eeSMatt Barden 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,			\
436da6c28aaSamw 		NDR_F_DIMENSION_IS, dimension_is, SIZE_IS)
437da6c28aaSamw 
438da6c28aaSamw #define	NDR_TOPMOST_MEMBER_PTR_WITH_SIZE_IS(TYPE, MEMBER, SIZE_IS)	\
439da6c28aaSamw 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,			\
440da6c28aaSamw 		NDR_F_SIZE_IS+NDR_F_IS_POINTER, size_is, SIZE_IS)
441da6c28aaSamw 
442da6c28aaSamw #define	NDR_TOPMOST_MEMBER_PTR(TYPE, MEMBER)		\
443da6c28aaSamw 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,	\
444da6c28aaSamw 		NDR_F_IS_POINTER, size_is, 0)
445da6c28aaSamw 
446da6c28aaSamw #define	NDR_TOPMOST_MEMBER_REF(TYPE, MEMBER)		\
447da6c28aaSamw 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,	\
448da6c28aaSamw 		NDR_F_IS_REFERENCE, size_is, 0)
449da6c28aaSamw 
450da6c28aaSamw #define	NDR_TOPMOST_MEMBER_REF_WITH_SIZE_IS(TYPE, MEMBER, SIZE_IS)	\
451da6c28aaSamw 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,			\
452da6c28aaSamw 		NDR_F_SIZE_IS+NDR_F_IS_REFERENCE, size_is, SIZE_IS)
453da6c28aaSamw 
454da6c28aaSamw #define	NDR_TOPMOST_MEMBER_WITH_SWITCH_IS(TYPE, MEMBER, SWITCH_IS)	\
455da6c28aaSamw 	NDR_TOPMOST_MEMBER_WITH_ARG(TYPE, MEMBER,			\
456da6c28aaSamw 		NDR_F_SWITCH_IS, switch_is, SWITCH_IS)
457da6c28aaSamw 
458da6c28aaSamw /* this is assuming offset+0 */
459da6c28aaSamw #define	NDR_PARAMS_MEMBER_WITH_ARG(TYPE, MEMBER, ARGFLAGS, \
460da6c28aaSamw 	ARGMEM, ARGVAL) { \
461da6c28aaSamw 		myref.pdu_offset = encl_ref->pdu_offset;		\
462da6c28aaSamw 		myref.name = MEMBER_STR(MEMBER);			\
463da6c28aaSamw 		myref.datum = (char *)&val->MEMBER;			\
464da6c28aaSamw 		myref.inner_flags = ARGFLAGS;				\
465da6c28aaSamw 		myref.ti = &ndt_##TYPE;					\
466da6c28aaSamw 		myref.ARGMEM = ARGVAL;					\
4678d7e4166Sjose borrego 		if (!ndr_params(&myref))				\
468da6c28aaSamw 			return (0);					\
469da6c28aaSamw 	}
470da6c28aaSamw 
471da6c28aaSamw #define	NDR_PARAMS_MEMBER(TYPE, MEMBER)			\
472da6c28aaSamw 	NDR_PARAMS_MEMBER_WITH_ARG(TYPE, MEMBER,	\
473da6c28aaSamw 	NDR_F_NONE, size_is, 0)
474da6c28aaSamw 
475da6c28aaSamw #define	NDR_STRING_DIM		1
476da6c28aaSamw #define	NDR_ANYSIZE_DIM		1
477da6c28aaSamw 
4788d7e4166Sjose borrego int ndo_process(struct ndr_stream *, ndr_typeinfo_t *, char *);
4798d7e4166Sjose borrego int ndo_operation(struct ndr_stream *, ndr_typeinfo_t *, int opnum, char *);
4808d7e4166Sjose borrego void ndo_printf(struct ndr_stream *, ndr_ref_t *, const char *, ...);
4818d7e4166Sjose borrego void ndo_trace(const char *);
4828d7e4166Sjose borrego void ndo_fmt(struct ndr_stream *, ndr_ref_t *, char *);
4838d7e4166Sjose borrego 
4848d7e4166Sjose borrego int ndr_params(ndr_ref_t *);
4858d7e4166Sjose borrego int ndr_topmost(ndr_ref_t *);
4868d7e4166Sjose borrego int ndr_run_outer_queue(struct ndr_stream *);
4878d7e4166Sjose borrego int ndr_outer(ndr_ref_t *);
4888d7e4166Sjose borrego int ndr_outer_fixed(ndr_ref_t *);
4898d7e4166Sjose borrego int ndr_outer_fixed_array(ndr_ref_t *);
4908d7e4166Sjose borrego int ndr_outer_conformant_array(ndr_ref_t *);
4918d7e4166Sjose borrego int ndr_outer_conformant_construct(ndr_ref_t *);
4928d7e4166Sjose borrego int ndr_size_is(ndr_ref_t *);
4938d7e4166Sjose borrego int ndr_outer_string(ndr_ref_t *);
4948d7e4166Sjose borrego int ndr_outer_peek_sizing(ndr_ref_t *, unsigned, unsigned long *);
4958d7e4166Sjose borrego int ndr_outer_poke_sizing(ndr_ref_t *, unsigned, unsigned long *);
4968d7e4166Sjose borrego int ndr_outer_align(ndr_ref_t *);
4978d7e4166Sjose borrego int ndr_outer_grow(ndr_ref_t *, unsigned);
4988d7e4166Sjose borrego int ndr_inner(ndr_ref_t *);
4998d7e4166Sjose borrego int ndr_inner_pointer(ndr_ref_t *);
5008d7e4166Sjose borrego int ndr_inner_reference(ndr_ref_t *);
5018d7e4166Sjose borrego int ndr_inner_array(ndr_ref_t *);
5028d7e4166Sjose borrego 
5033299f39fSGordon Ross size_t ndr_mbstowcs(struct ndr_stream *, ndr_wchar_t *, const char *, size_t);
5048d7e4166Sjose borrego 
5058d7e4166Sjose borrego void nds_bswap(void *src, void *dst, size_t len);
506da6c28aaSamw 
507da6c28aaSamw #ifdef __cplusplus
508da6c28aaSamw }
509da6c28aaSamw #endif
510da6c28aaSamw 
511da6c28aaSamw #endif /* _SMBSRV_NDR_H */
512