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