The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/nfs/nfs.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: nfs.h,v 1.60 2006/09/04 08:27:49 yamt Exp $    */
    2 /*
    3  * Copyright (c) 1989, 1993, 1995
    4  *      The Regents of the University of California.  All rights reserved.
    5  *
    6  * This code is derived from software contributed to Berkeley by
    7  * Rick Macklem at The University of Guelph.
    8  *
    9  * Redistribution and use in source and binary forms, with or without
   10  * modification, are permitted provided that the following conditions
   11  * are met:
   12  * 1. Redistributions of source code must retain the above copyright
   13  *    notice, this list of conditions and the following disclaimer.
   14  * 2. Redistributions in binary form must reproduce the above copyright
   15  *    notice, this list of conditions and the following disclaimer in the
   16  *    documentation and/or other materials provided with the distribution.
   17  * 3. Neither the name of the University nor the names of its contributors
   18  *    may be used to endorse or promote products derived from this software
   19  *    without specific prior written permission.
   20  *
   21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   31  * SUCH DAMAGE.
   32  *
   33  *      @(#)nfs.h       8.4 (Berkeley) 5/1/95
   34  */
   35 
   36 #ifndef _NFS_NFS_H_
   37 #define _NFS_NFS_H_
   38 
   39 /*
   40  * Tunable constants for nfs
   41  */
   42 
   43 #define NFS_MAXIOVEC    34
   44 #define NFS_TICKINTVL   5               /* Desired time for a tick (msec) */
   45 #define NFS_HZ          (hz / nfs_ticks) /* Ticks/sec */
   46 #define NFS_TIMEO       (3 * NFS_HZ)    /* Default timeout = 3 seconds */
   47 #define NFS_MINTIMEO    (1 * NFS_HZ)    /* Min timeout to use */
   48 #define NFS_MAXTIMEO    (60 * NFS_HZ)   /* Max timeout to backoff to */
   49 #define NFS_MINIDEMTIMEO (5 * NFS_HZ)   /* Min timeout for non-idempotent ops*/
   50 #define NFS_MAXREXMIT   100             /* Stop counting after this many */
   51 #define NFS_MAXWINDOW   1024            /* Max number of outstanding requests */
   52 #define NFS_RETRANS     10              /* Num of retrans for soft mounts */
   53 #define NFS_MAXGRPS     16              /* Max. size of groups list */
   54 #ifndef NFS_MINATTRTIMO
   55 #define NFS_MINATTRTIMO 5               /* Attribute cache timeout in sec */
   56 #endif
   57 #ifndef NFS_MAXATTRTIMO
   58 #define NFS_MAXATTRTIMO 60
   59 #endif
   60 #define NFS_TRYLATERDEL 1               /* Initial try later delay (sec) */
   61 #define NFS_TRYLATERDELMAX (1*60)       /* Maximum try later delay (sec) */
   62 #define NFS_TRYLATERDELMUL 2            /* Exponential backoff multiplier */
   63 
   64 /*
   65  * These can be overridden through <machine/param.h>, included via
   66  * <sys/param.h>. This means that <sys/param.h> should always be
   67  * included before this file.
   68  */
   69 #ifndef NFS_WSIZE
   70 #define NFS_WSIZE       8192            /* Def. write data size */
   71 #endif
   72 #ifndef NFS_RSIZE
   73 #define NFS_RSIZE       8192            /* Def. read data size */
   74 #endif
   75 #ifndef NFS_READDIRSIZE
   76 #define NFS_READDIRSIZE 8192            /* Def. readdir size */
   77 #endif
   78 
   79 /*
   80  * NFS client IO daemon threads. May be overridden by config options.
   81  */
   82 #ifndef NFS_MAXASYNCDAEMON
   83 #define NFS_MAXASYNCDAEMON      128     /* Max. number async_daemons runable */
   84 #endif
   85 
   86 /*
   87  * NFS client read-ahead. May be overridden by config options.
   88  * Should be no more than NFS_MAXASYNCDAEMON as each read-ahead operation
   89  * requires one IO thread.
   90  */
   91 #ifndef NFS_MAXRAHEAD
   92 #define NFS_MAXRAHEAD   32              /* Max. read ahead # blocks */
   93 #endif
   94 #define NFS_DEFRAHEAD   2               /* Def. read ahead # blocks */
   95 
   96 #define NFS_MAXUIDHASH  64              /* Max. # of hashed uid entries/mp */
   97 
   98 #ifdef _KERNEL
   99 extern int nfs_niothreads;              /* Number of async_daemons desired */
  100 #ifndef NFS_DEFAULT_NIOTHREADS
  101 #define NFS_DEFAULT_NIOTHREADS 4
  102 #endif
  103 #endif
  104 #define NFS_MAXGATHERDELAY      100     /* Max. write gather delay (msec) */
  105 #ifndef NFS_GATHERDELAY
  106 #define NFS_GATHERDELAY         10      /* Default write gather delay (msec) */
  107 #endif
  108 
  109 /*
  110  * NFS_DIRBLKSIZ is the size of buffers in the buffer cache used for
  111  * NFS directory vnodes. NFS_DIRFRAGSIZ is the minimum aligned amount
  112  * of data in those buffers, and thus the minimum amount of data
  113  * that you can request. NFS_DIRFRAGSIZ should be no smaller than
  114  * DIRBLKSIZ.
  115  */
  116 
  117 #define NFS_DIRBLKSIZ   8192            /* Must be a multiple of DIRBLKSIZ */
  118 #define NFS_DIRFRAGSIZ   512            /* Same as DIRBLKSIZ, generally */
  119 
  120 /*
  121  * Maximum number of directory entries cached per NFS node, to avoid
  122  * having this grow without bounds on very large directories. The
  123  * minimum size to get reasonable performance for emulated binaries
  124  * is the maximum number of entries that fits in NFS_DIRBLKSIZ.
  125  * For NFS_DIRBLKSIZ = 512, this would be 512 / 14 = 36.
  126  */
  127 #define NFS_MAXDIRCACHE (NFS_DIRBLKSIZ / 14)
  128 
  129 /*
  130  * Oddballs
  131  */
  132 #define NFS_CMPFH(n, f, s) \
  133         ((n)->n_fhsize == (s) && !memcmp((caddr_t)(n)->n_fhp,  (caddr_t)(f),  (s)))
  134 #ifdef NFS_V2_ONLY
  135 #define NFS_ISV3(v)     (0)
  136 #else
  137 #define NFS_ISV3(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
  138 #endif
  139 #define NFS_SRVMAXDATA(n) \
  140                 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
  141                  NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
  142 
  143 /*
  144  * Use the vm_page flag reserved for pager use to indicate pages
  145  * which have been written to the server but not yet committed.
  146  */
  147 #define PG_NEEDCOMMIT PG_PAGER1
  148 
  149 /*
  150  * The IO_METASYNC flag should be implemented for local file systems.
  151  * (Until then, it is nothin at all.)
  152  */
  153 #ifndef IO_METASYNC
  154 #define IO_METASYNC     0
  155 #endif
  156 
  157 /*
  158  * Set the attribute timeout based on how recently the file has been modified.
  159  */
  160 #define NFS_ATTRTIMEO(nmp, np) \
  161     ((nmp->nm_flag & NFSMNT_NOAC) ? 0 : \
  162         ((((np)->n_flag & NMODIFIED) || \
  163          (time_second - (np)->n_mtime.tv_sec) / 10 < NFS_MINATTRTIMO) ? NFS_MINATTRTIMO : \
  164          ((time_second - (np)->n_mtime.tv_sec) / 10 > NFS_MAXATTRTIMO ? NFS_MAXATTRTIMO : \
  165           (time_second - (np)->n_mtime.tv_sec) / 10)))
  166 
  167 /*
  168  * Export arguments for local filesystem mount calls.
  169  * Keep in mind that changing this structure modifies nfssvc(2)'s ABI (see
  170  * 'struct mountd_exports_list' below).
  171  * When modifying this structure, take care to also edit the
  172  * nfs_update_exports_30 function in nfs_export.c accordingly to convert
  173  * export_args to export_args30.
  174  */
  175 struct export_args {
  176         int     ex_flags;               /* export related flags */
  177         uid_t   ex_root;                /* mapping for root uid */
  178         struct  uucred ex_anon;         /* mapping for anonymous user */
  179         struct  sockaddr *ex_addr;      /* net address to which exported */
  180         int     ex_addrlen;             /* and the net address length */
  181         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
  182         int     ex_masklen;             /* and the smask length */
  183         char    *ex_indexfile;          /* index file for WebNFS URLs */
  184 };
  185 
  186 /*
  187  * Structures for the nfssvc(2) syscall. Not that anyone but mountd, nfsd and
  188  * mount_nfs should ever try and use it.
  189  */
  190 struct nfsd_args {
  191         int     sock;           /* Socket to serve */
  192         caddr_t name;           /* Client addr for connection based sockets */
  193         int     namelen;        /* Length of name */
  194 };
  195 
  196 struct nfsd_srvargs {
  197         struct nfsd     *nsd_nfsd;      /* Pointer to in kernel nfsd struct */
  198         uid_t           nsd_uid;        /* Effective uid mapped to cred */
  199         u_int32_t       nsd_haddr;      /* Ip address of client */
  200         struct uucred   nsd_cr;         /* Cred. uid maps to */
  201         int             nsd_authlen;    /* Length of auth string (ret) */
  202         u_char          *nsd_authstr;   /* Auth string (ret) */
  203         int             nsd_verflen;    /* and the verfier */
  204         u_char          *nsd_verfstr;
  205         struct timeval  nsd_timestamp;  /* timestamp from verifier */
  206         u_int32_t       nsd_ttl;        /* credential ttl (sec) */
  207         NFSKERBKEY_T    nsd_key;        /* Session key */
  208 };
  209 
  210 struct nfsd_cargs {
  211         char            *ncd_dirp;      /* Mount dir path */
  212         uid_t           ncd_authuid;    /* Effective uid */
  213         int             ncd_authtype;   /* Type of authenticator */
  214         u_int           ncd_authlen;    /* Length of authenticator string */
  215         u_char          *ncd_authstr;   /* Authenticator string */
  216         u_int           ncd_verflen;    /* and the verifier */
  217         u_char          *ncd_verfstr;
  218         NFSKERBKEY_T    ncd_key;        /* Session key */
  219 };
  220 
  221 struct mountd_exports_list {
  222         const char              *mel_path;
  223         size_t                  mel_nexports;
  224         struct export_args      *mel_exports;
  225 };
  226 
  227 /*
  228  * Stats structure
  229  */
  230 struct nfsstats {
  231         int     attrcache_hits;
  232         int     attrcache_misses;
  233         int     lookupcache_hits;
  234         int     lookupcache_misses;
  235         int     direofcache_hits;
  236         int     direofcache_misses;
  237         int     biocache_reads;
  238         int     read_bios;
  239         int     read_physios;
  240         int     biocache_writes;
  241         int     write_bios;
  242         int     write_physios;
  243         int     biocache_readlinks;
  244         int     readlink_bios;
  245         int     biocache_readdirs;
  246         int     readdir_bios;
  247         int     rpccnt[NFS_NPROCS];
  248         int     rpcretries;
  249         int     srvrpccnt[NFS_NPROCS];
  250         int     srvrpc_errs;
  251         int     srv_errs;
  252         int     rpcrequests;
  253         int     rpctimeouts;
  254         int     rpcunexpected;
  255         int     rpcinvalid;
  256         int     srvcache_inproghits;
  257         int     srvcache_idemdonehits;
  258         int     srvcache_nonidemdonehits;
  259         int     srvcache_misses;
  260         int     srvnqnfs_leases;
  261         int     srvnqnfs_maxleases;
  262         int     srvnqnfs_getleases;
  263         int     srvvop_writes;
  264 };
  265 
  266 /*
  267  * Flags for nfssvc() system call.
  268  */
  269 #define NFSSVC_BIOD     0x002
  270 #define NFSSVC_NFSD     0x004
  271 #define NFSSVC_ADDSOCK  0x008
  272 #define NFSSVC_AUTHIN   0x010
  273 #define NFSSVC_GOTAUTH  0x040
  274 #define NFSSVC_AUTHINFAIL 0x080
  275 #define NFSSVC_MNTD     0x100
  276 #define NFSSVC_SETEXPORTSLIST   0x200
  277 
  278 /*
  279  * fs.nfs sysctl(3) identifiers
  280  */
  281 #define NFS_NFSSTATS    1               /* struct: struct nfsstats */
  282 #define NFS_IOTHREADS   2               /* number of io threads */
  283 #define NFS_MAXID       3
  284 
  285 #define NFS_NAMES { \
  286         { 0, 0 }, \
  287         { "nfsstats", CTLTYPE_STRUCT }, \
  288         { "iothreads", CTLTYPE_INT }, \
  289 }
  290 
  291 /*
  292  * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
  293  * What should be in this set is open to debate, but I believe that since
  294  * I/O system calls on ufs are never interrupted by signals the set should
  295  * be minimal. My reasoning is that many current programs that use signals
  296  * such as SIGALRM will not expect file I/O system calls to be interrupted
  297  * by them and break.
  298  */
  299 #ifdef _KERNEL
  300 
  301 struct uio; struct buf; struct vattr; struct nameidata; /* XXX */
  302 
  303 /*
  304  * Socket errors ignored for connectionless sockets??
  305  * For now, ignore them all
  306  */
  307 #define NFSIGNORE_SOERROR(s, e) \
  308                 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
  309                 ((s) & PR_CONNREQUIRED) == 0)
  310 
  311 /*
  312  * Nfs outstanding request list element
  313  */
  314 struct nfsreq {
  315         TAILQ_ENTRY(nfsreq) r_chain;
  316         struct mbuf     *r_mreq;
  317         struct mbuf     *r_mrep;
  318         struct mbuf     *r_md;
  319         caddr_t         r_dpos;
  320         struct nfsmount *r_nmp;
  321         u_int32_t       r_xid;
  322         int             r_flags;        /* flags on request, see below */
  323         int             r_retry;        /* max retransmission count */
  324         int             r_rexmit;       /* current retrans count */
  325         int             r_timer;        /* tick counter on reply */
  326         u_int32_t       r_procnum;      /* NFS procedure number */
  327         int             r_rtt;          /* RTT for rpc */
  328         struct lwp      *r_lwp;         /* LWP that did I/O system call */
  329 };
  330 
  331 /*
  332  * Queue head for nfsreq's
  333  */
  334 extern TAILQ_HEAD(nfsreqhead, nfsreq) nfs_reqq;
  335 
  336 /* Flag values for r_flags */
  337 #define R_TIMING        0x01            /* timing request (in mntp) */
  338 #define R_SENT          0x02            /* request has been sent */
  339 #define R_SOFTTERM      0x04            /* soft mnt, too many retries */
  340 #define R_INTR          0x08            /* intr mnt, signal pending */
  341 #define R_SOCKERR       0x10            /* Fatal error on socket */
  342 #define R_TPRINTFMSG    0x20            /* Did a tprintf msg. */
  343 #define R_MUSTRESEND    0x40            /* Must resend request */
  344 #define R_GETONEREP     0x80            /* Probe for one reply only */
  345 #define R_REXMITTED     0x100           /* retransmitted after reconnect */
  346 
  347 /*
  348  * A list of nfssvc_sock structures is maintained with all the sockets
  349  * that require service by the nfsd.
  350  * The nfsuid structs hang off of the nfssvc_sock structs in both lru
  351  * and uid hash lists.
  352  */
  353 #ifndef NFS_UIDHASHSIZ
  354 #define NFS_UIDHASHSIZ  29      /* Tune the size of nfssvc_sock with this */
  355 #endif
  356 #define NUIDHASH(sock, uid) \
  357         (&(sock)->ns_uidhashtbl[(uid) % NFS_UIDHASHSIZ])
  358 #ifndef NFS_WDELAYHASHSIZ
  359 #define NFS_WDELAYHASHSIZ 16    /* and with this */
  360 #endif
  361 #ifndef NFS_MUIDHASHSIZ
  362 #define NFS_MUIDHASHSIZ 63      /* Tune the size of nfsmount with this */
  363 #endif
  364 #define NMUIDHASH(nmp, uid) \
  365         (&(nmp)->nm_uidhashtbl[(uid) % NFS_MUIDHASHSIZ])
  366 #define NFSNOHASH(fhsum) ((fhsum) & nfsnodehash)
  367 
  368 #ifndef NFS_DIRHASHSIZ
  369 #define NFS_DIRHASHSIZ 64
  370 #endif
  371 #define NFSDIRHASH(np, off) \
  372         (&np->n_dircache[(nfs_dirhash((off)) & nfsdirhashmask)])
  373 
  374 /*
  375  * Macros for storing/retrieving cookies into directory buffers.
  376  */
  377 #define NFS_STASHCOOKIE(dp,off) \
  378         *((off_t *)((caddr_t)(dp) + (dp)->d_reclen - sizeof (off_t))) = off
  379 #define NFS_GETCOOKIE(dp) \
  380         (*((off_t *)((caddr_t)(dp) + (dp)->d_reclen - sizeof (off_t))))
  381 #define NFS_STASHCOOKIE32(dp, val) \
  382         *((u_int32_t *)((caddr_t)(dp) + (dp)->d_reclen - sizeof (off_t) - \
  383             sizeof (int))) = val
  384 #define NFS_GETCOOKIE32(dp) \
  385         (*((u_int32_t *)((caddr_t)(dp) + (dp)->d_reclen - sizeof (off_t) - \
  386             sizeof (int))))
  387 
  388 /*
  389  * Flags passed to nfs_bioread().
  390  */
  391 #define NFSBIO_CACHECOOKIES     0x0001  /* Cache dir offset cookies */
  392 
  393 /*
  394  * Network address hash list element
  395  */
  396 union nethostaddr {
  397         u_int32_t had_inetaddr;
  398         struct mbuf *had_nam;
  399 };
  400 
  401 struct nfsuid {
  402         TAILQ_ENTRY(nfsuid) nu_lru;     /* LRU chain */
  403         LIST_ENTRY(nfsuid) nu_hash;     /* Hash list */
  404         int             nu_flag;        /* Flags */
  405         union nethostaddr nu_haddr;     /* Host addr. for dgram sockets */
  406         kauth_cred_t    nu_cr;          /* Cred uid mapped to */
  407         int             nu_expire;      /* Expiry time (sec) */
  408         struct timeval  nu_timestamp;   /* Kerb. timestamp */
  409         u_int32_t       nu_nickname;    /* Nickname on server */
  410         NFSKERBKEY_T    nu_key;         /* and session key */
  411 };
  412 
  413 #define nu_inetaddr     nu_haddr.had_inetaddr
  414 #define nu_nam          nu_haddr.had_nam
  415 /* Bits for nu_flag */
  416 #define NU_INETADDR     0x1
  417 #define NU_NAM          0x2
  418 #ifdef INET6
  419 #define NU_NETFAM(u) \
  420         (((u)->nu_flag & NU_INETADDR) ? \
  421         (((u)->nu_flag & NU_NAM) ? AF_INET6 : AF_INET) : AF_ISO)
  422 #else
  423 #define NU_NETFAM(u)    (((u)->nu_flag & NU_INETADDR) ? AF_INET : AF_ISO)
  424 #endif
  425 
  426 struct nfssvc_sock {
  427         struct simplelock ns_lock;
  428         TAILQ_ENTRY(nfssvc_sock) ns_chain;      /* List of all nfssvc_sock's */
  429         TAILQ_ENTRY(nfssvc_sock) ns_pending;    /* List of pending sockets */
  430         TAILQ_HEAD(, nfsuid) ns_uidlruhead;
  431         struct file     *ns_fp;
  432         struct socket   *ns_so;
  433         struct mbuf     *ns_nam;
  434         struct mbuf     *ns_raw;
  435         struct mbuf     *ns_rawend;
  436         struct mbuf     *ns_rec;
  437         struct mbuf     *ns_recend;
  438         struct mbuf     *ns_frag;
  439         int             ns_flag;
  440         int             ns_solock;
  441         int             ns_cc;
  442         int             ns_reclen;
  443         int             ns_numuids;
  444         u_int32_t       ns_sref;
  445         SIMPLEQ_HEAD(, nfsrv_descript) ns_sendq; /* send reply list */
  446         LIST_HEAD(, nfsrv_descript) ns_tq;      /* Write gather lists */
  447         LIST_HEAD(, nfsuid) ns_uidhashtbl[NFS_UIDHASHSIZ];
  448         LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
  449 };
  450 
  451 /* Bits for "ns_flag" */
  452 #define SLP_VALID       0x01
  453 #define SLP_DOREC       0x02    /* on nfssvc_sockpending queue */
  454 #define SLP_NEEDQ       0x04
  455 #define SLP_DISCONN     0x08
  456 #define SLP_BUSY        0x10
  457 #define SLP_WANT        0x20
  458 #define SLP_LASTFRAG    0x40
  459 #define SLP_SENDING     0x80
  460 
  461 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
  462 extern struct nfssvc_sockhead nfssvc_sockpending;
  463 extern int nfssvc_sockhead_flag;
  464 #define SLP_INIT        0x01
  465 #define SLP_WANTINIT    0x02
  466 
  467 /*
  468  * One of these structures is allocated for each nfsd.
  469  */
  470 struct nfsd {
  471         TAILQ_ENTRY(nfsd) nfsd_chain;   /* List of all nfsd's */
  472         SLIST_ENTRY(nfsd) nfsd_idle;    /* List of idle nfsd's */
  473         int             nfsd_flag;      /* NFSD_ flags */
  474         struct nfssvc_sock *nfsd_slp;   /* Current socket */
  475         int             nfsd_authlen;   /* Authenticator len */
  476         u_char          nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
  477         int             nfsd_verflen;   /* and the Verifier */
  478         u_char          nfsd_verfstr[RPCVERF_MAXSIZ];
  479         struct proc     *nfsd_procp;    /* Proc ptr */
  480         struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
  481 };
  482 
  483 /* Bits for "nfsd_flag" */
  484 #define NFSD_NEEDAUTH   0x04
  485 #define NFSD_AUTHFAIL   0x08
  486 
  487 #define NFSD_MAXFHSIZE  64
  488 typedef struct nfsrvfh {
  489         size_t nsfh_size;
  490         union {
  491                 fhandle_t u_fh;
  492                 uint8_t u_opaque[NFSD_MAXFHSIZE];
  493         } nsfh_u;
  494 } nfsrvfh_t;
  495 #define NFSRVFH_SIZE(nsfh)      ((nsfh)->nsfh_size)
  496 #define NFSRVFH_DATA(nsfh)      ((nsfh)->nsfh_u.u_opaque)
  497 #define NFSRVFH_FHANDLE(nsfh)   (&(nsfh)->nsfh_u.u_fh)
  498 
  499 /*
  500  * This structure is used by the server for describing each request.
  501  * Some fields are used only when write request gathering is performed.
  502  */
  503 struct nfsrv_descript {
  504         u_quad_t                nd_time;        /* Write deadline (usec) */
  505         off_t                   nd_off;         /* Start byte offset */
  506         off_t                   nd_eoff;        /* and end byte offset */
  507         LIST_ENTRY(nfsrv_descript) nd_hash;     /* Hash list */
  508         LIST_ENTRY(nfsrv_descript) nd_tq;               /* and timer list */
  509         LIST_HEAD(,nfsrv_descript) nd_coalesce; /* coalesced writes */
  510         SIMPLEQ_ENTRY(nfsrv_descript) nd_sendq; /* send reply list */
  511         struct mbuf             *nd_mrep;       /* Request mbuf list */
  512         struct mbuf             *nd_md;         /* Current dissect mbuf */
  513         struct mbuf             *nd_mreq;       /* Reply mbuf list */
  514         struct mbuf             *nd_nam;        /* and socket addr */
  515         struct mbuf             *nd_nam2;       /* return socket addr */
  516         caddr_t                 nd_dpos;        /* Current dissect pos */
  517         u_int32_t               nd_procnum;     /* RPC # */
  518         int                     nd_stable;      /* storage type */
  519         int                     nd_flag;        /* nd_flag */
  520         int                     nd_len;         /* Length of this write */
  521         int                     nd_repstat;     /* Reply status */
  522         u_int32_t               nd_retxid;      /* Reply xid */
  523         u_int32_t               nd_duration;    /* Lease duration */
  524         struct timeval          nd_starttime;   /* Time RPC initiated */
  525         nfsrvfh_t               nd_fh;          /* File handle */
  526         kauth_cred_t            nd_cr;          /* Credentials */
  527 };
  528 
  529 /* Bits for "nd_flag" */
  530 #define ND_READ         LEASE_READ
  531 #define ND_WRITE        LEASE_WRITE
  532 #define ND_CHECK        0x04
  533 #define ND_LEASE        (ND_READ | ND_WRITE | ND_CHECK)
  534 #define ND_NFSV3        0x08
  535 #define ND_NQNFS        0x10
  536 #define ND_KERBNICK     0x20
  537 #define ND_KERBFULL     0x40
  538 #define ND_KERBAUTH     (ND_KERBNICK | ND_KERBFULL)
  539 
  540 extern struct simplelock nfsd_slock;
  541 extern TAILQ_HEAD(nfsdhead, nfsd) nfsd_head;
  542 extern SLIST_HEAD(nfsdidlehead, nfsd) nfsd_idle_head;
  543 extern int nfsd_head_flag;
  544 #define NFSD_CHECKSLP   0x01
  545 
  546 extern struct mowner nfs_mowner;
  547 extern struct nfsstats nfsstats;
  548 extern int nfs_numasync;
  549 
  550 /*
  551  * These macros compare nfsrv_descript structures.
  552  */
  553 #define NFSW_CONTIG(o, n) \
  554                 ((o)->nd_eoff >= (n)->nd_off && \
  555                  !memcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
  556 
  557 /*
  558  * Defines for WebNFS
  559  */
  560 
  561 #define WEBNFS_ESC_CHAR         '%'
  562 #define WEBNFS_SPECCHAR_START   0x80
  563 
  564 #define WEBNFS_NATIVE_CHAR      0x80
  565 /*
  566  * ..
  567  * Possibly more here in the future.
  568  */
  569 
  570 /*
  571  * Macro for converting escape characters in WebNFS pathnames.
  572  * Should really be in libkern.
  573  */
  574 
  575 #define HEXTOC(c) \
  576         ((c) >= 'a' ? ((c) - ('a' - 10)) : \
  577             ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '')))
  578 #define HEXSTRTOI(p) \
  579         ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
  580 
  581 /*
  582  * Structure holding information for a publicly exported filesystem
  583  * (WebNFS).  Currently the specs allow just for one such filesystem.
  584  */
  585 struct nfs_public {
  586         int             np_valid;       /* Do we hold valid information */
  587         fhandle_t       *np_handle;     /* Filehandle for pub fs (internal) */
  588         struct mount    *np_mount;      /* Mountpoint of exported fs */
  589         char            *np_index;      /* Index file */
  590 };
  591 #endif  /* _KERNEL */
  592 
  593 #endif /* _NFS_NFS_H */

Cache object: 56b994b84bf74e37677f66470cdf19ad


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.