xref: /netbsd-src/sys/miscfs/procfs/procfs_vfsops.c (revision a536ee5124e62c9a0051a252f7833dc8f50f44c9)
1 /*	$NetBSD: procfs_vfsops.c,v 1.87 2012/04/30 22:51:28 rmind 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.87 2012/04/30 22:51:28 rmind 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 static kauth_listener_t procfs_listener;
114 
115 /*
116  * VFS Operations.
117  *
118  * mount system call
119  */
120 /* ARGSUSED */
121 int
122 procfs_mount(
123     struct mount *mp,
124     const char *path,
125     void *data,
126     size_t *data_len)
127 {
128 	struct lwp *l = curlwp;
129 	struct procfsmount *pmnt;
130 	struct procfs_args *args = data;
131 	int error;
132 
133 	if (UIO_MX & (UIO_MX-1)) {
134 		log(LOG_ERR, "procfs: invalid directory entry size");
135 		return (EINVAL);
136 	}
137 
138 	if (mp->mnt_flag & MNT_GETARGS) {
139 		if (*data_len < sizeof *args)
140 			return EINVAL;
141 
142 		pmnt = VFSTOPROC(mp);
143 		if (pmnt == NULL)
144 			return EIO;
145 		args->version = PROCFS_ARGSVERSION;
146 		args->flags = pmnt->pmnt_flags;
147 		*data_len = sizeof *args;
148 		return 0;
149 	}
150 
151 	if (mp->mnt_flag & MNT_UPDATE)
152 		return (EOPNOTSUPP);
153 
154 	if (*data_len >= sizeof *args && args->version != PROCFS_ARGSVERSION)
155 		return EINVAL;
156 
157 	pmnt = kmem_zalloc(sizeof(struct procfsmount), KM_SLEEP);
158 
159 	mp->mnt_stat.f_namemax = PROCFS_MAXNAMLEN;
160 	mp->mnt_flag |= MNT_LOCAL;
161 	mp->mnt_data = pmnt;
162 	vfs_getnewfsid(mp);
163 
164 	error = set_statvfs_info(path, UIO_USERSPACE, "procfs", UIO_SYSSPACE,
165 	    mp->mnt_op->vfs_name, mp, l);
166 	pmnt->pmnt_exechook = exechook_establish(procfs_revoke_vnodes, mp);
167 	if (*data_len >= sizeof *args)
168 		pmnt->pmnt_flags = args->flags;
169 	else
170 		pmnt->pmnt_flags = 0;
171 
172 	mp->mnt_iflag |= IMNT_MPSAFE;
173 	return error;
174 }
175 
176 /*
177  * unmount system call
178  */
179 int
180 procfs_unmount(struct mount *mp, int mntflags)
181 {
182 	int error;
183 	int flags = 0;
184 
185 	if (mntflags & MNT_FORCE)
186 		flags |= FORCECLOSE;
187 
188 	if ((error = vflush(mp, 0, flags)) != 0)
189 		return (error);
190 
191 	exechook_disestablish(VFSTOPROC(mp)->pmnt_exechook);
192 
193 	kmem_free(mp->mnt_data, sizeof(struct procfsmount));
194 	mp->mnt_data = NULL;
195 
196 	return 0;
197 }
198 
199 int
200 procfs_root(struct mount *mp, struct vnode **vpp)
201 {
202 
203 	return (procfs_allocvp(mp, vpp, 0, PFSroot, -1, NULL));
204 }
205 
206 /* ARGSUSED */
207 int
208 procfs_start(struct mount *mp, int flags)
209 {
210 
211 	return (0);
212 }
213 
214 /*
215  * Get file system statistics.
216  */
217 int
218 procfs_statvfs(struct mount *mp, struct statvfs *sbp)
219 {
220 
221 	genfs_statvfs(mp, sbp);
222 
223 	sbp->f_bsize = PAGE_SIZE;
224 	sbp->f_frsize = PAGE_SIZE;
225 	sbp->f_iosize = PAGE_SIZE;
226 	sbp->f_blocks = 1;
227 	sbp->f_files = maxproc;			/* approx */
228 	sbp->f_ffree = maxproc - nprocs;	/* approx */
229 	sbp->f_favail = maxproc - nprocs;	/* approx */
230 
231 	return (0);
232 }
233 
234 /*ARGSUSED*/
235 int
236 procfs_sync(
237     struct mount *mp,
238     int waitfor,
239     kauth_cred_t uc)
240 {
241 
242 	return (0);
243 }
244 
245 /*ARGSUSED*/
246 int
247 procfs_vget(struct mount *mp, ino_t ino,
248     struct vnode **vpp)
249 {
250 	return (EOPNOTSUPP);
251 }
252 
253 void
254 procfs_init(void)
255 {
256 	procfs_hashinit();
257 }
258 
259 void
260 procfs_reinit(void)
261 {
262 	procfs_hashreinit();
263 }
264 
265 void
266 procfs_done(void)
267 {
268 	procfs_hashdone();
269 }
270 
271 extern const struct vnodeopv_desc procfs_vnodeop_opv_desc;
272 
273 const struct vnodeopv_desc * const procfs_vnodeopv_descs[] = {
274 	&procfs_vnodeop_opv_desc,
275 	NULL,
276 };
277 
278 struct vfsops procfs_vfsops = {
279 	MOUNT_PROCFS,
280 	sizeof (struct procfs_args),
281 	procfs_mount,
282 	procfs_start,
283 	procfs_unmount,
284 	procfs_root,
285 	(void *)eopnotsupp,		/* vfs_quotactl */
286 	procfs_statvfs,
287 	procfs_sync,
288 	procfs_vget,
289 	(void *)eopnotsupp,		/* vfs_fhtovp */
290 	(void *)eopnotsupp,		/* vfs_vptofh */
291 	procfs_init,
292 	procfs_reinit,
293 	procfs_done,
294 	NULL,				/* vfs_mountroot */
295 	(int (*)(struct mount *, struct vnode *, struct timespec *)) eopnotsupp,
296 	vfs_stdextattrctl,
297 	(void *)eopnotsupp,		/* vfs_suspendctl */
298 	genfs_renamelock_enter,
299 	genfs_renamelock_exit,
300 	(void *)eopnotsupp,
301 	procfs_vnodeopv_descs,
302 	0,
303 	{ NULL, NULL },
304 };
305 
306 static int
307 procfs_listener_cb(kauth_cred_t cred, kauth_action_t action, void *cookie,
308     void *arg0, void *arg1, void *arg2, void *arg3)
309 {
310 	struct proc *p;
311 	struct pfsnode *pfs;
312 	enum kauth_process_req req;
313 	int result;
314 
315 	result = KAUTH_RESULT_DEFER;
316 	p = arg0;
317 	pfs = arg1;
318 	req = (enum kauth_process_req)(unsigned long)arg2;
319 
320 	if (action != KAUTH_PROCESS_PROCFS)
321 		return result;
322 
323 	/* Privileged; let secmodel handle that. */
324 	if (req == KAUTH_REQ_PROCESS_PROCFS_CTL)
325 		return result;
326 
327 	switch (pfs->pfs_type) {
328 	case PFSregs:
329 	case PFSfpregs:
330 	case PFSmem:
331 		if (kauth_cred_getuid(cred) != kauth_cred_getuid(p->p_cred) ||
332 		    ISSET(p->p_flag, PK_SUGID))
333 			break;
334 
335 		/*FALLTHROUGH*/
336 	default:
337 		result = KAUTH_RESULT_ALLOW;
338 		break;
339 	}
340 
341 	return result;
342 }
343 
344 
345 static int
346 procfs_modcmd(modcmd_t cmd, void *arg)
347 {
348 	int error;
349 
350 	switch (cmd) {
351 	case MODULE_CMD_INIT:
352 		error = vfs_attach(&procfs_vfsops);
353 		if (error != 0)
354 			break;
355 		sysctl_createv(&procfs_sysctl_log, 0, NULL, NULL,
356 			       CTLFLAG_PERMANENT,
357 			       CTLTYPE_NODE, "vfs", NULL,
358 			       NULL, 0, NULL, 0,
359 			       CTL_VFS, CTL_EOL);
360 		sysctl_createv(&procfs_sysctl_log, 0, NULL, NULL,
361 			       CTLFLAG_PERMANENT,
362 			       CTLTYPE_NODE, "procfs",
363 			       SYSCTL_DESCR("Process file system"),
364 			       NULL, 0, NULL, 0,
365 			       CTL_VFS, 12, CTL_EOL);
366 		/*
367 		 * XXX the "12" above could be dynamic, thereby eliminating
368 		 * one more instance of the "number to vfs" mapping problem,
369 		 * but "12" is the order as taken from sys/mount.h
370 		 */
371 
372 		procfs_listener = kauth_listen_scope(KAUTH_SCOPE_PROCESS,
373 		    procfs_listener_cb, NULL);
374 
375 		break;
376 	case MODULE_CMD_FINI:
377 		error = vfs_detach(&procfs_vfsops);
378 		if (error != 0)
379 			break;
380 		sysctl_teardown(&procfs_sysctl_log);
381 		kauth_unlisten_scope(procfs_listener);
382 		break;
383 	default:
384 		error = ENOTTY;
385 		break;
386 	}
387 
388 	return (error);
389 }
390