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