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