1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1989, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Rick Macklem at The University of Guelph.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * $FreeBSD$
35 */
36
37#ifndef _NFS_NFS_H_
38#define	_NFS_NFS_H_
39/*
40 * Tunable constants for nfs
41 */
42
43#define	NFS_MAXIOVEC	34
44#define	NFS_TICKINTVL	500		/* Desired time for a tick (msec) */
45#define	NFS_HZ		(hz / nfscl_ticks) /* Ticks/sec */
46#define	NFS_TIMEO	(1 * NFS_HZ)	/* Default timeout = 1 second */
47#define	NFS_MINTIMEO	(1 * NFS_HZ)	/* Min timeout to use */
48#define	NFS_MAXTIMEO	(60 * NFS_HZ)	/* Max timeout to backoff to */
49#define	NFS_TCPTIMEO	300		/* TCP timeout */
50#define	NFS_MAXRCVTIMEO	60		/* 1 minute in seconds */
51#define	NFS_MINIDEMTIMEO (5 * NFS_HZ)	/* Min timeout for non-idempotent ops*/
52#define	NFS_MAXREXMIT	100		/* Stop counting after this many */
53#define	NFSV4_CALLBACKTIMEO (2 * NFS_HZ) /* Timeout in ticks */
54#define	NFSV4_CALLBACKRETRY 5		/* Number of retries before failure */
55#define	NFSV4_SLOTS	64		/* Number of slots, fore channel */
56#define	NFSV4_CBSLOTS	8		/* Number of slots, back channel */
57#define	NFSV4_CBRETRYCNT 4		/* # of CBRecall retries upon err */
58#define	NFSV4_UPCALLTIMEO (15 * NFS_HZ)	/* Timeout in ticks for upcalls */
59					/* to gssd or nfsuserd */
60#define	NFSV4_UPCALLRETRY 4		/* Number of retries before failure */
61#define	NFS_MAXWINDOW	1024		/* Max number of outstanding requests */
62#define	NFS_RETRANS	10		/* Num of retrans for soft mounts */
63#define	NFS_RETRANS_TCP	2		/* Num of retrans for TCP soft mounts */
64#define	NFS_MAXGRPS	16		/* Max. size of groups list */
65#define	NFS_TRYLATERDEL	15		/* Maximum delay timeout (sec) */
66#ifndef NFS_REMOVETIMEO
67#define	NFS_REMOVETIMEO 15  /* # sec to wait for delegret in local syscall */
68#endif
69#ifndef NFS_MINATTRTIMO
70#define	NFS_MINATTRTIMO 5		/* Attribute cache timeout in sec */
71#endif
72#ifndef NFS_MAXATTRTIMO
73#define	NFS_MAXATTRTIMO 60
74#endif
75#define	NFS_WSIZE	8192		/* Def. write data size <= 8192 */
76#define	NFS_RSIZE	8192		/* Def. read data size <= 8192 */
77#define	NFS_READDIRSIZE	8192		/* Def. readdir size */
78#define	NFS_DEFRAHEAD	1		/* Def. read ahead # blocks */
79#define	NFS_MAXRAHEAD	16		/* Max. read ahead # blocks */
80#define	NFS_MAXASYNCDAEMON 	64	/* Max. number async_daemons runnable */
81#define	NFS_MAXUIDHASH	64		/* Max. # of hashed uid entries/mp */
82#ifndef	NFSRV_LEASE
83#define	NFSRV_LEASE		120	/* Lease time in seconds for V4 */
84#endif					/* assigned to nfsrv_lease */
85#ifndef NFSRV_STALELEASE
86#define	NFSRV_STALELEASE	(5 * nfsrv_lease)
87#endif
88#ifndef NFSRV_MOULDYLEASE
89#define	NFSRV_MOULDYLEASE	604800	/* One week (in sec) */
90#endif
91#ifndef NFSCLIENTHASHSIZE
92#define	NFSCLIENTHASHSIZE	20	/* Size of server client hash table */
93#endif
94#ifndef NFSLOCKHASHSIZE
95#define	NFSLOCKHASHSIZE		20	/* Size of server nfslock hash table */
96#endif
97#ifndef NFSSESSIONHASHSIZE
98#define	NFSSESSIONHASHSIZE	20	/* Size of server session hash table */
99#endif
100#define	NFSSTATEHASHSIZE	10	/* Size of server stateid hash table */
101#define	NFSLAYOUTHIGHWATER	1000000	/* Upper limit for # of layouts */
102#ifndef	NFSCLDELEGHIGHWATER
103#define	NFSCLDELEGHIGHWATER	10000	/* limit for client delegations */
104#endif
105#ifndef	NFSCLLAYOUTHIGHWATER
106#define	NFSCLLAYOUTHIGHWATER	10000	/* limit for client pNFS layouts */
107#endif
108#ifndef NFSNOOPEN			/* Inactive open owner (sec) */
109#define	NFSNOOPEN		120
110#endif
111#define	NFSRV_LEASEDELTA	15	/* # of seconds to delay beyond lease */
112#define	NFS_IDMAXSIZE		4	/* max sizeof (in_addr_t) */
113#ifndef NFSRVCACHE_UDPTIMEOUT
114#define	NFSRVCACHE_UDPTIMEOUT	30	/* # of sec to hold cached rpcs(udp) */
115#endif
116#ifndef NFSRVCACHE_UDPHIGHWATER
117#define	NFSRVCACHE_UDPHIGHWATER	500	/* Max # of udp cache entries */
118#endif
119#ifndef NFSRVCACHE_TCPTIMEOUT
120#define	NFSRVCACHE_TCPTIMEOUT	(3600*12) /*#of sec to hold cached rpcs(tcp) */
121#endif
122#ifndef	NFSRVCACHE_FLOODLEVEL
123#define	NFSRVCACHE_FLOODLEVEL	16384	/* Very high water mark for cache */
124#endif
125#ifndef	NFSRV_CLIENTHIGHWATER
126#define	NFSRV_CLIENTHIGHWATER	1000
127#endif
128#ifndef	NFSRV_MAXDUMPLIST
129#define	NFSRV_MAXDUMPLIST	10000
130#endif
131#ifndef NFS_ACCESSCACHESIZE
132#define	NFS_ACCESSCACHESIZE	8
133#endif
134#define	NFSV4_CBPORT	7745		/* Callback port for testing */
135
136/*
137 * This macro defines the high water mark for issuing V4 delegations.
138 * (It is currently set at a conservative 20% of nfsrv_v4statelimit. This
139 *  may want to increase when clients can make more effective use of
140 *  delegations.)
141 */
142#define	NFSRV_V4DELEGLIMIT(c) (((c) * 5) > nfsrv_v4statelimit)
143
144#define	NFS_READDIRBLKSIZ	DIRBLKSIZ	/* Minimal nm_readdirsize */
145
146/*
147 * Oddballs
148 */
149#define	NFS_CMPFH(n, f, s) 						\
150    ((n)->n_fhp->nfh_len == (s) && !NFSBCMP((n)->n_fhp->nfh_fh, (caddr_t)(f), (s)))
151#define	NFSRV_CMPFH(nf, ns, f, s) 					\
152	((ns) == (s) && !NFSBCMP((caddr_t)(nf), (caddr_t)(f), (s)))
153#define	NFS_CMPTIME(t1, t2) 						\
154	((t1).tv_sec == (t2).tv_sec && (t1).tv_nsec == (t2).tv_nsec)
155#define	NFS_SETTIME(t) do { 						\
156	(t).tv_sec = time.tv_sec; (t).tv_nsec = 1000 * time.tv_usec; } while (0)
157#define	NFS_SRVMAXDATA(n) 						\
158		(((n)->nd_flag & (ND_NFSV3 | ND_NFSV4)) ? 		\
159		 NFS_SRVMAXIO : NFS_V2MAXDATA)
160#define	NFS64BITSSET	0xffffffffffffffffull
161#define	NFS64BITSMINUS1	0xfffffffffffffffeull
162
163/*
164 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd, mount_nfs
165 * and nfsloaduser should ever try and use it.
166 */
167struct nfsd_addsock_args {
168	int	sock;		/* Socket to serve */
169	caddr_t	name;		/* Client addr for connection based sockets */
170	int	namelen;	/* Length of name */
171};
172
173/*
174 * nfsd argument for new krpc.
175 * (New version supports pNFS, indicated by NFSSVC_NEWSTRUCT flag.)
176 */
177struct nfsd_nfsd_args {
178	const char *principal;	/* GSS-API service principal name */
179	int	minthreads;	/* minimum service thread count */
180	int	maxthreads;	/* maximum service thread count */
181	int	version;	/* Allow multiple variants */
182	char	*addr;		/* pNFS DS addresses */
183	int	addrlen;	/* Length of addrs */
184	char	*dnshost;	/* DNS names for DS addresses */
185	int	dnshostlen;	/* Length of DNS names */
186	char	*dspath;	/* DS Mount path on MDS */
187	int	dspathlen;	/* Length of DS Mount path on MDS */
188	char	*mdspath;	/* MDS mount for DS path on MDS */
189	int	mdspathlen;	/* Length of MDS mount for DS path on MDS */
190	int	mirrorcnt;	/* Number of mirrors to create on DSs */
191};
192
193/*
194 * NFSDEV_MAXMIRRORS - Maximum level of mirroring for a DS.
195 * (Most will only put files on two DSs, but this setting allows up to 4.)
196 * NFSDEV_MAXVERS - maximum number of NFS versions supported by Flex File.
197 */
198#define	NFSDEV_MAXMIRRORS	4
199#define	NFSDEV_MAXVERS		4
200
201struct nfsd_pnfsd_args {
202	int	op;		/* Which pNFSd op to perform. */
203	char	*mdspath;	/* Path of MDS file. */
204	char	*dspath;	/* Path of recovered DS mounted on dir. */
205	char	*curdspath;	/* Path of current DS mounted on dir. */
206};
207
208#define	PNFSDOP_DELDSSERVER	1
209#define	PNFSDOP_COPYMR		2
210#define	PNFSDOP_FORCEDELDS	3
211
212/* Old version. */
213struct nfsd_nfsd_oargs {
214	const char *principal;	/* GSS-API service principal name */
215	int	minthreads;	/* minimum service thread count */
216	int	maxthreads;	/* maximum service thread count */
217};
218
219/*
220 * Arguments for use by the callback daemon.
221 */
222struct nfsd_nfscbd_args {
223	const char *principal;	/* GSS-API service principal name */
224};
225
226struct nfscbd_args {
227	int	sock;		/* Socket to serve */
228	caddr_t	name;		/* Client addr for connection based sockets */
229	int	namelen;	/* Length of name */
230	u_short	port;		/* Port# for callbacks */
231};
232
233struct nfsd_idargs {
234	int		nid_flag;	/* Flags (see below) */
235	uid_t		nid_uid;	/* user/group id */
236	gid_t		nid_gid;
237	int		nid_usermax;	/* Upper bound on user name cache */
238	int		nid_usertimeout;/* User name timeout (minutes) */
239	u_char		*nid_name;	/* Name */
240	int		nid_namelen;	/* and its length */
241	gid_t		*nid_grps;	/* and the list */
242	int		nid_ngroup;	/* Size of groups list */
243};
244
245struct nfsd_oidargs {
246	int		nid_flag;	/* Flags (see below) */
247	uid_t		nid_uid;	/* user/group id */
248	gid_t		nid_gid;
249	int		nid_usermax;	/* Upper bound on user name cache */
250	int		nid_usertimeout;/* User name timeout (minutes) */
251	u_char		*nid_name;	/* Name */
252	int		nid_namelen;	/* and its length */
253};
254
255struct nfsuserd_args {
256	sa_family_t	nuserd_family;	/* Address family to use */
257	u_short		nuserd_port;	/* Port# */
258};
259
260struct nfsd_clid {
261	int		nclid_idlen;	/* Length of client id */
262	u_char		nclid_id[NFSV4_OPAQUELIMIT]; /* and name */
263};
264
265struct nfsd_dumplist {
266	int		ndl_size;	/* Number of elements */
267	void		*ndl_list;	/* and the list of elements */
268};
269
270struct nfsd_dumpclients {
271	u_int32_t	ndcl_flags;		/* LCL_xxx flags */
272	u_int32_t	ndcl_nopenowners;	/* Number of openowners */
273	u_int32_t	ndcl_nopens;		/* and opens */
274	u_int32_t	ndcl_nlockowners;	/* and of lockowners */
275	u_int32_t	ndcl_nlocks;		/* and of locks */
276	u_int32_t	ndcl_ndelegs;		/* and of delegations */
277	u_int32_t	ndcl_nolddelegs;	/* and old delegations */
278	sa_family_t	ndcl_addrfam;		/* Callback address */
279	union {
280		struct in_addr sin_addr;
281		struct in6_addr sin6_addr;
282	} ndcl_cbaddr;
283	struct nfsd_clid ndcl_clid;	/* and client id */
284};
285
286struct nfsd_dumplocklist {
287	char		*ndllck_fname;	/* File Name */
288	int		ndllck_size;	/* Number of elements */
289	void		*ndllck_list;	/* and the list of elements */
290};
291
292struct nfsd_dumplocks {
293	u_int32_t	ndlck_flags;		/* state flags NFSLCK_xxx */
294	nfsv4stateid_t	ndlck_stateid;		/* stateid */
295	u_int64_t	ndlck_first;		/* lock byte range */
296	u_int64_t	ndlck_end;
297	struct nfsd_clid ndlck_owner;		/* Owner of open/lock */
298	sa_family_t	ndlck_addrfam;		/* Callback address */
299	union {
300		struct in_addr sin_addr;
301		struct in6_addr sin6_addr;
302	} ndlck_cbaddr;
303	struct nfsd_clid ndlck_clid;	/* and client id */
304};
305
306/*
307 * Structure for referral information.
308 */
309struct nfsreferral {
310	u_char		*nfr_srvlist;	/* List of servers */
311	int		nfr_srvcnt;	/* number of servers */
312	vnode_t		nfr_vp;	/* vnode for referral */
313	uint64_t	nfr_dfileno;	/* assigned dir inode# */
314};
315
316/*
317 * Flags for lc_flags and opsflags for nfsrv_getclient().
318 */
319#define	LCL_NEEDSCONFIRM	0x00000001
320#define	LCL_DONTCLEAN		0x00000002
321#define	LCL_WAKEUPWANTED	0x00000004
322#define	LCL_TCPCALLBACK		0x00000008
323#define	LCL_CALLBACKSON		0x00000010
324#define	LCL_INDEXNOTOK		0x00000020
325#define	LCL_STAMPEDSTABLE	0x00000040
326#define	LCL_EXPIREIT		0x00000080
327#define	LCL_CBDOWN		0x00000100
328#define	LCL_KERBV		0x00000400
329#define	LCL_NAME		0x00000800
330#define	LCL_NEEDSCBNULL		0x00001000
331#define	LCL_GSSINTEGRITY	0x00002000
332#define	LCL_GSSPRIVACY		0x00004000
333#define	LCL_ADMINREVOKED	0x00008000
334#define	LCL_RECLAIMCOMPLETE	0x00010000
335#define	LCL_NFSV41		0x00020000
336#define	LCL_DONEBINDCONN	0x00040000
337#define	LCL_RECLAIMONEFS	0x00080000
338#define	LCL_NFSV42		0x00100000
339
340#define	LCL_GSS		LCL_KERBV	/* Or of all mechs */
341
342/*
343 * Bits for flags in nfslock and nfsstate.
344 * The access, deny, NFSLCK_READ and NFSLCK_WRITE bits must be defined as
345 * below, in the correct order, so the shifts work for tests.
346 */
347#define	NFSLCK_READACCESS	0x00000001
348#define	NFSLCK_WRITEACCESS	0x00000002
349#define	NFSLCK_ACCESSBITS	(NFSLCK_READACCESS | NFSLCK_WRITEACCESS)
350#define	NFSLCK_SHIFT		2
351#define	NFSLCK_READDENY		0x00000004
352#define	NFSLCK_WRITEDENY	0x00000008
353#define	NFSLCK_DENYBITS		(NFSLCK_READDENY | NFSLCK_WRITEDENY)
354#define	NFSLCK_SHAREBITS 						\
355    (NFSLCK_READACCESS|NFSLCK_WRITEACCESS|NFSLCK_READDENY|NFSLCK_WRITEDENY)
356#define	NFSLCK_LOCKSHIFT	4
357#define	NFSLCK_READ		0x00000010
358#define	NFSLCK_WRITE		0x00000020
359#define	NFSLCK_BLOCKING		0x00000040
360#define	NFSLCK_RECLAIM		0x00000080
361#define	NFSLCK_OPENTOLOCK	0x00000100
362#define	NFSLCK_TEST		0x00000200
363#define	NFSLCK_LOCK		0x00000400
364#define	NFSLCK_UNLOCK		0x00000800
365#define	NFSLCK_OPEN		0x00001000
366#define	NFSLCK_CLOSE		0x00002000
367#define	NFSLCK_CHECK		0x00004000
368#define	NFSLCK_RELEASE		0x00008000
369#define	NFSLCK_NEEDSCONFIRM	0x00010000
370#define	NFSLCK_CONFIRM		0x00020000
371#define	NFSLCK_DOWNGRADE	0x00040000
372#define	NFSLCK_DELEGREAD	0x00080000
373#define	NFSLCK_DELEGWRITE	0x00100000
374#define	NFSLCK_DELEGCUR		0x00200000
375#define	NFSLCK_DELEGPREV	0x00400000
376#define	NFSLCK_OLDDELEG		0x00800000
377#define	NFSLCK_DELEGRECALL	0x01000000
378#define	NFSLCK_SETATTR		0x02000000
379#define	NFSLCK_DELEGPURGE	0x04000000
380#define	NFSLCK_DELEGRETURN	0x08000000
381#define	NFSLCK_WANTWDELEG	0x10000000
382#define	NFSLCK_WANTRDELEG	0x20000000
383#define	NFSLCK_WANTNODELEG	0x40000000
384#define	NFSLCK_WANTBITS							\
385    (NFSLCK_WANTWDELEG | NFSLCK_WANTRDELEG | NFSLCK_WANTNODELEG)
386
387/* And bits for nid_flag */
388#define	NFSID_INITIALIZE	0x0001
389#define	NFSID_ADDUID		0x0002
390#define	NFSID_DELUID		0x0004
391#define	NFSID_ADDUSERNAME	0x0008
392#define	NFSID_DELUSERNAME	0x0010
393#define	NFSID_ADDGID		0x0020
394#define	NFSID_DELGID		0x0040
395#define	NFSID_ADDGROUPNAME	0x0080
396#define	NFSID_DELGROUPNAME	0x0100
397
398/*
399 * fs.nfs sysctl(3) identifiers
400 */
401#define	NFS_NFSSTATS	1		/* struct: struct nfsstats */
402
403/*
404 * Here is the definition of the attribute bits array and macros that
405 * manipulate it.
406 * THE MACROS MUST BE MANUALLY MODIFIED IF NFSATTRBIT_MAXWORDS CHANGES!!
407 * It is (NFSATTRBIT_MAX + 31) / 32.
408 */
409#define	NFSATTRBIT_MAXWORDS	3
410
411typedef struct {
412	u_int32_t bits[NFSATTRBIT_MAXWORDS];
413} nfsattrbit_t;
414
415#define	NFSZERO_ATTRBIT(b) do {						\
416	(b)->bits[0] = 0;						\
417	(b)->bits[1] = 0;						\
418	(b)->bits[2] = 0;						\
419} while (0)
420
421#define	NFSSET_ATTRBIT(t, f) do {					\
422	(t)->bits[0] = (f)->bits[0];			 		\
423	(t)->bits[1] = (f)->bits[1];					\
424	(t)->bits[2] = (f)->bits[2];					\
425} while (0)
426
427#define	NFSSETSUPP_ATTRBIT(b, n) do { 					\
428	(b)->bits[0] = NFSATTRBIT_SUPP0; 				\
429	(b)->bits[1] = (NFSATTRBIT_SUPP1 | NFSATTRBIT_SUPPSETONLY1);	\
430	(b)->bits[2] = (NFSATTRBIT_SUPP2 | NFSATTRBIT_SUPPSETONLY2);	\
431	if (((n)->nd_flag & ND_NFSV41) == 0) {				\
432		(b)->bits[1] &= ~NFSATTRBIT_NFSV41_1;			\
433		(b)->bits[2] &= ~NFSATTRBIT_NFSV41_2;			\
434	}								\
435	if (((n)->nd_flag & ND_NFSV42) == 0)				\
436		(b)->bits[2] &= ~NFSATTRBIT_NFSV42_2;			\
437} while (0)
438
439#define	NFSISSET_ATTRBIT(b, p)	((b)->bits[(p) / 32] & (1 << ((p) % 32)))
440#define	NFSSETBIT_ATTRBIT(b, p)	((b)->bits[(p) / 32] |= (1 << ((p) % 32)))
441#define	NFSCLRBIT_ATTRBIT(b, p)	((b)->bits[(p) / 32] &= ~(1 << ((p) % 32)))
442
443#define	NFSCLRALL_ATTRBIT(b, a)	do { 					\
444	(b)->bits[0] &= ~((a)->bits[0]);	 			\
445	(b)->bits[1] &= ~((a)->bits[1]);	 			\
446	(b)->bits[2] &= ~((a)->bits[2]);				\
447} while (0)
448
449#define	NFSCLRNOT_ATTRBIT(b, a)	do { 					\
450	(b)->bits[0] &= ((a)->bits[0]);		 			\
451	(b)->bits[1] &= ((a)->bits[1]);		 			\
452	(b)->bits[2] &= ((a)->bits[2]);		 			\
453} while (0)
454
455#define	NFSCLRNOTFILLABLE_ATTRBIT(b, n) do { 				\
456	(b)->bits[0] &= NFSATTRBIT_SUPP0;	 			\
457	(b)->bits[1] &= NFSATTRBIT_SUPP1;				\
458	(b)->bits[2] &= NFSATTRBIT_SUPP2;				\
459	if (((n)->nd_flag & ND_NFSV41) == 0) {				\
460		(b)->bits[1] &= ~NFSATTRBIT_NFSV41_1;			\
461		(b)->bits[2] &= ~NFSATTRBIT_NFSV41_2;			\
462	}								\
463	if (((n)->nd_flag & ND_NFSV42) == 0)				\
464		(b)->bits[2] &= ~NFSATTRBIT_NFSV42_2;			\
465} while (0)
466
467#define	NFSCLRNOTSETABLE_ATTRBIT(b, n) do { 				\
468	(b)->bits[0] &= NFSATTRBIT_SETABLE0;	 			\
469	(b)->bits[1] &= NFSATTRBIT_SETABLE1;				\
470	(b)->bits[2] &= NFSATTRBIT_SETABLE2;				\
471	if (((n)->nd_flag & ND_NFSV41) == 0)				\
472		(b)->bits[2] &= ~NFSATTRBIT_NFSV41_2;			\
473	if (((n)->nd_flag & ND_NFSV42) == 0)				\
474		(b)->bits[2] &= ~NFSATTRBIT_NFSV42_2;			\
475} while (0)
476
477#define	NFSNONZERO_ATTRBIT(b)	((b)->bits[0] || (b)->bits[1] || (b)->bits[2])
478#define	NFSEQUAL_ATTRBIT(b, p)	((b)->bits[0] == (p)->bits[0] &&	\
479	(b)->bits[1] == (p)->bits[1] && (b)->bits[2] == (p)->bits[2])
480
481#define	NFSGETATTR_ATTRBIT(b) do { 					\
482	(b)->bits[0] = NFSATTRBIT_GETATTR0;	 			\
483	(b)->bits[1] = NFSATTRBIT_GETATTR1;				\
484	(b)->bits[2] = NFSATTRBIT_GETATTR2;				\
485} while (0)
486
487#define	NFSWCCATTR_ATTRBIT(b) do { 					\
488	(b)->bits[0] = NFSATTRBIT_WCCATTR0;	 			\
489	(b)->bits[1] = NFSATTRBIT_WCCATTR1;				\
490	(b)->bits[2] = NFSATTRBIT_WCCATTR2;				\
491} while (0)
492
493#define	NFSWRITEGETATTR_ATTRBIT(b) do { 				\
494	(b)->bits[0] = NFSATTRBIT_WRITEGETATTR0;			\
495	(b)->bits[1] = NFSATTRBIT_WRITEGETATTR1;			\
496	(b)->bits[2] = NFSATTRBIT_WRITEGETATTR2;			\
497} while (0)
498
499#define	NFSCBGETATTR_ATTRBIT(b, c) do { 				\
500	(c)->bits[0] = ((b)->bits[0] & NFSATTRBIT_CBGETATTR0);		\
501	(c)->bits[1] = ((b)->bits[1] & NFSATTRBIT_CBGETATTR1);		\
502	(c)->bits[2] = ((b)->bits[2] & NFSATTRBIT_CBGETATTR2);		\
503} while (0)
504
505#define	NFSPATHCONF_GETATTRBIT(b) do { 					\
506	(b)->bits[0] = NFSGETATTRBIT_PATHCONF0;		 		\
507	(b)->bits[1] = NFSGETATTRBIT_PATHCONF1;				\
508	(b)->bits[2] = NFSGETATTRBIT_PATHCONF2;				\
509} while (0)
510
511#define	NFSSTATFS_GETATTRBIT(b)	do { 					\
512	(b)->bits[0] = NFSGETATTRBIT_STATFS0;	 			\
513	(b)->bits[1] = NFSGETATTRBIT_STATFS1;				\
514	(b)->bits[2] = NFSGETATTRBIT_STATFS2;				\
515} while (0)
516
517#define	NFSISSETSTATFS_ATTRBIT(b) 					\
518		(((b)->bits[0] & NFSATTRBIT_STATFS0) || 		\
519		 ((b)->bits[1] & NFSATTRBIT_STATFS1) ||			\
520		 ((b)->bits[2] & NFSATTRBIT_STATFS2))
521
522#define	NFSCLRSTATFS_ATTRBIT(b)	do { 					\
523	(b)->bits[0] &= ~NFSATTRBIT_STATFS0;	 			\
524	(b)->bits[1] &= ~NFSATTRBIT_STATFS1;				\
525	(b)->bits[2] &= ~NFSATTRBIT_STATFS2;				\
526} while (0)
527
528#define	NFSREADDIRPLUS_ATTRBIT(b) do { 					\
529	(b)->bits[0] = NFSATTRBIT_READDIRPLUS0;		 		\
530	(b)->bits[1] = NFSATTRBIT_READDIRPLUS1;				\
531	(b)->bits[2] = NFSATTRBIT_READDIRPLUS2;				\
532} while (0)
533
534#define	NFSREFERRAL_ATTRBIT(b) do { 					\
535	(b)->bits[0] = NFSATTRBIT_REFERRAL0;		 		\
536	(b)->bits[1] = NFSATTRBIT_REFERRAL1;				\
537	(b)->bits[2] = NFSATTRBIT_REFERRAL2;				\
538} while (0)
539
540/*
541 * Store uid, gid creds that were used when the stateid was acquired.
542 * The RPC layer allows NFS_MAXGRPS + 1 groups to go out on the wire,
543 * so that's how many gets stored here.
544 */
545struct nfscred {
546	uid_t 		nfsc_uid;
547	gid_t		nfsc_groups[NFS_MAXGRPS + 1];
548	int		nfsc_ngroups;
549};
550
551/*
552 * Constants that define the file handle for the V4 root directory.
553 * (The FSID must never be used by other file systems that are exported.)
554 */
555#define	NFSV4ROOT_FSID0		((int32_t) -1)
556#define	NFSV4ROOT_FSID1		((int32_t) -1)
557#define	NFSV4ROOT_REFERRAL	((int32_t) -2)
558#define	NFSV4ROOT_INO		2	/* It's traditional */
559#define	NFSV4ROOT_GEN		1
560
561/*
562 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
563 * What should be in this set is open to debate, but I believe that since
564 * I/O system calls on ufs are never interrupted by signals the set should
565 * be minimal. My reasoning is that many current programs that use signals
566 * such as SIGALRM will not expect file I/O system calls to be interrupted
567 * by them and break.
568 */
569#if defined(_KERNEL) || defined(KERNEL)
570
571struct uio; struct buf; struct vattr; struct nameidata;	/* XXX */
572
573/*
574 * Socket errors ignored for connectionless sockets?
575 * For now, ignore them all
576 */
577#define	NFSIGNORE_SOERROR(s, e) 					\
578		((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
579		((s) & PR_CONNREQUIRED) == 0)
580
581
582/*
583 * This structure holds socket information for a connection. Used by the
584 * client and the server for callbacks.
585 */
586struct nfssockreq {
587	NFSSOCKADDR_T	nr_nam;
588	int		nr_sotype;
589	int		nr_soproto;
590	int		nr_soflags;
591	struct ucred	*nr_cred;
592	int		nr_lock;
593	NFSMUTEX_T	nr_mtx;
594	u_int32_t	nr_prog;
595	u_int32_t	nr_vers;
596	struct __rpc_client *nr_client;
597	AUTH		*nr_auth;
598};
599
600/*
601 * And associated nr_lock bits.
602 */
603#define	NFSR_SNDLOCK		0x01
604#define	NFSR_WANTSND		0x02
605#define	NFSR_RCVLOCK		0x04
606#define	NFSR_WANTRCV		0x08
607#define	NFSR_RESERVEDPORT	0x10
608#define	NFSR_LOCALHOST		0x20
609
610/*
611 * Queue head for nfsreq's
612 */
613TAILQ_HEAD(nfsreqhead, nfsreq);
614
615/* This is the only nfsreq R_xxx flag still used. */
616#define	R_DONTRECOVER	0x00000100	/* don't initiate recovery when this
617					   rpc gets a stale state reply */
618
619/*
620 * Network address hash list element
621 */
622union nethostaddr {
623	struct in_addr	had_inet;
624	struct in6_addr had_inet6;
625};
626
627/*
628 * Structure of list of mechanisms.
629 */
630struct nfsgss_mechlist {
631	int	len;
632	const u_char	*str;
633	int	totlen;
634};
635#define	KERBV_MECH	0	/* position in list */
636
637/*
638 * This structure is used by the server for describing each request.
639 */
640struct nfsrv_descript {
641	struct mbuf		*nd_mrep;	/* Request mbuf list */
642	struct mbuf		*nd_md;		/* Current dissect mbuf */
643	struct mbuf		*nd_mreq;	/* Reply mbuf list */
644	struct mbuf		*nd_mb;		/* Current build mbuf */
645	NFSSOCKADDR_T		nd_nam;		/* and socket addr */
646	NFSSOCKADDR_T		nd_nam2;	/* return socket addr */
647	caddr_t			nd_dpos;	/* Current dissect pos */
648	caddr_t			nd_bpos;	/* Current build pos */
649	u_int64_t		nd_flag;	/* nd_flag */
650	u_int16_t		nd_procnum;	/* RPC # */
651	u_int32_t		nd_repstat;	/* Reply status */
652	int			*nd_errp;	/* Pointer to ret status */
653	u_int32_t		nd_retxid;	/* Reply xid */
654	struct nfsrvcache	*nd_rp;		/* Assoc. cache entry */
655	fhandle_t		nd_fh;		/* File handle */
656	struct ucred		*nd_cred;	/* Credentials */
657	uid_t			nd_saveduid;	/* Saved uid */
658	u_int64_t		nd_sockref;	/* Rcv socket ref# */
659	u_int64_t		nd_compref;	/* Compound RPC ref# */
660	time_t			nd_tcpconntime;	/* Time TCP connection est. */
661	nfsquad_t		nd_clientid;	/* Implied clientid */
662	int			nd_gssnamelen;	/* principal name length */
663	char			*nd_gssname;	/* principal name */
664	uint32_t		*nd_slotseq;	/* ptr to slot seq# in req */
665	uint8_t			nd_sessionid[NFSX_V4SESSIONID];	/* Session id */
666	uint32_t		nd_slotid;	/* Slotid for this RPC */
667	SVCXPRT			*nd_xprt;	/* Server RPC handle */
668	uint32_t		*nd_sequence;	/* Sequence Op. ptr */
669	nfsv4stateid_t		nd_curstateid;	/* Current StateID */
670	nfsv4stateid_t		nd_savedcurstateid; /* Saved Current StateID */
671	uint32_t		nd_maxreq;	/* Max. request (session). */
672	uint32_t		nd_maxresp;	/* Max. reply (session). */
673	int			nd_bextpg;	/* Current ext_pgs page */
674	int			nd_bextpgsiz;	/* Bytes left in page */
675	int			nd_maxextsiz;	/* Max ext_pgs mbuf size */
676};
677
678#define	nd_princlen	nd_gssnamelen
679#define	nd_principal	nd_gssname
680
681/* Bits for "nd_flag" */
682#define	ND_DONTSAVEREPLY 	0x00000001
683#define	ND_SAVEREPLY		0x00000002
684#define	ND_NFSV2		0x00000004
685#define	ND_NFSV3		0x00000008
686#define	ND_NFSV4		0x00000010
687#define	ND_KERBV		0x00000020
688#define	ND_GSSINTEGRITY		0x00000040
689#define	ND_GSSPRIVACY		0x00000080
690#define	ND_WINDOWVERF		0x00000100
691#define	ND_GSSINITREPLY		0x00000200
692#define	ND_STREAMSOCK		0x00000400
693#define	ND_PUBLOOKUP		0x00000800
694#define	ND_USEGSSNAME		0x00001000
695#define	ND_SAMETCPCONN		0x00002000
696#define	ND_IMPLIEDCLID		0x00004000
697#define	ND_NOMOREDATA		0x00008000
698#define	ND_V4WCCATTR		0x00010000
699#define	ND_NFSCB		0x00020000
700#define	ND_AUTHNONE		0x00040000
701#define	ND_EXAUTHSYS		0x00080000
702#define	ND_EXGSS		0x00100000
703#define	ND_EXGSSINTEGRITY	0x00200000
704#define	ND_EXGSSPRIVACY		0x00400000
705#define	ND_INCRSEQID		0x00800000
706#define	ND_NFSCL		0x01000000
707#define	ND_NFSV41		0x02000000
708#define	ND_HASSEQUENCE		0x04000000
709#define	ND_CACHETHIS		0x08000000
710#define	ND_LASTOP		0x10000000
711#define	ND_LOOPBADSESS		0x20000000
712#define	ND_DSSERVER		0x40000000
713#define	ND_CURSTATEID		0x80000000
714#define	ND_SAVEDCURSTATEID	0x100000000
715#define	ND_HASSLOTID		0x200000000
716#define	ND_NFSV42		0x400000000
717#define	ND_EXTPG		0x800000000
718#define	ND_TLS			0x1000000000
719#define	ND_TLSCERT		0x2000000000
720#define	ND_TLSCERTUSER		0x4000000000
721#define	ND_EXTLS		0x8000000000
722#define	ND_EXTLSCERT		0x10000000000
723#define	ND_EXTLSCERTUSER	0x20000000000
724
725/*
726 * ND_GSS should be the "or" of all GSS type authentications.
727 */
728#define	ND_GSS		(ND_KERBV)
729
730struct nfsv4_opflag {
731	int	retfh;
732	int	needscfh;
733	int	savereply;
734	int	modifyfs;
735	int	lktype;
736	int	needsseq;
737	int	loopbadsess;
738};
739
740/*
741 * Flags used to indicate what to do w.r.t. seqid checking.
742 */
743#define	NFSRVSEQID_FIRST	0x01
744#define	NFSRVSEQID_LAST		0x02
745#define	NFSRVSEQID_OPEN		0x04
746
747/*
748 * assign a doubly linked list to a new head
749 * and prepend one list into another.
750 */
751#define	LIST_NEWHEAD(nhead, ohead, field) do { 				\
752	if (((nhead)->lh_first = (ohead)->lh_first) != NULL) 		\
753		(ohead)->lh_first->field.le_prev = &(nhead)->lh_first; 	\
754	(ohead)->lh_first = NULL; 					\
755    } while (0)
756
757#define	LIST_PREPEND(head, phead, lelm, field) do {			\
758	if ((head)->lh_first != NULL) {					\
759		(lelm)->field.le_next = (head)->lh_first;		\
760		(lelm)->field.le_next->field.le_prev =			\
761		    &(lelm)->field.le_next;				\
762	}								\
763	(head)->lh_first = (phead)->lh_first;				\
764	(head)->lh_first->field.le_prev = &(head)->lh_first;		\
765    } while (0)
766
767/*
768 * File handle structure for client. Malloc'd to the correct length with
769 * malloc type M_NFSFH.
770 */
771struct nfsfh {
772	u_int16_t	nfh_len;	/* Length of file handle */
773	u_int8_t	nfh_fh[1];	/* and the file handle */
774};
775
776/*
777 * File handle structure for server. The NFSRV_MAXFH constant is
778 * set in nfsdport.h. I use a 32bit length, so that alignment is
779 * preserved.
780 */
781struct nfsrvfh {
782	u_int32_t	nfsrvfh_len;
783	u_int8_t	nfsrvfh_data[NFSRV_MAXFH];
784};
785
786/*
787 * This structure is used for sleep locks on the NFSv4 nfsd threads and
788 * NFSv4 client data structures.
789 */
790struct nfsv4lock {
791	u_int32_t	nfslock_usecnt;
792	u_int8_t	nfslock_lock;
793};
794#define	NFSV4LOCK_LOCK		0x01
795#define	NFSV4LOCK_LOCKWANTED	0x02
796#define	NFSV4LOCK_WANTED	0x04
797
798/*
799 * Values for the override argument for nfsvno_accchk().
800 */
801#define	NFSACCCHK_NOOVERRIDE		0
802#define	NFSACCCHK_ALLOWROOT		1
803#define	NFSACCCHK_ALLOWOWNER		2
804
805/*
806 * and values for the vpislocked argument for nfsvno_accchk().
807 */
808#define	NFSACCCHK_VPNOTLOCKED		0
809#define	NFSACCCHK_VPISLOCKED		1
810
811/*
812 * Slot for the NFSv4.1 Sequence Op.
813 */
814struct nfsslot {
815	int		nfssl_inprog;
816	uint32_t	nfssl_seq;
817	struct mbuf	*nfssl_reply;
818};
819
820/* Enumerated type for nfsuserd state. */
821typedef enum { NOTRUNNING=0, STARTSTOP=1, RUNNING=2 } nfsuserd_state;
822
823#endif	/* _KERNEL */
824
825#endif	/* _NFS_NFS_H */
826