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/nfsserver/nfs.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    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  * 4. Neither the name of the University nor the names of its contributors
   17  *    may be used to endorse or promote products derived from this software
   18  *    without specific prior written permission.
   19  *
   20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   30  * SUCH DAMAGE.
   31  *
   32  *      @(#)nfs.h       8.4 (Berkeley) 5/1/95
   33  * $FreeBSD$
   34  */
   35 
   36 #ifndef _NFSSERVER_NFS_H_
   37 #define _NFSSERVER_NFS_H_
   38 
   39 #ifdef _KERNEL
   40 #include "opt_nfs.h"
   41 #endif
   42 
   43 /*
   44  * Tunable constants for nfs
   45  */
   46 
   47 #define NFS_TICKINTVL   10              /* Desired time for a tick (msec) */
   48 #define NFS_HZ          (hz / nfs_ticks) /* Ticks/sec */
   49 #define NFS_TIMEO       (1 * NFS_HZ)    /* Default timeout = 1 second */
   50 #define NFS_MINTIMEO    (1 * NFS_HZ)    /* Min timeout to use */
   51 #define NFS_MAXTIMEO    (60 * NFS_HZ)   /* Max timeout to backoff to */
   52 #define NFS_MINIDEMTIMEO (5 * NFS_HZ)   /* Min timeout for non-idempotent ops*/
   53 #define NFS_MAXUIDHASH  64              /* Max. # of hashed uid entries/mp */
   54 #ifndef NFS_GATHERDELAY
   55 #define NFS_GATHERDELAY         10      /* Default write gather delay (msec) */
   56 #endif
   57 #ifdef _KERNEL
   58 #define DIRBLKSIZ       512             /* XXX we used to use ufs's DIRBLKSIZ */
   59 #endif
   60 
   61 /*
   62  * Oddballs
   63  */
   64 #define NFS_SRVMAXDATA(n) \
   65                 (((n)->nd_flag & ND_NFSV3) ? (((n)->nd_nam2) ? \
   66                  NFS_MAXDGRAMDATA : NFS_MAXDATA) : NFS_V2MAXDATA)
   67 
   68 /*
   69  * XXX
   70  * The B_INVAFTERWRITE flag should be set to whatever is required by the
   71  * buffer cache code to say "Invalidate the block after it is written back".
   72  */
   73 #define B_INVAFTERWRITE B_NOCACHE
   74 
   75 /*
   76  * The IO_METASYNC flag should be implemented for local filesystems.
   77  * (Until then, it is nothin at all.)
   78  */
   79 #ifndef IO_METASYNC
   80 #define IO_METASYNC     0
   81 #endif
   82 
   83 
   84 /* NFS state flags XXX -Wunused */
   85 #define NFSRV_SNDLOCK           0x01000000  /* Send socket lock */
   86 #define NFSRV_WANTSND           0x02000000  /* Want above */
   87 
   88 /*
   89  * Structures for the nfssvc(2) syscall. Not that anyone but nfsd and mount_nfs
   90  * should ever try and use it.
   91  */
   92 struct nfsd_args {
   93         int     sock;           /* Socket to serve */
   94         caddr_t name;           /* Client addr for connection based sockets */
   95         int     namelen;        /* Length of name */
   96 };
   97 
   98 /*
   99  * XXX to allow amd to include nfs.h without nfsproto.h
  100  */
  101 #ifdef NFS_NPROCS
  102 #include <nfsserver/nfsrvstats.h>
  103 #endif
  104 
  105 /*
  106  * Flags for nfssvc() system call.
  107  */
  108 #define NFSSVC_NFSD     0x004
  109 #define NFSSVC_ADDSOCK  0x008
  110 
  111 /*
  112  * vfs.nfsrv sysctl(3) identifiers
  113  */
  114 #define NFS_NFSRVSTATS  1               /* struct: struct nfsrvstats */
  115 #define NFS_NFSPRIVPORT 2               /* int: prohibit nfs to resvports */
  116 
  117 #ifdef _KERNEL
  118 
  119 extern struct mtx nfsd_mtx;
  120 #define NFSD_LOCK_ASSERT()      mtx_assert(&nfsd_mtx, MA_OWNED)
  121 #define NFSD_UNLOCK_ASSERT()    mtx_assert(&nfsd_mtx, MA_NOTOWNED)
  122 #define NFSD_LOCK_DONTCARE()
  123 #define NFSD_LOCK()     mtx_lock(&nfsd_mtx)
  124 #define NFSD_UNLOCK()   mtx_unlock(&nfsd_mtx)
  125 
  126 #ifdef MALLOC_DECLARE
  127 MALLOC_DECLARE(M_NFSRVDESC);
  128 MALLOC_DECLARE(M_NFSD);
  129 #endif
  130 
  131 /* Forward declarations */
  132 struct nfssvc_sock;
  133 struct nfsrv_descript;
  134 struct uio;
  135 struct vattr;
  136 struct nameidata;
  137 
  138 extern struct callout nfsrv_callout;
  139 extern struct nfsrvstats nfsrvstats;
  140 
  141 extern int      nfsrv_ticks;
  142 extern int      nfsrvw_procrastinate;
  143 extern int      nfsrvw_procrastinate_v3;
  144 extern int      nfsrv_numnfsd;
  145 
  146 /* Various values converted to XDR form. */
  147 extern u_int32_t nfsrv_nfs_false, nfsrv_nfs_true, nfsrv_nfs_xdrneg1,
  148         nfsrv_nfs_prog;
  149 extern u_int32_t nfsrv_rpc_reply, nfsrv_rpc_msgdenied, nfsrv_rpc_mismatch,
  150         nfsrv_rpc_vers;
  151 extern u_int32_t nfsrv_rpc_auth_unix, nfsrv_rpc_msgaccepted, nfsrv_rpc_call,
  152         nfsrv_rpc_autherr;
  153 
  154 /* Procedure table data */
  155 extern const int        nfsrvv2_procid[NFS_NPROCS];
  156 extern const int        nfsrv_nfsv3_procid[NFS_NPROCS];
  157 extern int32_t (*nfsrv3_procs[NFS_NPROCS])(struct nfsrv_descript *nd,
  158                     struct nfssvc_sock *slp, struct thread *td,
  159                     struct mbuf **mreqp);
  160 
  161 /*
  162  * A list of nfssvc_sock structures is maintained with all the sockets
  163  * that require service by the nfsd.
  164  */
  165 #ifndef NFS_WDELAYHASHSIZ
  166 #define NFS_WDELAYHASHSIZ 16    /* and with this */
  167 #endif
  168 #define NWDELAYHASH(sock, f) \
  169         (&(sock)->ns_wdelayhashtbl[(*((u_int32_t *)(f))) % NFS_WDELAYHASHSIZ])
  170 
  171 /*
  172  * Network address hash list element
  173  */
  174 union nethostaddr {
  175         u_int32_t had_inetaddr;
  176         struct sockaddr *had_nam;
  177 };
  178 
  179 struct nfsrv_rec {
  180         STAILQ_ENTRY(nfsrv_rec) nr_link;
  181         struct sockaddr *nr_address;
  182         struct mbuf     *nr_packet;
  183 };
  184 
  185 struct nfssvc_sock {
  186         TAILQ_ENTRY(nfssvc_sock) ns_chain;      /* List of all nfssvc_sock's */
  187         struct file     *ns_fp;
  188         struct socket   *ns_so;
  189         struct sockaddr *ns_nam;
  190         struct mbuf     *ns_raw;
  191         struct mbuf     *ns_rawend;
  192         STAILQ_HEAD(, nfsrv_rec) ns_rec;
  193         struct mbuf     *ns_frag;
  194         int             ns_flag;
  195         int             ns_solock;
  196         int             ns_cc;
  197         int             ns_reclen;
  198         u_int32_t       ns_sref;
  199         LIST_HEAD(, nfsrv_descript) ns_tq;      /* Write gather lists */
  200         LIST_HEAD(nfsrvw_delayhash, nfsrv_descript) ns_wdelayhashtbl[NFS_WDELAYHASHSIZ];
  201 };
  202 
  203 /* Bits for "ns_flag" */
  204 #define SLP_VALID       0x01            /* Socket valid for use (XXX) */
  205 #define SLP_DOREC       0x02            /* Socket ready for processing */
  206 #define SLP_NEEDQ       0x04            /* Socket has request queued */
  207 #define SLP_DISCONN     0x08            /* Error received from stream socket */
  208 #define SLP_GETSTREAM   0x10            /* nfsrv_getstream in prog on sock */
  209 #define SLP_LASTFRAG    0x20            /* Socket received end-of-record */
  210 #define SLP_ALLFLAGS    0xff
  211 
  212 extern TAILQ_HEAD(nfssvc_sockhead, nfssvc_sock) nfssvc_sockhead;
  213 extern int nfssvc_sockhead_flag;
  214 #define SLP_INIT        0x01
  215 #define SLP_WANTINIT    0x02
  216 
  217 /*
  218  * One of these structures is allocated for each nfsd.
  219  */
  220 struct nfsd {
  221         TAILQ_ENTRY(nfsd) nfsd_chain;   /* List of all nfsd's */
  222         int             nfsd_flag;      /* NFSD_ flags */
  223         struct nfssvc_sock *nfsd_slp;   /* Current socket */
  224         int             nfsd_authlen;   /* Authenticator len */
  225         u_char          nfsd_authstr[RPCAUTH_MAXSIZ]; /* Authenticator data */
  226         int             nfsd_verflen;   /* and the Verifier */
  227         u_char          nfsd_verfstr[RPCVERF_MAXSIZ];
  228         struct thread   *nfsd_td;       /* daemon thread ptr */
  229         struct nfsrv_descript *nfsd_nd; /* Associated nfsrv_descript */
  230 };
  231 
  232 /* Bits for "nfsd_flag" */
  233 #define NFSD_WAITING    0x01
  234 #define NFSD_REQINPROG  0x02
  235 
  236 /*
  237  * This structure is used by the server for describing each request.
  238  * Some fields are used only when write request gathering is performed.
  239  */
  240 struct nfsrv_descript {
  241         u_quad_t                nd_time;        /* Write deadline (usec) */
  242         off_t                   nd_off;         /* Start byte offset */
  243         off_t                   nd_eoff;        /* and end byte offset */
  244         LIST_ENTRY(nfsrv_descript) nd_hash;     /* Hash list */
  245         LIST_ENTRY(nfsrv_descript) nd_tq;       /* and timer list */
  246         LIST_HEAD(, nfsrv_descript) nd_coalesce;/* coalesced writes */
  247         struct mbuf             *nd_mrep;       /* Request mbuf list */
  248         struct mbuf             *nd_md;         /* Current dissect mbuf */
  249         struct mbuf             *nd_mreq;       /* Reply mbuf list */
  250         struct sockaddr         *nd_nam;        /* and socket addr */
  251         struct sockaddr         *nd_nam2;       /* return socket addr */
  252         caddr_t                 nd_dpos;        /* Current dissect pos */
  253         u_int32_t               nd_procnum;     /* RPC # */
  254         int                     nd_stable;      /* storage type */
  255         int                     nd_flag;        /* nd_flag */
  256         int                     nd_len;         /* Length of this write */
  257         int                     nd_repstat;     /* Reply status */
  258         u_int32_t               nd_retxid;      /* Reply xid */
  259         struct timeval          nd_starttime;   /* Time RPC initiated */
  260         fhandle_t               nd_fh;          /* File handle */
  261         struct ucred            *nd_cr;         /* Credentials */
  262 };
  263 
  264 /* Bits for "nd_flag" */
  265 #define ND_NFSV3        0x08
  266 
  267 extern TAILQ_HEAD(nfsd_head, nfsd) nfsd_head;
  268 extern int nfsd_head_flag;
  269 #define NFSD_CHECKSLP   0x01
  270 
  271 /*
  272  * These macros compare nfsrv_descript structures.
  273  */
  274 #define NFSW_CONTIG(o, n) \
  275                 ((o)->nd_eoff >= (n)->nd_off && \
  276                  !bcmp((caddr_t)&(o)->nd_fh, (caddr_t)&(n)->nd_fh, NFSX_V3FH))
  277 
  278 /*
  279  * Defines for WebNFS
  280  */
  281 
  282 #define WEBNFS_ESC_CHAR         '%'
  283 #define WEBNFS_SPECCHAR_START   0x80
  284 
  285 #define WEBNFS_NATIVE_CHAR      0x80
  286 /*
  287  * ..
  288  * Possibly more here in the future.
  289  */
  290 
  291 /*
  292  * Macro for converting escape characters in WebNFS pathnames.
  293  * Should really be in libkern.
  294  */
  295 
  296 #define HEXTOC(c) \
  297         ((c) >= 'a' ? ((c) - ('a' - 10)) : \
  298             ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '')))
  299 #define HEXSTRTOI(p) \
  300         ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
  301 
  302 #ifdef NFS_DEBUG
  303 
  304 extern int nfs_debug;
  305 #define NFS_DEBUG_ASYNCIO       1 /* asynchronous i/o */
  306 #define NFS_DEBUG_WG            2 /* server write gathering */
  307 #define NFS_DEBUG_RC            4 /* server request caching */
  308 
  309 #define NFS_DPF(cat, args)                                      \
  310         do {                                                    \
  311                 if (nfs_debug & NFS_DEBUG_##cat) printf args;   \
  312         } while (0)
  313 
  314 #else
  315 
  316 #define NFS_DPF(cat, args)
  317 
  318 #endif
  319 
  320 int     nfs_getreq(struct nfsrv_descript *, struct nfsd *, int);
  321 int     nfsrv_send(struct socket *, struct sockaddr *, struct mbuf *);
  322 struct mbuf *nfs_rephead(int, struct nfsrv_descript *, int, struct mbuf **,
  323             caddr_t *);
  324 int     nfs_slplock(struct nfssvc_sock *, int);
  325 void    nfs_slpunlock(struct nfssvc_sock *);
  326 void    nfsm_srvfattr(struct nfsrv_descript *, struct vattr *,
  327             struct nfs_fattr *);
  328 void    nfsm_srvwcc(struct nfsrv_descript *, int, struct vattr *, int,
  329             struct vattr *, struct mbuf **, char **);
  330 void    nfsm_srvpostopattr(struct nfsrv_descript *, int, struct vattr *,
  331             struct mbuf **, char **);
  332 int     netaddr_match(int, union nethostaddr *, struct sockaddr *);
  333 int     nfs_namei(struct nameidata *, fhandle_t *, int,
  334             struct nfssvc_sock *, struct sockaddr *, struct mbuf **,
  335             caddr_t *, struct vnode **, int, struct vattr *, int *,
  336             struct thread *, int);
  337 void    nfsm_adj(struct mbuf *, int, int);
  338 int     nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
  339 void    nfsrv_initcache(void);
  340 void    nfsrv_destroycache(void);
  341 void    nfsrv_timer(void *);
  342 int     nfsrv_dorec(struct nfssvc_sock *, struct nfsd *,
  343             struct nfsrv_descript **);
  344 int     nfsrv_getcache(struct nfsrv_descript *, struct mbuf **);
  345 void    nfsrv_updatecache(struct nfsrv_descript *, int, struct mbuf *);
  346 void    nfsrv_cleancache(void);
  347 void    nfsrv_init(int);
  348 int     nfsrv_errmap(struct nfsrv_descript *, int);
  349 void    nfsrvw_sort(gid_t *, int);
  350 void    nfsrv_wakenfsd(struct nfssvc_sock *slp);
  351 int     nfsrv_writegather(struct nfsrv_descript **, struct nfssvc_sock *,
  352             struct thread *, struct mbuf **);
  353 
  354 int     nfsrv3_access(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  355             struct thread *td, struct mbuf **mrq);
  356 int     nfsrv_commit(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  357             struct thread *td, struct mbuf **mrq);
  358 int     nfsrv_create(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  359             struct thread *td, struct mbuf **mrq);
  360 int     nfsrv_fhtovp(fhandle_t *, int, struct vnode **, int *, struct ucred *,
  361             struct nfssvc_sock *, struct sockaddr *, int *, int);
  362 int     nfsrv_setpublicfs(struct mount *, struct netexport *,
  363             struct export_args *);
  364 int     nfs_ispublicfh(fhandle_t *);
  365 int     nfsrv_fsinfo(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  366             struct thread *td, struct mbuf **mrq);
  367 int     nfsrv_getattr(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  368             struct thread *td, struct mbuf **mrq);
  369 int     nfsrv_link(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  370             struct thread *td, struct mbuf **mrq);
  371 int     nfsrv_lookup(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  372             struct thread *td, struct mbuf **mrq);
  373 int     nfsrv_mkdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  374             struct thread *td, struct mbuf **mrq);
  375 int     nfsrv_mknod(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  376             struct thread *td, struct mbuf **mrq);
  377 int     nfsrv_noop(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  378             struct thread *td, struct mbuf **mrq);
  379 int     nfsrv_null(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  380             struct thread *td, struct mbuf **mrq);
  381 int     nfsrv_pathconf(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  382             struct thread *td, struct mbuf **mrq);
  383 int     nfsrv_read(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  384             struct thread *td, struct mbuf **mrq);
  385 int     nfsrv_readdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  386             struct thread *td, struct mbuf **mrq);
  387 int     nfsrv_readdirplus(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  388             struct thread *td, struct mbuf **mrq);
  389 int     nfsrv_readlink(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  390             struct thread *td, struct mbuf **mrq);
  391 int     nfsrv_remove(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  392             struct thread *td, struct mbuf **mrq);
  393 int     nfsrv_rename(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  394             struct thread *td, struct mbuf **mrq);
  395 int     nfsrv_rmdir(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  396             struct thread *td, struct mbuf **mrq);
  397 int     nfsrv_setattr(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  398             struct thread *td, struct mbuf **mrq);
  399 int     nfsrv_statfs(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  400             struct thread *td, struct mbuf **mrq);
  401 int     nfsrv_symlink(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  402             struct thread *td, struct mbuf **mrq);
  403 int     nfsrv_write(struct nfsrv_descript *nfsd, struct nfssvc_sock *slp,
  404             struct thread *td, struct mbuf **mrq);
  405 void    nfsrv_rcv(struct socket *so, void *arg, int waitflag);
  406 void    nfsrv_slpderef(struct nfssvc_sock *slp);
  407 #endif  /* _KERNEL */
  408 
  409 #endif

Cache object: 17a356bb39f04df64a71a85190d34a7b


[ 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.