sys/nfsclient/nfs.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993, 1995
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Rick Macklem at The University of Guelph.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)nfs.h       8.4 (Berkeley) 5/1/95
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _NFSCLIENT_NFS_H_
  39 #define _NFSCLIENT_NFS_H_
  40
  41 #ifdef _KERNEL
  42 #include "opt_nfs.h"
  43 #endif
  44
  45 #include <nfsclient/nfsargs.h>
  46
  47 /*
  48  * Tunable constants for nfs
  49  */
  50
  51 #define NFS_TICKINTVL   10              /* Desired time for a tick (msec) */
  52 #define NFS_HZ          (hz / nfs_ticks) /* Ticks/sec */
  53 #define NFS_TIMEO       (1 * NFS_HZ)    /* Default timeout = 1 second */
  54 #define NFS_MINTIMEO    (1 * NFS_HZ)    /* Min timeout to use */
  55 #define NFS_MAXTIMEO    (60 * NFS_HZ)   /* Max timeout to backoff to */
  56 #define NFS_MINIDEMTIMEO (5 * NFS_HZ)   /* Min timeout for non-idempotent ops*/
  57 #define NFS_MAXREXMIT   100             /* Stop counting after this many */
  58 #define NFS_RETRANS     10              /* Num of retrans for UDP soft mounts */
  59 #define NFS_RETRANS_TCP 2               /* Num of retrans for TCP soft mounts */
  60 #define NFS_MAXGRPS     16              /* Max. size of groups list */
  61 #ifndef NFS_MINATTRTIMO
  62 #define NFS_MINATTRTIMO 3               /* VREG attrib cache timeout in sec */
  63 #endif
  64 #ifndef NFS_MAXATTRTIMO
  65 #define NFS_MAXATTRTIMO 60
  66 #endif
  67 #ifndef NFS_MINDIRATTRTIMO
  68 #define NFS_MINDIRATTRTIMO 3            /* VDIR attrib cache timeout in sec */
  69 #endif
  70 #ifndef NFS_MAXDIRATTRTIMO
  71 #define NFS_MAXDIRATTRTIMO 60
  72 #endif
  73 #ifndef NFS_ACCESSCACHESIZE
  74 #define NFS_ACCESSCACHESIZE 8           /* Per-node access cache entries */
  75 #endif
  76 #define NFS_WSIZE       8192            /* Def. write data size <= 8192 */
  77 #define NFS_RSIZE       8192            /* Def. read data size <= 8192 */
  78 #define NFS_READDIRSIZE 8192            /* Def. readdir size */
  79 #define NFS_DEFRAHEAD   1               /* Def. read ahead # blocks */
  80 #define NFS_MAXRAHEAD   4               /* Max. read ahead # blocks */
  81 #define NFS_MAXASYNCDAEMON      64      /* Max. number async_daemons runnable */
  82 #define NFS_DIRBLKSIZ   4096            /* Must be a multiple of DIRBLKSIZ */
  83 #ifdef _KERNEL
  84 #define DIRBLKSIZ       512             /* XXX we used to use ufs's DIRBLKSIZ */
  85 #endif
  86 #define NFS_MAXDEADTHRESH       9       /* How long till we say 'server not responding' */
  87
  88 /*
  89  * Oddballs
  90  */
  91 #define NFS_CMPFH(n, f, s) \
  92         ((n)->n_fhsize == (s) && !bcmp((caddr_t)(n)->n_fhp, (caddr_t)(f), (s)))
  93 #define NFS_ISV3(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV3)
  94 #define NFS_ISV4(v)     (VFSTONFS((v)->v_mount)->nm_flag & NFSMNT_NFSV4)
  95
  96 #define NFSSTA_HASWRITEVERF     0x00040000  /* Has write verifier for V3 */
  97 #define NFSSTA_GOTFSINFO        0x00100000  /* Got the V3 fsinfo */
  98 #define NFSSTA_SNDLOCK          0x01000000  /* Send socket lock */
  99 #define NFSSTA_WANTSND          0x02000000  /* Want above */
 100 #define NFSSTA_TIMEO            0x10000000  /* Experiencing a timeout */
 101 #define NFSSTA_LOCKTIMEO        0x20000000  /* Experiencing a lockd timeout */
 102
 103
 104 /*
 105  * XXX to allow amd to include nfs.h without nfsproto.h
 106  */
 107 #ifdef NFS_NPROCS
 108 #include <nfsclient/nfsstats.h>
 109 #endif
 110
 111 /*
 112  * vfs.oldnfs sysctl(3) identifiers
 113  */
 114 #define NFS_NFSSTATS    1               /* struct: struct nfsstats */
 115
 116 #ifdef _KERNEL
 117
 118 #ifdef MALLOC_DECLARE
 119 MALLOC_DECLARE(M_NFSDIROFF);
 120 MALLOC_DECLARE(M_NFSDIRECTIO);
 121 #endif
 122
 123 extern struct uma_zone *nfsmount_zone;
 124
 125 extern struct nfsstats nfsstats;
 126 extern struct mtx nfs_iod_mtx;
 127 extern struct task nfs_nfsiodnew_task;
 128
 129 extern int nfs_numasync;
 130 extern unsigned int nfs_iodmax;
 131 extern int nfs_pbuf_freecnt;
 132 extern int nfs_ticks;
 133
 134 /* Data constants in XDR form */
 135 extern u_int32_t nfs_true, nfs_false, nfs_xdrneg1;
 136 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers;
 137 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr;
 138
 139 extern int nfsv3_procid[NFS_NPROCS];
 140
 141 /*
 142  * Socket errors ignored for connectionless sockets??
 143  * For now, ignore them all
 144  */
 145 #define NFSIGNORE_SOERROR(s, e) \
 146                 ((e) != EINTR && (e) != EIO && \
 147                 (e) != ERESTART && (e) != EWOULDBLOCK && \
 148                 ((s) & PR_CONNREQUIRED) == 0)
 149
 150 struct nfsmount;
 151
 152 struct buf;
 153 struct socket;
 154 struct uio;
 155 struct vattr;
 156
 157 /*
 158  * Pointers to ops that differ from v3 to v4
 159  */
 160 struct nfs_rpcops {
 161         int     (*nr_readrpc)(struct vnode *vp, struct uio *uiop,
 162                     struct ucred *cred);
 163         int     (*nr_writerpc)(struct vnode *vp, struct uio *uiop,
 164                     struct ucred *cred, int *iomode, int *must_commit);
 165         int     (*nr_writebp)(struct buf *bp, int force, struct thread *td);
 166         int     (*nr_readlinkrpc)(struct vnode *vp, struct uio *uiop,
 167                     struct ucred *cred);
 168         void    (*nr_invaldir)(struct vnode *vp);
 169         int     (*nr_commit)(struct vnode *vp, u_quad_t offset, int cnt,
 170                     struct ucred *cred, struct thread *td);
 171 };
 172
 173 /*
 174  * Defines for WebNFS
 175  */
 176
 177 #define WEBNFS_ESC_CHAR         '%'
 178 #define WEBNFS_SPECCHAR_START   0x80
 179
 180 #define WEBNFS_NATIVE_CHAR      0x80
 181 /*
 182  * ..
 183  * Possibly more here in the future.
 184  */
 185
 186 /*
 187  * Macro for converting escape characters in WebNFS pathnames.
 188  * Should really be in libkern.
 189  */
 190
 191 #define HEXTOC(c) \
 192         ((c) >= 'a' ? ((c) - ('a' - 10)) : \
 193             ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
 194 #define HEXSTRTOI(p) \
 195         ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
 196
 197 /* nfs_sigintr() helper, when 'rep' has all we need */
 198 #define NFS_SIGREP(rep)         nfs_sigintr((rep)->r_nmp, (rep), (rep)->r_td)
 199
 200 #ifdef NFS_DEBUG
 201
 202 extern int nfs_debug;
 203 #define NFS_DEBUG_ASYNCIO       1 /* asynchronous i/o */
 204 #define NFS_DEBUG_WG            2 /* server write gathering */
 205 #define NFS_DEBUG_RC            4 /* server request caching */
 206
 207 #define NFS_DPF(cat, args)                                      \
 208         do {                                                    \
 209                 if (nfs_debug & NFS_DEBUG_##cat) printf args;   \
 210         } while (0)
 211
 212 #else
 213
 214 #define NFS_DPF(cat, args)
 215
 216 #endif
 217
 218 /*
 219  * On fast networks, the estimator will try to reduce the
 220  * timeout lower than the latency of the server's disks,
 221  * which results in too many timeouts, so cap the lower
 222  * bound.
 223  */
 224 #define NFS_MINRTO      (NFS_HZ >> 2)
 225
 226 /*
 227  * Keep the RTO from increasing to unreasonably large values
 228  * when a server is not responding.
 229  */
 230 #define NFS_MAXRTO      (20 * NFS_HZ)
 231
 232 enum nfs_rto_timer_t {
 233         NFS_DEFAULT_TIMER,
 234         NFS_GETATTR_TIMER,
 235         NFS_LOOKUP_TIMER,
 236         NFS_READ_TIMER,
 237         NFS_WRITE_TIMER,
 238 };
 239 #define NFS_MAX_TIMER   (NFS_WRITE_TIMER)
 240
 241 #define NFS_INITRTT     (NFS_HZ << 3)
 242
 243 vfs_init_t nfs_init;
 244 vfs_uninit_t nfs_uninit;
 245 int     nfs_mountroot(struct mount *mp);
 246
 247 void    nfs_purgecache(struct vnode *);
 248 int     nfs_vinvalbuf(struct vnode *, int, struct thread *, int);
 249 int     nfs_readrpc(struct vnode *, struct uio *, struct ucred *);
 250 int     nfs_writerpc(struct vnode *, struct uio *, struct ucred *, int *,
 251             int *);
 252 int     nfs_commit(struct vnode *vp, u_quad_t offset, int cnt,
 253             struct ucred *cred, struct thread *td);
 254 int     nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *);
 255 void    nfs_nfsiodnew(void);
 256 void    nfs_nfsiodnew_tq(__unused void *, int);
 257 int     nfs_asyncio(struct nfsmount *, struct buf *, struct ucred *, struct thread *);
 258 int     nfs_doio(struct vnode *, struct buf *, struct ucred *, struct thread *);
 259 void    nfs_doio_directwrite (struct buf *);
 260 int     nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *);
 261 int     nfs_sigintr(struct nfsmount *, struct thread *);
 262 int     nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *);
 263 int     nfs_request(struct vnode *, struct mbuf *, int, struct thread *,
 264             struct ucred *, struct mbuf **, struct mbuf **, caddr_t *);
 265 int     nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *,
 266             struct vattr *, int);
 267 int     nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
 268 void    nfs_nhinit(void);
 269 void    nfs_nhuninit(void);
 270 int     nfs_nmcancelreqs(struct nfsmount *);
 271 void    nfs_timer(void*);
 272
 273 int     nfs_connect(struct nfsmount *);
 274 void    nfs_disconnect(struct nfsmount *);
 275 void    nfs_safedisconnect(struct nfsmount *);
 276 int     nfs_getattrcache(struct vnode *, struct vattr *);
 277 int     nfs_iosize(struct nfsmount *nmp);
 278 int     nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
 279 int     nfs_bioread(struct vnode *, struct uio *, int, struct ucred *);
 280 int     nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *);
 281 void    nfs_clearcommit(struct mount *);
 282 int     nfs_writebp(struct buf *, int, struct thread *);
 283 int     nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *,
 284             struct thread *);
 285 int     nfs_meta_setsize (struct vnode *, struct ucred *,
 286             struct thread *, u_quad_t);
 287
 288 void    nfs_set_sigmask(struct thread *td, sigset_t *oldset);
 289 void    nfs_restore_sigmask(struct thread *td, sigset_t *set);
 290 int     nfs_msleep(struct thread *td, void *ident, struct mtx *mtx,
 291             int priority, char *wmesg, int timo);
 292
 293 #endif  /* _KERNEL */
 294
 295 #endif