1 /*- 2 * Copyright (c) 1982, 1986, 1989, 1991, 1993 3 * The Regents of the University of California. 4 * Copyright (c) 2007 Robert N. M. Watson 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 4. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)user.h 8.2 (Berkeley) 9/23/93 32 * $FreeBSD$ 33 */ 34 35 #ifndef _SYS_USER_H_ 36 #define _SYS_USER_H_ 37 38 #include <machine/pcb.h> 39 #ifndef _KERNEL 40 /* stuff that *used* to be included by user.h, or is now needed */ 41 #include <sys/errno.h> 42 #include <sys/time.h> 43 #include <sys/resource.h> 44 #include <sys/ucred.h> 45 #include <sys/uio.h> 46 #include <sys/queue.h> 47 #include <sys/_lock.h> 48 #include <sys/_mutex.h> 49 #include <sys/proc.h> 50 #include <vm/vm.h> /* XXX */ 51 #include <vm/vm_param.h> /* XXX */ 52 #include <vm/pmap.h> /* XXX */ 53 #include <vm/vm_map.h> /* XXX */ 54 #endif /* !_KERNEL */ 55 #ifndef _SYS_RESOURCEVAR_H_ 56 #include <sys/resourcevar.h> 57 #endif 58 #ifndef _SYS_SIGNALVAR_H_ 59 #include <sys/signalvar.h> 60 #endif 61 #ifndef _SYS_SOCKET_VAR_H_ 62 #include <sys/socket.h> 63 #endif 64 65 /* 66 * KERN_PROC subtype ops return arrays of selected proc structure entries: 67 * 68 * This struct includes several arrays of spare space, with different arrays 69 * for different standard C-types. When adding new variables to this struct, 70 * the space for byte-aligned data should be taken from the ki_sparestring, 71 * pointers from ki_spareptrs, word-aligned data from ki_spareints, and 72 * doubleword-aligned data from ki_sparelongs. Make sure the space for new 73 * variables come from the array which matches the size and alignment of 74 * those variables on ALL hardware platforms, and then adjust the appropriate 75 * KI_NSPARE_* value(s) to match. 76 * 77 * Always verify that sizeof(struct kinfo_proc) == KINFO_PROC_SIZE on all 78 * platforms after you have added new variables. Note that if you change 79 * the value of KINFO_PROC_SIZE, then many userland programs will stop 80 * working until they are recompiled! 81 * 82 * Once you have added the new field, you will need to add code to initialize 83 * it in two places: function fill_kinfo_proc in sys/kern/kern_proc.c and 84 * function kvm_proclist in lib/libkvm/kvm_proc.c . 85 */ 86 #define KI_NSPARE_INT 9 87 #define KI_NSPARE_LONG 12 88 #define KI_NSPARE_PTR 7 89 90 #ifdef __amd64__ 91 #define KINFO_PROC_SIZE 1088 92 #endif 93 #ifdef __arm__ 94 #define KINFO_PROC_SIZE 792 95 #endif 96 #ifdef __ia64__ 97 #define KINFO_PROC_SIZE 1088 98 #endif 99 #ifdef __i386__ 100 #define KINFO_PROC_SIZE 768 101 #endif 102 #ifdef __mips__ 103 #define KINFO_PROC_SIZE 816 104 #endif 105 #ifdef __powerpc__ 106 #define KINFO_PROC_SIZE 768 107 #endif 108 #ifdef __sparc64__ 109 #define KINFO_PROC_SIZE 1088 110 #endif 111 #ifndef KINFO_PROC_SIZE 112 #error "Unknown architecture" 113 #endif 114 115 #define WMESGLEN 8 /* size of returned wchan message */ 116 #define LOCKNAMELEN 8 /* size of returned lock name */ 117 #define OCOMMLEN 16 /* size of returned thread name */ 118 #define COMMLEN 19 /* size of returned ki_comm name */ 119 #define KI_EMULNAMELEN 16 /* size of returned ki_emul */ 120 #define KI_NGROUPS 16 /* number of groups in ki_groups */ 121 #define LOGNAMELEN 17 /* size of returned ki_login */ 122 123 struct kinfo_proc { 124 int ki_structsize; /* size of this structure */ 125 int ki_layout; /* reserved: layout identifier */ 126 struct pargs *ki_args; /* address of command arguments */ 127 struct proc *ki_paddr; /* address of proc */ 128 struct user *ki_addr; /* kernel virtual addr of u-area */ 129 struct vnode *ki_tracep; /* pointer to trace file */ 130 struct vnode *ki_textvp; /* pointer to executable file */ 131 struct filedesc *ki_fd; /* pointer to open file info */ 132 struct vmspace *ki_vmspace; /* pointer to kernel vmspace struct */ 133 void *ki_wchan; /* sleep address */ 134 pid_t ki_pid; /* Process identifier */ 135 pid_t ki_ppid; /* parent process id */ 136 pid_t ki_pgid; /* process group id */ 137 pid_t ki_tpgid; /* tty process group id */ 138 pid_t ki_sid; /* Process session ID */ 139 pid_t ki_tsid; /* Terminal session ID */ 140 short ki_jobc; /* job control counter */ 141 short ki_spare_short1; /* unused (just here for alignment) */ 142 dev_t ki_tdev; /* controlling tty dev */ 143 sigset_t ki_siglist; /* Signals arrived but not delivered */ 144 sigset_t ki_sigmask; /* Current signal mask */ 145 sigset_t ki_sigignore; /* Signals being ignored */ 146 sigset_t ki_sigcatch; /* Signals being caught by user */ 147 uid_t ki_uid; /* effective user id */ 148 uid_t ki_ruid; /* Real user id */ 149 uid_t ki_svuid; /* Saved effective user id */ 150 gid_t ki_rgid; /* Real group id */ 151 gid_t ki_svgid; /* Saved effective group id */ 152 short ki_ngroups; /* number of groups */ 153 short ki_spare_short2; /* unused (just here for alignment) */ 154 gid_t ki_groups[KI_NGROUPS]; /* groups */ 155 vm_size_t ki_size; /* virtual size */ 156 segsz_t ki_rssize; /* current resident set size in pages */ 157 segsz_t ki_swrss; /* resident set size before last swap */ 158 segsz_t ki_tsize; /* text size (pages) XXX */ 159 segsz_t ki_dsize; /* data size (pages) XXX */ 160 segsz_t ki_ssize; /* stack size (pages) */ 161 u_short ki_xstat; /* Exit status for wait & stop signal */ 162 u_short ki_acflag; /* Accounting flags */ 163 fixpt_t ki_pctcpu; /* %cpu for process during ki_swtime */ 164 u_int ki_estcpu; /* Time averaged value of ki_cpticks */ 165 u_int ki_slptime; /* Time since last blocked */ 166 u_int ki_swtime; /* Time swapped in or out */ 167 int ki_spareint1; /* unused (just here for alignment) */ 168 u_int64_t ki_runtime; /* Real time in microsec */ 169 struct timeval ki_start; /* starting time */ 170 struct timeval ki_childtime; /* time used by process children */ 171 long ki_flag; /* P_* flags */ 172 long ki_kiflag; /* KI_* flags (below) */ 173 int ki_traceflag; /* Kernel trace points */ 174 char ki_stat; /* S* process status */ 175 signed char ki_nice; /* Process "nice" value */ 176 char ki_lock; /* Process lock (prevent swap) count */ 177 char ki_rqindex; /* Run queue index */ 178 u_char ki_oncpu; /* Which cpu we are on */ 179 u_char ki_lastcpu; /* Last cpu we were on */ 180 char ki_ocomm[OCOMMLEN+1]; /* thread name */ 181 char ki_wmesg[WMESGLEN+1]; /* wchan message */ 182 char ki_login[LOGNAMELEN+1]; /* setlogin name */ 183 char ki_lockname[LOCKNAMELEN+1]; /* lock name */ 184 char ki_comm[COMMLEN+1]; /* command name */ 185 char ki_emul[KI_EMULNAMELEN+1]; /* emulation name */ 186 /* 187 * When adding new variables, take space for char-strings from the 188 * front of ki_sparestrings, and ints from the end of ki_spareints. 189 * That way the spare room from both arrays will remain contiguous. 190 */ 191 char ki_sparestrings[68]; /* spare string space */ 192 int ki_spareints[KI_NSPARE_INT]; /* spare room for growth */ 193 u_int ki_cr_flags; /* Credential flags */ 194 int ki_jid; /* Process jail ID */ 195 int ki_numthreads; /* XXXKSE number of threads in total */ 196 lwpid_t ki_tid; /* XXXKSE thread id */ 197 struct priority ki_pri; /* process priority */ 198 struct rusage ki_rusage; /* process rusage statistics */ 199 /* XXX - most fields in ki_rusage_ch are not (yet) filled in */ 200 struct rusage ki_rusage_ch; /* rusage of children processes */ 201 struct pcb *ki_pcb; /* kernel virtual addr of pcb */ 202 void *ki_kstack; /* kernel virtual addr of stack */ 203 void *ki_udata; /* User convenience pointer */ 204 /* 205 * When adding new variables, take space for pointers from the 206 * front of ki_spareptrs, and longs from the end of ki_sparelongs. 207 * That way the spare room from both arrays will remain contiguous. 208 */ 209 void *ki_spareptrs[KI_NSPARE_PTR]; /* spare room for growth */ 210 long ki_sparelongs[KI_NSPARE_LONG]; /* spare room for growth */ 211 long ki_sflag; /* PS_* flags */ 212 long ki_tdflags; /* XXXKSE kthread flag */ 213 }; 214 void fill_kinfo_proc(struct proc *, struct kinfo_proc *); 215 /* XXX - the following two defines are temporary */ 216 #define ki_childstime ki_rusage_ch.ru_stime 217 #define ki_childutime ki_rusage_ch.ru_utime 218 219 /* 220 * Legacy PS_ flag. This moved to p_flag but is maintained for 221 * compatibility. 222 */ 223 #define PS_INMEM 0x00001 /* Loaded into memory. */ 224 225 /* ki_sessflag values */ 226 #define KI_CTTY 0x00000001 /* controlling tty vnode active */ 227 #define KI_SLEADER 0x00000002 /* session leader */ 228 #define KI_LOCKBLOCK 0x00000004 /* proc blocked on lock ki_lockname */ 229 230 /* 231 * This used to be the per-process structure containing data that 232 * isn't needed in core when the process is swapped out, but now it 233 * remains only for the benefit of a.out core dumps. 234 */ 235 struct user { 236 struct pstats u_stats; /* *p_stats */ 237 struct kinfo_proc u_kproc; /* eproc */ 238 }; 239 240 /* 241 * The KERN_PROC_FILE sysctl allows a process to dump the file descriptor 242 * array of another process. 243 */ 244 #define KF_TYPE_NONE 0 245 #define KF_TYPE_VNODE 1 246 #define KF_TYPE_SOCKET 2 247 #define KF_TYPE_PIPE 3 248 #define KF_TYPE_FIFO 4 249 #define KF_TYPE_KQUEUE 5 250 #define KF_TYPE_CRYPTO 6 251 #define KF_TYPE_MQUEUE 7 252 #define KF_TYPE_SHM 8 253 #define KF_TYPE_SEM 9 254 #define KF_TYPE_PTS 10 255 #define KF_TYPE_UNKNOWN 255 256 257 #define KF_VTYPE_VNON 0 258 #define KF_VTYPE_VREG 1 259 #define KF_VTYPE_VDIR 2 260 #define KF_VTYPE_VBLK 3 261 #define KF_VTYPE_VCHR 4 262 #define KF_VTYPE_VLNK 5 263 #define KF_VTYPE_VSOCK 6 264 #define KF_VTYPE_VFIFO 7 265 #define KF_VTYPE_VBAD 8 266 #define KF_VTYPE_UNKNOWN 255 267 268 #define KF_FD_TYPE_CWD -1 /* Current working directory */ 269 #define KF_FD_TYPE_ROOT -2 /* Root directory */ 270 #define KF_FD_TYPE_JAIL -3 /* Jail directory */ 271 272 #define KF_FLAG_READ 0x00000001 273 #define KF_FLAG_WRITE 0x00000002 274 #define KF_FLAG_APPEND 0x00000004 275 #define KF_FLAG_ASYNC 0x00000008 276 #define KF_FLAG_FSYNC 0x00000010 277 #define KF_FLAG_NONBLOCK 0x00000020 278 #define KF_FLAG_DIRECT 0x00000040 279 #define KF_FLAG_HASLOCK 0x00000080 280 281 /* 282 * Old format. Has variable hidden padding due to alignment. 283 * This is a compatability hack for pre-build 7.1 packages. 284 */ 285 #if defined(__amd64__) 286 #define KINFO_OFILE_SIZE 1328 287 #endif 288 #if defined(__i386__) 289 #define KINFO_OFILE_SIZE 1324 290 #endif 291 292 struct kinfo_ofile { 293 int kf_structsize; /* Size of kinfo_file. */ 294 int kf_type; /* Descriptor type. */ 295 int kf_fd; /* Array index. */ 296 int kf_ref_count; /* Reference count. */ 297 int kf_flags; /* Flags. */ 298 /* XXX Hidden alignment padding here on amd64 */ 299 off_t kf_offset; /* Seek location. */ 300 int kf_vnode_type; /* Vnode type. */ 301 int kf_sock_domain; /* Socket domain. */ 302 int kf_sock_type; /* Socket type. */ 303 int kf_sock_protocol; /* Socket protocol. */ 304 char kf_path[PATH_MAX]; /* Path to file, if any. */ 305 struct sockaddr_storage kf_sa_local; /* Socket address. */ 306 struct sockaddr_storage kf_sa_peer; /* Peer address. */ 307 }; 308 309 #if defined(__amd64__) || defined(__i386__) 310 #define KINFO_FILE_SIZE 1392 311 #endif 312 313 struct kinfo_file { 314 int kf_structsize; /* Variable size of record. */ 315 int kf_type; /* Descriptor type. */ 316 int kf_fd; /* Array index. */ 317 int kf_ref_count; /* Reference count. */ 318 int kf_flags; /* Flags. */ 319 int _kf_pad0; /* Round to 64 bit alignment */ 320 int64_t kf_offset; /* Seek location. */ 321 int kf_vnode_type; /* Vnode type. */ 322 int kf_sock_domain; /* Socket domain. */ 323 int kf_sock_type; /* Socket type. */ 324 int kf_sock_protocol; /* Socket protocol. */ 325 struct sockaddr_storage kf_sa_local; /* Socket address. */ 326 struct sockaddr_storage kf_sa_peer; /* Peer address. */ 327 int _kf_ispare[16]; /* Space for more stuff. */ 328 /* Truncated before copyout in sysctl */ 329 char kf_path[PATH_MAX]; /* Path to file, if any. */ 330 }; 331 332 /* 333 * The KERN_PROC_VMMAP sysctl allows a process to dump the VM layout of 334 * another process as a series of entries. 335 */ 336 #define KVME_TYPE_NONE 0 337 #define KVME_TYPE_DEFAULT 1 338 #define KVME_TYPE_VNODE 2 339 #define KVME_TYPE_SWAP 3 340 #define KVME_TYPE_DEVICE 4 341 #define KVME_TYPE_PHYS 5 342 #define KVME_TYPE_DEAD 6 343 #define KVME_TYPE_UNKNOWN 255 344 345 #define KVME_PROT_READ 0x00000001 346 #define KVME_PROT_WRITE 0x00000002 347 #define KVME_PROT_EXEC 0x00000004 348 349 #define KVME_FLAG_COW 0x00000001 350 #define KVME_FLAG_NEEDS_COPY 0x00000002 351 352 #if defined(__amd64__) 353 #define KINFO_OVMENTRY_SIZE 1168 354 #endif 355 #if defined(__i386__) 356 #define KINFO_OVMENTRY_SIZE 1128 357 #endif 358 359 struct kinfo_ovmentry { 360 int kve_structsize; /* Size of kinfo_vmmapentry. */ 361 int kve_type; /* Type of map entry. */ 362 void *kve_start; /* Starting address. */ 363 void *kve_end; /* Finishing address. */ 364 int kve_flags; /* Flags on map entry. */ 365 int kve_resident; /* Number of resident pages. */ 366 int kve_private_resident; /* Number of private pages. */ 367 int kve_protection; /* Protection bitmask. */ 368 int kve_ref_count; /* VM obj ref count. */ 369 int kve_shadow_count; /* VM obj shadow count. */ 370 char kve_path[PATH_MAX]; /* Path to VM obj, if any. */ 371 void *_kve_pspare[8]; /* Space for more stuff. */ 372 off_t kve_offset; /* Mapping offset in object */ 373 uint64_t kve_fileid; /* inode number if vnode */ 374 dev_t kve_fsid; /* dev_t of vnode location */ 375 int _kve_ispare[3]; /* Space for more stuff. */ 376 }; 377 378 #if defined(__amd64__) || defined(__i386__) 379 #define KINFO_VMENTRY_SIZE 1160 380 #endif 381 382 struct kinfo_vmentry { 383 int kve_structsize; /* Variable size of record. */ 384 int kve_type; /* Type of map entry. */ 385 uint64_t kve_start; /* Starting address. */ 386 uint64_t kve_end; /* Finishing address. */ 387 uint64_t kve_offset; /* Mapping offset in object */ 388 uint64_t kve_fileid; /* inode number if vnode */ 389 uint32_t kve_fsid; /* dev_t of vnode location */ 390 int kve_flags; /* Flags on map entry. */ 391 int kve_resident; /* Number of resident pages. */ 392 int kve_private_resident; /* Number of private pages. */ 393 int kve_protection; /* Protection bitmask. */ 394 int kve_ref_count; /* VM obj ref count. */ 395 int kve_shadow_count; /* VM obj shadow count. */ 396 int _kve_pad0; /* 64bit align next field */ 397 int _kve_ispare[16]; /* Space for more stuff. */ 398 /* Truncated before copyout in sysctl */ 399 char kve_path[PATH_MAX]; /* Path to VM obj, if any. */ 400 }; 401 402 /* 403 * The KERN_PROC_KSTACK sysctl allows a process to dump the kernel stacks of 404 * another process as a series of entries. Each stack is represented by a 405 * series of symbol names and offsets as generated by stack_sbuf_print(9). 406 */ 407 #define KKST_MAXLEN 1024 408 409 #define KKST_STATE_STACKOK 0 /* Stack is valid. */ 410 #define KKST_STATE_SWAPPED 1 /* Stack swapped out. */ 411 #define KKST_STATE_RUNNING 2 /* Stack ephemeral. */ 412 413 #if defined(__amd64__) || defined(__i386__) 414 #define KINFO_KSTACK_SIZE 1096 415 #endif 416 417 struct kinfo_kstack { 418 lwpid_t kkst_tid; /* ID of thread. */ 419 int kkst_state; /* Validity of stack. */ 420 char kkst_trace[KKST_MAXLEN]; /* String representing stack. */ 421 int _kkst_ispare[16]; /* Space for more stuff. */ 422 }; 423 424 #endif 425