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