procfs.h revision 1.86
1 /* $NetBSD: procfs.h,v 1.86 2024/05/12 17:26:50 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 #include <sys/proc.h> 79 80 /* 81 * The different types of node in a procfs filesystem 82 */ 83 typedef enum { 84 PFSauxv, /* ELF Auxiliary Vector */ 85 PFSchroot, /* the process's current root directory */ 86 PFScmdline, /* process command line args */ 87 PFScpuinfo, /* CPU info (if -o linux) */ 88 PFScpustat, /* status info (if -o linux) */ 89 PFScurproc, /* symbolic link for curproc */ 90 PFScwd, /* the process's current working directory */ 91 PFSdevices, /* major/device name mappings (if -o linux) */ 92 PFSemul, /* the process's emulation */ 93 PFSenviron, /* process environment */ 94 PFSexe, /* symlink to the executable file */ 95 PFSfd, /* a directory containing the processes open fd's */ 96 PFSfile, /* the executable file */ 97 PFSfpregs, /* the process's FP register set */ 98 PFSloadavg, /* load average (if -o linux) */ 99 PFSlimit, /* resource limits */ 100 PFSlimits, /* resource limits, Linux style (if -o linux) */ 101 PFSmap, /* memory map */ 102 PFSmaps, /* memory map, Linux style (if -o linux) */ 103 PFSmem, /* the process's memory image */ 104 PFSmeminfo, /* system memory info (if -o linux) */ 105 PFSmounts, /* mounted filesystems (if -o linux) */ 106 PFSnote, /* process notifier */ 107 PFSnotepg, /* process group notifier */ 108 PFSproc, /* a process-specific sub-directory */ 109 PFSregs, /* the process's register set */ 110 PFSroot, /* the filesystem root */ 111 PFSself, /* like curproc, but this is the Linux name */ 112 PFSstat, /* process status (if -o linux) */ 113 PFSstatm, /* process memory info (if -o linux) */ 114 PFSstatus, /* process status */ 115 PFSsysvipc, /* sysvipc subdirectory (if -o linux) */ 116 PFSsysvipc_msg, /* sysvipc msg info (if -o linux) */ 117 PFSsysvipc_sem, /* sysvipc sem info (if -o linux) */ 118 PFSsysvipc_shm, /* sysvipc shm info (if -o linux) */ 119 PFStask, /* task subdirectory (if -o linux) */ 120 PFSuptime, /* elapsed time since (if -o linux) */ 121 PFSversion, /* kernel version (if -o linux) */ 122 #ifdef __HAVE_PROCFS_MACHDEP 123 PROCFS_MACHDEP_NODE_TYPES 124 #endif 125 PFSlast, /* track number of types */ 126 } pfstype; 127 128 /* 129 * control data for the proc file system. 130 */ 131 struct pfskey { 132 pfstype pk_type; /* type of procfs node */ 133 pid_t pk_pid; /* associated process */ 134 int pk_fd; /* associated fd if not -1 */ 135 }; 136 struct pfsnode { 137 LIST_ENTRY(pfsnode) pfs_hash; /* per pid hash list */ 138 struct vnode *pfs_vnode; /* vnode associated with this pfsnode */ 139 struct mount *pfs_mount; /* mount associated with this pfsnode */ 140 struct pfskey pfs_key; 141 #define pfs_type pfs_key.pk_type 142 #define pfs_pid pfs_key.pk_pid 143 #define pfs_fd pfs_key.pk_fd 144 mode_t pfs_mode; /* mode bits for stat() */ 145 u_long pfs_flags; /* open flags */ 146 uint64_t pfs_fileno; /* unique file id */ 147 }; 148 149 #define PROCFS_NOTELEN 64 /* max length of a note (/proc/$pid/note) */ 150 #define PROCFS_MAXNAMLEN 255 151 152 #endif /* _KERNEL */ 153 154 struct procfs_args { 155 int version; 156 int flags; 157 }; 158 159 #define PROCFS_ARGSVERSION 1 160 161 #define PROCFSMNT_LINUXCOMPAT 0x01 162 163 #define PROCFSMNT_BITS "\177\20" \ 164 "b\00linuxcompat\0" 165 166 /* 167 * Kernel stuff follows 168 */ 169 #ifdef _KERNEL 170 #define CNEQ(cnp, s, len) \ 171 ((cnp)->cn_namelen == (len) && \ 172 (memcmp((s), (cnp)->cn_nameptr, (len)) == 0)) 173 174 #define UIO_MX 32 175 176 static __inline ino_t 177 procfs_fileno(pid_t _pid, pfstype _type, int _fd) 178 { 179 ino_t _ino; 180 switch (_type) { 181 case PFSroot: 182 return 2; 183 case PFScurproc: 184 return 3; 185 case PFSself: 186 return 4; 187 default: 188 _ino = _pid + 1; 189 if (_fd != -1) 190 _ino = _ino << 32 | _fd; 191 return _ino * PFSlast + _type; 192 } 193 } 194 195 #define PROCFS_FILENO(pid, type, fd) procfs_fileno(pid, type, fd) 196 197 #define PROCFS_TYPE(type) ((type) % PFSlast) 198 199 struct procfsmount { 200 int pmnt_flags; 201 }; 202 203 #define VFSTOPROC(mp) ((struct procfsmount *)(mp)->mnt_data) 204 205 /* 206 * Convert between pfsnode vnode 207 */ 208 #define VTOPFS(vp) ((struct pfsnode *)(vp)->v_data) 209 #define PFSTOV(pfs) ((pfs)->pfs_vnode) 210 211 typedef struct vfs_namemap vfs_namemap_t; 212 struct vfs_namemap { 213 const char *nm_name; 214 int nm_val; 215 }; 216 217 int vfs_getuserstr(struct uio *, char *, int *); 218 const vfs_namemap_t *vfs_findname(const vfs_namemap_t *, const char *, int); 219 220 struct mount; 221 222 struct proc *procfs_proc_find(struct mount *, pid_t); 223 bool procfs_use_linux_compat(struct mount *); 224 225 static inline bool 226 procfs_proc_is_linux_compat(void) 227 { 228 const char *emulname = curlwp->l_proc->p_emul->e_name; 229 return (strncmp(emulname, "linux", 5) == 0); 230 } 231 232 int procfs_proc_lock(struct mount *, int, struct proc **, int); 233 void procfs_proc_unlock(struct proc *); 234 int procfs_allocvp(struct mount *, struct vnode **, pid_t, pfstype, int); 235 int procfs_donote(struct lwp *, struct proc *, struct pfsnode *, 236 struct uio *); 237 int procfs_doregs(struct lwp *, struct lwp *, struct pfsnode *, 238 struct uio *); 239 int procfs_dofpregs(struct lwp *, struct lwp *, struct pfsnode *, 240 struct uio *); 241 int procfs_domem(struct lwp *, struct lwp *, struct pfsnode *, 242 struct uio *); 243 int procfs_do_pid_stat(struct lwp *, struct lwp *, struct pfsnode *, 244 struct uio *); 245 int procfs_dostatus(struct lwp *, struct lwp *, struct pfsnode *, 246 struct uio *); 247 int procfs_domap(struct lwp *, struct proc *, struct pfsnode *, 248 struct uio *, int); 249 int procfs_doprocargs(struct lwp *, struct proc *, struct pfsnode *, 250 struct uio *, int); 251 int procfs_domeminfo(struct lwp *, struct proc *, struct pfsnode *, 252 struct uio *); 253 int procfs_dodevices(struct lwp *, struct proc *, struct pfsnode *, 254 struct uio *); 255 int procfs_docpuinfo(struct lwp *, struct proc *, struct pfsnode *, 256 struct uio *); 257 int procfs_docpustat(struct lwp *, struct proc *, struct pfsnode *, 258 struct uio *); 259 int procfs_doloadavg(struct lwp *, struct proc *, struct pfsnode *, 260 struct uio *); 261 int procfs_do_pid_statm(struct lwp *, struct lwp *, struct pfsnode *, 262 struct uio *); 263 int procfs_dofd(struct lwp *, struct proc *, struct pfsnode *, 264 struct uio *); 265 int procfs_douptime(struct lwp *, struct proc *, struct pfsnode *, 266 struct uio *); 267 int procfs_domounts(struct lwp *, struct proc *, struct pfsnode *, 268 struct uio *); 269 int procfs_doemul(struct lwp *, struct proc *, struct pfsnode *, 270 struct uio *); 271 int procfs_doversion(struct lwp *, struct proc *, struct pfsnode *, 272 struct uio *); 273 int procfs_doauxv(struct lwp *, struct proc *, struct pfsnode *, 274 struct uio *); 275 int procfs_dolimit(struct lwp *, struct proc *, struct pfsnode *, 276 struct uio *); 277 int procfs_dolimits(struct lwp *, struct proc *, struct pfsnode *, 278 struct uio *); 279 int procfs_dosysvipc_msg(struct lwp *, struct proc *, struct pfsnode *, 280 struct uio *); 281 int procfs_dosysvipc_sem(struct lwp *, struct proc *, struct pfsnode *, 282 struct uio *); 283 int procfs_dosysvipc_shm(struct lwp *, struct proc *, struct pfsnode *, 284 struct uio *); 285 286 void procfs_hashrem(struct pfsnode *); 287 int procfs_getfp(struct pfsnode *, struct proc *, struct file **); 288 289 /* functions to check whether or not files should be displayed */ 290 int procfs_validauxv(struct lwp *, struct mount *); 291 int procfs_validfile(struct lwp *, struct mount *); 292 int procfs_validfpregs(struct lwp *, struct mount *); 293 int procfs_validregs(struct lwp *, struct mount *); 294 int procfs_validmap(struct lwp *, struct mount *); 295 296 int procfs_rw(void *); 297 298 int procfs_getcpuinfstr(char *, size_t *); 299 300 #define PROCFS_LOCKED 0x01 301 #define PROCFS_WANT 0x02 302 303 extern int (**procfs_vnodeop_p)(void *); 304 extern struct vfsops procfs_vfsops; 305 306 int procfs_root(struct mount *, int, struct vnode **); 307 308 #ifdef __HAVE_PROCFS_MACHDEP 309 struct vattr; 310 311 void procfs_machdep_allocvp(struct vnode *); 312 int procfs_machdep_rw(struct lwp *, struct lwp *, struct pfsnode *, 313 struct uio *); 314 int procfs_machdep_getattr(struct vnode *, struct vattr *, struct proc *); 315 #endif 316 317 #endif /* _KERNEL */ 318
Indexes created Thu Oct 02 14:10:14 GMT 2025