nfsargs.h revision 51791
1/*
2 * Copyright (c) 1989, 1993, 1995
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by the University of
19 *	California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 *    may be used to endorse or promote products derived from this software
22 *    without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 *	@(#)nfs.h	8.4 (Berkeley) 5/1/95
37 * $FreeBSD: head/sys/nfsclient/nfsargs.h 51791 1999-09-29 15:03:48Z marcel $
38 */
39
40#ifndef _NFS_NFS_H_
41#define _NFS_NFS_H_
42
43#ifdef KERNEL
44#include "opt_nfs.h"
45#endif
46
47/*
48 * Tunable constants for nfs
49 */
50
51#define	NFS_MAXIOVEC	34
52#define NFS_TICKINTVL	5		/* Desired time for a tick (msec) */
53#define NFS_HZ		(hz / nfs_ticks) /* Ticks/sec */
54#define	NFS_TIMEO	(1 * NFS_HZ)	/* Default timeout = 1 second */
55#define	NFS_MINTIMEO	(1 * NFS_HZ)	/* Min timeout to use */
56#define	NFS_MAXTIMEO	(60 * NFS_HZ)	/* Max timeout to backoff to */
57#define	NFS_MINIDEMTIMEO (5 * NFS_HZ)	/* Min timeout for non-idempotent ops*/
58#define	NFS_MAXREXMIT	100		/* Stop counting after this many */
59#define	NFS_MAXWINDOW	1024		/* Max number of outstanding requests */
60#define	NFS_RETRANS	10		/* Num of retrans for soft mounts */
61#define	NFS_MAXGRPS	16		/* Max. size of groups list */
62#ifndef NFS_MINATTRTIMO
63#define	NFS_MINATTRTIMO 3		/* VREG attrib cache timeout in sec */
64#endif
65#ifndef NFS_MAXATTRTIMO
66#define	NFS_MAXATTRTIMO 60
67#endif
68#ifndef NFS_MINDIRATTRTIMO
69#define	NFS_MINDIRATTRTIMO 30		/* VDIR attrib cache timeout in sec */
70#endif
71#ifndef NFS_MAXDIRATTRTIMO
72#define	NFS_MAXDIRATTRTIMO 60
73#endif
74#define	NFS_WSIZE	8192		/* Def. write data size <= 8192 */
75#define	NFS_RSIZE	8192		/* Def. read data size <= 8192 */
76#define NFS_READDIRSIZE	8192		/* Def. readdir size */
77#define	NFS_DEFRAHEAD	1		/* Def. read ahead # blocks */
78#define	NFS_MAXRAHEAD	4		/* Max. read ahead # blocks */
79#define	NFS_MAXUIDHASH	64		/* Max. # of hashed uid entries/mp */
80#define	NFS_MAXASYNCDAEMON 	20	/* Max. number async_daemons runnable */
81#define NFS_MAXGATHERDELAY	100	/* Max. write gather delay (msec) */
82#ifndef NFS_GATHERDELAY
83#define NFS_GATHERDELAY		10	/* Default write gather delay (msec) */
84#endif
85#define	NFS_DIRBLKSIZ	4096		/* Must be a multiple of DIRBLKSIZ */
86#ifdef KERNEL
87#define	DIRBLKSIZ	512		/* XXX we used to use ufs's DIRBLKSIZ */
88#endif
89
90/*
91 * Oddballs
92 */
93#define	NMOD(a)		((a) % nfs_asyncdaemons)
94#define NFS_CMPFH(n, f, s) \
95	((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
96#define NFS_ISV3(v)	(VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
97#define NFS_SRVMAXDATA(n) \
98		(((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
99		 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
100
101/*
102 * XXX
103 * The B_INVAFTERWRITE flag should be set to whatever is required by the
104 * buffer cache code to say "Invalidate the block after it is written back".
105 */
106#define	B_INVAFTERWRITE	B_NOCACHE
107
108/*
109 * The IO_METASYNC flag should be implemented for local file systems.
110 * (Until then, it is nothin at all.)
111 */
112#ifndef IO_METASYNC
113#define IO_METASYNC	0
114#endif
115
116/*
117 * Expected allocation sizes for major data structures. If the actual size
118 * of the structure exceeds these sizes, then malloc() will be allocating
119 * almost twice the memory required. This is used in nfs_init() to warn
120 * the sysadmin that the size of a structure should be reduced.
121 * (These sizes are always a power of 2. If the kernel malloc() changes
122 *  to one that does not allocate space in powers of 2 size, then this all
123 *  becomes bunk!)
124 */
125#define NFS_SVCALLOC	256
126#define NFS_UIDALLOC	128
127
128/*
129 * Arguments to mount NFS
130 */
131#define NFS_ARGSVERSION	3		/* change when nfs_args changes */
132struct nfs_args {
133	int		version;	/* args structure version number */
134	struct sockaddr	*addr;		/* file server address */
135	int		addrlen;	/* length of address */
136	int		sotype;		/* Socket type */
137	int		proto;		/* and Protocol */
138	u_char		*fh;		/* File handle to be mounted */
139	int		fhsize;		/* Size, in bytes, of fh */
140	int		flags;		/* flags */
141	int		wsize;		/* write size in bytes */
142	int		rsize;		/* read size in bytes */
143	int		readdirsize;	/* readdir size in bytes */
144	int		timeo;		/* initial timeout in .1 secs */
145	int		retrans;	/* times to retry send */
146	int		maxgrouplist;	/* Max. size of group list */
147	int		readahead;	/* # of blocks to readahead */
148	int		leaseterm;	/* Term (sec) of lease */
149	int		deadthresh;	/* Retrans threshold */
150	char		*hostname;	/* server's name */
151	int		acregmin;	/* cache attrs for reg files min time */
152	int		acregmax;	/* cache attrs for reg files max time */
153	int		acdirmin;	/* cache attrs for dirs min time */
154	int		acdirmax;	/* cache attrs for dirs max time */
155};
156
157/*
158 * NFS mount option flags
159 */
160#define	NFSMNT_SOFT		0x00000001  /* soft mount (hard is default) */
161#define	NFSMNT_WSIZE		0x00000002  /* set write size */
162#define	NFSMNT_RSIZE		0x00000004  /* set read size */
163#define	NFSMNT_TIMEO		0x00000008  /* set initial timeout */
164#define	NFSMNT_RETRANS		0x00000010  /* set number of request retries */
165#define	NFSMNT_MAXGRPS		0x00000020  /* set maximum grouplist size */
166#define	NFSMNT_INT		0x00000040  /* allow interrupts on hard mount */
167#define	NFSMNT_NOCONN		0x00000080  /* Don't Connect the socket */
168#define	NFSMNT_NQNFS		0x00000100  /* Use Nqnfs protocol */
169#define	NFSMNT_NFSV3		0x00000200  /* Use NFS Version 3 protocol */
170#define	NFSMNT_KERB		0x00000400  /* Use Kerberos authentication */
171#define	NFSMNT_DUMBTIMR		0x00000800  /* Don't estimate rtt dynamically */
172#define	NFSMNT_LEASETERM	0x00001000  /* set lease term (nqnfs) */
173#define	NFSMNT_READAHEAD	0x00002000  /* set read ahead */
174#define	NFSMNT_DEADTHRESH	0x00004000  /* set dead server retry thresh */
175#define	NFSMNT_RESVPORT		0x00008000  /* Allocate a reserved port */
176#define	NFSMNT_RDIRPLUS		0x00010000  /* Use Readdirplus for V3 */
177#define	NFSMNT_READDIRSIZE	0x00020000  /* Set readdir size */
178#define	NFSMNT_ACREGMIN		0x00040000
179#define	NFSMNT_ACREGMAX		0x00080000
180#define	NFSMNT_ACDIRMIN		0x00100000
181#define	NFSMNT_ACDIRMAX		0x00200000
182
183#define NFSSTA_HASWRITEVERF	0x00040000  /* Has write verifier for V3 */
184#define NFSSTA_GOTPATHCONF	0x00080000  /* Got the V3 pathconf info */
185#define NFSSTA_GOTFSINFO	0x00100000  /* Got the V3 fsinfo */
186#define	NFSSTA_MNTD		0x00200000  /* Mnt server for mnt point */
187#define	NFSSTA_DISMINPROG	0x00400000  /* Dismount in progress */
188#define	NFSSTA_DISMNT		0x00800000  /* Dismounted */
189#define	NFSSTA_SNDLOCK		0x01000000  /* Send socket lock */
190#define	NFSSTA_WANTSND		0x02000000  /* Want above */
191#define	NFSSTA_RCVLOCK		0x04000000  /* Rcv socket lock */
192#define	NFSSTA_WANTRCV		0x08000000  /* Want above */
193#define	NFSSTA_WAITAUTH		0x10000000  /* Wait for authentication */
194#define	NFSSTA_HASAUTH		0x20000000  /* Has authenticator */
195#define	NFSSTA_WANTAUTH		0x40000000  /* Wants an authenticator */
196#define	NFSSTA_AUTHERR		0x80000000  /* Authentication error */
197
198/*
199 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
200 * should ever try and use it.
201 */
202struct nfsd_args {
203	int	sock;		/* Socket to serve */
204	caddr_t	name;		/* Client addr for connection based sockets */
205	int	namelen;	/* Length of name */
206};
207
208struct nfsd_srvargs {
209	struct nfsd	*nsd_nfsd;	/* Pointer to in kernel nfsd struct */
210	uid_t		nsd_uid;	/* Effective uid mapped to cred */
211	u_int32_t	nsd_haddr;	/* Ip address of client */
212	struct ucred	nsd_cr;		/* Cred. uid maps to */
213	int		nsd_authlen;	/* Length of auth string (ret) */
214	u_char		*nsd_authstr;	/* Auth string (ret) */
215	int		nsd_verflen;	/* and the verfier */
216	u_char		*nsd_verfstr;
217	struct timeval	nsd_timestamp;	/* timestamp from verifier */
218	u_int32_t	nsd_ttl;	/* credential ttl (sec) */
219	NFSKERBKEY_T	nsd_key;	/* Session key */
220};
221
222struct nfsd_cargs {
223	char		*ncd_dirp;	/* Mount dir path */
224	uid_t		ncd_authuid;	/* Effective uid */
225	int		ncd_authtype;	/* Type of authenticator */
226	int		ncd_authlen;	/* Length of authenticator string */
227	u_char		*ncd_authstr;	/* Authenticator string */
228	int		ncd_verflen;	/* and the verifier */
229	u_char		*ncd_verfstr;
230	NFSKERBKEY_T	ncd_key;	/* Session key */
231};
232
233/*
234 * XXX to allow amd to include nfs.h without nfsproto.h
235 */
236#ifdef NFS_NPROCS
237/*
238 * Stats structure
239 */
240struct nfsstats {
241	int	attrcache_hits;
242	int	attrcache_misses;
243	int	lookupcache_hits;
244	int	lookupcache_misses;
245	int	direofcache_hits;
246	int	direofcache_misses;
247	int	biocache_reads;
248	int	read_bios;
249	int	read_physios;
250	int	biocache_writes;
251	int	write_bios;
252	int	write_physios;
253	int	biocache_readlinks;
254	int	readlink_bios;
255	int	biocache_readdirs;
256	int	readdir_bios;
257	int	rpccnt[NFS_NPROCS];
258	int	rpcretries;
259	int	srvrpccnt[NFS_NPROCS];
260	int	srvrpc_errs;
261	int	srv_errs;
262	int	rpcrequests;
263	int	rpctimeouts;
264	int	rpcunexpected;
265	int	rpcinvalid;
266	int	srvcache_inproghits;
267	int	srvcache_idemdonehits;
268	int	srvcache_nonidemdonehits;
269	int	srvcache_misses;
270	int	srvnqnfs_leases;
271	int	srvnqnfs_maxleases;
272	int	srvnqnfs_getleases;
273	int	srvvop_writes;
274};
275#endif
276
277/*
278 * Flags for nfssvc() system call.
279 */
280#define	NFSSVC_BIOD	0x002
281#define	NFSSVC_NFSD	0x004
282#define	NFSSVC_ADDSOCK	0x008
283#define	NFSSVC_AUTHIN	0x010
284#define	NFSSVC_GOTAUTH	0x040
285#define	NFSSVC_AUTHINFAIL 0x080
286#define	NFSSVC_MNTD	0x100
287
288/*
289 * fs.nfs sysctl(3) identifiers
290 */
291#define NFS_NFSSTATS	1		/* struct: struct nfsstats */
292#define NFS_NFSPRIVPORT	2		/* int: prohibit nfs to resvports */
293
294#define FS_NFS_NAMES { \
295		       { 0, 0 }, \
296		       { "nfsstats", CTLTYPE_STRUCT }, \
297		       { "nfsprivport", CTLTYPE_INT }, \
298}
299
300#ifdef KERNEL
301
302#ifdef MALLOC_DECLARE
303MALLOC_DECLARE(M_NFSREQ);
304MALLOC_DECLARE(M_NFSDIROFF);
305MALLOC_DECLARE(M_NFSRVDESC);
306MALLOC_DECLARE(M_NFSUID);
307MALLOC_DECLARE(M_NQLEASE);
308MALLOC_DECLARE(M_NFSD);
309MALLOC_DECLARE(M_NFSBIGFH);
310MALLOC_DECLARE(M_NFSHASH);
311#endif
312
313#ifdef ZONE_INTERRUPT
314extern vm_zone_t nfsmount_zone;
315#endif
316
317extern struct callout_handle nfs_timer_handle;
318
319struct uio; struct buf; struct vattr; struct nameidata;	/* XXX */
320
321/*
322 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
323 * What should be in this set is open to debate, but I believe that since
324 * I/O system calls on ufs are never interrupted by signals the set should
325 * be minimal. My reasoning is that many current programs that use signals
326 * such as SIGALRM will not expect file I/O system calls to be interrupted
327 * by them and break.
328 */
329#define	NFSINT_SIGMASK(set) 						\
330	(SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||	\
331	 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||	\
332	 SIGISMEMBER(set, SIGQUIT))
333
334/*
335 * Socket errors ignored for connectionless sockets??
336 * For now, ignore them all
337 */
338#define	NFSIGNORE_SOERROR(s, e) \
339		((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
340		((s) & PR_CONNREQUIRED) == 0)
341
342/*
343 * Nfs outstanding request list element
344 */
345struct nfsreq {
346	TAILQ_ENTRY(nfsreq) r_chain;
347	struct mbuf	*r_mreq;
348	struct mbuf	*r_mrep;
349	struct mbuf	*r_md;
350	caddr_t		r_dpos;
351	struct nfsmount *r_nmp;
352	struct vnode	*r_vp;
353	u_int32_t	r_xid;
354	int		r_flags;	/* flags on request, see below */
355	int		r_retry;	/* max retransmission count */
356	int		r_rexmit;	/* current retrans count */
357	int		r_timer;	/* tick counter on reply */
358	u_int32_t	r_procnum;	/* NFS procedure number */
359	int		r_rtt;		/* RTT for rpc */
360	struct proc	*r_procp;	/* Proc that did I/O system call */
361};
362
363/*
364 * Queue head for nfsreq's
365 */
366extern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq;
367
368/* Flag values for r_flags */
369#define R_TIMING	0x01		/* timing request (in mntp) */
370#define R_SENT		0x02		/* request has been sent */
371#define	R_SOFTTERM	0x04		/* soft mnt, too many retries */
372#define	R_INTR		0x08		/* intr mnt, signal pending */
373#define	R_SOCKERR	0x10		/* Fatal error on socket */
374#define	R_TPRINTFMSG	0x20		/* Did a tprintf msg. */
375#define	R_MUSTRESEND	0x40		/* Must resend request */
376#define	R_GETONEREP	0x80		/* Probe for one reply only */
377
378/*
379 * A list of nfssvc_sock structures is maintained with all the sockets
380 * that require service by the nfsd.
381 * The nfsuid structs hang off of the nfssvc_sock structs in both lru
382 * and uid hash lists.
383 */
384#ifndef NFS_UIDHASHSIZ
385#define	NFS_UIDHASHSIZ	29	/* Tune the size of nfssvc_sock with this */
386#endif
387#define	NUIDHASH(sock, uid) \
388	(&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
389#ifndef NFS_WDELAYHASHSIZ
390#define	NFS_WDELAYHASHSIZ 16	/* and with this */
391#endif
392#define	NWDELAYHASH(sock, f) \
393	(&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
394#ifndef NFS_MUIDHASHSIZ
395#define NFS_MUIDHASHSIZ	63	/* Tune the size of nfsmount with this */
396#endif
397#define	NMUIDHASH(nmp, uid) \
398	(&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
399#define	NFSNOHASH(fhsum) \
400	(&nfsnodehashtbl[(fhsum) & nfsnodehash])
401
402/*
403 * Network address hash list element
404 */
405union nethostaddr {
406	u_int32_t had_inetaddr;
407	struct sockaddr *had_nam;
408};
409
410struct nfsuid {
411	TAILQ_ENTRY(nfsuid) nu_lru;	/* LRU chain */
412	LIST_ENTRY(nfsuid) nu_hash;	/* Hash list */
413	int		nu_flag;	/* Flags */
414	union nethostaddr nu_haddr;	/* Host addr. for dgram sockets */
415	struct ucred	nu_cr;		/* Cred uid mapped to */
416	int		nu_expire;	/* Expiry time (sec) */
417	struct timeval	nu_timestamp;	/* Kerb. timestamp */
418	u_int32_t	nu_nickname;	/* Nickname on server */
419	NFSKERBKEY_T	nu_key;		/* and session key */
420};
421
422#define	nu_inetaddr	nu_haddr.had_inetaddr
423#define	nu_nam		nu_haddr.had_nam
424/* Bits for nu_flag */
425#define	NU_INETADDR	0x1
426#define NU_NAM		0x2
427#define NU_NETFAM(u)	(((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
428
429struct nfsrv_rec {
430	STAILQ_ENTRY(nfsrv_rec) nr_link;
431	struct sockaddr	*nr_address;
432	struct mbuf	*nr_packet;
433};
434
435struct nfssvc_sock {
436	TAILQ_ENTRY(nfssvc_sock) ns_chain;	/* List of all nfssvc_sock's */
437	TAILQ_HEAD(, nfsuid) ns_uidlruhead;
438	struct file	*ns_fp;
439	struct socket	*ns_so;
440	struct sockaddr	*ns_nam;
441	struct mbuf	*ns_raw;
442	struct mbuf	*ns_rawend;
443	STAILQ_HEAD(, nfsrv_rec) ns_rec;
444	struct mbuf	*ns_frag;
445	int		ns_flag;
446	int		ns_solock;
447	int		ns_cc;
448	int		ns_reclen;
449	int		ns_numuids;
450	u_int32_t	ns_sref;
451	LIST_HEAD(, nfsrv_descript) ns_tq;	/* Write gather lists */
452	LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
453	LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
454};
455
456/* Bits for "ns_flag" */
457#define	SLP_VALID	0x01
458#define	SLP_DOREC	0x02
459#define	SLP_NEEDQ	0x04
460#define	SLP_DISCONN	0x08
461#define	SLP_GETSTREAM	0x10
462#define	SLP_LASTFRAG	0x20
463#define SLP_ALLFLAGS	0xff
464
465extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
466extern int nfssvc_sockhead_flag;
467#define	SLP_INIT	0x01
468#define	SLP_WANTINIT	0x02
469
470/*
471 * One of these structures is allocated for each nfsd.
472 */
473struct nfsd {
474	TAILQ_ENTRY(nfsd) nfsd_chain;	/* List of all nfsd's */
475	int		nfsd_flag;	/* NFSD_ flags */
476	struct nfssvc_sock *nfsd_slp;	/* Current socket */
477	int		nfsd_authlen;	/* Authenticator len */
478	u_char		nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
479	int		nfsd_verflen;	/* and the Verifier */
480	u_char		nfsd_verfstr[RPCVERF_MAXSIZ];
481	struct proc	*nfsd_procp;	/* Proc ptr */
482	struct nfsrv_descript *nfsd_nd;	/* Associated nfsrv_descript */
483};
484
485/* Bits for "nfsd_flag" */
486#define	NFSD_WAITING	0x01
487#define	NFSD_REQINPROG	0x02
488#define	NFSD_NEEDAUTH	0x04
489#define	NFSD_AUTHFAIL	0x08
490
491/*
492 * This structure is used by the server for describing each request.
493 * Some fields are used only when write request gathering is performed.
494 */
495struct nfsrv_descript {
496	u_quad_t		nd_time;	/* Write deadline (usec) */
497	off_t			nd_off;		/* Start byte offset */
498	off_t			nd_eoff;	/* and end byte offset */
499	LIST_ENTRY(nfsrv_descript) nd_hash;	/* Hash list */
500	LIST_ENTRY(nfsrv_descript) nd_tq;		/* and timer list */
501	LIST_HEAD(,nfsrv_descript) nd_coalesce;	/* coalesced writes */
502	struct mbuf		*nd_mrep;	/* Request mbuf list */
503	struct mbuf		*nd_md;		/* Current dissect mbuf */
504	struct mbuf		*nd_mreq;	/* Reply mbuf list */
505	struct sockaddr		*nd_nam;	/* and socket addr */
506	struct sockaddr		*nd_nam2;	/* return socket addr */
507	caddr_t			nd_dpos;	/* Current dissect pos */
508	u_int32_t		nd_procnum;	/* RPC # */
509	int			nd_stable;	/* storage type */
510	int			nd_flag;	/* nd_flag */
511	int			nd_len;		/* Length of this write */
512	int			nd_repstat;	/* Reply status */
513	u_int32_t		nd_retxid;	/* Reply xid */
514	u_int32_t		nd_duration;	/* Lease duration */
515	struct timeval		nd_starttime;	/* Time RPC initiated */
516	fhandle_t		nd_fh;		/* File handle */
517	struct ucred		nd_cr;		/* Credentials */
518};
519
520/* Bits for "nd_flag" */
521#define	ND_READ		LEASE_READ
522#define ND_WRITE	LEASE_WRITE
523#define ND_CHECK	0x04
524#define ND_LEASE	(ND_READ | ND_WRITE | ND_CHECK)
525#define ND_NFSV3	0x08
526#define ND_NQNFS	0x10
527#define ND_KERBNICK	0x20
528#define ND_KERBFULL	0x40
529#define ND_KERBAUTH	(ND_KERBNICK | ND_KERBFULL)
530
531extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
532extern int nfsd_head_flag;
533#define	NFSD_CHECKSLP	0x01
534
535/*
536 * These macros compare nfsrv_descript structures.
537 */
538#define NFSW_CONTIG(o, n) \
539		((o)->nd_eoff >= (n)->nd_off && \
540		 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
541
542#define NFSW_SAMECRED(o, n) \
543	(((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \
544 	 !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
545		sizeof (struct ucred)))
546
547/*
548 * Defines for WebNFS
549 */
550
551#define WEBNFS_ESC_CHAR		'%'
552#define WEBNFS_SPECCHAR_START	0x80
553
554#define WEBNFS_NATIVE_CHAR	0x80
555/*
556 * ..
557 * Possibly more here in the future.
558 */
559
560/*
561 * Macro for converting escape characters in WebNFS pathnames.
562 * Should really be in libkern.
563 */
564
565#define HEXTOC(c) \
566	((c) >= 'a' ? ((c) - ('a' - 10)) : \
567	    ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
568#define HEXSTRTOI(p) \
569	((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
570
571#ifdef NFS_DEBUG
572
573extern int nfs_debug;
574#define NFS_DEBUG_ASYNCIO	1 /* asynchronous i/o */
575#define NFS_DEBUG_WG		2 /* server write gathering */
576#define NFS_DEBUG_RC		4 /* server request caching */
577
578#define NFS_DPF(cat, args)					\
579	do {							\
580		if (nfs_debug & NFS_DEBUG_##cat) printf args;	\
581	} while (0)
582
583#else
584
585#define NFS_DPF(cat, args)
586
587#endif
588
589u_quad_t nfs_curusec __P((void));
590int	nfs_init __P((struct vfsconf *vfsp));
591int	nfs_uninit __P((struct vfsconf *vfsp));
592int	nfs_reply __P((struct nfsreq *));
593int	nfs_getreq __P((struct nfsrv_descript *,struct nfsd *,int));
594int	nfs_send __P((struct socket *, struct sockaddr *, struct mbuf *,
595		      struct nfsreq *));
596int	nfs_rephead __P((int, struct nfsrv_descript *, struct nfssvc_sock *,
597			 int, int, u_quad_t *, struct mbuf **, struct mbuf **,
598			 caddr_t *));
599int	nfs_sndlock __P((struct nfsreq *));
600void	nfs_sndunlock __P((struct nfsreq *));
601int	nfs_slplock __P((struct nfssvc_sock *, int));
602void	nfs_slpunlock __P((struct nfssvc_sock *));
603int	nfs_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
604int	nfs_vinvalbuf __P((struct vnode *, int, struct ucred *, struct proc *,
605			   int));
606int	nfs_readrpc __P((struct vnode *, struct uio *, struct ucred *));
607int	nfs_writerpc __P((struct vnode *, struct uio *, struct ucred *, int *,
608			  int *));
609int	nfs_commit __P((struct vnode *vp, u_quad_t offset, int cnt,
610			struct ucred *cred, struct proc *procp));
611int	nfs_readdirrpc __P((struct vnode *, struct uio *, struct ucred *));
612int	nfs_asyncio __P((struct buf *, struct ucred *, struct proc *));
613int	nfs_doio __P((struct buf *, struct ucred *, struct proc *));
614int	nfs_readlinkrpc __P((struct vnode *, struct uio *, struct ucred *));
615int	nfs_sigintr __P((struct nfsmount *, struct nfsreq *, struct proc *));
616int	nfs_readdirplusrpc __P((struct vnode *, struct uio *, struct ucred *));
617int	nfsm_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
618void	nfsm_srvfattr __P((struct nfsrv_descript *, struct vattr *,
619			   struct nfs_fattr *));
620void	nfsm_srvwcc __P((struct nfsrv_descript *, int, struct vattr *, int,
621			 struct vattr *, struct mbuf **, char **));
622void	nfsm_srvpostopattr __P((struct nfsrv_descript *, int, struct vattr *,
623				struct mbuf **, char **));
624int	netaddr_match __P((int, union nethostaddr *, struct sockaddr *));
625int	nfs_request __P((struct vnode *, struct mbuf *, int, struct proc *,
626			 struct ucred *, struct mbuf **, struct mbuf **,
627			 caddr_t *));
628int	nfs_loadattrcache __P((struct vnode **, struct mbuf **, caddr_t *,
629			       struct vattr *));
630int	nfs_namei __P((struct nameidata *, fhandle_t *, int,
631		       struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
632		       caddr_t *, struct vnode **, struct proc *, int, int));
633void	nfsm_adj __P((struct mbuf *, int, int));
634int	nfsm_mbuftouio __P((struct mbuf **, struct uio *, int, caddr_t *));
635void	nfsrv_initcache __P((void));
636int	nfs_getauth __P((struct nfsmount *, struct nfsreq *, struct ucred *,
637			 char **, int *, char *, int *, NFSKERBKEY_T));
638int	nfs_getnickauth __P((struct nfsmount *, struct ucred *, char **,
639			     int *, char *, int));
640int	nfs_savenickauth __P((struct nfsmount *, struct ucred *, int,
641			      NFSKERBKEY_T, struct mbuf **, char **,
642			      struct mbuf *));
643int	nfs_adv __P((struct mbuf **, caddr_t *, int, int));
644void	nfs_nhinit __P((void));
645void	nfs_timer __P((void*));
646u_long	nfs_hash __P((nfsfh_t *, int));
647int	nfsrv_dorec __P((struct nfssvc_sock *, struct nfsd *,
648			 struct nfsrv_descript **));
649int	nfsrv_getcache __P((struct nfsrv_descript *, struct nfssvc_sock *,
650			    struct mbuf **));
651void	nfsrv_updatecache __P((struct nfsrv_descript *, int, struct mbuf *));
652void	nfsrv_cleancache __P((void));
653int	nfs_connect __P((struct nfsmount *, struct nfsreq *));
654void	nfs_disconnect __P((struct nfsmount *));
655void	nfs_safedisconnect __P((struct nfsmount *));
656int	nfs_getattrcache __P((struct vnode *, struct vattr *));
657int	nfsm_strtmbuf __P((struct mbuf **, char **, const char *, long));
658int	nfs_bioread __P((struct vnode *, struct uio *, int, struct ucred *));
659int	nfsm_uiotombuf __P((struct uio *, struct mbuf **, int, caddr_t *));
660void	nfsrv_init __P((int));
661void	nfs_clearcommit __P((struct mount *));
662int	nfsrv_errmap __P((struct nfsrv_descript *, int));
663void	nfsrvw_sort __P((gid_t *, int));
664void	nfsrv_setcred __P((struct ucred *, struct ucred *));
665int	nfs_writebp __P((struct buf *, int, struct proc *));
666int	nfsrv_object_create __P((struct vnode *));
667void	nfsrv_wakenfsd __P((struct nfssvc_sock *slp));
668int	nfsrv_writegather __P((struct nfsrv_descript **, struct nfssvc_sock *,
669			       struct proc *, struct mbuf **));
670int	nfs_fsinfo __P((struct nfsmount *, struct vnode *, struct ucred *,
671			struct proc *p));
672
673int	nfsrv3_access __P((struct nfsrv_descript *nfsd,
674			   struct nfssvc_sock *slp,
675			   struct proc *procp, struct mbuf **mrq));
676int	nfsrv_commit __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
677			  struct proc *procp, struct mbuf **mrq));
678int	nfsrv_create __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
679			  struct proc *procp, struct mbuf **mrq));
680int	nfsrv_fhtovp __P((fhandle_t *, int, struct vnode **, struct ucred *,
681			  struct nfssvc_sock *, struct sockaddr *, int *,
682			  int, int));
683int	nfsrv_setpublicfs __P((struct mount *, struct netexport *,
684			       struct export_args *));
685int	nfs_ispublicfh __P((fhandle_t *));
686int	nfsrv_fsinfo __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
687			  struct proc *procp, struct mbuf **mrq));
688int	nfsrv_getattr __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
689			   struct proc *procp, struct mbuf **mrq));
690int	nfsrv_link __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
691			struct proc *procp, struct mbuf **mrq));
692int	nfsrv_lookup __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
693			  struct proc *procp, struct mbuf **mrq));
694int	nfsrv_mkdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
695			 struct proc *procp, struct mbuf **mrq));
696int	nfsrv_mknod __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
697			 struct proc *procp, struct mbuf **mrq));
698int	nfsrv_noop __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
699			struct proc *procp, struct mbuf **mrq));
700int	nfsrv_null __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
701			struct proc *procp, struct mbuf **mrq));
702int	nfsrv_pathconf __P((struct nfsrv_descript *nfsd,
703			    struct nfssvc_sock *slp, struct proc *procp,
704			    struct mbuf **mrq));
705int	nfsrv_read __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
706			struct proc *procp, struct mbuf **mrq));
707int	nfsrv_readdir __P((struct nfsrv_descript *nfsd,
708			   struct nfssvc_sock *slp,
709			   struct proc *procp, struct mbuf **mrq));
710int	nfsrv_readdirplus __P((struct nfsrv_descript *nfsd,
711			       struct nfssvc_sock *slp, struct proc *procp,
712			       struct mbuf **mrq));
713int	nfsrv_readlink __P((struct nfsrv_descript *nfsd,
714			    struct nfssvc_sock *slp, struct proc *procp,
715			    struct mbuf **mrq));
716int	nfsrv_remove __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
717			  struct proc *procp, struct mbuf **mrq));
718int	nfsrv_rename __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
719			  struct proc *procp, struct mbuf **mrq));
720int	nfsrv_rmdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
721			 struct proc *procp, struct mbuf **mrq));
722int	nfsrv_setattr __P((struct nfsrv_descript *nfsd,
723			   struct nfssvc_sock *slp,
724			   struct proc *procp, struct mbuf **mrq));
725int	nfsrv_statfs __P((struct nfsrv_descript *nfsd,
726			  struct nfssvc_sock *slp,
727			  struct proc *procp, struct mbuf **mrq));
728int	nfsrv_symlink __P((struct nfsrv_descript *nfsd,
729			   struct nfssvc_sock *slp,
730			   struct proc *procp, struct mbuf **mrq));
731int	nfsrv_write __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
732			 struct proc *procp, struct mbuf **mrq));
733void	nfsrv_rcv __P((struct socket *so, void *arg, int waitflag));
734void	nfsrv_slpderef __P((struct nfssvc_sock *slp));
735#endif	/* KERNEL */
736
737#endif
738