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