40a1d4893e84ee242b45e07688052aa298509c21
[dragonfly.git] / sys / vfs / nfs / nfs.h
1 /*
2  * Copyright (c) 1989, 1993, 1995
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Rick Macklem at The University of Guelph.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      @(#)nfs.h       8.4 (Berkeley) 5/1/95
37  * $FreeBSD: src/sys/nfs/nfs.h,v 1.53.2.5 2002/02/20 01:35:34 iedowse Exp $
38  * $DragonFly: src/sys/vfs/nfs/nfs.h,v 1.21 2008/09/17 21:44:24 dillon Exp $
39  */
40
41 #ifndef _NFS_NFS_H_
42 #define _NFS_NFS_H_
43
44 #ifdef _KERNEL
45 #include "opt_nfs.h"
46 #endif
47
48 #include <sys/vnode.h>
49 #include <sys/mutex.h>
50
51 /*
52  * Tunable constants for nfs
53  */
54
55 #define NFS_MAXIOVEC    34
56 #define NFS_TICKINTVL   5               /* Desired time for a tick (msec) */
57 #define NFS_HZ          (hz / nfs_ticks) /* Ticks/sec */
58 #define NFS_TIMEO       (1 * NFS_HZ)    /* Default timeout = 1 second */
59 #define NFS_MINTIMEO    (1 * NFS_HZ)    /* Min timeout to use */
60 #define NFS_MAXTIMEO    (60 * NFS_HZ)   /* Max timeout to backoff to */
61 #define NFS_MINIDEMTIMEO (5 * NFS_HZ)   /* Min timeout for non-idempotent ops*/
62 #define NFS_MAXREXMIT   100             /* Stop counting after this many */
63 #define NFS_MAXWINDOW   1024            /* Max number of outstanding requests */
64 #define NFS_RETRANS     10              /* Num of retrans for soft mounts */
65 #define NFS_MAXGRPS     16              /* Max. size of groups list */
66 #ifndef NFS_MINATTRTIMO
67 #define NFS_MINATTRTIMO 3               /* VREG attrib cache timeout in sec */
68 #endif
69 #ifndef NFS_DEFATTRTIMO
70 #define NFS_DEFATTRTIMO 10              /* VREG attrib cache timeout in sec */
71 #endif
72 #ifndef NFS_MAXATTRTIMO
73 #define NFS_MAXATTRTIMO 60
74 #endif
75 #ifndef NFS_MINDIRATTRTIMO
76 #define NFS_MINDIRATTRTIMO 30           /* VDIR attrib cache timeout in sec */
77 #endif
78 #ifndef NFS_MAXDIRATTRTIMO
79 #define NFS_MAXDIRATTRTIMO 60
80 #endif
81 #ifndef NFS_DEADTHRESH
82 #define NFS_DEADTHRESH  NFS_NEVERDEAD
83 #endif
84 #define NFS_NEVERDEAD   9
85 #define NFS_WSIZE       8192            /* Def. write data size <= 8192 */
86 #define NFS_RSIZE       8192            /* Def. read data size <= 8192 */
87 #define NFS_READDIRSIZE 8192            /* Def. readdir size */
88 #define NFS_DEFRAHEAD   4               /* Def. read ahead # blocks */
89 #define NFS_MAXRAHEAD   32              /* Max. read ahead # blocks */
90 #define NFS_MAXUIDHASH  64              /* Max. # of hashed uid entries/mp */
91 #define NFS_MAXGATHERDELAY      100     /* Max. write gather delay (msec) */
92 #ifndef NFS_GATHERDELAY
93 #define NFS_GATHERDELAY         20      /* Default write gather delay (msec) */
94 #endif
95 #define NFS_DIRBLKSIZ   4096            /* Must be a multiple of DIRBLKSIZ */
96 #ifdef _KERNEL
97 #define DIRBLKSIZ       512             /* XXX we used to use ufs's DIRBLKSIZ */
98 #endif
99
100 /*
101  * Oddballs
102  */
103 #define NMOD(a)         ((a) % nfs_asyncdaemons)
104 #define NFS_CMPFH(n, f, s) \
105         ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
106 #define NFS_ISV3(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
107 #define NFS_SRVMAXDATA(n) \
108                 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
109                  NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
110
111 /*
112  * The IO_METASYNC flag should be implemented for local file systems.
113  * (Until then, it is nothin at all.)
114  */
115 #ifndef IO_METASYNC
116 #define IO_METASYNC     0
117 #endif
118
119 /*
120  * Arguments to mount NFS
121  */
122 #define NFS_ARGSVERSION 3               /* change when nfs_args changes */
123 struct nfs_args {
124         int             version;        /* args structure version number */
125         struct sockaddr *addr;          /* file server address */
126         int             addrlen;        /* length of address */
127         int             sotype;         /* Socket type */
128         int             proto;          /* and Protocol */
129         u_char          *fh;            /* File handle to be mounted */
130         int             fhsize;         /* Size, in bytes, of fh */
131         int             flags;          /* flags */
132         int             wsize;          /* write size in bytes */
133         int             rsize;          /* read size in bytes */
134         int             readdirsize;    /* readdir size in bytes */
135         int             timeo;          /* initial timeout in .1 secs */
136         int             retrans;        /* times to retry send */
137         int             maxgrouplist;   /* Max. size of group list */
138         int             readahead;      /* # of blocks to readahead */
139         int             unused01;       /* Term (sec) of lease */
140         int             deadthresh;     /* Retrans threshold */
141         char            *hostname;      /* server's name */
142         int             acregmin;       /* cache attrs for reg files min time */
143         int             acregmax;       /* cache attrs for reg files max time */
144         int             acdirmin;       /* cache attrs for dirs min time */
145         int             acdirmax;       /* cache attrs for dirs max time */
146 };
147
148 /*
149  * NFS mount option flags
150  */
151 #define NFSMNT_SOFT             0x00000001  /* soft mount (hard is default) */
152 #define NFSMNT_WSIZE            0x00000002  /* set write size */
153 #define NFSMNT_RSIZE            0x00000004  /* set read size */
154 #define NFSMNT_TIMEO            0x00000008  /* set initial timeout */
155 #define NFSMNT_RETRANS          0x00000010  /* set number of request retries */
156 #define NFSMNT_MAXGRPS          0x00000020  /* set maximum grouplist size */
157 #define NFSMNT_INT              0x00000040  /* allow interrupts on hard mount */
158 #define NFSMNT_NOCONN           0x00000080  /* Don't Connect the socket */
159 #define NFSMNT_UNUSED0100       0x00000100
160 #define NFSMNT_NFSV3            0x00000200  /* Use NFS Version 3 protocol */
161 #define NFSMNT_KERB             0x00000400  /* Use Kerberos authentication */
162 #define NFSMNT_DUMBTIMR         0x00000800  /* Don't estimate rtt dynamically */
163 #define NFSMNT_UNUSED1000       0x00001000  /* set lease term (nqnfs) */
164 #define NFSMNT_READAHEAD        0x00002000  /* set read ahead */
165 #define NFSMNT_DEADTHRESH       0x00004000  /* set dead server retry thresh */
166 #define NFSMNT_RESVPORT         0x00008000  /* Allocate a reserved port */
167 #define NFSMNT_RDIRPLUS         0x00010000  /* Use Readdirplus for V3 */
168 #define NFSMNT_READDIRSIZE      0x00020000  /* Set readdir size */
169 #define NFSMNT_ACREGMIN         0x00040000
170 #define NFSMNT_ACREGMAX         0x00080000
171 #define NFSMNT_ACDIRMIN         0x00100000
172 #define NFSMNT_ACDIRMAX         0x00200000
173
174 #define NFSSTA_HASWRITEVERF     0x00040000  /* Has write verifier for V3 */
175 #define NFSSTA_GOTPATHCONF      0x00080000  /* Got the V3 pathconf info */
176 #define NFSSTA_GOTFSINFO        0x00100000  /* Got the V3 fsinfo */
177 #define NFSSTA_MNTD             0x00200000  /* Mnt server for mnt point */
178 #define NFSSTA_DISMINPROG       0x00400000  /* Dismount in progress */
179 #define NFSSTA_DISMNT           0x00800000  /* Dismounted */
180 #define NFSSTA_UNUSED24         0x01000000
181 #define NFSSTA_UNUSED25         0x02000000
182 #define NFSSTA_UNUSED26         0x04000000
183 #define NFSSTA_UNUSED27         0x08000000
184 #define NFSSTA_WAITAUTH         0x10000000  /* Wait for authentication */
185 #define NFSSTA_HASAUTH          0x20000000  /* Has authenticator */
186 #define NFSSTA_WANTAUTH         0x40000000  /* Wants an authenticator */
187 #define NFSSTA_AUTHERR          0x80000000  /* Authentication error */
188
189 /*
190  * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
191  * should ever try and use it.
192  */
193 struct nfsd_args {
194         int     sock;           /* Socket to serve */
195         caddr_t name;           /* Client addr for connection based sockets */
196         int     namelen;        /* Length of name */
197 };
198
199 struct nfsd_srvargs {
200         struct nfsd     *nsd_nfsd;      /* Pointer to in kernel nfsd struct */
201         uid_t           nsd_uid;        /* Effective uid mapped to cred */
202         u_int32_t       nsd_haddr;      /* Ip address of client */
203         struct ucred    nsd_cr;         /* Cred. uid maps to */
204         u_int           nsd_authlen;    /* Length of auth string (ret) */
205         u_char          *nsd_authstr;   /* Auth string (ret) */
206         u_int           nsd_verflen;    /* and the verfier */
207         u_char          *nsd_verfstr;
208         struct timeval  nsd_timestamp;  /* timestamp from verifier */
209         u_int32_t       nsd_ttl;        /* credential ttl (sec) */
210         NFSKERBKEY_T    nsd_key;        /* Session key */
211 };
212
213 struct nfsd_cargs {
214         char            *ncd_dirp;      /* Mount dir path */
215         uid_t           ncd_authuid;    /* Effective uid */
216         int             ncd_authtype;   /* Type of authenticator */
217         u_int           ncd_authlen;    /* Length of authenticator string */
218         u_char          *ncd_authstr;   /* Authenticator string */
219         u_int           ncd_verflen;    /* and the verifier */
220         u_char          *ncd_verfstr;
221         NFSKERBKEY_T    ncd_key;        /* Session key */
222 };
223
224 /*
225  * XXX to allow amd to include nfs.h without nfsproto.h
226  */
227 #ifdef NFS_NPROCS
228 /*
229  * Stats structure
230  */
231 struct nfsstats {
232         int     attrcache_hits;
233         int     attrcache_misses;
234         int     lookupcache_hits;
235         int     lookupcache_misses;
236         int     direofcache_hits;
237         int     direofcache_misses;
238         int     biocache_reads;
239         int     read_bios;
240         int     read_physios;
241         int     biocache_writes;
242         int     write_bios;
243         int     write_physios;
244         int     biocache_readlinks;
245         int     readlink_bios;
246         int     biocache_readdirs;
247         int     readdir_bios;
248         int     rpccnt[NFS_NPROCS];
249         int     rpcretries;
250         int     srvrpccnt[NFS_NPROCS];
251         int     srvrpc_errs;
252         int     srv_errs;
253         int     rpcrequests;
254         int     rpctimeouts;
255         int     rpcunexpected;
256         int     rpcinvalid;
257         int     srvcache_inproghits;
258         int     srvcache_idemdonehits;
259         int     srvcache_nonidemdonehits;
260         int     srvcache_misses;
261         int     srvnqnfs_leases;
262         int     srvnqnfs_maxleases;
263         int     srvnqnfs_getleases;
264         int     srvvop_writes;
265         int     accesscache_hits;
266         int     accesscache_misses;
267 };
268 #endif
269
270 /*
271  * Flags for nfssvc() system call.
272  */
273 #define NFSSVC_BIOD     0x002
274 #define NFSSVC_NFSD     0x004
275 #define NFSSVC_ADDSOCK  0x008
276 #define NFSSVC_AUTHIN   0x010
277 #define NFSSVC_GOTAUTH  0x040
278 #define NFSSVC_AUTHINFAIL 0x080
279 #define NFSSVC_MNTD     0x100
280
281 /*
282  * fs.nfs sysctl(3) identifiers
283  */
284 #define NFS_NFSSTATS    1               /* struct: struct nfsstats */
285 #define NFS_NFSPRIVPORT 2               /* int: prohibit nfs to resvports */
286
287 #define FS_NFS_NAMES { \
288                        { 0, 0 }, \
289                        { "nfsstats", CTLTYPE_STRUCT }, \
290                        { "nfsprivport", CTLTYPE_INT }, \
291 }
292
293 #ifdef _KERNEL
294
295 #ifdef MALLOC_DECLARE
296 MALLOC_DECLARE(M_NFSREQ);
297 MALLOC_DECLARE(M_NFSDIROFF);
298 MALLOC_DECLARE(M_NFSRVDESC);
299 MALLOC_DECLARE(M_NFSUID);
300 MALLOC_DECLARE(M_NFSD);
301 MALLOC_DECLARE(M_NFSBIGFH);
302 MALLOC_DECLARE(M_NFSHASH);
303 #endif
304
305 #ifdef ZONE_INTERRUPT
306 extern vm_zone_t nfsmount_zone;
307 #endif
308
309 extern struct callout nfs_timer_handle;
310 extern int nfs_async;
311
312 struct uio;
313 struct buf;
314 struct bio;
315 struct vattr;
316 struct nlookupdata;
317
318 /*
319  * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
320  * What should be in this set is open to debate, but I believe that since
321  * I/O system calls on ufs are never interrupted by signals the set should
322  * be minimal. My reasoning is that many current programs that use signals
323  * such as SIGALRM will not expect file I/O system calls to be interrupted
324  * by them and break.
325  */
326 #define NFSINT_SIGMASK(set)                                             \
327         (SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||       \
328          SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||       \
329          SIGISMEMBER(set, SIGQUIT))
330
331 /*
332  * Socket errors ignored for connectionless sockets??
333  * For now, ignore them all
334  */
335 #define NFSIGNORE_SOERROR(s, e) \
336                 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
337                 ((s) & PR_CONNREQUIRED) == 0)
338
339 /*
340  * Nfs outstanding request list element
341  */
342 struct nfsreq {
343         TAILQ_ENTRY(nfsreq) r_chain;
344         struct mtx_link r_link;
345         struct mbuf     *r_mreq;
346         struct mbuf     *r_mrep;
347         struct mbuf     *r_md;
348         caddr_t         r_dpos;
349         struct nfsmount *r_nmp;
350         struct vnode    *r_vp;
351         u_int32_t       r_xid;
352         int             r_flags;        /* flags on request, see below */
353         int             r_retry;        /* max retransmission count */
354         int             r_rexmit;       /* current retrans count */
355         int             r_timer;        /* tick counter on reply */
356         u_int32_t       r_procnum;      /* NFS procedure number */
357         int             r_rtt;          /* RTT for rpc */
358         struct thread   *r_td;          /* Thread that did I/O system call */
359         struct mbuf     *r_mrest;
360         struct mbuf     *r_mheadend;
361         struct mbuf     **r_mrp;
362         struct mbuf     **r_mdp;
363         caddr_t         *r_dposp;
364         int             r_mrest_len;
365         int             r_failed_auth;
366         NFSKERBKEY_T    r_key;
367         struct ucred    *r_cred;
368 };
369
370 /*
371  * Flag values for r_flags
372  */
373 #define R_TIMING        0x0001          /* timing request (in mntp) */
374 #define R_SENT          0x0002          /* request has been sent */
375 #define R_SOFTTERM      0x0004          /* soft mnt, too many retries */
376 #define R_INTR          0x0008          /* intr mnt, signal pending */
377 #define R_SOCKERR       0x0010          /* Fatal error on socket */
378 #define R_TPRINTFMSG    0x0020          /* Did a tprintf msg. */
379 #define R_MUSTRESEND    0x0040          /* Must resend request */
380 #define R_GETONEREP     0x0080          /* Probe for one reply only */
381 #define R_MASKTIMER     0x0100          /* Timer should ignore this req */
382 #define R_LOCKED        0x0200          /* Locked by the timer */
383
384 /*
385  * A list of nfssvc_sock structures is maintained with all the sockets
386  * that require service by the nfsd.
387  * The nfsuid structs hang off of the nfssvc_sock structs in both lru
388  * and uid hash lists.
389  */
390 #ifndef NFS_UIDHASHSIZ
391 #define NFS_UIDHASHSIZ  29      /* Tune the size of nfssvc_sock with this */
392 #endif
393 #define NUIDHASH(sock, uid) \
394         (&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
395 #ifndef NFS_WDELAYHASHSIZ
396 #define NFS_WDELAYHASHSIZ 16    /* and with this */
397 #endif
398 #define NWDELAYHASH(sock, f) \
399         (&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
400 #ifndef NFS_MUIDHASHSIZ
401 #define NFS_MUIDHASHSIZ 63      /* Tune the size of nfsmount with this */
402 #endif
403 #define NMUIDHASH(nmp, uid) \
404         (&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
405
406 /*
407  * Network address hash list element
408  */
409 union nethostaddr {
410         u_int32_t had_inetaddr;
411         struct sockaddr *had_nam;
412 };
413
414 struct nfsuid {
415         TAILQ_ENTRY(nfsuid) nu_lru;     /* LRU chain */
416         LIST_ENTRY(nfsuid) nu_hash;     /* Hash list */
417         int             nu_flag;        /* Flags */
418         union nethostaddr nu_haddr;     /* Host addr. for dgram sockets */
419         struct ucred    nu_cr;          /* Cred uid mapped to */
420         int             nu_expire;      /* Expiry time (sec) */
421         struct timeval  nu_timestamp;   /* Kerb. timestamp */
422         u_int32_t       nu_nickname;    /* Nickname on server */
423         NFSKERBKEY_T    nu_key;         /* and session key */
424 };
425
426 #define nu_inetaddr     nu_haddr.had_inetaddr
427 #define nu_nam          nu_haddr.had_nam
428 /* Bits for nu_flag */
429 #define NU_INETADDR     0x1
430 #define NU_NAM          0x2
431 #define NU_NETFAM(u)    (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
432
433 struct nfsrv_rec {
434         STAILQ_ENTRY(nfsrv_rec) nr_link;
435         struct sockaddr *nr_address;
436         struct mbuf     *nr_packet;
437 };
438
439 struct nfssvc_sock {
440         TAILQ_ENTRY(nfssvc_sock) ns_chain;      /* List of all nfssvc_sock's */
441         TAILQ_HEAD(, nfsuid) ns_uidlruhead;
442         struct file     *ns_fp;
443         struct socket   *ns_so;
444         struct sockaddr *ns_nam;
445         struct mbuf     *ns_raw;
446         struct mbuf     *ns_rawend;
447         STAILQ_HEAD(, nfsrv_rec) ns_rec;
448         struct mbuf     *ns_frag;
449         int             ns_numrec;
450         int             ns_flag;
451         struct mtx      ns_solock;
452         int             ns_cc;
453         int             ns_reclen;
454         int             ns_numuids;
455         u_int32_t       ns_sref;
456         LIST_HEAD(, nfsrv_descript) ns_tq;      /* Write gather lists */
457         LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
458         LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
459 };
460
461 /* Bits for "ns_flag" */
462 #define SLP_VALID       0x01
463 #define SLP_DOREC       0x02
464 #define SLP_NEEDQ       0x04
465 #define SLP_DISCONN     0x08
466 #define SLP_GETSTREAM   0x10
467 #define SLP_LASTFRAG    0x20
468 #define SLP_ALLFLAGS    0xff
469
470 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
471 extern int nfssvc_sockhead_flag;
472 extern TAILQ_HEAD(nfsmount_head, nfsmount) nfs_mountq;
473
474 #define SLP_INIT        0x01
475 #define SLP_WANTINIT    0x02
476
477 /*
478  * One of these structures is allocated for each nfsd.
479  */
480 struct nfsd {
481         TAILQ_ENTRY(nfsd) nfsd_chain;   /* List of all nfsd's */
482         int             nfsd_flag;      /* NFSD_ flags */
483         struct nfssvc_sock *nfsd_slp;   /* Current socket */
484         int             nfsd_authlen;   /* Authenticator len */
485         u_char          nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
486         int             nfsd_verflen;   /* and the Verifier */
487         u_char          nfsd_verfstr[RPCVERF_MAXSIZ];
488         struct thread   *nfsd_td;       /* thread ptr */
489         struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
490 };
491
492 /* Bits for "nfsd_flag" */
493 #define NFSD_WAITING    0x01
494 #define NFSD_REQINPROG  0x02
495 #define NFSD_NEEDAUTH   0x04
496 #define NFSD_AUTHFAIL   0x08
497
498 /* Bits for loadattrcache */
499 #define NFS_LATTR_NOSHRINK      0x01
500 #define NFS_LATTR_NOMTIMECHECK  0x02
501
502 /*
503  * This structure is used by the server for describing each request.
504  * Some fields are used only when write request gathering is performed.
505  */
506 struct nfsrv_descript {
507         u_quad_t                nd_time;        /* Write deadline (usec) */
508         off_t                   nd_off;         /* Start byte offset */
509         off_t                   nd_eoff;        /* and end byte offset */
510         LIST_ENTRY(nfsrv_descript) nd_hash;     /* Hash list */
511         LIST_ENTRY(nfsrv_descript) nd_tq;               /* and timer list */
512         LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */
513         struct mbuf             *nd_mrep;       /* Request mbuf list */
514         struct mbuf             *nd_md;         /* Current dissect mbuf */
515         struct mbuf             *nd_mreq;       /* Reply mbuf list */
516         struct sockaddr         *nd_nam;        /* and socket addr */
517         struct sockaddr         *nd_nam2;       /* return socket addr */
518         caddr_t                 nd_dpos;        /* Current dissect pos */
519         u_int32_t               nd_procnum;     /* RPC # */
520         int                     nd_stable;      /* storage type */
521         int                     nd_flag;        /* nd_flag */
522         int                     nd_len;         /* Length of this write */
523         int                     nd_repstat;     /* Reply status */
524         u_int32_t               nd_retxid;      /* Reply xid */
525         struct timeval          nd_starttime;   /* Time RPC initiated */
526         fhandle_t               nd_fh;          /* File handle */
527         struct ucred            nd_cr;          /* Credentials */
528 };
529
530 /* Bits for "nd_flag" */
531 #define ND_READ         0x01
532 #define ND_WRITE        0x02
533 #define ND_CHECK        0x04
534 #define ND_NFSV3        0x08
535 #define ND_UNUSED010    0x10
536 #define ND_KERBNICK     0x20
537 #define ND_KERBFULL     0x40
538 #define ND_KERBAUTH     (ND_KERBNICK | ND_KERBFULL)
539
540 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
541 extern int nfsd_head_flag;
542 extern int nfsd_waiting;
543 #define NFSD_CHECKSLP   0x01
544
545 /*
546  * These macros compare nfsrv_descript structures.
547  */
548 #define NFSW_CONTIG(o, n) \
549                 ((o)->nd_eoff >= (n)->nd_off && \
550                  !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
551
552 #define NFSW_SAMECRED(o, n) \
553         (((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \
554          !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
555                 sizeof (struct ucred)))
556
557 /*
558  * Defines for WebNFS
559  */
560
561 #define WEBNFS_ESC_CHAR         '%'
562 #define WEBNFS_SPECCHAR_START   0x80
563
564 #define WEBNFS_NATIVE_CHAR      0x80
565 /*
566  * ..
567  * Possibly more here in the future.
568  */
569
570 /*
571  * Macro for converting escape characters in WebNFS pathnames.
572  * Should really be in libkern.
573  */
574
575 #define HEXTOC(c) \
576         ((c) >= 'a' ? ((c) - ('a' - 10)) : \
577             ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
578 #define HEXSTRTOI(p) \
579         ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
580
581 #ifdef NFS_DEBUG
582
583 extern int nfs_debug;
584 #define NFS_DEBUG_ASYNCIO       1 /* asynchronous i/o */
585 #define NFS_DEBUG_WG            2 /* server write gathering */
586 #define NFS_DEBUG_RC            4 /* server request caching */
587
588 #define NFS_DPF(cat, args)                                      \
589         do {                                                    \
590                 if (nfs_debug & NFS_DEBUG_##cat) kprintf args;  \
591         } while (0)
592
593 #else
594
595 #define NFS_DPF(cat, args)
596
597 #endif
598
599 extern u_int32_t nfs_xdrneg1;
600 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers;
601 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr;
602 extern u_int32_t rpc_auth_kerb;
603 extern u_int32_t nfs_prog, nfs_true, nfs_false;
604 extern struct nfsstats nfsstats;
605 extern nfstype nfsv2_type[9];
606 extern nfstype nfsv3_type[9];
607 extern int nfsv2_procid[NFS_NPROCS];
608 extern enum vtype nv3tov_type[8];
609 extern int nfsv3_procid[NFS_NPROCS];
610 extern int nfs_ticks;
611 extern struct nfsrtt nfsrtt;
612 extern int nfsrtton;
613 extern int nfsrvw_procrastinate;
614 extern int nfsrvw_procrastinate_v3;
615 extern int32_t (*nfsrv3_procs[NFS_NPROCS]) (struct nfsrv_descript *nd,
616                                             struct nfssvc_sock *slp,
617                                             struct thread *td,
618                                             struct mbuf **mreqp);
619
620 extern struct nfsv3_diskless nfsv3_diskless;
621
622 u_quad_t nfs_curusec (void);
623 int     nfs_init (struct vfsconf *vfsp);
624 int     nfs_uninit (struct vfsconf *vfsp);
625 int     nfs_reply (struct nfsreq *);
626 int     nfs_getreq (struct nfsrv_descript *,struct nfsd *,int);
627 int     nfs_send (struct socket *, struct sockaddr *, struct mbuf *, 
628                       struct nfsreq *);
629 int     nfs_rephead (int, struct nfsrv_descript *, struct nfssvc_sock *,
630                          int, struct mbuf **, struct mbuf **, caddr_t *);
631 int     nfs_sndlock (struct nfsreq *);
632 void    nfs_sndunlock (struct nfsreq *);
633 int     nfs_slplock (struct nfssvc_sock *, int);
634 void    nfs_slpunlock (struct nfssvc_sock *);
635 int     nfs_disct (struct mbuf **, caddr_t *, int, int, caddr_t *);
636 int     nfs_vinvalbuf (struct vnode *, int, int);
637 int     nfs_readrpc (struct vnode *, struct uio *);
638 int     nfs_writerpc (struct vnode *, struct uio *, int *, int *);
639 int     nfs_commit (struct vnode *vp, u_quad_t offset, int cnt, 
640                         struct thread *td);
641 int     nfs_readdirrpc (struct vnode *, struct uio *);
642 int     nfs_asyncio (struct vnode *vp, struct bio *, struct thread *);
643 int     nfs_doio (struct vnode *vp, struct bio *, struct thread *);
644 int     nfs_readlinkrpc (struct vnode *, struct uio *);
645 int     nfs_sigintr (struct nfsmount *, struct nfsreq *, struct thread *);
646 int     nfs_readdirplusrpc (struct vnode *, struct uio *);
647 int     netaddr_match (int, union nethostaddr *, struct sockaddr *);
648
649 int     nfs_loadattrcache (struct vnode *, struct mbuf **, caddr_t *,
650                         struct vattr *, int);
651 int     nfs_namei (struct nlookupdata *, struct ucred *, int, 
652                     struct vnode **, struct vnode **, fhandle_t *, int,
653                     struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
654                     caddr_t *, struct vnode **, struct thread *, int, int);
655 void    nfsrv_initcache (void);
656 int     nfs_getauth (struct nfsmount *, struct nfsreq *, struct ucred *, 
657                          char **, int *, char *, int *, NFSKERBKEY_T);
658 int     nfs_getnickauth (struct nfsmount *, struct ucred *, char **, 
659                              int *, char *, int);
660 int     nfs_savenickauth (struct nfsmount *, struct ucred *, int, 
661                               NFSKERBKEY_T, struct mbuf **, char **,
662                               struct mbuf *);
663 int     nfs_adv (struct mbuf **, caddr_t *, int, int);
664 void    nfs_nhinit (void);
665 int     nfs_nmcancelreqs (struct nfsmount *);
666 void    nfs_timer (void*);
667 int     nfsrv_dorec (struct nfssvc_sock *, struct nfsd *, 
668                          struct nfsrv_descript **);
669 int     nfsrv_getcache (struct nfsrv_descript *, struct nfssvc_sock *,
670                             struct mbuf **);
671 void    nfsrv_updatecache (struct nfsrv_descript *, int, struct mbuf *);
672 void    nfsrv_cleancache (void);
673 int     nfs_connect (struct nfsmount *, struct nfsreq *);
674 void    nfs_disconnect (struct nfsmount *);
675 void    nfs_safedisconnect (struct nfsmount *);
676 int     nfs_getattrcache (struct vnode *, struct vattr *);
677 int     nfs_bioread (struct vnode *, struct uio *, int);
678 void    nfsrv_init (int);
679 void    nfs_clearcommit (struct mount *);
680 int     nfsrv_errmap (struct nfsrv_descript *, int);
681 void    nfsrvw_sort (gid_t *, int);
682 void    nfsrv_setcred (struct ucred *, struct ucred *);
683 int     nfsrv_object_create (struct vnode *);
684 void    nfsrv_wakenfsd (struct nfssvc_sock *slp, int nparallel);
685 int     nfsrv_writegather (struct nfsrv_descript **, struct nfssvc_sock *,
686                                struct thread *, struct mbuf **);
687 int     nfs_fsinfo (struct nfsmount *, struct vnode *, struct thread *p);
688
689 int     nfsrv3_access (struct nfsrv_descript *nfsd, 
690                            struct nfssvc_sock *slp,
691                            struct thread *td, struct mbuf **mrq);
692 int     nfsrv_commit (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
693                           struct thread *td, struct mbuf **mrq);
694 int     nfsrv_create (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
695                           struct thread *td, struct mbuf **mrq);
696 int     nfsrv_fhtovp (fhandle_t *, int, struct mount **, struct vnode **,
697                           struct ucred *, struct nfssvc_sock *,
698                           struct sockaddr *, int *, int, int);
699 int     nfsrv_setpublicfs (struct mount *, struct netexport *,
700                                struct export_args *);
701 int     nfs_ispublicfh (fhandle_t *);
702 int     nfsrv_fsinfo (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
703                           struct thread *td, struct mbuf **mrq);
704 int     nfsrv_getattr (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
705                            struct thread *td, struct mbuf **mrq);
706 int     nfsrv_link (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
707                         struct thread *td, struct mbuf **mrq);
708 int     nfsrv_lookup (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
709                           struct thread *td, struct mbuf **mrq);
710 int     nfsrv_mkdir (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
711                          struct thread *td, struct mbuf **mrq);
712 int     nfsrv_mknod (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
713                          struct thread *td, struct mbuf **mrq);
714 int     nfsrv_noop (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
715                         struct thread *td, struct mbuf **mrq);
716 int     nfsrv_null (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
717                         struct thread *td, struct mbuf **mrq);
718 int     nfsrv_pathconf (struct nfsrv_descript *nfsd,
719                             struct nfssvc_sock *slp, struct thread *td,
720                             struct mbuf **mrq);
721 int     nfsrv_read (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
722                         struct thread *td, struct mbuf **mrq);
723 int     nfsrv_readdir (struct nfsrv_descript *nfsd, 
724                            struct nfssvc_sock *slp,
725                            struct thread *td, struct mbuf **mrq);
726 int     nfsrv_readdirplus (struct nfsrv_descript *nfsd,
727                                struct nfssvc_sock *slp, struct thread *td,
728                                struct mbuf **mrq);
729 int     nfsrv_readlink (struct nfsrv_descript *nfsd,
730                             struct nfssvc_sock *slp, struct thread *td,
731                             struct mbuf **mrq);
732 int     nfsrv_remove (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
733                           struct thread *td, struct mbuf **mrq);
734 int     nfsrv_rename (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
735                           struct thread *td, struct mbuf **mrq);
736 int     nfsrv_rmdir (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
737                          struct thread *td, struct mbuf **mrq);
738 int     nfsrv_setattr (struct nfsrv_descript *nfsd, 
739                            struct nfssvc_sock *slp,
740                            struct thread *td, struct mbuf **mrq);
741 int     nfsrv_statfs (struct nfsrv_descript *nfsd, 
742                           struct nfssvc_sock *slp,
743                           struct thread *td, struct mbuf **mrq);
744 int     nfsrv_symlink (struct nfsrv_descript *nfsd, 
745                            struct nfssvc_sock *slp,
746                            struct thread *td, struct mbuf **mrq);
747 int     nfsrv_write (struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
748                          struct thread *td, struct mbuf **mrq);
749 void    nfsrv_rcv (struct socket *so, void *arg, int waitflag);
750 void    nfsrv_slpderef (struct nfssvc_sock *slp);
751 int     nfs_meta_setsize (struct vnode *vp, struct thread *td, u_quad_t nsize);
752 int     nfs_clientd(struct nfsmount *nmp, struct ucred *cred,
753                         struct nfsd_cargs *ncd, int flag, caddr_t argp,
754                         struct thread *td);
755 void    nfssvc_iod_reader(void *arg);
756 void    nfssvc_iod_writer(void *arg);
757 void    nfssvc_iod_stop(struct nfsmount *nmp);
758 void    nfssvc_iod_writer_wakeup(struct nfsmount *nmp);
759
760 #endif  /* _KERNEL */
761
762 #endif