xref: /netbsd-src/sys/miscfs/procfs/procfs_vfsops.c (revision 466a16a118933bd295a8a104f095714fadf9cf68)
1 /*	$NetBSD: procfs_vfsops.c,v 1.81 2008/06/28 01:34:06 rumble 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.81 2008/06/28 01:34:06 rumble 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 #include <sys/module.h>
100 
101 #include <miscfs/genfs/genfs.h>
102 
103 #include <miscfs/procfs/procfs.h>
104 
105 #include <uvm/uvm_extern.h>			/* for PAGE_SIZE */
106 
107 MODULE(MODULE_CLASS_VFS, procfs, NULL);
108 
109 VFS_PROTOS(procfs);
110 
111 static struct sysctllog *procfs_sysctl_log;
112 
113 /*
114  * VFS Operations.
115  *
116  * mount system call
117  */
118 /* ARGSUSED */
119 int
120 procfs_mount(
121     struct mount *mp,
122     const char *path,
123     void *data,
124     size_t *data_len)
125 {
126 	struct lwp *l = curlwp;
127 	struct procfsmount *pmnt;
128 	struct procfs_args *args = data;
129 	int error;
130 
131 	if (UIO_MX & (UIO_MX-1)) {
132 		log(LOG_ERR, "procfs: invalid directory entry size");
133 		return (EINVAL);
134 	}
135 
136 	if (mp->mnt_flag & MNT_GETARGS) {
137 		if (*data_len < sizeof *args)
138 			return EINVAL;
139 
140 		pmnt = VFSTOPROC(mp);
141 		if (pmnt == NULL)
142 			return EIO;
143 		args->version = PROCFS_ARGSVERSION;
144 		args->flags = pmnt->pmnt_flags;
145 		*data_len = sizeof *args;
146 		return 0;
147 	}
148 
149 	if (mp->mnt_flag & MNT_UPDATE)
150 		return (EOPNOTSUPP);
151 
152 	if (*data_len >= sizeof *args && args->version != PROCFS_ARGSVERSION)
153 		return EINVAL;
154 
155 	pmnt = (struct procfsmount *) malloc(sizeof(struct procfsmount),
156 	    M_UFSMNT, M_WAITOK);   /* XXX need new malloc type */
157 
158 	mp->mnt_stat.f_namemax = MAXNAMLEN;
159 	mp->mnt_flag |= MNT_LOCAL;
160 	mp->mnt_data = pmnt;
161 	vfs_getnewfsid(mp);
162 
163 	error = set_statvfs_info(path, UIO_USERSPACE, "procfs", UIO_SYSSPACE,
164 	    mp->mnt_op->vfs_name, mp, l);
165 	pmnt->pmnt_exechook = exechook_establish(procfs_revoke_vnodes, mp);
166 	if (*data_len >= sizeof *args)
167 		pmnt->pmnt_flags = args->flags;
168 	else
169 		pmnt->pmnt_flags = 0;
170 
171 	mp->mnt_iflag |= IMNT_MPSAFE;
172 	return error;
173 }
174 
175 /*
176  * unmount system call
177  */
178 int
179 procfs_unmount(struct mount *mp, int mntflags)
180 {
181 	int error;
182 	int flags = 0;
183 
184 	if (mntflags & MNT_FORCE)
185 		flags |= FORCECLOSE;
186 
187 	if ((error = vflush(mp, 0, flags)) != 0)
188 		return (error);
189 
190 	exechook_disestablish(VFSTOPROC(mp)->pmnt_exechook);
191 
192 	free(mp->mnt_data, M_UFSMNT);
193 	mp->mnt_data = NULL;
194 
195 	return (0);
196 }
197 
198 int
199 procfs_root(mp, vpp)
200 	struct mount *mp;
201 	struct vnode **vpp;
202 {
203 
204 	return (procfs_allocvp(mp, vpp, 0, PFSroot, -1, NULL));
205 }
206 
207 /* ARGSUSED */
208 int
209 procfs_start(struct mount *mp, int flags)
210 {
211 
212 	return (0);
213 }
214 
215 /*
216  * Get file system statistics.
217  */
218 int
219 procfs_statvfs(struct mount *mp, struct statvfs *sbp)
220 {
221 
222 	sbp->f_bsize = PAGE_SIZE;
223 	sbp->f_frsize = PAGE_SIZE;
224 	sbp->f_iosize = PAGE_SIZE;
225 	sbp->f_blocks = 1;	/* avoid divide by zero in some df's */
226 	sbp->f_bfree = 0;
227 	sbp->f_bavail = 0;
228 	sbp->f_bresvd = 0;
229 	sbp->f_files = maxproc;			/* approx */
230 	sbp->f_ffree = maxproc - nprocs;	/* approx */
231 	sbp->f_favail = maxproc - nprocs;	/* approx */
232 	sbp->f_fresvd = 0;
233 	copy_statvfs_info(sbp, mp);
234 	return (0);
235 }
236 
237 /*ARGSUSED*/
238 int
239 procfs_sync(
240     struct mount *mp,
241     int waitfor,
242     kauth_cred_t uc)
243 {
244 
245 	return (0);
246 }
247 
248 /*ARGSUSED*/
249 int
250 procfs_vget(struct mount *mp, ino_t ino,
251     struct vnode **vpp)
252 {
253 	return (EOPNOTSUPP);
254 }
255 
256 void
257 procfs_init()
258 {
259 	procfs_hashinit();
260 }
261 
262 void
263 procfs_reinit()
264 {
265 	procfs_hashreinit();
266 }
267 
268 void
269 procfs_done()
270 {
271 	procfs_hashdone();
272 }
273 
274 extern const struct vnodeopv_desc procfs_vnodeop_opv_desc;
275 
276 const struct vnodeopv_desc * const procfs_vnodeopv_descs[] = {
277 	&procfs_vnodeop_opv_desc,
278 	NULL,
279 };
280 
281 struct vfsops procfs_vfsops = {
282 	MOUNT_PROCFS,
283 	sizeof (struct procfs_args),
284 	procfs_mount,
285 	procfs_start,
286 	procfs_unmount,
287 	procfs_root,
288 	(void *)eopnotsupp,		/* vfs_quotactl */
289 	procfs_statvfs,
290 	procfs_sync,
291 	procfs_vget,
292 	(void *)eopnotsupp,		/* vfs_fhtovp */
293 	(void *)eopnotsupp,		/* vfs_vptofh */
294 	procfs_init,
295 	procfs_reinit,
296 	procfs_done,
297 	NULL,				/* vfs_mountroot */
298 	(int (*)(struct mount *, struct vnode *, struct timespec *)) eopnotsupp,
299 	vfs_stdextattrctl,
300 	(void *)eopnotsupp,		/* vfs_suspendctl */
301 	genfs_renamelock_enter,
302 	genfs_renamelock_exit,
303 	(void *)eopnotsupp,
304 	procfs_vnodeopv_descs,
305 	0,
306 	{ NULL, NULL },
307 };
308 
309 static int
310 procfs_modcmd(modcmd_t cmd, void *arg)
311 {
312 	int error;
313 
314 	switch (cmd) {
315 	case MODULE_CMD_INIT:
316 		error = vfs_attach(&procfs_vfsops);
317 		if (error != 0)
318 			break;
319 		sysctl_createv(&procfs_sysctl_log, 0, NULL, NULL,
320 			       CTLFLAG_PERMANENT,
321 			       CTLTYPE_NODE, "vfs", NULL,
322 			       NULL, 0, NULL, 0,
323 			       CTL_VFS, CTL_EOL);
324 		sysctl_createv(&procfs_sysctl_log, 0, NULL, NULL,
325 			       CTLFLAG_PERMANENT,
326 			       CTLTYPE_NODE, "procfs",
327 			       SYSCTL_DESCR("Process file system"),
328 			       NULL, 0, NULL, 0,
329 			       CTL_VFS, 12, CTL_EOL);
330 		/*
331 		 * XXX the "12" above could be dynamic, thereby eliminating
332 		 * one more instance of the "number to vfs" mapping problem,
333 		 * but "12" is the order as taken from sys/mount.h
334 		 */
335 		break;
336 	case MODULE_CMD_FINI:
337 		error = vfs_detach(&procfs_vfsops);
338 		if (error != 0)
339 			break;
340 		sysctl_teardown(&procfs_sysctl_log);
341 		break;
342 	default:
343 		error = ENOTTY;
344 		break;
345 	}
346 
347 	return (error);
348 }
349