nfs_var.h revision 1.84 1 /* $NetBSD: nfs_var.h,v 1.84 2008/11/19 18:36:09 ad Exp $ */
2
3 /*-
4 * Copyright (c) 1996 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Christos Zoulas.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*
33 * XXX needs <nfs/rpcv2.h> and <nfs/nfs.h> because of typedefs
34 */
35
36 #ifdef _KERNEL
37 #include <sys/mallocvar.h>
38 #include <sys/pool.h>
39
40 MALLOC_DECLARE(M_NFSD);
41 MALLOC_DECLARE(M_NFSDIROFF);
42
43 struct vnode;
44 struct uio;
45 struct proc;
46 struct buf;
47 struct nfs_diskless;
48 struct sockaddr_in;
49 struct nfs_dlmount;
50 struct vnode;
51 struct nfsd;
52 struct mbuf;
53 struct file;
54 struct nfssvc_sock;
55 struct nfsmount;
56 struct socket;
57 struct nfsreq;
58 struct vattr;
59 struct nameidata;
60 struct nfsnode;
61 struct sillyrename;
62 struct componentname;
63 struct nfsd_srvargs;
64 struct nfsrv_descript;
65 struct nfs_fattr;
66 struct nfsdircache;
67 union nethostaddr;
68
69 /* nfs_bio.c */
70 int nfs_bioread(struct vnode *, struct uio *, int, kauth_cred_t, int);
71 struct buf *nfs_getcacheblk(struct vnode *, daddr_t, int, struct lwp *);
72 int nfs_vinvalbuf(struct vnode *, int, kauth_cred_t, struct lwp *, int);
73 int nfs_flushstalebuf(struct vnode *, kauth_cred_t, struct lwp *, int);
74 #define NFS_FLUSHSTALEBUF_MYWRITE 1 /* assume writes are ours */
75 int nfs_asyncio(struct buf *);
76 int nfs_doio(struct buf *);
77
78 /* nfs_boot.c */
79 /* see nfsdiskless.h */
80
81 /* nfs_kq.c */
82 void nfs_kqinit(void);
83 void nfs_kqfini(void);
84
85 /* nfs_node.c */
86 void nfs_rbtinit(struct nfsmount *);
87 void nfs_node_init(void);
88 void nfs_node_done(void);
89
90 int nfs_nget1(struct mount *, nfsfh_t *, int, struct nfsnode **, int);
91 #define nfs_nget(mp, fhp, fhsize, npp) \
92 nfs_nget1((mp), (fhp), (fhsize), (npp), 0)
93
94 /* nfs_vnops.c */
95 int nfs_null(struct vnode *, kauth_cred_t, struct lwp *);
96 int nfs_setattrrpc(struct vnode *, struct vattr *, kauth_cred_t, struct lwp *);
97 int nfs_readlinkrpc(struct vnode *, struct uio *, kauth_cred_t);
98 int nfs_readrpc(struct vnode *, struct uio *);
99 int nfs_writerpc(struct vnode *, struct uio *, int *, bool, bool *);
100 int nfs_mknodrpc(struct vnode *, struct vnode **, struct componentname *,
101 struct vattr *);
102 int nfs_removeit(struct sillyrename *);
103 int nfs_removerpc(struct vnode *, const char *, int, kauth_cred_t,
104 struct lwp *);
105 int nfs_renameit(struct vnode *, struct componentname *, struct sillyrename *);
106 int nfs_renamerpc(struct vnode *, const char *, int, struct vnode *,
107 const char *, int, kauth_cred_t, struct lwp *);
108 int nfs_readdirrpc(struct vnode *, struct uio *, kauth_cred_t);
109 int nfs_readdirplusrpc(struct vnode *, struct uio *, kauth_cred_t);
110 int nfs_sillyrename(struct vnode *, struct vnode *, struct componentname *,
111 bool);
112 int nfs_lookitup(struct vnode *, const char *, int, kauth_cred_t,
113 struct lwp *, struct nfsnode **);
114 int nfs_commit(struct vnode *, off_t, uint32_t, struct lwp *);
115 int nfs_flush(struct vnode *, kauth_cred_t, int, struct lwp *, int);
116
117 /* nfs_serv.c */
118 int nfsrv3_access(struct nfsrv_descript *, struct nfssvc_sock *,
119 struct lwp *, struct mbuf **);
120 int nfsrv_getattr(struct nfsrv_descript *, struct nfssvc_sock *,
121 struct lwp *, struct mbuf **);
122 int nfsrv_setattr(struct nfsrv_descript *, struct nfssvc_sock *,
123 struct lwp *, struct mbuf **);
124 int nfsrv_lookup(struct nfsrv_descript *, struct nfssvc_sock *,
125 struct lwp *, struct mbuf **);
126 int nfsrv_readlink(struct nfsrv_descript *, struct nfssvc_sock *,
127 struct lwp *, struct mbuf **);
128 int nfsrv_read(struct nfsrv_descript *, struct nfssvc_sock *,
129 struct lwp *, struct mbuf **);
130 int nfsrv_write(struct nfsrv_descript *, struct nfssvc_sock *,
131 struct lwp *, struct mbuf **);
132 int nfsrv_writegather(struct nfsrv_descript **, struct nfssvc_sock *,
133 struct lwp *, struct mbuf **);
134 void nfsrvw_coalesce(struct nfsrv_descript *, struct nfsrv_descript *);
135 int nfsrv_create(struct nfsrv_descript *, struct nfssvc_sock *,
136 struct lwp *, struct mbuf **);
137 int nfsrv_mknod(struct nfsrv_descript *, struct nfssvc_sock *,
138 struct lwp *, struct mbuf **);
139 int nfsrv_remove(struct nfsrv_descript *, struct nfssvc_sock *,
140 struct lwp *, struct mbuf **);
141 int nfsrv_rename(struct nfsrv_descript *, struct nfssvc_sock *,
142 struct lwp *, struct mbuf **);
143 int nfsrv_link(struct nfsrv_descript *, struct nfssvc_sock *,
144 struct lwp *, struct mbuf **);
145 int nfsrv_symlink(struct nfsrv_descript *, struct nfssvc_sock *,
146 struct lwp *, struct mbuf **);
147 int nfsrv_mkdir(struct nfsrv_descript *, struct nfssvc_sock *,
148 struct lwp *, struct mbuf **);
149 int nfsrv_rmdir(struct nfsrv_descript *, struct nfssvc_sock *,
150 struct lwp *, struct mbuf **);
151 int nfsrv_readdir(struct nfsrv_descript *, struct nfssvc_sock *,
152 struct lwp *, struct mbuf **);
153 int nfsrv_readdirplus(struct nfsrv_descript *, struct nfssvc_sock *,
154 struct lwp *, struct mbuf **);
155 int nfsrv_commit(struct nfsrv_descript *, struct nfssvc_sock *,
156 struct lwp *, struct mbuf **);
157 int nfsrv_statfs(struct nfsrv_descript *, struct nfssvc_sock *,
158 struct lwp *, struct mbuf **);
159 int nfsrv_fsinfo(struct nfsrv_descript *, struct nfssvc_sock *,
160 struct lwp *, struct mbuf **);
161 int nfsrv_pathconf(struct nfsrv_descript *, struct nfssvc_sock *,
162 struct lwp *, struct mbuf **);
163 int nfsrv_null(struct nfsrv_descript *, struct nfssvc_sock *,
164 struct lwp *, struct mbuf **);
165 int nfsrv_noop(struct nfsrv_descript *, struct nfssvc_sock *,
166 struct lwp *, struct mbuf **);
167 int nfsrv_access(struct vnode *, int, kauth_cred_t, int, struct lwp *, int);
168
169 /* nfs_socket.c */
170 int nfs_connect(struct nfsmount *, struct nfsreq *, struct lwp *);
171 int nfs_reconnect(struct nfsreq *);
172 void nfs_disconnect(struct nfsmount *);
173 void nfs_safedisconnect(struct nfsmount *);
174 int nfs_send(struct socket *, struct mbuf *, struct mbuf *, struct nfsreq *,
175 struct lwp *);
176 int nfs_request(struct nfsnode *, struct mbuf *, int, struct lwp *,
177 kauth_cred_t, struct mbuf **, struct mbuf **, char **, int *);
178 int nfs_rephead(int, struct nfsrv_descript *, struct nfssvc_sock *,
179 int, int, u_quad_t *, struct mbuf **, struct mbuf **, char **);
180 void nfs_timer(void *);
181 void nfs_timer_init(void);
182 void nfs_timer_fini(void);
183 void nfs_timer_start(void);
184 void nfs_timer_srvinit(bool (*)(void));
185 void nfs_timer_srvfini(void);
186 int nfs_sigintr(struct nfsmount *, struct nfsreq *, struct lwp *);
187 int nfs_getreq(struct nfsrv_descript *, struct nfsd *, int);
188 int nfs_msg(struct lwp *, const char *, const char *);
189 void nfsrv_soupcall(struct socket *, void *, int);
190 void nfsrv_rcv(struct nfssvc_sock *);
191 int nfsrv_getstream(struct nfssvc_sock *, int);
192 int nfsrv_dorec(struct nfssvc_sock *, struct nfsd *, struct nfsrv_descript **,
193 bool *);
194 void nfsrv_wakenfsd(struct nfssvc_sock *);
195 int nfsdsock_lock(struct nfssvc_sock *, bool);
196 void nfsdsock_unlock(struct nfssvc_sock *);
197 int nfsdsock_drain(struct nfssvc_sock *);
198 int nfsdsock_sendreply(struct nfssvc_sock *, struct nfsrv_descript *);
199 void nfsdreq_init(void);
200 void nfsdreq_fini(void);
201 struct nfsrv_descript *nfsdreq_alloc(void);
202 void nfsdreq_free(struct nfsrv_descript *);
203 bool nfsrv_timer(void);
204
205 void nfsdsock_setbits(struct nfssvc_sock *, int);
206 void nfsdsock_clearbits(struct nfssvc_sock *, int);
207 bool nfsdsock_testbits(struct nfssvc_sock *, int);
208
209 /* nfs_srvcache.c */
210 void nfsrv_initcache(void);
211 void nfsrv_finicache(void);
212 int nfsrv_getcache(struct nfsrv_descript *, struct nfssvc_sock *,
213 struct mbuf **);
214 void nfsrv_updatecache(struct nfsrv_descript *, int, struct mbuf *);
215 void nfsrv_cleancache(void);
216
217 /* nfs_subs.c */
218 struct mbuf *nfsm_reqh(struct nfsnode *, u_long, int, char **);
219 struct mbuf *nfsm_rpchead(kauth_cred_t, int, int, int, int, char *, int,
220 char *, struct mbuf *, int, struct mbuf **, u_int32_t *);
221 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, char **);
222 int nfsm_uiotombuf(struct uio *, struct mbuf **, int, char **);
223 int nfsm_disct(struct mbuf **, char **, int, int, char **);
224 int nfs_adv(struct mbuf **, char **, int, int);
225 int nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
226 u_long nfs_dirhash(off_t);
227 void nfs_initdircache(struct vnode *);
228 void nfs_initdirxlatecookie(struct vnode *);
229 struct nfsdircache *nfs_searchdircache(struct vnode *, off_t, int, int *);
230 struct nfsdircache *nfs_enterdircache(struct vnode *, off_t, off_t, int,
231 daddr_t);
232 void nfs_putdircache(struct nfsnode *, struct nfsdircache *);
233 void nfs_invaldircache(struct vnode *, int);
234 #define NFS_INVALDIRCACHE_FORCE 1
235 #define NFS_INVALDIRCACHE_KEEPEOF 2
236 void nfs_init(void);
237 void nfs_fini(void);
238 int nfsm_loadattrcache(struct vnode **, struct mbuf **, char **,
239 struct vattr *, int flags);
240 int nfs_loadattrcache(struct vnode **, struct nfs_fattr *, struct vattr *,
241 int flags);
242 int nfs_getattrcache(struct vnode *, struct vattr *);
243 void nfs_delayedtruncate(struct vnode *);
244 int nfs_check_wccdata(struct nfsnode *, const struct timespec *,
245 struct timespec *, bool);
246 int nfs_namei(struct nameidata *, nfsrvfh_t *, uint32_t, struct nfssvc_sock *,
247 struct mbuf *, struct mbuf **, char **, struct vnode **, struct lwp *,
248 int, int);
249 void nfs_zeropad(struct mbuf *, int, int);
250 void nfsm_srvwcc(struct nfsrv_descript *, int, struct vattr *, int,
251 struct vattr *, struct mbuf **, char **);
252 void nfsm_srvpostopattr(struct nfsrv_descript *, int, struct vattr *,
253 struct mbuf **, char **);
254 void nfsm_srvfattr(struct nfsrv_descript *, struct vattr *, struct nfs_fattr *);
255 int nfsrv_fhtovp(nfsrvfh_t *, int, struct vnode **, kauth_cred_t,
256 struct nfssvc_sock *, struct mbuf *, int *, int, int);
257 int nfs_ispublicfh __P((const nfsrvfh_t *));
258 int netaddr_match(int, union nethostaddr *, struct mbuf *);
259 time_t nfs_attrtimeo(struct nfsmount *, struct nfsnode *);
260
261 /* flags for nfs_loadattrcache and friends */
262 #define NAC_NOTRUNC 1 /* don't truncate file size */
263
264 void nfs_clearcommit(struct mount *);
265 void nfs_merge_commit_ranges(struct vnode *);
266 int nfs_in_committed_range(struct vnode *, off_t, off_t);
267 int nfs_in_tobecommitted_range(struct vnode *, off_t, off_t);
268 void nfs_add_committed_range(struct vnode *, off_t, off_t);
269 void nfs_del_committed_range(struct vnode *, off_t, off_t);
270 void nfs_add_tobecommitted_range(struct vnode *, off_t, off_t);
271 void nfs_del_tobecommitted_range(struct vnode *, off_t, off_t);
272
273 int nfsrv_errmap(struct nfsrv_descript *, int);
274 void nfs_cookieheuristic(struct vnode *, int *, struct lwp *, kauth_cred_t);
275
276 u_int32_t nfs_getxid(void);
277 void nfs_renewxid(struct nfsreq *);
278
279 int nfsrv_composefh(struct vnode *, nfsrvfh_t *, bool);
280 int nfsrv_comparefh(const nfsrvfh_t *, const nfsrvfh_t *);
281 void nfsrv_copyfh(nfsrvfh_t *, const nfsrvfh_t *);
282
283 /* nfs_syscalls.c */
284 struct sys_getfh_args;
285 struct sys_nfssvc_args;
286 int sys_getfh(struct lwp *, const struct sys_getfh_args *, register_t *);
287 int sys_nfssvc(struct lwp *, const struct sys_nfssvc_args *, register_t *);
288 int nfssvc_addsock(struct file *, struct mbuf *);
289 int nfssvc_nfsd(struct nfsd_srvargs *, void *, struct lwp *);
290 void nfsrv_zapsock(struct nfssvc_sock *);
291 void nfsrv_slpderef(struct nfssvc_sock *);
292 void nfsrv_init(int);
293 void nfsrv_fini(void);
294 void nfs_iodinit(void);
295 void nfs_iodfini(void);
296 int nfs_set_niothreads(int);
297 int nfs_getauth(struct nfsmount *, struct nfsreq *, kauth_cred_t, char **,
298 int *, char *, int *, NFSKERBKEY_T);
299 int nfs_getnickauth(struct nfsmount *, kauth_cred_t, char **, int *, char *,
300 int);
301 int nfs_savenickauth(struct nfsmount *, kauth_cred_t, int, NFSKERBKEY_T,
302 struct mbuf **, char **, struct mbuf *);
303
304 /* nfs_export.c */
305 extern struct nfs_public nfs_pub;
306 int mountd_set_exports_list(const struct mountd_exports_list *, struct lwp *);
307 int netexport_check(const fsid_t *, struct mbuf *, struct mount **, int *,
308 kauth_cred_t *);
309 void netexport_rdlock(void);
310 void netexport_rdunlock(void);
311 #endif /* _KERNEL */
312