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