xref: /netbsd-src/sys/nfs/nfs_var.h (revision e5548b402ae4c44fb816de42c7bba9581ce23ef5)
1 /*	$NetBSD: nfs_var.h,v 1.55 2005/12/11 12:25:17 christos 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 extern struct pool nfs_srvdesc_pool;
55 
56 struct vnode;
57 struct uio;
58 struct ucred;
59 struct proc;
60 struct buf;
61 struct nfs_diskless;
62 struct sockaddr_in;
63 struct nfs_dlmount;
64 struct vnode;
65 struct nfsd;
66 struct mbuf;
67 struct file;
68 struct nqlease;
69 struct nqhost;
70 struct nfssvc_sock;
71 struct nfsmount;
72 struct socket;
73 struct nfsreq;
74 struct vattr;
75 struct nameidata;
76 struct nfsnode;
77 struct sillyrename;
78 struct componentname;
79 struct nfsd_srvargs;
80 struct nfsrv_descript;
81 struct nfs_fattr;
82 struct nfsdircache;
83 union nethostaddr;
84 
85 /* nfs_bio.c */
86 int nfs_bioread __P((struct vnode *, struct uio *, int, struct ucred *, int));
87 struct buf *nfs_getcacheblk __P((struct vnode *, daddr_t, int, struct lwp *));
88 int nfs_vinvalbuf __P((struct vnode *, int, struct ucred *, struct lwp *,
89 		       int));
90 int nfs_flushstalebuf __P((struct vnode *, struct ucred *, struct lwp *, int));
91 #define	NFS_FLUSHSTALEBUF_MYWRITE	1	/* assume writes are ours */
92 int nfs_asyncio __P((struct buf *));
93 int nfs_doio __P((struct buf *));
94 
95 /* nfs_boot.c */
96 /* see nfsdiskless.h */
97 
98 /* nfs_kq.c */
99 void nfs_kqinit __P((void));
100 
101 /* nfs_node.c */
102 void nfs_nhinit __P((void));
103 void nfs_nhreinit __P((void));
104 void nfs_nhdone __P((void));
105 int nfs_nget1 __P((struct mount *, nfsfh_t *, int, struct nfsnode **, int));
106 #define	nfs_nget(mp, fhp, fhsize, npp) \
107 	nfs_nget1((mp), (fhp), (fhsize), (npp), 0)
108 
109 /* nfs_vnops.c */
110 int nfs_null __P((struct vnode *, struct ucred *, struct lwp *));
111 int nfs_setattrrpc __P((struct vnode *, struct vattr *, struct ucred *,
112 			struct lwp *));
113 int nfs_readlinkrpc __P((struct vnode *, struct uio *, struct ucred *));
114 int nfs_readrpc __P((struct vnode *, struct uio *));
115 int nfs_writerpc __P((struct vnode *, struct uio *, int *, boolean_t,
116 			boolean_t *));
117 int nfs_mknodrpc __P((struct vnode *, struct vnode **, struct componentname *,
118 		      struct vattr *));
119 int nfs_removeit __P((struct sillyrename *));
120 int nfs_removerpc __P((struct vnode *, const char *, int, struct ucred *,
121 		       struct lwp *));
122 int nfs_renameit __P((struct vnode *, struct componentname *,
123 		      struct sillyrename *));
124 int nfs_renamerpc __P((struct vnode *, const char *, int, struct vnode *,
125 		       const char *, int, struct ucred *, struct lwp *));
126 int nfs_readdirrpc __P((struct vnode *, struct uio *, struct ucred *));
127 int nfs_readdirplusrpc __P((struct vnode *, struct uio *, struct ucred *));
128 int nfs_sillyrename __P((struct vnode *, struct vnode *,
129 			 struct componentname *));
130 int nfs_lookitup __P((struct vnode *, const char *, int, struct ucred *,
131 		      struct lwp *, struct nfsnode **));
132 int nfs_commit __P((struct vnode *, off_t, uint32_t, struct lwp *));
133 int nfs_flush __P((struct vnode *, struct ucred *, int, struct lwp *, int));
134 
135 /* nfs_nqlease.c */
136 void nqnfs_lease_updatetime __P((int));
137 void nqnfs_clientlease __P((struct nfsmount *, struct nfsnode *, int, int,
138 			    time_t, u_quad_t));
139 void nqsrv_locklease __P((struct nqlease *));
140 void nqsrv_unlocklease __P((struct nqlease *));
141 int nqsrv_getlease __P((struct vnode *, u_int32_t *, int, struct nfssvc_sock *,
142 			struct lwp *, struct mbuf *, int *, u_quad_t *,
143 			struct ucred *));
144 void nqsrv_addhost __P((struct nqhost *, struct nfssvc_sock *, struct mbuf *));
145 void nqsrv_instimeq __P((struct nqlease *, u_int32_t));
146 int nqsrv_cmpnam __P((struct nfssvc_sock *, struct mbuf *, struct nqhost *));
147 void nqsrv_send_eviction __P((struct vnode *, struct nqlease *,
148 			      struct nfssvc_sock *, struct mbuf *,
149 			      struct ucred *, struct lwp *));
150 void nqsrv_waitfor_expiry __P((struct nqlease *));
151 void nqnfs_serverd __P((void));
152 int nqnfsrv_getlease __P((struct nfsrv_descript *, struct nfssvc_sock *,
153 			  struct lwp *, struct mbuf **));
154 int nqnfsrv_vacated __P((struct nfsrv_descript *, struct nfssvc_sock *,
155 			 struct lwp *, struct mbuf **));
156 int nqnfs_getlease __P((struct vnode *, int, struct ucred *, struct lwp *));
157 int nqnfs_vacated __P((struct vnode *, struct ucred *, struct lwp *));
158 int nqnfs_callback __P((struct nfsmount *, struct mbuf *, struct mbuf *,
159 			caddr_t, struct lwp *));
160 
161 /* nfs_serv.c */
162 int nfsrv3_access __P((struct nfsrv_descript *, struct nfssvc_sock *,
163 		       struct lwp *, struct mbuf **));
164 int nfsrv_getattr __P((struct nfsrv_descript *, struct nfssvc_sock *,
165 		       struct lwp *, struct mbuf **));
166 int nfsrv_setattr __P((struct nfsrv_descript *, struct nfssvc_sock *,
167 		       struct lwp *, struct mbuf **));
168 int nfsrv_lookup __P((struct nfsrv_descript *, struct nfssvc_sock *,
169 		      struct lwp *, struct mbuf **));
170 int nfsrv_readlink __P((struct nfsrv_descript *, struct nfssvc_sock *,
171 			struct lwp *, struct mbuf **));
172 int nfsrv_read __P((struct nfsrv_descript *, struct nfssvc_sock *,
173 		    struct lwp *, struct mbuf **));
174 int nfsrv_write __P((struct nfsrv_descript *, struct nfssvc_sock *,
175 		     struct lwp *, struct mbuf **));
176 int nfsrv_writegather __P((struct nfsrv_descript **, struct nfssvc_sock *,
177 			   struct lwp *, struct mbuf **));
178 void nfsrvw_coalesce __P((struct nfsrv_descript *, struct nfsrv_descript *));
179 int nfsrv_create __P((struct nfsrv_descript *, struct nfssvc_sock *,
180 		      struct lwp *, struct mbuf **));
181 int nfsrv_mknod __P((struct nfsrv_descript *, struct nfssvc_sock *,
182 		     struct lwp *, struct mbuf **));
183 int nfsrv_remove __P((struct nfsrv_descript *, struct nfssvc_sock *,
184 		      struct lwp *, struct mbuf **));
185 int nfsrv_rename __P((struct nfsrv_descript *, struct nfssvc_sock *,
186 		      struct lwp *, struct mbuf **));
187 int nfsrv_link __P((struct nfsrv_descript *, struct nfssvc_sock *,
188 		    struct lwp *, struct mbuf **));
189 int nfsrv_symlink __P((struct nfsrv_descript *, struct nfssvc_sock *,
190 		       struct lwp *, struct mbuf **));
191 int nfsrv_mkdir __P((struct nfsrv_descript *, struct nfssvc_sock *,
192 		     struct lwp *, struct mbuf **));
193 int nfsrv_rmdir __P((struct nfsrv_descript *, struct nfssvc_sock *,
194 		     struct lwp *, struct mbuf **));
195 int nfsrv_readdir __P((struct nfsrv_descript *, struct nfssvc_sock *,
196 		       struct lwp *, struct mbuf **));
197 int nfsrv_readdirplus __P((struct nfsrv_descript *, struct nfssvc_sock *,
198 			   struct lwp *, struct mbuf **));
199 int nfsrv_commit __P((struct nfsrv_descript *, struct nfssvc_sock *,
200 		      struct lwp *, struct mbuf **));
201 int nfsrv_statfs __P((struct nfsrv_descript *, struct nfssvc_sock *,
202 		      struct lwp *, struct mbuf **));
203 int nfsrv_fsinfo __P((struct nfsrv_descript *, struct nfssvc_sock *,
204 		      struct lwp *, struct mbuf **));
205 int nfsrv_pathconf __P((struct nfsrv_descript *, struct nfssvc_sock *,
206 		        struct lwp *, struct mbuf **));
207 int nfsrv_null __P((struct nfsrv_descript *, struct nfssvc_sock *,
208 		    struct lwp *, struct mbuf **));
209 int nfsrv_noop __P((struct nfsrv_descript *, struct nfssvc_sock *,
210 		    struct lwp *, struct mbuf **));
211 int nfsrv_access __P((struct vnode *, int, struct ucred *, int, struct lwp *,
212 		      int));
213 
214 /* nfs_socket.c */
215 int nfs_connect __P((struct nfsmount *, struct nfsreq *, struct lwp *));
216 int nfs_reconnect __P((struct nfsreq *, struct lwp *));
217 void nfs_disconnect __P((struct nfsmount *));
218 void nfs_safedisconnect __P((struct nfsmount *));
219 int nfs_send __P((struct socket *, struct mbuf *, struct mbuf *,
220 		  struct nfsreq *, struct lwp *));
221 int nfs_receive __P((struct nfsreq *, struct mbuf **, struct mbuf **,
222 		     struct lwp *));
223 int nfs_reply __P((struct nfsreq *, struct lwp *));
224 int nfs_request __P((struct nfsnode *, struct mbuf *, int, struct lwp *,
225 		     struct ucred *, struct mbuf **, struct mbuf **,
226 		     caddr_t *, int *));
227 int nfs_rephead __P((int, struct nfsrv_descript *, struct nfssvc_sock *,
228 		     int, int, u_quad_t *, struct mbuf **, struct mbuf **,			     caddr_t *));
229 void nfs_timer __P((void *));
230 int nfs_sigintr __P((struct nfsmount *, struct nfsreq *, struct lwp *));
231 int nfs_sndlock __P((int *, struct nfsreq *));
232 void nfs_exit __P((struct proc *, void *));
233 void nfs_sndunlock __P((int *));
234 int nfs_rcvlock __P((struct nfsreq *));
235 void nfs_rcvunlock __P((struct nfsmount *));
236 int nfs_getreq __P((struct nfsrv_descript *, struct nfsd *, int));
237 int nfs_msg __P((struct lwp *, const char *, const char *));
238 void nfsrv_rcv __P((struct socket *, caddr_t, int));
239 int nfsrv_getstream __P((struct nfssvc_sock *, int));
240 int nfsrv_dorec __P((struct nfssvc_sock *, struct nfsd *,
241 		     struct nfsrv_descript **));
242 void nfsrv_wakenfsd __P((struct nfssvc_sock *));
243 
244 /* nfs_srvcache.c */
245 void nfsrv_initcache __P((void ));
246 int nfsrv_getcache __P((struct nfsrv_descript *, struct nfssvc_sock *,
247 			struct mbuf **));
248 void nfsrv_updatecache __P((struct nfsrv_descript *, int, struct mbuf *));
249 void nfsrv_cleancache __P((void));
250 
251 /* nfs_subs.c */
252 struct mbuf *nfsm_reqh __P((struct nfsnode *, u_long, int, caddr_t *));
253 struct mbuf *nfsm_rpchead __P((struct ucred *, int, int, int, int, char *, int,
254 			       char *, struct mbuf *, int, struct mbuf **,
255 			       u_int32_t *));
256 int nfsm_mbuftouio __P((struct mbuf **, struct uio *, int, caddr_t *));
257 int nfsm_uiotombuf __P((struct uio *, struct mbuf **, int, caddr_t *));
258 int nfsm_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
259 int nfs_adv __P((struct mbuf **, caddr_t *, int, int));
260 int nfsm_strtmbuf __P((struct mbuf **, char **, const char *, long));
261 u_long nfs_dirhash __P((off_t));
262 void nfs_initdircache __P((struct vnode *));
263 void nfs_initdirxlatecookie __P((struct vnode *));
264 struct nfsdircache *nfs_searchdircache __P((struct vnode *, off_t, int, int *));
265 struct nfsdircache *nfs_enterdircache __P((struct vnode *, off_t, off_t,						   int, daddr_t));
266 void nfs_putdircache __P((struct nfsnode *, struct nfsdircache *));
267 void nfs_invaldircache __P((struct vnode *, int));
268 #define	NFS_INVALDIRCACHE_FORCE		1
269 #define	NFS_INVALDIRCACHE_KEEPEOF	2
270 void nfs_init __P((void));
271 int nfsm_loadattrcache __P((struct vnode **, struct mbuf **, caddr_t *,
272 			   struct vattr *, int flags));
273 int nfs_loadattrcache __P((struct vnode **, struct nfs_fattr *,
274 			   struct vattr *, int flags));
275 int nfs_getattrcache __P((struct vnode *, struct vattr *));
276 void nfs_delayedtruncate __P((struct vnode *));
277 int nfs_check_wccdata __P((struct nfsnode *, const struct timespec *,
278     struct timespec *, boolean_t));
279 int nfs_namei __P((struct nameidata *, fhandle_t *, uint32_t,
280 		   struct nfssvc_sock *, struct mbuf *, struct mbuf **,
281 		   caddr_t *, struct vnode **, struct lwp *, int, int));
282 void nfs_zeropad __P((struct mbuf *, int, int));
283 void nfsm_srvwcc __P((struct nfsrv_descript *, int, struct vattr *, int,
284 		      struct vattr *, struct mbuf **, char **));
285 void nfsm_srvpostopattr __P((struct nfsrv_descript *, int, struct vattr *,
286 			     struct mbuf **, char **));
287 void nfsm_srvfattr __P((struct nfsrv_descript *, struct vattr *,
288 			struct nfs_fattr *));
289 int nfsrv_fhtovp __P((fhandle_t *, int, struct vnode **, struct ucred *,
290 		      struct nfssvc_sock *, struct mbuf *, int *, int, int));
291 int nfs_ispublicfh __P((fhandle_t *));
292 int netaddr_match __P((int, union nethostaddr *, struct mbuf *));
293 
294 /* flags for nfs_loadattrcache and friends */
295 #define	NAC_NOTRUNC	1	/* don't truncate file size */
296 
297 void nfs_clearcommit __P((struct mount *));
298 void nfs_merge_commit_ranges __P((struct vnode *));
299 int nfs_in_committed_range __P((struct vnode *, off_t, off_t));
300 int nfs_in_tobecommitted_range __P((struct vnode *, off_t, off_t));
301 void nfs_add_committed_range __P((struct vnode *, off_t, off_t));
302 void nfs_del_committed_range __P((struct vnode *, off_t, off_t));
303 void nfs_add_tobecommitted_range __P((struct vnode *, off_t, off_t));
304 void nfs_del_tobecommitted_range __P((struct vnode *, off_t, off_t));
305 
306 int nfsrv_errmap __P((struct nfsrv_descript *, int));
307 void nfsrvw_sort __P((gid_t *, int));
308 void nfsrv_setcred __P((struct ucred *, struct ucred *));
309 void nfs_cookieheuristic __P((struct vnode *, int *, struct lwp *,
310 			      struct ucred *));
311 
312 u_int32_t nfs_getxid __P((void));
313 void nfs_renewxid __P((struct nfsreq *));
314 
315 /* nfs_syscalls.c */
316 int sys_getfh __P((struct lwp *, void *, register_t *));
317 int sys_nfssvc __P((struct lwp *, void *, register_t *));
318 int nfssvc_addsock __P((struct file *, struct mbuf *));
319 int nfssvc_nfsd __P((struct nfsd_srvargs *, caddr_t, struct lwp *));
320 void nfsrv_zapsock __P((struct nfssvc_sock *));
321 void nfsrv_slpderef __P((struct nfssvc_sock *));
322 void nfsrv_init __P((int));
323 int nfssvc_iod __P((struct lwp *));
324 void nfs_iodinit __P((void));
325 void start_nfsio __P((void *));
326 void nfs_getset_niothreads __P((int));
327 int nfs_getauth __P((struct nfsmount *, struct nfsreq *, struct ucred *,
328 		     char **, int *, char *, int *, NFSKERBKEY_T));
329 int nfs_getnickauth __P((struct nfsmount *, struct ucred *, char **, int *,
330 			 char *, int));
331 int nfs_savenickauth __P((struct nfsmount *, struct ucred *, int, NFSKERBKEY_T,
332 			  struct mbuf **, char **, struct mbuf *));
333 
334 /* nfs_export.c */
335 extern struct nfs_public nfs_pub;
336 int mountd_set_exports_list(const struct mountd_exports_list *, struct lwp *);
337 int netexport_check(const fsid_t *, struct mbuf *, struct mount **, int *,
338     struct ucred **);
339 #ifdef COMPAT_30
340 int nfs_update_exports_30(struct mount *, const char *, void *, struct lwp *);
341 #endif
342 #endif /* _KERNEL */
343