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 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 extern struct mtx nfs_iod_mtx; 135 136 extern int nfs_numasync; 137 extern unsigned int nfs_iodmax; 138 extern int nfs_pbuf_freecnt; 139 extern int nfs_ticks; 140 141 /* Data constants in XDR form */ 142 extern u_int32_t nfs_true, nfs_false, nfs_xdrneg1; 143 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers; 144 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr; 145 146 extern int nfsv3_procid[NFS_NPROCS]; 147 148 struct uio; 149 struct buf; 150 struct vattr; 151 struct nameidata; 152 153 /* 154 * Socket errors ignored for connectionless sockets?? 155 * For now, ignore them all 156 */ 157 #define NFSIGNORE_SOERROR(s, e) \ 158 ((e) != EINTR && (e) != EIO && \ 159 (e) != ERESTART && (e) != EWOULDBLOCK && \ 160 ((s) & PR_CONNREQUIRED) == 0) 161 162 /* 163 * Nfs outstanding request list element 164 */ 165 struct nfsreq { 166 TAILQ_ENTRY(nfsreq) r_chain; 167 struct mbuf *r_mreq; 168 struct mbuf *r_mrep; 169 struct mbuf *r_md; 170 caddr_t r_dpos; 171 struct nfsmount *r_nmp; 172 struct vnode *r_vp; 173 u_int32_t r_xid; 174 int r_flags; /* flags on request, see below */ 175 int r_retry; /* max retransmission count */ 176 int r_rexmit; /* current retrans count */ 177 int r_timer; /* tick counter on reply */ 178 u_int32_t r_procnum; /* NFS procedure number */ 179 int r_rtt; /* RTT for rpc */ 180 int r_lastmsg; /* last tprintf */ 181 struct thread *r_td; /* Proc that did I/O system call */ 182 struct mtx r_mtx; /* Protects nfsreq fields */ 183 }; 184 185 /* 186 * Queue head for nfsreq's 187 */ 188 extern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq; 189 190 /* Flag values for r_flags */ 191 #define R_TIMING 0x01 /* timing request (in mntp) */ 192 #define R_SENT 0x02 /* request has been sent */ 193 #define R_SOFTTERM 0x04 /* soft mnt, too many retries */ 194 #define R_RESENDERR 0x08 /* Resend failed */ 195 #define R_SOCKERR 0x10 /* Fatal error on socket */ 196 #define R_TPRINTFMSG 0x20 /* Did a tprintf msg. */ 197 #define R_MUSTRESEND 0x40 /* Must resend request */ 198 #define R_GETONEREP 0x80 /* Probe for one reply only */ 199 #define R_REXMIT_INPROG 0x100 /* Re-transmit in progress */ 200 201 /* 202 * Pointers to ops that differ from v3 to v4 203 */ 204 struct nfs_rpcops { 205 int (*nr_readrpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred); 206 int (*nr_writerpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred, 207 int *iomode, int *must_commit); 208 int (*nr_writebp)(struct buf *bp, int force, struct thread *td); 209 int (*nr_readlinkrpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred); 210 void (*nr_invaldir)(struct vnode *vp); 211 int (*nr_commit)(struct vnode *vp, u_quad_t offset, int cnt, 212 struct ucred *cred, struct thread *td); 213 }; 214 215 /* 216 * Defines for WebNFS 217 */ 218 219 #define WEBNFS_ESC_CHAR '%' 220 #define WEBNFS_SPECCHAR_START 0x80 221 222 #define WEBNFS_NATIVE_CHAR 0x80 223 /* 224 * .. 225 * Possibly more here in the future. 226 */ 227 228 /* 229 * Macro for converting escape characters in WebNFS pathnames. 230 * Should really be in libkern. 231 */ 232 233 #define HEXTOC(c) \ 234 ((c) >= 'a' ? ((c) - ('a' - 10)) : \ 235 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0'))) 236 #define HEXSTRTOI(p) \ 237 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1])) 238 239 /* nfs_sigintr() helper, when 'rep' has all we need */ 240 #define NFS_SIGREP(rep) nfs_sigintr((rep)->r_nmp, (rep), (rep)->r_td) 241 242 #ifdef NFS_DEBUG 243 244 extern int nfs_debug; 245 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */ 246 #define NFS_DEBUG_WG 2 /* server write gathering */ 247 #define NFS_DEBUG_RC 4 /* server request caching */ 248 249 #define NFS_DPF(cat, args) \ 250 do { \ 251 if (nfs_debug & NFS_DEBUG_##cat) printf args; \ 252 } while (0) 253 254 #else 255 256 #define NFS_DPF(cat, args) 257 258 #endif 259 260 vfs_init_t nfs_init; 261 vfs_uninit_t nfs_uninit; 262 int nfs_mountroot(struct mount *mp, struct thread *td); 263 264 #ifndef NFS4_USE_RPCCLNT 265 int nfs_send(struct socket *, struct sockaddr *, struct mbuf *, 266 struct nfsreq *); 267 int nfs_sndlock(struct nfsreq *); 268 void nfs_sndunlock(struct nfsreq *); 269 #endif /* ! NFS4_USE_RPCCLNT */ 270 271 int nfs_vinvalbuf(struct vnode *, int, struct thread *, int); 272 int nfs_readrpc(struct vnode *, struct uio *, struct ucred *); 273 int nfs_writerpc(struct vnode *, struct uio *, struct ucred *, int *, 274 int *); 275 int nfs_commit(struct vnode *vp, u_quad_t offset, int cnt, 276 struct ucred *cred, struct thread *td); 277 int nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *); 278 int nfs_nfsiodnew(void); 279 int nfs_asyncio(struct nfsmount *, struct buf *, struct ucred *, struct thread *); 280 int nfs_doio(struct vnode *, struct buf *, struct ucred *, struct thread *); 281 void nfs_doio_directwrite (struct buf *); 282 void nfs_up(struct nfsreq *, struct nfsmount *, struct thread *, 283 const char *, int); 284 void nfs_down(struct nfsreq *, struct nfsmount *, struct thread *, 285 const char *, int, int); 286 int nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *); 287 int nfs_sigintr(struct nfsmount *, struct nfsreq *, struct thread *); 288 int nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *); 289 int nfs_request(struct vnode *, struct mbuf *, int, struct thread *, 290 struct ucred *, struct mbuf **, struct mbuf **, caddr_t *); 291 int nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *, 292 struct vattr *, int); 293 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *); 294 void nfs_nhinit(void); 295 void nfs_nhuninit(void); 296 int nfs_nmcancelreqs(struct nfsmount *); 297 void nfs_timer(void*); 298 299 int nfs_connect(struct nfsmount *, struct nfsreq *); 300 void nfs_disconnect(struct nfsmount *); 301 void nfs_safedisconnect(struct nfsmount *); 302 int nfs_getattrcache(struct vnode *, struct vattr *); 303 int nfsm_strtmbuf(struct mbuf **, char **, const char *, long); 304 int nfs_bioread(struct vnode *, struct uio *, int, struct ucred *); 305 int nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *); 306 void nfs_clearcommit(struct mount *); 307 int nfs_writebp(struct buf *, int, struct thread *); 308 int nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *, 309 struct thread *); 310 int nfs_meta_setsize (struct vnode *, struct ucred *, 311 struct thread *, u_quad_t); 312 313 void nfs_set_sigmask __P((struct thread *td, sigset_t *oldset)); 314 void nfs_restore_sigmask __P((struct thread *td, sigset_t *set)); 315 int nfs_msleep __P((struct thread *td, void *ident, struct mtx *mtx, int priority, 316 char *wmesg, int timo)); 317 318 #endif /* _KERNEL */ 319 320 #endif 321