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