8dc4f8f9fd6930f199fafb6f808ddcdcbf8ab441
[dragonfly.git] / sys / emulation / linux / i386 / linprocfs / linprocfs_subr.c
1 /*
2  * Copyright (c) 2000 Dag-Erling Coïdan Smørgrav
3  * Copyright (c) 1999 Pierre Beyssac
4  * Copyright (c) 1993 Jan-Simon Pendry
5  * Copyright (c) 1993
6  *      The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Jan-Simon Pendry.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *      This product includes software developed by the University of
22  *      California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *      @(#)procfs_subr.c       8.6 (Berkeley) 5/14/95
40  *
41  * $FreeBSD: src/sys/i386/linux/linprocfs/linprocfs_subr.c,v 1.3.2.4 2001/06/25 19:46:47 pirzyk Exp $
42  */
43
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/proc.h>
47 #include <sys/vnode.h>
48 #include <sys/malloc.h>
49 #include <sys/mount.h>
50 #include "linprocfs.h"
51
52 #define PFSHSIZE        256
53 #define PFSHMASK        (PFSHSIZE - 1)
54
55 static struct pfsnode *pfshead[PFSHSIZE];
56 static struct lwkt_token pfs_token;
57 static int pfsvplock;
58
59 extern int procfs_domem (struct proc *, struct lwp *, struct pfsnode *pfsp, struct uio *uio);
60
61 /*
62  * allocate a pfsnode/vnode pair.  the vnode is
63  * referenced, but not locked.
64  *
65  * the pid, pfs_type, and mount point uniquely
66  * identify a pfsnode.  the mount point is needed
67  * because someone might mount this filesystem
68  * twice.
69  *
70  * all pfsnodes are maintained on a singly-linked
71  * list.  new nodes are only allocated when they cannot
72  * be found on this list.  entries on the list are
73  * removed when the vfs reclaim entry is called.
74  *
75  * a single lock is kept for the entire list.  this is
76  * needed because the getnewvnode() function can block
77  * waiting for a vnode to become free, in which case there
78  * may be more than one process trying to get the same
79  * vnode.  this lock is only taken if we are going to
80  * call getnewvnode, since the kernel itself is single-threaded.
81  *
82  * if an entry is found on the list, then call vget() to
83  * take a reference.  this is done because there may be
84  * zero references to it and so it needs to removed from
85  * the vnode free list.
86  */
87 int
88 linprocfs_allocvp(struct mount *mp, struct vnode **vpp, long pid,
89                   pfstype pfs_type)
90 {
91         struct pfsnode *pfs;
92         struct vnode *vp;
93         struct pfsnode **pp;
94         int error;
95
96         lwkt_gettoken(&pfs_token);
97 loop:
98         for (pfs = pfshead[pid & PFSHMASK]; pfs; pfs = pfs->pfs_next) {
99                 vp = PFSTOV(pfs);
100                 if (pfs->pfs_pid == pid &&
101                     pfs->pfs_type == pfs_type &&
102                     vp->v_mount == mp) {
103                         if (vget(vp, LK_EXCLUSIVE|LK_SLEEPFAIL))
104                                 goto loop;
105                         *vpp = vp;
106                         lwkt_reltoken(&pfs_token);
107                         return (0);
108                 }
109         }
110
111         /*
112          * otherwise lock the vp list while we call getnewvnode
113          * since that can block.
114          */
115         if (pfsvplock & PROCFS_LOCKED) {
116                 pfsvplock |= PROCFS_WANT;
117                 (void) tsleep((caddr_t) &pfsvplock, 0, "pfsavp", 0);
118                 goto loop;
119         }
120         pfsvplock |= PROCFS_LOCKED;
121
122         /*
123          * Do the MALLOC before the getnewvnode since doing so afterward
124          * might cause a bogus v_data pointer to get dereferenced
125          * elsewhere if MALLOC should block.
126          */
127         pfs = kmalloc(sizeof(struct pfsnode), M_TEMP, M_WAITOK);
128
129         error = getnewvnode(VT_PROCFS, mp, vpp, 0, 0);
130         if (error) {
131                 kfree(pfs, M_TEMP);
132                 goto out;
133         }
134         vp = *vpp;
135
136         vp->v_data = pfs;
137
138         pfs->pfs_next = 0;
139         pfs->pfs_pid = (pid_t) pid;
140         pfs->pfs_type = pfs_type;
141         pfs->pfs_vnode = vp;
142         pfs->pfs_flags = 0;
143         pfs->pfs_lockowner = NULL;
144         pfs->pfs_fileno = PROCFS_FILENO(pid, pfs_type);
145
146         switch (pfs_type) {
147         case Proot:     /* /proc = dr-xr-xr-x */
148                 vsetflags(vp, VROOT);
149                 /* fallthrough */
150         case Pnet:
151         case Psys:
152         case Psyskernel:
153                 pfs->pfs_mode = (VREAD|VEXEC) |
154                                 (VREAD|VEXEC) >> 3 |
155                                 (VREAD|VEXEC) >> 6;
156                 vp->v_type = VDIR;
157                 break;
158
159         case Pself:     /* /proc/self = lr--r--r-- */
160                 pfs->pfs_mode = (VREAD) |
161                                 (VREAD >> 3) |
162                                 (VREAD >> 6);
163                 vp->v_type = VLNK;
164                 break;
165
166         case Pproc:
167                 pfs->pfs_mode = (VREAD|VEXEC) |
168                                 (VREAD|VEXEC) >> 3 |
169                                 (VREAD|VEXEC) >> 6;
170                 vp->v_type = VDIR;
171                 break;
172
173         case Pexe:
174         case Pcwd:
175         case Pprocroot:
176         case Pfd:
177                 pfs->pfs_mode = (VREAD|VEXEC) |
178                                 (VREAD|VEXEC) >> 3 |
179                                 (VREAD|VEXEC) >> 6;
180                 vp->v_type = VLNK;
181                 break;
182
183         case Pmem:
184                 pfs->pfs_mode = (VREAD|VWRITE) |
185                                 (VREAD) >> 3;
186                 vp->v_type = VREG;
187                 break;
188
189         case Pprocstat:
190         case Pprocstatus:
191         case Pcmdline:
192         case Penviron:
193         case Pstatm:
194                 /* fallthrough */
195         case Pmaps:
196         case Pmeminfo:
197         case Pcpuinfo:
198         case Pmounts:
199         case Pstat:
200         case Puptime:
201         case Pversion:
202         case Ploadavg:
203         case Pdevices:
204         case Pnetdev:
205         case Posrelease:
206         case Postype:
207         case Ppidmax:
208                 pfs->pfs_mode = (VREAD) |
209                                 (VREAD >> 3) |
210                                 (VREAD >> 6);
211                 vp->v_type = VREG;
212                 break;
213
214         default:
215                 panic("linprocfs_allocvp");
216         }
217
218         /* add to procfs vnode list */
219         for (pp = &pfshead[pid & PFSHMASK]; *pp; pp = &(*pp)->pfs_next)
220                 continue;
221         *pp = pfs;
222
223 out:
224         pfsvplock &= ~PROCFS_LOCKED;
225
226         if (pfsvplock & PROCFS_WANT) {
227                 pfsvplock &= ~PROCFS_WANT;
228                 wakeup((caddr_t) &pfsvplock);
229         }
230         lwkt_reltoken(&pfs_token);
231
232         return (error);
233 }
234
235 int
236 linprocfs_freevp(struct vnode *vp)
237 {
238         struct pfsnode **pfspp;
239         struct pfsnode *pfs = VTOPFS(vp);
240
241         lwkt_gettoken(&pfs_token);
242         pfspp = &pfshead[pfs->pfs_pid & PFSHMASK]; 
243         while (*pfspp != pfs) {
244                 KKASSERT(*pfspp != NULL);
245                 pfspp = &(*pfspp)->pfs_next;
246         }
247         *pfspp = pfs->pfs_next;
248         lwkt_reltoken(&pfs_token);
249         kfree(vp->v_data, M_TEMP);
250         vp->v_data = NULL;
251         return (0);
252 }
253
254 int
255 linprocfs_rw(struct vop_read_args *ap)
256 {
257         struct vnode *vp = ap->a_vp;
258         struct uio *uio = ap->a_uio;
259         struct thread *td = uio->uio_td;
260         struct pfsnode *pfs = VTOPFS(vp);
261         struct proc *p;
262         struct proc *curp;
263         struct lwp *lp;
264         int rtval;
265
266         curp = td->td_proc;
267         KKASSERT(curp);
268
269         p = pfind(pfs->pfs_pid);
270         if (p == NULL)
271                 return (EINVAL);
272         if (p->p_pid == 1 && securelevel > 0 && uio->uio_rw == UIO_WRITE) {
273                 PRELE(p);
274                 return (EACCES);
275         }
276         lp = FIRST_LWP_IN_PROC(p);
277         LWPHOLD(lp);
278
279         lwkt_gettoken(&pfs_token);
280         while (pfs->pfs_lockowner) {
281                 tsleep(&pfs->pfs_lockowner, 0, "pfslck", 0);
282         }
283         pfs->pfs_lockowner = curthread;
284         lwkt_reltoken(&pfs_token);
285
286         switch (pfs->pfs_type) {
287         case Pmem:
288                 rtval = procfs_domem(curp, lp, pfs, uio);
289                 break;
290         case Pprocstat:
291                 rtval = linprocfs_doprocstat(curp, p, pfs, uio);
292                 break;
293         case Pprocstatus:
294                 rtval = linprocfs_doprocstatus(curp, p, pfs, uio);
295                 break;
296         case Pmeminfo:
297                 rtval = linprocfs_domeminfo(curp, p, pfs, uio);
298                 break;
299         case Pcpuinfo:
300                 rtval = linprocfs_docpuinfo(curp, p, pfs, uio);
301                 break;
302         case Pmounts:
303                 rtval = linprocfs_domounts(curp, p, pfs, uio);
304                 break;
305         case Pstat:
306                 rtval = linprocfs_dostat(curp, p, pfs, uio);
307                 break;
308         case Puptime:
309                 rtval = linprocfs_douptime(curp, p, pfs, uio);
310                 break;
311         case Pversion:
312                 rtval = linprocfs_doversion(curp, p, pfs, uio);
313                 break;
314         case Ploadavg:
315                 rtval = linprocfs_doloadavg(curp, p, pfs, uio);
316                 break;
317         case Pnetdev:
318                 rtval = linprocfs_donetdev(curp, p, pfs, uio);
319                 break;
320         case Pdevices:
321                 rtval = linprocfs_dodevices(curp, p, pfs, uio);
322                 break;
323         case Posrelease:
324                 rtval = linprocfs_doosrelease(curp, p, pfs, uio);
325                 break;
326         case Postype:
327                 rtval = linprocfs_doostype(curp, p, pfs, uio);
328                 break;
329         case Ppidmax:
330                 rtval = linprocfs_dopidmax(curp, p, pfs, uio);
331                 break;
332         case Pmaps:
333                 rtval = linprocfs_domaps(curp, p, pfs, uio);
334                 break;
335         case Pstatm:
336                 rtval = linprocfs_dostatm(curp, p, pfs, uio);
337                 break;
338         default:
339                 rtval = EOPNOTSUPP;
340                 break;
341         }
342         LWPRELE(lp);
343         PRELE(p);
344
345         lwkt_gettoken(&pfs_token);
346         pfs->pfs_lockowner = NULL;
347         wakeup(&pfs->pfs_lockowner);
348         lwkt_reltoken(&pfs_token);
349
350         return rtval;
351 }
352
353 #if 0
354 /*
355  * Get a string from userland into (buf).  Strip a trailing
356  * nl character (to allow easy access from the shell).
357  * The buffer should be *buflenp + 1 chars long.  vfs_getuserstr
358  * will automatically add a nul char at the end.
359  *
360  * Returns 0 on success or the following errors
361  *
362  * EINVAL:    file offset is non-zero.
363  * EMSGSIZE:  message is longer than kernel buffer
364  * EFAULT:    user i/o buffer is not addressable
365  */
366 int
367 vfs_getuserstr(struct uio *uio, char *buf, int *buflenp)
368 {
369         int xlen;
370         int error;
371
372         if (uio->uio_offset != 0)
373                 return (EINVAL);
374
375         xlen = *buflenp;
376
377         /* must be able to read the whole string in one go */
378         if (xlen < uio->uio_resid)
379                 return (EMSGSIZE);
380         xlen = uio->uio_resid;
381
382         if ((error = uiomove(buf, xlen, uio)) != 0)
383                 return (error);
384
385         /* allow multiple writes without seeks */
386         uio->uio_offset = 0;
387
388         /* cleanup string and remove trailing newline */
389         buf[xlen] = '\0';
390         xlen = strlen(buf);
391         if (xlen > 0 && buf[xlen-1] == '\n')
392                 buf[--xlen] = '\0';
393         *buflenp = xlen;
394
395         return (0);
396 }
397
398 vfs_namemap_t *
399 vfs_findname(vfs_namemap_t *nm, char *buf, int buflen)
400 {
401
402         for (; nm->nm_name; nm++)
403                 if (bcmp(buf, nm->nm_name, buflen+1) == 0)
404                         return (nm);
405
406         return (0);
407 }
408 #endif
409
410 void
411 linprocfs_init(void)
412 {
413         lwkt_token_init(&pfs_token, "linprocfs");
414
415
416 void
417 linprocfs_exit(struct thread *td)
418 {
419         struct pfsnode *pfs;
420         struct vnode *vp;
421         pid_t pid;
422
423         KKASSERT(td->td_proc);
424         pid = td->td_proc->p_pid;
425
426         /*
427          * Remove all the procfs vnodes associated with an exiting process.
428          */
429         lwkt_gettoken(&pfs_token);
430 restart:
431         for (pfs = pfshead[pid & PFSHMASK]; pfs; pfs = pfs->pfs_next) {
432                 if (pfs->pfs_pid == pid) {
433                         vp = PFSTOV(pfs);
434                         vx_get(vp);
435                         vgone_vxlocked(vp);
436                         vx_put(vp);
437                         goto restart;
438                 }
439         }
440         lwkt_reltoken(&pfs_token);
441         lwkt_token_uninit(&pfs_token);
442 }
443