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