2 * Copyright (c) 1989, 1993, 1995
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)nfs.h 8.4 (Berkeley) 5/1/95
36 #ifndef _NFSCLIENT_NFS_H_
37 #define _NFSCLIENT_NFS_H_
43 #include <nfsclient/nfsargs.h>
46 * Tunable constants for nfs
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 */
61 #ifndef NFS_MAXATTRTIMO
62 #define NFS_MAXATTRTIMO 60
64 #ifndef NFS_MINDIRATTRTIMO
65 #define NFS_MINDIRATTRTIMO 30 /* VDIR attrib cache timeout in sec */
67 #ifndef NFS_MAXDIRATTRTIMO
68 #define NFS_MAXDIRATTRTIMO 60
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 */
78 #define DIRBLKSIZ 512 /* XXX we used to use ufs's DIRBLKSIZ */
80 #define NFS_MAXDEADTHRESH 9 /* How long till we say 'server not responding' */
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)
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 */
97 * XXX to allow amd to include nfs.h without nfsproto.h
100 #include <nfsclient/nfsstats.h>
104 * vfs.nfs sysctl(3) identifiers
106 #define NFS_NFSSTATS 1 /* struct: struct nfsstats */
109 * File context information for nfsv4. Currently, there is only one
110 * lockowner for the whole machine "0."
113 TAILQ_ENTRY(nfs4_fstate) next;
115 struct nfs4_lowner *lop;
117 char stateid[NFSX_V4STATEID];
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);
130 extern struct uma_zone *nfsmount_zone;
132 extern struct callout nfs_callout;
133 extern struct nfsstats nfsstats;
135 extern int nfs_numasync;
136 extern unsigned int nfs_iodmax;
137 extern int nfs_pbuf_freecnt;
138 extern int nfs_ticks;
140 /* Data constants in XDR form */
141 extern u_int32_t nfs_true, nfs_false, nfs_xdrneg1;
142 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers;
143 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr;
145 extern int nfsv3_procid[NFS_NPROCS];
153 * Socket errors ignored for connectionless sockets??
154 * For now, ignore them all
156 #define NFSIGNORE_SOERROR(s, e) \
157 ((e) != EINTR && (e) != EIO && \
158 (e) != ERESTART && (e) != EWOULDBLOCK && \
159 ((s) & PR_CONNREQUIRED) == 0)
162 * Nfs outstanding request list element
165 TAILQ_ENTRY(nfsreq) r_chain;
170 struct nfsmount *r_nmp;
173 int r_flags; /* flags on request, see below */
174 int r_retry; /* max retransmission count */
175 int r_rexmit; /* current retrans count */
176 int r_timer; /* tick counter on reply */
177 u_int32_t r_procnum; /* NFS procedure number */
178 int r_rtt; /* RTT for rpc */
179 int r_lastmsg; /* last tprintf */
180 struct thread *r_td; /* Proc that did I/O system call */
184 * Queue head for nfsreq's
186 extern TAILQ_HEAD(nfs_reqq, nfsreq) nfs_reqq;
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_REXMIT_INPROG 0x100 /* Re-transmit in progress */
200 * Pointers to ops that differ from v3 to v4
203 int (*nr_readrpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred);
204 int (*nr_writerpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred,
205 int *iomode, int *must_commit);
206 int (*nr_writebp)(struct buf *bp, int force, struct thread *td);
207 int (*nr_readlinkrpc)(struct vnode *vp, struct uio *uiop, struct ucred *cred);
208 void (*nr_invaldir)(struct vnode *vp);
209 int (*nr_commit)(struct vnode *vp, u_quad_t offset, int cnt,
210 struct ucred *cred, struct thread *td);
217 #define WEBNFS_ESC_CHAR '%'
218 #define WEBNFS_SPECCHAR_START 0x80
220 #define WEBNFS_NATIVE_CHAR 0x80
223 * Possibly more here in the future.
227 * Macro for converting escape characters in WebNFS pathnames.
228 * Should really be in libkern.
232 ((c) >= 'a' ? ((c) - ('a' - 10)) : \
233 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '0')))
234 #define HEXSTRTOI(p) \
235 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
237 /* nfs_sigintr() helper, when 'rep' has all we need */
238 #define NFS_SIGREP(rep) nfs_sigintr((rep)->r_nmp, (rep), (rep)->r_td)
242 extern int nfs_debug;
243 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */
244 #define NFS_DEBUG_WG 2 /* server write gathering */
245 #define NFS_DEBUG_RC 4 /* server request caching */
247 #define NFS_DPF(cat, args) \
249 if (nfs_debug & NFS_DEBUG_##cat) printf args; \
254 #define NFS_DPF(cat, args)
259 vfs_uninit_t nfs_uninit;
260 int nfs_mountroot(struct mount *mp, struct thread *td);
262 #ifndef NFS4_USE_RPCCLNT
263 int nfs_send(struct socket *, struct sockaddr *, struct mbuf *,
265 int nfs_sndlock(struct nfsreq *);
266 void nfs_sndunlock(struct nfsreq *);
267 #endif /* ! NFS4_USE_RPCCLNT */
269 int nfs_vinvalbuf(struct vnode *, int, struct thread *, int);
270 int nfs_readrpc(struct vnode *, struct uio *, struct ucred *);
271 int nfs_writerpc(struct vnode *, struct uio *, struct ucred *, int *,
273 int nfs_commit(struct vnode *vp, u_quad_t offset, int cnt,
274 struct ucred *cred, struct thread *td);
275 int nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *);
276 int nfs_nfsiodnew(void);
277 int nfs_asyncio(struct nfsmount *, struct buf *, struct ucred *, struct thread *);
278 int nfs_doio(struct vnode *, struct buf *, struct ucred *, struct thread *);
279 void nfs_doio_directwrite (struct buf *);
280 void nfs_up(struct nfsreq *, struct nfsmount *, struct thread *,
282 void nfs_down(struct nfsreq *, struct nfsmount *, struct thread *,
283 const char *, int, int);
284 int nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *);
285 int nfs_sigintr(struct nfsmount *, struct nfsreq *, struct thread *);
286 int nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *);
287 int nfs_request(struct vnode *, struct mbuf *, int, struct thread *,
288 struct ucred *, struct mbuf **, struct mbuf **, caddr_t *);
289 int nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *,
290 struct vattr *, int);
291 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
292 void nfs_nhinit(void);
293 void nfs_nhuninit(void);
294 int nfs_nmcancelreqs(struct nfsmount *);
295 void nfs_timer(void*);
297 int nfs_connect(struct nfsmount *, struct nfsreq *);
298 void nfs_disconnect(struct nfsmount *);
299 void nfs_safedisconnect(struct nfsmount *);
300 int nfs_getattrcache(struct vnode *, struct vattr *);
301 int nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
302 int nfs_bioread(struct vnode *, struct uio *, int, struct ucred *);
303 int nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *);
304 void nfs_clearcommit(struct mount *);
305 int nfs_writebp(struct buf *, int, struct thread *);
306 int nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *,
308 int nfs_meta_setsize (struct vnode *, struct ucred *,
309 struct thread *, u_quad_t);
311 void nfs_set_sigmask __P((struct thread *td, sigset_t *oldset));
312 void nfs_restore_sigmask __P((struct thread *td, sigset_t *set));
313 int nfs_tsleep __P((struct thread *td, void *ident, int priority, char *wmesg,
315 int nfs_msleep __P((struct thread *td, void *ident, struct mtx *mtx, int priority,
316 char *wmesg, int timo));