procfs.h revision 1.56 1 /* $NetBSD: procfs.h,v 1.56 2004/09/20 17:53:08 jdolecek 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.h 8.9 (Berkeley) 5/14/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.h 8.9 (Berkeley) 5/14/95
72 */
73
74 /* This also pulls in __HAVE_PROCFS_MACHDEP */
75 #include <sys/ptrace.h>
76
77 #ifdef _KERNEL
78 /*
79 * The different types of node in a procfs filesystem
80 */
81 typedef enum {
82 PFSroot, /* the filesystem root */
83 PFScurproc, /* symbolic link for curproc */
84 PFSself, /* like curproc, but this is the Linux name */
85 PFSproc, /* a process-specific sub-directory */
86 PFSfile, /* the executable file */
87 PFSmem, /* the process's memory image */
88 PFSregs, /* the process's register set */
89 PFSfpregs, /* the process's FP register set */
90 PFSctl, /* process control */
91 PFSstat, /* process status (if -o linux) */
92 PFSstatus, /* process status */
93 PFSnote, /* process notifier */
94 PFSnotepg, /* process group notifier */
95 PFSmap, /* memory map */
96 PFScmdline, /* process command line args */
97 PFSmeminfo, /* system memory info (if -o linux) */
98 PFScpuinfo, /* CPU info (if -o linux) */
99 PFSmaps, /* memory map, Linux style (if -o linux) */
100 PFSfd, /* a directory containing the processes open fd's */
101 PFSuptime, /* elapsed time since (if -o linux) */
102 PFSmounts, /* mounted filesystems (if -o linux) */
103 #ifdef __HAVE_PROCFS_MACHDEP
104 PROCFS_MACHDEP_NODE_TYPES
105 #endif
106 } pfstype;
107
108 /*
109 * control data for the proc file system.
110 */
111 struct pfsnode {
112 LIST_ENTRY(pfsnode) pfs_hash; /* hash chain */
113 struct vnode *pfs_vnode; /* vnode associated with this pfsnode */
114 pfstype pfs_type; /* type of procfs node */
115 pid_t pfs_pid; /* associated process */
116 int pfs_fd; /* associated fd if not -1 */
117 mode_t pfs_mode; /* mode bits for stat() */
118 u_long pfs_flags; /* open flags */
119 u_long pfs_fileno; /* unique file id */
120 };
121
122 #define PROCFS_NOTELEN 64 /* max length of a note (/proc/$pid/note) */
123 #define PROCFS_CTLLEN 8 /* max length of a ctl msg (/proc/$pid/ctl */
124
125 #endif /* _KERNEL */
126
127 struct procfs_args {
128 int version;
129 int flags;
130 };
131
132 #define PROCFS_ARGSVERSION 1
133
134 #define PROCFSMNT_LINUXCOMPAT 0x01
135
136 #define PROCFSMNT_BITS "\177\20" \
137 "b\00linuxcompat\0"
138
139 /*
140 * Kernel stuff follows
141 */
142 #ifdef _KERNEL
143 #define CNEQ(cnp, s, len) \
144 ((cnp)->cn_namelen == (len) && \
145 (memcmp((s), (cnp)->cn_nameptr, (len)) == 0))
146
147 #define UIO_MX 32
148
149 #define PROCFS_FILENO(pid, type, fd) \
150 (((type) < PFSproc) ? ((type) + 2) : \
151 (((fd) == -1) ? ((((pid)+1) << 5) + ((int) (type))) : \
152 ((((pid)+1) << 16) | ((fd) << 5) | ((int) (type)))))
153
154 struct procfsmount {
155 void *pmnt_exechook;
156 int pmnt_flags;
157 };
158
159 #define VFSTOPROC(mp) ((struct procfsmount *)(mp)->mnt_data)
160
161 /*
162 * Convert between pfsnode vnode
163 */
164 #define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data)
165 #define PFSTOV(pfs) ((pfs)->pfs_vnode)
166
167 typedef struct vfs_namemap vfs_namemap_t;
168 struct vfs_namemap {
169 const char *nm_name;
170 int nm_val;
171 };
172
173 int vfs_getuserstr __P((struct uio *, char *, int *));
174 const vfs_namemap_t *vfs_findname __P((const vfs_namemap_t *, const char *, int));
175
176 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
177 int procfs_freevp __P((struct vnode *));
178 int procfs_allocvp __P((struct mount *, struct vnode **, pid_t, pfstype, int));
179 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *,
180 struct uio *));
181 int procfs_doregs __P((struct proc *, struct lwp *, struct pfsnode *,
182 struct uio *));
183 int procfs_dofpregs __P((struct proc *, struct lwp *, struct pfsnode *,
184 struct uio *));
185 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *,
186 struct uio *));
187 int procfs_doctl __P((struct proc *, struct lwp *, struct pfsnode *,
188 struct uio *));
189 int procfs_do_pid_stat __P((struct proc *, struct lwp *, struct pfsnode *,
190 struct uio *));
191 int procfs_dostatus __P((struct proc *, struct lwp *, struct pfsnode *,
192 struct uio *));
193 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *,
194 struct uio *, int));
195 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *,
196 struct uio *));
197 int procfs_domeminfo __P((struct proc *, struct proc *, struct pfsnode *,
198 struct uio *));
199 int procfs_docpuinfo __P((struct proc *, struct proc *, struct pfsnode *,
200 struct uio *));
201 int procfs_dofd __P((struct proc *, struct proc *, struct pfsnode *,
202 struct uio *));
203 int procfs_douptime __P((struct proc *, struct proc *, struct pfsnode *,
204 struct uio *));
205 int procfs_domounts __P((struct proc *, struct proc *, struct pfsnode *,
206 struct uio *));
207
208 void procfs_revoke_vnodes __P((struct proc *, void *));
209 void procfs_hashinit __P((void));
210 void procfs_hashreinit __P((void));
211 void procfs_hashdone __P((void));
212 int procfs_getfp __P((struct pfsnode *, struct proc **, struct file **));
213
214 /* functions to check whether or not files should be displayed */
215 int procfs_validfile __P((struct proc *, struct mount *));
216 int procfs_validfpregs __P((struct proc *, struct mount *));
217 int procfs_validregs __P((struct proc *, struct mount *));
218 int procfs_validmap __P((struct proc *, struct mount *));
219
220 int procfs_rw __P((void *));
221
222 int procfs_getcpuinfstr __P((char *, int *));
223
224 #define PROCFS_LOCKED 0x01
225 #define PROCFS_WANT 0x02
226
227 extern int (**procfs_vnodeop_p) __P((void *));
228 extern struct vfsops procfs_vfsops;
229
230 int procfs_root __P((struct mount *, struct vnode **));
231
232 #ifdef __HAVE_PROCFS_MACHDEP
233 struct vattr;
234
235 void procfs_machdep_allocvp(struct vnode *);
236 int procfs_machdep_rw(struct proc *, struct lwp *, struct pfsnode *,
237 struct uio *);
238 int procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *);
239 #endif
240
241 #ifdef SYSCTL_SETUP_PROTO
242 SYSCTL_SETUP_PROTO(sysctl_vfs_procfs_setup);
243 #endif /* SYSCTL_SETUP_PROTO */
244 #endif /* _KERNEL */
245