xref: /netbsd-src/sys/miscfs/procfs/procfs_vfsops.c (revision 51f0d6a0ebafbc22501d2759dad36aa6c11261b7)
1 /*	$NetBSD: procfs_vfsops.c,v 1.84 2009/10/02 23:00:02 elad 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.84 2009/10/02 23:00:02 elad 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 = (struct procfsmount *) malloc(sizeof(struct procfsmount),
158 	    M_UFSMNT, M_WAITOK);   /* XXX need new malloc type */
159 
160 	mp->mnt_stat.f_namemax = MAXNAMLEN;
161 	mp->mnt_flag |= MNT_LOCAL;
162 	mp->mnt_data = pmnt;
163 	vfs_getnewfsid(mp);
164 
165 	error = set_statvfs_info(path, UIO_USERSPACE, "procfs", UIO_SYSSPACE,
166 	    mp->mnt_op->vfs_name, mp, l);
167 	pmnt->pmnt_exechook = exechook_establish(procfs_revoke_vnodes, mp);
168 	if (*data_len >= sizeof *args)
169 		pmnt->pmnt_flags = args->flags;
170 	else
171 		pmnt->pmnt_flags = 0;
172 
173 	mp->mnt_iflag |= IMNT_MPSAFE;
174 	return error;
175 }
176 
177 /*
178  * unmount system call
179  */
180 int
181 procfs_unmount(struct mount *mp, int mntflags)
182 {
183 	int error;
184 	int flags = 0;
185 
186 	if (mntflags & MNT_FORCE)
187 		flags |= FORCECLOSE;
188 
189 	if ((error = vflush(mp, 0, flags)) != 0)
190 		return (error);
191 
192 	exechook_disestablish(VFSTOPROC(mp)->pmnt_exechook);
193 
194 	free(mp->mnt_data, M_UFSMNT);
195 	mp->mnt_data = NULL;
196 
197 	return (0);
198 }
199 
200 int
201 procfs_root(struct mount *mp, 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(void)
258 {
259 	procfs_hashinit();
260 }
261 
262 void
263 procfs_reinit(void)
264 {
265 	procfs_hashreinit();
266 }
267 
268 void
269 procfs_done(void)
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_listener_cb(kauth_cred_t cred, kauth_action_t action, void *cookie,
311     void *arg0, void *arg1, void *arg2, void *arg3)
312 {
313 	struct proc *p;
314 	struct pfsnode *pfs;
315 	enum kauth_process_req req;
316 	int result;
317 
318 	result = KAUTH_RESULT_DEFER;
319 	p = arg0;
320 	pfs = arg1;
321 	req = (enum kauth_process_req)(unsigned long)arg2;
322 
323 	if (action != KAUTH_PROCESS_PROCFS)
324 		return result;
325 
326 	/* Privileged; let secmodel handle that. */
327 	if (req == KAUTH_REQ_PROCESS_PROCFS_CTL)
328 		return result;
329 
330 	switch (pfs->pfs_type) {
331 	case PFSregs:
332 	case PFSfpregs:
333 	case PFSmem:
334 		if (kauth_cred_getuid(cred) != kauth_cred_getuid(p->p_cred) ||
335 		    ISSET(p->p_flag, PK_SUGID))
336 			break;
337 
338 		/*FALLTHROUGH*/
339 	default:
340 		result = KAUTH_RESULT_ALLOW;
341 		break;
342 	}
343 
344 	return result;
345 }
346 
347 
348 static int
349 procfs_modcmd(modcmd_t cmd, void *arg)
350 {
351 	int error;
352 
353 	switch (cmd) {
354 	case MODULE_CMD_INIT:
355 		error = vfs_attach(&procfs_vfsops);
356 		if (error != 0)
357 			break;
358 		sysctl_createv(&procfs_sysctl_log, 0, NULL, NULL,
359 			       CTLFLAG_PERMANENT,
360 			       CTLTYPE_NODE, "vfs", NULL,
361 			       NULL, 0, NULL, 0,
362 			       CTL_VFS, CTL_EOL);
363 		sysctl_createv(&procfs_sysctl_log, 0, NULL, NULL,
364 			       CTLFLAG_PERMANENT,
365 			       CTLTYPE_NODE, "procfs",
366 			       SYSCTL_DESCR("Process file system"),
367 			       NULL, 0, NULL, 0,
368 			       CTL_VFS, 12, CTL_EOL);
369 		/*
370 		 * XXX the "12" above could be dynamic, thereby eliminating
371 		 * one more instance of the "number to vfs" mapping problem,
372 		 * but "12" is the order as taken from sys/mount.h
373 		 */
374 
375 		procfs_listener = kauth_listen_scope(KAUTH_SCOPE_PROCESS,
376 		    procfs_listener_cb, NULL);
377 
378 		break;
379 	case MODULE_CMD_FINI:
380 		error = vfs_detach(&procfs_vfsops);
381 		if (error != 0)
382 			break;
383 		sysctl_teardown(&procfs_sysctl_log);
384 		kauth_unlisten_scope(procfs_listener);
385 		break;
386 	default:
387 		error = ENOTTY;
388 		break;
389 	}
390 
391 	return (error);
392 }
393