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