xref: /freebsd/sys/fs/nfs/nfsport.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Rick Macklem at The University of Guelph.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $FreeBSD$
35  */
36 
37 #ifndef _NFS_NFSPORT_H_
38 #define	_NFS_NFSPORT_H_
39 
40 /*
41  * In general, I'm not fond of #includes in .h files, but this seems
42  * to be the cleanest way to handle #include files for the ports.
43  */
44 #ifdef _KERNEL
45 #include <sys/unistd.h>
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/conf.h>
49 #include <sys/dirent.h>
50 #include <sys/domain.h>
51 #include <sys/fcntl.h>
52 #include <sys/file.h>
53 #include <sys/filedesc.h>
54 #include <sys/jail.h>
55 #include <sys/kernel.h>
56 #include <sys/lockf.h>
57 #include <sys/malloc.h>
58 #include <sys/mbuf.h>
59 #include <sys/mount.h>
60 #include <sys/mutex.h>
61 #include <sys/namei.h>
62 #include <sys/proc.h>
63 #include <sys/protosw.h>
64 #include <sys/reboot.h>
65 #include <sys/resourcevar.h>
66 #include <sys/signalvar.h>
67 #include <sys/socket.h>
68 #include <sys/socketvar.h>
69 #include <sys/stat.h>
70 #include <sys/syslog.h>
71 #include <sys/sysproto.h>
72 #include <sys/time.h>
73 #include <sys/uio.h>
74 #include <sys/vnode.h>
75 #include <sys/bio.h>
76 #include <sys/buf.h>
77 #include <sys/acl.h>
78 #include <sys/module.h>
79 #include <sys/sysent.h>
80 #include <sys/syscall.h>
81 #include <sys/priv.h>
82 #include <sys/kthread.h>
83 #include <sys/syscallsubr.h>
84 #include <net/if.h>
85 #include <net/if_var.h>
86 #include <net/radix.h>
87 #include <net/route.h>
88 #include <net/if_dl.h>
89 #include <netinet/in.h>
90 #include <netinet/in_pcb.h>
91 #include <netinet/in_systm.h>
92 #include <netinet/in_var.h>
93 #include <netinet/ip.h>
94 #include <netinet/ip_var.h>
95 #include <netinet/tcp.h>
96 #include <netinet/tcp_fsm.h>
97 #include <netinet/tcp_seq.h>
98 #include <netinet/tcp_timer.h>
99 #include <netinet/tcp_var.h>
100 #include <machine/in_cksum.h>
101 #include <sys/md5.h>
102 #include <rpc/rpc.h>
103 #include <rpc/rpcsec_gss.h>
104 
105 #include <ufs/ufs/dir.h>
106 #include <ufs/ufs/quota.h>
107 #include <ufs/ufs/inode.h>
108 #include <ufs/ufs/extattr.h>
109 #include <ufs/ufs/ufsmount.h>
110 #include <vm/uma.h>
111 #include <vm/vm.h>
112 #include <vm/pmap.h>
113 #include <vm/vm_extern.h>
114 #include <vm/vm_object.h>
115 #include <vm/vm_page.h>
116 #include <vm/vm_pageout.h>
117 #include <vm/vm_param.h>
118 #include <nfs/nfssvc.h>
119 #include "opt_nfs.h"
120 #include "opt_ufs.h"
121 
122 /*
123  * These types must be defined before the nfs includes.
124  */
125 #define	NFSSOCKADDR_T	struct sockaddr *
126 #define	NFSPROC_T	struct thread
127 #define	NFSDEV_T	dev_t
128 #define	NFSSVCARGS	nfssvc_args
129 #define	NFSACL_T	struct acl
130 
131 /*
132  * These should be defined as the types used for the corresponding VOP's
133  * argument type.
134  */
135 #define	NFS_ACCESS_ARGS		struct vop_access_args
136 #define	NFS_OPEN_ARGS		struct vop_open_args
137 #define	NFS_GETATTR_ARGS	struct vop_getattr_args
138 #define	NFS_LOOKUP_ARGS		struct vop_lookup_args
139 #define	NFS_READDIR_ARGS	struct vop_readdir_args
140 
141 /*
142  * Allocate mbufs. Must succeed and never set the mbuf ptr to NULL.
143  */
144 #define	NFSMGET(m)	do { 					\
145 		MGET((m), M_WAITOK, MT_DATA); 			\
146 		while ((m) == NULL ) { 				\
147 			(void) nfs_catnap(PZERO, 0, "nfsmget");	\
148 			MGET((m), M_WAITOK, MT_DATA); 		\
149 		} 						\
150 	} while (0)
151 #define	NFSMGETHDR(m)	do { 					\
152 		MGETHDR((m), M_WAITOK, MT_DATA);		\
153 		while ((m) == NULL ) { 				\
154 			(void) nfs_catnap(PZERO, 0, "nfsmget");	\
155 			MGETHDR((m), M_WAITOK, MT_DATA); 	\
156 		} 						\
157 	} while (0)
158 #define	NFSMCLGET(m, w)	do { 					\
159 		MGET((m), M_WAITOK, MT_DATA); 			\
160 		while ((m) == NULL ) { 				\
161 			(void) nfs_catnap(PZERO, 0, "nfsmget");	\
162 			MGET((m), M_WAITOK, MT_DATA); 		\
163 		} 						\
164 		MCLGET((m), (w));				\
165 	} while (0)
166 #define	NFSMCLGETHDR(m, w) do { 				\
167 		MGETHDR((m), M_WAITOK, MT_DATA);		\
168 		while ((m) == NULL ) { 				\
169 			(void) nfs_catnap(PZERO, 0, "nfsmget");	\
170 			MGETHDR((m), M_WAITOK, MT_DATA); 	\
171 		} 						\
172 	} while (0)
173 
174 /*
175  * Client side constant for size of a lockowner name.
176  */
177 #define	NFSV4CL_LOCKNAMELEN	12
178 
179 /*
180  * Type for a mutex lock.
181  */
182 #define	NFSMUTEX_T		struct mtx
183 
184 #endif	/* _KERNEL */
185 
186 /*
187  * NFSv4 Operation numbers.
188  */
189 #define	NFSV4OP_ACCESS		3
190 #define	NFSV4OP_CLOSE		4
191 #define	NFSV4OP_COMMIT		5
192 #define	NFSV4OP_CREATE		6
193 #define	NFSV4OP_DELEGPURGE	7
194 #define	NFSV4OP_DELEGRETURN	8
195 #define	NFSV4OP_GETATTR		9
196 #define	NFSV4OP_GETFH		10
197 #define	NFSV4OP_LINK		11
198 #define	NFSV4OP_LOCK		12
199 #define	NFSV4OP_LOCKT		13
200 #define	NFSV4OP_LOCKU		14
201 #define	NFSV4OP_LOOKUP		15
202 #define	NFSV4OP_LOOKUPP		16
203 #define	NFSV4OP_NVERIFY		17
204 #define	NFSV4OP_OPEN		18
205 #define	NFSV4OP_OPENATTR	19
206 #define	NFSV4OP_OPENCONFIRM	20
207 #define	NFSV4OP_OPENDOWNGRADE	21
208 #define	NFSV4OP_PUTFH		22
209 #define	NFSV4OP_PUTPUBFH	23
210 #define	NFSV4OP_PUTROOTFH	24
211 #define	NFSV4OP_READ		25
212 #define	NFSV4OP_READDIR		26
213 #define	NFSV4OP_READLINK	27
214 #define	NFSV4OP_REMOVE		28
215 #define	NFSV4OP_RENAME		29
216 #define	NFSV4OP_RENEW		30
217 #define	NFSV4OP_RESTOREFH	31
218 #define	NFSV4OP_SAVEFH		32
219 #define	NFSV4OP_SECINFO		33
220 #define	NFSV4OP_SETATTR		34
221 #define	NFSV4OP_SETCLIENTID	35
222 #define	NFSV4OP_SETCLIENTIDCFRM	36
223 #define	NFSV4OP_VERIFY		37
224 #define	NFSV4OP_WRITE		38
225 #define	NFSV4OP_RELEASELCKOWN	39
226 
227 /*
228  * Must be one greater than the last Operation#.
229  */
230 #define	NFSV4OP_NOPS		40
231 
232 /*
233  * Additional Ops for NFSv4.1.
234  */
235 #define	NFSV4OP_BACKCHANNELCTL	40
236 #define	NFSV4OP_BINDCONNTOSESS	41
237 #define	NFSV4OP_EXCHANGEID	42
238 #define	NFSV4OP_CREATESESSION	43
239 #define	NFSV4OP_DESTROYSESSION	44
240 #define	NFSV4OP_FREESTATEID	45
241 #define	NFSV4OP_GETDIRDELEG	46
242 #define	NFSV4OP_GETDEVINFO	47
243 #define	NFSV4OP_GETDEVLIST	48
244 #define	NFSV4OP_LAYOUTCOMMIT	49
245 #define	NFSV4OP_LAYOUTGET	50
246 #define	NFSV4OP_LAYOUTRETURN	51
247 #define	NFSV4OP_SECINFONONAME	52
248 #define	NFSV4OP_SEQUENCE	53
249 #define	NFSV4OP_SETSSV		54
250 #define	NFSV4OP_TESTSTATEID	55
251 #define	NFSV4OP_WANTDELEG	56
252 #define	NFSV4OP_DESTROYCLIENTID	57
253 #define	NFSV4OP_RECLAIMCOMPL	58
254 
255 /*
256  * Must be one more than last op#.
257  */
258 #define	NFSV41_NOPS		59
259 
260 /*
261  * Additional operations for NFSv4.2.
262  */
263 #define	NFSV4OP_ALLOCATE	59
264 #define	NFSV4OP_COPY		60
265 #define	NFSV4OP_COPYNOTIFY	61
266 #define	NFSV4OP_DEALLOCATE	62
267 #define	NFSV4OP_IOADVISE	63
268 #define	NFSV4OP_LAYOUTERROR	64
269 #define	NFSV4OP_LAYOUTSTATS	65
270 #define	NFSV4OP_OFFLOADCANCEL	66
271 #define	NFSV4OP_OFFLOADSTATUS	67
272 #define	NFSV4OP_READPLUS	68
273 #define	NFSV4OP_SEEK		69
274 #define	NFSV4OP_WRITESAME	70
275 #define	NFSV4OP_CLONE		71
276 
277 /* One greater than the last Operation # defined in RFC-7862. */
278 #define	NFSV42_PURENOPS		72
279 
280 /* and the optional Extended attribute operations (RFC-8276). */
281 #define	NFSV4OP_GETXATTR	72
282 #define	NFSV4OP_SETXATTR	73
283 #define	NFSV4OP_LISTXATTRS	74
284 #define	NFSV4OP_REMOVEXATTR	75
285 
286 /*
287  * Must be one more than the last NFSv4.2 op#.
288  */
289 #define	NFSV42_NOPS		76
290 
291 /* Quirky case if the illegal op code */
292 #define	NFSV4OP_OPILLEGAL	10044
293 
294 /*
295  * Fake NFSV4OP_xxx used for nfsstat. Start at NFSV42_NOPS.
296  */
297 #define	NFSV4OP_SYMLINK		(NFSV42_NOPS)
298 #define	NFSV4OP_MKDIR		(NFSV42_NOPS + 1)
299 #define	NFSV4OP_RMDIR		(NFSV42_NOPS + 2)
300 #define	NFSV4OP_READDIRPLUS	(NFSV42_NOPS + 3)
301 #define	NFSV4OP_MKNOD		(NFSV42_NOPS + 4)
302 #define	NFSV4OP_FSSTAT		(NFSV42_NOPS + 5)
303 #define	NFSV4OP_FSINFO		(NFSV42_NOPS + 6)
304 #define	NFSV4OP_PATHCONF	(NFSV42_NOPS + 7)
305 #define	NFSV4OP_V3CREATE	(NFSV42_NOPS + 8)
306 
307 /*
308  * This is the count of the fake operations listed above.
309  */
310 #define	NFSV4OP_FAKENOPS	9
311 
312 /*
313  * and the Callback OPs
314  */
315 #define	NFSV4OP_CBGETATTR	3
316 #define	NFSV4OP_CBRECALL	4
317 
318 /*
319  * Must be one greater than the last Callback Operation# for NFSv4.0.
320  */
321 #define	NFSV4OP_CBNOPS		5
322 
323 /*
324  * Additional Callback Ops for NFSv4.1 only.
325  */
326 #define	NFSV4OP_CBLAYOUTRECALL	5
327 #define	NFSV4OP_CBNOTIFY	6
328 #define	NFSV4OP_CBPUSHDELEG	7
329 #define	NFSV4OP_CBRECALLANY	8
330 #define	NFSV4OP_CBRECALLOBJAVAIL 9
331 #define	NFSV4OP_CBRECALLSLOT	10
332 #define	NFSV4OP_CBSEQUENCE	11
333 #define	NFSV4OP_CBWANTCANCELLED	12
334 #define	NFSV4OP_CBNOTIFYLOCK	13
335 #define	NFSV4OP_CBNOTIFYDEVID	14
336 
337 #define	NFSV41_CBNOPS		15
338 
339 /*
340  * Additional callback operations for NFSv4.2.
341  */
342 #define	NFSV4OP_CBOFFLOAD	15
343 
344 #define	NFSV42_CBNOPS		16
345 
346 /*
347  * The lower numbers -> 21 are used by NFSv2 and v3. These define higher
348  * numbers used by NFSv4.
349  * NFS_V3NPROCS is one greater than the last V3 op and NFS_NPROCS is
350  * one greater than the last number.
351  */
352 #ifndef	NFS_V3NPROCS
353 #define	NFS_V3NPROCS		22
354 
355 #define	NFSPROC_LOOKUPP		22
356 #define	NFSPROC_SETCLIENTID	23
357 #define	NFSPROC_SETCLIENTIDCFRM	24
358 #define	NFSPROC_LOCK		25
359 #define	NFSPROC_LOCKU		26
360 #define	NFSPROC_OPEN		27
361 #define	NFSPROC_CLOSE		28
362 #define	NFSPROC_OPENCONFIRM	29
363 #define	NFSPROC_LOCKT		30
364 #define	NFSPROC_OPENDOWNGRADE	31
365 #define	NFSPROC_RENEW		32
366 #define	NFSPROC_PUTROOTFH	33
367 #define	NFSPROC_RELEASELCKOWN	34
368 #define	NFSPROC_DELEGRETURN	35
369 #define	NFSPROC_RETDELEGREMOVE	36
370 #define	NFSPROC_RETDELEGRENAME1	37
371 #define	NFSPROC_RETDELEGRENAME2	38
372 #define	NFSPROC_GETACL		39
373 #define	NFSPROC_SETACL		40
374 
375 /*
376  * Must be defined as one higher than the last Proc# above.
377  */
378 #define	NFSV4_NPROCS		41
379 
380 /* Additional procedures for NFSv4.1. */
381 #define	NFSPROC_EXCHANGEID	41
382 #define	NFSPROC_CREATESESSION	42
383 #define	NFSPROC_DESTROYSESSION	43
384 #define	NFSPROC_DESTROYCLIENT	44
385 #define	NFSPROC_FREESTATEID	45
386 #define	NFSPROC_LAYOUTGET	46
387 #define	NFSPROC_GETDEVICEINFO	47
388 #define	NFSPROC_LAYOUTCOMMIT	48
389 #define	NFSPROC_LAYOUTRETURN	49
390 #define	NFSPROC_RECLAIMCOMPL	50
391 #define	NFSPROC_WRITEDS		51
392 #define	NFSPROC_READDS		52
393 #define	NFSPROC_COMMITDS	53
394 #define	NFSPROC_OPENLAYGET	54
395 #define	NFSPROC_CREATELAYGET	55
396 
397 /*
398  * Must be defined as one higher than the last NFSv4.1 Proc# above.
399  */
400 #define	NFSV41_NPROCS		56
401 
402 /* Additional procedures for NFSv4.2. */
403 #define	NFSPROC_IOADVISE	56
404 #define	NFSPROC_ALLOCATE	57
405 #define	NFSPROC_COPY		58
406 #define	NFSPROC_SEEK		59
407 #define	NFSPROC_SEEKDS		60
408 
409 /* and the ones for the optional Extended attribute support (RFC-8276). */
410 #define	NFSPROC_GETEXTATTR	61
411 #define	NFSPROC_SETEXTATTR	62
412 #define	NFSPROC_RMEXTATTR	63
413 #define	NFSPROC_LISTEXTATTR	64
414 
415 /* BindConnectionToSession, done by the krpc for a new connection. */
416 #define	NFSPROC_BINDCONNTOSESS	65
417 
418 /* Do a Lookup+Open for "oneopenown". */
419 #define	NFSPROC_LOOKUPOPEN	66
420 
421 /* Do an NFSv4.2 Deallocate. */
422 #define	NFSPROC_DEALLOCATE	67
423 
424 /* Do an NFSv4.2 LayoutError. */
425 #define	NFSPROC_LAYOUTERROR	68
426 
427 /* Do an NFSv4 Verify+Write. */
428 #define	NFSPROC_APPENDWRITE	69
429 
430 /*
431  * Must be defined as one higher than the last NFSv4.2 Proc# above.
432  */
433 #define	NFSV42_NPROCS		70
434 
435 /* Value of NFSV42_NPROCS for old nfsstats structure. (Always 69) */
436 #define	NFSV42_OLDNPROCS	69
437 
438 #endif	/* NFS_V3NPROCS */
439 
440 /*
441  * Newest stats structure.
442  * The vers field will be set to NFSSTATS_V1 by the caller.
443  */
444 #define	NFSSTATS_V1	2
445 struct nfsstatsv1 {
446 	int		vers;	/* Set to version requested by caller. */
447 	uint64_t	attrcache_hits;
448 	uint64_t	attrcache_misses;
449 	uint64_t	lookupcache_hits;
450 	uint64_t	lookupcache_misses;
451 	uint64_t	direofcache_hits;
452 	uint64_t	direofcache_misses;
453 	uint64_t	accesscache_hits;
454 	uint64_t	accesscache_misses;
455 	uint64_t	biocache_reads;
456 	uint64_t	read_bios;
457 	uint64_t	read_physios;
458 	uint64_t	biocache_writes;
459 	uint64_t	write_bios;
460 	uint64_t	write_physios;
461 	uint64_t	biocache_readlinks;
462 	uint64_t	readlink_bios;
463 	uint64_t	biocache_readdirs;
464 	uint64_t	readdir_bios;
465 	uint64_t	rpccnt[NFSV42_NPROCS + 10];
466 	uint64_t	rpcretries;
467 	uint64_t	srvrpccnt[NFSV42_NOPS + NFSV4OP_FAKENOPS + 15];
468 	uint64_t	srvlayouts;
469 	uint64_t	cllayouts;
470 	uint64_t	rpcrequests;
471 	uint64_t	rpctimeouts;
472 	uint64_t	rpcunexpected;
473 	uint64_t	rpcinvalid;
474 	uint64_t	srvcache_inproghits;
475 	uint64_t	reserved_2;
476 	uint64_t	srvcache_nonidemdonehits;
477 	uint64_t	srvcache_misses;
478 	uint64_t	srvcache_tcppeak;
479 	int		srvcache_size;	/* Updated by atomic_xx_int(). */
480 	uint64_t	srvclients;
481 	uint64_t	srvopenowners;
482 	uint64_t	srvopens;
483 	uint64_t	srvlockowners;
484 	uint64_t	srvlocks;
485 	uint64_t	srvdelegates;
486 	uint64_t	cbrpccnt[NFSV42_CBNOPS + 10];
487 	uint64_t	clopenowners;
488 	uint64_t	clopens;
489 	uint64_t	cllockowners;
490 	uint64_t	cllocks;
491 	uint64_t	cldelegates;
492 	uint64_t	cllocalopenowners;
493 	uint64_t	cllocalopens;
494 	uint64_t	cllocallockowners;
495 	uint64_t	cllocallocks;
496 	uint64_t	srvstartcnt;
497 	uint64_t	srvdonecnt;
498 	uint64_t	srvbytes[NFSV42_NOPS + NFSV4OP_FAKENOPS + 15];
499 	uint64_t	srvops[NFSV42_NOPS + NFSV4OP_FAKENOPS + 15];
500 	struct bintime	srvduration[NFSV42_NOPS + NFSV4OP_FAKENOPS + 15];
501 	struct bintime	busyfrom;
502 	struct bintime	busytime;
503 };
504 
505 /*
506  * Newer stats structure.
507  * The vers field will be set to NFSSTATS_OV1 by the caller.
508  */
509 #define	NFSSTATS_OV1	1
510 struct nfsstatsov1 {
511 	int		vers;	/* Set to version requested by caller. */
512 	uint64_t	attrcache_hits;
513 	uint64_t	attrcache_misses;
514 	uint64_t	lookupcache_hits;
515 	uint64_t	lookupcache_misses;
516 	uint64_t	direofcache_hits;
517 	uint64_t	direofcache_misses;
518 	uint64_t	accesscache_hits;
519 	uint64_t	accesscache_misses;
520 	uint64_t	biocache_reads;
521 	uint64_t	read_bios;
522 	uint64_t	read_physios;
523 	uint64_t	biocache_writes;
524 	uint64_t	write_bios;
525 	uint64_t	write_physios;
526 	uint64_t	biocache_readlinks;
527 	uint64_t	readlink_bios;
528 	uint64_t	biocache_readdirs;
529 	uint64_t	readdir_bios;
530 	uint64_t	rpccnt[NFSV42_OLDNPROCS];
531 	uint64_t	rpcretries;
532 	uint64_t	srvrpccnt[NFSV42_PURENOPS + NFSV4OP_FAKENOPS];
533 	uint64_t	reserved_0;
534 	uint64_t	reserved_1;
535 	uint64_t	rpcrequests;
536 	uint64_t	rpctimeouts;
537 	uint64_t	rpcunexpected;
538 	uint64_t	rpcinvalid;
539 	uint64_t	srvcache_inproghits;
540 	uint64_t	reserved_2;
541 	uint64_t	srvcache_nonidemdonehits;
542 	uint64_t	srvcache_misses;
543 	uint64_t	srvcache_tcppeak;
544 	int		srvcache_size;	/* Updated by atomic_xx_int(). */
545 	uint64_t	srvclients;
546 	uint64_t	srvopenowners;
547 	uint64_t	srvopens;
548 	uint64_t	srvlockowners;
549 	uint64_t	srvlocks;
550 	uint64_t	srvdelegates;
551 	uint64_t	cbrpccnt[NFSV42_CBNOPS];
552 	uint64_t	clopenowners;
553 	uint64_t	clopens;
554 	uint64_t	cllockowners;
555 	uint64_t	cllocks;
556 	uint64_t	cldelegates;
557 	uint64_t	cllocalopenowners;
558 	uint64_t	cllocalopens;
559 	uint64_t	cllocallockowners;
560 	uint64_t	cllocallocks;
561 	uint64_t	srvstartcnt;
562 	uint64_t	srvdonecnt;
563 	uint64_t	srvbytes[NFSV42_PURENOPS + NFSV4OP_FAKENOPS];
564 	uint64_t	srvops[NFSV42_PURENOPS + NFSV4OP_FAKENOPS];
565 	struct bintime	srvduration[NFSV42_PURENOPS + NFSV4OP_FAKENOPS];
566 	struct bintime	busyfrom;
567 	struct bintime	busytime;
568 };
569 
570 /*
571  * Old stats structure.
572  */
573 struct ext_nfsstats {
574 	int	attrcache_hits;
575 	int	attrcache_misses;
576 	int	lookupcache_hits;
577 	int	lookupcache_misses;
578 	int	direofcache_hits;
579 	int	direofcache_misses;
580 	int	accesscache_hits;
581 	int	accesscache_misses;
582 	int	biocache_reads;
583 	int	read_bios;
584 	int	read_physios;
585 	int	biocache_writes;
586 	int	write_bios;
587 	int	write_physios;
588 	int	biocache_readlinks;
589 	int	readlink_bios;
590 	int	biocache_readdirs;
591 	int	readdir_bios;
592 	int	rpccnt[NFSV4_NPROCS];
593 	int	rpcretries;
594 	int	srvrpccnt[NFSV4OP_NOPS + NFSV4OP_FAKENOPS];
595 	int	reserved_0;
596 	int	reserved_1;
597 	int	rpcrequests;
598 	int	rpctimeouts;
599 	int	rpcunexpected;
600 	int	rpcinvalid;
601 	int	srvcache_inproghits;
602 	int	reserved_2;
603 	int	srvcache_nonidemdonehits;
604 	int	srvcache_misses;
605 	int	srvcache_tcppeak;
606 	int	srvcache_size;
607 	int	srvclients;
608 	int	srvopenowners;
609 	int	srvopens;
610 	int	srvlockowners;
611 	int	srvlocks;
612 	int	srvdelegates;
613 	int	cbrpccnt[NFSV4OP_CBNOPS];
614 	int	clopenowners;
615 	int	clopens;
616 	int	cllockowners;
617 	int	cllocks;
618 	int	cldelegates;
619 	int	cllocalopenowners;
620 	int	cllocalopens;
621 	int	cllocallockowners;
622 	int	cllocallocks;
623 };
624 
625 #ifdef _KERNEL
626 /*
627  * Define NFS_NPROCS as NFSV4_NPROCS for the experimental kernel code.
628  */
629 #ifndef	NFS_NPROCS
630 #define	NFS_NPROCS		NFSV4_NPROCS
631 #endif
632 
633 #include <fs/nfs/nfskpiport.h>
634 #include <fs/nfs/nfsdport.h>
635 #include <fs/nfs/rpcv2.h>
636 #include <fs/nfs/nfsproto.h>
637 #include <fs/nfs/nfs.h>
638 #include <fs/nfs/nfsclstate.h>
639 #include <fs/nfs/nfs_var.h>
640 #include <fs/nfs/nfsm_subs.h>
641 #include <fs/nfs/nfsrvcache.h>
642 #include <fs/nfs/nfsrvstate.h>
643 #include <fs/nfs/xdr_subs.h>
644 #include <fs/nfs/nfscl.h>
645 #include <nfsclient/nfsargs.h>
646 #include <fs/nfsclient/nfsmount.h>
647 
648 /*
649  * Just to keep nfs_var.h happy.
650  */
651 struct nfs_vattr {
652 	int	junk;
653 };
654 
655 struct nfsvattr {
656 	struct vattr	na_vattr;
657 	nfsattrbit_t	na_suppattr;
658 	u_int64_t	na_mntonfileno;
659 	u_int64_t	na_filesid[2];
660 };
661 
662 #define	na_type		na_vattr.va_type
663 #define	na_mode		na_vattr.va_mode
664 #define	na_nlink	na_vattr.va_nlink
665 #define	na_uid		na_vattr.va_uid
666 #define	na_gid		na_vattr.va_gid
667 #define	na_fsid		na_vattr.va_fsid
668 #define	na_fileid	na_vattr.va_fileid
669 #define	na_size		na_vattr.va_size
670 #define	na_blocksize	na_vattr.va_blocksize
671 #define	na_atime	na_vattr.va_atime
672 #define	na_mtime	na_vattr.va_mtime
673 #define	na_ctime	na_vattr.va_ctime
674 #define	na_btime	na_vattr.va_birthtime
675 #define	na_gen		na_vattr.va_gen
676 #define	na_flags	na_vattr.va_flags
677 #define	na_rdev		na_vattr.va_rdev
678 #define	na_bytes	na_vattr.va_bytes
679 #define	na_filerev	na_vattr.va_filerev
680 #define	na_vaflags	na_vattr.va_vaflags
681 
682 #include <fs/nfsclient/nfsnode.h>
683 
684 /*
685  * This is the header structure used for the lists, etc. (It has the
686  * above record in it.
687  */
688 struct nfsrv_stablefirst {
689 	LIST_HEAD(, nfsrv_stable) nsf_head;	/* Head of nfsrv_stable list */
690 	time_t		nsf_eograce;	/* Time grace period ends */
691 	time_t		*nsf_bootvals;	/* Previous boottime values */
692 	struct file	*nsf_fp;	/* File table pointer */
693 	u_char		nsf_flags;	/* NFSNSF_ flags */
694 	struct nfsf_rec	nsf_rec;	/* and above first record */
695 };
696 #define	nsf_lease	nsf_rec.lease
697 #define	nsf_numboots	nsf_rec.numboots
698 
699 /* NFSNSF_xxx flags */
700 #define	NFSNSF_UPDATEDONE	0x01
701 #define	NFSNSF_GRACEOVER	0x02
702 #define	NFSNSF_NEEDLOCK		0x04
703 #define	NFSNSF_EXPIREDCLIENT	0x08
704 #define	NFSNSF_NOOPENS		0x10
705 #define	NFSNSF_OK		0x20
706 
707 /*
708  * Maximum number of boot times allowed in record. Although there is
709  * really no need for a fixed upper bound, this serves as a sanity check
710  * for a corrupted file.
711  */
712 #define	NFSNSF_MAXNUMBOOTS	10000
713 
714 /*
715  * This structure defines the other records in the file. The
716  * nst_client array is actually the size of the client string name.
717  */
718 struct nfst_rec {
719 	u_int16_t	len;
720 	u_char		flag;
721 	u_char		client[1];
722 };
723 /* and the values for flag */
724 #define	NFSNST_NEWSTATE	0x1
725 #define	NFSNST_REVOKE		0x2
726 #define	NFSNST_GOTSTATE		0x4
727 #define	NFSNST_RECLAIMED	0x8
728 
729 /*
730  * This structure is linked onto nfsrv_stablefirst for the duration of
731  * reclaim.
732  */
733 struct nfsrv_stable {
734 	LIST_ENTRY(nfsrv_stable) nst_list;
735 	struct nfsclient	*nst_clp;
736 	struct nfst_rec		nst_rec;
737 };
738 #define	nst_timestamp	nst_rec.timestamp
739 #define	nst_len		nst_rec.len
740 #define	nst_flag	nst_rec.flag
741 #define	nst_client	nst_rec.client
742 
743 /*
744  * At some point the server will run out of kernel storage for
745  * state structures. For FreeBSD5.2, this results in a panic
746  * kmem_map is full. It happens at well over 1000000 opens plus
747  * locks on a PIII-800 with 256Mbytes, so that is where I've set
748  * the limit. If your server panics due to too many opens/locks,
749  * decrease the size of NFSRV_V4STATELIMIT. If you find the server
750  * returning NFS4ERR_RESOURCE a lot and have lots of memory, try
751  * increasing it.
752  */
753 #define	NFSRV_V4STATELIMIT	500000	/* Max # of Opens + Locks */
754 
755 /*
756  * The type required differs with BSDen (just the second arg).
757  */
758 void nfsrvd_rcv(struct socket *, void *, int);
759 
760 /*
761  * Macros for handling socket addresses. (Hopefully this makes the code
762  * more portable, since I've noticed some 'BSD don't have sockaddrs in
763  * mbufs any more.)
764  */
765 #define	NFSSOCKADDR(a, t)	((t)(a))
766 #define	NFSSOCKADDRSIZE(a, s)		((a)->sa_len = (s))
767 
768 /*
769  * These should be defined as a process or thread structure, as required
770  * for signal handling, etc.
771  */
772 #define	NFSNEWCRED(c)		(crdup(c))
773 #define	NFSPROCCRED(p)		((p)->td_ucred)
774 #define	NFSFREECRED(c)		(crfree(c))
775 #define	NFSUIOPROC(u, p)	((u)->uio_td = NULL)
776 #define	NFSPROCP(p)		((p)->td_proc)
777 
778 /*
779  * Define these so that cn_hash and its length is ignored.
780  */
781 #define	NFSCNHASHZERO(c)
782 #define	NFSCNHASH(c, v)
783 #define	NCHNAMLEN	9999999
784 
785 /*
786  * Handle SMP stuff:
787  */
788 #define	NFSSTATESPINLOCK	extern struct mtx nfs_state_mutex
789 #define	NFSLOCKSTATE()		mtx_lock(&nfs_state_mutex)
790 #define	NFSUNLOCKSTATE()	mtx_unlock(&nfs_state_mutex)
791 #define	NFSSTATEMUTEXPTR	(&nfs_state_mutex)
792 #define	NFSREQSPINLOCK		extern struct mtx nfs_req_mutex
793 #define	NFSLOCKREQ()		mtx_lock(&nfs_req_mutex)
794 #define	NFSUNLOCKREQ()		mtx_unlock(&nfs_req_mutex)
795 #define	NFSSOCKMUTEX		extern struct mtx nfs_slock_mutex
796 #define	NFSSOCKMUTEXPTR		(&nfs_slock_mutex)
797 #define	NFSLOCKSOCK()		mtx_lock(&nfs_slock_mutex)
798 #define	NFSUNLOCKSOCK()		mtx_unlock(&nfs_slock_mutex)
799 #define	NFSNAMEIDMUTEX		extern struct mtx nfs_nameid_mutex
800 #define	NFSNAMEIDMUTEXPTR	(&nfs_nameid_mutex)
801 #define	NFSLOCKNAMEID()		mtx_lock(&nfs_nameid_mutex)
802 #define	NFSUNLOCKNAMEID()	mtx_unlock(&nfs_nameid_mutex)
803 #define	NFSNAMEIDREQUIRED()	mtx_assert(&nfs_nameid_mutex, MA_OWNED)
804 #define	NFSCLSTATEMUTEX		extern struct mtx nfs_clstate_mutex
805 #define	NFSCLSTATEMUTEXPTR	(&nfs_clstate_mutex)
806 #define	NFSLOCKCLSTATE()	mtx_lock(&nfs_clstate_mutex)
807 #define	NFSUNLOCKCLSTATE()	mtx_unlock(&nfs_clstate_mutex)
808 #define	NFSDLOCKMUTEX		extern struct mtx newnfsd_mtx
809 #define	NFSDLOCKMUTEXPTR	(&newnfsd_mtx)
810 #define	NFSD_LOCK()		mtx_lock(&newnfsd_mtx)
811 #define	NFSD_UNLOCK()		mtx_unlock(&newnfsd_mtx)
812 #define	NFSD_LOCK_ASSERT()	mtx_assert(&newnfsd_mtx, MA_OWNED)
813 #define	NFSD_UNLOCK_ASSERT()	mtx_assert(&newnfsd_mtx, MA_NOTOWNED)
814 #define	NFSV4ROOTLOCKMUTEX	extern struct mtx nfs_v4root_mutex
815 #define	NFSV4ROOTLOCKMUTEXPTR	(&nfs_v4root_mutex)
816 #define	NFSLOCKV4ROOTMUTEX()	mtx_lock(&nfs_v4root_mutex)
817 #define	NFSUNLOCKV4ROOTMUTEX()	mtx_unlock(&nfs_v4root_mutex)
818 #define	NFSLOCKNODE(n)		mtx_lock(&((n)->n_mtx))
819 #define	NFSUNLOCKNODE(n)	mtx_unlock(&((n)->n_mtx))
820 #define	NFSASSERTNODE(n)	mtx_assert(&((n)->n_mtx), MA_OWNED)
821 #define	NFSLOCKMNT(m)		mtx_lock(&((m)->nm_mtx))
822 #define	NFSUNLOCKMNT(m)		mtx_unlock(&((m)->nm_mtx))
823 #define	NFSLOCKIOD()		mtx_lock(&ncl_iod_mutex)
824 #define	NFSUNLOCKIOD()		mtx_unlock(&ncl_iod_mutex)
825 #define	NFSASSERTIOD()		mtx_assert(&ncl_iod_mutex, MA_OWNED)
826 #define	NFSLOCKREQUEST(r)	mtx_lock(&((r)->r_mtx))
827 #define	NFSUNLOCKREQUEST(r)	mtx_unlock(&((r)->r_mtx))
828 #define	NFSLOCKSOCKREQ(r)	mtx_lock(&((r)->nr_mtx))
829 #define	NFSUNLOCKSOCKREQ(r)	mtx_unlock(&((r)->nr_mtx))
830 #define	NFSLOCKDS(d)		mtx_lock(&((d)->nfsclds_mtx))
831 #define	NFSUNLOCKDS(d)		mtx_unlock(&((d)->nfsclds_mtx))
832 #define	NFSSESSIONMUTEXPTR(s)	(&((s)->mtx))
833 #define	NFSLOCKSESSION(s)	mtx_lock(&((s)->mtx))
834 #define	NFSUNLOCKSESSION(s)	mtx_unlock(&((s)->mtx))
835 #define	NFSLAYOUTMUTEXPTR(l)	(&((l)->mtx))
836 #define	NFSLOCKLAYOUT(l)	mtx_lock(&((l)->mtx))
837 #define	NFSUNLOCKLAYOUT(l)	mtx_unlock(&((l)->mtx))
838 #define	NFSDDSMUTEXPTR		(&nfsrv_dslock_mtx)
839 #define	NFSDDSLOCK()		mtx_lock(&nfsrv_dslock_mtx)
840 #define	NFSDDSUNLOCK()		mtx_unlock(&nfsrv_dslock_mtx)
841 #define	NFSDDONTLISTMUTEXPTR	(&nfsrv_dontlistlock_mtx)
842 #define	NFSDDONTLISTLOCK()	mtx_lock(&nfsrv_dontlistlock_mtx)
843 #define	NFSDDONTLISTUNLOCK()	mtx_unlock(&nfsrv_dontlistlock_mtx)
844 #define	NFSDRECALLMUTEXPTR	(&nfsrv_recalllock_mtx)
845 #define	NFSDRECALLLOCK()	mtx_lock(&nfsrv_recalllock_mtx)
846 #define	NFSDRECALLUNLOCK()	mtx_unlock(&nfsrv_recalllock_mtx)
847 
848 /*
849  * Use these macros to initialize/free a mutex.
850  */
851 #define	NFSINITSOCKMUTEX(m)	mtx_init((m), "nfssock", NULL, MTX_DEF)
852 #define	NFSFREEMUTEX(m)		mtx_destroy((m))
853 
854 int nfsmsleep(void *, void *, int, const char *, struct timespec *);
855 
856 /*
857  * And weird vm stuff in the nfs server.
858  */
859 #define	PDIRUNLOCK	0x0
860 #define	MAX_COMMIT_COUNT	(1024 * 1024)
861 
862 /*
863  * Define these to handle the type of va_rdev.
864  */
865 #define	NFSMAKEDEV(m, n)	makedev((m), (n))
866 #define	NFSMAJOR(d)		major(d)
867 #define	NFSMINOR(d)		minor(d)
868 
869 /*
870  * The vnode tag for nfsv4root.
871  */
872 #define	VT_NFSV4ROOT		"nfsv4root"
873 
874 /*
875  * Define whatever it takes to do a vn_rdwr().
876  */
877 #define	NFSD_RDWR(r, v, b, l, o, s, i, c, a, p) \
878 	vn_rdwr((r), (v), (b), (l), (o), (s), (i), (c), NULL, (a), (p))
879 
880 /*
881  * Macros for handling memory for different BSDen.
882  * NFSBCOPY(src, dst, len) - copies len bytes, non-overlapping
883  * NFSOVBCOPY(src, dst, len) - ditto, but data areas might overlap
884  * NFSBCMP(cp1, cp2, len) - compare len bytes, return 0 if same
885  * NFSBZERO(cp, len) - set len bytes to 0x0
886  */
887 #define	NFSBCOPY(s, d, l)	bcopy((s), (d), (l))
888 #define	NFSOVBCOPY(s, d, l)	ovbcopy((s), (d), (l))
889 #define	NFSBCMP(s, d, l)	bcmp((s), (d), (l))
890 #define	NFSBZERO(s, l)		bzero((s), (l))
891 
892 /*
893  * Some queue.h files don't have these dfined in them.
894  */
895 #ifndef LIST_END
896 #define	LIST_END(head)		NULL
897 #define	SLIST_END(head)		NULL
898 #define	TAILQ_END(head)		NULL
899 #endif
900 
901 /*
902  * This must be defined to be a global variable that increments once
903  * per second, but never stops or goes backwards, even when a "date"
904  * command changes the TOD clock. It is used for delta times for
905  * leases, etc.
906  */
907 #define	NFSD_MONOSEC		time_uptime
908 
909 /*
910  * Declare the malloc types.
911  */
912 MALLOC_DECLARE(M_NEWNFSRVCACHE);
913 MALLOC_DECLARE(M_NEWNFSDCLIENT);
914 MALLOC_DECLARE(M_NEWNFSDSTATE);
915 MALLOC_DECLARE(M_NEWNFSDLOCK);
916 MALLOC_DECLARE(M_NEWNFSDLOCKFILE);
917 MALLOC_DECLARE(M_NEWNFSSTRING);
918 MALLOC_DECLARE(M_NEWNFSUSERGROUP);
919 MALLOC_DECLARE(M_NEWNFSDREQ);
920 MALLOC_DECLARE(M_NEWNFSFH);
921 MALLOC_DECLARE(M_NEWNFSCLOWNER);
922 MALLOC_DECLARE(M_NEWNFSCLOPEN);
923 MALLOC_DECLARE(M_NEWNFSCLDELEG);
924 MALLOC_DECLARE(M_NEWNFSCLCLIENT);
925 MALLOC_DECLARE(M_NEWNFSCLLOCKOWNER);
926 MALLOC_DECLARE(M_NEWNFSCLLOCK);
927 MALLOC_DECLARE(M_NEWNFSDIROFF);
928 MALLOC_DECLARE(M_NEWNFSV4NODE);
929 MALLOC_DECLARE(M_NEWNFSDIRECTIO);
930 MALLOC_DECLARE(M_NEWNFSMNT);
931 MALLOC_DECLARE(M_NEWNFSDROLLBACK);
932 MALLOC_DECLARE(M_NEWNFSLAYOUT);
933 MALLOC_DECLARE(M_NEWNFSFLAYOUT);
934 MALLOC_DECLARE(M_NEWNFSDEVINFO);
935 MALLOC_DECLARE(M_NEWNFSSOCKREQ);
936 MALLOC_DECLARE(M_NEWNFSCLDS);
937 MALLOC_DECLARE(M_NEWNFSLAYRECALL);
938 MALLOC_DECLARE(M_NEWNFSDSESSION);
939 #define	M_NFSRVCACHE	M_NEWNFSRVCACHE
940 #define	M_NFSDCLIENT	M_NEWNFSDCLIENT
941 #define	M_NFSDSTATE	M_NEWNFSDSTATE
942 #define	M_NFSDLOCK	M_NEWNFSDLOCK
943 #define	M_NFSDLOCKFILE	M_NEWNFSDLOCKFILE
944 #define	M_NFSSTRING	M_NEWNFSSTRING
945 #define	M_NFSUSERGROUP	M_NEWNFSUSERGROUP
946 #define	M_NFSDREQ	M_NEWNFSDREQ
947 #define	M_NFSFH		M_NEWNFSFH
948 #define	M_NFSCLOWNER	M_NEWNFSCLOWNER
949 #define	M_NFSCLOPEN	M_NEWNFSCLOPEN
950 #define	M_NFSCLDELEG	M_NEWNFSCLDELEG
951 #define	M_NFSCLCLIENT	M_NEWNFSCLCLIENT
952 #define	M_NFSCLLOCKOWNER M_NEWNFSCLLOCKOWNER
953 #define	M_NFSCLLOCK	M_NEWNFSCLLOCK
954 #define	M_NFSDIROFF	M_NEWNFSDIROFF
955 #define	M_NFSV4NODE	M_NEWNFSV4NODE
956 #define	M_NFSDIRECTIO	M_NEWNFSDIRECTIO
957 #define	M_NFSDROLLBACK	M_NEWNFSDROLLBACK
958 #define	M_NFSLAYOUT	M_NEWNFSLAYOUT
959 #define	M_NFSFLAYOUT	M_NEWNFSFLAYOUT
960 #define	M_NFSDEVINFO	M_NEWNFSDEVINFO
961 #define	M_NFSSOCKREQ	M_NEWNFSSOCKREQ
962 #define	M_NFSCLDS	M_NEWNFSCLDS
963 #define	M_NFSLAYRECALL	M_NEWNFSLAYRECALL
964 #define	M_NFSDSESSION	M_NEWNFSDSESSION
965 
966 #define	NFSINT_SIGMASK(set) 						\
967 	(SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||	\
968 	 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||	\
969 	 SIGISMEMBER(set, SIGQUIT))
970 
971 /*
972  * Convert a quota block count to byte count.
973  */
974 #define	NFSQUOTABLKTOBYTE(q, b)	(q) *= (b)
975 
976 /*
977  * Define this as the largest file size supported. (It should probably
978  * be available via a VFS_xxx Op, but it isn't.
979  */
980 #define	NFSRV_MAXFILESIZE	((u_int64_t)0x800000000000)
981 
982 /*
983  * Set this macro to index() or strchr(), whichever is supported.
984  */
985 #define	STRCHR(s, c)		strchr((s), (c))
986 
987 /*
988  * Set the n_time in the client write rpc, as required.
989  */
990 #define	NFSWRITERPC_SETTIME(w, n, a, v4)				\
991 	do {								\
992 		if (w) {						\
993 			NFSLOCKNODE(n);					\
994 			(n)->n_mtime = (a)->na_mtime;			\
995 			if (v4)						\
996 				(n)->n_change = (a)->na_filerev;	\
997 			NFSUNLOCKNODE(n);				\
998 		}							\
999 	} while (0)
1000 
1001 /*
1002  * Fake value, just to make the client work.
1003  */
1004 #define	NFS_LATTR_NOSHRINK	1
1005 
1006 /*
1007  * Prototypes for functions where the arguments vary for different ports.
1008  */
1009 int nfscl_loadattrcache(struct vnode **, struct nfsvattr *, void *, int, int);
1010 int newnfs_realign(struct mbuf **, int);
1011 bool ncl_pager_setsize(struct vnode *vp, u_quad_t *nsizep);
1012 void ncl_copy_vattr(struct vattr *dst, struct vattr *src);
1013 
1014 /*
1015  * If the port runs on an SMP box that can enforce Atomic ops with low
1016  * overheads, define these as atomic increments/decrements. If not,
1017  * don't worry about it, since these are used for stats that can be
1018  * "out by one" without disastrous consequences.
1019  */
1020 #define	NFSINCRGLOBAL(a)	((a)++)
1021 #define	NFSDECRGLOBAL(a)	((a)--)
1022 
1023 /*
1024  * Assorted funky stuff to make things work under Darwin8.
1025  */
1026 /*
1027  * These macros checks for a field in vattr being set.
1028  */
1029 #define	NFSATTRISSET(t, v, a)	((v)->a != (t)VNOVAL)
1030 #define	NFSATTRISSETTIME(v, a)	((v)->a.tv_sec != VNOVAL)
1031 
1032 /*
1033  * Manipulate mount flags.
1034  */
1035 #define	NFSSTA_HASWRITEVERF	0x00040000  /* Has write verifier */
1036 #define	NFSSTA_GOTFSINFO	0x00100000  /* Got the fsinfo */
1037 #define	NFSSTA_OPENMODE		0x00200000  /* Must use correct open mode */
1038 #define	NFSSTA_FLEXFILE		0x00800000  /* Use Flex File Layout */
1039 #define	NFSSTA_NOLAYOUTCOMMIT	0x04000000  /* Don't do LayoutCommit */
1040 #define	NFSSTA_SESSPERSIST	0x08000000  /* Has a persistent session */
1041 #define	NFSSTA_TIMEO		0x10000000  /* Experiencing a timeout */
1042 #define	NFSSTA_LOCKTIMEO	0x20000000  /* Experiencing a lockd timeout */
1043 #define	NFSSTA_HASSETFSID	0x40000000  /* Has set the fsid */
1044 #define	NFSSTA_PNFS		0x80000000  /* pNFS is enabled */
1045 
1046 #define	NFSHASNFSV3(n)		((n)->nm_flag & NFSMNT_NFSV3)
1047 #define	NFSHASNFSV4(n)		((n)->nm_flag & NFSMNT_NFSV4)
1048 #define	NFSHASNFSV4N(n)		((n)->nm_minorvers > 0)
1049 #define	NFSHASNFSV3OR4(n)	((n)->nm_flag & (NFSMNT_NFSV3 | NFSMNT_NFSV4))
1050 #define	NFSHASGOTFSINFO(n)	((n)->nm_state & NFSSTA_GOTFSINFO)
1051 #define	NFSHASHASSETFSID(n)	((n)->nm_state & NFSSTA_HASSETFSID)
1052 #define	NFSHASSTRICT3530(n)	((n)->nm_flag & NFSMNT_STRICT3530)
1053 #define	NFSHASWRITEVERF(n)	((n)->nm_state & NFSSTA_HASWRITEVERF)
1054 #define	NFSHASINT(n)		((n)->nm_flag & NFSMNT_INT)
1055 #define	NFSHASSOFT(n)		((n)->nm_flag & NFSMNT_SOFT)
1056 #define	NFSHASINTORSOFT(n)	((n)->nm_flag & (NFSMNT_INT | NFSMNT_SOFT))
1057 #define	NFSHASDUMBTIMR(n)	((n)->nm_flag & NFSMNT_DUMBTIMR)
1058 #define	NFSHASNOCONN(n)		((n)->nm_flag & NFSMNT_MNTD)
1059 #define	NFSHASKERB(n)		((n)->nm_flag & NFSMNT_KERB)
1060 #define	NFSHASALLGSSNAME(n)	((n)->nm_flag & NFSMNT_ALLGSSNAME)
1061 #define	NFSHASINTEGRITY(n)	((n)->nm_flag & NFSMNT_INTEGRITY)
1062 #define	NFSHASPRIVACY(n)	((n)->nm_flag & NFSMNT_PRIVACY)
1063 #define	NFSSETWRITEVERF(n)	((n)->nm_state |= NFSSTA_HASWRITEVERF)
1064 #define	NFSSETHASSETFSID(n)	((n)->nm_state |= NFSSTA_HASSETFSID)
1065 #define	NFSHASPNFSOPT(n)	((n)->nm_flag & NFSMNT_PNFS)
1066 #define	NFSHASNOLAYOUTCOMMIT(n)	((n)->nm_state & NFSSTA_NOLAYOUTCOMMIT)
1067 #define	NFSHASSESSPERSIST(n)	((n)->nm_state & NFSSTA_SESSPERSIST)
1068 #define	NFSHASPNFS(n)		((n)->nm_state & NFSSTA_PNFS)
1069 #define	NFSHASFLEXFILE(n)	((n)->nm_state & NFSSTA_FLEXFILE)
1070 #define	NFSHASOPENMODE(n)	((n)->nm_state & NFSSTA_OPENMODE)
1071 #define	NFSHASONEOPENOWN(n)	(((n)->nm_flag & NFSMNT_ONEOPENOWN) != 0 &&	\
1072 				    (n)->nm_minorvers > 0)
1073 #define	NFSHASTLS(n)		(((n)->nm_newflag & NFSMNT_TLS) != 0)
1074 
1075 /*
1076  * Set boottime.
1077  */
1078 #define	NFSSETBOOTTIME(b)	(getboottime(&b))
1079 
1080 /*
1081  * The size of directory blocks in the buffer cache.
1082  * MUST BE in the range of PAGE_SIZE <= NFS_DIRBLKSIZ <= MAXBSIZE!!
1083  */
1084 #define	NFS_DIRBLKSIZ	(16 * DIRBLKSIZ) /* Must be a multiple of DIRBLKSIZ */
1085 
1086 /*
1087  * Define these macros to access mnt_flag fields.
1088  */
1089 #define	NFSMNT_RDONLY(m)	((m)->mnt_flag & MNT_RDONLY)
1090 #endif	/* _KERNEL */
1091 
1092 /*
1093  * Define a structure similar to ufs_args for use in exporting the V4 root.
1094  */
1095 struct nfsex_args {
1096 	char	*fspec;
1097 	struct export_args	export;
1098 };
1099 
1100 struct nfsex_oldargs {
1101 	char	*fspec;
1102 	struct o2export_args	export;
1103 };
1104 
1105 /*
1106  * These export flags should be defined, but there are no bits left.
1107  * Maybe a separate mnt_exflag field could be added or the mnt_flag
1108  * field increased to 64 bits?
1109  */
1110 #ifndef	MNT_EXSTRICTACCESS
1111 #define	MNT_EXSTRICTACCESS	0x0
1112 #endif
1113 #ifndef MNT_EXV4ONLY
1114 #define	MNT_EXV4ONLY		0x0
1115 #endif
1116 
1117 #ifdef _KERNEL
1118 /*
1119  * Define this to invalidate the attribute cache for the nfs node.
1120  */
1121 #define	NFSINVALATTRCACHE(n)	((n)->n_attrstamp = 0)
1122 
1123 /* Used for FreeBSD only */
1124 void nfsd_mntinit(void);
1125 
1126 /*
1127  * Define these for vnode lock/unlock ops.
1128  *
1129  * These are good abstractions to macro out, so that they can be added to
1130  * later, for debugging or stats, etc.
1131  */
1132 #define	NFSVOPLOCK(v, f)	vn_lock((v), (f))
1133 #define	NFSVOPUNLOCK(v)		VOP_UNLOCK((v))
1134 #define	NFSVOPISLOCKED(v)	VOP_ISLOCKED((v))
1135 
1136 /*
1137  * Define ncl_hash().
1138  */
1139 #define	ncl_hash(f, l)	(fnv_32_buf((f), (l), FNV1_32_INIT))
1140 
1141 int newnfs_iosize(struct nfsmount *);
1142 
1143 int newnfs_vncmpf(struct vnode *, void *);
1144 
1145 #ifndef NFS_MINDIRATTRTIMO
1146 #define	NFS_MINDIRATTRTIMO 3		/* VDIR attrib cache timeout in sec */
1147 #endif
1148 #ifndef NFS_MAXDIRATTRTIMO
1149 #define	NFS_MAXDIRATTRTIMO 60
1150 #endif
1151 
1152 /*
1153  * Nfs outstanding request list element
1154  */
1155 struct nfsreq {
1156 	TAILQ_ENTRY(nfsreq) r_chain;
1157 	u_int32_t	r_flags;	/* flags on request, see below */
1158 	struct nfsmount *r_nmp;		/* Client mnt ptr */
1159 	struct mtx	r_mtx;		/* Mutex lock for this structure */
1160 };
1161 
1162 #ifndef NFS_MAXBSIZE
1163 #define	NFS_MAXBSIZE	(maxbcachebuf)
1164 #endif
1165 
1166 /*
1167  * This macro checks to see if issuing of delegations is allowed for this
1168  * vnode.
1169  */
1170 #ifdef VV_DISABLEDELEG
1171 #define	NFSVNO_DELEGOK(v)						\
1172 	((v) == NULL || ((v)->v_vflag & VV_DISABLEDELEG) == 0)
1173 #else
1174 #define	NFSVNO_DELEGOK(v)	(1)
1175 #endif
1176 
1177 /*
1178  * Name used by getnewvnode() to describe filesystem, "nfs".
1179  * For performance reasons it is useful to have the same string
1180  * used in both places that call getnewvnode().
1181  */
1182 extern const char nfs_vnode_tag[];
1183 
1184 /*
1185  * Check for the errors that indicate a DS should be disabled.
1186  * ENXIO indicates that the krpc cannot do an RPC on the DS.
1187  * EIO is returned by the RPC as an indication of I/O problems on the
1188  * server.
1189  * Are there other fatal errors?
1190  */
1191 #define	nfsds_failerr(e)	((e) == ENXIO || (e) == EIO)
1192 
1193 /*
1194  * Get a pointer to the MDS session, which is always the first element
1195  * in the list.
1196  * This macro can only be safely used when the NFSLOCKMNT() lock is held.
1197  * The inline function can be used when the lock isn't held.
1198  */
1199 #define	NFSMNT_MDSSESSION(m)	(&(TAILQ_FIRST(&((m)->nm_sess))->nfsclds_sess))
1200 
1201 static __inline struct nfsclsession *
1202 nfsmnt_mdssession(struct nfsmount *nmp)
1203 {
1204 	struct nfsclsession *tsep;
1205 
1206 	tsep = NULL;
1207 	mtx_lock(&nmp->nm_mtx);
1208 	if (TAILQ_FIRST(&nmp->nm_sess) != NULL)
1209 		tsep = NFSMNT_MDSSESSION(nmp);
1210 	mtx_unlock(&nmp->nm_mtx);
1211 	return (tsep);
1212 }
1213 
1214 #endif	/* _KERNEL */
1215 
1216 #endif	/* _NFS_NFSPORT_H */
1217