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