xref: /netbsd-src/sys/nfs/nfs_var.h (revision 1ffa7b76c40339c17a0fb2a09fac93f287cfc046)
1 /*	$NetBSD: nfs_var.h,v 1.31 2003/05/03 16:28:58 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 
46 MALLOC_DECLARE(M_NFSREQ);
47 MALLOC_DECLARE(M_NFSMNT);
48 MALLOC_DECLARE(M_NFSUID);
49 MALLOC_DECLARE(M_NFSD);
50 MALLOC_DECLARE(M_NFSRVDESC);
51 MALLOC_DECLARE(M_NFSDIROFF);
52 MALLOC_DECLARE(M_NFSBIGFH);
53 MALLOC_DECLARE(M_NQLEASE);
54 #endif
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 proc *));
88 int nfs_vinvalbuf __P((struct vnode *, int, struct ucred *, struct proc *,
89 		       int));
90 int nfs_asyncio __P((struct buf *));
91 int nfs_doio __P((struct buf *, struct proc *));
92 
93 /* nfs_boot.c */
94 /* see nfsdiskless.h */
95 
96 /* nfs_kq.c */
97 void nfs_kqinit __P((void));
98 
99 /* nfs_node.c */
100 void nfs_nhinit __P((void));
101 void nfs_nhreinit __P((void));
102 void nfs_nhdone __P((void));
103 int nfs_nget __P((struct mount *, nfsfh_t *, int, struct nfsnode **));
104 
105 /* nfs_vnops.c */
106 int nfs_null __P((struct vnode *, struct ucred *, struct proc *));
107 int nfs_setattrrpc __P((struct vnode *, struct vattr *, struct ucred *,
108 			struct proc *));
109 int nfs_readlinkrpc __P((struct vnode *, struct uio *, struct ucred *));
110 int nfs_readrpc __P((struct vnode *, struct uio *));
111 int nfs_writerpc __P((struct vnode *, struct uio *, int *, boolean_t *));
112 int nfs_mknodrpc __P((struct vnode *, struct vnode **, struct componentname *,
113 		      struct vattr *));
114 int nfs_removeit __P((struct sillyrename *));
115 int nfs_removerpc __P((struct vnode *, const char *, int, struct ucred *,
116 		       struct proc *));
117 int nfs_renameit __P((struct vnode *, struct componentname *,
118 		      struct sillyrename *));
119 int nfs_renamerpc __P((struct vnode *, const char *, int, struct vnode *,
120 		       const char *, int, struct ucred *, struct proc *));
121 int nfs_readdirrpc __P((struct vnode *, struct uio *, struct ucred *));
122 int nfs_readdirplusrpc __P((struct vnode *, struct uio *, struct ucred *));
123 int nfs_sillyrename __P((struct vnode *, struct vnode *,
124 			 struct componentname *));
125 int nfs_lookitup __P((struct vnode *, const char *, int, struct ucred *,
126 		      struct proc *, struct nfsnode **));
127 int nfs_commit __P((struct vnode *, off_t, uint32_t, struct proc *));
128 int nfs_flush __P((struct vnode *, struct ucred *, int, struct proc *, int));
129 
130 /* nfs_nqlease.c */
131 void nqnfs_lease_updatetime __P((int));
132 void nqnfs_clientlease __P((struct nfsmount *, struct nfsnode *, int, int,
133 			    time_t, u_quad_t));
134 void nqsrv_locklease __P((struct nqlease *));
135 void nqsrv_unlocklease __P((struct nqlease *));
136 int nqsrv_getlease __P((struct vnode *, u_int32_t *, int, struct nfssvc_sock *,
137 			struct proc *, struct mbuf *, int *, u_quad_t *,
138 			struct ucred *));
139 void nqsrv_addhost __P((struct nqhost *, struct nfssvc_sock *, struct mbuf *));
140 void nqsrv_instimeq __P((struct nqlease *, u_int32_t));
141 int nqsrv_cmpnam __P((struct nfssvc_sock *, struct mbuf *, struct nqhost *));
142 void nqsrv_send_eviction __P((struct vnode *, struct nqlease *,
143 			      struct nfssvc_sock *, struct mbuf *,
144 			      struct ucred *));
145 void nqsrv_waitfor_expiry __P((struct nqlease *));
146 void nqnfs_serverd __P((void));
147 int nqnfsrv_getlease __P((struct nfsrv_descript *, struct nfssvc_sock *,
148 			  struct proc *, struct mbuf **));
149 int nqnfsrv_vacated __P((struct nfsrv_descript *, struct nfssvc_sock *,
150 			 struct proc *, struct mbuf **));
151 int nqnfs_getlease __P((struct vnode *, int, struct ucred *, struct proc *));
152 int nqnfs_vacated __P((struct vnode *, struct ucred *));
153 int nqnfs_callback __P((struct nfsmount *, struct mbuf *, struct mbuf *,
154 			caddr_t));
155 
156 /* nfs_serv.c */
157 int nfsrv3_access __P((struct nfsrv_descript *, struct nfssvc_sock *,
158 		       struct proc *, struct mbuf **));
159 int nfsrv_getattr __P((struct nfsrv_descript *, struct nfssvc_sock *,
160 		       struct proc *, struct mbuf **));
161 int nfsrv_setattr __P((struct nfsrv_descript *, struct nfssvc_sock *,
162 		       struct proc *, struct mbuf **));
163 int nfsrv_lookup __P((struct nfsrv_descript *, struct nfssvc_sock *,
164 		      struct proc *, struct mbuf **));
165 int nfsrv_readlink __P((struct nfsrv_descript *, struct nfssvc_sock *,
166 			struct proc *, struct mbuf **));
167 int nfsrv_read __P((struct nfsrv_descript *, struct nfssvc_sock *,
168 		    struct proc *, struct mbuf **));
169 int nfsrv_write __P((struct nfsrv_descript *, struct nfssvc_sock *,
170 		     struct proc *, struct mbuf **));
171 int nfsrv_writegather __P((struct nfsrv_descript **, struct nfssvc_sock *,
172 			   struct proc *, struct mbuf **));
173 void nfsrvw_coalesce __P((struct nfsrv_descript *, struct nfsrv_descript *));
174 int nfsrv_create __P((struct nfsrv_descript *, struct nfssvc_sock *,
175 		      struct proc *, struct mbuf **));
176 int nfsrv_mknod __P((struct nfsrv_descript *, struct nfssvc_sock *,
177 		     struct proc *, struct mbuf **));
178 int nfsrv_remove __P((struct nfsrv_descript *, struct nfssvc_sock *,
179 		      struct proc *, struct mbuf **));
180 int nfsrv_rename __P((struct nfsrv_descript *, struct nfssvc_sock *,
181 		      struct proc *, struct mbuf **));
182 int nfsrv_link __P((struct nfsrv_descript *, struct nfssvc_sock *,
183 		    struct proc *, struct mbuf **));
184 int nfsrv_symlink __P((struct nfsrv_descript *, struct nfssvc_sock *,
185 		       struct proc *, struct mbuf **));
186 int nfsrv_mkdir __P((struct nfsrv_descript *, struct nfssvc_sock *,
187 		     struct proc *, struct mbuf **));
188 int nfsrv_rmdir __P((struct nfsrv_descript *, struct nfssvc_sock *,
189 		     struct proc *, struct mbuf **));
190 int nfsrv_readdir __P((struct nfsrv_descript *, struct nfssvc_sock *,
191 		       struct proc *, struct mbuf **));
192 int nfsrv_readdirplus __P((struct nfsrv_descript *, struct nfssvc_sock *,
193 			   struct proc *, struct mbuf **));
194 int nfsrv_commit __P((struct nfsrv_descript *, struct nfssvc_sock *,
195 		      struct proc *, struct mbuf **));
196 int nfsrv_statfs __P((struct nfsrv_descript *, struct nfssvc_sock *,
197 		      struct proc *, struct mbuf **));
198 int nfsrv_fsinfo __P((struct nfsrv_descript *, struct nfssvc_sock *,
199 		      struct proc *, struct mbuf **));
200 int nfsrv_pathconf __P((struct nfsrv_descript *, struct nfssvc_sock *,
201 		        struct proc *, struct mbuf **));
202 int nfsrv_null __P((struct nfsrv_descript *, struct nfssvc_sock *,
203 		    struct proc *, struct mbuf **));
204 int nfsrv_noop __P((struct nfsrv_descript *, struct nfssvc_sock *,
205 		    struct proc *, struct mbuf **));
206 int nfsrv_access __P((struct vnode *, int, struct ucred *, int, struct proc *,
207 		      int));
208 
209 /* nfs_socket.c */
210 int nfs_connect __P((struct nfsmount *, struct nfsreq *));
211 int nfs_reconnect __P((struct nfsreq *));
212 void nfs_disconnect __P((struct nfsmount *));
213 void nfs_safedisconnect __P((struct nfsmount *));
214 int nfs_send __P((struct socket *, struct mbuf *, struct mbuf *,
215 		  struct nfsreq *));
216 int nfs_receive __P((struct nfsreq *, struct mbuf **, struct mbuf **));
217 int nfs_reply __P((struct nfsreq *));
218 int nfs_request __P((struct nfsnode *, struct mbuf *, int, struct proc *,
219 		     struct ucred *, struct mbuf **, struct mbuf **,
220 		     caddr_t *));
221 int nfs_rephead __P((int, struct nfsrv_descript *, struct nfssvc_sock *,
222 		     int, int, u_quad_t *, struct mbuf **, struct mbuf **,			     caddr_t *));
223 void nfs_timer __P((void *));
224 int nfs_sigintr __P((struct nfsmount *, struct nfsreq *, struct proc *));
225 int nfs_sndlock __P((int *, struct nfsreq *));
226 void nfs_exit __P((struct proc *, void *));
227 void nfs_sndunlock __P((int *));
228 int nfs_rcvlock __P((struct nfsreq *));
229 void nfs_rcvunlock __P((int *));
230 int nfs_getreq __P((struct nfsrv_descript *, struct nfsd *, int));
231 int nfs_msg __P((struct proc *, char *, char *));
232 void nfsrv_rcv __P((struct socket *, caddr_t, int));
233 int nfsrv_getstream __P((struct nfssvc_sock *, int));
234 int nfsrv_dorec __P((struct nfssvc_sock *, struct nfsd *,
235 		     struct nfsrv_descript **));
236 void nfsrv_wakenfsd __P((struct nfssvc_sock *));
237 
238 /* nfs_srvcache.c */
239 void nfsrv_initcache __P((void ));
240 int nfsrv_getcache __P((struct nfsrv_descript *, struct nfssvc_sock *,
241 			struct mbuf **));
242 void nfsrv_updatecache __P((struct nfsrv_descript *, int, struct mbuf *));
243 void nfsrv_cleancache __P((void));
244 
245 /* nfs_subs.c */
246 struct mbuf *nfsm_reqh __P((struct nfsnode *, u_long, int, caddr_t *));
247 struct mbuf *nfsm_rpchead __P((struct ucred *, int, int, int, int, char *, int,
248 			       char *, struct mbuf *, int, struct mbuf **,
249 			       u_int32_t *));
250 int nfsm_mbuftouio __P((struct mbuf **, struct uio *, int, caddr_t *));
251 int nfsm_uiotombuf __P((struct uio *, struct mbuf **, int, caddr_t *));
252 int nfsm_disct __P((struct mbuf **, caddr_t *, int, int, caddr_t *));
253 int nfs_adv __P((struct mbuf **, caddr_t *, int, int));
254 int nfsm_strtmbuf __P((struct mbuf **, char **, const char *, long));
255 u_long nfs_dirhash __P((off_t));
256 void nfs_initdircache __P((struct vnode *));
257 struct nfsdircache *nfs_searchdircache __P((struct vnode *, off_t, int, int *));
258 struct nfsdircache *nfs_enterdircache __P((struct vnode *, off_t, off_t,						   int, daddr_t));
259 void nfs_invaldircache __P((struct vnode *, int));
260 void nfs_init __P((void));
261 int nfsm_loadattrcache __P((struct vnode **, struct mbuf **, caddr_t *,
262 			   struct vattr *, int flags));
263 int nfs_loadattrcache __P((struct vnode **, struct nfs_fattr *,
264 			   struct vattr *, int flags));
265 int nfs_getattrcache __P((struct vnode *, struct vattr *));
266 void nfs_delayedtruncate __P((struct vnode *));
267 int nfs_namei __P((struct nameidata *, fhandle_t *, uint32_t,
268 		   struct nfssvc_sock *, struct mbuf *, struct mbuf **,
269 		   caddr_t *, struct vnode **, struct proc *, int, int));
270 void nfsm_adj __P((struct mbuf *, int, int));
271 void nfsm_srvwcc __P((struct nfsrv_descript *, int, struct vattr *, int,
272 		      struct vattr *, struct mbuf **, char **));
273 void nfsm_srvpostopattr __P((struct nfsrv_descript *, int, struct vattr *,
274 			     struct mbuf **, char **));
275 void nfsm_srvfattr __P((struct nfsrv_descript *, struct vattr *,
276 			struct nfs_fattr *));
277 int nfsrv_fhtovp __P((fhandle_t *, int, struct vnode **, struct ucred *,
278 		      struct nfssvc_sock *, struct mbuf *, int *, int, int));
279 int nfsrv_setpublicfs __P((struct mount *, struct netexport *,
280 			   struct export_args *));
281 int nfs_ispublicfh __P((fhandle_t *));
282 int netaddr_match __P((int, union nethostaddr *, struct mbuf *));
283 
284 /* flags for nfs_loadattrcache and friends */
285 #define	NAC_NOTRUNC	1	/* don't truncate file size */
286 
287 void nfs_clearcommit __P((struct mount *));
288 void nfs_merge_commit_ranges __P((struct vnode *));
289 int nfs_in_committed_range __P((struct vnode *, off_t, off_t));
290 int nfs_in_tobecommitted_range __P((struct vnode *, off_t, off_t));
291 void nfs_add_committed_range __P((struct vnode *, off_t, off_t));
292 void nfs_del_committed_range __P((struct vnode *, off_t, off_t));
293 void nfs_add_tobecommitted_range __P((struct vnode *, off_t, off_t));
294 void nfs_del_tobecommitted_range __P((struct vnode *, off_t, off_t));
295 
296 int nfsrv_errmap __P((struct nfsrv_descript *, int));
297 void nfsrvw_sort __P((gid_t *, int));
298 void nfsrv_setcred __P((struct ucred *, struct ucred *));
299 void nfs_cookieheuristic __P((struct vnode *, int *, struct proc *,
300 			      struct ucred *));
301 
302 /* nfs_syscalls.c */
303 int sys_getfh __P((struct lwp *, void *, register_t *));
304 int sys_nfssvc __P((struct lwp *, void *, register_t *));
305 int nfssvc_addsock __P((struct file *, struct mbuf *));
306 int nfssvc_nfsd __P((struct nfsd_srvargs *, caddr_t, struct lwp *));
307 void nfsrv_zapsock __P((struct nfssvc_sock *));
308 void nfsrv_slpderef __P((struct nfssvc_sock *));
309 void nfsrv_init __P((int));
310 int nfssvc_iod __P((struct lwp *));
311 void start_nfsio __P((void *));
312 void nfs_getset_niothreads __P((int));
313 int nfs_getauth __P((struct nfsmount *, struct nfsreq *, struct ucred *,
314 		     char **, int *, char *, int *, NFSKERBKEY_T));
315 int nfs_getnickauth __P((struct nfsmount *, struct ucred *, char **, int *,
316 			 char *, int));
317 int nfs_savenickauth __P((struct nfsmount *, struct ucred *, int, NFSKERBKEY_T,
318 			  struct mbuf **, char **, struct mbuf *));
319