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