procfs.h revision 1.30 1 /* $NetBSD: procfs.h,v 1.30 2000/11/24 18:58:37 chs Exp $ */
2
3 /*
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.h 8.9 (Berkeley) 5/14/95
40 */
41
42 /*
43 * The different types of node in a procfs filesystem
44 */
45 typedef enum {
46 Proot, /* the filesystem root */
47 Pcurproc, /* symbolic link for curproc */
48 Pself, /* like curproc, but this is the Linux name */
49 Pproc, /* a process-specific sub-directory */
50 Pfile, /* the executable file */
51 Pmem, /* the process's memory image */
52 Pregs, /* the process's register set */
53 Pfpregs, /* the process's FP register set */
54 Pctl, /* process control */
55 Pstatus, /* process status */
56 Pnote, /* process notifier */
57 Pnotepg, /* process group notifier */
58 Pmap, /* memory map */
59 Pcmdline /* process command line args */
60 } pfstype;
61
62 /*
63 * control data for the proc file system.
64 */
65 struct pfsnode {
66 LIST_ENTRY(pfsnode) pfs_hash; /* hash chain */
67 struct vnode *pfs_vnode; /* vnode associated with this pfsnode */
68 pfstype pfs_type; /* type of procfs node */
69 pid_t pfs_pid; /* associated process */
70 mode_t pfs_mode; /* mode bits for stat() */
71 u_long pfs_flags; /* open flags */
72 u_long pfs_fileno; /* unique file id */
73 };
74
75 #define PROCFS_NOTELEN 64 /* max length of a note (/proc/$pid/note) */
76 #define PROCFS_CTLLEN 8 /* max length of a ctl msg (/proc/$pid/ctl */
77
78 /*
79 * Kernel stuff follows
80 */
81 #ifdef _KERNEL
82 #define CNEQ(cnp, s, len) \
83 ((cnp)->cn_namelen == (len) && \
84 (memcmp((s), (cnp)->cn_nameptr, (len)) == 0))
85
86 #define UIO_MX 32
87
88 #define PROCFS_FILENO(pid, type) \
89 (((type) < Pproc) ? \
90 ((type) + 2) : \
91 ((((pid)+1) << 4) + ((int) (type))))
92
93 struct procfsmount {
94 void *pmnt_exechook;
95 struct mount *pmnt_mp;
96 };
97
98 #define VFSTOPROC(mp) ((struct procfsmount *)(mp)->mnt_data)
99 #define PROCTOVFS(pp) ((pp)->pmnt_mp)
100
101 /*
102 * Convert between pfsnode vnode
103 */
104 #define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data)
105 #define PFSTOV(pfs) ((pfs)->pfs_vnode)
106
107 typedef struct vfs_namemap vfs_namemap_t;
108 struct vfs_namemap {
109 const char *nm_name;
110 int nm_val;
111 };
112
113 int vfs_getuserstr __P((struct uio *, char *, int *));
114 vfs_namemap_t *vfs_findname __P((vfs_namemap_t *, char *, int));
115
116 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
117 int procfs_freevp __P((struct vnode *));
118 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
119 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *,
120 struct uio *));
121 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *,
122 struct uio *));
123 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *,
124 struct uio *));
125 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *,
126 struct uio *));
127 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *,
128 struct uio *));
129 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *,
130 struct uio *));
131 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *,
132 struct uio *));
133 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *,
134 struct uio *));
135
136 int procfs_checkioperm __P((struct proc *, struct proc *));
137 void procfs_revoke_vnodes __P((struct proc *, void *));
138 void procfs_hashinit __P((void));
139 void procfs_hashdone __P((void));
140
141 /* functions to check whether or not files should be displayed */
142 int procfs_validfile __P((struct proc *));
143 int procfs_validfpregs __P((struct proc *));
144 int procfs_validregs __P((struct proc *));
145 int procfs_validmap __P((struct proc *));
146
147 int procfs_rw __P((void *));
148
149 #define PROCFS_LOCKED 0x01
150 #define PROCFS_WANT 0x02
151
152 extern int (**procfs_vnodeop_p) __P((void *));
153 extern struct vfsops procfs_vfsops;
154
155 int procfs_root __P((struct mount *, struct vnode **));
156
157 #endif /* _KERNEL */
158