xref: /netbsd-src/sys/nfs/nfs.h (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: nfs.h,v 1.72 2010/03/02 23:19:09 pooka Exp $	*/
2 /*
3  * Copyright (c) 1989, 1993, 1995
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  * 3. 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  *	@(#)nfs.h	8.4 (Berkeley) 5/1/95
34  */
35 
36 #ifndef _NFS_NFS_H_
37 #define _NFS_NFS_H_
38 
39 #ifdef _KERNEL
40 #include <sys/condvar.h>
41 #include <sys/fstypes.h>
42 #include <sys/mbuf.h>
43 #include <sys/mutex.h>
44 #endif
45 
46 /*
47  * Tunable constants for nfs
48  */
49 
50 #define	NFS_MAXIOVEC	34
51 #define NFS_TICKINTVL	5		/* Desired time for a tick (msec) */
52 #define NFS_HZ		(hz / nfs_ticks) /* Ticks/sec */
53 #define	NFS_TIMEO	(3 * NFS_HZ)	/* Default timeout = 3 seconds */
54 #define	NFS_MINTIMEO	(1 * NFS_HZ)	/* Min timeout to use */
55 #define	NFS_MAXTIMEO	(60 * NFS_HZ)	/* Max timeout to backoff to */
56 #define	NFS_MINIDEMTIMEO (5 * NFS_HZ)	/* Min timeout for non-idempotent ops*/
57 #define	NFS_MAXREXMIT	100		/* Stop counting after this many */
58 #define	NFS_MAXWINDOW	1024		/* Max number of outstanding requests */
59 #define	NFS_RETRANS	10		/* Num of retrans for soft mounts */
60 #define	NFS_MAXGRPS	16		/* Max. size of groups list */
61 #ifndef NFS_MINATTRTIMO
62 #define	NFS_MINATTRTIMO 5		/* Attribute cache timeout in sec */
63 #endif
64 #ifndef NFS_MAXATTRTIMO
65 #define	NFS_MAXATTRTIMO 60
66 #endif
67 #define	NFS_TRYLATERDEL	1		/* Initial try later delay (sec) */
68 #define	NFS_TRYLATERDELMAX (1*60)	/* Maximum try later delay (sec) */
69 #define	NFS_TRYLATERDELMUL 2		/* Exponential backoff multiplier */
70 
71 #define NFS_CWNDSCALE   256
72 #define NFS_MAXCWND     (NFS_CWNDSCALE * 32)
73 
74 /*
75  * These can be overridden through <machine/param.h>, included via
76  * <sys/param.h>. This means that <sys/param.h> should always be
77  * included before this file.
78  */
79 #ifndef NFS_WSIZE
80 #define	NFS_WSIZE	8192		/* Def. write data size */
81 #endif
82 #ifndef NFS_RSIZE
83 #define	NFS_RSIZE	8192		/* Def. read data size */
84 #endif
85 #ifndef NFS_READDIRSIZE
86 #define NFS_READDIRSIZE	8192		/* Def. readdir size */
87 #endif
88 
89 /*
90  * NFS client IO daemon threads. May be overridden by config options.
91  */
92 #ifndef NFS_MAXASYNCDAEMON
93 #define	NFS_MAXASYNCDAEMON 	128	/* Max. number async_daemons runable */
94 #endif
95 
96 /*
97  * NFS client read-ahead. May be overridden by config options.
98  * Should be no more than NFS_MAXASYNCDAEMON as each read-ahead operation
99  * requires one IO thread.
100  */
101 #ifndef NFS_MAXRAHEAD
102 #define	NFS_MAXRAHEAD	32		/* Max. read ahead # blocks */
103 #endif
104 #define	NFS_DEFRAHEAD	2		/* Def. read ahead # blocks */
105 
106 #define	NFS_MAXUIDHASH	64		/* Max. # of hashed uid entries/mp */
107 
108 #define	NFS_DEFDEADTHRESH NFS_NEVERDEAD	/* Default nm_deadthresh */
109 #define	NFS_NEVERDEAD	9		/* Greater than max. nm_timeouts */
110 
111 #ifdef _KERNEL
112 extern int nfs_niothreads;              /* Number of async_daemons desired */
113 #ifndef NFS_DEFAULT_NIOTHREADS
114 #define NFS_DEFAULT_NIOTHREADS 4
115 #endif
116 #endif
117 #define NFS_MAXGATHERDELAY	100	/* Max. write gather delay (msec) */
118 #ifndef NFS_GATHERDELAY
119 #define NFS_GATHERDELAY		10	/* Default write gather delay (msec) */
120 #endif
121 
122 /*
123  * NFS_DIRBLKSIZ is the size of buffers in the buffer cache used for
124  * NFS directory vnodes. NFS_DIRFRAGSIZ is the minimum aligned amount
125  * of data in those buffers, and thus the minimum amount of data
126  * that you can request. NFS_DIRFRAGSIZ should be no smaller than
127  * DIRBLKSIZ.
128  */
129 
130 #define	NFS_DIRBLKSIZ	8192		/* Must be a multiple of DIRBLKSIZ */
131 #define NFS_DIRFRAGSIZ	 512		/* Same as DIRBLKSIZ, generally */
132 
133 /*
134  * Maximum number of directory entries cached per NFS node, to avoid
135  * having this grow without bounds on very large directories. The
136  * minimum size to get reasonable performance for emulated binaries
137  * is the maximum number of entries that fits in NFS_DIRBLKSIZ.
138  * For NFS_DIRBLKSIZ = 512, this would be 512 / 14 = 36.
139  */
140 #define NFS_MAXDIRCACHE	(NFS_DIRBLKSIZ / 14)
141 
142 /*
143  * Oddballs
144  */
145 #define NFS_CMPFH(n, f, s) \
146 	((n)->n_fhsize == (s) && !memcmp((void *)(n)->n_fhp,  (void *)(f),  (s)))
147 #ifdef NFS_V2_ONLY
148 #define NFS_ISV3(v)	(0)
149 #else
150 #define NFS_ISV3(v)	(VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
151 #endif
152 #define NFS_SRVMAXDATA(n) \
153 		(((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
154 		 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
155 
156 /*
157  * Use the vm_page flag reserved for pager use to indicate pages
158  * which have been written to the server but not yet committed.
159  */
160 #define PG_NEEDCOMMIT PG_PAGER1
161 
162 /*
163  * The IO_METASYNC flag should be implemented for local file systems.
164  * (Until then, it is nothin at all.)
165  */
166 #ifndef IO_METASYNC
167 #define IO_METASYNC	0
168 #endif
169 
170 /*
171  * Export arguments for local filesystem mount calls.
172  * Keep in mind that changing this structure modifies nfssvc(2)'s ABI (see
173  * 'struct mountd_exports_list' below).
174  * When modifying this structure, take care to also edit the
175  * nfs_update_exports_30 function in nfs_export.c accordingly to convert
176  * export_args to export_args30.
177  */
178 struct export_args {
179 	int	ex_flags;		/* export related flags */
180 	uid_t	ex_root;		/* mapping for root uid */
181 	struct	uucred ex_anon;		/* mapping for anonymous user */
182 	struct	sockaddr *ex_addr;	/* net address to which exported */
183 	int	ex_addrlen;		/* and the net address length */
184 	struct	sockaddr *ex_mask;	/* mask of valid bits in saddr */
185 	int	ex_masklen;		/* and the smask length */
186 	char	*ex_indexfile;		/* index file for WebNFS URLs */
187 };
188 
189 /*
190  * Structures for the nfssvc(2) syscall. Not that anyone but mountd, nfsd and
191  * mount_nfs should ever try and use it.
192  */
193 struct nfsd_args {
194 	int	sock;		/* Socket to serve */
195 	void *	name;		/* Client addr for connection based sockets */
196 	int	namelen;	/* Length of name */
197 };
198 
199 struct nfsd_srvargs {
200 	struct nfsd	*nsd_nfsd;	/* Pointer to in kernel nfsd struct */
201 	uid_t		nsd_uid;	/* Effective uid mapped to cred */
202 	u_int32_t	nsd_haddr;	/* Ip address of client */
203 	struct uucred	nsd_cr;		/* Cred. uid maps to */
204 	int		nsd_authlen;	/* Length of auth string (ret) */
205 	u_char		*nsd_authstr;	/* Auth string (ret) */
206 	int		nsd_verflen;	/* and the verfier */
207 	u_char		*nsd_verfstr;
208 	struct timeval	nsd_timestamp;	/* timestamp from verifier */
209 	u_int32_t	nsd_ttl;	/* credential ttl (sec) */
210 	NFSKERBKEY_T	nsd_key;	/* Session key */
211 };
212 
213 struct nfsd_cargs {
214 	char		*ncd_dirp;	/* Mount dir path */
215 	uid_t		ncd_authuid;	/* Effective uid */
216 	int		ncd_authtype;	/* Type of authenticator */
217 	u_int		ncd_authlen;	/* Length of authenticator string */
218 	u_char		*ncd_authstr;	/* Authenticator string */
219 	u_int		ncd_verflen;	/* and the verifier */
220 	u_char		*ncd_verfstr;
221 	NFSKERBKEY_T	ncd_key;	/* Session key */
222 };
223 
224 struct mountd_exports_list {
225 	const char		*mel_path;
226 	size_t			mel_nexports;
227 	struct export_args	*mel_exports;
228 };
229 
230 /*
231  * try to keep nfsstats, which is exposed to userland via sysctl,
232  * compatible after NQNFS removal.
233  * 26 is the old value of NFS_NPROCS, which includes NQNFS procedures.
234  */
235 #define	NFSSTATS_NPROCS	26
236 
237 /*
238  * Stats structure
239  */
240 struct nfsstats {
241 	int	attrcache_hits;
242 	int	attrcache_misses;
243 	int	lookupcache_hits;
244 	int	lookupcache_misses;
245 	int	direofcache_hits;
246 	int	direofcache_misses;
247 	int	biocache_reads;
248 	int	read_bios;
249 	int	read_physios;
250 	int	biocache_writes;
251 	int	write_bios;
252 	int	write_physios;
253 	int	biocache_readlinks;
254 	int	readlink_bios;
255 	int	biocache_readdirs;
256 	int	readdir_bios;
257 	int	rpccnt[NFSSTATS_NPROCS];
258 	int	rpcretries;
259 	int	srvrpccnt[NFSSTATS_NPROCS];
260 	int	srvrpc_errs;
261 	int	srv_errs;
262 	int	rpcrequests;
263 	int	rpctimeouts;
264 	int	rpcunexpected;
265 	int	rpcinvalid;
266 	int	srvcache_inproghits;
267 	int	srvcache_idemdonehits;
268 	int	srvcache_nonidemdonehits;
269 	int	srvcache_misses;
270 	int	__srvnqnfs_leases;	/* unused */
271 	int	__srvnqnfs_maxleases;	/* unused */
272 	int	__srvnqnfs_getleases;	/* unused */
273 	int	srvvop_writes;
274 };
275 
276 /*
277  * Flags for nfssvc() system call.
278  */
279 #define	NFSSVC_BIOD	0x002
280 #define	NFSSVC_NFSD	0x004
281 #define	NFSSVC_ADDSOCK	0x008
282 #define	NFSSVC_AUTHIN	0x010
283 #define	NFSSVC_GOTAUTH	0x040
284 #define	NFSSVC_AUTHINFAIL 0x080
285 #define	NFSSVC_MNTD	0x100
286 #define	NFSSVC_SETEXPORTSLIST	0x200
287 
288 /*
289  * fs.nfs sysctl(3) identifiers
290  */
291 #define NFS_NFSSTATS	1		/* struct: struct nfsstats */
292 #define NFS_IOTHREADS	2		/* number of io threads */
293 #define	NFS_MAXID	3
294 
295 #define NFS_NAMES { \
296 	{ 0, 0 }, \
297 	{ "nfsstats", CTLTYPE_STRUCT }, \
298 	{ "iothreads", CTLTYPE_INT }, \
299 }
300 
301 /*
302  * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
303  * What should be in this set is open to debate, but I believe that since
304  * I/O system calls on ufs are never interrupted by signals the set should
305  * be minimal. My reasoning is that many current programs that use signals
306  * such as SIGALRM will not expect file I/O system calls to be interrupted
307  * by them and break.
308  */
309 #ifdef _KERNEL
310 
311 struct uio; struct buf; struct vattr; struct nameidata;	/* XXX */
312 
313 /*
314  * Socket errors ignored for connectionless sockets??
315  * For now, ignore them all
316  */
317 #define	NFSIGNORE_SOERROR(s, e) \
318 		((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
319 		((s) & PR_CONNREQUIRED) == 0)
320 
321 /*
322  * Nfs outstanding request list element
323  */
324 struct nfsreq {
325 	TAILQ_ENTRY(nfsreq) r_chain;
326 	struct mbuf	*r_mreq;
327 	struct mbuf	*r_mrep;
328 	struct mbuf	*r_md;
329 	void *		r_dpos;
330 	struct nfsmount *r_nmp;
331 	u_int32_t	r_xid;
332 	int		r_flags;	/* flags on request, see below */
333 	int		r_retry;	/* max retransmission count */
334 	int		r_rexmit;	/* current retrans count */
335 	u_int32_t	r_procnum;	/* NFS procedure number */
336 	int		r_rtt;		/* RTT for rpc */
337 	struct lwp	*r_lwp;		/* LWP that did I/O system call */
338 };
339 
340 /*
341  * Queue head for nfsreq's
342  */
343 extern TAILQ_HEAD(nfsreqhead, nfsreq) nfs_reqq;
344 
345 /* Flag values for r_flags */
346 #define R_TIMING	0x01		/* timing request (in mntp) */
347 #define R_SENT		0x02		/* request has been sent */
348 #define	R_SOFTTERM	0x04		/* soft mnt, too many retries */
349 #define	R_INTR		0x08		/* intr mnt, signal pending */
350 #define	R_SOCKERR	0x10		/* Fatal error on socket */
351 #define	R_TPRINTFMSG	0x20		/* Did a tprintf msg. */
352 #define	R_MUSTRESEND	0x40		/* Must resend request */
353 #define	R_REXMITTED	0x100		/* retransmitted after reconnect */
354 
355 /*
356  * A list of nfssvc_sock structures is maintained with all the sockets
357  * that require service by the nfsd.
358  * The nfsuid structs hang off of the nfssvc_sock structs in both lru
359  * and uid hash lists.
360  */
361 #ifndef NFS_UIDHASHSIZ
362 #define	NFS_UIDHASHSIZ	29	/* Tune the size of nfssvc_sock with this */
363 #endif
364 #define	NUIDHASH(sock, uid) \
365 	(&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
366 #ifndef NFS_WDELAYHASHSIZ
367 #define	NFS_WDELAYHASHSIZ 16	/* and with this */
368 #endif
369 #ifndef NFS_MUIDHASHSIZ
370 #define NFS_MUIDHASHSIZ	63	/* Tune the size of nfsmount with this */
371 #endif
372 #define	NMUIDHASH(nmp, uid) \
373 	(&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
374 
375 #ifndef NFS_DIRHASHSIZ
376 #define NFS_DIRHASHSIZ 64
377 #endif
378 #define NFSDIRHASH(np, off) \
379 	(&np->n_dircache[(nfs_dirhash((off)) & nfsdirhashmask)])
380 
381 /*
382  * Macros for storing/retrieving cookies into directory buffers.
383  */
384 #define NFS_STASHCOOKIE(dp,off) \
385 	*((off_t *)((char *)(dp) + (dp)->d_reclen - sizeof (off_t))) = off
386 #define NFS_GETCOOKIE(dp) \
387 	(*((off_t *)((char *)(dp) + (dp)->d_reclen - sizeof (off_t))))
388 #define NFS_STASHCOOKIE32(dp, val) \
389 	*((u_int32_t *)((char *)(dp) + (dp)->d_reclen - sizeof (off_t) - \
390 	    sizeof (int))) = val
391 #define NFS_GETCOOKIE32(dp) \
392 	(*((u_int32_t *)((char *)(dp) + (dp)->d_reclen - sizeof (off_t) - \
393 	    sizeof (int))))
394 
395 /*
396  * Flags passed to nfs_bioread().
397  */
398 #define NFSBIO_CACHECOOKIES	0x0001	/* Cache dir offset cookies */
399 
400 /*
401  * Network address hash list element
402  */
403 union nethostaddr {
404 	u_int32_t had_inetaddr;
405 	struct mbuf *had_nam;
406 };
407 
408 struct nfsuid {
409 	TAILQ_ENTRY(nfsuid) nu_lru;	/* LRU chain */
410 	LIST_ENTRY(nfsuid) nu_hash;	/* Hash list */
411 	int		nu_flag;	/* Flags */
412 	union nethostaddr nu_haddr;	/* Host addr. for dgram sockets */
413 	kauth_cred_t	nu_cr;		/* Cred uid mapped to */
414 	int		nu_expire;	/* Expiry time (sec) */
415 	struct timeval	nu_timestamp;	/* Kerb. timestamp */
416 	u_int32_t	nu_nickname;	/* Nickname on server */
417 	NFSKERBKEY_T	nu_key;		/* and session key */
418 };
419 
420 #define	nu_inetaddr	nu_haddr.had_inetaddr
421 #define	nu_nam		nu_haddr.had_nam
422 /* Bits for nu_flag */
423 #define	NU_INETADDR	0x1
424 #define NU_NAM		0x2
425 #ifdef INET6
426 #define NU_NETFAM(u) \
427 	(((u)->nu_flag & NU_INETADDR) ? \
428 	(((u)->nu_flag & NU_NAM) ? AF_INET6 : AF_INET) : AF_ISO)
429 #else
430 #define NU_NETFAM(u)	(((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
431 #endif
432 
433 /*
434  * b: protected by SLP_BUSY
435  * g: protected by nfsd_lock
436  * s: protected by ns_lock
437  * a: protected by ns_alock
438  */
439 
440 struct nfssvc_sock {
441 	kmutex_t ns_lock;
442 	kmutex_t ns_alock;
443 	kcondvar_t ns_cv;			/* s: */
444 	TAILQ_ENTRY(nfssvc_sock) ns_chain;	/* g: List of all nfssvc_sock */
445 	TAILQ_ENTRY(nfssvc_sock) ns_pending;	/* g: List of pending sockets */
446 	TAILQ_HEAD(, nfsuid) ns_uidlruhead;
447 	struct file	*ns_fp;
448 	struct socket	*ns_so;
449 	struct mbuf	*ns_nam;
450 	struct mbuf	*ns_raw;		/* b: */
451 	struct mbuf	*ns_rawend;		/* b: */
452 	struct mbuf	*ns_rec;		/* b: */
453 	struct mbuf	*ns_recend;		/* b: */
454 	struct mbuf	*ns_frag;		/* b: */
455 	int		ns_flags;		/* s: */
456 	int		ns_aflags;		/* a: */
457 	int		ns_gflags;		/* g: */
458 	int		ns_sflags;		/* b: */
459 	int		ns_cc;			/* b: */
460 	int		ns_reclen;		/* b: */
461 	int		ns_numuids;
462 	u_int32_t	ns_sref;		/* g: */
463 	SIMPLEQ_HEAD(, nfsrv_descript) ns_sendq; /* s: send reply list */
464 	LIST_HEAD(, nfsrv_descript) ns_tq;	/* g: Write gather lists */
465 	LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
466 	LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ]; /* g: */
467 };
468 
469 /* Bits for "ns_flags" */
470 #define	SLP_VALID	0x01
471 #define	SLP_BUSY	0x10
472 #define	SLP_SENDING	0x80
473 
474 /* Bits for "ns_aflags" */
475 #define	SLP_A_NEEDQ	0x01
476 #define	SLP_A_DISCONN	0x04
477 
478 /* Bits for "ns_gflags" */
479 #define	SLP_G_DOREC	0x02	/* on nfssvc_sockpending queue */
480 
481 /* Bits for "ns_sflags" */
482 #define	SLP_S_LASTFRAG	0x40
483 
484 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
485 extern struct nfssvc_sockhead nfssvc_sockpending;
486 extern int nfssvc_sockhead_flag;
487 #define	SLP_INIT	0x01
488 
489 /*
490  * One of these structures is allocated for each nfsd.
491  */
492 struct nfsd {
493 	TAILQ_ENTRY(nfsd) nfsd_chain;	/* List of all nfsd's */
494 	SLIST_ENTRY(nfsd) nfsd_idle;	/* List of idle nfsd's */
495 	kcondvar_t	nfsd_cv;
496 	int		nfsd_flag;	/* NFSD_ flags */
497 	struct nfssvc_sock *nfsd_slp;	/* Current socket */
498 	int		nfsd_authlen;	/* Authenticator len */
499 	u_char		nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
500 	int		nfsd_verflen;	/* and the Verifier */
501 	u_char		nfsd_verfstr[RPCVERF_MAXSIZ];
502 	struct proc	*nfsd_procp;	/* Proc ptr */
503 	struct nfsrv_descript *nfsd_nd;	/* Associated nfsrv_descript */
504 };
505 
506 /* Bits for "nfsd_flag" */
507 #define	NFSD_NEEDAUTH	0x04
508 #define	NFSD_AUTHFAIL	0x08
509 
510 #define	NFSD_MAXFHSIZE	64
511 typedef struct nfsrvfh {
512 	size_t nsfh_size;
513 	union {
514 		fhandle_t u_fh;
515 		uint8_t u_opaque[NFSD_MAXFHSIZE];
516 	} nsfh_u;
517 } nfsrvfh_t;
518 #define	NFSRVFH_SIZE(nsfh)	((nsfh)->nsfh_size)
519 #define	NFSRVFH_DATA(nsfh)	((nsfh)->nsfh_u.u_opaque)
520 #define	NFSRVFH_FHANDLE(nsfh)	(&(nsfh)->nsfh_u.u_fh)
521 
522 /*
523  * This structure is used by the server for describing each request.
524  * Some fields are used only when write request gathering is performed.
525  */
526 struct nfsrv_descript {
527 	u_quad_t		nd_time;	/* Write deadline (usec) */
528 	off_t			nd_off;		/* Start byte offset */
529 	off_t			nd_eoff;	/* and end byte offset */
530 	LIST_ENTRY(nfsrv_descript) nd_hash;	/* Hash list */
531 	LIST_ENTRY(nfsrv_descript) nd_tq;		/* and timer list */
532 	LIST_HEAD(,nfsrv_descript) nd_coalesce;	/* coalesced writes */
533 	SIMPLEQ_ENTRY(nfsrv_descript) nd_sendq;	/* send reply list */
534 	struct mbuf		*nd_mrep;	/* Request mbuf list */
535 	struct mbuf		*nd_md;		/* Current dissect mbuf */
536 	struct mbuf		*nd_mreq;	/* Reply mbuf list */
537 	struct mbuf		*nd_nam;	/* and socket addr */
538 	struct mbuf		*nd_nam2;	/* return socket addr */
539 	void *			nd_dpos;	/* Current dissect pos */
540 	u_int32_t		nd_procnum;	/* RPC # */
541 	int			nd_stable;	/* storage type */
542 	int			nd_flag;	/* nd_flag */
543 	int			nd_len;		/* Length of this write */
544 	int			nd_repstat;	/* Reply status */
545 	u_int32_t		nd_retxid;	/* Reply xid */
546 	u_int32_t		nd_duration;	/* Lease duration */
547 	struct timeval		nd_starttime;	/* Time RPC initiated */
548 	nfsrvfh_t		nd_fh;		/* File handle */
549 	kauth_cred_t	 	nd_cr;		/* Credentials */
550 };
551 
552 /* Bits for "nd_flag" */
553 #define	ND_READ		LEASE_READ
554 #define ND_WRITE	LEASE_WRITE
555 #define ND_CHECK	0x04
556 #define ND_LEASE	(ND_READ | ND_WRITE | ND_CHECK)
557 #define ND_NFSV3	0x08
558 #define ND_KERBNICK	0x20
559 #define ND_KERBFULL	0x40
560 #define ND_KERBAUTH	(ND_KERBNICK | ND_KERBFULL)
561 
562 extern kmutex_t nfsd_lock;
563 extern kcondvar_t nfsd_initcv;
564 extern TAILQ_HEAD(nfsdhead, nfsd) nfsd_head;
565 extern SLIST_HEAD(nfsdidlehead, nfsd) nfsd_idle_head;
566 extern int nfsd_head_flag;
567 #define	NFSD_CHECKSLP	0x01
568 
569 extern struct mowner nfs_mowner;
570 extern struct nfsstats nfsstats;
571 extern int nfs_numasync;
572 
573 /*
574  * These macros compare nfsrv_descript structures.
575  */
576 #define NFSW_CONTIG(o, n) \
577 		((o)->nd_eoff >= (n)->nd_off && \
578 		 !memcmp((void *)&(o)->nd_fh, (void *)&(n)->nd_fh, NFSX_V3FH))
579 
580 /*
581  * Defines for WebNFS
582  */
583 
584 #define WEBNFS_ESC_CHAR		'%'
585 #define WEBNFS_SPECCHAR_START	0x80
586 
587 #define WEBNFS_NATIVE_CHAR	0x80
588 /*
589  * ..
590  * Possibly more here in the future.
591  */
592 
593 /*
594  * Macro for converting escape characters in WebNFS pathnames.
595  * Should really be in libkern.
596  */
597 
598 #define HEXTOC(c) \
599 	((c) >= 'a' ? ((c) - ('a' - 10)) : \
600 	    ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
601 #define HEXSTRTOI(p) \
602 	((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
603 
604 /*
605  * Structure holding information for a publicly exported filesystem
606  * (WebNFS).  Currently the specs allow just for one such filesystem.
607  */
608 struct nfs_public {
609 	int		np_valid;	/* Do we hold valid information */
610 	fhandle_t	*np_handle;	/* Filehandle for pub fs (internal) */
611 	struct mount	*np_mount;	/* Mountpoint of exported fs */
612 	char		*np_index;	/* Index file */
613 };
614 #endif	/* _KERNEL */
615 
616 #endif /* _NFS_NFS_H */
617