sys/nfsclient/nfs.h

   1 /*-
   2  * Copyright (c) 1989, 1993, 1995
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Rick Macklem at The University of Guelph.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 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 _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 UDP soft mounts */
  57 #define NFS_RETRANS_TCP 2               /* Num of retrans for TCP soft mounts */
  58 #define NFS_MAXGRPS     16              /* Max. size of groups list */
  59 #ifndef NFS_MINATTRTIMO
  60 #define NFS_MINATTRTIMO 3               /* VREG attrib cache timeout in sec */
  61 #endif
  62 #ifndef NFS_MAXATTRTIMO
  63 #define NFS_MAXATTRTIMO 60
  64 #endif
  65 #ifndef NFS_MINDIRATTRTIMO
  66 #define NFS_MINDIRATTRTIMO 30           /* VDIR attrib cache timeout in sec */
  67 #endif
  68 #ifndef NFS_MAXDIRATTRTIMO
  69 #define NFS_MAXDIRATTRTIMO 60
  70 #endif
  71 #define NFS_WSIZE       8192            /* Def. write data size <= 8192 */
  72 #define NFS_RSIZE       8192            /* Def. read data size <= 8192 */
  73 #define NFS_READDIRSIZE 8192            /* Def. readdir size */
  74 #define NFS_DEFRAHEAD   1               /* Def. read ahead # blocks */
  75 #define NFS_MAXRAHEAD   4               /* Max. read ahead # blocks */
  76 #define NFS_MAXASYNCDAEMON      64      /* Max. number async_daemons runnable */
  77 #define NFS_DIRBLKSIZ   4096            /* Must be a multiple of DIRBLKSIZ */
  78 #ifdef _KERNEL
  79 #define DIRBLKSIZ       512             /* XXX we used to use ufs's DIRBLKSIZ */
  80 #endif
  81 #define NFS_MAXDEADTHRESH       9       /* How long till we say 'server not responding' */
  82
  83 /*
  84  * Oddballs
  85  */
  86 #define NFS_CMPFH(n, f, s) \
  87         ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
  88 #define NFS_ISV3(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
  89 #define NFS_ISV4(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV4)
  90
  91 #define NFSSTA_HASWRITEVERF     0x00040000  /* Has write verifier for V3 */
  92 #define NFSSTA_GOTFSINFO        0x00100000  /* Got the V3 fsinfo */
  93 #define NFSSTA_SNDLOCK          0x01000000  /* Send socket lock */
  94 #define NFSSTA_WANTSND          0x02000000  /* Want above */
  95 #define NFSSTA_TIMEO            0x10000000  /* Experiencing a timeout */
  96 #define NFSSTA_LOCKTIMEO        0x20000000  /* Experiencing a lockd timeout */
  97
  98
  99 /*
 100  * XXX to allow amd to include nfs.h without nfsproto.h
 101  */
 102 #ifdef NFS_NPROCS
 103 #include <nfsclient/nfsstats.h>
 104 #endif
 105
 106 /*
 107  * vfs.nfs sysctl(3) identifiers
 108  */
 109 #define NFS_NFSSTATS    1               /* struct: struct nfsstats */
 110
 111 /*
 112  * File context information for nfsv4.  Currently, there is only one
 113  * lockowner for the whole machine "0."
 114  */
 115 struct nfs4_fctx {
 116         TAILQ_ENTRY(nfs4_fstate) next;
 117         uint32_t        refcnt;
 118         struct nfs4_lowner *lop;
 119         struct nfsnode *np;
 120         char            stateid[NFSX_V4STATEID];
 121 };
 122
 123 #ifdef _KERNEL
 124
 125 #ifdef MALLOC_DECLARE
 126 MALLOC_DECLARE(M_NFSREQ);
 127 MALLOC_DECLARE(M_NFSDIROFF);
 128 MALLOC_DECLARE(M_NFSBIGFH);
 129 MALLOC_DECLARE(M_NFSHASH);
 130 MALLOC_DECLARE(M_NFSDIRECTIO);
 131 #endif
 132
 133 extern struct uma_zone *nfsmount_zone;
 134
 135 extern struct callout nfs_callout;
 136 extern struct nfsstats nfsstats;
 137 extern struct mtx nfs_iod_mtx;
 138
 139 extern int nfs_numasync;
 140 extern unsigned int nfs_iodmax;
 141 extern int nfs_pbuf_freecnt;
 142 extern int nfs_ticks;
 143
 144 /* Data constants in XDR form */
 145 extern u_int32_t nfs_true, nfs_false, nfs_xdrneg1;
 146 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers;
 147 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr;
 148
 149 extern int nfsv3_procid[NFS_NPROCS];
 150
 151 /*
 152  * Socket errors ignored for connectionless sockets??
 153  * For now, ignore them all
 154  */
 155 #define NFSIGNORE_SOERROR(s, e) \
 156                 ((e) != EINTR && (e) != EIO && \
 157                 (e) != ERESTART && (e) != EWOULDBLOCK && \
 158                 ((s) & PR_CONNREQUIRED) == 0)
 159
 160 /*
 161  * Nfs outstanding request list element
 162  */
 163 struct nfsreq {
 164         TAILQ_ENTRY(nfsreq) r_chain;
 165         struct mbuf     *r_mreq;
 166         struct mbuf     *r_mrep;
 167         struct mbuf     *r_md;
 168         caddr_t         r_dpos;
 169         struct nfsmount *r_nmp;
 170         struct vnode    *r_vp;
 171         u_int32_t       r_xid;
 172         int             r_flags;        /* flags on request, see below */
 173         int             r_retry;        /* max retransmission count */
 174         int             r_rexmit;       /* current retrans count */
 175         int             r_timer;        /* tick counter on reply */
 176         u_int32_t       r_procnum;      /* NFS procedure number */
 177         int             r_rtt;          /* RTT for rpc */
 178         int             r_lastmsg;      /* last tprintf */
 179         struct thread   *r_td;          /* Proc that did I/O system call */
 180         struct mtx      r_mtx;          /* Protects nfsreq fields */
 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 #define R_PIN_REQ       0x100           /* Pin request down (rexmit in prog or other) */
 198
 199 struct buf;
 200 struct socket;
 201 struct uio;
 202 struct vattr;
 203
 204 /*
 205  * Pointers to ops that differ from v3 to v4
 206  */
 207 struct nfs_rpcops {
 208         int     (*nr_readrpc)(struct vnode *vp, struct uio *uiop,
 209                     struct ucred *cred);
 210         int     (*nr_writerpc)(struct vnode *vp, struct uio *uiop,
 211                     struct ucred *cred, int *iomode, int *must_commit);
 212         int     (*nr_writebp)(struct buf *bp, int force, struct thread *td);
 213         int     (*nr_readlinkrpc)(struct vnode *vp, struct uio *uiop,
 214                     struct ucred *cred);
 215         void    (*nr_invaldir)(struct vnode *vp);
 216         int     (*nr_commit)(struct vnode *vp, u_quad_t offset, int cnt,
 217                     struct ucred *cred, struct thread *td);
 218 };
 219
 220 /*
 221  * Defines for WebNFS
 222  */
 223
 224 #define WEBNFS_ESC_CHAR         '%'
 225 #define WEBNFS_SPECCHAR_START   0x80
 226
 227 #define WEBNFS_NATIVE_CHAR      0x80
 228 /*
 229  * ..
 230  * Possibly more here in the future.
 231  */
 232
 233 /*
 234  * Macro for converting escape characters in WebNFS pathnames.
 235  * Should really be in libkern.
 236  */
 237
 238 #define HEXTOC(c) \
 239         ((c) >= 'a' ? ((c) - ('a' - 10)) : \
 240             ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
 241 #define HEXSTRTOI(p) \
 242         ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
 243
 244 /* nfs_sigintr() helper, when 'rep' has all we need */
 245 #define NFS_SIGREP(rep)         nfs_sigintr((rep)->r_nmp, (rep), (rep)->r_td)
 246
 247 #ifdef NFS_DEBUG
 248
 249 extern int nfs_debug;
 250 #define NFS_DEBUG_ASYNCIO       1 /* asynchronous i/o */
 251 #define NFS_DEBUG_WG            2 /* server write gathering */
 252 #define NFS_DEBUG_RC            4 /* server request caching */
 253
 254 #define NFS_DPF(cat, args)                                      \
 255         do {                                                    \
 256                 if (nfs_debug & NFS_DEBUG_##cat) printf args;   \
 257         } while (0)
 258
 259 #else
 260
 261 #define NFS_DPF(cat, args)
 262
 263 #endif
 264
 265 /*
 266  * On fast networks, the estimator will try to reduce the
 267  * timeout lower than the latency of the server's disks,
 268  * which results in too many timeouts, so cap the lower
 269  * bound.
 270  */
 271 #define NFS_MINRTO      (NFS_HZ >> 2)
 272
 273 /*
 274  * Keep the RTO from increasing to unreasonably large values
 275  * when a server is not responding.
 276  */
 277 #define NFS_MAXRTO      (20 * NFS_HZ)
 278
 279 enum nfs_rto_timer_t {
 280         NFS_DEFAULT_TIMER,
 281         NFS_GETATTR_TIMER,
 282         NFS_LOOKUP_TIMER,
 283         NFS_READ_TIMER,
 284         NFS_WRITE_TIMER,
 285 };
 286 #define NFS_MAX_TIMER   (NFS_WRITE_TIMER)
 287
 288 #define NFS_INITRTT     (NFS_HZ << 3)
 289
 290 vfs_init_t nfs_init;
 291 vfs_uninit_t nfs_uninit;
 292 int     nfs_mountroot(struct mount *mp, struct thread *td);
 293
 294 #ifndef NFS4_USE_RPCCLNT
 295 int     nfs_send(struct socket *, struct sockaddr *, struct mbuf *,
 296             struct nfsreq *);
 297 int     nfs_connect_lock(struct nfsreq *);
 298 void    nfs_connect_unlock(struct nfsreq *);
 299 #endif /* ! NFS4_USE_RPCCLNT */
 300
 301 int     nfs_vinvalbuf(struct vnode *, int, struct thread *, int);
 302 int     nfs_readrpc(struct vnode *, struct uio *, struct ucred *);
 303 int     nfs_writerpc(struct vnode *, struct uio *, struct ucred *, int *,
 304             int *);
 305 int     nfs_commit(struct vnode *vp, u_quad_t offset, int cnt,
 306             struct ucred *cred, struct thread *td);
 307 int     nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *);
 308 int     nfs_nfsiodnew(void);
 309 int     nfs_asyncio(struct nfsmount *, struct buf *, struct ucred *, struct thread *);
 310 int     nfs_doio(struct vnode *, struct buf *, struct ucred *, struct thread *);
 311 void    nfs_doio_directwrite (struct buf *);
 312 void    nfs_up(struct nfsreq *, struct nfsmount *, struct thread *,
 313             const char *, int);
 314 void    nfs_down(struct nfsreq *, struct nfsmount *, struct thread *,
 315             const char *, int, int);
 316 int     nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *);
 317 int     nfs_sigintr(struct nfsmount *, struct nfsreq *, struct thread *);
 318 int     nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *);
 319 int     nfs_request(struct vnode *, struct mbuf *, int, struct thread *,
 320             struct ucred *, struct mbuf **, struct mbuf **, caddr_t *);
 321 int     nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *,
 322             struct vattr *, int);
 323 int     nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
 324 void    nfs_nhinit(void);
 325 void    nfs_nhuninit(void);
 326 int     nfs_nmcancelreqs(struct nfsmount *);
 327 void    nfs_timer(void*);
 328
 329 int     nfs_connect(struct nfsmount *, struct nfsreq *);
 330 void    nfs_disconnect(struct nfsmount *);
 331 void    nfs_safedisconnect(struct nfsmount *);
 332 int     nfs_getattrcache(struct vnode *, struct vattr *);
 333 int     nfs_iosize(struct nfsmount *nmp);
 334 int     nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
 335 int     nfs_bioread(struct vnode *, struct uio *, int, struct ucred *);
 336 int     nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *);
 337 void    nfs_clearcommit(struct mount *);
 338 int     nfs_writebp(struct buf *, int, struct thread *);
 339 int     nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *,
 340             struct thread *);
 341 int     nfs_meta_setsize (struct vnode *, struct ucred *,
 342             struct thread *, u_quad_t);
 343
 344 void    nfs_set_sigmask(struct thread *td, sigset_t *oldset);
 345 void    nfs_restore_sigmask(struct thread *td, sigset_t *set);
 346 int     nfs_msleep(struct thread *td, void *ident, struct mtx *mtx,
 347             int priority, char *wmesg, int timo);
 348
 349 #endif  /* _KERNEL */
 350
 351 #endif