2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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 * 4. 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.
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
35 #ifndef _NFS_NFSPORT_H_
36 #define _NFS_NFSPORT_H_
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.
43 #include <sys/unistd.h>
44 #include <sys/param.h>
45 #include <sys/systm.h>
47 #include <sys/dirent.h>
48 #include <sys/domain.h>
49 #include <sys/fcntl.h>
51 #include <sys/filedesc.h>
53 #include <sys/kernel.h>
54 #include <sys/lockf.h>
55 #include <sys/malloc.h>
57 #include <sys/mount.h>
58 #include <sys/namei.h>
60 #include <sys/protosw.h>
61 #include <sys/reboot.h>
62 #include <sys/resourcevar.h>
63 #include <sys/signalvar.h>
64 #include <sys/socket.h>
65 #include <sys/socketvar.h>
67 #include <sys/syslog.h>
68 #include <sys/sysproto.h>
71 #include <sys/vnode.h>
75 #include <sys/module.h>
76 #include <sys/sysent.h>
77 #include <sys/syscall.h>
79 #include <sys/kthread.h>
80 #include <sys/syscallsubr.h>
82 #include <net/radix.h>
83 #include <net/route.h>
84 #include <net/if_dl.h>
85 #include <netinet/in.h>
86 #include <netinet/in_pcb.h>
87 #include <netinet/in_systm.h>
88 #include <netinet/in_var.h>
89 #include <netinet/ip.h>
90 #include <netinet/ip_var.h>
91 #include <netinet/tcp.h>
92 #include <netinet/tcp_fsm.h>
93 #include <netinet/tcp_seq.h>
94 #include <netinet/tcp_timer.h>
95 #include <netinet/tcp_var.h>
96 #include <machine/in_cksum.h>
97 #include <crypto/des/des.h>
100 #include <rpc/rpcsec_gss.h>
103 * For Darwin, these functions should be "static" when built in a kext.
104 * (This is always defined as nil otherwise.)
107 #include <ufs/ufs/dir.h>
108 #include <ufs/ufs/quota.h>
109 #include <ufs/ufs/inode.h>
110 #include <ufs/ufs/extattr.h>
111 #include <ufs/ufs/ufsmount.h>
114 #include <vm/vm_object.h>
115 #include <vm/vm_extern.h>
116 #include <nfs/nfssvc.h>
121 * These types must be defined before the nfs includes.
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
130 * These should be defined as the types used for the corresponding VOP's
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
140 * Allocate mbufs. Must succeed and never set the mbuf ptr to NULL.
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); \
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); \
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); \
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); \
174 * Client side constant for size of a lockowner name.
176 #define NFSV4CL_LOCKNAMELEN 12
179 * Type for a mutex lock.
181 #define NFSMUTEX_T struct mtx
186 * NFSv4 Operation numbers.
188 #define NFSV4OP_ACCESS 3
189 #define NFSV4OP_CLOSE 4
190 #define NFSV4OP_COMMIT 5
191 #define NFSV4OP_CREATE 6
192 #define NFSV4OP_DELEGPURGE 7
193 #define NFSV4OP_DELEGRETURN 8
194 #define NFSV4OP_GETATTR 9
195 #define NFSV4OP_GETFH 10
196 #define NFSV4OP_LINK 11
197 #define NFSV4OP_LOCK 12
198 #define NFSV4OP_LOCKT 13
199 #define NFSV4OP_LOCKU 14
200 #define NFSV4OP_LOOKUP 15
201 #define NFSV4OP_LOOKUPP 16
202 #define NFSV4OP_NVERIFY 17
203 #define NFSV4OP_OPEN 18
204 #define NFSV4OP_OPENATTR 19
205 #define NFSV4OP_OPENCONFIRM 20
206 #define NFSV4OP_OPENDOWNGRADE 21
207 #define NFSV4OP_PUTFH 22
208 #define NFSV4OP_PUTPUBFH 23
209 #define NFSV4OP_PUTROOTFH 24
210 #define NFSV4OP_READ 25
211 #define NFSV4OP_READDIR 26
212 #define NFSV4OP_READLINK 27
213 #define NFSV4OP_REMOVE 28
214 #define NFSV4OP_RENAME 29
215 #define NFSV4OP_RENEW 30
216 #define NFSV4OP_RESTOREFH 31
217 #define NFSV4OP_SAVEFH 32
218 #define NFSV4OP_SECINFO 33
219 #define NFSV4OP_SETATTR 34
220 #define NFSV4OP_SETCLIENTID 35
221 #define NFSV4OP_SETCLIENTIDCFRM 36
222 #define NFSV4OP_VERIFY 37
223 #define NFSV4OP_WRITE 38
224 #define NFSV4OP_RELEASELCKOWN 39
227 * Must be one greater than the last Operation#.
229 #define NFSV4OP_NOPS 40
232 * Additional Ops for NFSv4.1.
234 #define NFSV4OP_BACKCHANNELCTL 40
235 #define NFSV4OP_BINDCONNTOSESS 41
236 #define NFSV4OP_EXCHANGEID 42
237 #define NFSV4OP_CREATESESSION 43
238 #define NFSV4OP_DESTROYSESSION 44
239 #define NFSV4OP_FREESTATEID 45
240 #define NFSV4OP_GETDIRDELEG 46
241 #define NFSV4OP_GETDEVINFO 47
242 #define NFSV4OP_GETDEVLIST 48
243 #define NFSV4OP_LAYOUTCOMMIT 49
244 #define NFSV4OP_LAYOUTGET 50
245 #define NFSV4OP_LAYOUTRETURN 51
246 #define NFSV4OP_SECINFONONAME 52
247 #define NFSV4OP_SEQUENCE 53
248 #define NFSV4OP_SETSSV 54
249 #define NFSV4OP_TESTSTATEID 55
250 #define NFSV4OP_WANTDELEG 56
251 #define NFSV4OP_DESTROYCLIENTID 57
252 #define NFSV4OP_RECLAIMCOMPL 58
255 * Must be one more than last op#.
257 #define NFSV41_NOPS 59
259 /* Quirky case if the illegal op code */
260 #define NFSV4OP_OPILLEGAL 10044
263 * Fake NFSV4OP_xxx used for nfsstat. Start at NFSV4OP_NOPS.
265 #define NFSV4OP_SYMLINK (NFSV4OP_NOPS)
266 #define NFSV4OP_MKDIR (NFSV4OP_NOPS + 1)
267 #define NFSV4OP_RMDIR (NFSV4OP_NOPS + 2)
268 #define NFSV4OP_READDIRPLUS (NFSV4OP_NOPS + 3)
269 #define NFSV4OP_MKNOD (NFSV4OP_NOPS + 4)
270 #define NFSV4OP_FSSTAT (NFSV4OP_NOPS + 5)
271 #define NFSV4OP_FSINFO (NFSV4OP_NOPS + 6)
272 #define NFSV4OP_PATHCONF (NFSV4OP_NOPS + 7)
273 #define NFSV4OP_V3CREATE (NFSV4OP_NOPS + 8)
276 * This is the count of the fake operations listed above.
278 #define NFSV4OP_FAKENOPS 9
281 * and the Callback OPs
283 #define NFSV4OP_CBGETATTR 3
284 #define NFSV4OP_CBRECALL 4
287 * Must be one greater than the last Callback Operation#.
289 #define NFSV4OP_CBNOPS 5
292 * Additional Callback Ops for NFSv4.1 only. Not yet in nfsstats.
294 #define NFSV4OP_CBLAYOUTRECALL 5
295 #define NFSV4OP_CBNOTIFY 6
296 #define NFSV4OP_CBPUSHDELEG 7
297 #define NFSV4OP_CBRECALLANY 8
298 #define NFSV4OP_CBRECALLOBJAVAIL 9
299 #define NFSV4OP_CBRECALLSLOT 10
300 #define NFSV4OP_CBSEQUENCE 11
301 #define NFSV4OP_CBWANTCANCELLED 12
302 #define NFSV4OP_CBNOTIFYLOCK 13
303 #define NFSV4OP_CBNOTIFYDEVID 14
306 * The lower numbers -> 21 are used by NFSv2 and v3. These define higher
307 * numbers used by NFSv4.
308 * NFS_V3NPROCS is one greater than the last V3 op and NFS_NPROCS is
309 * one greater than the last number.
312 #define NFS_V3NPROCS 22
314 #define NFSPROC_LOOKUPP 22
315 #define NFSPROC_SETCLIENTID 23
316 #define NFSPROC_SETCLIENTIDCFRM 24
317 #define NFSPROC_LOCK 25
318 #define NFSPROC_LOCKU 26
319 #define NFSPROC_OPEN 27
320 #define NFSPROC_CLOSE 28
321 #define NFSPROC_OPENCONFIRM 29
322 #define NFSPROC_LOCKT 30
323 #define NFSPROC_OPENDOWNGRADE 31
324 #define NFSPROC_RENEW 32
325 #define NFSPROC_PUTROOTFH 33
326 #define NFSPROC_RELEASELCKOWN 34
327 #define NFSPROC_DELEGRETURN 35
328 #define NFSPROC_RETDELEGREMOVE 36
329 #define NFSPROC_RETDELEGRENAME1 37
330 #define NFSPROC_RETDELEGRENAME2 38
331 #define NFSPROC_GETACL 39
332 #define NFSPROC_SETACL 40
335 * Must be defined as one higher than the last Proc# above.
337 #define NFSV4_NPROCS 41
339 /* Additional procedures for NFSv4.1. */
340 #define NFSPROC_EXCHANGEID 41
341 #define NFSPROC_CREATESESSION 42
342 #define NFSPROC_DESTROYSESSION 43
343 #define NFSPROC_DESTROYCLIENT 44
344 #define NFSPROC_FREESTATEID 45
345 #define NFSPROC_LAYOUTGET 46
346 #define NFSPROC_GETDEVICEINFO 47
347 #define NFSPROC_LAYOUTCOMMIT 48
348 #define NFSPROC_LAYOUTRETURN 49
349 #define NFSPROC_RECLAIMCOMPL 50
350 #define NFSPROC_WRITEDS 51
351 #define NFSPROC_READDS 52
352 #define NFSPROC_COMMITDS 53
355 * Must be defined as one higher than the last NFSv4.1 Proc# above.
357 #define NFSV41_NPROCS 54
359 #endif /* NFS_V3NPROCS */
364 struct ext_nfsstats {
366 int attrcache_misses;
367 int lookupcache_hits;
368 int lookupcache_misses;
369 int direofcache_hits;
370 int direofcache_misses;
371 int accesscache_hits;
372 int accesscache_misses;
379 int biocache_readlinks;
381 int biocache_readdirs;
383 int rpccnt[NFSV4_NPROCS];
385 int srvrpccnt[NFSV4OP_NOPS + NFSV4OP_FAKENOPS];
392 int srvcache_inproghits;
393 int srvcache_idemdonehits;
394 int srvcache_nonidemdonehits;
396 int srvcache_tcppeak;
404 int cbrpccnt[NFSV4OP_CBNOPS];
410 int cllocalopenowners;
412 int cllocallockowners;
418 * Define the ext_nfsstats as nfsstats for the kernel code.
420 #define nfsstats ext_nfsstats
423 * Define NFS_NPROCS as NFSV4_NPROCS for the experimental kernel code.
426 #define NFS_NPROCS NFSV4_NPROCS
429 #include <fs/nfs/nfskpiport.h>
430 #include <fs/nfs/nfsdport.h>
431 #include <fs/nfs/rpcv2.h>
432 #include <fs/nfs/nfsproto.h>
433 #include <fs/nfs/nfs.h>
434 #include <fs/nfs/nfsclstate.h>
435 #include <fs/nfs/nfs_var.h>
436 #include <fs/nfs/nfsm_subs.h>
437 #include <fs/nfs/nfsrvcache.h>
438 #include <fs/nfs/nfsrvstate.h>
439 #include <fs/nfs/xdr_subs.h>
440 #include <fs/nfs/nfscl.h>
441 #include <nfsclient/nfsargs.h>
442 #include <fs/nfsclient/nfsmount.h>
445 * Just to keep nfs_var.h happy.
452 struct vattr na_vattr;
453 nfsattrbit_t na_suppattr;
454 u_int32_t na_mntonfileno;
455 u_int64_t na_filesid[2];
458 #define na_type na_vattr.va_type
459 #define na_mode na_vattr.va_mode
460 #define na_nlink na_vattr.va_nlink
461 #define na_uid na_vattr.va_uid
462 #define na_gid na_vattr.va_gid
463 #define na_fsid na_vattr.va_fsid
464 #define na_fileid na_vattr.va_fileid
465 #define na_size na_vattr.va_size
466 #define na_blocksize na_vattr.va_blocksize
467 #define na_atime na_vattr.va_atime
468 #define na_mtime na_vattr.va_mtime
469 #define na_ctime na_vattr.va_ctime
470 #define na_gen na_vattr.va_gen
471 #define na_flags na_vattr.va_flags
472 #define na_rdev na_vattr.va_rdev
473 #define na_bytes na_vattr.va_bytes
474 #define na_filerev na_vattr.va_filerev
475 #define na_vaflags na_vattr.va_vaflags
477 #include <fs/nfsclient/nfsnode.h>
480 * This is the header structure used for the lists, etc. (It has the
481 * above record in it.
483 struct nfsrv_stablefirst {
484 LIST_HEAD(, nfsrv_stable) nsf_head; /* Head of nfsrv_stable list */
485 time_t nsf_eograce; /* Time grace period ends */
486 time_t *nsf_bootvals; /* Previous boottime values */
487 struct file *nsf_fp; /* File table pointer */
488 u_char nsf_flags; /* NFSNSF_ flags */
489 struct nfsf_rec nsf_rec; /* and above first record */
491 #define nsf_lease nsf_rec.lease
492 #define nsf_numboots nsf_rec.numboots
494 /* NFSNSF_xxx flags */
495 #define NFSNSF_UPDATEDONE 0x01
496 #define NFSNSF_GRACEOVER 0x02
497 #define NFSNSF_NEEDLOCK 0x04
498 #define NFSNSF_EXPIREDCLIENT 0x08
499 #define NFSNSF_NOOPENS 0x10
500 #define NFSNSF_OK 0x20
503 * Maximum number of boot times allowed in record. Although there is
504 * really no need for a fixed upper bound, this serves as a sanity check
505 * for a corrupted file.
507 #define NFSNSF_MAXNUMBOOTS 10000
510 * This structure defines the other records in the file. The
511 * nst_client array is actually the size of the client string name.
518 /* and the values for flag */
519 #define NFSNST_NEWSTATE 0x1
520 #define NFSNST_REVOKE 0x2
521 #define NFSNST_GOTSTATE 0x4
524 * This structure is linked onto nfsrv_stablefirst for the duration of
527 struct nfsrv_stable {
528 LIST_ENTRY(nfsrv_stable) nst_list;
529 struct nfsclient *nst_clp;
530 struct nfst_rec nst_rec;
532 #define nst_timestamp nst_rec.timestamp
533 #define nst_len nst_rec.len
534 #define nst_flag nst_rec.flag
535 #define nst_client nst_rec.client
538 * At some point the server will run out of kernel storage for
539 * state structures. For FreeBSD5.2, this results in a panic
540 * kmem_map is full. It happens at well over 1000000 opens plus
541 * locks on a PIII-800 with 256Mbytes, so that is where I've set
542 * the limit. If your server panics due to too many opens/locks,
543 * decrease the size of NFSRV_V4STATELIMIT. If you find the server
544 * returning NFS4ERR_RESOURCE a lot and have lots of memory, try
547 #define NFSRV_V4STATELIMIT 500000 /* Max # of Opens + Locks */
550 * The type required differs with BSDen (just the second arg).
552 void nfsrvd_rcv(struct socket *, void *, int);
555 * Macros for handling socket addresses. (Hopefully this makes the code
556 * more portable, since I've noticed some 'BSD don't have sockaddrs in
559 #define NFSSOCKADDR(a, t) ((t)(a))
560 #define NFSSOCKADDRALLOC(a) \
562 MALLOC((a), struct sockaddr *, sizeof (struct sockaddr), \
563 M_SONAME, M_WAITOK); \
564 NFSBZERO((a), sizeof (struct sockaddr)); \
566 #define NFSSOCKADDRSIZE(a, s) ((a)->sa_len = (s))
567 #define NFSSOCKADDRFREE(a) \
570 FREE((caddr_t)(a), M_SONAME); \
574 * These should be defined as a process or thread structure, as required
575 * for signal handling, etc.
577 #define NFSNEWCRED(c) (crdup(c))
578 #define NFSPROCCRED(p) ((p)->td_ucred)
579 #define NFSFREECRED(c) (crfree(c))
580 #define NFSUIOPROC(u, p) ((u)->uio_td = NULL)
581 #define NFSPROCP(p) ((p)->td_proc)
584 * Define these so that cn_hash and its length is ignored.
586 #define NFSCNHASHZERO(c)
587 #define NFSCNHASH(c, v)
588 #define NCHNAMLEN 9999999
591 * These macros are defined to initialize and set the timer routine.
593 #define NFS_TIMERINIT \
599 #define NFSSTATESPINLOCK extern struct mtx nfs_state_mutex
600 #define NFSLOCKSTATE() mtx_lock(&nfs_state_mutex)
601 #define NFSUNLOCKSTATE() mtx_unlock(&nfs_state_mutex)
602 #define NFSSTATEMUTEXPTR (&nfs_state_mutex)
603 #define NFSREQSPINLOCK extern struct mtx nfs_req_mutex
604 #define NFSLOCKREQ() mtx_lock(&nfs_req_mutex)
605 #define NFSUNLOCKREQ() mtx_unlock(&nfs_req_mutex)
606 #define NFSSOCKMUTEX extern struct mtx nfs_slock_mutex
607 #define NFSSOCKMUTEXPTR (&nfs_slock_mutex)
608 #define NFSLOCKSOCK() mtx_lock(&nfs_slock_mutex)
609 #define NFSUNLOCKSOCK() mtx_unlock(&nfs_slock_mutex)
610 #define NFSNAMEIDMUTEX extern struct mtx nfs_nameid_mutex
611 #define NFSLOCKNAMEID() mtx_lock(&nfs_nameid_mutex)
612 #define NFSUNLOCKNAMEID() mtx_unlock(&nfs_nameid_mutex)
613 #define NFSNAMEIDREQUIRED() mtx_assert(&nfs_nameid_mutex, MA_OWNED)
614 #define NFSCLSTATEMUTEX extern struct mtx nfs_clstate_mutex
615 #define NFSCLSTATEMUTEXPTR (&nfs_clstate_mutex)
616 #define NFSLOCKCLSTATE() mtx_lock(&nfs_clstate_mutex)
617 #define NFSUNLOCKCLSTATE() mtx_unlock(&nfs_clstate_mutex)
618 #define NFSDLOCKMUTEX extern struct mtx newnfsd_mtx
619 #define NFSDLOCKMUTEXPTR (&newnfsd_mtx)
620 #define NFSD_LOCK() mtx_lock(&newnfsd_mtx)
621 #define NFSD_UNLOCK() mtx_unlock(&newnfsd_mtx)
622 #define NFSD_LOCK_ASSERT() mtx_assert(&newnfsd_mtx, MA_OWNED)
623 #define NFSD_UNLOCK_ASSERT() mtx_assert(&newnfsd_mtx, MA_NOTOWNED)
624 #define NFSV4ROOTLOCKMUTEX extern struct mtx nfs_v4root_mutex
625 #define NFSV4ROOTLOCKMUTEXPTR (&nfs_v4root_mutex)
626 #define NFSLOCKV4ROOTMUTEX() mtx_lock(&nfs_v4root_mutex)
627 #define NFSUNLOCKV4ROOTMUTEX() mtx_unlock(&nfs_v4root_mutex)
628 #define NFSLOCKNODE(n) mtx_lock(&((n)->n_mtx))
629 #define NFSUNLOCKNODE(n) mtx_unlock(&((n)->n_mtx))
630 #define NFSLOCKMNT(m) mtx_lock(&((m)->nm_mtx))
631 #define NFSUNLOCKMNT(m) mtx_unlock(&((m)->nm_mtx))
632 #define NFSLOCKREQUEST(r) mtx_lock(&((r)->r_mtx))
633 #define NFSUNLOCKREQUEST(r) mtx_unlock(&((r)->r_mtx))
634 #define NFSPROCLISTLOCK() sx_slock(&allproc_lock)
635 #define NFSPROCLISTUNLOCK() sx_sunlock(&allproc_lock)
636 #define NFSLOCKSOCKREQ(r) mtx_lock(&((r)->nr_mtx))
637 #define NFSUNLOCKSOCKREQ(r) mtx_unlock(&((r)->nr_mtx))
638 #define NFSLOCKDS(d) mtx_lock(&((d)->nfsclds_mtx))
639 #define NFSUNLOCKDS(d) mtx_unlock(&((d)->nfsclds_mtx))
640 #define NFSSESSIONMUTEXPTR(s) (&((s)->mtx))
641 #define NFSLOCKSESSION(s) mtx_lock(&((s)->mtx))
642 #define NFSUNLOCKSESSION(s) mtx_unlock(&((s)->mtx))
645 * Use these macros to initialize/free a mutex.
647 #define NFSINITSOCKMUTEX(m) mtx_init((m), "nfssock", NULL, MTX_DEF)
648 #define NFSFREEMUTEX(m) mtx_destroy((m))
650 int nfsmsleep(void *, void *, int, const char *, struct timespec *);
653 * And weird vm stuff in the nfs server.
655 #define PDIRUNLOCK 0x0
656 #define MAX_COMMIT_COUNT (1024 * 1024)
659 * Define these to handle the type of va_rdev.
661 #define NFSMAKEDEV(m, n) makedev((m), (n))
662 #define NFSMAJOR(d) major(d)
663 #define NFSMINOR(d) minor(d)
666 * Define this to be the macro that returns the minimum size required
667 * for a directory entry.
669 #define DIRENT_SIZE(dp) GENERIC_DIRSIZ(dp)
672 * The vnode tag for nfsv4root.
674 #define VT_NFSV4ROOT "nfsv4root"
677 * Define whatever it takes to do a vn_rdwr().
679 #define NFSD_RDWR(r, v, b, l, o, s, i, c, a, p) \
680 vn_rdwr((r), (v), (b), (l), (o), (s), (i), (c), NULL, (a), (p))
683 * Macros for handling memory for different BSDen.
684 * NFSBCOPY(src, dst, len) - copies len bytes, non-overlapping
685 * NFSOVBCOPY(src, dst, len) - ditto, but data areas might overlap
686 * NFSBCMP(cp1, cp2, len) - compare len bytes, return 0 if same
687 * NFSBZERO(cp, len) - set len bytes to 0x0
689 #define NFSBCOPY(s, d, l) bcopy((s), (d), (l))
690 #define NFSOVBCOPY(s, d, l) ovbcopy((s), (d), (l))
691 #define NFSBCMP(s, d, l) bcmp((s), (d), (l))
692 #define NFSBZERO(s, l) bzero((s), (l))
695 * Some queue.h files don't have these dfined in them.
697 #define LIST_END(head) NULL
698 #define SLIST_END(head) NULL
699 #define TAILQ_END(head) NULL
702 * This must be defined to be a global variable that increments once
703 * per second, but never stops or goes backwards, even when a "date"
704 * command changes the TOD clock. It is used for delta times for
707 #define NFSD_MONOSEC time_uptime
710 * Declare the malloc types.
712 MALLOC_DECLARE(M_NEWNFSRVCACHE);
713 MALLOC_DECLARE(M_NEWNFSDCLIENT);
714 MALLOC_DECLARE(M_NEWNFSDSTATE);
715 MALLOC_DECLARE(M_NEWNFSDLOCK);
716 MALLOC_DECLARE(M_NEWNFSDLOCKFILE);
717 MALLOC_DECLARE(M_NEWNFSSTRING);
718 MALLOC_DECLARE(M_NEWNFSUSERGROUP);
719 MALLOC_DECLARE(M_NEWNFSDREQ);
720 MALLOC_DECLARE(M_NEWNFSFH);
721 MALLOC_DECLARE(M_NEWNFSCLOWNER);
722 MALLOC_DECLARE(M_NEWNFSCLOPEN);
723 MALLOC_DECLARE(M_NEWNFSCLDELEG);
724 MALLOC_DECLARE(M_NEWNFSCLCLIENT);
725 MALLOC_DECLARE(M_NEWNFSCLLOCKOWNER);
726 MALLOC_DECLARE(M_NEWNFSCLLOCK);
727 MALLOC_DECLARE(M_NEWNFSDIROFF);
728 MALLOC_DECLARE(M_NEWNFSV4NODE);
729 MALLOC_DECLARE(M_NEWNFSDIRECTIO);
730 MALLOC_DECLARE(M_NEWNFSMNT);
731 MALLOC_DECLARE(M_NEWNFSDROLLBACK);
732 MALLOC_DECLARE(M_NEWNFSLAYOUT);
733 MALLOC_DECLARE(M_NEWNFSFLAYOUT);
734 MALLOC_DECLARE(M_NEWNFSDEVINFO);
735 MALLOC_DECLARE(M_NEWNFSSOCKREQ);
736 MALLOC_DECLARE(M_NEWNFSCLDS);
737 MALLOC_DECLARE(M_NEWNFSLAYRECALL);
738 MALLOC_DECLARE(M_NEWNFSDSESSION);
739 #define M_NFSRVCACHE M_NEWNFSRVCACHE
740 #define M_NFSDCLIENT M_NEWNFSDCLIENT
741 #define M_NFSDSTATE M_NEWNFSDSTATE
742 #define M_NFSDLOCK M_NEWNFSDLOCK
743 #define M_NFSDLOCKFILE M_NEWNFSDLOCKFILE
744 #define M_NFSSTRING M_NEWNFSSTRING
745 #define M_NFSUSERGROUP M_NEWNFSUSERGROUP
746 #define M_NFSDREQ M_NEWNFSDREQ
747 #define M_NFSFH M_NEWNFSFH
748 #define M_NFSCLOWNER M_NEWNFSCLOWNER
749 #define M_NFSCLOPEN M_NEWNFSCLOPEN
750 #define M_NFSCLDELEG M_NEWNFSCLDELEG
751 #define M_NFSCLCLIENT M_NEWNFSCLCLIENT
752 #define M_NFSCLLOCKOWNER M_NEWNFSCLLOCKOWNER
753 #define M_NFSCLLOCK M_NEWNFSCLLOCK
754 #define M_NFSDIROFF M_NEWNFSDIROFF
755 #define M_NFSV4NODE M_NEWNFSV4NODE
756 #define M_NFSDIRECTIO M_NEWNFSDIRECTIO
757 #define M_NFSDROLLBACK M_NEWNFSDROLLBACK
758 #define M_NFSLAYOUT M_NEWNFSLAYOUT
759 #define M_NFSFLAYOUT M_NEWNFSFLAYOUT
760 #define M_NFSDEVINFO M_NEWNFSDEVINFO
761 #define M_NFSSOCKREQ M_NEWNFSSOCKREQ
762 #define M_NFSCLDS M_NEWNFSCLDS
763 #define M_NFSLAYRECALL M_NEWNFSLAYRECALL
764 #define M_NFSDSESSION M_NEWNFSDSESSION
766 #define NFSINT_SIGMASK(set) \
767 (SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) || \
768 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) || \
769 SIGISMEMBER(set, SIGQUIT))
772 * Convert a quota block count to byte count.
774 #define NFSQUOTABLKTOBYTE(q, b) (q) *= (b)
777 * Define this as the largest file size supported. (It should probably
778 * be available via a VFS_xxx Op, but it isn't.
780 #define NFSRV_MAXFILESIZE ((u_int64_t)0x800000000000)
783 * Set this macro to index() or strchr(), whichever is supported.
785 #define STRCHR(s, c) strchr((s), (c))
788 * Set the n_time in the client write rpc, as required.
790 #define NFSWRITERPC_SETTIME(w, n, v4) \
793 (n)->n_mtime = (n)->n_vattr.na_vattr.va_mtime; \
795 (n)->n_change = (n)->n_vattr.na_vattr.va_filerev; \
800 * Fake value, just to make the client work.
802 #define NFS_LATTR_NOSHRINK 1
805 * Prototypes for functions where the arguments vary for different ports.
807 int nfscl_loadattrcache(struct vnode **, struct nfsvattr *, void *, void *,
809 int newnfs_realign(struct mbuf **, int);
812 * If the port runs on an SMP box that can enforce Atomic ops with low
813 * overheads, define these as atomic increments/decrements. If not,
814 * don't worry about it, since these are used for stats that can be
815 * "out by one" without disastrous consequences.
817 #define NFSINCRGLOBAL(a) ((a)++)
820 * Assorted funky stuff to make things work under Darwin8.
823 * These macros checks for a field in vattr being set.
825 #define NFSATTRISSET(t, v, a) ((v)->a != (t)VNOVAL)
826 #define NFSATTRISSETTIME(v, a) ((v)->a.tv_sec != VNOVAL)
829 * Manipulate mount flags.
831 #define NFSSTA_HASWRITEVERF 0x00040000 /* Has write verifier */
832 #define NFSSTA_GOTFSINFO 0x00100000 /* Got the fsinfo */
833 #define NFSSTA_NOLAYOUTCOMMIT 0x04000000 /* Don't do LayoutCommit */
834 #define NFSSTA_SESSPERSIST 0x08000000 /* Has a persistent session */
835 #define NFSSTA_TIMEO 0x10000000 /* Experiencing a timeout */
836 #define NFSSTA_LOCKTIMEO 0x20000000 /* Experiencing a lockd timeout */
837 #define NFSSTA_HASSETFSID 0x40000000 /* Has set the fsid */
838 #define NFSSTA_PNFS 0x80000000 /* pNFS is enabled */
840 #define NFSHASNFSV3(n) ((n)->nm_flag & NFSMNT_NFSV3)
841 #define NFSHASNFSV4(n) ((n)->nm_flag & NFSMNT_NFSV4)
842 #define NFSHASNFSV4N(n) ((n)->nm_minorvers > 0)
843 #define NFSHASNFSV3OR4(n) ((n)->nm_flag & (NFSMNT_NFSV3 | NFSMNT_NFSV4))
844 #define NFSHASGOTFSINFO(n) ((n)->nm_state & NFSSTA_GOTFSINFO)
845 #define NFSHASHASSETFSID(n) ((n)->nm_state & NFSSTA_HASSETFSID)
846 #define NFSHASSTRICT3530(n) ((n)->nm_flag & NFSMNT_STRICT3530)
847 #define NFSHASWRITEVERF(n) ((n)->nm_state & NFSSTA_HASWRITEVERF)
848 #define NFSHASINT(n) ((n)->nm_flag & NFSMNT_INT)
849 #define NFSHASSOFT(n) ((n)->nm_flag & NFSMNT_SOFT)
850 #define NFSHASINTORSOFT(n) ((n)->nm_flag & (NFSMNT_INT | NFSMNT_SOFT))
851 #define NFSHASDUMBTIMR(n) ((n)->nm_flag & NFSMNT_DUMBTIMR)
852 #define NFSHASNOCONN(n) ((n)->nm_flag & NFSMNT_MNTD)
853 #define NFSHASKERB(n) ((n)->nm_flag & NFSMNT_KERB)
854 #define NFSHASALLGSSNAME(n) ((n)->nm_flag & NFSMNT_ALLGSSNAME)
855 #define NFSHASINTEGRITY(n) ((n)->nm_flag & NFSMNT_INTEGRITY)
856 #define NFSHASPRIVACY(n) ((n)->nm_flag & NFSMNT_PRIVACY)
857 #define NFSSETWRITEVERF(n) ((n)->nm_state |= NFSSTA_HASWRITEVERF)
858 #define NFSSETHASSETFSID(n) ((n)->nm_state |= NFSSTA_HASSETFSID)
859 #define NFSHASPNFSOPT(n) ((n)->nm_flag & NFSMNT_PNFS)
860 #define NFSHASNOLAYOUTCOMMIT(n) ((n)->nm_state & NFSSTA_NOLAYOUTCOMMIT)
861 #define NFSHASSESSPERSIST(n) ((n)->nm_state & NFSSTA_SESSPERSIST)
862 #define NFSHASPNFS(n) ((n)->nm_state & NFSSTA_PNFS)
865 * Gets the stats field out of the mount structure.
867 #define vfs_statfs(m) (&((m)->mnt_stat))
872 #define NFSSETBOOTTIME(b) ((b) = boottime)
875 * The size of directory blocks in the buffer cache.
876 * MUST BE in the range of PAGE_SIZE <= NFS_DIRBLKSIZ <= MAXBSIZE!!
878 #define NFS_DIRBLKSIZ (16 * DIRBLKSIZ) /* Must be a multiple of DIRBLKSIZ */
881 * Define these macros to access mnt_flag fields.
883 #define NFSMNT_RDONLY(m) ((m)->mnt_flag & MNT_RDONLY)
887 * Define a structure similar to ufs_args for use in exporting the V4 root.
891 struct export_args export;
895 * These export flags should be defined, but there are no bits left.
896 * Maybe a separate mnt_exflag field could be added or the mnt_flag
897 * field increased to 64 bits?
899 #ifndef MNT_EXSTRICTACCESS
900 #define MNT_EXSTRICTACCESS 0x0
903 #define MNT_EXV4ONLY 0x0
908 * Define this to invalidate the attribute cache for the nfs node.
910 #define NFSINVALATTRCACHE(n) ((n)->n_attrstamp = 0)
912 /* Used for FreeBSD only */
913 void nfsd_mntinit(void);
916 * Define these for vnode lock/unlock ops.
918 * These are good abstractions to macro out, so that they can be added to
919 * later, for debugging or stats, etc.
921 #define NFSVOPLOCK(v, f) vn_lock((v), (f))
922 #define NFSVOPUNLOCK(v, f) VOP_UNLOCK((v), (f))
923 #define NFSVOPISLOCKED(v) VOP_ISLOCKED((v))
928 #define ncl_hash(f, l) (fnv_32_buf((f), (l), FNV1_32_INIT))
930 int newnfs_iosize(struct nfsmount *);
934 extern int nfs_debug;
935 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */
936 #define NFS_DEBUG_WG 2 /* server write gathering */
937 #define NFS_DEBUG_RC 4 /* server request caching */
939 #define NFS_DPF(cat, args) \
941 if (nfs_debug & NFS_DEBUG_##cat) printf args; \
946 #define NFS_DPF(cat, args)
950 int newnfs_vncmpf(struct vnode *, void *);
952 #ifndef NFS_MINDIRATTRTIMO
953 #define NFS_MINDIRATTRTIMO 3 /* VDIR attrib cache timeout in sec */
955 #ifndef NFS_MAXDIRATTRTIMO
956 #define NFS_MAXDIRATTRTIMO 60
960 * Nfs outstanding request list element
963 TAILQ_ENTRY(nfsreq) r_chain;
964 u_int32_t r_flags; /* flags on request, see below */
965 struct nfsmount *r_nmp; /* Client mnt ptr */
966 struct mtx r_mtx; /* Mutex lock for this structure */
970 #define NFS_MAXBSIZE MAXBCACHEBUF
974 * This macro checks to see if issuing of delegations is allowed for this
977 #ifdef VV_DISABLEDELEG
978 #define NFSVNO_DELEGOK(v) \
979 ((v) == NULL || ((v)->v_vflag & VV_DISABLEDELEG) == 0)
981 #define NFSVNO_DELEGOK(v) (1)
986 #endif /* _NFS_NFSPORT_H */