procfs.h revision 1.34.2.1 1 /* $NetBSD: procfs.h,v 1.34.2.1 2002/01/10 20:01:41 thorpej 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 /* This also pulls in __HAVE_PROCFS_MACHDEP */
43 #include <sys/ptrace.h>
44
45 /*
46 * The different types of node in a procfs filesystem
47 */
48 typedef enum {
49 Proot, /* the filesystem root */
50 Pcurproc, /* symbolic link for curproc */
51 Pself, /* like curproc, but this is the Linux name */
52 Pproc, /* a process-specific sub-directory */
53 Pfile, /* the executable file */
54 Pmem, /* the process's memory image */
55 Pregs, /* the process's register set */
56 Pfpregs, /* the process's FP register set */
57 Pctl, /* process control */
58 Pstatus, /* process status */
59 Pnote, /* process notifier */
60 Pnotepg, /* process group notifier */
61 Pmap, /* memory map */
62 Pcmdline, /* process command line args */
63 Pmeminfo, /* system memory info (if -o linux) */
64 Pcpuinfo, /* CPU info (if -o linux) */
65 Pmaps, /* memory map, Linux style (if -o linux) */
66 #ifdef __HAVE_PROCFS_MACHDEP
67 PROCFS_MACHDEP_NODE_TYPES
68 #endif
69 } pfstype;
70
71 /*
72 * control data for the proc file system.
73 */
74 struct pfsnode {
75 LIST_ENTRY(pfsnode) pfs_hash; /* hash chain */
76 struct vnode *pfs_vnode; /* vnode associated with this pfsnode */
77 pfstype pfs_type; /* type of procfs node */
78 pid_t pfs_pid; /* associated process */
79 mode_t pfs_mode; /* mode bits for stat() */
80 u_long pfs_flags; /* open flags */
81 u_long pfs_fileno; /* unique file id */
82 };
83
84 #define PROCFS_NOTELEN 64 /* max length of a note (/proc/$pid/note) */
85 #define PROCFS_CTLLEN 8 /* max length of a ctl msg (/proc/$pid/ctl */
86
87 struct procfs_args {
88 int version;
89 int flags;
90 };
91
92 #define PROCFS_ARGSVERSION 1
93
94 #define PROCFSMNT_LINUXCOMPAT 0x01
95
96 /*
97 * Kernel stuff follows
98 */
99 #ifdef _KERNEL
100 #define CNEQ(cnp, s, len) \
101 ((cnp)->cn_namelen == (len) && \
102 (memcmp((s), (cnp)->cn_nameptr, (len)) == 0))
103
104 #define UIO_MX 32
105
106 #define PROCFS_FILENO(pid, type) \
107 (((type) < Pproc) ? \
108 ((type) + 2) : \
109 ((((pid)+1) << 4) + ((int) (type))))
110
111 struct procfsmount {
112 void *pmnt_exechook;
113 int pmnt_flags;
114 };
115
116 #define VFSTOPROC(mp) ((struct procfsmount *)(mp)->mnt_data)
117
118 /*
119 * Convert between pfsnode vnode
120 */
121 #define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data)
122 #define PFSTOV(pfs) ((pfs)->pfs_vnode)
123
124 typedef struct vfs_namemap vfs_namemap_t;
125 struct vfs_namemap {
126 const char *nm_name;
127 int nm_val;
128 };
129
130 int vfs_getuserstr __P((struct uio *, char *, int *));
131 const vfs_namemap_t *vfs_findname __P((const vfs_namemap_t *, const char *, int));
132
133 #define PFIND(pid) ((pid) ? pfind(pid) : &proc0)
134 int procfs_freevp __P((struct vnode *));
135 int procfs_allocvp __P((struct mount *, struct vnode **, long, pfstype));
136 int procfs_donote __P((struct proc *, struct proc *, struct pfsnode *,
137 struct uio *));
138 int procfs_doregs __P((struct proc *, struct proc *, struct pfsnode *,
139 struct uio *));
140 int procfs_dofpregs __P((struct proc *, struct proc *, struct pfsnode *,
141 struct uio *));
142 int procfs_domem __P((struct proc *, struct proc *, struct pfsnode *,
143 struct uio *));
144 int procfs_doctl __P((struct proc *, struct proc *, struct pfsnode *,
145 struct uio *));
146 int procfs_dostatus __P((struct proc *, struct proc *, struct pfsnode *,
147 struct uio *));
148 int procfs_domap __P((struct proc *, struct proc *, struct pfsnode *,
149 struct uio *, int));
150 int procfs_docmdline __P((struct proc *, struct proc *, struct pfsnode *,
151 struct uio *));
152 int procfs_domeminfo __P((struct proc *, struct proc *, struct pfsnode *,
153 struct uio *));
154 int procfs_docpuinfo __P((struct proc *, struct proc *, struct pfsnode *,
155 struct uio *));
156
157 int procfs_checkioperm __P((struct proc *, struct proc *));
158 void procfs_revoke_vnodes __P((struct proc *, void *));
159 void procfs_hashinit __P((void));
160 void procfs_hashreinit __P((void));
161 void procfs_hashdone __P((void));
162
163 /* functions to check whether or not files should be displayed */
164 int procfs_validfile __P((struct proc *, struct mount *));
165 int procfs_validfpregs __P((struct proc *, struct mount *));
166 int procfs_validregs __P((struct proc *, struct mount *));
167 int procfs_validmap __P((struct proc *, struct mount *));
168
169 int procfs_rw __P((void *));
170
171 int procfs_getcpuinfstr __P((char *, int *));
172
173 #define PROCFS_LOCKED 0x01
174 #define PROCFS_WANT 0x02
175
176 extern int (**procfs_vnodeop_p) __P((void *));
177 extern struct vfsops procfs_vfsops;
178
179 int procfs_root __P((struct mount *, struct vnode **));
180
181 #ifdef __HAVE_PROCFS_MACHDEP
182 struct vattr;
183
184 void procfs_machdep_allocvp(struct vnode *);
185 int procfs_machdep_rw(struct proc *, struct proc *, struct pfsnode *,
186 struct uio *);
187 int procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *);
188 #endif
189
190 #endif /* _KERNEL */
191