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