xref: /dragonfly/sys/vfs/nfs/nfs.h (revision cae2835b)
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. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)nfs.h	8.4 (Berkeley) 5/1/95
33  * $FreeBSD: src/sys/nfs/nfs.h,v 1.53.2.5 2002/02/20 01:35:34 iedowse Exp $
34  */
35 
36 #ifndef _NFS_NFS_H_
37 #define _NFS_NFS_H_
38 
39 #ifdef _KERNEL
40 #include "opt_nfs.h"
41 #endif
42 
43 #include <sys/vnode.h>
44 #include <sys/mutex.h>
45 #include <sys/thread.h>
46 
47 /*
48  * Tunable constants for nfs
49  */
50 
51 #define	NFS_MAXIOVEC	34
52 #define NFS_TICKINTVL	200		/* 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_DEFATTRTIMO
66 #define	NFS_DEFATTRTIMO 10		/* VREG attrib cache timeout in sec */
67 #endif
68 #ifndef NFS_MAXATTRTIMO
69 #define	NFS_MAXATTRTIMO 60
70 #endif
71 #ifndef NFS_MINDIRATTRTIMO
72 #define	NFS_MINDIRATTRTIMO 30		/* VDIR attrib cache timeout in sec */
73 #endif
74 #ifndef NFS_MAXDIRATTRTIMO
75 #define	NFS_MAXDIRATTRTIMO 60
76 #endif
77 #ifndef NFS_DEADTHRESH
78 #define NFS_DEADTHRESH	NFS_NEVERDEAD
79 #endif
80 #define NFS_NEVERDEAD	9
81 #define	NFS_WSIZE	8192		/* Def. write data size <= 8192 */
82 #define	NFS_RSIZE	8192		/* Def. read data size <= 8192 */
83 #define NFS_READDIRSIZE	8192		/* Def. readdir size */
84 #define	NFS_DEFRAHEAD	6		/* Def. read ahead # blocks */
85 #define	NFS_MAXRAHEAD	32		/* Max. read ahead # blocks */
86 #define	NFS_MAXASYNCBIO	64		/* Max. asynchronous BIOs */
87 #define	NFS_MAXUIDHASH	64		/* Max. # of hashed uid entries/mp */
88 #define NFS_MAXGATHERDELAY	100	/* Max. write gather delay (msec) */
89 #ifndef NFS_GATHERDELAY
90 #define NFS_GATHERDELAY		20	/* Default write gather delay (msec) */
91 #endif
92 #define	NFS_DIRBLKSIZ	4096		/* Must be a multiple of DIRBLKSIZ */
93 #ifdef _KERNEL
94 #define	DIRBLKSIZ	512		/* XXX we used to use ufs's DIRBLKSIZ */
95 #endif
96 
97 #define NFS_ASYSCALE		256
98 #define NFS_MINASYNC_SCALED	(4 * NFS_ASYSCALE)
99 #define NFS_MAXASYNC_SCALED	(NFS_MAXASYNCBIO * NFS_ASYSCALE)
100 
101 /*
102  * Oddballs
103  */
104 #define	NMOD(a)		((a) % nfs_asyncdaemons)
105 #define NFS_CMPFH(n, f, s) \
106 	((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
107 #define NFS_ISV3(v)	(VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
108 #define NFS_SRVMAXDATA(n) \
109 		(((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
110 		 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
111 
112 /*
113  * The IO_METASYNC flag should be implemented for local file systems.
114  * (Until then, it is nothin at all.)
115  */
116 #ifndef IO_METASYNC
117 #define IO_METASYNC	0
118 #endif
119 
120 /*
121  * Arguments to mount NFS
122  */
123 #define NFS_ARGSVERSION	3		/* change when nfs_args changes */
124 struct nfs_args {
125 	int		version;	/* args structure version number */
126 	struct sockaddr	*addr;		/* file server address */
127 	int		addrlen;	/* length of address */
128 	int		sotype;		/* Socket type */
129 	int		proto;		/* and Protocol */
130 	u_char		*fh;		/* File handle to be mounted */
131 	int		fhsize;		/* Size, in bytes, of fh */
132 	int		flags;		/* flags */
133 	int		wsize;		/* write size in bytes */
134 	int		rsize;		/* read size in bytes */
135 	int		readdirsize;	/* readdir size in bytes */
136 	int		timeo;		/* initial timeout in .1 secs */
137 	int		retrans;	/* times to retry send */
138 	int		maxgrouplist;	/* Max. size of group list */
139 	int		readahead;	/* # of blocks to readahead */
140 	int		unused01;	/* Term (sec) of lease */
141 	int		deadthresh;	/* Retrans threshold */
142 	char		*hostname;	/* server's name */
143 	int		acregmin;	/* cache attrs for reg files min time */
144 	int		acregmax;	/* cache attrs for reg files max time */
145 	int		acdirmin;	/* cache attrs for dirs min time */
146 	int		acdirmax;	/* cache attrs for dirs max time */
147 };
148 
149 /*
150  * NFS mount option flags
151  */
152 #define	NFSMNT_SOFT		0x00000001  /* soft mount (hard is default) */
153 #define	NFSMNT_WSIZE		0x00000002  /* set write size */
154 #define	NFSMNT_RSIZE		0x00000004  /* set read size */
155 #define	NFSMNT_TIMEO		0x00000008  /* set initial timeout */
156 #define	NFSMNT_RETRANS		0x00000010  /* set number of request retries */
157 #define	NFSMNT_MAXGRPS		0x00000020  /* set maximum grouplist size */
158 #define	NFSMNT_INT		0x00000040  /* allow interrupts on hard mount */
159 #define	NFSMNT_NOCONN		0x00000080  /* Don't Connect the socket */
160 #define	NFSMNT_FORCE		0x00000100  /* Forced unmount */
161 #define	NFSMNT_NFSV3		0x00000200  /* Use NFS Version 3 protocol */
162 #define	NFSMNT_KERB		0x00000400  /* Use Kerberos authentication */
163 #define	NFSMNT_DUMBTIMR		0x00000800  /* Don't estimate rtt dynamically */
164 #define	NFSMNT_CACHE		0x00001000  /* enable swapcache */
165 #define	NFSMNT_READAHEAD	0x00002000  /* set read ahead */
166 #define	NFSMNT_DEADTHRESH	0x00004000  /* set dead server retry thresh */
167 #define	NFSMNT_RESVPORT		0x00008000  /* Allocate a reserved port */
168 #define	NFSMNT_RDIRPLUS		0x00010000  /* Use Readdirplus for V3 */
169 #define	NFSMNT_READDIRSIZE	0x00020000  /* Set readdir size */
170 #define	NFSMNT_ACREGMIN		0x00040000
171 #define	NFSMNT_ACREGMAX		0x00080000
172 #define	NFSMNT_ACDIRMIN		0x00100000
173 #define	NFSMNT_ACDIRMAX		0x00200000
174 #define	NFSMNT_RETRYCNT		0x00400000  /* Set retry count */
175 
176 #define NFSSTA_HASWRITEVERF	0x00040000  /* Has write verifier for V3 */
177 #define NFSSTA_GOTPATHCONF	0x00080000  /* Got the V3 pathconf info */
178 #define NFSSTA_GOTFSINFO	0x00100000  /* Got the V3 fsinfo */
179 #define	NFSSTA_MNTD		0x00200000  /* Mnt server for mnt point */
180 #define	NFSSTA_DISMINPROG	0x00400000  /* Dismount in progress */
181 #define	NFSSTA_DISMNT		0x00800000  /* Dismounted */
182 #define	NFSSTA_SENDSPACE	0x01000000  /* Printed sendspace warning */
183 #define	NFSSTA_UNUSED25		0x02000000
184 #define	NFSSTA_UNUSED26		0x04000000
185 #define	NFSSTA_UNUSED27		0x08000000
186 #define	NFSSTA_WAITAUTH		0x10000000  /* Wait for authentication */
187 #define	NFSSTA_HASAUTH		0x20000000  /* Has authenticator */
188 #define	NFSSTA_WANTAUTH		0x40000000  /* Wants an authenticator */
189 #define	NFSSTA_AUTHERR		0x80000000  /* Authentication error */
190 
191 /*
192  * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
193  * should ever try and use it.
194  */
195 struct nfsd_args {
196 	int	sock;		/* Socket to serve */
197 	caddr_t	name;		/* Client addr for connection based sockets */
198 	int	namelen;	/* Length of name */
199 };
200 
201 struct nfsd_srvargs {
202 	struct nfsd	*nsd_nfsd;	/* Pointer to in kernel nfsd struct */
203 	uid_t		nsd_uid;	/* Effective uid mapped to cred */
204 	u_int32_t	nsd_haddr;	/* Ip address of client */
205 	struct ucred	nsd_cr;		/* Cred. uid maps to */
206 	u_int		nsd_authlen;	/* Length of auth string (ret) */
207 	u_char		*nsd_authstr;	/* Auth string (ret) */
208 	u_int		nsd_verflen;	/* and the verfier */
209 	u_char		*nsd_verfstr;
210 	struct timeval	nsd_timestamp;	/* timestamp from verifier */
211 	u_int32_t	nsd_ttl;	/* credential ttl (sec) */
212 	NFSKERBKEY_T	nsd_key;	/* Session key */
213 };
214 
215 struct nfsd_cargs {
216 	char		*ncd_dirp;	/* Mount dir path */
217 	uid_t		ncd_authuid;	/* Effective uid */
218 	int		ncd_authtype;	/* Type of authenticator */
219 	u_int		ncd_authlen;	/* Length of authenticator string */
220 	u_char		*ncd_authstr;	/* Authenticator string */
221 	u_int		ncd_verflen;	/* and the verifier */
222 	u_char		*ncd_verfstr;
223 	NFSKERBKEY_T	ncd_key;	/* Session key */
224 };
225 
226 /*
227  * XXX to allow amd to include nfs.h without nfsproto.h
228  */
229 #ifdef NFS_NPROCS
230 /*
231  * Stats structure
232  */
233 struct nfsstats {
234 	int	attrcache_hits;
235 	int	attrcache_misses;
236 	int	lookupcache_hits;
237 	int	lookupcache_misses;
238 	int	direofcache_hits;
239 	int	direofcache_misses;
240 	int	biocache_reads;
241 	int	read_bios;
242 	int	read_physios;
243 	int	biocache_writes;
244 	int	write_bios;
245 	int	write_physios;
246 	int	biocache_readlinks;
247 	int	readlink_bios;
248 	int	biocache_readdirs;
249 	int	readdir_bios;
250 	int	rpccnt[NFS_NPROCS];
251 	int	rpcretries;
252 	int	srvrpccnt[NFS_NPROCS];
253 	int	srvrpc_errs;
254 	int	srv_errs;
255 	int	rpcrequests;
256 	int	rpctimeouts;
257 	int	rpcunexpected;
258 	int	rpcinvalid;
259 	int	srvcache_inproghits;
260 	int	srvcache_idemdonehits;
261 	int	srvcache_nonidemdonehits;
262 	int	srvcache_misses;
263 	int	srvnqnfs_leases;
264 	int	srvnqnfs_maxleases;
265 	int	srvnqnfs_getleases;
266 	int	srvvop_writes;
267 	int	accesscache_hits;
268 	int	accesscache_misses;
269 };
270 #endif
271 
272 /*
273  * Flags for nfssvc() system call.
274  */
275 #define	NFSSVC_BIOD	0x002
276 #define	NFSSVC_NFSD	0x004
277 #define	NFSSVC_ADDSOCK	0x008
278 #define	NFSSVC_AUTHIN	0x010
279 #define	NFSSVC_GOTAUTH	0x040
280 #define	NFSSVC_AUTHINFAIL 0x080
281 #define	NFSSVC_MNTD	0x100
282 
283 /*
284  * fs.nfs sysctl(3) identifiers
285  */
286 #define NFS_NFSSTATS	1		/* struct: struct nfsstats */
287 #define NFS_NFSPRIVPORT	2		/* int: prohibit nfs to resvports */
288 
289 #define FS_NFS_NAMES { \
290 		       { 0, 0 }, \
291 		       { "nfsstats", CTLTYPE_STRUCT }, \
292 		       { "nfsprivport", CTLTYPE_INT }, \
293 }
294 
295 #ifdef _KERNEL
296 
297 #ifdef MALLOC_DECLARE
298 MALLOC_DECLARE(M_NFSREQ);
299 MALLOC_DECLARE(M_NFSDIROFF);
300 MALLOC_DECLARE(M_NFSRVDESC);
301 MALLOC_DECLARE(M_NFSUID);
302 MALLOC_DECLARE(M_NFSD);
303 MALLOC_DECLARE(M_NFSBIGFH);
304 MALLOC_DECLARE(M_NFSHASH);
305 #endif
306 
307 extern struct objcache *nfsmount_objcache;
308 
309 extern struct callout nfs_timer_handle;
310 extern int nfs_async;
311 extern int nfs_maxasyncbio;
312 extern int nfs_soreserve;
313 
314 struct uio;
315 struct buf;
316 struct bio;
317 struct vattr;
318 struct nlookupdata;
319 
320 /*
321  * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
322  * What should be in this set is open to debate, but I believe that since
323  * I/O system calls on ufs are never interrupted by signals the set should
324  * be minimal. My reasoning is that many current programs that use signals
325  * such as SIGALRM will not expect file I/O system calls to be interrupted
326  * by them and break.
327  */
328 #define	NFSINT_SIGMASK(set) 						\
329 	(SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||	\
330 	 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||	\
331 	 SIGISMEMBER(set, SIGQUIT))
332 
333 /*
334  * Socket errors ignored for connectionless sockets??
335  * For now, ignore them all
336  */
337 #define	NFSIGNORE_SOERROR(s, e) \
338 		((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
339 		((s) & PR_CONNREQUIRED) == 0)
340 
341 struct nfsm_info;
342 
343 /*
344  * Nfs outstanding request list element
345  */
346 struct nfsreq {
347 	TAILQ_ENTRY(nfsreq) r_chain;
348 	struct nfsm_info *r_info;
349 	mtx_link_t	r_link;
350 	struct mbuf	*r_mreq;
351 	struct mbuf	*r_mrep;
352 	struct mbuf	*r_md;
353 	caddr_t		r_dpos;
354 	struct nfsmount *r_nmp;
355 	struct vnode	*r_vp;
356 	u_int32_t	r_xid;
357 	int		r_flags;	/* flags on request, see below */
358 	int		r_retry;	/* max retransmission count */
359 	int		r_rexmit;	/* current retrans count */
360 	int		r_timer;	/* tick counter on reply */
361 	u_int32_t	r_procnum;	/* NFS procedure number */
362 	int		r_rtt;		/* RTT for rpc */
363 	struct thread	*r_td;		/* Thread that did I/O system call */
364 	struct mbuf	*r_mrest;
365 	struct mbuf	*r_mheadend;
366 	struct mbuf	**r_mrp;
367 	struct mbuf	**r_mdp;
368 	caddr_t		*r_dposp;
369 	int		r_mrest_len;
370 	int		r_failed_auth;
371 	NFSKERBKEY_T	r_key;
372 	struct ucred	*r_cred;
373 };
374 
375 /*
376  * Flag values for r_flags
377  *
378  * R_TIMING -	Timer is active on request.  If timer goes off the
379  *		request's retransmit counter will bump and it will
380  *		be flagged NEEDSXMIT to retransmit.
381  *
382  * R_SENT -	Indicates that the request was sent the first time.
383  *		This stays set unless we want to repeat a first-time
384  *		styled transmit sequence.
385  *
386  * R_NEEDSXMIT - The request needs a [re]transmission.  It will still
387  *		be sitting on nm_reqq if synchronous, otherwise it
388  *		will be moved to nm_reqtxq.
389  *
390  * R_ASYNC -	Indicates an asynchronous request, which modifies the
391  *		behavior of how it is dealt with.
392  *
393  * R_LOCKED -	Prevents the request from being moved between queues
394  *		e.g. by the timer or by the async thread.
395  */
396 #define R_TIMING	0x0001		/* timing request (in mntp) */
397 #define R_SENT		0x0002		/* request has been sent */
398 #define	R_SOFTTERM	0x0004		/* soft mnt, too many retries */
399 #define	R_INTR		0x0008		/* intr mnt, signal pending */
400 #define	R_SOCKERR	0x0010		/* Fatal error on socket */
401 #define	R_TPRINTFMSG	0x0020		/* Did a tprintf msg. */
402 #define	R_NEEDSXMIT	0x0040		/* Needs [re]transmission */
403 #define	R_ASYNC		0x0080		/* Asynchronous mechanics */
404 #define R_ONREQQ	0x0100		/* On primary request queue */
405 #define R_LOCKED	0x0200		/* Locked by the someone */
406 #define R_WANTED	0x0400		/* Someone wants access */
407 
408 /*
409  * A list of nfssvc_sock structures is maintained with all the sockets
410  * that require service by the nfsd.
411  * The nfsuid structs hang off of the nfssvc_sock structs in both lru
412  * and uid hash lists.
413  */
414 #ifndef NFS_UIDHASHSIZ
415 #define	NFS_UIDHASHSIZ	29	/* Tune the size of nfssvc_sock with this */
416 #endif
417 #define	NUIDHASH(sock, uid) \
418 	(&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
419 #ifndef NFS_WDELAYHASHSIZ
420 #define	NFS_WDELAYHASHSIZ 16	/* and with this */
421 #endif
422 #define	NWDELAYHASH(sock, f) \
423 	(&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
424 #ifndef NFS_MUIDHASHSIZ
425 #define NFS_MUIDHASHSIZ	63	/* Tune the size of nfsmount with this */
426 #endif
427 #define	NMUIDHASH(nmp, uid) \
428 	(&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
429 
430 /*
431  * Network address hash list element
432  */
433 union nethostaddr {
434 	u_int32_t had_inetaddr;
435 	struct sockaddr *had_nam;
436 };
437 
438 struct nfsuid {
439 	TAILQ_ENTRY(nfsuid) nu_lru;	/* LRU chain */
440 	LIST_ENTRY(nfsuid) nu_hash;	/* Hash list */
441 	int		nu_flag;	/* Flags */
442 	union nethostaddr nu_haddr;	/* Host addr. for dgram sockets */
443 	struct ucred	nu_cr;		/* Cred uid mapped to */
444 	time_t		nu_expire;	/* Expiry time (time_uptime) */
445 	struct timeval	nu_timestamp;	/* Kerb. timestamp */
446 	u_int32_t	nu_nickname;	/* Nickname on server */
447 	NFSKERBKEY_T	nu_key;		/* and session key */
448 };
449 
450 #define	nu_inetaddr	nu_haddr.had_inetaddr
451 #define	nu_nam		nu_haddr.had_nam
452 /* Bits for nu_flag */
453 #define	NU_INETADDR	0x1
454 #define NU_NAM		0x2
455 
456 struct nfsrv_rec {
457 	STAILQ_ENTRY(nfsrv_rec) nr_link;
458 	struct sockaddr	*nr_address;
459 	struct mbuf	*nr_packet;
460 };
461 
462 struct nfssvc_sock {
463 	TAILQ_ENTRY(nfssvc_sock) ns_chain;	/* List of all nfssvc_sock's */
464 	TAILQ_HEAD(, nfsuid) ns_uidlruhead;
465 	struct file	*ns_fp;
466 	struct socket	*ns_so;
467 	struct sockaddr	*ns_nam;
468 	struct mbuf	*ns_raw;
469 	struct mbuf	*ns_rawend;
470 	STAILQ_HEAD(, nfsrv_rec) ns_rec;
471 	struct mbuf	*ns_frag;
472 	int		ns_numrec;
473 	u_int32_t	ns_flag;
474 	u_int32_t	ns_needq_upcall;
475 	struct mtx	ns_solock;
476 	int		ns_cc;
477 	int		ns_reclen;
478 	int		ns_numuids;
479 	u_int32_t	ns_sref;
480 	LIST_HEAD(, nfsrv_descript) ns_tq;	/* Write gather lists */
481 	LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
482 	LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
483 	struct lwkt_token ns_token;
484 };
485 
486 /* Bits for "ns_flag" */
487 #define	SLP_VALID	0x0001
488 #define	SLP_DOREC	0x0002	/* socket holding at least one record */
489 #define	SLP_NEEDQ	0x0004	/* socket needs general rx processing */
490 #define	SLP_DISCONN	0x0008
491 #define	SLP_GETSTREAM	0x0010	/* receive stream interlock */
492 #define	SLP_LASTFRAG	0x0020
493 
494 #define SLP_ALLFLAGS		0xff
495 #define SLP_ACTION_MASK		(SLP_NEEDQ | SLP_DOREC | SLP_DISCONN)
496 
497 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
498 extern int nfssvc_sockhead_flag;
499 extern TAILQ_HEAD(nfsmount_head, nfsmount) nfs_mountq;
500 
501 #define	SLP_INIT	0x01
502 #define	SLP_WANTINIT	0x02
503 
504 /*
505  * One of these structures is allocated for each nfsd.
506  */
507 struct nfsd {
508 	TAILQ_ENTRY(nfsd) nfsd_chain;	/* List of all nfsd's */
509 	int		nfsd_flag;	/* NFSD_ flags */
510 	struct nfssvc_sock *nfsd_slp;	/* Current socket */
511 	int		nfsd_authlen;	/* Authenticator len */
512 	u_char		nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
513 	int		nfsd_verflen;	/* and the Verifier */
514 	u_char		nfsd_verfstr[RPCVERF_MAXSIZ];
515 	struct thread	*nfsd_td;	/* thread ptr */
516 	struct nfsrv_descript *nfsd_nd;	/* Associated nfsrv_descript */
517 };
518 
519 /* Bits for "nfsd_flag" */
520 #define	NFSD_WAITING	0x01
521 #define	NFSD_REQINPROG	0x02
522 #define	NFSD_NEEDAUTH	0x04
523 #define	NFSD_AUTHFAIL	0x08
524 
525 /* Bits for loadattrcache */
526 #define NFS_LATTR_NOSHRINK	0x01
527 #define NFS_LATTR_NOMTIMECHECK	0x02
528 
529 #define NFSRV_RECLIMIT(slp)	((slp)->ns_numrec >= nfsd_waiting + 4)
530 
531 /*
532  * This structure is used by the server for describing each request.
533  * Some fields are used only when write request gathering is performed.
534  */
535 struct nfsrv_descript {
536 	u_quad_t		nd_time;	/* Write deadline (usec) */
537 	off_t			nd_off;		/* Start byte offset */
538 	off_t			nd_eoff;	/* and end byte offset */
539 	LIST_ENTRY(nfsrv_descript) nd_hash;	/* Hash list */
540 	LIST_ENTRY(nfsrv_descript) nd_tq;		/* and timer list */
541 	LIST_HEAD(,nfsrv_descript) nd_coalesce;	/* coalesced writes */
542 	struct mbuf		*nd_mrep;	/* Request mbuf list */
543 	struct mbuf		*nd_md;		/* Current dissect mbuf */
544 	struct mbuf		*nd_mreq;	/* Reply mbuf list */
545 	struct sockaddr		*nd_nam;	/* and socket addr */
546 	struct sockaddr		*nd_nam2;	/* return socket addr */
547 	caddr_t			nd_dpos;	/* Current dissect pos */
548 	u_int32_t		nd_procnum;	/* RPC # */
549 	int			nd_stable;	/* storage type */
550 	int			nd_flag;	/* nd_flag */
551 	int			nd_len;		/* Length of this write */
552 	int			nd_repstat;	/* Reply status */
553 	u_int32_t		nd_retxid;	/* Reply xid */
554 	struct timeval		nd_starttime;	/* Time RPC initiated */
555 	fhandle_t		nd_fh;		/* File handle */
556 	struct ucred		nd_cr;		/* Credentials */
557 };
558 
559 /* Bits for "nd_flag" */
560 #define	ND_READ		0x01
561 #define ND_WRITE	0x02
562 #define ND_CHECK	0x04
563 #define ND_NFSV3	0x08
564 #define ND_UNUSED010	0x10
565 #define ND_KERBNICK	0x20
566 #define ND_KERBFULL	0x40
567 #define ND_KERBAUTH	(ND_KERBNICK | ND_KERBFULL)
568 
569 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
570 extern int nfsd_head_flag;
571 extern int nfsd_waiting;
572 #define	NFSD_CHECKSLP	0x01
573 
574 /*
575  * These macros compare nfsrv_descript structures.
576  */
577 #define NFSW_CONTIG(o, n) \
578 		((o)->nd_eoff >= (n)->nd_off && \
579 		 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
580 
581 #define NFSW_SAMECRED(o, n) \
582 	(((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \
583  	 !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
584 		sizeof (struct ucred)))
585 
586 /*
587  * Defines for WebNFS
588  */
589 
590 #define WEBNFS_ESC_CHAR		'%'
591 #define WEBNFS_SPECCHAR_START	0x80
592 
593 #define WEBNFS_NATIVE_CHAR	0x80
594 /*
595  * ..
596  * Possibly more here in the future.
597  */
598 
599 /*
600  * Macro for converting escape characters in WebNFS pathnames.
601  * Should really be in libkern.
602  */
603 
604 #define HEXTOC(c) \
605 	((c) >= 'a' ? ((c) - ('a' - 10)) : \
606 	    ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
607 #define HEXSTRTOI(p) \
608 	((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
609 
610 #ifdef NFS_DEBUG
611 
612 extern int nfs_debug;
613 #define NFS_DEBUG_ASYNCIO	1 /* asynchronous i/o */
614 #define NFS_DEBUG_WG		2 /* server write gathering */
615 #define NFS_DEBUG_RC		4 /* server request caching */
616 
617 #define NFS_DPF(cat, args)					\
618 	do {							\
619 		if (nfs_debug & NFS_DEBUG_##cat) kprintf args;	\
620 	} while (0)
621 
622 #else
623 
624 #define NFS_DPF(cat, args)
625 
626 #endif
627 
628 extern u_int32_t nfs_xdrneg1;
629 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers;
630 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr;
631 extern u_int32_t rpc_auth_kerb;
632 extern u_int32_t nfs_prog, nfs_true, nfs_false;
633 extern struct nfsstats nfsstats;
634 extern nfstype nfsv2_type[9];
635 extern nfstype nfsv3_type[9];
636 extern int nfsv2_procid[NFS_NPROCS];
637 extern enum vtype nv3tov_type[8];
638 extern int nfsv3_procid[NFS_NPROCS];
639 extern int nfs_ticks;
640 extern struct nfsrtt nfsrtt;
641 extern int nfsrtton;
642 extern int nfsrvw_procrastinate;
643 extern int nfsrvw_procrastinate_v3;
644 extern int32_t (*nfsrv3_procs[NFS_NPROCS]) (struct nfsrv_descript *nd,
645 					    struct nfssvc_sock *slp,
646 					    struct thread *td,
647 					    struct mbuf **mreqp);
648 
649 extern struct nfsv3_diskless nfsv3_diskless;
650 extern struct lwkt_token nfs_token;
651 
652 u_quad_t nfs_curusec (void);
653 int	nfs_init (struct vfsconf *vfsp);
654 int	nfs_uninit (struct vfsconf *vfsp);
655 int	nfs_reply (struct nfsmount *nmp, struct nfsreq *);
656 int	nfs_getreq (struct nfsrv_descript *,struct nfsd *,int);
657 int	nfs_send (struct socket *, struct sockaddr *, struct mbuf *,
658 		      struct nfsreq *);
659 int	nfs_rephead (int, struct nfsrv_descript *, struct nfssvc_sock *,
660 			 int, struct mbuf **, struct mbuf **, caddr_t *);
661 int	nfs_sndlock (struct nfsmount *, struct nfsreq *);
662 void	nfs_sndunlock (struct nfsmount *);
663 int	nfs_slplock (struct nfssvc_sock *, int);
664 void	nfs_slpunlock (struct nfssvc_sock *);
665 int	nfs_disct (struct mbuf **, caddr_t *, int, int, caddr_t *);
666 int	nfs_vinvalbuf (struct vnode *, int, int);
667 int	nfs_readrpc_uio (struct vnode *, struct uio *);
668 void	nfs_readrpc_bio (struct vnode *, struct bio *);
669 int	nfs_writerpc_uio (struct vnode *, struct uio *, int *, int *);
670 void	nfs_writerpc_bio (struct vnode *, struct bio *);
671 int	nfs_commitrpc_uio (struct vnode *vp, u_quad_t offset, int cnt,
672 			struct thread *td);
673 void	nfs_commitrpc_bio (struct vnode *vp, struct bio *);
674 int	nfs_readdirrpc_uio (struct vnode *, struct uio *);
675 void	nfs_startio(struct vnode *vp, struct bio *, struct thread *);
676 int	nfs_doio(struct vnode *vp, struct bio *, struct thread *);
677 void	nfs_asyncio(struct vnode *vp, struct bio *bio);
678 int	nfs_asyncok(struct nfsmount *nmp);
679 
680 int	nfs_readlinkrpc_uio (struct vnode *, struct uio *);
681 int	nfs_sigintr (struct nfsmount *, struct nfsreq *, struct thread *);
682 int	nfs_readdirplusrpc_uio (struct vnode *, struct uio *);
683 int	netaddr_match (int, union nethostaddr *, struct sockaddr *);
684 
685 int	nfs_loadattrcache (struct vnode *, struct mbuf **, caddr_t *,
686 			struct vattr *, int);
687 int	nfs_namei (struct nlookupdata *, struct ucred *, int,
688 		    struct vnode **, struct vnode **, fhandle_t *, int,
689 		    struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
690 		    caddr_t *, struct vnode **, struct thread *, int, int);
691 void	nfsrv_initcache (void);
692 int	nfs_getauth (struct nfsmount *, struct nfsreq *, struct ucred *,
693 			 char **, int *, char *, int *, NFSKERBKEY_T);
694 int	nfs_getnickauth (struct nfsmount *, struct ucred *, char **,
695 			     int *, char *, int);
696 int	nfs_savenickauth (struct nfsmount *, struct ucred *, int,
697 			      NFSKERBKEY_T, struct mbuf **, char **,
698 			      struct mbuf *);
699 int	nfs_adv (struct mbuf **, caddr_t *, int, int);
700 void	nfs_nhinit (void);
701 int	nfs_nmcancelreqs (struct nfsmount *);
702 void	nfs_timer_callout (void*);
703 int	nfsrv_dorec (struct nfssvc_sock *, struct nfsd *,
704 			 struct nfsrv_descript **);
705 int	nfsrv_getcache (struct nfsrv_descript *, struct nfssvc_sock *,
706 			    struct mbuf **);
707 void	nfsrv_updatecache (struct nfsrv_descript *, int, struct mbuf *);
708 void	nfsrv_cleancache (void);
709 int	nfs_connect (struct nfsmount *, struct nfsreq *);
710 void	nfs_disconnect (struct nfsmount *);
711 void	nfs_safedisconnect (struct nfsmount *);
712 int	nfs_getattrcache (struct vnode *, struct vattr *);
713 int	nfs_bioread (struct vnode *, struct uio *, int);
714 void	nfsrv_init (int);
715 void	nfs_clearcommit (struct mount *);
716 int	nfsrv_errmap (struct nfsrv_descript *, int);
717 void	nfsrvw_sort (gid_t *, int);
718 void	nfsrv_setcred (struct ucred *, struct ucred *);
719 int	nfsrv_object_create (struct vnode *);
720 void	nfsrv_wakenfsd (struct nfssvc_sock *slp, int nparallel);
721 int	nfsrv_writegather (struct nfsrv_descript **, struct nfssvc_sock *,
722 			       struct thread *, struct mbuf **);
723 int	nfs_fsinfo (struct nfsmount *, struct vnode *, struct thread *p);
724 
725 int	nfsrv3_access (struct nfsrv_descript *nfsd,
726 			   struct nfssvc_sock *slp,
727 			   struct thread *td, struct mbuf **mrq);
728 int	nfsrv_commit (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
729 			  struct thread *td, struct mbuf **mrq);
730 int	nfsrv_create (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
731 			  struct thread *td, struct mbuf **mrq);
732 int	nfsrv_fhtovp (fhandle_t *, int, struct mount **, struct vnode **,
733 			  struct ucred *, struct nfssvc_sock *,
734 			  struct sockaddr *, int *, int, int);
735 int	nfsrv_setpublicfs (struct mount *, struct netexport *,
736 			       struct export_args *);
737 int	nfs_ispublicfh (fhandle_t *);
738 int	nfsrv_fsinfo (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
739 			  struct thread *td, struct mbuf **mrq);
740 int	nfsrv_getattr (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
741 			   struct thread *td, struct mbuf **mrq);
742 int	nfsrv_link (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
743 			struct thread *td, struct mbuf **mrq);
744 int	nfsrv_lookup (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
745 			  struct thread *td, struct mbuf **mrq);
746 int	nfsrv_mkdir (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
747 			 struct thread *td, struct mbuf **mrq);
748 int	nfsrv_mknod (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
749 			 struct thread *td, struct mbuf **mrq);
750 int	nfsrv_noop (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
751 			struct thread *td, struct mbuf **mrq);
752 int	nfsrv_null (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
753 			struct thread *td, struct mbuf **mrq);
754 int	nfsrv_pathconf (struct nfsrv_descript *nfsd,
755 			    struct nfssvc_sock *slp, struct thread *td,
756 			    struct mbuf **mrq);
757 int	nfsrv_read (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
758 			struct thread *td, struct mbuf **mrq);
759 int	nfsrv_readdir (struct nfsrv_descript *nfsd,
760 			   struct nfssvc_sock *slp,
761 			   struct thread *td, struct mbuf **mrq);
762 int	nfsrv_readdirplus (struct nfsrv_descript *nfsd,
763 			       struct nfssvc_sock *slp, struct thread *td,
764 			       struct mbuf **mrq);
765 int	nfsrv_readlink (struct nfsrv_descript *nfsd,
766 			    struct nfssvc_sock *slp, struct thread *td,
767 			    struct mbuf **mrq);
768 int	nfsrv_remove (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
769 			  struct thread *td, struct mbuf **mrq);
770 int	nfsrv_rename (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
771 			  struct thread *td, struct mbuf **mrq);
772 int	nfsrv_rmdir (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
773 			 struct thread *td, struct mbuf **mrq);
774 int	nfsrv_setattr (struct nfsrv_descript *nfsd,
775 			   struct nfssvc_sock *slp,
776 			   struct thread *td, struct mbuf **mrq);
777 int	nfsrv_statfs (struct nfsrv_descript *nfsd,
778 			  struct nfssvc_sock *slp,
779 			  struct thread *td, struct mbuf **mrq);
780 int	nfsrv_symlink (struct nfsrv_descript *nfsd,
781 			   struct nfssvc_sock *slp,
782 			   struct thread *td, struct mbuf **mrq);
783 int	nfsrv_write (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
784 			 struct thread *td, struct mbuf **mrq);
785 void	nfsrv_rcv (struct socket *so, void *arg, int waitflag);
786 void	nfsrv_rcv_upcall (struct socket *so, void *arg, int waitflag);
787 void	nfsrv_slpderef (struct nfssvc_sock *slp);
788 void	nfsrv_slpref (struct nfssvc_sock *slp);
789 int	nfs_meta_setsize (struct vnode *vp, struct thread *td,
790 			off_t nbase, int trivial);
791 int	nfs_clientd(struct nfsmount *nmp, struct ucred *cred,
792 			struct nfsd_cargs *ncd, int flag, caddr_t argp,
793 			struct thread *td);
794 void	nfssvc_iod_reader(void *arg);
795 void	nfssvc_iod_writer(void *arg);
796 void	nfssvc_iod_stop1(struct nfsmount *nmp);
797 void	nfssvc_iod_stop2(struct nfsmount *nmp);
798 void	nfssvc_iod_writer_wakeup(struct nfsmount *nmp);
799 void	nfssvc_iod_reader_wakeup(struct nfsmount *nmp);
800 
801 #endif	/* _KERNEL */
802 
803 #endif
804