]> git.saurik.com Git - apple/xnu.git/blob - bsd/nfs/nfs.h
projects / apple / xnu.git / blob
? search:


b8d810f1109f625851440796ff87a6f2b688af02
[apple/xnu.git] / bsd / nfs / nfs.h
1 /*
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
7 *
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
13 * file.
14 *
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.
22 *
23 * @APPLE_LICENSE_HEADER_END@
24 */
25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
26 /*
27 * Copyright (c) 1989, 1993, 1995
28 * The Regents of the University of California. All rights reserved.
29 *
30 * This code is derived from software contributed to Berkeley by
31 * Rick Macklem at The University of Guelph.
32 *
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
35 * are met:
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.
48 *
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
59 * SUCH DAMAGE.
60 *
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 $
63 */
64
65 #ifndef _NFS_NFS_H_
66 #define _NFS_NFS_H_
67
68 #include <sys/appleapiopts.h>
69
70 #ifdef __APPLE_API_PRIVATE
71 /*
72 * Tunable constants for nfs
73 */
74
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 */
88 #endif
89 #ifndef NFS_MAXATTRTIMO
90 #define NFS_MAXATTRTIMO 60
91 #endif
92 #define NFS_WSIZE 8192 /* Def. write data size <= 8192 */
93 #define NFS_RSIZE 8192 /* Def. read data size <= 8192 */
94 #define NFS_READDIRSIZE 8192 /* Def. readdir size */
95 #define NFS_DEFRAHEAD 1 /* Def. read ahead # blocks */
96 #define NFS_MAXRAHEAD 4 /* Max. read ahead # blocks */
97 #define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */
98 #define NFS_MAXASYNCDAEMON 20 /* Max. number async_daemons runnable */
99 #define NFS_MAXGATHERDELAY 100 /* Max. write gather delay (msec) */
100 #ifndef NFS_GATHERDELAY
101 #define NFS_GATHERDELAY 10 /* Default write gather delay (msec) */
102 #endif
103 #define NFS_DIRBLKSIZ 4096 /* Must be a multiple of DIRBLKSIZ */
104
105 /*
106 * Oddballs
107 */
108 #define NMOD(a) ((a) % nfs_asyncdaemons)
109 #define NFS_CMPFH(n, f, s) \
110 ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
111 #define NFS_ISV3(v) (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
112 #define NFS_SRVMAXDATA(n) \
113 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
114 NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
115
116 /*
117 * XXX
118 * The B_INVAFTERWRITE flag should be set to whatever is required by the
119 * buffer cache code to say "Invalidate the block after it is written back".
120 */
121 #ifdef __FreeBSD__
122 #define B_INVAFTERWRITE B_NOCACHE
123 #else
124 #define B_INVAFTERWRITE B_INVAL
125 #endif
126
127 /*
128 * The IO_METASYNC flag should be implemented for local file systems.
129 * (Until then, it is nothin at all.)
130 */
131 #ifndef IO_METASYNC
132 #define IO_METASYNC 0
133 #endif
134
135 /*
136 * Set the attribute timeout based on how recently the file has been modified.
137 */
138 #define NFS_ATTRTIMEO(np) \
139 ((((np)->n_flag & NMODIFIED) || \
140 (time.tv_sec - (np)->n_mtime) / 10 < NFS_MINATTRTIMO) ? NFS_MINATTRTIMO : \
141 ((time.tv_sec - (np)->n_mtime) / 10 > NFS_MAXATTRTIMO ? NFS_MAXATTRTIMO : \
142 (time.tv_sec - (np)->n_mtime) / 10))
143
144 /*
145 * Expected allocation sizes for major data structures. If the actual size
146 * of the structure exceeds these sizes, then malloc() will be allocating
147 * almost twice the memory required. This is used in nfs_init() to warn
148 * the sysadmin that the size of a structure should be reduced.
149 * (These sizes are always a power of 2. If the kernel malloc() changes
150 * to one that does not allocate space in powers of 2 size, then this all
151 * becomes bunk!).
152 * Note that some of these structures come out of there own nfs zones.
153 */
154 #define NFS_NODEALLOC 512
155 #define NFS_MNTALLOC 512
156 #define NFS_SVCALLOC 256
157 #define NFS_UIDALLOC 128
158
159 /*
160 * Arguments to mount NFS
161 */
162 #define NFS_ARGSVERSION 3 /* change when nfs_args changes */
163 struct nfs_args {
164 int version; /* args structure version number */
165 struct sockaddr *addr; /* file server address */
166 int addrlen; /* length of address */
167 int sotype; /* Socket type */
168 int proto; /* and Protocol */
169 u_char *fh; /* File handle to be mounted */
170 int fhsize; /* Size, in bytes, of fh */
171 int flags; /* flags */
172 int wsize; /* write size in bytes */
173 int rsize; /* read size in bytes */
174 int readdirsize; /* readdir size in bytes */
175 int timeo; /* initial timeout in .1 secs */
176 int retrans; /* times to retry send */
177 int maxgrouplist; /* Max. size of group list */
178 int readahead; /* # of blocks to readahead */
179 int leaseterm; /* Term (sec) of lease */
180 int deadthresh; /* Retrans threshold */
181 char *hostname; /* server's name */
182 };
183
184 /*
185 * NFS mount option flags
186 */
187 #define NFSMNT_SOFT 0x00000001 /* soft mount (hard is default) */
188 #define NFSMNT_WSIZE 0x00000002 /* set write size */
189 #define NFSMNT_RSIZE 0x00000004 /* set read size */
190 #define NFSMNT_TIMEO 0x00000008 /* set initial timeout */
191 #define NFSMNT_RETRANS 0x00000010 /* set number of request retries */
192 #define NFSMNT_MAXGRPS 0x00000020 /* set maximum grouplist size */
193 #define NFSMNT_INT 0x00000040 /* allow interrupts on hard mount */
194 #define NFSMNT_NOCONN 0x00000080 /* Don't Connect the socket */
195 #define NFSMNT_NQNFS 0x00000100 /* Use Nqnfs protocol */
196 #define NFSMNT_NFSV3 0x00000200 /* Use NFS Version 3 protocol */
197 #define NFSMNT_KERB 0x00000400 /* Use Kerberos authentication */
198 #define NFSMNT_DUMBTIMR 0x00000800 /* Don't estimate rtt dynamically */
199 #define NFSMNT_LEASETERM 0x00001000 /* set lease term (nqnfs) */
200 #define NFSMNT_READAHEAD 0x00002000 /* set read ahead */
201 #define NFSMNT_DEADTHRESH 0x00004000 /* set dead server retry thresh */
202 #define NFSMNT_RESVPORT 0x00008000 /* Allocate a reserved port */
203 #define NFSMNT_RDIRPLUS 0x00010000 /* Use Readdirplus for V3 */
204 #define NFSMNT_READDIRSIZE 0x00020000 /* Set readdir size */
205 #define NFSMNT_INTERNAL 0xfffc0000 /* Bits set internally */
206 #define NFSMNT_HASWRITEVERF 0x00040000 /* Has write verifier for V3 */
207 #define NFSMNT_GOTPATHCONF 0x00080000 /* Got the V3 pathconf info */
208 #define NFSMNT_GOTFSINFO 0x00100000 /* Got the V3 fsinfo */
209 #define NFSMNT_MNTD 0x00200000 /* Mnt server for mnt point */
210 #define NFSMNT_DISMINPROG 0x00400000 /* Dismount in progress */
211 #define NFSMNT_DISMNT 0x00800000 /* Dismounted */
212 #define NFSMNT_SNDLOCK 0x01000000 /* Send socket lock */
213 #define NFSMNT_WANTSND 0x02000000 /* Want above */
214 #define NFSMNT_RCVLOCK 0x04000000 /* Rcv socket lock */
215 #define NFSMNT_WANTRCV 0x08000000 /* Want above */
216 #define NFSMNT_WAITAUTH 0x10000000 /* Wait for authentication */
217 #define NFSMNT_HASAUTH 0x20000000 /* Has authenticator */
218 #define NFSMNT_WANTAUTH 0x40000000 /* Wants an authenticator */
219 #define NFSMNT_AUTHERR 0x80000000 /* Authentication error */
220
221 /*
222 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
223 * should ever try and use it.
224 */
225 struct nfsd_args {
226 int sock; /* Socket to serve */
227 caddr_t name; /* Client addr for connection based sockets */
228 int namelen; /* Length of name */
229 };
230
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 */
239 u_char *nsd_verfstr;
240 struct timeval nsd_timestamp; /* timestamp from verifier */
241 u_long nsd_ttl; /* credential ttl (sec) */
242 NFSKERBKEY_T nsd_key; /* Session key */
243 };
244
245 struct nfsd_cargs {
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 */
252 u_char *ncd_verfstr;
253 NFSKERBKEY_T ncd_key; /* Session key */
254 };
255
256 /*
257 * XXX to allow amd to include nfs.h without nfsproto.h
258 */
259 #ifdef NFS_NPROCS
260 /*
261 * Stats structure
262 */
263 struct nfsstats {
264 int attrcache_hits;
265 int attrcache_misses;
266 int lookupcache_hits;
267 int lookupcache_misses;
268 int direofcache_hits;
269 int direofcache_misses;
270 int biocache_reads;
271 int read_bios;
272 int read_physios;
273 int biocache_writes;
274 int write_bios;
275 int write_physios;
276 int biocache_readlinks;
277 int readlink_bios;
278 int biocache_readdirs;
279 int readdir_bios;
280 int rpccnt[NFS_NPROCS];
281 int rpcretries;
282 int srvrpccnt[NFS_NPROCS];
283 int srvrpc_errs;
284 int srv_errs;
285 int rpcrequests;
286 int rpctimeouts;
287 int rpcunexpected;
288 int rpcinvalid;
289 int srvcache_inproghits;
290 int srvcache_idemdonehits;
291 int srvcache_nonidemdonehits;
292 int srvcache_misses;
293 int srvnqnfs_leases;
294 int srvnqnfs_maxleases;
295 int srvnqnfs_getleases;
296 int srvvop_writes;
297 int pageins;
298 int pageouts;
299 };
300 #endif
301
302 /*
303 * Flags for nfssvc() system call.
304 */
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
312
313 /*
314 * fs.nfs sysctl(3) identifiers
315 */
316 #define NFS_NFSSTATS 1 /* struct: struct nfsstats */
317 #define NFS_NFSPRIVPORT 2 /* int: prohibit nfs to resvports */
318
319 #define FS_NFS_NAMES { \
320 { 0, 0 }, \
321 { "nfsstats", CTLTYPE_STRUCT }, \
322 { "nfsprivport", CTLTYPE_INT }, \
323 }
324
325 #ifndef NFS_MUIDHASHSIZ
326 #define NFS_MUIDHASHSIZ 63 /* Tune the size of nfsmount with this */
327 #endif
328 #ifndef NFS_WDELAYHASHSIZ
329 #define NFS_WDELAYHASHSIZ 16 /* and with this */
330 #endif
331
332 /*
333 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
334 * What should be in this set is open to debate, but I believe that since
335 * I/O system calls on ufs are never interrupted by signals the set should
336 * be minimal. My reasoning is that many current programs that use signals
337 * such as SIGALRM will not expect file I/O system calls to be interrupted
338 * by them and break.
339 */
340 #ifdef KERNEL
341
342 #ifdef MALLOC_DECLARE
343 MALLOC_DECLARE(M_NFSREQ);
344 MALLOC_DECLARE(M_NFSMNT);
345 MALLOC_DECLARE(M_NFSDIROFF);
346 MALLOC_DECLARE(M_NFSRVDESC);
347 MALLOC_DECLARE(M_NFSUID);
348 MALLOC_DECLARE(M_NQLEASE);
349 MALLOC_DECLARE(M_NFSD);
350 MALLOC_DECLARE(M_NFSBIGFH);
351 #endif
352
353 struct uio; struct buf; struct vattr; struct nameidata; /* XXX */
354
355 #define NFSINT_SIGMASK (sigmask(SIGINT)|sigmask(SIGTERM)|sigmask(SIGKILL)| \
356 sigmask(SIGHUP)|sigmask(SIGQUIT))
357
358 /*
359 * Socket errors ignored for connectionless sockets??
360 * For now, ignore them all
361 */
362 #define NFSIGNORE_SOERROR(s, e) \
363 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
364 ((s) & PR_CONNREQUIRED) == 0)
365
366 /*
367 * Nfs outstanding request list element
368 */
369 struct nfsreq {
370 TAILQ_ENTRY(nfsreq) r_chain;
371 struct mbuf *r_mreq;
372 struct mbuf *r_mrep;
373 struct mbuf *r_md;
374 caddr_t r_dpos;
375 struct nfsmount *r_nmp;
376 struct vnode *r_vp;
377 u_long r_xid;
378 int r_flags; /* flags on request, see below */
379 int r_retry; /* max retransmission count */
380 int r_rexmit; /* current retrans count */
381 int r_timer; /* tick counter on reply */
382 u_int32_t r_procnum; /* NFS procedure number */
383 int r_rtt; /* RTT for rpc */
384 struct proc *r_procp; /* Proc that did I/O system call */
385 };
386
387 /*
388 * Queue head for nfsreq's
389 */
390 extern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq;
391
392 /* Flag values for r_flags */
393 #define R_TIMING 0x01 /* timing request (in mntp) */
394 #define R_SENT 0x02 /* request has been sent */
395 #define R_SOFTTERM 0x04 /* soft mnt, too many retries */
396 #define R_INTR 0x08 /* intr mnt, signal pending */
397 #define R_SOCKERR 0x10 /* Fatal error on socket */
398 #define R_TPRINTFMSG 0x20 /* Did a tprintf msg. */
399 #define R_MUSTRESEND 0x40 /* Must resend request */
400 #define R_GETONEREP 0x80 /* Probe for one reply only */
401
402 /*
403 * A list of nfssvc_sock structures is maintained with all the sockets
404 * that require service by the nfsd.
405 * The nfsuid structs hang off of the nfssvc_sock structs in both lru
406 * and uid hash lists.
407 */
408 #ifndef NFS_UIDHASHSIZ
409 #define NFS_UIDHASHSIZ 29 /* Tune the size of nfssvc_sock with this */
410 #endif
411 #define NUIDHASH(sock, uid) \
412 (&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
413 #define NWDELAYHASH(sock, f) \
414 (&(sock)->ns_wdelayhashtbl[(*((u_long *)(f))) % NFS_WDELAYHASHSIZ])
415 #define NMUIDHASH(nmp, uid) \
416 (&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
417 #define NFSNOHASH(fhsum) \
418 (&nfsnodehashtbl[(fhsum) & nfsnodehash])
419
420 /*
421 * Network address hash list element
422 */
423 union nethostaddr {
424 u_long had_inetaddr;
425 struct mbuf *had_nam;
426 };
427
428 struct nfsuid {
429 TAILQ_ENTRY(nfsuid) nu_lru; /* LRU chain */
430 LIST_ENTRY(nfsuid) nu_hash; /* Hash list */
431 int nu_flag; /* Flags */
432 union nethostaddr nu_haddr; /* Host addr. for dgram sockets */
433 struct ucred nu_cr; /* Cred uid mapped to */
434 int nu_expire; /* Expiry time (sec) */
435 struct timeval nu_timestamp; /* Kerb. timestamp */
436 u_long nu_nickname; /* Nickname on server */
437 NFSKERBKEY_T nu_key; /* and session key */
438 };
439
440 #define nu_inetaddr nu_haddr.had_inetaddr
441 #define nu_nam nu_haddr.had_nam
442 /* Bits for nu_flag */
443 #define NU_INETADDR 0x1
444 #define NU_NAM 0x2
445 #define NU_NETFAM(u) (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
446
447 #ifdef notyet
448 /* XXX CSM 12/2/97 When/if we merge queue.h */
449 struct nfsrv_rec {
450 STAILQ_ENTRY(nfsrv_rec) nr_link;
451 struct sockaddr *nr_address;
452 struct mbuf *nr_packet;
453 };
454 #endif
455
456 struct nfssvc_sock {
457 TAILQ_ENTRY(nfssvc_sock) ns_chain; /* List of all nfssvc_sock's */
458 TAILQ_HEAD(, nfsuid) ns_uidlruhead;
459 struct file *ns_fp;
460 struct socket *ns_so;
461 struct mbuf *ns_nam;
462 struct mbuf *ns_raw;
463 struct mbuf *ns_rawend;
464 struct mbuf *ns_rec;
465 struct mbuf *ns_recend;
466 struct mbuf *ns_frag;
467 int ns_flag;
468 int ns_solock;
469 int ns_cc;
470 int ns_reclen;
471 int ns_numuids;
472 u_long ns_sref;
473 LIST_HEAD(, nfsrv_descript) ns_tq; /* Write gather lists */
474 LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
475 LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
476 };
477
478 /* Bits for "ns_flag" */
479 #define SLP_VALID 0x01
480 #define SLP_DOREC 0x02
481 #define SLP_NEEDQ 0x04
482 #define SLP_DISCONN 0x08
483 #define SLP_GETSTREAM 0x10
484 #define SLP_LASTFRAG 0x20
485 #define SLP_ALLFLAGS 0xff
486
487 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
488 extern int nfssvc_sockhead_flag;
489 #define SLP_INIT 0x01
490 #define SLP_WANTINIT 0x02
491
492 /*
493 * One of these structures is allocated for each nfsd.
494 */
495 struct nfsd {
496 TAILQ_ENTRY(nfsd) nfsd_chain; /* List of all nfsd's */
497 int nfsd_flag; /* NFSD_ flags */
498 struct nfssvc_sock *nfsd_slp; /* Current socket */
499 int nfsd_authlen; /* Authenticator len */
500 u_char nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
501 int nfsd_verflen; /* and the Verifier */
502 u_char nfsd_verfstr[RPCVERF_MAXSIZ];
503 struct proc *nfsd_procp; /* Proc ptr */
504 struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
505 };
506
507 /* Bits for "nfsd_flag" */
508 #define NFSD_WAITING 0x01
509 #define NFSD_REQINPROG 0x02
510 #define NFSD_NEEDAUTH 0x04
511 #define NFSD_AUTHFAIL 0x08
512
513 /*
514 * This structure is used by the server for describing each request.
515 * Some fields are used only when write request gathering is performed.
516 */
517 struct nfsrv_descript {
518 u_quad_t nd_time; /* Write deadline (usec) */
519 off_t nd_off; /* Start byte offset */
520 off_t nd_eoff; /* and end byte offset */
521 LIST_ENTRY(nfsrv_descript) nd_hash; /* Hash list */
522 LIST_ENTRY(nfsrv_descript) nd_tq; /* and timer list */
523 LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */
524 struct mbuf *nd_mrep; /* Request mbuf list */
525 struct mbuf *nd_md; /* Current dissect mbuf */
526 struct mbuf *nd_mreq; /* Reply mbuf list */
527 struct mbuf *nd_nam; /* and socket addr */
528 struct mbuf *nd_nam2; /* return socket addr */
529 caddr_t nd_dpos; /* Current dissect pos */
530 u_int32_t nd_procnum; /* RPC # */
531 int nd_stable; /* storage type */
532 int nd_flag; /* nd_flag */
533 int nd_len; /* Length of this write */
534 int nd_repstat; /* Reply status */
535 u_long nd_retxid; /* Reply xid */
536 u_long nd_duration; /* Lease duration */
537 struct timeval nd_starttime; /* Time RPC initiated */
538 fhandle_t nd_fh; /* File handle */
539 struct ucred nd_cr; /* Credentials */
540 };
541
542 /* Bits for "nd_flag" */
543 #define ND_READ LEASE_READ
544 #define ND_WRITE LEASE_WRITE
545 #define ND_CHECK 0x04
546 #define ND_LEASE (ND_READ | ND_WRITE | ND_CHECK)
547 #define ND_NFSV3 0x08
548 #define ND_NQNFS 0x10
549 #define ND_KERBNICK 0x20
550 #define ND_KERBFULL 0x40
551 #define ND_KERBAUTH (ND_KERBNICK | ND_KERBFULL)
552
553 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
554 extern int nfsd_head_flag;
555 #define NFSD_CHECKSLP 0x01
556
557 /*
558 * These macros compare nfsrv_descript structures.
559 */
560 #define NFSW_CONTIG(o, n) \
561 ((o)->nd_eoff >= (n)->nd_off && \
562 !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
563
564 #define NFSW_SAMECRED(o, n) \
565 (((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \
566 !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
567 sizeof (struct ucred)))
568
569 /*
570 * Defines for WebNFS
571 */
572
573 #define WEBNFS_ESC_CHAR '%'
574 #define WEBNFS_SPECCHAR_START 0x80
575
576 #define WEBNFS_NATIVE_CHAR 0x80
577 /*
578 * ..
579 * Possibly more here in the future.
580 */
581
582 /*
583 * Macro for converting escape characters in WebNFS pathnames.
584 * Should really be in libkern.
585 */
586
587 #define HEXTOC(c) \
588 ((c) >= 'a' ? ((c) - ('a' - 10)) : \
589 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
590 #define HEXSTRTOI(p) \
591 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
592
593 #define NFSDIAG 0
594 #if NFSDIAG
595
596 extern int nfs_debug;
597 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */
598 #define NFS_DEBUG_WG 2 /* server write gathering */
599 #define NFS_DEBUG_RC 4 /* server request caching */
600 #define NFS_DEBUG_SILLY 8 /* nfs_sillyrename (.nfsXXX aka turd files) */
601 #define NFS_DEBUG_DUP 16 /* debug duplicate requests */
602 #define NFS_DEBUG_ATTR 32
603
604 #define NFS_DPF(cat, args) \
605 do { \
606 if (nfs_debug & NFS_DEBUG_##cat) kprintf args; \
607 } while (0)
608
609 #else
610
611 #define NFS_DPF(cat, args)
612
613 #endif /* NFSDIAG */
614
615 int nfs_init __P((struct vfsconf *vfsp));
616 int nfs_reply __P((struct nfsreq *));
617 int nfs_getreq __P((struct nfsrv_descript *,struct nfsd *,int));
618 int nfs_send __P((struct socket *, struct mbuf *, struct mbuf *,
619 struct nfsreq *));
620 int nfs_rephead __P((int, struct nfsrv_descript *, struct nfssvc_sock *,
621 int, int, u_quad_t *, struct mbuf **, struct mbuf **,
622 caddr_t *));
623 int nfs_sndlock __P((int *, struct nfsreq *));
624 void nfs_sndunlock __P((int *flagp));
625 int nfs_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
626 int nfs_vinvalbuf __P((struct vnode *, int, struct ucred *, struct proc *,
627 int));
628 int nfs_readrpc __P((struct vnode *, struct uio *, struct ucred *));
629 int nfs_writerpc __P((struct vnode *, struct uio *, struct ucred *, int *,
630 int *));
631 int nfs_readdirrpc __P((struct vnode *, struct uio *, struct ucred *));
632 int nfs_asyncio __P((struct buf *, struct ucred *));
633 int nfs_doio __P((struct buf *, struct ucred *, struct proc *));
634 int nfs_readlinkrpc __P((struct vnode *, struct uio *, struct ucred *));
635 int nfs_sigintr __P((struct nfsmount *, struct nfsreq *, struct proc *));
636 int nfs_readdirplusrpc __P((struct vnode *, struct uio *, struct ucred *));
637 int nfsm_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
638 void nfsm_srvfattr __P((struct nfsrv_descript *, struct vattr *,
639 struct nfs_fattr *));
640 void nfsm_srvwcc __P((struct nfsrv_descript *, int, struct vattr *, int,
641 struct vattr *, struct mbuf **, char **));
642 void nfsm_srvpostopattr __P((struct nfsrv_descript *, int, struct vattr *,
643 struct mbuf **, char **));
644 int netaddr_match __P((int, union nethostaddr *, struct mbuf *));
645 int nfs_request __P((struct vnode *, struct mbuf *, int, struct proc *,
646 struct ucred *, struct mbuf **, struct mbuf **,
647 caddr_t *, u_int64_t *));
648 int nfs_loadattrcache __P((struct vnode **, struct mbuf **, caddr_t *,
649 struct vattr *, int, u_int64_t *));
650 int nfs_namei __P((struct nameidata *, fhandle_t *, int,
651 struct nfssvc_sock *, struct mbuf *, struct mbuf **,
652 caddr_t *, struct vnode **, struct proc *, int, int));
653 void nfsm_adj __P((struct mbuf *, int, int));
654 int nfsm_mbuftouio __P((struct mbuf **, struct uio *, int, caddr_t *));
655 void nfsrv_initcache __P((void));
656 int nfs_getauth __P((struct nfsmount *, struct nfsreq *, struct ucred *,
657 char **, int *, char *, int *, NFSKERBKEY_T));
658 int nfs_getnickauth __P((struct nfsmount *, struct ucred *, char **,
659 int *, char *, int));
660 int nfs_savenickauth __P((struct nfsmount *, struct ucred *, int,
661 NFSKERBKEY_T, struct mbuf **, char **,
662 struct mbuf *));
663 int nfs_adv __P((struct mbuf **, caddr_t *, int, int));
664 void nfs_nhinit __P((void));
665 void nfs_timer __P((void*));
666 u_long nfs_hash __P((nfsfh_t *, int));
667 int nfsrv_dorec __P((struct nfssvc_sock *, struct nfsd *,
668 struct nfsrv_descript **));
669 int nfsrv_getcache __P((struct nfsrv_descript *, struct nfssvc_sock *,
670 struct mbuf **));
671 void nfsrv_updatecache __P((struct nfsrv_descript *, int, struct mbuf *));
672 void nfsrv_cleancache __P((void));
673 int nfs_connect __P((struct nfsmount *, struct nfsreq *));
674 void nfs_disconnect __P((struct nfsmount *));
675 int nfs_getattrcache __P((struct vnode *, struct vattr *));
676 int nfsm_strtmbuf __P((struct mbuf **, char **, char *, long));
677 int nfs_bioread __P((struct vnode *, struct uio *, int, struct ucred *,
678 int));
679 int nfsm_uiotombuf __P((struct uio *, struct mbuf **, int, caddr_t *));
680 void nfsrv_init __P((int));
681 void nfs_clearcommit __P((struct mount *));
682 int nfsrv_errmap __P((struct nfsrv_descript *, int));
683 void nfsrvw_sort __P((gid_t *, int));
684 void nfsrv_setcred __P((struct ucred *, struct ucred *));
685 int nfs_writebp __P((struct buf *, int));
686 int nfsrv_object_create __P((struct vnode *));
687 void nfsrv_wakenfsd __P((struct nfssvc_sock *slp));
688 int nfsrv_writegather __P((struct nfsrv_descript **, struct nfssvc_sock *,
689 struct proc *, struct mbuf **));
690 int nfs_fsinfo __P((struct nfsmount *, struct vnode *, struct ucred *,
691 struct proc *p));
692
693 int nfsrv3_access __P((struct nfsrv_descript *nfsd,
694 struct nfssvc_sock *slp,
695 struct proc *procp, struct mbuf **mrq));
696 int nfsrv_commit __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
697 struct proc *procp, struct mbuf **mrq));
698 int nfsrv_create __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
699 struct proc *procp, struct mbuf **mrq));
700 int nfsrv_fhtovp __P((fhandle_t *, int, struct vnode **, struct ucred *,
701 struct nfssvc_sock *, struct mbuf *, int *,
702 int, int));
703 int nfsrv_setpublicfs __P((struct mount *, struct netexport *,
704 struct export_args *));
705 int nfs_ispublicfh __P((fhandle_t *));
706 int nfsrv_fsinfo __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
707 struct proc *procp, struct mbuf **mrq));
708 int nfsrv_getattr __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
709 struct proc *procp, struct mbuf **mrq));
710 int nfsrv_link __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
711 struct proc *procp, struct mbuf **mrq));
712 int nfsrv_lookup __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
713 struct proc *procp, struct mbuf **mrq));
714 int nfsrv_mkdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
715 struct proc *procp, struct mbuf **mrq));
716 int nfsrv_mknod __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
717 struct proc *procp, struct mbuf **mrq));
718 int nfsrv_noop __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
719 struct proc *procp, struct mbuf **mrq));
720 int nfsrv_null __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
721 struct proc *procp, struct mbuf **mrq));
722 int nfsrv_pathconf __P((struct nfsrv_descript *nfsd,
723 struct nfssvc_sock *slp, struct proc *procp,
724 struct mbuf **mrq));
725 int nfsrv_read __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
726 struct proc *procp, struct mbuf **mrq));
727 int nfsrv_readdir __P((struct nfsrv_descript *nfsd,
728 struct nfssvc_sock *slp,
729 struct proc *procp, struct mbuf **mrq));
730 int nfsrv_readdirplus __P((struct nfsrv_descript *nfsd,
731 struct nfssvc_sock *slp, struct proc *procp,
732 struct mbuf **mrq));
733 int nfsrv_readlink __P((struct nfsrv_descript *nfsd,
734 struct nfssvc_sock *slp, struct proc *procp,
735 struct mbuf **mrq));
736 int nfsrv_remove __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
737 struct proc *procp, struct mbuf **mrq));
738 int nfsrv_rename __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
739 struct proc *procp, struct mbuf **mrq));
740 int nfsrv_rmdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
741 struct proc *procp, struct mbuf **mrq));
742 int nfsrv_setattr __P((struct nfsrv_descript *nfsd,
743 struct nfssvc_sock *slp,
744 struct proc *procp, struct mbuf **mrq));
745 int nfsrv_statfs __P((struct nfsrv_descript *nfsd,
746 struct nfssvc_sock *slp,
747 struct proc *procp, struct mbuf **mrq));
748 int nfsrv_symlink __P((struct nfsrv_descript *nfsd,
749 struct nfssvc_sock *slp,
750 struct proc *procp, struct mbuf **mrq));
751 int nfsrv_write __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
752 struct proc *procp, struct mbuf **mrq));
753 void nfsrv_rcv __P((struct socket *so, caddr_t arg, int waitflag));
754 void nfsrv_slpderef __P((struct nfssvc_sock *slp));
755
756 /*
757 * NFSTRACE points were changed to FSDBG (KERNEL_DEBUG)
758 * But some of this code may prove useful someday...
759 */
760 #undef NFSDIAG
761 #if NFSDIAG
762
763 extern int nfstraceindx;
764 #define NFSTBUFSIZ 8912
765 struct nfstracerec { uint i1, i2, i3, i4; };
766 extern struct nfstracerec nfstracebuf[NFSTBUFSIZ];
767 extern uint nfstracemask; /* 32 bits - trace points over 31 are unconditional */
768
769 /* 0x0000000f nfs_getattrcache trace points */
770 #define NFSTRC_GAC_MISS 0x00 /* 0x00000001 cache miss */
771 #define NFSTRC_GAC_HIT 0x01 /* 0x00000002 cache hit */
772 #define NFSTRC_GAC_NP 0x02 /* 0x00000004 np size mismatch - vp... */
773 /* 0x00000038 nfs_loadattrcache trace points */
774 #define NFSTRC_LAC 0x03 /* 0x00000008 function entry point - vp */
775 #define NFSTRC_LAC_INIT 0x04 /* 0x00000010 new vp & init n_mtime - vp */
776 #define NFSTRC_LAC_NP 0x05 /* 0x00000020 np size mismatch - vp... */
777 /* 0x000000c0 nfs_getattr trace points */
778 #define NFSTRC_GA_INV 0x06 /* 0x00000040 times mismatch - vp */
779 #define NFSTRC_GA_INV1 0x07 /* 0x00000080 invalidate ok - vp */
780 /* 0x00000100 vmp_invalidate trace points */
781 #define NFSTRC_VMP_INV 0x08 /* 0x00000100 function entry point - vmp */
782 /* 0x00000200 nfs_request trace points */
783 #define NFSTRC_REQ 0x09 /* 0x00000200 - alternates vp and procnum */
784 /* 0x00000c00 vmp_push_range trace points */
785 #define NFSTRC_VPR 0xa /* 0x00000400 entry point - vp... */
786 #define NFSTRC_VPR_DONE 0xb /* 0x00000800 tail exit - error # */
787 /* 0x00003000 nfs_doio trace points */
788 #define NFSTRC_DIO 0xc /* 0x00001000 entry point - vp */
789 #define NFSTRC_DIO_DONE 0xd /* 0x00002000 exit points - vp */
790 /* 0x000fc000 congestion window trace points */
791 #define NFSTRC_CWND_INIT 0xe
792 #define NFSTRC_CWND_REPLY 0xf
793 #define NFSTRC_CWND_TIMER 0x10
794 #define NFSTRC_CWND_REQ1 0x11
795 #define NFSTRC_CWND_REQ2 0x12
796 #define NFSTRC_CWND_SOFT 0x13
797 /* 0xfff00000 nfs_rcvlock & nfs_rcvunlock trace points */
798 #define NFSTRC_ECONN 0x14
799 #define NFSTRC_RCVERR 0x15
800 #define NFSTRC_REQFREE 0x16
801 #define NFSTRC_NOTMINE 0x17
802 #define NFSTRC_6 0x18
803 #define NFSTRC_7 0x19
804 #define NFSTRC_RCVLCKINTR 0x1a
805 #define NFSTRC_RCVALREADY 0x1b
806 #define NFSTRC_RCVLCKW 0x1c /* 0x10000000 seeking recieve lock (waiting) */
807 #define NFSTRC_RCVLCK 0x1d /* 0x20000000 getting recieve lock */
808 #define NFSTRC_RCVUNLW 0x1e /* 0x40000000 releasing rcv lock w/ wakeup */
809 #define NFSTRC_RCVUNL 0x1f /* 0x80000000 releasing rcv lock w/o wakeup */
810 /* trace points beyond 31 are on if any of above points are on */
811 #define NFSTRC_GA_INV2 0x20 /* nfs_getattr invalidate - error# */
812 #define NFSTRC_VBAD 0x21
813 #define NFSTRC_REQERR 0x22
814 #define NFSTRC_RPCERR 0x23
815 #define NFSTRC_DISSECTERR 0x24
816 #define NFSTRC_CONTINUE 0xff /* continuation record for previous entry */
817
818 #define NFSTRACEX(a1, a2, a3, a4) \
819 ( \
820 nfstracebuf[nfstraceindx].i1 = (uint)(a1), \
821 nfstracebuf[nfstraceindx].i2 = (uint)(a2), \
822 nfstracebuf[nfstraceindx].i3 = (uint)(a3), \
823 nfstracebuf[nfstraceindx].i4 = (uint)(a4), \
824 nfstraceindx = (nfstraceindx + 1) % NFSTBUFSIZ, \
825 1 \
826 )
827
828 #define NFSTRACE(cnst, fptr) \
829 ( \
830 (nfstracemask && ((cnst) > 31 || nfstracemask & 1<<(cnst))) ? \
831 NFSTRACEX((cnst), (fptr), current_thread(), \
832 clock_get_system_value().tv_nsec) : \
833 0 \
834 )
835
836 #define NFSTRACE4(cnst, fptr, a2, a3, a4) \
837 ( \
838 NFSTRACE(cnst,fptr) ? \
839 NFSTRACEX(NFSTRC_CONTINUE, a2, a3, a4) : \
840 0 \
841 )
842
843 #else /* NFSDIAG */
844
845 #define NFSTRACE(cnst, fptr)
846 #define NFSTRACE4(cnst, fptr, a2, a3, a4)
847
848 #endif /* NFSDIAG */
849
850 #endif /* KERNEL */
851 #endif /* __APPLE_API_PRIVATE */
852
853 #endif
mirror of XNU