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.4 2003/06/26 05:55:18 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_MAXATTRTIMO
  67 #define NFS_MAXATTRTIMO 60
  68 #endif
  69 #ifndef NFS_MINDIRATTRTIMO
  70 #define NFS_MINDIRATTRTIMO 30           /* VDIR attrib cache timeout in sec */
  71 #endif
  72 #ifndef NFS_MAXDIRATTRTIMO
  73 #define NFS_MAXDIRATTRTIMO 60
  74 #endif
  75 #define NFS_WSIZE       8192            /* Def. write data size <= 8192 */
  76 #define NFS_RSIZE       8192            /* Def. read data size <= 8192 */
  77 #define NFS_READDIRSIZE 8192            /* Def. readdir size */
  78 #define NFS_DEFRAHEAD   1               /* Def. read ahead # blocks */
  79 #define NFS_MAXRAHEAD   4               /* Max. read ahead # blocks */
  80 #define NFS_MAXUIDHASH  64              /* Max. # of hashed uid entries/mp */
  81 #define NFS_MAXASYNCDAEMON      20      /* Max. number async_daemons runnable */
  82 #define NFS_MAXGATHERDELAY      100     /* Max. write gather delay (msec) */
  83 #ifndef NFS_GATHERDELAY
  84 #define NFS_GATHERDELAY         10      /* Default write gather delay (msec) */
  85 #endif
  86 #define NFS_DIRBLKSIZ   4096            /* Must be a multiple of DIRBLKSIZ */
  87 #ifdef _KERNEL
  88 #define DIRBLKSIZ       512             /* XXX we used to use ufs's DIRBLKSIZ */
  89 #endif
  90
  91 /*
  92  * Oddballs
  93  */
  94 #define NMOD(a)         ((a) % nfs_asyncdaemons)
  95 #define NFS_CMPFH(n, f, s) \
  96         ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
  97 #define NFS_ISV3(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
  98 #define NFS_SRVMAXDATA(n) \
  99                 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
 100                  NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
 101
 102 /*
 103  * XXX
 104  * The B_INVAFTERWRITE flag should be set to whatever is required by the
 105  * buffer cache code to say "Invalidate the block after it is written back".
 106  */
 107 #define B_INVAFTERWRITE B_NOCACHE
 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             leaseterm;      /* 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_NQNFS            0x00000100  /* Use Nqnfs protocol */
 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_LEASETERM        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_NQLEASE);
 299 MALLOC_DECLARE(M_NFSD);
 300 MALLOC_DECLARE(M_NFSBIGFH);
 301 MALLOC_DECLARE(M_NFSHASH);
 302 #endif
 303
 304 #ifdef ZONE_INTERRUPT
 305 extern vm_zone_t nfsmount_zone;
 306 #endif
 307
 308 extern struct callout_handle nfs_timer_handle;
 309
 310 struct uio; struct buf; struct vattr; struct nameidata; /* XXX */
 311
 312 /*
 313  * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
 314  * What should be in this set is open to debate, but I believe that since
 315  * I/O system calls on ufs are never interrupted by signals the set should
 316  * be minimal. My reasoning is that many current programs that use signals
 317  * such as SIGALRM will not expect file I/O system calls to be interrupted
 318  * by them and break.
 319  */
 320 #define NFSINT_SIGMASK(set)                                             \
 321         (SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||       \
 322          SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||       \
 323          SIGISMEMBER(set, SIGQUIT))
 324
 325 /*
 326  * Socket errors ignored for connectionless sockets??
 327  * For now, ignore them all
 328  */
 329 #define NFSIGNORE_SOERROR(s, e) \
 330                 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
 331                 ((s) & PR_CONNREQUIRED) == 0)
 332
 333 /*
 334  * Nfs outstanding request list element
 335  */
 336 struct nfsreq {
 337         TAILQ_ENTRY(nfsreq) r_chain;
 338         struct mbuf     *r_mreq;
 339         struct mbuf     *r_mrep;
 340         struct mbuf     *r_md;
 341         caddr_t         r_dpos;
 342         struct nfsmount *r_nmp;
 343         struct vnode    *r_vp;
 344         u_int32_t       r_xid;
 345         int             r_flags;        /* flags on request, see below */
 346         int             r_retry;        /* max retransmission count */
 347         int             r_rexmit;       /* current retrans count */
 348         int             r_timer;        /* tick counter on reply */
 349         u_int32_t       r_procnum;      /* NFS procedure number */
 350         int             r_rtt;          /* RTT for rpc */
 351         struct thread   *r_td;          /* Thread that did I/O system call */
 352 };
 353
 354 /*
 355  * Queue head for nfsreq's
 356  */
 357 extern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq;
 358
 359 /* Flag values for r_flags */
 360 #define R_TIMING        0x01            /* timing request (in mntp) */
 361 #define R_SENT          0x02            /* request has been sent */
 362 #define R_SOFTTERM      0x04            /* soft mnt, too many retries */
 363 #define R_INTR          0x08            /* intr mnt, signal pending */
 364 #define R_SOCKERR       0x10            /* Fatal error on socket */
 365 #define R_TPRINTFMSG    0x20            /* Did a tprintf msg. */
 366 #define R_MUSTRESEND    0x40            /* Must resend request */
 367 #define R_GETONEREP     0x80            /* Probe for one reply only */
 368
 369 /*
 370  * A list of nfssvc_sock structures is maintained with all the sockets
 371  * that require service by the nfsd.
 372  * The nfsuid structs hang off of the nfssvc_sock structs in both lru
 373  * and uid hash lists.
 374  */
 375 #ifndef NFS_UIDHASHSIZ
 376 #define NFS_UIDHASHSIZ  29      /* Tune the size of nfssvc_sock with this */
 377 #endif
 378 #define NUIDHASH(sock, uid) \
 379         (&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
 380 #ifndef NFS_WDELAYHASHSIZ
 381 #define NFS_WDELAYHASHSIZ 16    /* and with this */
 382 #endif
 383 #define NWDELAYHASH(sock, f) \
 384         (&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
 385 #ifndef NFS_MUIDHASHSIZ
 386 #define NFS_MUIDHASHSIZ 63      /* Tune the size of nfsmount with this */
 387 #endif
 388 #define NMUIDHASH(nmp, uid) \
 389         (&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
 390 #define NFSNOHASH(fhsum) \
 391         (&nfsnodehashtbl[(fhsum) & nfsnodehash])
 392
 393 /*
 394  * Network address hash list element
 395  */
 396 union nethostaddr {
 397         u_int32_t had_inetaddr;
 398         struct sockaddr *had_nam;
 399 };
 400
 401 struct nfsuid {
 402         TAILQ_ENTRY(nfsuid) nu_lru;     /* LRU chain */
 403         LIST_ENTRY(nfsuid) nu_hash;     /* Hash list */
 404         int             nu_flag;        /* Flags */
 405         union nethostaddr nu_haddr;     /* Host addr. for dgram sockets */
 406         struct ucred    nu_cr;          /* Cred uid mapped to */
 407         int             nu_expire;      /* Expiry time (sec) */
 408         struct timeval  nu_timestamp;   /* Kerb. timestamp */
 409         u_int32_t       nu_nickname;    /* Nickname on server */
 410         NFSKERBKEY_T    nu_key;         /* and session key */
 411 };
 412
 413 #define nu_inetaddr     nu_haddr.had_inetaddr
 414 #define nu_nam          nu_haddr.had_nam
 415 /* Bits for nu_flag */
 416 #define NU_INETADDR     0x1
 417 #define NU_NAM          0x2
 418 #define NU_NETFAM(u)    (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
 419
 420 struct nfsrv_rec {
 421         STAILQ_ENTRY(nfsrv_rec) nr_link;
 422         struct sockaddr *nr_address;
 423         struct mbuf     *nr_packet;
 424 };
 425
 426 struct nfssvc_sock {
 427         TAILQ_ENTRY(nfssvc_sock) ns_chain;      /* List of all nfssvc_sock's */
 428         TAILQ_HEAD(, nfsuid) ns_uidlruhead;
 429         struct file     *ns_fp;
 430         struct socket   *ns_so;
 431         struct sockaddr *ns_nam;
 432         struct mbuf     *ns_raw;
 433         struct mbuf     *ns_rawend;
 434         STAILQ_HEAD(, nfsrv_rec) ns_rec;
 435         struct mbuf     *ns_frag;
 436         int             ns_flag;
 437         int             ns_solock;
 438         int             ns_cc;
 439         int             ns_reclen;
 440         int             ns_numuids;
 441         u_int32_t       ns_sref;
 442         LIST_HEAD(, nfsrv_descript) ns_tq;      /* Write gather lists */
 443         LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
 444         LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
 445 };
 446
 447 /* Bits for "ns_flag" */
 448 #define SLP_VALID       0x01
 449 #define SLP_DOREC       0x02
 450 #define SLP_NEEDQ       0x04
 451 #define SLP_DISCONN     0x08
 452 #define SLP_GETSTREAM   0x10
 453 #define SLP_LASTFRAG    0x20
 454 #define SLP_ALLFLAGS    0xff
 455
 456 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
 457 extern int nfssvc_sockhead_flag;
 458 #define SLP_INIT        0x01
 459 #define SLP_WANTINIT    0x02
 460
 461 /*
 462  * One of these structures is allocated for each nfsd.
 463  */
 464 struct nfsd {
 465         TAILQ_ENTRY(nfsd) nfsd_chain;   /* List of all nfsd's */
 466         int             nfsd_flag;      /* NFSD_ flags */
 467         struct nfssvc_sock *nfsd_slp;   /* Current socket */
 468         int             nfsd_authlen;   /* Authenticator len */
 469         u_char          nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
 470         int             nfsd_verflen;   /* and the Verifier */
 471         u_char          nfsd_verfstr[RPCVERF_MAXSIZ];
 472         struct thread   *nfsd_td;       /* thread ptr */
 473         struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
 474 };
 475
 476 /* Bits for "nfsd_flag" */
 477 #define NFSD_WAITING    0x01
 478 #define NFSD_REQINPROG  0x02
 479 #define NFSD_NEEDAUTH   0x04
 480 #define NFSD_AUTHFAIL   0x08
 481
 482 /*
 483  * This structure is used by the server for describing each request.
 484  * Some fields are used only when write request gathering is performed.
 485  */
 486 struct nfsrv_descript {
 487         u_quad_t                nd_time;        /* Write deadline (usec) */
 488         off_t                   nd_off;         /* Start byte offset */
 489         off_t                   nd_eoff;        /* and end byte offset */
 490         LIST_ENTRY(nfsrv_descript) nd_hash;     /* Hash list */
 491         LIST_ENTRY(nfsrv_descript) nd_tq;               /* and timer list */
 492         LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */
 493         struct mbuf             *nd_mrep;       /* Request mbuf list */
 494         struct mbuf             *nd_md;         /* Current dissect mbuf */
 495         struct mbuf             *nd_mreq;       /* Reply mbuf list */
 496         struct sockaddr         *nd_nam;        /* and socket addr */
 497         struct sockaddr         *nd_nam2;       /* return socket addr */
 498         caddr_t                 nd_dpos;        /* Current dissect pos */
 499         u_int32_t               nd_procnum;     /* RPC # */
 500         int                     nd_stable;      /* storage type */
 501         int                     nd_flag;        /* nd_flag */
 502         int                     nd_len;         /* Length of this write */
 503         int                     nd_repstat;     /* Reply status */
 504         u_int32_t               nd_retxid;      /* Reply xid */
 505         u_int32_t               nd_duration;    /* Lease duration */
 506         struct timeval          nd_starttime;   /* Time RPC initiated */
 507         fhandle_t               nd_fh;          /* File handle */
 508         struct ucred            nd_cr;          /* Credentials */
 509 };
 510
 511 /* Bits for "nd_flag" */
 512 #define ND_READ         LEASE_READ
 513 #define ND_WRITE        LEASE_WRITE
 514 #define ND_CHECK        0x04
 515 #define ND_LEASE        (ND_READ | ND_WRITE | ND_CHECK)
 516 #define ND_NFSV3        0x08
 517 #define ND_NQNFS        0x10
 518 #define ND_KERBNICK     0x20
 519 #define ND_KERBFULL     0x40
 520 #define ND_KERBAUTH     (ND_KERBNICK | ND_KERBFULL)
 521
 522 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
 523 extern int nfsd_head_flag;
 524 #define NFSD_CHECKSLP   0x01
 525
 526 /*
 527  * These macros compare nfsrv_descript structures.
 528  */
 529 #define NFSW_CONTIG(o, n) \
 530                 ((o)->nd_eoff >= (n)->nd_off && \
 531                  !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
 532
 533 #define NFSW_SAMECRED(o, n) \
 534         (((o)->nd_flag & ND_KERBAUTH) == ((n)->nd_flag & ND_KERBAUTH) && \
 535          !bcmp((caddr_t)&(o)->nd_cr, (caddr_t)&(n)->nd_cr, \
 536                 sizeof (struct ucred)))
 537
 538 /*
 539  * Defines for WebNFS
 540  */
 541
 542 #define WEBNFS_ESC_CHAR         '%'
 543 #define WEBNFS_SPECCHAR_START   0x80
 544
 545 #define WEBNFS_NATIVE_CHAR      0x80
 546 /*
 547  * ..
 548  * Possibly more here in the future.
 549  */
 550
 551 /*
 552  * Macro for converting escape characters in WebNFS pathnames.
 553  * Should really be in libkern.
 554  */
 555
 556 #define HEXTOC(c) \
 557         ((c) >= 'a' ? ((c) - ('a' - 10)) : \
 558             ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
 559 #define HEXSTRTOI(p) \
 560         ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
 561
 562 #ifdef NFS_DEBUG
 563
 564 extern int nfs_debug;
 565 #define NFS_DEBUG_ASYNCIO       1 /* asynchronous i/o */
 566 #define NFS_DEBUG_WG            2 /* server write gathering */
 567 #define NFS_DEBUG_RC            4 /* server request caching */
 568
 569 #define NFS_DPF(cat, args)                                      \
 570         do {                                                    \
 571                 if (nfs_debug & NFS_DEBUG_##cat) printf args;   \
 572         } while (0)
 573
 574 #else
 575
 576 #define NFS_DPF(cat, args)
 577
 578 #endif
 579
 580 u_quad_t nfs_curusec __P((void));
 581 int     nfs_init __P((struct vfsconf *vfsp));
 582 int     nfs_uninit __P((struct vfsconf *vfsp));
 583 int     nfs_reply __P((struct nfsreq *));
 584 int     nfs_getreq __P((struct nfsrv_descript *,struct nfsd *,int));
 585 int     nfs_send __P((struct socket *, struct sockaddr *, struct mbuf *,
 586                       struct nfsreq *));
 587 int     nfs_rephead __P((int, struct nfsrv_descript *, struct nfssvc_sock *,
 588                          int, int, u_quad_t *, struct mbuf **, struct mbuf **,
 589                          caddr_t *));
 590 int     nfs_sndlock __P((struct nfsreq *));
 591 void    nfs_sndunlock __P((struct nfsreq *));
 592 int     nfs_slplock __P((struct nfssvc_sock *, int));
 593 void    nfs_slpunlock __P((struct nfssvc_sock *));
 594 int     nfs_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
 595 int     nfs_vinvalbuf __P((struct vnode *, int, struct thread *, int));
 596 int     nfs_readrpc __P((struct vnode *, struct uio *));
 597 int     nfs_writerpc __P((struct vnode *, struct uio *, int *, int *));
 598 int     nfs_commit __P((struct vnode *vp, u_quad_t offset, int cnt,
 599                         struct thread *td));
 600 int     nfs_readdirrpc __P((struct vnode *, struct uio *));
 601 int     nfs_asyncio __P((struct buf *, struct thread *));
 602 int     nfs_doio __P((struct buf *, struct thread *));
 603 int     nfs_readlinkrpc __P((struct vnode *, struct uio *));
 604 int     nfs_sigintr __P((struct nfsmount *, struct nfsreq *, struct thread *));
 605 int     nfs_readdirplusrpc __P((struct vnode *, struct uio *));
 606 int     nfsm_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
 607 void    nfsm_srvfattr __P((struct nfsrv_descript *, struct vattr *,
 608                            struct nfs_fattr *));
 609 void    nfsm_srvwcc __P((struct nfsrv_descript *, int, struct vattr *, int,
 610                          struct vattr *, struct mbuf **, char **));
 611 void    nfsm_srvpostopattr __P((struct nfsrv_descript *, int, struct vattr *,
 612                                 struct mbuf **, char **));
 613 int     netaddr_match __P((int, union nethostaddr *, struct sockaddr *));
 614 int     nfs_request __P((struct vnode *, struct mbuf *, int, struct thread *,
 615                          struct ucred *, struct mbuf **, struct mbuf **,
 616                          caddr_t *));
 617 int     nfs_loadattrcache __P((struct vnode **, struct mbuf **, caddr_t *,
 618                                struct vattr *, int));
 619 int     nfs_namei __P((struct nameidata *, fhandle_t *, int,
 620                        struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
 621                        caddr_t *, struct vnode **, struct thread *, int, int));
 622 void    nfsm_adj __P((struct mbuf *, int, int));
 623 int     nfsm_mbuftouio __P((struct mbuf **, struct uio *, int, caddr_t *));
 624 void    nfsrv_initcache __P((void));
 625 int     nfs_getauth __P((struct nfsmount *, struct nfsreq *, struct ucred *,
 626                          char **, int *, char *, int *, NFSKERBKEY_T));
 627 int     nfs_getnickauth __P((struct nfsmount *, struct ucred *, char **,
 628                              int *, char *, int));
 629 int     nfs_savenickauth __P((struct nfsmount *, struct ucred *, int,
 630                               NFSKERBKEY_T, struct mbuf **, char **,
 631                               struct mbuf *));
 632 int     nfs_adv __P((struct mbuf **, caddr_t *, int, int));
 633 void    nfs_nhinit __P((void));
 634 int     nfs_nmcancelreqs __P((struct nfsmount *));
 635 void    nfs_timer __P((void*));
 636 int     nfsrv_dorec __P((struct nfssvc_sock *, struct nfsd *,
 637                          struct nfsrv_descript **));
 638 int     nfsrv_getcache __P((struct nfsrv_descript *, struct nfssvc_sock *,
 639                             struct mbuf **));
 640 void    nfsrv_updatecache __P((struct nfsrv_descript *, int, struct mbuf *));
 641 void    nfsrv_cleancache __P((void));
 642 int     nfs_connect __P((struct nfsmount *, struct nfsreq *));
 643 void    nfs_disconnect __P((struct nfsmount *));
 644 void    nfs_safedisconnect __P((struct nfsmount *));
 645 int     nfs_getattrcache __P((struct vnode *, struct vattr *));
 646 int     nfsm_strtmbuf __P((struct mbuf **, char **, const char *, long));
 647 int     nfs_bioread __P((struct vnode *, struct uio *, int));
 648 int     nfsm_uiotombuf __P((struct uio *, struct mbuf **, int, caddr_t *));
 649 void    nfsrv_init __P((int));
 650 void    nfs_clearcommit __P((struct mount *));
 651 int     nfsrv_errmap __P((struct nfsrv_descript *, int));
 652 void    nfsrvw_sort __P((gid_t *, int));
 653 void    nfsrv_setcred __P((struct ucred *, struct ucred *));
 654 int     nfs_writebp __P((struct buf *, int, struct thread *));
 655 int     nfsrv_object_create __P((struct vnode *));
 656 void    nfsrv_wakenfsd __P((struct nfssvc_sock *slp));
 657 int     nfsrv_writegather __P((struct nfsrv_descript **, struct nfssvc_sock *,
 658                                struct thread *, struct mbuf **));
 659 int     nfs_fsinfo __P((struct nfsmount *, struct vnode *, struct thread *p));
 660
 661 int     nfsrv3_access __P((struct nfsrv_descript *nfsd,
 662                            struct nfssvc_sock *slp,
 663                            struct thread *td, struct mbuf **mrq));
 664 int     nfsrv_commit __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 665                           struct thread *td, struct mbuf **mrq));
 666 int     nfsrv_create __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 667                           struct thread *td, struct mbuf **mrq));
 668 int     nfsrv_fhtovp __P((fhandle_t *, int, struct vnode **, struct ucred *,
 669                           struct nfssvc_sock *, struct sockaddr *, int *,
 670                           int, int));
 671 int     nfsrv_setpublicfs __P((struct mount *, struct netexport *,
 672                                struct export_args *));
 673 int     nfs_ispublicfh __P((fhandle_t *));
 674 int     nfsrv_fsinfo __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 675                           struct thread *td, struct mbuf **mrq));
 676 int     nfsrv_getattr __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 677                            struct thread *td, struct mbuf **mrq));
 678 int     nfsrv_link __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 679                         struct thread *td, struct mbuf **mrq));
 680 int     nfsrv_lookup __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 681                           struct thread *td, struct mbuf **mrq));
 682 int     nfsrv_mkdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 683                          struct thread *td, struct mbuf **mrq));
 684 int     nfsrv_mknod __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 685                          struct thread *td, struct mbuf **mrq));
 686 int     nfsrv_noop __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 687                         struct thread *td, struct mbuf **mrq));
 688 int     nfsrv_null __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 689                         struct thread *td, struct mbuf **mrq));
 690 int     nfsrv_pathconf __P((struct nfsrv_descript *nfsd,
 691                             struct nfssvc_sock *slp, struct thread *td,
 692                             struct mbuf **mrq));
 693 int     nfsrv_read __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 694                         struct thread *td, struct mbuf **mrq));
 695 int     nfsrv_readdir __P((struct nfsrv_descript *nfsd,
 696                            struct nfssvc_sock *slp,
 697                            struct thread *td, struct mbuf **mrq));
 698 int     nfsrv_readdirplus __P((struct nfsrv_descript *nfsd,
 699                                struct nfssvc_sock *slp, struct thread *td,
 700                                struct mbuf **mrq));
 701 int     nfsrv_readlink __P((struct nfsrv_descript *nfsd,
 702                             struct nfssvc_sock *slp, struct thread *td,
 703                             struct mbuf **mrq));
 704 int     nfsrv_remove __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 705                           struct thread *td, struct mbuf **mrq));
 706 int     nfsrv_rename __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 707                           struct thread *td, struct mbuf **mrq));
 708 int     nfsrv_rmdir __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 709                          struct thread *td, struct mbuf **mrq));
 710 int     nfsrv_setattr __P((struct nfsrv_descript *nfsd,
 711                            struct nfssvc_sock *slp,
 712                            struct thread *td, struct mbuf **mrq));
 713 int     nfsrv_statfs __P((struct nfsrv_descript *nfsd,
 714                           struct nfssvc_sock *slp,
 715                           struct thread *td, struct mbuf **mrq));
 716 int     nfsrv_symlink __P((struct nfsrv_descript *nfsd,
 717                            struct nfssvc_sock *slp,
 718                            struct thread *td, struct mbuf **mrq));
 719 int     nfsrv_write __P((struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
 720                          struct thread *td, struct mbuf **mrq));
 721 void    nfsrv_rcv __P((struct socket *so, void *arg, int waitflag));
 722 void    nfsrv_slpderef __P((struct nfssvc_sock *slp));
 723 int     nfs_meta_setsize __P((struct vnode *vp, struct thread *td, u_quad_t nsize));
 724
 725 #endif  /* _KERNEL */
 726
 727 #endif