nfsargs.h revision 74384
1219560Savg/*
2219560Savg * Copyright (c) 1989, 1993, 1995
3219560Savg *	The Regents of the University of California.  All rights reserved.
4219560Savg *
5219560Savg * This code is derived from software contributed to Berkeley by
6219560Savg * Rick Macklem at The University of Guelph.
7219560Savg *
8219560Savg * Redistribution and use in source and binary forms, with or without
9219560Savg * modification, are permitted provided that the following conditions
10219560Savg * are met:
11219560Savg * 1. Redistributions of source code must retain the above copyright
12219560Savg *    notice, this list of conditions and the following disclaimer.
13219560Savg * 2. Redistributions in binary form must reproduce the above copyright
14232449Sjmallett *    notice, this list of conditions and the following disclaimer in the
15219560Savg *    documentation and/or other materials provided with the distribution.
16219560Savg * 3. All advertising materials mentioning features or use of this software
17219560Savg *    must display the following acknowledgement:
18219560Savg *	This product includes software developed by the University of
19219560Savg *	California, Berkeley and its contributors.
20219560Savg * 4. Neither the name of the University nor the names of its contributors
21219560Savg *    may be used to endorse or promote products derived from this software
22219560Savg *    without specific prior written permission.
23219560Savg *
24219560Savg * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25219560Savg * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26219560Savg * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27219560Savg * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28219560Savg * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29219560Savg * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30219560Savg * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31219560Savg * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32219560Savg * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33219560Savg * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34219560Savg * SUCH DAMAGE.
35219560Savg *
36219560Savg *	@(#)nfs.h	8.4 (Berkeley) 5/1/95
37219560Savg * $FreeBSD: head/sys/nfsclient/nfsargs.h 74384 2001-03-17 09:31:06Z peter $
38219560Savg */
39219560Savg
40219560Savg#ifndef _NFS_NFS_H_
41219560Savg#define _NFS_NFS_H_
42219560Savg
43219560Savg#ifdef _KERNEL
44219560Savg#include "opt_nfs.h"
45219560Savg#endif
46219560Savg
47219560Savg/*
48219560Savg * Tunable constants for nfs
49219560Savg */
50219560Savg
51219560Savg#define	NFS_MAXIOVEC	34
52219560Savg#define NFS_TICKINTVL	5		/* Desired time for a tick (msec) */
53219560Savg#define NFS_HZ		(hz / nfs_ticks) /* Ticks/sec */
54219560Savg#define	NFS_TIMEO	(1 * NFS_HZ)	/* Default timeout = 1 second */
55219560Savg#define	NFS_MINTIMEO	(1 * NFS_HZ)	/* Min timeout to use */
56219560Savg#define	NFS_MAXTIMEO	(60 * NFS_HZ)	/* Max timeout to backoff to */
57219560Savg#define	NFS_MINIDEMTIMEO (5 * NFS_HZ)	/* Min timeout for non-idempotent ops*/
58219560Savg#define	NFS_MAXREXMIT	100		/* Stop counting after this many */
59219560Savg#define	NFS_MAXWINDOW	1024		/* Max number of outstanding requests */
60219560Savg#define	NFS_RETRANS	10		/* Num of retrans for soft mounts */
61219560Savg#define	NFS_MAXGRPS	16		/* Max. size of groups list */
62219560Savg#ifndef NFS_MINATTRTIMO
63219560Savg#define	NFS_MINATTRTIMO 3		/* VREG attrib cache timeout in sec */
64219560Savg#endif
65219560Savg#ifndef NFS_MAXATTRTIMO
66219560Savg#define	NFS_MAXATTRTIMO 60
67219560Savg#endif
68219560Savg#ifndef NFS_MINDIRATTRTIMO
69219560Savg#define	NFS_MINDIRATTRTIMO 30		/* VDIR attrib cache timeout in sec */
70219560Savg#endif
71219560Savg#ifndef NFS_MAXDIRATTRTIMO
72219560Savg#define	NFS_MAXDIRATTRTIMO 60
73219560Savg#endif
74219560Savg#define	NFS_WSIZE	8192		/* Def. write data size <= 8192 */
75219560Savg#define	NFS_RSIZE	8192		/* Def. read data size <= 8192 */
76219560Savg#define NFS_READDIRSIZE	8192		/* Def. readdir size */
77219560Savg#define	NFS_DEFRAHEAD	1		/* Def. read ahead # blocks */
78219560Savg#define	NFS_MAXRAHEAD	4		/* Max. read ahead # blocks */
79219560Savg#define	NFS_MAXUIDHASH	64		/* Max. # of hashed uid entries/mp */
80219560Savg#define	NFS_MAXASYNCDAEMON 	20	/* Max. number async_daemons runnable */
81219560Savg#define NFS_MAXGATHERDELAY	100	/* Max. write gather delay (msec) */
82219560Savg#ifndef NFS_GATHERDELAY
83219560Savg#define NFS_GATHERDELAY		10	/* Default write gather delay (msec) */
84219560Savg#endif
85219560Savg#define	NFS_DIRBLKSIZ	4096		/* Must be a multiple of DIRBLKSIZ */
86219560Savg#ifdef _KERNEL
87219560Savg#define	DIRBLKSIZ	512		/* XXX we used to use ufs's DIRBLKSIZ */
88219560Savg#endif
89219560Savg
90219560Savg/*
91219560Savg * Oddballs
92219560Savg */
93219560Savg#define	NMOD(a)		((a) % nfs_asyncdaemons)
94219560Savg#define NFS_CMPFH(n, f, s) \
95219560Savg	((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
96219560Savg#define NFS_ISV3(v)	(VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
97219560Savg#define NFS_SRVMAXDATA(n) \
98219560Savg		(((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
99219560Savg		 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
100219560Savg
101219560Savg/*
102219560Savg * XXX
103219560Savg * The B_INVAFTERWRITE flag should be set to whatever is required by the
104219560Savg * buffer cache code to say "Invalidate the block after it is written back".
105219560Savg */
106219560Savg#define	B_INVAFTERWRITE	B_NOCACHE
107219560Savg
108219560Savg/*
109219560Savg * The IO_METASYNC flag should be implemented for local file systems.
110219560Savg * (Until then, it is nothin at all.)
111219560Savg */
112219560Savg#ifndef IO_METASYNC
113219560Savg#define IO_METASYNC	0
114219560Savg#endif
115219560Savg
116219560Savg/*
117219560Savg * Arguments to mount NFS
118219560Savg */
119219560Savg#define NFS_ARGSVERSION	3		/* change when nfs_args changes */
120219560Savgstruct nfs_args {
121219560Savg	int		version;	/* args structure version number */
122219560Savg	struct sockaddr	*addr;		/* file server address */
123219560Savg	int		addrlen;	/* length of address */
124219560Savg	int		sotype;		/* Socket type */
125219560Savg	int		proto;		/* and Protocol */
126219560Savg	u_char		*fh;		/* File handle to be mounted */
127219560Savg	int		fhsize;		/* Size, in bytes, of fh */
128219560Savg	int		flags;		/* flags */
129219560Savg	int		wsize;		/* write size in bytes */
130219560Savg	int		rsize;		/* read size in bytes */
131219560Savg	int		readdirsize;	/* readdir size in bytes */
132219560Savg	int		timeo;		/* initial timeout in .1 secs */
133219560Savg	int		retrans;	/* times to retry send */
134219560Savg	int		maxgrouplist;	/* Max. size of group list */
135219560Savg	int		readahead;	/* # of blocks to readahead */
136219560Savg	int		leaseterm;	/* Term (sec) of lease */
137219560Savg	int		deadthresh;	/* Retrans threshold */
138219560Savg	char		*hostname;	/* server's name */
139219560Savg	int		acregmin;	/* cache attrs for reg files min time */
140219560Savg	int		acregmax;	/* cache attrs for reg files max time */
141219560Savg	int		acdirmin;	/* cache attrs for dirs min time */
142219560Savg	int		acdirmax;	/* cache attrs for dirs max time */
143219560Savg};
144219560Savg
145219560Savg/*
146219560Savg * NFS mount option flags
147219560Savg */
148219560Savg#define	NFSMNT_SOFT		0x00000001  /* soft mount (hard is default) */
149219560Savg#define	NFSMNT_WSIZE		0x00000002  /* set write size */
150219560Savg#define	NFSMNT_RSIZE		0x00000004  /* set read size */
151219560Savg#define	NFSMNT_TIMEO		0x00000008  /* set initial timeout */
152219560Savg#define	NFSMNT_RETRANS		0x00000010  /* set number of request retries */
153219560Savg#define	NFSMNT_MAXGRPS		0x00000020  /* set maximum grouplist size */
154219560Savg#define	NFSMNT_INT		0x00000040  /* allow interrupts on hard mount */
155219560Savg#define	NFSMNT_NOCONN		0x00000080  /* Don't Connect the socket */
156219560Savg#define	NFSMNT_NQNFS		0x00000100  /* Use Nqnfs protocol */
157219560Savg#define	NFSMNT_NFSV3		0x00000200  /* Use NFS Version 3 protocol */
158219560Savg#define	NFSMNT_KERB		0x00000400  /* Use Kerberos authentication */
159219560Savg#define	NFSMNT_DUMBTIMR		0x00000800  /* Don't estimate rtt dynamically */
160219560Savg#define	NFSMNT_LEASETERM	0x00001000  /* set lease term (nqnfs) */
161219560Savg#define	NFSMNT_READAHEAD	0x00002000  /* set read ahead */
162219560Savg#define	NFSMNT_DEADTHRESH	0x00004000  /* set dead server retry thresh */
163219560Savg#define	NFSMNT_RESVPORT		0x00008000  /* Allocate a reserved port */
164219560Savg#define	NFSMNT_RDIRPLUS		0x00010000  /* Use Readdirplus for V3 */
165219560Savg#define	NFSMNT_READDIRSIZE	0x00020000  /* Set readdir size */
166219560Savg#define	NFSMNT_ACREGMIN		0x00040000
167219560Savg#define	NFSMNT_ACREGMAX		0x00080000
168219560Savg#define	NFSMNT_ACDIRMIN		0x00100000
169219560Savg#define	NFSMNT_ACDIRMAX		0x00200000
170219560Savg
171219560Savg#define NFSSTA_HASWRITEVERF	0x00040000  /* Has write verifier for V3 */
172219560Savg#define NFSSTA_GOTPATHCONF	0x00080000  /* Got the V3 pathconf info */
173219560Savg#define NFSSTA_GOTFSINFO	0x00100000  /* Got the V3 fsinfo */
174219560Savg#define	NFSSTA_MNTD		0x00200000  /* Mnt server for mnt point */
175219560Savg#define	NFSSTA_DISMINPROG	0x00400000  /* Dismount in progress */
176219560Savg#define	NFSSTA_DISMNT		0x00800000  /* Dismounted */
177219560Savg#define	NFSSTA_SNDLOCK		0x01000000  /* Send socket lock */
178219560Savg#define	NFSSTA_WANTSND		0x02000000  /* Want above */
179219560Savg#define	NFSSTA_RCVLOCK		0x04000000  /* Rcv socket lock */
180219560Savg#define	NFSSTA_WANTRCV		0x08000000  /* Want above */
181219560Savg#define	NFSSTA_WAITAUTH		0x10000000  /* Wait for authentication */
182219560Savg#define	NFSSTA_HASAUTH		0x20000000  /* Has authenticator */
183219560Savg#define	NFSSTA_WANTAUTH		0x40000000  /* Wants an authenticator */
184219560Savg#define	NFSSTA_AUTHERR		0x80000000  /* Authentication error */
185219560Savg
186219560Savg/*
187219560Savg * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
188219560Savg * should ever try and use it.
189219560Savg */
190219560Savgstruct nfsd_args {
191219560Savg	int	sock;		/* Socket to serve */
192219560Savg	caddr_t	name;		/* Client addr for connection based sockets */
193219560Savg	int	namelen;	/* Length of name */
194219560Savg};
195219560Savg
196219560Savgstruct nfsd_srvargs {
197219560Savg	struct nfsd	*nsd_nfsd;	/* Pointer to in kernel nfsd struct */
198219560Savg	uid_t		nsd_uid;	/* Effective uid mapped to cred */
199219560Savg	u_int32_t	nsd_haddr;	/* Ip address of client */
200219560Savg	struct xucred	nsd_cr;		/* Cred. uid maps to */
201219560Savg	int		nsd_authlen;	/* Length of auth string (ret) */
202219560Savg	u_char		*nsd_authstr;	/* Auth string (ret) */
203219560Savg	int		nsd_verflen;	/* and the verfier */
204219560Savg	u_char		*nsd_verfstr;
205219560Savg	struct timeval	nsd_timestamp;	/* timestamp from verifier */
206219560Savg	u_int32_t	nsd_ttl;	/* credential ttl (sec) */
207219560Savg	NFSKERBKEY_T	nsd_key;	/* Session key */
208219560Savg};
209219560Savg
210219560Savgstruct nfsd_cargs {
211219560Savg	char		*ncd_dirp;	/* Mount dir path */
212236027Sed	uid_t		ncd_authuid;	/* Effective uid */
213236027Sed	int		ncd_authtype;	/* Type of authenticator */
214219560Savg	int		ncd_authlen;	/* Length of authenticator string */
215236027Sed	u_char		*ncd_authstr;	/* Authenticator string */
216236027Sed	int		ncd_verflen;	/* and the verifier */
217219560Savg	u_char		*ncd_verfstr;
218219560Savg	NFSKERBKEY_T	ncd_key;	/* Session key */
219219560Savg};
220219560Savg
221219560Savg/*
222219560Savg * XXX to allow amd to include nfs.h without nfsproto.h
223219560Savg */
224219560Savg#ifdef NFS_NPROCS
225219560Savg/*
226219560Savg * Stats structure
227219560Savg */
228219560Savgstruct nfsstats {
229219560Savg	int	attrcache_hits;
230219560Savg	int	attrcache_misses;
231219560Savg	int	lookupcache_hits;
232219560Savg	int	lookupcache_misses;
233219560Savg	int	direofcache_hits;
234219560Savg	int	direofcache_misses;
235219560Savg	int	biocache_reads;
236219560Savg	int	read_bios;
237219560Savg	int	read_physios;
238219560Savg	int	biocache_writes;
239219560Savg	int	write_bios;
240219560Savg	int	write_physios;
241219560Savg	int	biocache_readlinks;
242219560Savg	int	readlink_bios;
243219560Savg	int	biocache_readdirs;
244219560Savg	int	readdir_bios;
245219560Savg	int	rpccnt[NFS_NPROCS];
246219560Savg	int	rpcretries;
247219560Savg	int	srvrpccnt[NFS_NPROCS];
248219560Savg	int	srvrpc_errs;
249219560Savg	int	srv_errs;
250219560Savg	int	rpcrequests;
251227692Sed	int	rpctimeouts;
252219560Savg	int	rpcunexpected;
253219560Savg	int	rpcinvalid;
254219560Savg	int	srvcache_inproghits;
255219560Savg	int	srvcache_idemdonehits;
256219560Savg	int	srvcache_nonidemdonehits;
257219560Savg	int	srvcache_misses;
258248598Spjd	int	srvnqnfs_leases;
259248598Spjd	int	srvnqnfs_maxleases;
260219560Savg	int	srvnqnfs_getleases;
261219560Savg	int	srvvop_writes;
262219560Savg	int	accesscache_hits;
263219560Savg	int	accesscache_misses;
264219560Savg};
265219560Savg#endif
266219560Savg
267248598Spjd/*
268219560Savg * Flags for nfssvc() system call.
269219560Savg */
270219560Savg#define	NFSSVC_BIOD	0x002
271219560Savg#define	NFSSVC_NFSD	0x004
272219560Savg#define	NFSSVC_ADDSOCK	0x008
273219560Savg#define	NFSSVC_AUTHIN	0x010
274219560Savg#define	NFSSVC_GOTAUTH	0x040
275219560Savg#define	NFSSVC_AUTHINFAIL 0x080
276219560Savg#define	NFSSVC_MNTD	0x100
277219560Savg
278219560Savg/*
279219560Savg * fs.nfs sysctl(3) identifiers
280219560Savg */
281219560Savg#define NFS_NFSSTATS	1		/* struct: struct nfsstats */
282219560Savg#define NFS_NFSPRIVPORT	2		/* int: prohibit nfs to resvports */
283219560Savg
284219560Savg#define FS_NFS_NAMES { \
285219560Savg		       { 0, 0 }, \
286219560Savg		       { "nfsstats", CTLTYPE_STRUCT }, \
287219560Savg		       { "nfsprivport", CTLTYPE_INT }, \
288219560Savg}
289219560Savg
290219560Savg#ifdef _KERNEL
291219560Savg
292219560Savg#ifdef MALLOC_DECLARE
293219560SavgMALLOC_DECLARE(M_NFSREQ);
294219560SavgMALLOC_DECLARE(M_NFSDIROFF);
295219560SavgMALLOC_DECLARE(M_NFSRVDESC);
296219560SavgMALLOC_DECLARE(M_NFSUID);
297219560SavgMALLOC_DECLARE(M_NQLEASE);
298219560SavgMALLOC_DECLARE(M_NFSD);
299219560SavgMALLOC_DECLARE(M_NFSBIGFH);
300219560SavgMALLOC_DECLARE(M_NFSHASH);
301219560Savg#endif
302219560Savg
303219560Savg#ifdef ZONE_INTERRUPT
304219560Savgextern vm_zone_t nfsmount_zone;
305219560Savg#endif
306219560Savg
307219560Savgextern struct callout_handle nfs_timer_handle;
308219560Savg
309219560Savgstruct uio; struct buf; struct vattr; struct nameidata;	/* XXX */
310219560Savg
311219560Savg/*
312219560Savg * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
313219560Savg * What should be in this set is open to debate, but I believe that since
314219560Savg * I/O system calls on ufs are never interrupted by signals the set should
315219560Savg * be minimal. My reasoning is that many current programs that use signals
316219560Savg * such as SIGALRM will not expect file I/O system calls to be interrupted
317219560Savg * by them and break.
318219560Savg */
319219560Savg#define	NFSINT_SIGMASK(set) 						\
320219560Savg	(SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||	\
321219560Savg	 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||	\
322219560Savg	 SIGISMEMBER(set, SIGQUIT))
323219560Savg
324219560Savg/*
325219560Savg * Socket errors ignored for connectionless sockets??
326219560Savg * For now, ignore them all
327219560Savg */
328219560Savg#define	NFSIGNORE_SOERROR(s, e) \
329219560Savg		((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
330219560Savg		((s) & PR_CONNREQUIRED) == 0)
331219560Savg
332219560Savg/*
333219560Savg * Nfs outstanding request list element
334219560Savg */
335219560Savgstruct nfsreq {
336219560Savg	TAILQ_ENTRY(nfsreq) r_chain;
337219560Savg	struct mbuf	*r_mreq;
338219560Savg	struct mbuf	*r_mrep;
339219560Savg	struct mbuf	*r_md;
340219560Savg	caddr_t		r_dpos;
341219560Savg	struct nfsmount *r_nmp;
342219560Savg	struct vnode	*r_vp;
343219560Savg	u_int32_t	r_xid;
344219560Savg	int		r_flags;	/* flags on request, see below */
345219560Savg	int		r_retry;	/* max retransmission count */
346219560Savg	int		r_rexmit;	/* current retrans count */
347219560Savg	int		r_timer;	/* tick counter on reply */
348219560Savg	u_int32_t	r_procnum;	/* NFS procedure number */
349219560Savg	int		r_rtt;		/* RTT for rpc */
350219560Savg	struct proc	*r_procp;	/* Proc that did I/O system call */
351219560Savg};
352219560Savg
353219560Savg/*
354219560Savg * Queue head for nfsreq's
355219560Savg */
356219560Savgextern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq;
357219560Savg
358219560Savg/* Flag values for r_flags */
359219560Savg#define R_TIMING	0x01		/* timing request (in mntp) */
360219560Savg#define R_SENT		0x02		/* request has been sent */
361219560Savg#define	R_SOFTTERM	0x04		/* soft mnt, too many retries */
362219560Savg#define	R_INTR		0x08		/* intr mnt, signal pending */
363219560Savg#define	R_SOCKERR	0x10		/* Fatal error on socket */
364219560Savg#define	R_TPRINTFMSG	0x20		/* Did a tprintf msg. */
365219560Savg#define	R_MUSTRESEND	0x40		/* Must resend request */
366219560Savg#define	R_GETONEREP	0x80		/* Probe for one reply only */
367219560Savg
368219560Savg/*
369219560Savg * A list of nfssvc_sock structures is maintained with all the sockets
370219560Savg * that require service by the nfsd.
371219560Savg * The nfsuid structs hang off of the nfssvc_sock structs in both lru
372219560Savg * and uid hash lists.
373219560Savg */
374219560Savg#ifndef NFS_UIDHASHSIZ
375219560Savg#define	NFS_UIDHASHSIZ	29	/* Tune the size of nfssvc_sock with this */
376219560Savg#endif
377219560Savg#define	NUIDHASH(sock, uid) \
378219560Savg	(&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
379219560Savg#ifndef NFS_WDELAYHASHSIZ
380219560Savg#define	NFS_WDELAYHASHSIZ 16	/* and with this */
381219560Savg#endif
382219560Savg#define	NWDELAYHASH(sock, f) \
383219560Savg	(&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
384219560Savg#ifndef NFS_MUIDHASHSIZ
385219560Savg#define NFS_MUIDHASHSIZ	63	/* Tune the size of nfsmount with this */
386219560Savg#endif
387219560Savg#define	NMUIDHASH(nmp, uid) \
388219560Savg	(&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
389219560Savg#define	NFSNOHASH(fhsum) \
390219560Savg	(&nfsnodehashtbl[(fhsum) & nfsnodehash])
391219560Savg
392219560Savg/*
393219560Savg * Network address hash list element
394219560Savg */
395219560Savgunion nethostaddr {
396219560Savg	u_int32_t had_inetaddr;
397219560Savg	struct sockaddr *had_nam;
398219560Savg};
399219560Savg
400219560Savgstruct nfsuid {
401219560Savg	TAILQ_ENTRY(nfsuid) nu_lru;	/* LRU chain */
402219560Savg	LIST_ENTRY(nfsuid) nu_hash;	/* Hash list */
403219560Savg	int		nu_flag;	/* Flags */
404219560Savg	union nethostaddr nu_haddr;	/* Host addr. for dgram sockets */
405236027Sed	struct ucred	nu_cr;		/* Cred uid mapped to */
406236027Sed	int		nu_expire;	/* Expiry time (sec) */
407219560Savg	struct timeval	nu_timestamp;	/* Kerb. timestamp */
408219560Savg	u_int32_t	nu_nickname;	/* Nickname on server */
409219560Savg	NFSKERBKEY_T	nu_key;		/* and session key */
410219560Savg};
411219560Savg
412219560Savg#define	nu_inetaddr	nu_haddr.had_inetaddr
413219560Savg#define	nu_nam		nu_haddr.had_nam
414219560Savg/* Bits for nu_flag */
415219560Savg#define	NU_INETADDR	0x1
416219560Savg#define NU_NAM		0x2
417219560Savg#define NU_NETFAM(u)	(((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
418219560Savg
419219560Savgstruct nfsrv_rec {
420219560Savg	STAILQ_ENTRY(nfsrv_rec) nr_link;
421219560Savg	struct sockaddr	*nr_address;
422219560Savg	struct mbuf	*nr_packet;
423219560Savg};
424219560Savg
425219560Savgstruct nfssvc_sock {
426219560Savg	TAILQ_ENTRY(nfssvc_sock) ns_chain;	/* List of all nfssvc_sock's */
427219560Savg	TAILQ_HEAD(, nfsuid) ns_uidlruhead;
428219560Savg	struct file	*ns_fp;
429219560Savg	struct socket	*ns_so;
430219560Savg	struct sockaddr	*ns_nam;
431219560Savg	struct mbuf	*ns_raw;
432219560Savg	struct mbuf	*ns_rawend;
433219560Savg	STAILQ_HEAD(, nfsrv_rec) ns_rec;
434219560Savg	struct mbuf	*ns_frag;
435219560Savg	int		ns_flag;
436219560Savg	int		ns_solock;
437219560Savg	int		ns_cc;
438219560Savg	int		ns_reclen;
439219560Savg	int		ns_numuids;
440219560Savg	u_int32_t	ns_sref;
441219560Savg	LIST_HEAD(, nfsrv_descript) ns_tq;	/* Write gather lists */
442219560Savg	LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
443219560Savg	LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
444219560Savg};
445219560Savg
446219560Savg/* Bits for "ns_flag" */
447219560Savg#define	SLP_VALID	0x01
448219560Savg#define	SLP_DOREC	0x02
449219560Savg#define	SLP_NEEDQ	0x04
450219560Savg#define	SLP_DISCONN	0x08
451219560Savg#define	SLP_GETSTREAM	0x10
452219560Savg#define	SLP_LASTFRAG	0x20
453219560Savg#define SLP_ALLFLAGS	0xff
454219560Savg
455219560Savgextern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
456219560Savgextern int nfssvc_sockhead_flag;
457219560Savg#define	SLP_INIT	0x01
458219560Savg#define	SLP_WANTINIT	0x02
459219560Savg
460219560Savg/*
461219560Savg * One of these structures is allocated for each nfsd.
462219560Savg */
463219560Savgstruct nfsd {
464219560Savg	TAILQ_ENTRY(nfsd) nfsd_chain;	/* List of all nfsd's */
465219560Savg	int		nfsd_flag;	/* NFSD_ flags */
466219560Savg	struct nfssvc_sock *nfsd_slp;	/* Current socket */
467226349Smarcel	int		nfsd_authlen;	/* Authenticator len */
468219560Savg	u_char		nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
469226349Smarcel	int		nfsd_verflen;	/* and the Verifier */
470219560Savg	u_char		nfsd_verfstr[RPCVERF_MAXSIZ];
471219560Savg	struct proc	*nfsd_procp;	/* Proc ptr */
472219560Savg	struct nfsrv_descript *nfsd_nd;	/* Associated nfsrv_descript */
473219560Savg};
474219560Savg
475219560Savg/* Bits for "nfsd_flag" */
476219560Savg#define	NFSD_WAITING	0x01
477219560Savg#define	NFSD_REQINPROG	0x02
478219560Savg#define	NFSD_NEEDAUTH	0x04
479219560Savg#define	NFSD_AUTHFAIL	0x08
480219560Savg
481219560Savg/*
482219560Savg * This structure is used by the server for describing each request.
483219560Savg * Some fields are used only when write request gathering is performed.
484219560Savg */
485219560Savgstruct nfsrv_descript {
486219560Savg	u_quad_t		nd_time;	/* Write deadline (usec) */
487219560Savg	off_t			nd_off;		/* Start byte offset */
488219560Savg	off_t			nd_eoff;	/* and end byte offset */
489219560Savg	LIST_ENTRY(nfsrv_descript) nd_hash;	/* Hash list */
490219560Savg	LIST_ENTRY(nfsrv_descript) nd_tq;		/* and timer list */
491219560Savg	LIST_HEAD(,nfsrv_descript) nd_coalesce;	/* coalesced writes */
492219560Savg	struct mbuf		*nd_mrep;	/* Request mbuf list */
493219560Savg	struct mbuf		*nd_md;		/* Current dissect mbuf */
494219560Savg	struct mbuf		*nd_mreq;	/* Reply mbuf list */
495219560Savg	struct sockaddr		*nd_nam;	/* and socket addr */
496219560Savg	struct sockaddr		*nd_nam2;	/* return socket addr */
497219560Savg	caddr_t			nd_dpos;	/* Current dissect pos */
498219560Savg	u_int32_t		nd_procnum;	/* RPC # */
499219560Savg	int			nd_stable;	/* storage type */
500219560Savg	int			nd_flag;	/* nd_flag */
501219560Savg	int			nd_len;		/* Length of this write */
502219560Savg	int			nd_repstat;	/* Reply status */
503219560Savg	u_int32_t		nd_retxid;	/* Reply xid */
504219560Savg	u_int32_t		nd_duration;	/* Lease duration */
505219560Savg	struct timeval		nd_starttime;	/* Time RPC initiated */
506219560Savg	fhandle_t		nd_fh;		/* File handle */
507219560Savg	struct ucred		nd_cr;		/* Credentials */
508219560Savg};
509219560Savg
510219560Savg/* Bits for "nd_flag" */
511219560Savg#define	ND_READ		LEASE_READ
512219560Savg#define ND_WRITE	LEASE_WRITE
513219560Savg#define ND_CHECK	0x04
514219560Savg#define ND_LEASE	(ND_READ | ND_WRITE | ND_CHECK)
515219560Savg#define ND_NFSV3	0x08
516219560Savg#define ND_NQNFS	0x10
517219560Savg#define ND_KERBNICK	0x20
518219560Savg#define ND_KERBFULL	0x40
519219560Savg#define ND_KERBAUTH	(ND_KERBNICK | ND_KERBFULL)
520219560Savg
521219560Savgextern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
522219560Savgextern int nfsd_head_flag;
523219560Savg#define	NFSD_CHECKSLP	0x01
524219560Savg
525219560Savg/*
526219560Savg * These macros compare nfsrv_descript structures.
527219560Savg */
528219560Savg#define NFSW_CONTIG(o, n) \
529219560Savg		((o)->nd_eoff >= (n)->nd_off && \
530219560Savg		 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
531219560Savg
532219560Savg#define NFSW_SAMECRED(o, n) \
533219560Savg	(((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \
534219560Savg 	 !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
535219560Savg		sizeof (struct ucred)))
536219560Savg
537219560Savg/*
538219560Savg * Defines for WebNFS
539219560Savg */
540219560Savg
541219560Savg#define WEBNFS_ESC_CHAR		'%'
542219560Savg#define WEBNFS_SPECCHAR_START	0x80
543219560Savg
544219560Savg#define WEBNFS_NATIVE_CHAR	0x80
545219560Savg/*
546219560Savg * ..
547219560Savg * Possibly more here in the future.
548219560Savg */
549219560Savg
550219560Savg/*
551219560Savg * Macro for converting escape characters in WebNFS pathnames.
552219560Savg * Should really be in libkern.
553219560Savg */
554219560Savg
555219560Savg#define HEXTOC(c) \
556219560Savg	((c) >= 'a' ? ((c) - ('a' - 10)) : \
557219560Savg	    ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
558219560Savg#define HEXSTRTOI(p) \
559219560Savg	((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
560219560Savg
561219560Savg#ifdef NFS_DEBUG
562219560Savg
563219560Savgextern int nfs_debug;
564219560Savg#define NFS_DEBUG_ASYNCIO	1 /* asynchronous i/o */
565219560Savg#define NFS_DEBUG_WG		2 /* server write gathering */
566219560Savg#define NFS_DEBUG_RC		4 /* server request caching */
567219560Savg
568219560Savg#define NFS_DPF(cat, args)					\
569219560Savg	do {							\
570219560Savg		if (nfs_debug & NFS_DEBUG_##cat) printf args;	\
571219560Savg	} while (0)
572219560Savg
573219560Savg#else
574219560Savg
575219560Savg#define NFS_DPF(cat, args)
576219560Savg
577219560Savg#endif
578219560Savg
579219560Savgu_quad_t nfs_curusec __P((void));
580219560Savgint	nfs_init __P((struct vfsconf *vfsp));
581219560Savgint	nfs_uninit __P((struct vfsconf *vfsp));
582219560Savgint	nfs_reply __P((struct nfsreq *));
583219560Savgint	nfs_getreq __P((struct nfsrv_descript *,struct nfsd *,int));
584219560Savgint	nfs_send __P((struct socket *, struct sockaddr *, struct mbuf *,
585219560Savg		      struct nfsreq *));
586219560Savgint	nfs_rephead __P((int, struct nfsrv_descript *, struct nfssvc_sock *,
587219560Savg			 int, int, u_quad_t *, struct mbuf **, struct mbuf **,
588219560Savg			 caddr_t *));
589219560Savgint	nfs_sndlock __P((struct nfsreq *));
590219560Savgvoid	nfs_sndunlock __P((struct nfsreq *));
591219560Savgint	nfs_slplock __P((struct nfssvc_sock *, int));
592219560Savgvoid	nfs_slpunlock __P((struct nfssvc_sock *));
593219560Savgint	nfs_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
594219560Savgint	nfs_vinvalbuf __P((struct vnode *, int, struct ucred *, struct proc *,
595219560Savg			   int));
596219560Savgint	nfs_readrpc __P((struct vnode *, struct uio *, struct ucred *));
597219560Savgint	nfs_writerpc __P((struct vnode *, struct uio *, struct ucred *, int *,
598219560Savg			  int *));
599219560Savgint	nfs_commit __P((struct vnode *vp, u_quad_t offset, int cnt,
600219560Savg			struct ucred *cred, struct proc *procp));
601219560Savgint	nfs_readdirrpc __P((struct vnode *, struct uio *, struct ucred *));
602219560Savgint	nfs_asyncio __P((struct buf *, struct ucred *, struct proc *));
603219560Savgint	nfs_doio __P((struct buf *, struct ucred *, struct proc *));
604219560Savgint	nfs_readlinkrpc __P((struct vnode *, struct uio *, struct ucred *));
605219560Savgint	nfs_sigintr __P((struct nfsmount *, struct nfsreq *, struct proc *));
606219560Savgint	nfs_readdirplusrpc __P((struct vnode *, struct uio *, struct ucred *));
607219560Savgint	nfsm_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
608219560Savgvoid	nfsm_srvfattr __P((struct nfsrv_descript *, struct vattr *,
609219560Savg			   struct nfs_fattr *));
610219560Savgvoid	nfsm_srvwcc __P((struct nfsrv_descript *, int, struct vattr *, int,
611219560Savg			 struct vattr *, struct mbuf **, char **));
612219560Savgvoid	nfsm_srvpostopattr __P((struct nfsrv_descript *, int, struct vattr *,
613219560Savg				struct mbuf **, char **));
614219560Savgint	netaddr_match __P((int, union nethostaddr *, struct sockaddr *));
615219560Savgint	nfs_request __P((struct vnode *, struct mbuf *, int, struct proc *,
616219560Savg			 struct ucred *, struct mbuf **, struct mbuf **,
617219560Savg			 caddr_t *));
618219560Savgint	nfs_loadattrcache __P((struct vnode **, struct mbuf **, caddr_t *,
619219560Savg			       struct vattr *, int));
620219560Savgint	nfs_namei __P((struct nameidata *, fhandle_t *, int,
621219560Savg		       struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
622219560Savg		       caddr_t *, struct vnode **, struct proc *, int, int));
623219560Savgvoid	nfsm_adj __P((struct mbuf *, int, int));
624219560Savgint	nfsm_mbuftouio __P((struct mbuf **, struct uio *, int, caddr_t *));
625219560Savgvoid	nfsrv_initcache __P((void));
626219560Savgint	nfs_getauth __P((struct nfsmount *, struct nfsreq *, struct ucred *,
627219560Savg			 char **, int *, char *, int *, NFSKERBKEY_T));
628219560Savgint	nfs_getnickauth __P((struct nfsmount *, struct ucred *, char **,
629219560Savg			     int *, char *, int));
630219560Savgint	nfs_savenickauth __P((struct nfsmount *, struct ucred *, int,
631219560Savg			      NFSKERBKEY_T, struct mbuf **, char **,
632219560Savg			      struct mbuf *));
633219560Savgint	nfs_adv __P((struct mbuf **, caddr_t *, int, int));
634219560Savgvoid	nfs_nhinit __P((void));
635219560Savgvoid	nfs_timer __P((void*));
636219560Savgint	nfsrv_dorec __P((struct nfssvc_sock *, struct nfsd *,
637219560Savg			 struct nfsrv_descript **));
638219560Savgint	nfsrv_getcache __P((struct nfsrv_descript *, struct nfssvc_sock *,
639219560Savg			    struct mbuf **));
640219560Savgvoid	nfsrv_updatecache __P((struct nfsrv_descript *, int, struct mbuf *));
641219560Savgvoid	nfsrv_cleancache __P((void));
642219560Savgint	nfs_connect __P((struct nfsmount *, struct nfsreq *));
643219560Savgvoid	nfs_disconnect __P((struct nfsmount *));
644219560Savgvoid	nfs_safedisconnect __P((struct nfsmount *));
645219560Savgint	nfs_getattrcache __P((struct vnode *, struct vattr *));
646219560Savgint	nfsm_strtmbuf __P((struct mbuf **, char **, const char *, long));
647219560Savgint	nfs_bioread __P((struct vnode *, struct uio *, int, struct ucred *));
648219560Savgint	nfsm_uiotombuf __P((struct uio *, struct mbuf **, int, caddr_t *));
649219560Savgvoid	nfsrv_init __P((int));
650219560Savgvoid	nfs_clearcommit __P((struct mount *));
651219560Savgint	nfsrv_errmap __P((struct nfsrv_descript *, int));
652219560Savgvoid	nfsrvw_sort __P((gid_t *, int));
653219560Savgvoid	nfsrv_setcred __P((struct ucred *, struct ucred *));
654219560Savgint	nfs_writebp __P((struct buf *, int, struct proc *));
655219560Savgint	nfsrv_object_create __P((struct vnode *));
656219560Savgvoid	nfsrv_wakenfsd __P((struct nfssvc_sock *slp));
657219560Savgint	nfsrv_writegather __P((struct nfsrv_descript **, struct nfssvc_sock *,
658219560Savg			       struct proc *, struct mbuf **));
659219560Savgint	nfs_fsinfo __P((struct nfsmount *, struct vnode *, struct ucred *,
660219560Savg			struct proc *p));
661219560Savg
662219560Savgint	nfsrv3_access __P((struct nfsrv_descript *nfsd,
663219560Savg			   struct nfssvc_sock *slp,
664219560Savg			   struct proc *procp, struct mbuf **mrq));
665219560Savgint	nfsrv_commit __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
666219560Savg			  struct proc *procp, struct mbuf **mrq));
667219560Savgint	nfsrv_create __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
668219560Savg			  struct proc *procp, struct mbuf **mrq));
669219560Savgint	nfsrv_fhtovp __P((fhandle_t *, int, struct vnode **, struct ucred *,
670219560Savg			  struct nfssvc_sock *, struct sockaddr *, int *,
671219560Savg			  int, int));
672219560Savgint	nfsrv_setpublicfs __P((struct mount *, struct netexport *,
673219560Savg			       struct export_args *));
674219560Savgint	nfs_ispublicfh __P((fhandle_t *));
675219560Savgint	nfsrv_fsinfo __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
676219560Savg			  struct proc *procp, struct mbuf **mrq));
677219560Savgint	nfsrv_getattr __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
678219560Savg			   struct proc *procp, struct mbuf **mrq));
679219560Savgint	nfsrv_link __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
680219560Savg			struct proc *procp, struct mbuf **mrq));
681219560Savgint	nfsrv_lookup __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
682219560Savg			  struct proc *procp, struct mbuf **mrq));
683219560Savgint	nfsrv_mkdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
684219560Savg			 struct proc *procp, struct mbuf **mrq));
685219560Savgint	nfsrv_mknod __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
686219560Savg			 struct proc *procp, struct mbuf **mrq));
687219560Savgint	nfsrv_noop __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
688219560Savg			struct proc *procp, struct mbuf **mrq));
689219560Savgint	nfsrv_null __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
690219560Savg			struct proc *procp, struct mbuf **mrq));
691219560Savgint	nfsrv_pathconf __P((struct nfsrv_descript *nfsd,
692219560Savg			    struct nfssvc_sock *slp, struct proc *procp,
693219560Savg			    struct mbuf **mrq));
694219560Savgint	nfsrv_read __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
695219560Savg			struct proc *procp, struct mbuf **mrq));
696219560Savgint	nfsrv_readdir __P((struct nfsrv_descript *nfsd,
697219560Savg			   struct nfssvc_sock *slp,
698219560Savg			   struct proc *procp, struct mbuf **mrq));
699219560Savgint	nfsrv_readdirplus __P((struct nfsrv_descript *nfsd,
700219560Savg			       struct nfssvc_sock *slp, struct proc *procp,
701219560Savg			       struct mbuf **mrq));
702219560Savgint	nfsrv_readlink __P((struct nfsrv_descript *nfsd,
703219560Savg			    struct nfssvc_sock *slp, struct proc *procp,
704219560Savg			    struct mbuf **mrq));
705219560Savgint	nfsrv_remove __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
706219560Savg			  struct proc *procp, struct mbuf **mrq));
707219560Savgint	nfsrv_rename __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
708219560Savg			  struct proc *procp, struct mbuf **mrq));
709219560Savgint	nfsrv_rmdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
710219560Savg			 struct proc *procp, struct mbuf **mrq));
711219560Savgint	nfsrv_setattr __P((struct nfsrv_descript *nfsd,
712219560Savg			   struct nfssvc_sock *slp,
713219560Savg			   struct proc *procp, struct mbuf **mrq));
714219560Savgint	nfsrv_statfs __P((struct nfsrv_descript *nfsd,
715219560Savg			  struct nfssvc_sock *slp,
716219560Savg			  struct proc *procp, struct mbuf **mrq));
717219560Savgint	nfsrv_symlink __P((struct nfsrv_descript *nfsd,
718219560Savg			   struct nfssvc_sock *slp,
719219560Savg			   struct proc *procp, struct mbuf **mrq));
720219560Savgint	nfsrv_write __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
721219560Savg			 struct proc *procp, struct mbuf **mrq));
722219560Savgvoid	nfsrv_rcv __P((struct socket *so, void *arg, int waitflag));
723219560Savgvoid	nfsrv_slpderef __P((struct nfssvc_sock *slp));
724219560Savg#endif	/* _KERNEL */
725219560Savg
726219560Savg#endif
727219560Savg