nfs_var.h revision 1.61.2.2 1 /* $NetBSD: nfs_var.h,v 1.61.2.2 2006/05/19 13:53:12 yamt 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 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 /*
40 * XXX needs <nfs/rpcv2.h> and <nfs/nfs.h> because of typedefs
41 */
42
43 #ifdef _KERNEL
44 #include <sys/mallocvar.h>
45 #include <sys/pool.h>
46
47 MALLOC_DECLARE(M_NFSREQ);
48 MALLOC_DECLARE(M_NFSMNT);
49 MALLOC_DECLARE(M_NFSUID);
50 MALLOC_DECLARE(M_NFSD);
51 MALLOC_DECLARE(M_NFSDIROFF);
52 MALLOC_DECLARE(M_NFSBIGFH);
53 MALLOC_DECLARE(M_NQLEASE);
54
55 struct vnode;
56 struct uio;
57 struct proc;
58 struct buf;
59 struct nfs_diskless;
60 struct sockaddr_in;
61 struct nfs_dlmount;
62 struct vnode;
63 struct nfsd;
64 struct mbuf;
65 struct file;
66 struct nqlease;
67 struct nqhost;
68 struct nfssvc_sock;
69 struct nfsmount;
70 struct socket;
71 struct nfsreq;
72 struct vattr;
73 struct nameidata;
74 struct nfsnode;
75 struct sillyrename;
76 struct componentname;
77 struct nfsd_srvargs;
78 struct nfsrv_descript;
79 struct nfs_fattr;
80 struct nfsdircache;
81 union nethostaddr;
82
83 /* nfs_bio.c */
84 int nfs_bioread(struct vnode *, struct uio *, int, kauth_cred_t, int);
85 struct buf *nfs_getcacheblk(struct vnode *, daddr_t, int, struct lwp *);
86 int nfs_vinvalbuf(struct vnode *, int, kauth_cred_t, struct lwp *, int);
87 int nfs_flushstalebuf(struct vnode *, kauth_cred_t, struct lwp *, int);
88 #define NFS_FLUSHSTALEBUF_MYWRITE 1 /* assume writes are ours */
89 int nfs_asyncio(struct buf *);
90 int nfs_doio(struct buf *);
91
92 /* nfs_boot.c */
93 /* see nfsdiskless.h */
94
95 /* nfs_kq.c */
96 void nfs_kqinit(void);
97
98 /* nfs_node.c */
99 void nfs_nhinit(void);
100 void nfs_nhreinit(void);
101 void nfs_nhdone(void);
102 int nfs_nget1(struct mount *, nfsfh_t *, int, struct nfsnode **, int);
103 #define nfs_nget(mp, fhp, fhsize, npp) \
104 nfs_nget1((mp), (fhp), (fhsize), (npp), 0)
105
106 /* nfs_vnops.c */
107 int nfs_null(struct vnode *, kauth_cred_t, struct lwp *);
108 int nfs_setattrrpc(struct vnode *, struct vattr *, kauth_cred_t, struct lwp *);
109 int nfs_readlinkrpc(struct vnode *, struct uio *, kauth_cred_t);
110 int nfs_readrpc(struct vnode *, struct uio *);
111 int nfs_writerpc(struct vnode *, struct uio *, int *, boolean_t, boolean_t *);
112 int nfs_mknodrpc(struct vnode *, struct vnode **, struct componentname *,
113 struct vattr *);
114 int nfs_removeit(struct sillyrename *);
115 int nfs_removerpc(struct vnode *, const char *, int, kauth_cred_t,
116 struct lwp *);
117 int nfs_renameit(struct vnode *, struct componentname *, struct sillyrename *);
118 int nfs_renamerpc(struct vnode *, const char *, int, struct vnode *,
119 const char *, int, kauth_cred_t, struct lwp *);
120 int nfs_readdirrpc(struct vnode *, struct uio *, kauth_cred_t);
121 int nfs_readdirplusrpc(struct vnode *, struct uio *, kauth_cred_t);
122 int nfs_sillyrename(struct vnode *, struct vnode *, struct componentname *);
123 int nfs_lookitup(struct vnode *, const char *, int, kauth_cred_t,
124 struct lwp *, struct nfsnode **);
125 int nfs_commit(struct vnode *, off_t, uint32_t, struct lwp *);
126 int nfs_flush(struct vnode *, kauth_cred_t, int, struct lwp *, int);
127
128 /* nfs_nqlease.c */
129 void nqnfs_lease_updatetime(int);
130 void nqnfs_clientlease(struct nfsmount *, struct nfsnode *, int, int, time_t,
131 u_quad_t);
132 void nqsrv_locklease(struct nqlease *);
133 void nqsrv_unlocklease(struct nqlease *);
134 int nqsrv_getlease(struct vnode *, u_int32_t *, int, struct nfssvc_sock *,
135 struct lwp *, struct mbuf *, int *, u_quad_t *, kauth_cred_t);
136 void nqsrv_addhost(struct nqhost *, struct nfssvc_sock *, struct mbuf *);
137 void nqsrv_instimeq(struct nqlease *, u_int32_t);
138 int nqsrv_cmpnam(struct nfssvc_sock *, struct mbuf *, struct nqhost *);
139 void nqsrv_send_eviction(struct vnode *, struct nqlease *,
140 struct nfssvc_sock *, struct mbuf *, kauth_cred_t, struct lwp *);
141 void nqsrv_waitfor_expiry(struct nqlease *);
142 void nqnfs_serverd(void);
143 int nqnfsrv_getlease(struct nfsrv_descript *, struct nfssvc_sock *,
144 struct lwp *, struct mbuf **);
145 int nqnfsrv_vacated(struct nfsrv_descript *, struct nfssvc_sock *,
146 struct lwp *, struct mbuf **);
147 int nqnfs_getlease(struct vnode *, int, kauth_cred_t, struct lwp *);
148 int nqnfs_vacated(struct vnode *, kauth_cred_t, struct lwp *);
149 int nqnfs_callback(struct nfsmount *, struct mbuf *, struct mbuf *,
150 caddr_t, struct lwp *);
151
152 /* nfs_serv.c */
153 int nfsrv3_access(struct nfsrv_descript *, struct nfssvc_sock *,
154 struct lwp *, struct mbuf **);
155 int nfsrv_getattr(struct nfsrv_descript *, struct nfssvc_sock *,
156 struct lwp *, struct mbuf **);
157 int nfsrv_setattr(struct nfsrv_descript *, struct nfssvc_sock *,
158 struct lwp *, struct mbuf **);
159 int nfsrv_lookup(struct nfsrv_descript *, struct nfssvc_sock *,
160 struct lwp *, struct mbuf **);
161 int nfsrv_readlink(struct nfsrv_descript *, struct nfssvc_sock *,
162 struct lwp *, struct mbuf **);
163 int nfsrv_read(struct nfsrv_descript *, struct nfssvc_sock *,
164 struct lwp *, struct mbuf **);
165 int nfsrv_write(struct nfsrv_descript *, struct nfssvc_sock *,
166 struct lwp *, struct mbuf **);
167 int nfsrv_writegather(struct nfsrv_descript **, struct nfssvc_sock *,
168 struct lwp *, struct mbuf **);
169 void nfsrvw_coalesce(struct nfsrv_descript *, struct nfsrv_descript *);
170 int nfsrv_create(struct nfsrv_descript *, struct nfssvc_sock *,
171 struct lwp *, struct mbuf **);
172 int nfsrv_mknod(struct nfsrv_descript *, struct nfssvc_sock *,
173 struct lwp *, struct mbuf **);
174 int nfsrv_remove(struct nfsrv_descript *, struct nfssvc_sock *,
175 struct lwp *, struct mbuf **);
176 int nfsrv_rename(struct nfsrv_descript *, struct nfssvc_sock *,
177 struct lwp *, struct mbuf **);
178 int nfsrv_link(struct nfsrv_descript *, struct nfssvc_sock *,
179 struct lwp *, struct mbuf **);
180 int nfsrv_symlink(struct nfsrv_descript *, struct nfssvc_sock *,
181 struct lwp *, struct mbuf **);
182 int nfsrv_mkdir(struct nfsrv_descript *, struct nfssvc_sock *,
183 struct lwp *, struct mbuf **);
184 int nfsrv_rmdir(struct nfsrv_descript *, struct nfssvc_sock *,
185 struct lwp *, struct mbuf **);
186 int nfsrv_readdir(struct nfsrv_descript *, struct nfssvc_sock *,
187 struct lwp *, struct mbuf **);
188 int nfsrv_readdirplus(struct nfsrv_descript *, struct nfssvc_sock *,
189 struct lwp *, struct mbuf **);
190 int nfsrv_commit(struct nfsrv_descript *, struct nfssvc_sock *,
191 struct lwp *, struct mbuf **);
192 int nfsrv_statfs(struct nfsrv_descript *, struct nfssvc_sock *,
193 struct lwp *, struct mbuf **);
194 int nfsrv_fsinfo(struct nfsrv_descript *, struct nfssvc_sock *,
195 struct lwp *, struct mbuf **);
196 int nfsrv_pathconf(struct nfsrv_descript *, struct nfssvc_sock *,
197 struct lwp *, struct mbuf **);
198 int nfsrv_null(struct nfsrv_descript *, struct nfssvc_sock *,
199 struct lwp *, struct mbuf **);
200 int nfsrv_noop(struct nfsrv_descript *, struct nfssvc_sock *,
201 struct lwp *, struct mbuf **);
202 int nfsrv_access(struct vnode *, int, kauth_cred_t, int, struct lwp *, int);
203
204 /* nfs_socket.c */
205 int nfs_connect(struct nfsmount *, struct nfsreq *, struct lwp *);
206 int nfs_reconnect(struct nfsreq *, struct lwp *);
207 void nfs_disconnect(struct nfsmount *);
208 void nfs_safedisconnect(struct nfsmount *);
209 int nfs_send(struct socket *, struct mbuf *, struct mbuf *, struct nfsreq *,
210 struct lwp *);
211 int nfs_receive(struct nfsreq *, struct mbuf **, struct mbuf **, struct lwp *);
212 int nfs_reply(struct nfsreq *, struct lwp *);
213 int nfs_request(struct nfsnode *, struct mbuf *, int, struct lwp *,
214 kauth_cred_t, struct mbuf **, struct mbuf **, caddr_t *, int *);
215 int nfs_rephead(int, struct nfsrv_descript *, struct nfssvc_sock *,
216 int, int, u_quad_t *, struct mbuf **, struct mbuf **, caddr_t *);
217 void nfs_timer(void *);
218 int nfs_sigintr(struct nfsmount *, struct nfsreq *, struct lwp *);
219 int nfs_sndlock(int *, struct nfsreq *);
220 void nfs_exit(struct proc *, void *);
221 void nfs_sndunlock(int *);
222 int nfs_rcvlock(struct nfsreq *);
223 void nfs_rcvunlock(struct nfsmount *);
224 int nfs_getreq(struct nfsrv_descript *, struct nfsd *, int);
225 int nfs_msg(struct lwp *, const char *, const char *);
226 void nfsrv_rcv(struct socket *, caddr_t, int);
227 int nfsrv_getstream(struct nfssvc_sock *, int);
228 int nfsrv_dorec(struct nfssvc_sock *, struct nfsd *, struct nfsrv_descript **);
229 void nfsrv_wakenfsd(struct nfssvc_sock *);
230 int nfsdsock_lock(struct nfssvc_sock *, boolean_t);
231 void nfsdsock_unlock(struct nfssvc_sock *);
232 int nfsdsock_drain(struct nfssvc_sock *);
233 int nfsdsock_sendreply(struct nfssvc_sock *, struct nfsrv_descript *);
234 void nfsdreq_init(void);
235 struct nfsrv_descript *nfsdreq_alloc(void);
236 void nfsdreq_free(struct nfsrv_descript *);
237
238 /* nfs_srvcache.c */
239 void nfsrv_initcache(void);
240 int nfsrv_getcache(struct nfsrv_descript *, struct nfssvc_sock *,
241 struct mbuf **);
242 void nfsrv_updatecache(struct nfsrv_descript *, int, struct mbuf *);
243 void nfsrv_cleancache(void);
244
245 /* nfs_subs.c */
246 struct mbuf *nfsm_reqh(struct nfsnode *, u_long, int, caddr_t *);
247 struct mbuf *nfsm_rpchead(kauth_cred_t, int, int, int, int, char *, int,
248 char *, struct mbuf *, int, struct mbuf **, u_int32_t *);
249 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
250 int nfsm_uiotombuf(struct uio *, struct mbuf **, int, caddr_t *);
251 int nfsm_disct(struct mbuf **, caddr_t *, int, int, caddr_t *);
252 int nfs_adv(struct mbuf **, caddr_t *, int, int);
253 int nfsm_strtmbuf(struct mbuf **, char **, const char *, long);
254 u_long nfs_dirhash(off_t);
255 void nfs_initdircache(struct vnode *);
256 void nfs_initdirxlatecookie(struct vnode *);
257 struct nfsdircache *nfs_searchdircache(struct vnode *, off_t, int, int *);
258 struct nfsdircache *nfs_enterdircache(struct vnode *, off_t, off_t, int,
259 daddr_t);
260 void nfs_putdircache(struct nfsnode *, struct nfsdircache *);
261 void nfs_invaldircache(struct vnode *, int);
262 #define NFS_INVALDIRCACHE_FORCE 1
263 #define NFS_INVALDIRCACHE_KEEPEOF 2
264 void nfs_init __P((void));
265 int nfsm_loadattrcache(struct vnode **, struct mbuf **, caddr_t *,
266 struct vattr *, int flags);
267 int nfs_loadattrcache(struct vnode **, struct nfs_fattr *, struct vattr *,
268 int flags);
269 int nfs_getattrcache(struct vnode *, struct vattr *);
270 void nfs_delayedtruncate(struct vnode *);
271 int nfs_check_wccdata(struct nfsnode *, const struct timespec *,
272 struct timespec *, boolean_t);
273 int nfs_namei(struct nameidata *, fhandle_t *, uint32_t, struct nfssvc_sock *,
274 struct mbuf *, struct mbuf **, caddr_t *, struct vnode **, struct lwp *,
275 int, int);
276 void nfs_zeropad(struct mbuf *, int, int);
277 void nfsm_srvwcc(struct nfsrv_descript *, int, struct vattr *, int,
278 struct vattr *, struct mbuf **, char **);
279 void nfsm_srvpostopattr(struct nfsrv_descript *, int, struct vattr *,
280 struct mbuf **, char **);
281 void nfsm_srvfattr(struct nfsrv_descript *, struct vattr *, struct nfs_fattr *);
282 int nfsrv_fhtovp(fhandle_t *, int, struct vnode **, kauth_cred_t,
283 struct nfssvc_sock *, struct mbuf *, int *, int, int);
284 int nfs_ispublicfh __P((fhandle_t *));
285 int netaddr_match(int, union nethostaddr *, struct mbuf *);
286
287 /* flags for nfs_loadattrcache and friends */
288 #define NAC_NOTRUNC 1 /* don't truncate file size */
289
290 void nfs_clearcommit(struct mount *);
291 void nfs_merge_commit_ranges(struct vnode *);
292 int nfs_in_committed_range(struct vnode *, off_t, off_t);
293 int nfs_in_tobecommitted_range(struct vnode *, off_t, off_t);
294 void nfs_add_committed_range(struct vnode *, off_t, off_t);
295 void nfs_del_committed_range(struct vnode *, off_t, off_t);
296 void nfs_add_tobecommitted_range(struct vnode *, off_t, off_t);
297 void nfs_del_tobecommitted_range(struct vnode *, off_t, off_t);
298
299 int nfsrv_errmap(struct nfsrv_descript *, int);
300 void nfs_cookieheuristic(struct vnode *, int *, struct lwp *, kauth_cred_t);
301
302 u_int32_t nfs_getxid(void);
303 void nfs_renewxid(struct nfsreq *);
304
305 /* nfs_syscalls.c */
306 int sys_getfh(struct lwp *, void *, register_t *);
307 int sys_nfssvc(struct lwp *, void *, register_t *);
308 int nfssvc_addsock(struct file *, struct mbuf *);
309 int nfssvc_nfsd(struct nfsd_srvargs *, caddr_t, struct lwp *);
310 void nfsrv_zapsock(struct nfssvc_sock *);
311 void nfsrv_slpderef(struct nfssvc_sock *);
312 void nfsrv_init(int);
313 int nfssvc_iod(struct lwp *);
314 void nfs_iodinit(void);
315 void start_nfsio(void *);
316 void nfs_getset_niothreads(int);
317 int nfs_getauth(struct nfsmount *, struct nfsreq *, kauth_cred_t, char **,
318 int *, char *, int *, NFSKERBKEY_T);
319 int nfs_getnickauth(struct nfsmount *, kauth_cred_t, char **, int *, char *,
320 int);
321 int nfs_savenickauth(struct nfsmount *, kauth_cred_t, int, NFSKERBKEY_T,
322 struct mbuf **, char **, struct mbuf *);
323
324 /* nfs_export.c */
325 extern struct nfs_public nfs_pub;
326 int mountd_set_exports_list(const struct mountd_exports_list *, struct lwp *);
327 int netexport_check(const fsid_t *, struct mbuf *, struct mount **, int *,
328 kauth_cred_t *);
329 void netexport_rdlock(void);
330 void netexport_rdunlock(void);
331 #ifdef COMPAT_30
332 int nfs_update_exports_30(struct mount *, const char *, void *, struct lwp *);
333 #endif
334 #endif /* _KERNEL */
335