procfs.h revision 1.56.12.1 1 /* $NetBSD: procfs.h,v 1.56.12.1 2006/06/21 15:10:26 yamt 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 PFScwd, /* the process's current working directory */
104 PFSchroot, /* the process's current root directory */
105 #ifdef __HAVE_PROCFS_MACHDEP
106 PROCFS_MACHDEP_NODE_TYPES
107 #endif
108 } pfstype;
109
110 /*
111 * control data for the proc file system.
112 */
113 struct pfsnode {
114 LIST_ENTRY(pfsnode) pfs_hash; /* hash chain */
115 struct vnode *pfs_vnode; /* vnode associated with this pfsnode */
116 pfstype pfs_type; /* type of procfs node */
117 pid_t pfs_pid; /* associated process */
118 int pfs_fd; /* associated fd if not -1 */
119 mode_t pfs_mode; /* mode bits for stat() */
120 u_long pfs_flags; /* open flags */
121 u_long pfs_fileno; /* unique file id */
122 };
123
124 #define PROCFS_NOTELEN 64 /* max length of a note (/proc/$pid/note) */
125 #define PROCFS_CTLLEN 8 /* max length of a ctl msg (/proc/$pid/ctl */
126
127 #endif /* _KERNEL */
128
129 struct procfs_args {
130 int version;
131 int flags;
132 };
133
134 #define PROCFS_ARGSVERSION 1
135
136 #define PROCFSMNT_LINUXCOMPAT 0x01
137
138 #define PROCFSMNT_BITS "\177\20" \
139 "b\00linuxcompat\0"
140
141 /*
142 * Kernel stuff follows
143 */
144 #ifdef _KERNEL
145 #define CNEQ(cnp, s, len) \
146 ((cnp)->cn_namelen == (len) && \
147 (memcmp((s), (cnp)->cn_nameptr, (len)) == 0))
148
149 #define UIO_MX 32
150
151 #define PROCFS_FILENO(pid, type, fd) \
152 (((type) < PFSproc) ? ((type) + 2) : \
153 (((fd) == -1) ? ((((pid)+1) << 5) + ((int) (type))) : \
154 ((((pid)+1) << 16) | ((fd) << 5) | ((int) (type)))))
155
156 struct procfsmount {
157 void *pmnt_exechook;
158 int pmnt_flags;
159 };
160
161 #define VFSTOPROC(mp) ((struct procfsmount *)(mp)->mnt_data)
162
163 /*
164 * Convert between pfsnode vnode
165 */
166 #define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data)
167 #define PFSTOV(pfs) ((pfs)->pfs_vnode)
168
169 typedef struct vfs_namemap vfs_namemap_t;
170 struct vfs_namemap {
171 const char *nm_name;
172 int nm_val;
173 };
174
175 int vfs_getuserstr(struct uio *, char *, int *);
176 const vfs_namemap_t *vfs_findname(const vfs_namemap_t *, const char *, int);
177
178 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
179 int procfs_freevp(struct vnode *);
180 int procfs_allocvp(struct mount *, struct vnode **, pid_t, pfstype, int);
181 int procfs_donote(struct lwp *, struct proc *, struct pfsnode *,
182 struct uio *);
183 int procfs_doregs(struct lwp *, struct lwp *, struct pfsnode *,
184 struct uio *);
185 int procfs_dofpregs(struct lwp *, struct lwp *, struct pfsnode *,
186 struct uio *);
187 int procfs_domem(struct lwp *, struct lwp *, struct pfsnode *,
188 struct uio *);
189 int procfs_doctl(struct lwp *, struct lwp *, struct pfsnode *,
190 struct uio *);
191 int procfs_do_pid_stat(struct lwp *, struct lwp *, struct pfsnode *,
192 struct uio *);
193 int procfs_dostatus(struct lwp *, struct lwp *, struct pfsnode *,
194 struct uio *);
195 int procfs_domap(struct lwp *, struct proc *, struct pfsnode *,
196 struct uio *, int);
197 int procfs_docmdline(struct lwp *, struct proc *, struct pfsnode *,
198 struct uio *);
199 int procfs_domeminfo(struct lwp *, struct proc *, struct pfsnode *,
200 struct uio *);
201 int procfs_docpuinfo(struct lwp *, struct proc *, struct pfsnode *,
202 struct uio *);
203 int procfs_dofd(struct lwp *, struct proc *, struct pfsnode *,
204 struct uio *);
205 int procfs_douptime(struct lwp *, struct proc *, struct pfsnode *,
206 struct uio *);
207 int procfs_domounts(struct lwp *, struct proc *, struct pfsnode *,
208 struct uio *);
209
210 void procfs_revoke_vnodes(struct proc *, void *);
211 void procfs_hashinit(void);
212 void procfs_hashreinit(void);
213 void procfs_hashdone(void);
214 int procfs_getfp(struct pfsnode *, struct proc **, struct file **);
215
216 /* functions to check whether or not files should be displayed */
217 int procfs_validfile(struct lwp *, struct mount *);
218 int procfs_validfpregs(struct lwp *, struct mount *);
219 int procfs_validregs(struct lwp *, struct mount *);
220 int procfs_validmap(struct lwp *, struct mount *);
221
222 int procfs_rw(void *);
223
224 int procfs_getcpuinfstr(char *, int *);
225
226 #define PROCFS_LOCKED 0x01
227 #define PROCFS_WANT 0x02
228
229 extern int (**procfs_vnodeop_p)(void *);
230 extern struct vfsops procfs_vfsops;
231
232 int procfs_root(struct mount *, struct vnode **);
233
234 #ifdef __HAVE_PROCFS_MACHDEP
235 struct vattr;
236
237 void procfs_machdep_allocvp(struct vnode *);
238 int procfs_machdep_rw(struct lwp *, struct lwp *, struct pfsnode *,
239 struct uio *);
240 int procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *);
241 #endif
242
243 #ifdef SYSCTL_SETUP_PROTO
244 SYSCTL_SETUP_PROTO(sysctl_vfs_procfs_setup);
245 #endif /* SYSCTL_SETUP_PROTO */
246 #endif /* _KERNEL */
247