FreeBSD/Linux Kernel Cross Reference
sys/nfsclient/nfs.h
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: releng/11.2/sys/nfsclient/nfs.h 331722 2018-03-29 02:50:57Z eadler $
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.oldnfs 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_NFSDIROFF);
118 MALLOC_DECLARE(M_NFSDIRECTIO);
119 #endif
120
121 extern struct uma_zone *nfsmount_zone;
122
123 extern struct nfsstats nfsstats;
124 extern struct mtx nfs_iod_mtx;
125 extern struct task nfs_nfsiodnew_task;
126
127 extern int nfs_numasync;
128 extern unsigned int nfs_iodmax;
129 extern int nfs_pbuf_freecnt;
130 extern int nfs_ticks;
131
132 /* Data constants in XDR form */
133 extern u_int32_t nfs_true, nfs_false, nfs_xdrneg1;
134 extern u_int32_t rpc_reply, rpc_msgdenied, rpc_mismatch, rpc_vers;
135 extern u_int32_t rpc_auth_unix, rpc_msgaccepted, rpc_call, rpc_autherr;
136
137 extern int nfsv3_procid[NFS_NPROCS];
138
139 /*
140 * Socket errors ignored for connectionless sockets??
141 * For now, ignore them all
142 */
143 #define NFSIGNORE_SOERROR(s, e) \
144 ((e) != EINTR && (e) != EIO && \
145 (e) != ERESTART && (e) != EWOULDBLOCK && \
146 ((s) & PR_CONNREQUIRED) == 0)
147
148 struct nfsmount;
149
150 struct buf;
151 struct socket;
152 struct uio;
153 struct vattr;
154
155 /*
156 * Pointers to ops that differ from v3 to v4
157 */
158 struct nfs_rpcops {
159 int (*nr_readrpc)(struct vnode *vp, struct uio *uiop,
160 struct ucred *cred);
161 int (*nr_writerpc)(struct vnode *vp, struct uio *uiop,
162 struct ucred *cred, int *iomode, int *must_commit);
163 int (*nr_writebp)(struct buf *bp, int force, struct thread *td);
164 int (*nr_readlinkrpc)(struct vnode *vp, struct uio *uiop,
165 struct ucred *cred);
166 void (*nr_invaldir)(struct vnode *vp);
167 int (*nr_commit)(struct vnode *vp, u_quad_t offset, int cnt,
168 struct ucred *cred, struct thread *td);
169 };
170
171 /*
172 * Defines for WebNFS
173 */
174
175 #define WEBNFS_ESC_CHAR '%'
176 #define WEBNFS_SPECCHAR_START 0x80
177
178 #define WEBNFS_NATIVE_CHAR 0x80
179 /*
180 * ..
181 * Possibly more here in the future.
182 */
183
184 /*
185 * Macro for converting escape characters in WebNFS pathnames.
186 * Should really be in libkern.
187 */
188
189 #define HEXTOC(c) \
190 ((c) >= 'a' ? ((c) - ('a' - 10)) : \
191 ((c) >= 'A' ? ((c) - ('A' - 10)) : ((c) - '')))
192 #define HEXSTRTOI(p) \
193 ((HEXTOC(p[0]) << 4) + HEXTOC(p[1]))
194
195 /* nfs_sigintr() helper, when 'rep' has all we need */
196 #define NFS_SIGREP(rep) nfs_sigintr((rep)->r_nmp, (rep), (rep)->r_td)
197
198 #ifdef NFS_DEBUG
199
200 extern int nfs_debug;
201 #define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */
202 #define NFS_DEBUG_WG 2 /* server write gathering */
203 #define NFS_DEBUG_RC 4 /* server request caching */
204
205 #define NFS_DPF(cat, args) \
206 do { \
207 if (nfs_debug & NFS_DEBUG_##cat) printf args; \
208 } while (0)
209
210 #else
211
212 #define NFS_DPF(cat, args)
213
214 #endif
215
216 /*
217 * On fast networks, the estimator will try to reduce the
218 * timeout lower than the latency of the server's disks,
219 * which results in too many timeouts, so cap the lower
220 * bound.
221 */
222 #define NFS_MINRTO (NFS_HZ >> 2)
223
224 /*
225 * Keep the RTO from increasing to unreasonably large values
226 * when a server is not responding.
227 */
228 #define NFS_MAXRTO (20 * NFS_HZ)
229
230 enum nfs_rto_timer_t {
231 NFS_DEFAULT_TIMER,
232 NFS_GETATTR_TIMER,
233 NFS_LOOKUP_TIMER,
234 NFS_READ_TIMER,
235 NFS_WRITE_TIMER,
236 };
237 #define NFS_MAX_TIMER (NFS_WRITE_TIMER)
238
239 #define NFS_INITRTT (NFS_HZ << 3)
240
241 vfs_init_t nfs_init;
242 vfs_uninit_t nfs_uninit;
243 int nfs_mountroot(struct mount *mp);
244
245 void nfs_purgecache(struct vnode *);
246 int nfs_vinvalbuf(struct vnode *, int, struct thread *, int);
247 int nfs_readrpc(struct vnode *, struct uio *, struct ucred *);
248 int nfs_writerpc(struct vnode *, struct uio *, struct ucred *, int *,
249 int *);
250 int nfs_commit(struct vnode *vp, u_quad_t offset, int cnt,
251 struct ucred *cred, struct thread *td);
252 int nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *);
253 void nfs_nfsiodnew(void);
254 void nfs_nfsiodnew_tq(__unused void *, int);
255 int nfs_asyncio(struct nfsmount *, struct buf *, struct ucred *, struct thread *);
256 int nfs_doio(struct vnode *, struct buf *, struct ucred *, struct thread *);
257 void nfs_doio_directwrite (struct buf *);
258 int nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *);
259 int nfs_sigintr(struct nfsmount *, struct thread *);
260 int nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *);
261 int nfs_request(struct vnode *, struct mbuf *, int, struct thread *,
262 struct ucred *, struct mbuf **, struct mbuf **, caddr_t *);
263 int nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *,
264 struct vattr *, int);
265 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
266 void nfs_nhinit(void);
267 void nfs_nhuninit(void);
268 int nfs_nmcancelreqs(struct nfsmount *);
269 void nfs_timer(void*);
270
271 int nfs_connect(struct nfsmount *);
272 void nfs_disconnect(struct nfsmount *);
273 void nfs_safedisconnect(struct nfsmount *);
274 int nfs_getattrcache(struct vnode *, struct vattr *);
275 int nfs_iosize(struct nfsmount *nmp);
276 int nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
277 int nfs_bioread(struct vnode *, struct uio *, int, struct ucred *);
278 int nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *);
279 void nfs_clearcommit(struct mount *);
280 int nfs_writebp(struct buf *, int, struct thread *);
281 int nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *,
282 struct thread *);
283 int nfs_meta_setsize (struct vnode *, struct ucred *,
284 struct thread *, u_quad_t);
285
286 void nfs_set_sigmask(struct thread *td, sigset_t *oldset);
287 void nfs_restore_sigmask(struct thread *td, sigset_t *set);
288 int nfs_msleep(struct thread *td, void *ident, struct mtx *mtx,
289 int priority, char *wmesg, int timo);
290
291 #endif /* _KERNEL */
292
293 #endif
Cache object: 69a9b30343d4341273f9d76e3b32a8d3
|