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 #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 /* 115 * File context information for nfsv4. Currently, there is only one 116 * lockowner for the whole machine "0." 117 */ 118 struct nfs4_fctx { 119 TAILQ_ENTRY(nfs4_fstate) next; 120 uint32_t refcnt; 121 struct nfs4_lowner *lop; 122 struct nfsnode *np; 123 char stateid[NFSX_V4STATEID]; 124 }; 125 126 #ifdef _KERNEL 127 128 #ifdef MALLOC_DECLARE 129 MALLOC_DECLARE(M_NFSREQ); 130 MALLOC_DECLARE(M_NFSDIROFF); 131 MALLOC_DECLARE(M_NFSBIGFH); 132 MALLOC_DECLARE(M_NFSHASH); 133 MALLOC_DECLARE(M_NFSDIRECTIO); 134 #endif 135 136 extern struct uma_zone *nfsmount_zone; 137 138 #ifdef NFS_LEGACYRPC 139 extern struct callout nfs_callout; 140 #endif 141 extern struct nfsstats nfsstats; 142 extern struct mtx nfs_iod_mtx; 143 144 extern int nfs_numasync; 145 extern unsigned int nfs_iodmax; 146 extern int nfs_pbuf_freecnt; 147 extern int nfs_ticks; 148 149 /* Data constants in XDR form */ 150 extern u_int32_t nfs_true, nfs_false, nfs_xdrneg1; 151 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers; 152 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr; 153 154 extern int nfsv3_procid[NFS_NPROCS]; 155 156 /* 157 * Socket errors ignored for connectionless sockets?? 158 * For now, ignore them all 159 */ 160 #define NFSIGNORE_SOERROR(s, e) \ 161 ((e) != EINTR && (e) != EIO && \ 162 (e) != ERESTART && (e) != EWOULDBLOCK && \ 163 ((s) & PR_CONNREQUIRED) == 0) 164 165 #ifdef NFS_LEGACYRPC 166 167 /* 168 * Nfs outstanding request list element 169 */ 170 struct nfsreq { 171 TAILQ_ENTRY(nfsreq) r_chain; 172 struct mbuf *r_mreq; 173 struct mbuf *r_mrep; 174 struct mbuf *r_md; 175 caddr_t r_dpos; 176 struct nfsmount *r_nmp; 177 struct vnode *r_vp; 178 u_int32_t r_xid; 179 int r_flags; /* flags on request, see below */ 180 int r_retry; /* max retransmission count */ 181 int r_rexmit; /* current retrans count */ 182 int r_timer; /* tick counter on reply */ 183 u_int32_t r_procnum; /* NFS procedure number */ 184 int r_rtt; /* RTT for rpc */ 185 int r_lastmsg; /* last tprintf */ 186 struct thread *r_td; /* Proc that did I/O system call */ 187 struct mtx r_mtx; /* Protects nfsreq fields */ 188 }; 189 190 /* 191 * Queue head for nfsreq's 192 */ 193 extern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq; 194 195 /* Flag values for r_flags */ 196 #define R_TIMING 0x01 /* timing request (in mntp) */ 197 #define R_SENT 0x02 /* request has been sent */ 198 #define R_SOFTTERM 0x04 /* soft mnt, too many retries */ 199 #define R_RESENDERR 0x08 /* Resend failed */ 200 #define R_SOCKERR 0x10 /* Fatal error on socket */ 201 #define R_TPRINTFMSG 0x20 /* Did a tprintf msg. */ 202 #define R_MUSTRESEND 0x40 /* Must resend request */ 203 #define R_GETONEREP 0x80 /* Probe for one reply only */ 204 #define R_PIN_REQ 0x100 /* Pin request down (rexmit in prog or other) */ 205 206 #else 207 208 /* 209 * This is only needed to keep things working while we support 210 * compiling for both RPC implementations. 211 */ 212 struct nfsreq; 213 struct nfsmount; 214 215 #endif 216 217 struct buf; 218 struct socket; 219 struct uio; 220 struct vattr; 221 222 /* 223 * Pointers to ops that differ from v3 to v4 224 */ 225 struct nfs_rpcops { 226 int (*nr_readrpc)(struct vnode *vp, struct uio *uiop, 227 struct ucred *cred); 228 int (*nr_writerpc)(struct vnode *vp, struct uio *uiop, 229 struct ucred *cred, int *iomode, int *must_commit); 230 int (*nr_writebp)(struct buf *bp, int force, struct thread *td); 231 int (*nr_readlinkrpc)(struct vnode *vp, struct uio *uiop, 232 struct ucred *cred); 233 void (*nr_invaldir)(struct vnode *vp); 234 int (*nr_commit)(struct vnode *vp, u_quad_t offset, int cnt, 235 struct ucred *cred, struct thread *td); 236 }; 237 238 /* 239 * Defines for WebNFS 240 */ 241 242 #define WEBNFS_ESC_CHAR '%' 243 #define WEBNFS_SPECCHAR_START 0x80 244 245 #define WEBNFS_NATIVE_CHAR 0x80 246 /* 247 * .. 248 * Possibly more here in the future. 249 */ 250 251 /* 252 * Macro for converting escape characters in WebNFS pathnames. 253 * Should really be in libkern. 254 */ 255 256 #define HEXTOC(c) \ 257 ((c) >= 'a' ? ((c) - ('a' - 10)) : \ 258 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0'))) 259 #define HEXSTRTOI(p) \ 260 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1])) 261 262 /* nfs_sigintr() helper, when 'rep' has all we need */ 263 #define NFS_SIGREP(rep) nfs_sigintr((rep)->r_nmp, (rep), (rep)->r_td) 264 265 #ifdef NFS_DEBUG 266 267 extern int nfs_debug; 268 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */ 269 #define NFS_DEBUG_WG 2 /* server write gathering */ 270 #define NFS_DEBUG_RC 4 /* server request caching */ 271 272 #define NFS_DPF(cat, args) \ 273 do { \ 274 if (nfs_debug & NFS_DEBUG_##cat) printf args; \ 275 } while (0) 276 277 #else 278 279 #define NFS_DPF(cat, args) 280 281 #endif 282 283 /* 284 * On fast networks, the estimator will try to reduce the 285 * timeout lower than the latency of the server's disks, 286 * which results in too many timeouts, so cap the lower 287 * bound. 288 */ 289 #define NFS_MINRTO (NFS_HZ >> 2) 290 291 /* 292 * Keep the RTO from increasing to unreasonably large values 293 * when a server is not responding. 294 */ 295 #define NFS_MAXRTO (20 * NFS_HZ) 296 297 enum nfs_rto_timer_t { 298 NFS_DEFAULT_TIMER, 299 NFS_GETATTR_TIMER, 300 NFS_LOOKUP_TIMER, 301 NFS_READ_TIMER, 302 NFS_WRITE_TIMER, 303 }; 304 #define NFS_MAX_TIMER (NFS_WRITE_TIMER) 305 306 #define NFS_INITRTT (NFS_HZ << 3) 307 308 vfs_init_t nfs_init; 309 vfs_uninit_t nfs_uninit; 310 int nfs_mountroot(struct mount *mp, struct thread *td); 311 312 #ifdef NFS_LEGACYRPC 313 #ifndef NFS4_USE_RPCCLNT 314 int nfs_send(struct socket *, struct sockaddr *, struct mbuf *, 315 struct nfsreq *); 316 int nfs_connect_lock(struct nfsreq *); 317 void nfs_connect_unlock(struct nfsreq *); 318 void nfs_up(struct nfsreq *, struct nfsmount *, struct thread *, 319 const char *, int); 320 void nfs_down(struct nfsreq *, struct nfsmount *, struct thread *, 321 const char *, int, int); 322 #endif /* ! NFS4_USE_RPCCLNT */ 323 #endif 324 325 int nfs_vinvalbuf(struct vnode *, int, struct thread *, int); 326 int nfs_readrpc(struct vnode *, struct uio *, struct ucred *); 327 int nfs_writerpc(struct vnode *, struct uio *, struct ucred *, int *, 328 int *); 329 int nfs_commit(struct vnode *vp, u_quad_t offset, int cnt, 330 struct ucred *cred, struct thread *td); 331 int nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *); 332 int nfs_nfsiodnew(void); 333 int nfs_asyncio(struct nfsmount *, struct buf *, struct ucred *, struct thread *); 334 int nfs_doio(struct vnode *, struct buf *, struct ucred *, struct thread *); 335 void nfs_doio_directwrite (struct buf *); 336 int nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *); 337 int nfs_sigintr(struct nfsmount *, struct nfsreq *, struct thread *); 338 int nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *); 339 int nfs_request(struct vnode *, struct mbuf *, int, struct thread *, 340 struct ucred *, struct mbuf **, struct mbuf **, caddr_t *); 341 int nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *, 342 struct vattr *, int); 343 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *); 344 void nfs_nhinit(void); 345 void nfs_nhuninit(void); 346 int nfs_nmcancelreqs(struct nfsmount *); 347 void nfs_timer(void*); 348 349 int nfs_connect(struct nfsmount *, struct nfsreq *); 350 void nfs_disconnect(struct nfsmount *); 351 void nfs_safedisconnect(struct nfsmount *); 352 int nfs_getattrcache(struct vnode *, struct vattr *); 353 int nfs_iosize(struct nfsmount *nmp); 354 int nfsm_strtmbuf(struct mbuf **, char **, const char *, long); 355 int nfs_bioread(struct vnode *, struct uio *, int, struct ucred *); 356 int nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *); 357 void nfs_clearcommit(struct mount *); 358 int nfs_writebp(struct buf *, int, struct thread *); 359 int nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *, 360 struct thread *); 361 int nfs_meta_setsize (struct vnode *, struct ucred *, 362 struct thread *, u_quad_t); 363 364 void nfs_set_sigmask(struct thread *td, sigset_t *oldset); 365 void nfs_restore_sigmask(struct thread *td, sigset_t *set); 366 int nfs_msleep(struct thread *td, void *ident, struct mtx *mtx, 367 int priority, char *wmesg, int timo); 368 369 #endif /* _KERNEL */ 370 371 #endif 372