xref: /openbsd/sys/nfs/nfs_var.h (revision 9b7c3dbb)
1 /*	$OpenBSD: nfs_var.h,v 1.61 2016/04/29 14:40:36 beck Exp $	*/
2 /*	$NetBSD: nfs_var.h,v 1.3 1996/02/18 11:53:54 fvdl Exp $	*/
3 
4 /*
5  * Copyright (c) 1996 Christos Zoulas.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Christos Zoulas.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * XXX needs <nfs/rpcv2.h> and <nfs/nfs.h> because of typedefs.
35  */
36 #ifndef _NFS_NFS_VAR_H_
37 #define _NFS_NFS_VAR_H_
38 
39 #ifdef _KERNEL
40 
41 struct nfsnode;
42 struct sillyrename;
43 struct componentname;
44 struct nfs_diskless;
45 struct nfsm_info;
46 
47 /* nfs_bio.c */
48 int nfs_bioread(struct vnode *, struct uio *, int, struct ucred *);
49 int nfs_write(void *);
50 struct buf *nfs_getcacheblk(struct vnode *, daddr_t, int, struct proc *);
51 int nfs_vinvalbuf(struct vnode *, int, struct ucred *, struct proc *);
52 int nfs_asyncio(struct buf *, int readahead);
53 int nfs_doio(struct buf *, struct proc *);
54 
55 /* nfs_boot.c */
56 int nfs_boot_init(struct nfs_diskless *, struct proc *);
57 
58 /* nfs_node.c */
59 int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **);
60 int nfs_inactive(void *);
61 int nfs_reclaim(void *);
62 
63 /* nfs_vnops.c */
64 int nfs_poll(void *);
65 int nfs_null(struct vnode *, struct ucred *, struct proc *);
66 int nfs_access(void *);
67 int nfs_open(void *);
68 int nfs_close(void *);
69 int nfs_getattr(void *);
70 int nfs_setattr(void *);
71 int nfs_setattrrpc(struct vnode *, struct vattr *, struct ucred *,
72 			struct proc *);
73 int nfs_lookup(void *);
74 int nfs_read(void *);
75 int nfs_readlink(void *);
76 int nfs_readlinkrpc(struct vnode *, struct uio *, struct ucred *);
77 int nfs_readrpc(struct vnode *, struct uio *);
78 int nfs_writerpc(struct vnode *, struct uio *, int *, int *);
79 int nfs_mknodrpc(struct vnode *, struct vnode **, struct componentname *,
80 		      struct vattr *);
81 int nfs_mknod(void *);
82 int nfs_create(void *);
83 int nfs_remove(void *);
84 int nfs_removeit(struct sillyrename *);
85 int nfs_removerpc(struct vnode *, char *, int, struct ucred *,
86 		       struct proc *);
87 int nfs_rename(void *);
88 int nfs_renameit(struct vnode *, struct componentname *,
89 		      struct sillyrename *);
90 int nfs_renamerpc(struct vnode *, char *, int, struct vnode *, char *, int,
91 		       struct ucred *, struct proc *);
92 int nfs_link(void *);
93 int nfs_symlink(void *);
94 int nfs_mkdir(void *);
95 int nfs_rmdir(void *);
96 int nfs_readdir(void *);
97 int nfs_readdirrpc(struct vnode *, struct uio *, struct ucred *, int *);
98 int nfs_readdirplusrpc(struct vnode *, struct uio *, struct ucred *, int *,
99     struct proc *);
100 int nfs_sillyrename(struct vnode *, struct vnode *,
101 			 struct componentname *);
102 int nfs_lookitup(struct vnode *, char *, int, struct ucred *,
103 		      struct proc *, struct nfsnode **);
104 int nfs_commit(struct vnode *, u_quad_t, int, struct proc *);
105 int nfs_bmap(void *);
106 int nfs_strategy(void *);
107 int nfs_mmap(void *);
108 int nfs_fsync(void *);
109 int nfs_flush(struct vnode *, struct ucred *, int, struct proc *, int);
110 int nfs_pathconf(void *);
111 int nfs_advlock(void *);
112 int nfs_print(void *);
113 int nfs_blkatoff(void *);
114 int nfs_bwrite(void *);
115 int nfs_writebp(struct buf *, int);
116 int nfsspec_access(void *);
117 int nfsspec_read(void *);
118 int nfsspec_write(void *);
119 int nfsspec_close(void *);
120 int nfsfifo_read(void *);
121 int nfsfifo_write(void *);
122 int nfsfifo_close(void *);
123 int nfsfifo_reclaim(void *);
124 
125 #define	nfs_ioctl	((int (*)(void *))enoioctl)
126 
127 /* nfs_serv.c */
128 int nfsrv3_access(struct nfsrv_descript *, struct nfssvc_sock *,
129 		       struct proc *, struct mbuf **);
130 int nfsrv_getattr(struct nfsrv_descript *, struct nfssvc_sock *,
131 		       struct proc *, struct mbuf **);
132 int nfsrv_setattr(struct nfsrv_descript *, struct nfssvc_sock *,
133 		       struct proc *, struct mbuf **);
134 int nfsrv_lookup(struct nfsrv_descript *, struct nfssvc_sock *,
135 		      struct proc *, struct mbuf **);
136 int nfsrv_readlink(struct nfsrv_descript *, struct nfssvc_sock *,
137 			struct proc *, struct mbuf **);
138 int nfsrv_read(struct nfsrv_descript *, struct nfssvc_sock *,
139 		    struct proc *, struct mbuf **);
140 int nfsrv_write(struct nfsrv_descript *, struct nfssvc_sock *,
141 		     struct proc *, struct mbuf **);
142 int nfsrv_create(struct nfsrv_descript *, struct nfssvc_sock *,
143 		      struct proc *, struct mbuf **);
144 int nfsrv_mknod(struct nfsrv_descript *, struct nfssvc_sock *,
145 		     struct proc *, struct mbuf **);
146 int nfsrv_remove(struct nfsrv_descript *, struct nfssvc_sock *,
147 		      struct proc *, struct mbuf **);
148 int nfsrv_rename(struct nfsrv_descript *, struct nfssvc_sock *,
149 		      struct proc *, struct mbuf **);
150 int nfsrv_link(struct nfsrv_descript *, struct nfssvc_sock *,
151 		    struct proc *, struct mbuf **);
152 int nfsrv_symlink(struct nfsrv_descript *, struct nfssvc_sock *,
153 		       struct proc *, struct mbuf **);
154 int nfsrv_mkdir(struct nfsrv_descript *, struct nfssvc_sock *,
155 		     struct proc *, struct mbuf **);
156 int nfsrv_rmdir(struct nfsrv_descript *, struct nfssvc_sock *,
157 		     struct proc *, struct mbuf **);
158 int nfsrv_readdir(struct nfsrv_descript *, struct nfssvc_sock *,
159 		       struct proc *, struct mbuf **);
160 int nfsrv_readdirplus(struct nfsrv_descript *, struct nfssvc_sock *,
161 			   struct proc *, struct mbuf **);
162 int nfsrv_commit(struct nfsrv_descript *, struct nfssvc_sock *,
163 		      struct proc *, struct mbuf **);
164 int nfsrv_statfs(struct nfsrv_descript *, struct nfssvc_sock *,
165 		      struct proc *, struct mbuf **);
166 int nfsrv_fsinfo(struct nfsrv_descript *, struct nfssvc_sock *,
167 		      struct proc *, struct mbuf **);
168 int nfsrv_pathconf(struct nfsrv_descript *, struct nfssvc_sock *,
169 		        struct proc *, struct mbuf **);
170 int nfsrv_null(struct nfsrv_descript *, struct nfssvc_sock *,
171 		    struct proc *, struct mbuf **);
172 int nfsrv_noop(struct nfsrv_descript *, struct nfssvc_sock *,
173 		    struct proc *, struct mbuf **);
174 int nfsrv_access(struct vnode *, int, struct ucred *, int, struct proc *,
175 		    int);
176 
177 /* nfs_socket.c */
178 int nfs_connect(struct nfsmount *, struct nfsreq *);
179 int nfs_reconnect(struct nfsreq *);
180 void nfs_disconnect(struct nfsmount *);
181 int nfs_send(struct socket *, struct mbuf *, struct mbuf *,
182 		  struct nfsreq *);
183 int nfs_receive(struct nfsreq *, struct mbuf **, struct mbuf **);
184 int nfs_reply(struct nfsreq *);
185 int nfs_request(struct vnode *, int, struct nfsm_info *);
186 int nfs_rephead(int, struct nfsrv_descript *, struct nfssvc_sock *, int,
187 		struct mbuf **, struct mbuf **);
188 void nfs_timer(void *);
189 int nfs_sigintr(struct nfsmount *, struct nfsreq *, struct proc *);
190 int nfs_sndlock(int *, struct nfsreq *);
191 void nfs_sndunlock(int *);
192 int nfs_rcvlock(struct nfsreq *);
193 void nfs_rcvunlock(int *);
194 int nfs_getreq(struct nfsrv_descript *, struct nfsd *, int);
195 void nfs_msg(struct nfsreq *, char *);
196 void nfsrv_rcv(struct socket *, caddr_t, int);
197 int nfsrv_getstream(struct nfssvc_sock *, int);
198 int nfsrv_dorec(struct nfssvc_sock *, struct nfsd *,
199 		     struct nfsrv_descript **);
200 void nfsrv_wakenfsd(struct nfssvc_sock *);
201 
202 /* nfs_srvcache.c */
203 void nfsrv_initcache(void );
204 int nfsrv_getcache(struct nfsrv_descript *, struct nfssvc_sock *,
205 			struct mbuf **);
206 void nfsrv_updatecache(struct nfsrv_descript *, int, struct mbuf *);
207 void nfsrv_cleancache(void);
208 
209 /* nfs_subs.c */
210 struct mbuf *nfsm_reqhead(int);
211 u_int32_t nfs_get_xid(void);
212 void nfsm_rpchead(struct nfsreq *, struct ucred *, int);
213 void *nfsm_build(struct mbuf **, u_int);
214 int nfsm_mbuftouio(struct mbuf **, struct uio *, int, caddr_t *);
215 void nfsm_uiotombuf(struct mbuf **, struct uio *, size_t);
216 void nfsm_strtombuf(struct mbuf **, void *, size_t);
217 void nfsm_buftombuf(struct mbuf **, void *, size_t);
218 int nfsm_disct(struct mbuf **, caddr_t *, int, int, caddr_t *);
219 int nfs_adv(struct mbuf **, caddr_t *, int, int);
220 int nfsm_strtmbuf(struct mbuf **, char **, char *, long);
221 int nfs_vfs_init(struct vfsconf *);
222 int nfs_attrtimeo(struct nfsnode *);
223 int nfs_loadattrcache(struct vnode **, struct mbuf **, caddr_t *,
224 			   struct vattr *);
225 int nfs_getattrcache(struct vnode *, struct vattr *);
226 int nfs_namei(struct nameidata *, fhandle_t *, int, struct nfssvc_sock *,
227 		   struct mbuf *, struct mbuf **, caddr_t *, struct vnode **,
228 		   struct proc *);
229 void nfsm_v3attrbuild(struct mbuf **, struct vattr *, int);
230 void nfsm_adj(struct mbuf *, int, int);
231 void nfsm_srvwcc(struct nfsrv_descript *, int, struct vattr *, int,
232 		      struct vattr *, struct nfsm_info *);
233 void nfsm_srvpostop_attr(struct nfsrv_descript *, int, struct vattr *,
234 			     struct nfsm_info *);
235 void nfsm_srvfattr(struct nfsrv_descript *, struct vattr *,
236 			struct nfs_fattr *);
237 int nfsrv_fhtovp(fhandle_t *, int, struct vnode **, struct ucred *,
238 		      struct nfssvc_sock *, struct mbuf *, int *);
239 int netaddr_match(int, union nethostaddr *, struct mbuf *);
240 void nfs_clearcommit(struct mount *);
241 int nfs_in_committed_range(struct vnode *, struct buf *);
242 int nfs_in_tobecommitted_range(struct vnode *, struct buf *);
243 void nfs_add_committed_range(struct vnode *, struct buf *);
244 void nfs_del_committed_range(struct vnode *, struct buf *);
245 void nfs_add_tobecommitted_range(struct vnode *, struct buf *);
246 void nfs_del_tobecommitted_range(struct vnode *, struct buf *);
247 void nfs_merge_commit_ranges(struct vnode *);
248 int nfsrv_errmap(struct nfsrv_descript *, int);
249 int nfsm_srvsattr(struct mbuf **, struct vattr *, struct mbuf *, caddr_t *);
250 void nfsm_fhtom(struct nfsm_info *, struct vnode *, int);
251 void nfsm_srvfhtom(struct mbuf **, fhandle_t *, int);
252 
253 /* nfs_syscalls.c */
254 int sys_nfssvc(struct proc *, void *, register_t *);
255 int nfssvc_addsock(struct file *, struct mbuf *);
256 int nfssvc_nfsd(struct nfsd *);
257 void nfsrv_zapsock(struct nfssvc_sock *);
258 void nfsrv_slpderef(struct nfssvc_sock *);
259 void nfsrv_init(int);
260 void nfssvc_iod(void *);
261 void start_nfsio(void *);
262 void nfs_getset_niothreads(int);
263 
264 /* nfs_kq.c */
265 int  nfs_kqfilter(void *);
266 
267 /* Internal NFS utility macros */
268 #define	mb_offset(m)	(mtod((m), caddr_t) + (m)->m_len)
269 #define	nfsm_padlen(s)	(nfsm_rndup(s) - (s))
270 
271 #endif /* _KERNEL */
272 #endif /* _NFS_NFS_VAR_H_ */
273