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/nfsclient/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: releng/6.0/sys/nfsclient/nfs.h 140731 2005-01-24 12:31:06Z phk $
   34  */
   35 
   36 #ifndef _NFSCLIENT_NFS_H_
   37 #define _NFSCLIENT_NFS_H_
   38 
   39 #ifdef _KERNEL
   40 #include "opt_nfs.h"
   41 #endif
   42 
   43 #include <nfsclient/nfsargs.h>
   44 
   45 /*
   46  * Tunable constants for nfs
   47  */
   48 
   49 #define NFS_TICKINTVL   10              /* Desired time for a tick (msec) */
   50 #define NFS_HZ          (hz / nfs_ticks) /* Ticks/sec */
   51 #define NFS_TIMEO       (1 * NFS_HZ)    /* Default timeout = 1 second */
   52 #define NFS_MINTIMEO    (1 * NFS_HZ)    /* Min timeout to use */
   53 #define NFS_MAXTIMEO    (60 * NFS_HZ)   /* Max timeout to backoff to */
   54 #define NFS_MINIDEMTIMEO (5 * NFS_HZ)   /* Min timeout for non-idempotent ops*/
   55 #define NFS_MAXREXMIT   100             /* Stop counting after this many */
   56 #define NFS_RETRANS     10              /* Num of retrans for soft mounts */
   57 #define NFS_MAXGRPS     16              /* Max. size of groups list */
   58 #ifndef NFS_MINATTRTIMO
   59 #define NFS_MINATTRTIMO 3               /* VREG attrib cache timeout in sec */
   60 #endif
   61 #ifndef NFS_MAXATTRTIMO
   62 #define NFS_MAXATTRTIMO 60
   63 #endif
   64 #ifndef NFS_MINDIRATTRTIMO
   65 #define NFS_MINDIRATTRTIMO 30           /* VDIR attrib cache timeout in sec */
   66 #endif
   67 #ifndef NFS_MAXDIRATTRTIMO
   68 #define NFS_MAXDIRATTRTIMO 60
   69 #endif
   70 #define NFS_WSIZE       8192            /* Def. write data size <= 8192 */
   71 #define NFS_RSIZE       8192            /* Def. read data size <= 8192 */
   72 #define NFS_READDIRSIZE 8192            /* Def. readdir size */
   73 #define NFS_DEFRAHEAD   1               /* Def. read ahead # blocks */
   74 #define NFS_MAXRAHEAD   4               /* Max. read ahead # blocks */
   75 #define NFS_MAXASYNCDAEMON      64      /* Max. number async_daemons runnable */
   76 #define NFS_DIRBLKSIZ   4096            /* Must be a multiple of DIRBLKSIZ */
   77 #ifdef _KERNEL
   78 #define DIRBLKSIZ       512             /* XXX we used to use ufs's DIRBLKSIZ */
   79 #endif
   80 #define NFS_MAXDEADTHRESH       9       /* How long till we say 'server not responding' */
   81 
   82 /*
   83  * Oddballs
   84  */
   85 #define NFS_CMPFH(n, f, s) \
   86         ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
   87 #define NFS_ISV3(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
   88 
   89 #define NFSSTA_HASWRITEVERF     0x00040000  /* Has write verifier for V3 */
   90 #define NFSSTA_GOTFSINFO        0x00100000  /* Got the V3 fsinfo */
   91 #define NFSSTA_SNDLOCK          0x01000000  /* Send socket lock */
   92 #define NFSSTA_WANTSND          0x02000000  /* Want above */
   93 #define NFSSTA_TIMEO            0x10000000  /* Experiencing a timeout */
   94 
   95 
   96 /*
   97  * XXX to allow amd to include nfs.h without nfsproto.h
   98  */
   99 #ifdef NFS_NPROCS
  100 #include <nfsclient/nfsstats.h>
  101 #endif
  102 
  103 /*
  104  * vfs.nfs sysctl(3) identifiers
  105  */
  106 #define NFS_NFSSTATS    1               /* struct: struct nfsstats */
  107 
  108 /*
  109  * File context information for nfsv4.  Currently, there is only one
  110  * lockowner for the whole machine "0."
  111  */
  112 struct nfs4_fctx {
  113         TAILQ_ENTRY(nfs4_fstate) next;
  114         uint32_t        refcnt;
  115         struct nfs4_lowner *lop;
  116         struct nfsnode *np;
  117         char            stateid[NFSX_V4STATEID];
  118 };
  119 
  120 #ifdef _KERNEL
  121 
  122 #ifdef MALLOC_DECLARE
  123 MALLOC_DECLARE(M_NFSREQ);
  124 MALLOC_DECLARE(M_NFSDIROFF);
  125 MALLOC_DECLARE(M_NFSBIGFH);
  126 MALLOC_DECLARE(M_NFSHASH);
  127 MALLOC_DECLARE(M_NFSDIRECTIO);
  128 #endif
  129 
  130 extern struct uma_zone *nfsmount_zone;
  131 
  132 extern struct callout nfs_callout;
  133 extern struct nfsstats nfsstats;
  134 
  135 extern int nfs_numasync;
  136 extern unsigned int nfs_iodmax;
  137 extern int nfs_pbuf_freecnt;
  138 extern int nfs_ticks;
  139 
  140 /* Data constants in XDR form */
  141 extern u_int32_t nfs_true, nfs_false, nfs_xdrneg1;
  142 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers;
  143 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr;
  144 
  145 extern int nfsv3_procid[NFS_NPROCS];
  146 
  147 struct uio;
  148 struct buf;
  149 struct vattr;
  150 struct nameidata;
  151 
  152 /*
  153  * Socket errors ignored for connectionless sockets??
  154  * For now, ignore them all
  155  */
  156 #define NFSIGNORE_SOERROR(s, e) \
  157                 ((e) != EINTR && (e) != EIO && \
  158                  (e) != ERESTART && (e) != EWOULDBLOCK && \
  159                 ((s) & PR_CONNREQUIRED) == 0)
  160 
  161 /*
  162  * Nfs outstanding request list element
  163  */
  164 struct nfsreq {
  165         TAILQ_ENTRY(nfsreq) r_chain;
  166         struct mbuf     *r_mreq;
  167         struct mbuf     *r_mrep;
  168         struct mbuf     *r_md;
  169         caddr_t         r_dpos;
  170         struct nfsmount *r_nmp;
  171         struct vnode    *r_vp;
  172         u_int32_t       r_xid;
  173         int             r_flags;        /* flags on request, see below */
  174         int             r_retry;        /* max retransmission count */
  175         int             r_rexmit;       /* current retrans count */
  176         int             r_timer;        /* tick counter on reply */
  177         u_int32_t       r_procnum;      /* NFS procedure number */
  178         int             r_rtt;          /* RTT for rpc */
  179         int             r_lastmsg;      /* last tprintf */
  180         struct thread   *r_td;          /* Proc that did I/O system call */
  181 };
  182 
  183 /*
  184  * Queue head for nfsreq's
  185  */
  186 extern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq;
  187 
  188 /* Flag values for r_flags */
  189 #define R_TIMING        0x01            /* timing request (in mntp) */
  190 #define R_SENT          0x02            /* request has been sent */
  191 #define R_SOFTTERM      0x04            /* soft mnt, too many retries */
  192 #define R_RESENDERR     0x08            /* Resend failed */
  193 #define R_SOCKERR       0x10            /* Fatal error on socket */
  194 #define R_TPRINTFMSG    0x20            /* Did a tprintf msg. */
  195 #define R_MUSTRESEND    0x40            /* Must resend request */
  196 #define R_GETONEREP     0x80            /* Probe for one reply only */
  197 
  198 /*
  199  * Pointers to ops that differ from v3 to v4
  200  */
  201 struct nfs_rpcops {
  202         int     (*nr_readrpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred);
  203         int     (*nr_writerpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred,
  204                                int *iomode, int *must_commit);
  205         int     (*nr_writebp)(struct buf *bp, int force, struct thread *td);
  206         int     (*nr_readlinkrpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred);
  207         void    (*nr_invaldir)(struct vnode *vp);
  208         int     (*nr_commit)(struct vnode *vp, u_quad_t offset, int cnt,
  209                              struct ucred *cred, struct thread *td);
  210 };
  211 
  212 /*
  213  * Defines for WebNFS
  214  */
  215 
  216 #define WEBNFS_ESC_CHAR         '%'
  217 #define WEBNFS_SPECCHAR_START   0x80
  218 
  219 #define WEBNFS_NATIVE_CHAR      0x80
  220 /*
  221  * ..
  222  * Possibly more here in the future.
  223  */
  224 
  225 /*
  226  * Macro for converting escape characters in WebNFS pathnames.
  227  * Should really be in libkern.
  228  */
  229 
  230 #define HEXTOC(c) \
  231         ((c) >= 'a' ? ((c) - ('a' - 10)) : \
  232             ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '')))
  233 #define HEXSTRTOI(p) \
  234         ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
  235 
  236 /* nfs_sigintr() helper, when 'rep' has all we need */
  237 #define NFS_SIGREP(rep)         nfs_sigintr((rep)->r_nmp, (rep), (rep)->r_td)
  238 
  239 #ifdef NFS_DEBUG
  240 
  241 extern int nfs_debug;
  242 #define NFS_DEBUG_ASYNCIO       1 /* asynchronous i/o */
  243 #define NFS_DEBUG_WG            2 /* server write gathering */
  244 #define NFS_DEBUG_RC            4 /* server request caching */
  245 
  246 #define NFS_DPF(cat, args)                                      \
  247         do {                                                    \
  248                 if (nfs_debug & NFS_DEBUG_##cat) printf args;   \
  249         } while (0)
  250 
  251 #else
  252 
  253 #define NFS_DPF(cat, args)
  254 
  255 #endif
  256 
  257 vfs_init_t nfs_init;
  258 vfs_uninit_t nfs_uninit;
  259 int     nfs_mountroot(struct mount *mp, struct thread *td);
  260 
  261 #ifndef NFS4_USE_RPCCLNT
  262 int     nfs_send(struct socket *, struct sockaddr *, struct mbuf *,
  263             struct nfsreq *);
  264 int     nfs_sndlock(struct nfsreq *);
  265 void    nfs_sndunlock(struct nfsreq *);
  266 #endif /* ! NFS4_USE_RPCCLNT */
  267 
  268 int     nfs_vinvalbuf(struct vnode *, int, struct thread *, int);
  269 int     nfs_readrpc(struct vnode *, struct uio *, struct ucred *);
  270 int     nfs_writerpc(struct vnode *, struct uio *, struct ucred *, int *,
  271             int *);
  272 int     nfs_commit(struct vnode *vp, u_quad_t offset, int cnt,
  273             struct ucred *cred, struct thread *td);
  274 int     nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *);
  275 int     nfs_nfsiodnew(void);
  276 int     nfs_asyncio(struct nfsmount *, struct buf *, struct ucred *, struct thread *);
  277 int     nfs_doio(struct vnode *, struct buf *, struct ucred *, struct thread *);
  278 void    nfs_doio_directwrite (struct buf *);
  279 void    nfs_up(struct nfsreq *, struct nfsmount *, struct thread *,
  280             const char *, int);
  281 void    nfs_down(struct nfsreq *, struct nfsmount *, struct thread *,
  282             const char *, int, int);
  283 int     nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *);
  284 int     nfs_sigintr(struct nfsmount *, struct nfsreq *, struct thread *);
  285 int     nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *);
  286 int     nfs_request(struct vnode *, struct mbuf *, int, struct thread *,
  287             struct ucred *, struct mbuf **, struct mbuf **, caddr_t *);
  288 int     nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *,
  289             struct vattr *, int);
  290 int     nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
  291 void    nfs_nhinit(void);
  292 void    nfs_nhuninit(void);
  293 int     nfs_nmcancelreqs(struct nfsmount *);
  294 void    nfs_timer(void*);
  295 
  296 int     nfs_connect(struct nfsmount *, struct nfsreq *);
  297 void    nfs_disconnect(struct nfsmount *);
  298 void    nfs_safedisconnect(struct nfsmount *);
  299 int     nfs_getattrcache(struct vnode *, struct vattr *);
  300 int     nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
  301 int     nfs_bioread(struct vnode *, struct uio *, int, struct ucred *);
  302 int     nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *);
  303 void    nfs_clearcommit(struct mount *);
  304 int     nfs_writebp(struct buf *, int, struct thread *);
  305 int     nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *,
  306             struct thread *);
  307 int     nfs_meta_setsize (struct vnode *, struct ucred *,
  308             struct thread *, u_quad_t);
  309 
  310 void    nfs_set_sigmask __P((struct thread *td, sigset_t *oldset));
  311 void    nfs_restore_sigmask __P((struct thread *td, sigset_t *set));
  312 int     nfs_tsleep __P((struct thread *td, void *ident, int priority, char *wmesg, 
  313                         int timo));
  314 int     nfs_msleep __P((struct thread *td, void *ident, struct mtx *mtx, int priority, 
  315                         char *wmesg, int timo));
  316 
  317 #endif  /* _KERNEL */
  318 
  319 #endif

Cache object: 87305e6dc8910740634a006cdafc3cd6


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