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