xref: /netbsd-src/sys/miscfs/procfs/procfs_vfsops.c (revision d9970c80662f0e151adf926f67d8a12272a3a3e5)
1 /*	$NetBSD: procfs_vfsops.c,v 1.73 2007/07/26 22:57:39 pooka Exp $	*/
2 
3 /*
4  * Copyright (c) 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Jan-Simon Pendry.
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. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)procfs_vfsops.c	8.7 (Berkeley) 5/10/95
35  */
36 
37 /*
38  * Copyright (c) 1993 Jan-Simon Pendry
39  *
40  * This code is derived from software contributed to Berkeley by
41  * Jan-Simon Pendry.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by the University of
54  *	California, Berkeley and its contributors.
55  * 4. Neither the name of the University nor the names of its contributors
56  *    may be used to endorse or promote products derived from this software
57  *    without specific prior written permission.
58  *
59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69  * SUCH DAMAGE.
70  *
71  *	@(#)procfs_vfsops.c	8.7 (Berkeley) 5/10/95
72  */
73 
74 /*
75  * procfs VFS interface
76  */
77 
78 #include <sys/cdefs.h>
79 __KERNEL_RCSID(0, "$NetBSD: procfs_vfsops.c,v 1.73 2007/07/26 22:57:39 pooka Exp $");
80 
81 #if defined(_KERNEL_OPT)
82 #include "opt_compat_netbsd.h"
83 #endif
84 
85 #include <sys/param.h>
86 #include <sys/time.h>
87 #include <sys/kernel.h>
88 #include <sys/systm.h>
89 #include <sys/sysctl.h>
90 #include <sys/proc.h>
91 #include <sys/buf.h>
92 #include <sys/syslog.h>
93 #include <sys/mount.h>
94 #include <sys/dirent.h>
95 #include <sys/signalvar.h>
96 #include <sys/vnode.h>
97 #include <sys/malloc.h>
98 #include <sys/kauth.h>
99 
100 #include <miscfs/procfs/procfs.h>
101 
102 #include <uvm/uvm_extern.h>			/* for PAGE_SIZE */
103 
104 void	procfs_init(void);
105 void	procfs_reinit(void);
106 void	procfs_done(void);
107 int	procfs_mount(struct mount *, const char *, void *, size_t *,
108 			  struct nameidata *, struct lwp *);
109 int	procfs_start(struct mount *, int, struct lwp *);
110 int	procfs_unmount(struct mount *, int, struct lwp *);
111 int	procfs_quotactl(struct mount *, int, uid_t, void *,
112 			     struct lwp *);
113 int	procfs_statvfs(struct mount *, struct statvfs *, struct lwp *);
114 int	procfs_sync(struct mount *, int, kauth_cred_t, struct lwp *);
115 int	procfs_vget(struct mount *, ino_t, struct vnode **);
116 
117 /*
118  * VFS Operations.
119  *
120  * mount system call
121  */
122 /* ARGSUSED */
123 int
124 procfs_mount(
125     struct mount *mp,
126     const char *path,
127     void *data,
128     size_t *data_len,
129     struct nameidata *ndp,
130     struct lwp *l
131 )
132 {
133 	struct procfsmount *pmnt;
134 	struct procfs_args *args = data;
135 	int error;
136 
137 	if (UIO_MX & (UIO_MX-1)) {
138 		log(LOG_ERR, "procfs: invalid directory entry size");
139 		return (EINVAL);
140 	}
141 
142 	if (mp->mnt_flag & MNT_GETARGS) {
143 		if (*data_len < sizeof *args)
144 			return EINVAL;
145 
146 		pmnt = VFSTOPROC(mp);
147 		if (pmnt == NULL)
148 			return EIO;
149 		args->version = PROCFS_ARGSVERSION;
150 		args->flags = pmnt->pmnt_flags;
151 		*data_len = sizeof *args;
152 		return 0;
153 	}
154 
155 	if (mp->mnt_flag & MNT_UPDATE)
156 		return (EOPNOTSUPP);
157 
158 	if (*data_len >= sizeof *args && args->version != PROCFS_ARGSVERSION)
159 		return EINVAL;
160 
161 	pmnt = (struct procfsmount *) malloc(sizeof(struct procfsmount),
162 	    M_UFSMNT, M_WAITOK);   /* XXX need new malloc type */
163 
164 	mp->mnt_stat.f_namemax = MAXNAMLEN;
165 	mp->mnt_flag |= MNT_LOCAL;
166 	mp->mnt_data = pmnt;
167 	vfs_getnewfsid(mp);
168 
169 	error = set_statvfs_info(path, UIO_USERSPACE, "procfs", UIO_SYSSPACE,
170 	    mp->mnt_op->vfs_name, mp, l);
171 	pmnt->pmnt_exechook = exechook_establish(procfs_revoke_vnodes, mp);
172 	if (*data_len >= sizeof *args)
173 		pmnt->pmnt_flags = args->flags;
174 	else
175 		pmnt->pmnt_flags = 0;
176 
177 	return error;
178 }
179 
180 /*
181  * unmount system call
182  */
183 int
184 procfs_unmount(struct mount *mp, int mntflags, struct lwp *l)
185 {
186 	int error;
187 	int flags = 0;
188 
189 	if (mntflags & MNT_FORCE)
190 		flags |= FORCECLOSE;
191 
192 	if ((error = vflush(mp, 0, flags)) != 0)
193 		return (error);
194 
195 	exechook_disestablish(VFSTOPROC(mp)->pmnt_exechook);
196 
197 	free(mp->mnt_data, M_UFSMNT);
198 	mp->mnt_data = 0;
199 
200 	return (0);
201 }
202 
203 int
204 procfs_root(mp, vpp)
205 	struct mount *mp;
206 	struct vnode **vpp;
207 {
208 
209 	return (procfs_allocvp(mp, vpp, 0, PFSroot, -1, NULL));
210 }
211 
212 /* ARGSUSED */
213 int
214 procfs_start(struct mount *mp, int flags,
215     struct lwp *l)
216 {
217 
218 	return (0);
219 }
220 
221 /*
222  * Get file system statistics.
223  */
224 int
225 procfs_statvfs(struct mount *mp, struct statvfs *sbp, struct lwp *l)
226 {
227 
228 	sbp->f_bsize = PAGE_SIZE;
229 	sbp->f_frsize = PAGE_SIZE;
230 	sbp->f_iosize = PAGE_SIZE;
231 	sbp->f_blocks = 1;	/* avoid divide by zero in some df's */
232 	sbp->f_bfree = 0;
233 	sbp->f_bavail = 0;
234 	sbp->f_bresvd = 0;
235 	sbp->f_files = maxproc;			/* approx */
236 	sbp->f_ffree = maxproc - nprocs;	/* approx */
237 	sbp->f_favail = maxproc - nprocs;	/* approx */
238 	sbp->f_fresvd = 0;
239 	copy_statvfs_info(sbp, mp);
240 	return (0);
241 }
242 
243 /*ARGSUSED*/
244 int
245 procfs_quotactl(
246     struct mount *mp,
247     int cmds,
248     uid_t uid,
249     void *arg,
250     struct lwp *l
251 )
252 {
253 
254 	return (EOPNOTSUPP);
255 }
256 
257 /*ARGSUSED*/
258 int
259 procfs_sync(
260     struct mount *mp,
261     int waitfor,
262     kauth_cred_t uc,
263     struct lwp *l
264 )
265 {
266 
267 	return (0);
268 }
269 
270 /*ARGSUSED*/
271 int
272 procfs_vget(struct mount *mp, ino_t ino,
273     struct vnode **vpp)
274 {
275 	return (EOPNOTSUPP);
276 }
277 
278 void
279 procfs_init()
280 {
281 	procfs_hashinit();
282 }
283 
284 void
285 procfs_reinit()
286 {
287 	procfs_hashreinit();
288 }
289 
290 void
291 procfs_done()
292 {
293 	procfs_hashdone();
294 }
295 
296 SYSCTL_SETUP(sysctl_vfs_procfs_setup, "sysctl vfs.procfs subtree setup")
297 {
298 
299 	sysctl_createv(clog, 0, NULL, NULL,
300 		       CTLFLAG_PERMANENT,
301 		       CTLTYPE_NODE, "vfs", NULL,
302 		       NULL, 0, NULL, 0,
303 		       CTL_VFS, CTL_EOL);
304 	sysctl_createv(clog, 0, NULL, NULL,
305 		       CTLFLAG_PERMANENT,
306 		       CTLTYPE_NODE, "procfs",
307 		       SYSCTL_DESCR("Process file system"),
308 		       NULL, 0, NULL, 0,
309 		       CTL_VFS, 12, CTL_EOL);
310 	/*
311 	 * XXX the "12" above could be dynamic, thereby eliminating
312 	 * one more instance of the "number to vfs" mapping problem,
313 	 * but "12" is the order as taken from sys/mount.h
314 	 */
315 }
316 
317 extern const struct vnodeopv_desc procfs_vnodeop_opv_desc;
318 
319 const struct vnodeopv_desc * const procfs_vnodeopv_descs[] = {
320 	&procfs_vnodeop_opv_desc,
321 	NULL,
322 };
323 
324 struct vfsops procfs_vfsops = {
325 	MOUNT_PROCFS,
326 	sizeof (struct procfs_args),
327 	procfs_mount,
328 	procfs_start,
329 	procfs_unmount,
330 	procfs_root,
331 	procfs_quotactl,
332 	procfs_statvfs,
333 	procfs_sync,
334 	procfs_vget,
335 	(void *)eopnotsupp,		/* vfs_fhtovp */
336 	(void *)eopnotsupp,		/* vfs_vptofh */
337 	procfs_init,
338 	procfs_reinit,
339 	procfs_done,
340 	NULL,				/* vfs_mountroot */
341 	(int (*)(struct mount *, struct vnode *, struct timespec *)) eopnotsupp,
342 	vfs_stdextattrctl,
343 	(void *)eopnotsupp,		/* vfs_suspendctl */
344 	procfs_vnodeopv_descs,
345 	0,
346 	{ NULL, NULL },
347 };
348 VFS_ATTACH(procfs_vfsops);
349