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