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