]>
git.saurik.com Git - apple/xnu.git/blob - bsd/nfs/nfs.h
2 * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
23 * @APPLE_LICENSE_HEADER_END@
25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
27 * Copyright (c) 1989, 1993, 1995
28 * The Regents of the University of California. All rights reserved.
30 * This code is derived from software contributed to Berkeley by
31 * Rick Macklem at The University of Guelph.
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 * 3. All advertising materials mentioning features or use of this software
42 * must display the following acknowledgement:
43 * This product includes software developed by the University of
44 * California, Berkeley and its contributors.
45 * 4. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61 * @(#)nfs.h 8.4 (Berkeley) 5/1/95
62 * FreeBSD-Id: nfs.h,v 1.32 1997/10/12 20:25:38 phk Exp $
68 #include <sys/appleapiopts.h>
70 #ifdef __APPLE_API_PRIVATE
72 * Tunable constants for nfs
75 #define NFS_MAXIOVEC 34
76 #define NFS_TICKINTVL 5 /* Desired time for a tick (msec) */
77 #define NFS_HZ (hz / nfs_ticks) /* Ticks/sec */
78 #define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */
79 #define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */
80 #define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */
81 #define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/
82 #define NFS_MAXREXMIT 100 /* Stop counting after this many */
83 #define NFS_MAXWINDOW 1024 /* Max number of outstanding requests */
84 #define NFS_RETRANS 10 /* Num of retrans for soft mounts */
85 #define NFS_MAXGRPS 16 /* Max. size of groups list */
86 #ifndef NFS_MINATTRTIMO
87 #define NFS_MINATTRTIMO 5 /* Attribute cache timeout in sec */
89 #ifndef NFS_MAXATTRTIMO
90 #define NFS_MAXATTRTIMO 60
92 #define NFS_WSIZE 16384 /* Def. write data size <= 16K */
93 #define NFS_RSIZE 16384 /* Def. read data size <= 16K */
94 #define NFS_DGRAM_WSIZE 8192 /* UDP Def. write data size <= 8K */
95 #define NFS_DGRAM_RSIZE 8192 /* UDP Def. read data size <= 8K */
96 #define NFS_READDIRSIZE 8192 /* Def. readdir size */
97 #define NFS_DEFRAHEAD 4 /* Def. read ahead # blocks */
98 #define NFS_MAXRAHEAD 16 /* Max. read ahead # blocks */
99 #define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */
100 #define NFS_MAXASYNCDAEMON 32 /* Max. number async_daemons runnable */
101 #define NFS_MAXGATHERDELAY 100 /* Max. write gather delay (msec) */
102 #ifndef NFS_GATHERDELAY
103 #define NFS_GATHERDELAY 10 /* Default write gather delay (msec) */
105 #define NFS_DIRBLKSIZ 4096 /* Must be a multiple of DIRBLKSIZ */
106 #if defined(KERNEL) && !defined(DIRBLKSIZ)
107 #define DIRBLKSIZ 512 /* XXX we used to use ufs's DIRBLKSIZ */
108 /* can't be larger than NFS_FABLKSIZE */
114 #define NMOD(a) ((a) % nfs_asyncdaemons)
115 #define NFS_CMPFH(n, f, s) \
116 ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
117 #define NFS_ISV3(v) (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
118 #define NFS_SRVMAXDATA(n) \
119 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
120 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
124 * The NB_INVAFTERWRITE flag should be set to whatever is required by the
125 * buffer cache code to say "Invalidate the block after it is written back".
128 #define NB_INVAFTERWRITE NB_NOCACHE
130 #define NB_INVAFTERWRITE NB_INVAL
134 * The IO_METASYNC flag should be implemented for local file systems.
135 * (Until then, it is nothin at all.)
138 #define IO_METASYNC 0
142 * Expected allocation sizes for major data structures. If the actual size
143 * of the structure exceeds these sizes, then malloc() will be allocating
144 * almost twice the memory required. This is used in nfs_init() to warn
145 * the sysadmin that the size of a structure should be reduced.
146 * (These sizes are always a power of 2. If the kernel malloc() changes
147 * to one that does not allocate space in powers of 2 size, then this all
149 * Note that some of these structures come out of there own nfs zones.
151 #define NFS_NODEALLOC 512
152 #define NFS_MNTALLOC 512
153 #define NFS_SVCALLOC 256
154 #define NFS_UIDALLOC 128
157 * Arguments to mount NFS
159 #define NFS_ARGSVERSION 3 /* change when nfs_args changes */
161 int version
; /* args structure version number */
162 struct sockaddr
*addr
; /* file server address */
163 int addrlen
; /* length of address */
164 int sotype
; /* Socket type */
165 int proto
; /* and Protocol */
166 u_char
*fh
; /* File handle to be mounted */
167 int fhsize
; /* Size, in bytes, of fh */
168 int flags
; /* flags */
169 int wsize
; /* write size in bytes */
170 int rsize
; /* read size in bytes */
171 int readdirsize
; /* readdir size in bytes */
172 int timeo
; /* initial timeout in .1 secs */
173 int retrans
; /* times to retry send */
174 int maxgrouplist
; /* Max. size of group list */
175 int readahead
; /* # of blocks to readahead */
176 int leaseterm
; /* Term (sec) of lease */
177 int deadthresh
; /* Retrans threshold */
178 char *hostname
; /* server's name */
182 * NFS mount option flags
184 #define NFSMNT_SOFT 0x00000001 /* soft mount (hard is default) */
185 #define NFSMNT_WSIZE 0x00000002 /* set write size */
186 #define NFSMNT_RSIZE 0x00000004 /* set read size */
187 #define NFSMNT_TIMEO 0x00000008 /* set initial timeout */
188 #define NFSMNT_RETRANS 0x00000010 /* set number of request retries */
189 #define NFSMNT_MAXGRPS 0x00000020 /* set maximum grouplist size */
190 #define NFSMNT_INT 0x00000040 /* allow interrupts on hard mount */
191 #define NFSMNT_NOCONN 0x00000080 /* Don't Connect the socket */
192 #define NFSMNT_NQNFS 0x00000100 /* Use Nqnfs protocol */
193 #define NFSMNT_NFSV3 0x00000200 /* Use NFS Version 3 protocol */
194 #define NFSMNT_KERB 0x00000400 /* Use Kerberos authentication */
195 #define NFSMNT_DUMBTIMR 0x00000800 /* Don't estimate rtt dynamically */
196 #define NFSMNT_LEASETERM 0x00001000 /* set lease term (nqnfs) */
197 #define NFSMNT_READAHEAD 0x00002000 /* set read ahead */
198 #define NFSMNT_DEADTHRESH 0x00004000 /* set dead server retry thresh */
199 #define NFSMNT_RESVPORT 0x00008000 /* Allocate a reserved port */
200 #define NFSMNT_RDIRPLUS 0x00010000 /* Use Readdirplus for V3 */
201 #define NFSMNT_READDIRSIZE 0x00020000 /* Set readdir size */
202 #define NFSMNT_NOLOCKS 0x00040000 /* don't support file locking */
204 #define NFSSTA_TIMEO 0x00010000 /* experienced a timeout. */
205 #define NFSSTA_FORCE 0x00020000 /* doing a forced unmount. */
206 #define NFSSTA_HASWRITEVERF 0x00040000 /* Has write verifier for V3 */
207 #define NFSSTA_GOTPATHCONF 0x00080000 /* Got the V3 pathconf info */
208 #define NFSSTA_GOTFSINFO 0x00100000 /* Got the V3 fsinfo */
209 #define NFSSTA_MNTD 0x00200000 /* Mnt server for mnt point */
210 #define NFSSTA_DISMINPROG 0x00400000 /* Dismount in progress */
211 #define NFSSTA_DISMNT 0x00800000 /* Dismounted */
212 #define NFSSTA_SNDLOCK 0x01000000 /* Send socket lock */
213 #define NFSSTA_WANTSND 0x02000000 /* Want above */
214 #define NFSSTA_RCVLOCK 0x04000000 /* Rcv socket lock */
215 #define NFSSTA_WANTRCV 0x08000000 /* Want above */
216 #define NFSSTA_WAITAUTH 0x10000000 /* Wait for authentication */
217 #define NFSSTA_HASAUTH 0x20000000 /* Has authenticator */
218 #define NFSSTA_WANTAUTH 0x40000000 /* Wants an authenticator */
219 #define NFSSTA_AUTHERR 0x80000000 /* Authentication error */
222 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
223 * should ever try and use it.
226 int sock
; /* Socket to serve */
227 caddr_t name
; /* Client addr for connection based sockets */
228 int namelen
; /* Length of name */
231 struct nfsd_srvargs
{
232 struct nfsd
*nsd_nfsd
; /* Pointer to in kernel nfsd struct */
233 uid_t nsd_uid
; /* Effective uid mapped to cred */
234 u_long nsd_haddr
; /* Ip address of client */
235 struct ucred nsd_cr
; /* Cred. uid maps to */
236 int nsd_authlen
; /* Length of auth string (ret) */
237 u_char
*nsd_authstr
; /* Auth string (ret) */
238 int nsd_verflen
; /* and the verfier */
240 struct timeval nsd_timestamp
; /* timestamp from verifier */
241 u_long nsd_ttl
; /* credential ttl (sec) */
242 NFSKERBKEY_T nsd_key
; /* Session key */
246 char *ncd_dirp
; /* Mount dir path */
247 uid_t ncd_authuid
; /* Effective uid */
248 int ncd_authtype
; /* Type of authenticator */
249 int ncd_authlen
; /* Length of authenticator string */
250 u_char
*ncd_authstr
; /* Authenticator string */
251 int ncd_verflen
; /* and the verifier */
253 NFSKERBKEY_T ncd_key
; /* Session key */
257 * XXX to allow amd to include nfs.h without nfsproto.h
265 int attrcache_misses
;
266 int lookupcache_hits
;
267 int lookupcache_misses
;
268 int direofcache_hits
;
269 int direofcache_misses
;
276 int biocache_readlinks
;
278 int biocache_readdirs
;
280 int rpccnt
[NFS_NPROCS
];
282 int srvrpccnt
[NFS_NPROCS
];
289 int srvcache_inproghits
;
290 int srvcache_idemdonehits
;
291 int srvcache_nonidemdonehits
;
294 int srvnqnfs_maxleases
;
295 int srvnqnfs_getleases
;
303 * Flags for nfssvc() system call.
305 #define NFSSVC_BIOD 0x002
306 #define NFSSVC_NFSD 0x004
307 #define NFSSVC_ADDSOCK 0x008
308 #define NFSSVC_AUTHIN 0x010
309 #define NFSSVC_GOTAUTH 0x040
310 #define NFSSVC_AUTHINFAIL 0x080
311 #define NFSSVC_MNTD 0x100
314 * Flags for nfsclnt() system call.
316 #define NFSCLNT_LOCKDANS 0x200
317 #define NFSCLNT_LOCKDFD 0x400
318 #define NFSCLNT_LOCKDWAIT 0x800
321 * fs.nfs sysctl(3) identifiers
323 #define NFS_NFSSTATS 1 /* struct: struct nfsstats */
324 #define NFS_NFSPRIVPORT 2 /* int: prohibit nfs to resvports */
326 #define FS_NFS_NAMES { \
328 { "nfsstats", CTLTYPE_STRUCT }, \
329 { "nfsprivport", CTLTYPE_INT }, \
332 #ifndef NFS_MUIDHASHSIZ
333 #define NFS_MUIDHASHSIZ 63 /* Tune the size of nfsmount with this */
335 #ifndef NFS_WDELAYHASHSIZ
336 #define NFS_WDELAYHASHSIZ 16 /* and with this */
340 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
341 * What should be in this set is open to debate, but I believe that since
342 * I/O system calls on ufs are never interrupted by signals the set should
343 * be minimal. My reasoning is that many current programs that use signals
344 * such as SIGALRM will not expect file I/O system calls to be interrupted
349 #ifdef MALLOC_DECLARE
350 MALLOC_DECLARE(M_NFSREQ
);
351 MALLOC_DECLARE(M_NFSMNT
);
352 MALLOC_DECLARE(M_NFSDIROFF
);
353 MALLOC_DECLARE(M_NFSRVDESC
);
354 MALLOC_DECLARE(M_NFSUID
);
355 MALLOC_DECLARE(M_NQLEASE
);
356 MALLOC_DECLARE(M_NFSD
);
357 MALLOC_DECLARE(M_NFSBIGFH
);
360 struct uio
; struct vattr
; struct nameidata
; /* XXX */
363 #define NFSINT_SIGMASK (sigmask(SIGINT)|sigmask(SIGTERM)|sigmask(SIGKILL)| \
364 sigmask(SIGHUP)|sigmask(SIGQUIT))
367 * Socket errors ignored for connectionless sockets??
368 * For now, ignore them all
370 #define NFSIGNORE_SOERROR(s, e) \
371 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
372 (e) != EIO && ((s) & PR_CONNREQUIRED) == 0)
375 * Nfs outstanding request list element
378 TAILQ_ENTRY(nfsreq
) r_chain
;
383 struct nfsmount
*r_nmp
;
386 int r_flags
; /* flags on request, see below */
387 int r_retry
; /* max retransmission count */
388 int r_rexmit
; /* current retrans count */
389 int r_timer
; /* tick counter on reply */
390 u_int32_t r_procnum
; /* NFS procedure number */
391 int r_rtt
; /* RTT for rpc */
392 struct proc
*r_procp
; /* Proc that did I/O system call */
393 long r_lastmsg
; /* time of last tprintf */
397 * Queue head for nfsreq's
399 extern TAILQ_HEAD(nfs_reqq
, nfsreq
) nfs_reqq
;
401 /* Flag values for r_flags */
402 #define R_TIMING 0x0001 /* timing request (in mntp) */
403 #define R_SENT 0x0002 /* request has been sent */
404 #define R_SOFTTERM 0x0004 /* soft mnt, too many retries */
405 #define R_INTR 0x0008 /* intr mnt, signal pending */
406 #define R_SOCKERR 0x0010 /* Fatal error on socket */
407 #define R_TPRINTFMSG 0x0020 /* Did a tprintf msg. */
408 #define R_MUSTRESEND 0x0040 /* Must resend request */
409 #define R_GETONEREP 0x0080 /* Probe for one reply only */
410 #define R_BUSY 0x0100 /* Locked. */
411 #define R_WAITING 0x0200 /* Someone waiting for lock. */
412 #define R_RESENDERR 0x0400 /* resend failed. */
415 * A list of nfssvc_sock structures is maintained with all the sockets
416 * that require service by the nfsd.
417 * The nfsuid structs hang off of the nfssvc_sock structs in both lru
418 * and uid hash lists.
420 #ifndef NFS_UIDHASHSIZ
421 #define NFS_UIDHASHSIZ 29 /* Tune the size of nfssvc_sock with this */
423 #define NUIDHASH(sock, uid) \
424 (&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
425 #define NWDELAYHASH(sock, f) \
426 (&(sock)->ns_wdelayhashtbl[(*((u_long *)(f))) % NFS_WDELAYHASHSIZ])
427 #define NMUIDHASH(nmp, uid) \
428 (&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
429 #define NFSNOHASH(fhsum) \
430 (&nfsnodehashtbl[(fhsum) & nfsnodehash])
433 * Network address hash list element
437 struct mbuf
*had_nam
;
441 TAILQ_ENTRY(nfsuid
) nu_lru
; /* LRU chain */
442 LIST_ENTRY(nfsuid
) nu_hash
; /* Hash list */
443 int nu_flag
; /* Flags */
444 union nethostaddr nu_haddr
; /* Host addr. for dgram sockets */
445 struct ucred nu_cr
; /* Cred uid mapped to */
446 int nu_expire
; /* Expiry time (sec) */
447 struct timeval nu_timestamp
; /* Kerb. timestamp */
448 u_long nu_nickname
; /* Nickname on server */
449 NFSKERBKEY_T nu_key
; /* and session key */
452 #define nu_inetaddr nu_haddr.had_inetaddr
453 #define nu_nam nu_haddr.had_nam
454 /* Bits for nu_flag */
455 #define NU_INETADDR 0x1
457 #define NU_NETFAM(u) (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
460 /* XXX CSM 12/2/97 When/if we merge queue.h */
462 STAILQ_ENTRY(nfsrv_rec
) nr_link
;
463 struct sockaddr
*nr_address
;
464 struct mbuf
*nr_packet
;
469 TAILQ_ENTRY(nfssvc_sock
) ns_chain
; /* List of all nfssvc_sock's */
470 TAILQ_HEAD(, nfsuid
) ns_uidlruhead
;
472 struct socket
*ns_so
;
475 struct mbuf
*ns_rawend
;
477 struct mbuf
*ns_recend
;
478 struct mbuf
*ns_frag
;
479 short ns_flag
; /* modified under kernel funnel */
480 short ns_nflag
; /* modified under network funnel */
486 LIST_HEAD(, nfsrv_descript
) ns_tq
; /* Write gather lists */
487 LIST_HEAD(, nfsuid
) ns_uidhashtbl
[NFS_UIDHASHSIZ
];
488 LIST_HEAD(nfsrvw_delayhash
, nfsrv_descript
) ns_wdelayhashtbl
[NFS_WDELAYHASHSIZ
];
491 /* Bits for "ns_*flag" */
492 #define SLP_VALID 0x01 /* ns_flag */
493 #define SLP_DOREC 0x02 /* ns_flag */
494 #define SLPN_NEEDQ 0x04 /* ns_nflag */
495 #define SLPN_DISCONN 0x08 /* ns_nflag */
496 #define SLPN_GETSTREAM 0x10 /* ns_nflag */
497 #define SLPN_LASTFRAG 0x20 /* ns_nflag */
498 #define SLP_ALLFLAGS 0xff /* ns_flag && ns_nflag */
500 extern TAILQ_HEAD(nfssvc_sockhead
, nfssvc_sock
) nfssvc_sockhead
;
501 extern int nfssvc_sockhead_flag
;
502 #define SLP_INIT 0x01
503 #define SLP_WANTINIT 0x02
506 * One of these structures is allocated for each nfsd.
509 TAILQ_ENTRY(nfsd
) nfsd_chain
; /* List of all nfsd's */
510 int nfsd_flag
; /* NFSD_ flags */
511 struct nfssvc_sock
*nfsd_slp
; /* Current socket */
512 int nfsd_authlen
; /* Authenticator len */
513 u_char nfsd_authstr
[RPCAUTH_MAXSIZ
]; /* Authenticator data */
514 int nfsd_verflen
; /* and the Verifier */
515 u_char nfsd_verfstr
[RPCVERF_MAXSIZ
];
516 struct proc
*nfsd_procp
; /* Proc ptr */
517 struct nfsrv_descript
*nfsd_nd
; /* Associated nfsrv_descript */
520 /* Bits for "nfsd_flag" */
521 #define NFSD_WAITING 0x01
522 #define NFSD_REQINPROG 0x02
523 #define NFSD_NEEDAUTH 0x04
524 #define NFSD_AUTHFAIL 0x08
527 * This structure is used by the server for describing each request.
528 * Some fields are used only when write request gathering is performed.
530 struct nfsrv_descript
{
531 u_quad_t nd_time
; /* Write deadline (usec) */
532 off_t nd_off
; /* Start byte offset */
533 off_t nd_eoff
; /* and end byte offset */
534 LIST_ENTRY(nfsrv_descript
) nd_hash
; /* Hash list */
535 LIST_ENTRY(nfsrv_descript
) nd_tq
; /* and timer list */
536 LIST_HEAD(,nfsrv_descript
) nd_coalesce
; /* coalesced writes */
537 struct mbuf
*nd_mrep
; /* Request mbuf list */
538 struct mbuf
*nd_md
; /* Current dissect mbuf */
539 struct mbuf
*nd_mreq
; /* Reply mbuf list */
540 struct mbuf
*nd_nam
; /* and socket addr */
541 struct mbuf
*nd_nam2
; /* return socket addr */
542 caddr_t nd_dpos
; /* Current dissect pos */
543 u_int32_t nd_procnum
; /* RPC # */
544 int nd_stable
; /* storage type */
545 int nd_flag
; /* nd_flag */
546 int nd_len
; /* Length of this write */
547 int nd_repstat
; /* Reply status */
548 u_long nd_retxid
; /* Reply xid */
549 u_long nd_duration
; /* Lease duration */
550 struct timeval nd_starttime
; /* Time RPC initiated */
551 fhandle_t nd_fh
; /* File handle */
552 struct ucred nd_cr
; /* Credentials */
555 /* Bits for "nd_flag" */
556 #define ND_READ LEASE_READ
557 #define ND_WRITE LEASE_WRITE
558 #define ND_CHECK 0x04
559 #define ND_LEASE (ND_READ | ND_WRITE | ND_CHECK)
560 #define ND_NFSV3 0x08
561 #define ND_NQNFS 0x10
562 #define ND_KERBNICK 0x20
563 #define ND_KERBFULL 0x40
564 #define ND_KERBAUTH (ND_KERBNICK | ND_KERBFULL)
566 extern TAILQ_HEAD(nfsd_head
, nfsd
) nfsd_head
;
567 extern int nfsd_head_flag
;
568 #define NFSD_CHECKSLP 0x01
571 * These macros compare nfsrv_descript structures.
573 #define NFSW_CONTIG(o, n) \
574 ((o)->nd_eoff >= (n)->nd_off && \
575 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
577 #define NFSW_SAMECRED(o, n) \
578 (((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \
579 !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
580 sizeof (struct ucred)))
586 #define WEBNFS_ESC_CHAR '%'
587 #define WEBNFS_SPECCHAR_START 0x80
589 #define WEBNFS_NATIVE_CHAR 0x80
592 * Possibly more here in the future.
596 * Macro for converting escape characters in WebNFS pathnames.
597 * Should really be in libkern.
601 ((c) >= 'a' ? ((c) - ('a' - 10)) : \
602 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
603 #define HEXSTRTOI(p) \
604 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
609 extern int nfs_debug
;
610 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */
611 #define NFS_DEBUG_WG 2 /* server write gathering */
612 #define NFS_DEBUG_RC 4 /* server request caching */
613 #define NFS_DEBUG_SILLY 8 /* nfs_sillyrename (.nfsXXX aka turd files) */
614 #define NFS_DEBUG_DUP 16 /* debug duplicate requests */
615 #define NFS_DEBUG_ATTR 32
617 #define NFS_DPF(cat, args) \
619 if (nfs_debug & NFS_DEBUG_##cat) kprintf args; \
624 #define NFS_DPF(cat, args)
628 int nfs_init
__P((struct vfsconf
*vfsp
));
629 int nfs_reply
__P((struct nfsreq
*));
630 int nfs_getreq
__P((struct nfsrv_descript
*,struct nfsd
*,int));
631 int nfs_send
__P((struct socket
*, struct mbuf
*, struct mbuf
*,
633 int nfs_rephead
__P((int, struct nfsrv_descript
*, struct nfssvc_sock
*,
634 int, int, u_quad_t
*, struct mbuf
**, struct mbuf
**,
636 int nfs_sndlock
__P((struct nfsreq
*));
637 void nfs_sndunlock
__P((struct nfsreq
*));
638 int nfs_slplock
__P((struct nfssvc_sock
*, int));
639 void nfs_slpunlock
__P((struct nfssvc_sock
*));
640 int nfs_disct
__P((struct mbuf
**, caddr_t
*, int, int, caddr_t
*));
641 int nfs_vinvalbuf
__P((struct vnode
*, int, struct ucred
*, struct proc
*,
643 int nfs_readrpc
__P((struct vnode
*, struct uio
*, struct ucred
*));
644 int nfs_writerpc
__P((struct vnode
*, struct uio
*, struct ucred
*, int *,
646 int nfs_readdirrpc
__P((struct vnode
*, struct uio
*, struct ucred
*));
647 int nfs_asyncio
__P((struct nfsbuf
*, struct ucred
*));
648 int nfs_doio
__P((struct nfsbuf
*, struct ucred
*, struct proc
*));
649 int nfs_readlinkrpc
__P((struct vnode
*, struct uio
*, struct ucred
*));
650 int nfs_sigintr
__P((struct nfsmount
*, struct nfsreq
*, struct proc
*));
651 int nfs_readdirplusrpc
__P((struct vnode
*, struct uio
*, struct ucred
*));
652 int nfsm_disct
__P((struct mbuf
**, caddr_t
*, int, int, caddr_t
*));
653 void nfsm_srvfattr
__P((struct nfsrv_descript
*, struct vattr
*,
654 struct nfs_fattr
*));
655 void nfsm_srvwcc
__P((struct nfsrv_descript
*, int, struct vattr
*, int,
656 struct vattr
*, struct mbuf
**, char **));
657 void nfsm_srvpostopattr
__P((struct nfsrv_descript
*, int, struct vattr
*,
658 struct mbuf
**, char **));
659 int netaddr_match
__P((int, union nethostaddr
*, struct mbuf
*));
660 int nfs_request
__P((struct vnode
*, struct mbuf
*, int, struct proc
*,
661 struct ucred
*, struct mbuf
**, struct mbuf
**,
662 caddr_t
*, u_int64_t
*));
663 int nfs_loadattrcache
__P((struct vnode
**, struct mbuf
**, caddr_t
*,
664 struct vattr
*, int, u_int64_t
*));
665 int nfs_namei
__P((struct nameidata
*, fhandle_t
*, int,
666 struct nfssvc_sock
*, struct mbuf
*, struct mbuf
**,
667 caddr_t
*, struct vnode
**, struct proc
*, int, int));
668 void nfsm_adj
__P((struct mbuf
*, int, int));
669 int nfsm_mbuftouio
__P((struct mbuf
**, struct uio
*, int, caddr_t
*));
670 void nfsrv_initcache
__P((void));
671 int nfs_getauth
__P((struct nfsmount
*, struct nfsreq
*, struct ucred
*,
672 char **, int *, char *, int *, NFSKERBKEY_T
));
673 int nfs_getnickauth
__P((struct nfsmount
*, struct ucred
*, char **,
674 int *, char *, int));
675 int nfs_savenickauth
__P((struct nfsmount
*, struct ucred
*, int,
676 NFSKERBKEY_T
, struct mbuf
**, char **,
678 int nfs_adv
__P((struct mbuf
**, caddr_t
*, int, int));
679 void nfs_nhinit
__P((void));
680 void nfs_timer
__P((void*));
681 u_long nfs_hash
__P((nfsfh_t
*, int));
682 int nfsrv_dorec
__P((struct nfssvc_sock
*, struct nfsd
*,
683 struct nfsrv_descript
**));
684 int nfsrv_getcache
__P((struct nfsrv_descript
*, struct nfssvc_sock
*,
686 void nfsrv_updatecache
__P((struct nfsrv_descript
*, int, struct mbuf
*));
687 void nfsrv_cleancache
__P((void));
688 int nfs_connect
__P((struct nfsmount
*, struct nfsreq
*));
689 void nfs_disconnect
__P((struct nfsmount
*));
690 int nfs_getattrcache
__P((struct vnode
*, struct vattr
*));
691 int nfsm_strtmbuf
__P((struct mbuf
**, char **, char *, long));
692 int nfs_bioread
__P((struct vnode
*, struct uio
*, int, struct ucred
*,
694 int nfsm_uiotombuf
__P((struct uio
*, struct mbuf
**, int, caddr_t
*));
695 void nfsrv_init
__P((int));
696 int nfs_commit
__P((struct vnode
*vp
, u_quad_t offset
, int cnt
,
697 struct ucred
*cred
, struct proc
*procp
));
698 int nfs_flushcommits(struct vnode
*, struct proc
*);
699 void nfs_clearcommit
__P((struct mount
*));
700 int nfsrv_errmap
__P((struct nfsrv_descript
*, int));
701 void nfsrvw_sort
__P((gid_t
*, int));
702 void nfsrv_setcred
__P((struct ucred
*, struct ucred
*));
703 int nfs_buf_write
__P((struct nfsbuf
*));
704 int nfsrv_object_create
__P((struct vnode
*));
705 void nfsrv_wakenfsd
__P((struct nfssvc_sock
*slp
));
706 int nfsrv_writegather
__P((struct nfsrv_descript
**, struct nfssvc_sock
*,
707 struct proc
*, struct mbuf
**));
708 int nfs_fsinfo
__P((struct nfsmount
*, struct vnode
*, struct ucred
*,
711 int nfsrv3_access
__P((struct nfsrv_descript
*nfsd
,
712 struct nfssvc_sock
*slp
,
713 struct proc
*procp
, struct mbuf
**mrq
));
714 int nfsrv_commit
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
715 struct proc
*procp
, struct mbuf
**mrq
));
716 int nfsrv_create
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
717 struct proc
*procp
, struct mbuf
**mrq
));
718 int nfsrv_fhtovp
__P((fhandle_t
*, int, struct vnode
**, struct ucred
*,
719 struct nfssvc_sock
*, struct mbuf
*, int *,
721 int nfsrv_setpublicfs
__P((struct mount
*, struct netexport
*,
722 struct export_args
*));
723 int nfs_ispublicfh
__P((fhandle_t
*));
724 int nfsrv_fsinfo
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
725 struct proc
*procp
, struct mbuf
**mrq
));
726 int nfsrv_getattr
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
727 struct proc
*procp
, struct mbuf
**mrq
));
728 int nfsrv_link
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
729 struct proc
*procp
, struct mbuf
**mrq
));
730 int nfsrv_lookup
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
731 struct proc
*procp
, struct mbuf
**mrq
));
732 int nfsrv_mkdir
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
733 struct proc
*procp
, struct mbuf
**mrq
));
734 int nfsrv_mknod
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
735 struct proc
*procp
, struct mbuf
**mrq
));
736 int nfsrv_noop
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
737 struct proc
*procp
, struct mbuf
**mrq
));
738 int nfsrv_null
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
739 struct proc
*procp
, struct mbuf
**mrq
));
740 int nfsrv_pathconf
__P((struct nfsrv_descript
*nfsd
,
741 struct nfssvc_sock
*slp
, struct proc
*procp
,
743 int nfsrv_read
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
744 struct proc
*procp
, struct mbuf
**mrq
));
745 int nfsrv_readdir
__P((struct nfsrv_descript
*nfsd
,
746 struct nfssvc_sock
*slp
,
747 struct proc
*procp
, struct mbuf
**mrq
));
748 int nfsrv_readdirplus
__P((struct nfsrv_descript
*nfsd
,
749 struct nfssvc_sock
*slp
, struct proc
*procp
,
751 int nfsrv_readlink
__P((struct nfsrv_descript
*nfsd
,
752 struct nfssvc_sock
*slp
, struct proc
*procp
,
754 int nfsrv_remove
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
755 struct proc
*procp
, struct mbuf
**mrq
));
756 int nfsrv_rename
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
757 struct proc
*procp
, struct mbuf
**mrq
));
758 int nfsrv_rmdir
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
759 struct proc
*procp
, struct mbuf
**mrq
));
760 int nfsrv_setattr
__P((struct nfsrv_descript
*nfsd
,
761 struct nfssvc_sock
*slp
,
762 struct proc
*procp
, struct mbuf
**mrq
));
763 int nfsrv_statfs
__P((struct nfsrv_descript
*nfsd
,
764 struct nfssvc_sock
*slp
,
765 struct proc
*procp
, struct mbuf
**mrq
));
766 int nfsrv_symlink
__P((struct nfsrv_descript
*nfsd
,
767 struct nfssvc_sock
*slp
,
768 struct proc
*procp
, struct mbuf
**mrq
));
769 int nfsrv_write
__P((struct nfsrv_descript
*nfsd
, struct nfssvc_sock
*slp
,
770 struct proc
*procp
, struct mbuf
**mrq
));
771 void nfsrv_rcv
__P((struct socket
*so
, caddr_t arg
, int waitflag
));
772 void nfsrv_slpderef
__P((struct nfssvc_sock
*slp
));
775 * NFSTRACE points were changed to FSDBG (KERNEL_DEBUG)
776 * But some of this code may prove useful someday...
781 extern int nfstraceindx
;
782 #define NFSTBUFSIZ 8912
783 struct nfstracerec
{ uint i1
, i2
, i3
, i4
; };
784 extern struct nfstracerec nfstracebuf
[NFSTBUFSIZ
];
785 extern uint nfstracemask
; /* 32 bits - trace points over 31 are unconditional */
787 /* 0x0000000f nfs_getattrcache trace points */
788 #define NFSTRC_GAC_MISS 0x00 /* 0x00000001 cache miss */
789 #define NFSTRC_GAC_HIT 0x01 /* 0x00000002 cache hit */
790 #define NFSTRC_GAC_NP 0x02 /* 0x00000004 np size mismatch - vp... */
791 /* 0x00000038 nfs_loadattrcache trace points */
792 #define NFSTRC_LAC 0x03 /* 0x00000008 function entry point - vp */
793 #define NFSTRC_LAC_INIT 0x04 /* 0x00000010 new vp & init n_mtime - vp */
794 #define NFSTRC_LAC_NP 0x05 /* 0x00000020 np size mismatch - vp... */
795 /* 0x000000c0 nfs_getattr trace points */
796 #define NFSTRC_GA_INV 0x06 /* 0x00000040 times mismatch - vp */
797 #define NFSTRC_GA_INV1 0x07 /* 0x00000080 invalidate ok - vp */
798 /* 0x00000100 vmp_invalidate trace points */
799 #define NFSTRC_VMP_INV 0x08 /* 0x00000100 function entry point - vmp */
800 /* 0x00000200 nfs_request trace points */
801 #define NFSTRC_REQ 0x09 /* 0x00000200 - alternates vp and procnum */
802 /* 0x00000c00 vmp_push_range trace points */
803 #define NFSTRC_VPR 0xa /* 0x00000400 entry point - vp... */
804 #define NFSTRC_VPR_DONE 0xb /* 0x00000800 tail exit - error # */
805 /* 0x00003000 nfs_doio trace points */
806 #define NFSTRC_DIO 0xc /* 0x00001000 entry point - vp */
807 #define NFSTRC_DIO_DONE 0xd /* 0x00002000 exit points - vp */
808 /* 0x000fc000 congestion window trace points */
809 #define NFSTRC_CWND_INIT 0xe
810 #define NFSTRC_CWND_REPLY 0xf
811 #define NFSTRC_CWND_TIMER 0x10
812 #define NFSTRC_CWND_REQ1 0x11
813 #define NFSTRC_CWND_REQ2 0x12
814 #define NFSTRC_CWND_SOFT 0x13
815 /* 0xfff00000 nfs_rcvlock & nfs_rcvunlock trace points */
816 #define NFSTRC_ECONN 0x14
817 #define NFSTRC_RCVERR 0x15
818 #define NFSTRC_REQFREE 0x16
819 #define NFSTRC_NOTMINE 0x17
820 #define NFSTRC_6 0x18
821 #define NFSTRC_7 0x19
822 #define NFSTRC_RCVLCKINTR 0x1a
823 #define NFSTRC_RCVALREADY 0x1b
824 #define NFSTRC_RCVLCKW 0x1c /* 0x10000000 seeking recieve lock (waiting) */
825 #define NFSTRC_RCVLCK 0x1d /* 0x20000000 getting recieve lock */
826 #define NFSTRC_RCVUNLW 0x1e /* 0x40000000 releasing rcv lock w/ wakeup */
827 #define NFSTRC_RCVUNL 0x1f /* 0x80000000 releasing rcv lock w/o wakeup */
828 /* trace points beyond 31 are on if any of above points are on */
829 #define NFSTRC_GA_INV2 0x20 /* nfs_getattr invalidate - error# */
830 #define NFSTRC_VBAD 0x21
831 #define NFSTRC_REQERR 0x22
832 #define NFSTRC_RPCERR 0x23
833 #define NFSTRC_DISSECTERR 0x24
834 #define NFSTRC_CONTINUE 0xff /* continuation record for previous entry */
836 #define NFSTRACEX(a1, a2, a3, a4) \
838 nfstracebuf[nfstraceindx].i1 = (uint)(a1), \
839 nfstracebuf[nfstraceindx].i2 = (uint)(a2), \
840 nfstracebuf[nfstraceindx].i3 = (uint)(a3), \
841 nfstracebuf[nfstraceindx].i4 = (uint)(a4), \
842 nfstraceindx = (nfstraceindx + 1) % NFSTBUFSIZ, \
846 #define NFSTRACE(cnst, fptr) \
848 (nfstracemask && ((cnst) > 31 || nfstracemask & 1<<(cnst))) ? \
849 NFSTRACEX((cnst), (fptr), current_thread(), \
850 clock_get_system_value().tv_nsec) : \
854 #define NFSTRACE4(cnst, fptr, a2, a3, a4) \
856 NFSTRACE(cnst,fptr) ? \
857 NFSTRACEX(NFSTRC_CONTINUE, a2, a3, a4) : \
863 # define NFSTRACE(cnst, fptr)
864 # define NFSTRACE4(cnst, fptr, a2, a3, a4)
869 #endif /* __APPLE_API_PRIVATE */