1 | /* $NetBSD: procfs.h,v 1.70 2014/07/27 16:47:26 hannken 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 | PFSexe, /* symlink to the executable file */ |
88 | PFSmem, /* the process's memory image */ |
89 | PFSregs, /* the process's register set */ |
90 | PFSfpregs, /* the process's FP register set */ |
91 | PFSctl, /* process control */ |
92 | PFSstat, /* process status (if -o linux) */ |
93 | PFSstatus, /* process status */ |
94 | PFSnote, /* process notifier */ |
95 | PFSnotepg, /* process group notifier */ |
96 | PFSmap, /* memory map */ |
97 | PFScmdline, /* process command line args */ |
98 | PFSmeminfo, /* system memory info (if -o linux) */ |
99 | PFScpuinfo, /* CPU info (if -o linux) */ |
100 | PFSmaps, /* memory map, Linux style (if -o linux) */ |
101 | PFSfd, /* a directory containing the processes open fd's */ |
102 | PFSuptime, /* elapsed time since (if -o linux) */ |
103 | PFSmounts, /* mounted filesystems (if -o linux) */ |
104 | PFScwd, /* the process's current working directory */ |
105 | PFSchroot, /* the process's current root directory */ |
106 | PFSemul, /* the process's emulation */ |
107 | PFSdevices, /* major/device name mappings (if -o linux) */ |
108 | PFScpustat, /* status info (if -o linux) */ |
109 | PFSloadavg, /* load average (if -o linux) */ |
110 | PFSstatm, /* process memory info (if -o linux) */ |
111 | PFSversion, /* kernel version (if -o linux) */ |
112 | PFStask, /* task subdirector (if -o linux) */ |
113 | #ifdef __HAVE_PROCFS_MACHDEP |
114 | PROCFS_MACHDEP_NODE_TYPES |
115 | #endif |
116 | } pfstype; |
117 | |
118 | /* |
119 | * control data for the proc file system. |
120 | */ |
121 | struct pfskey { |
122 | pfstype pk_type; /* type of procfs node */ |
123 | pid_t pk_pid; /* associated process */ |
124 | int pk_fd; /* associated fd if not -1 */ |
125 | }; |
126 | struct pfsnode { |
127 | struct vnode *pfs_vnode; /* vnode associated with this pfsnode */ |
128 | struct pfskey pfs_key; |
129 | #define pfs_type pfs_key.pk_type |
130 | #define pfs_pid pfs_key.pk_pid |
131 | #define pfs_fd pfs_key.pk_fd |
132 | mode_t pfs_mode; /* mode bits for stat() */ |
133 | u_long pfs_flags; /* open flags */ |
134 | u_long pfs_fileno; /* unique file id */ |
135 | }; |
136 | |
137 | #define PROCFS_NOTELEN 64 /* max length of a note (/proc/$pid/note) */ |
138 | #define PROCFS_CTLLEN 8 /* max length of a ctl msg (/proc/$pid/ctl */ |
139 | #define PROCFS_MAXNAMLEN 255 |
140 | |
141 | #endif /* _KERNEL */ |
142 | |
143 | struct procfs_args { |
144 | int version; |
145 | int flags; |
146 | }; |
147 | |
148 | #define PROCFS_ARGSVERSION 1 |
149 | |
150 | #define PROCFSMNT_LINUXCOMPAT 0x01 |
151 | |
152 | #define PROCFSMNT_BITS "\177\20" \ |
153 | "b\00linuxcompat\0" |
154 | |
155 | /* |
156 | * Kernel stuff follows |
157 | */ |
158 | #ifdef _KERNEL |
159 | #define CNEQ(cnp, s, len) \ |
160 | ((cnp)->cn_namelen == (len) && \ |
161 | (memcmp((s), (cnp)->cn_nameptr, (len)) == 0)) |
162 | |
163 | #define UIO_MX 32 |
164 | |
165 | #define PROCFS_FILENO(pid, type, fd) \ |
166 | (((type) < PFSproc) ? ((type) + 2) : \ |
167 | (((fd) == -1) ? ((((pid)+1) << 5) + ((int) (type))) : \ |
168 | ((((pid)+1) << 16) | ((fd) << 5) | ((int) (type))))) |
169 | #define PROCFS_TYPE(type) ((type) & 0x1f) |
170 | |
171 | struct procfsmount { |
172 | void *pmnt_exechook; |
173 | int pmnt_flags; |
174 | }; |
175 | |
176 | #define VFSTOPROC(mp) ((struct procfsmount *)(mp)->mnt_data) |
177 | |
178 | /* |
179 | * Convert between pfsnode vnode |
180 | */ |
181 | #define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data) |
182 | #define PFSTOV(pfs) ((pfs)->pfs_vnode) |
183 | |
184 | typedef struct vfs_namemap vfs_namemap_t; |
185 | struct vfs_namemap { |
186 | const char *nm_name; |
187 | int nm_val; |
188 | }; |
189 | |
190 | int vfs_getuserstr(struct uio *, char *, int *); |
191 | const vfs_namemap_t *vfs_findname(const vfs_namemap_t *, const char *, int); |
192 | |
193 | int procfs_proc_lock(int, struct proc **, int); |
194 | void procfs_proc_unlock(struct proc *); |
195 | int procfs_allocvp(struct mount *, struct vnode **, pid_t, pfstype, int); |
196 | int procfs_donote(struct lwp *, struct proc *, struct pfsnode *, |
197 | struct uio *); |
198 | int procfs_doregs(struct lwp *, struct lwp *, struct pfsnode *, |
199 | struct uio *); |
200 | int procfs_dofpregs(struct lwp *, struct lwp *, struct pfsnode *, |
201 | struct uio *); |
202 | int procfs_domem(struct lwp *, struct lwp *, struct pfsnode *, |
203 | struct uio *); |
204 | int procfs_doctl(struct lwp *, struct lwp *, struct pfsnode *, |
205 | struct uio *); |
206 | int procfs_do_pid_stat(struct lwp *, struct lwp *, struct pfsnode *, |
207 | struct uio *); |
208 | int procfs_dostatus(struct lwp *, struct lwp *, struct pfsnode *, |
209 | struct uio *); |
210 | int procfs_domap(struct lwp *, struct proc *, struct pfsnode *, |
211 | struct uio *, int); |
212 | int procfs_docmdline(struct lwp *, struct proc *, struct pfsnode *, |
213 | struct uio *); |
214 | int procfs_domeminfo(struct lwp *, struct proc *, struct pfsnode *, |
215 | struct uio *); |
216 | int procfs_dodevices(struct lwp *, struct proc *, struct pfsnode *, |
217 | struct uio *); |
218 | int procfs_docpuinfo(struct lwp *, struct proc *, struct pfsnode *, |
219 | struct uio *); |
220 | int procfs_docpustat(struct lwp *, struct proc *, struct pfsnode *, |
221 | struct uio *); |
222 | int procfs_doloadavg(struct lwp *, struct proc *, struct pfsnode *, |
223 | struct uio *); |
224 | int procfs_do_pid_statm(struct lwp *, struct lwp *, struct pfsnode *, |
225 | struct uio *); |
226 | int procfs_dofd(struct lwp *, struct proc *, struct pfsnode *, |
227 | struct uio *); |
228 | int procfs_douptime(struct lwp *, struct proc *, struct pfsnode *, |
229 | struct uio *); |
230 | int procfs_domounts(struct lwp *, struct proc *, struct pfsnode *, |
231 | struct uio *); |
232 | int procfs_doemul(struct lwp *, struct proc *, struct pfsnode *, |
233 | struct uio *); |
234 | int procfs_doversion(struct lwp *, struct proc *, struct pfsnode *, |
235 | struct uio *); |
236 | |
237 | void procfs_revoke_vnodes(struct proc *, void *); |
238 | int procfs_getfp(struct pfsnode *, struct proc *, struct file **); |
239 | |
240 | /* functions to check whether or not files should be displayed */ |
241 | int procfs_validfile(struct lwp *, struct mount *); |
242 | int procfs_validfpregs(struct lwp *, struct mount *); |
243 | int procfs_validregs(struct lwp *, struct mount *); |
244 | int procfs_validmap(struct lwp *, struct mount *); |
245 | |
246 | int procfs_rw(void *); |
247 | |
248 | int procfs_getcpuinfstr(char *, size_t *); |
249 | |
250 | #define PROCFS_LOCKED 0x01 |
251 | #define PROCFS_WANT 0x02 |
252 | |
253 | extern int (**procfs_vnodeop_p)(void *); |
254 | extern struct vfsops procfs_vfsops; |
255 | |
256 | int procfs_root(struct mount *, struct vnode **); |
257 | |
258 | #ifdef __HAVE_PROCFS_MACHDEP |
259 | struct vattr; |
260 | |
261 | void procfs_machdep_allocvp(struct vnode *); |
262 | int procfs_machdep_rw(struct lwp *, struct lwp *, struct pfsnode *, |
263 | struct uio *); |
264 | int procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *); |
265 | #endif |
266 | |
267 | #endif /* _KERNEL */ |
268 | |