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 #ifdef __mips_n64 104 #define KINFO_PROC_SIZE 1088 105 #else 106 #define KINFO_PROC_SIZE 816 107 #endif 108 #endif 109 #ifdef __powerpc__ 110 #define KINFO_PROC_SIZE 768 111 #endif 112 #ifdef __sparc64__ 113 #define KINFO_PROC_SIZE 1088 114 #endif 115 #ifndef KINFO_PROC_SIZE 116 #error "Unknown architecture" 117 #endif 118 119 #define WMESGLEN 8 /* size of returned wchan message */ 120 #define LOCKNAMELEN 8 /* size of returned lock name */ 121 #define OCOMMLEN 16 /* size of returned thread name */ 122 #define COMMLEN 19 /* size of returned ki_comm name */ 123 #define KI_EMULNAMELEN 16 /* size of returned ki_emul */ 124 #define KI_NGROUPS 16 /* number of groups in ki_groups */ 125 #define LOGNAMELEN 17 /* size of returned ki_login */ 126 127 /* 128 * Steal a bit from ki_cr_flags (cr_flags is never used) to indicate 129 * that the cred had more than KI_NGROUPS groups. 130 */ 131 #define KI_CRF_GRP_OVERFLOW 0x80000000 132 133 struct kinfo_proc { 134 int ki_structsize; /* size of this structure */ 135 int ki_layout; /* reserved: layout identifier */ 136 struct pargs *ki_args; /* address of command arguments */ 137 struct proc *ki_paddr; /* address of proc */ 138 struct user *ki_addr; /* kernel virtual addr of u-area */ 139 struct vnode *ki_tracep; /* pointer to trace file */ 140 struct vnode *ki_textvp; /* pointer to executable file */ 141 struct filedesc *ki_fd; /* pointer to open file info */ 142 struct vmspace *ki_vmspace; /* pointer to kernel vmspace struct */ 143 void *ki_wchan; /* sleep address */ 144 pid_t ki_pid; /* Process identifier */ 145 pid_t ki_ppid; /* parent process id */ 146 pid_t ki_pgid; /* process group id */ 147 pid_t ki_tpgid; /* tty process group id */ 148 pid_t ki_sid; /* Process session ID */ 149 pid_t ki_tsid; /* Terminal session ID */ 150 short ki_jobc; /* job control counter */ 151 short ki_spare_short1; /* unused (just here for alignment) */ 152 dev_t ki_tdev; /* controlling tty dev */ 153 sigset_t ki_siglist; /* Signals arrived but not delivered */ 154 sigset_t ki_sigmask; /* Current signal mask */ 155 sigset_t ki_sigignore; /* Signals being ignored */ 156 sigset_t ki_sigcatch; /* Signals being caught by user */ 157 uid_t ki_uid; /* effective user id */ 158 uid_t ki_ruid; /* Real user id */ 159 uid_t ki_svuid; /* Saved effective user id */ 160 gid_t ki_rgid; /* Real group id */ 161 gid_t ki_svgid; /* Saved effective group id */ 162 short ki_ngroups; /* number of groups */ 163 short ki_spare_short2; /* unused (just here for alignment) */ 164 gid_t ki_groups[KI_NGROUPS]; /* groups */ 165 vm_size_t ki_size; /* virtual size */ 166 segsz_t ki_rssize; /* current resident set size in pages */ 167 segsz_t ki_swrss; /* resident set size before last swap */ 168 segsz_t ki_tsize; /* text size (pages) XXX */ 169 segsz_t ki_dsize; /* data size (pages) XXX */ 170 segsz_t ki_ssize; /* stack size (pages) */ 171 u_short ki_xstat; /* Exit status for wait & stop signal */ 172 u_short ki_acflag; /* Accounting flags */ 173 fixpt_t ki_pctcpu; /* %cpu for process during ki_swtime */ 174 u_int ki_estcpu; /* Time averaged value of ki_cpticks */ 175 u_int ki_slptime; /* Time since last blocked */ 176 u_int ki_swtime; /* Time swapped in or out */ 177 int ki_spareint1; /* unused (just here for alignment) */ 178 u_int64_t ki_runtime; /* Real time in microsec */ 179 struct timeval ki_start; /* starting time */ 180 struct timeval ki_childtime; /* time used by process children */ 181 long ki_flag; /* P_* flags */ 182 long ki_kiflag; /* KI_* flags (below) */ 183 int ki_traceflag; /* Kernel trace points */ 184 char ki_stat; /* S* process status */ 185 signed char ki_nice; /* Process "nice" value */ 186 char ki_lock; /* Process lock (prevent swap) count */ 187 char ki_rqindex; /* Run queue index */ 188 u_char ki_oncpu; /* Which cpu we are on */ 189 u_char ki_lastcpu; /* Last cpu we were on */ 190 char ki_ocomm[OCOMMLEN+1]; /* thread name */ 191 char ki_wmesg[WMESGLEN+1]; /* wchan message */ 192 char ki_login[LOGNAMELEN+1]; /* setlogin name */ 193 char ki_lockname[LOCKNAMELEN+1]; /* lock name */ 194 char ki_comm[COMMLEN+1]; /* command name */ 195 char ki_emul[KI_EMULNAMELEN+1]; /* emulation name */ 196 /* 197 * When adding new variables, take space for char-strings from the 198 * front of ki_sparestrings, and ints from the end of ki_spareints. 199 * That way the spare room from both arrays will remain contiguous. 200 */ 201 char ki_sparestrings[68]; /* spare string space */ 202 int ki_spareints[KI_NSPARE_INT]; /* spare room for growth */ 203 u_int ki_cr_flags; /* Credential flags */ 204 int ki_jid; /* Process jail ID */ 205 int ki_numthreads; /* XXXKSE number of threads in total */ 206 lwpid_t ki_tid; /* XXXKSE thread id */ 207 struct priority ki_pri; /* process priority */ 208 struct rusage ki_rusage; /* process rusage statistics */ 209 /* XXX - most fields in ki_rusage_ch are not (yet) filled in */ 210 struct rusage ki_rusage_ch; /* rusage of children processes */ 211 struct pcb *ki_pcb; /* kernel virtual addr of pcb */ 212 void *ki_kstack; /* kernel virtual addr of stack */ 213 void *ki_udata; /* User convenience pointer */ 214 /* 215 * When adding new variables, take space for pointers from the 216 * front of ki_spareptrs, and longs from the end of ki_sparelongs. 217 * That way the spare room from both arrays will remain contiguous. 218 */ 219 void *ki_spareptrs[KI_NSPARE_PTR]; /* spare room for growth */ 220 long ki_sparelongs[KI_NSPARE_LONG]; /* spare room for growth */ 221 long ki_sflag; /* PS_* flags */ 222 long ki_tdflags; /* XXXKSE kthread flag */ 223 }; 224 void fill_kinfo_proc(struct proc *, struct kinfo_proc *); 225 /* XXX - the following two defines are temporary */ 226 #define ki_childstime ki_rusage_ch.ru_stime 227 #define ki_childutime ki_rusage_ch.ru_utime 228 229 /* 230 * Legacy PS_ flag. This moved to p_flag but is maintained for 231 * compatibility. 232 */ 233 #define PS_INMEM 0x00001 /* Loaded into memory. */ 234 235 /* ki_sessflag values */ 236 #define KI_CTTY 0x00000001 /* controlling tty vnode active */ 237 #define KI_SLEADER 0x00000002 /* session leader */ 238 #define KI_LOCKBLOCK 0x00000004 /* proc blocked on lock ki_lockname */ 239 240 /* 241 * This used to be the per-process structure containing data that 242 * isn't needed in core when the process is swapped out, but now it 243 * remains only for the benefit of a.out core dumps. 244 */ 245 struct user { 246 struct pstats u_stats; /* *p_stats */ 247 struct kinfo_proc u_kproc; /* eproc */ 248 }; 249 250 /* 251 * The KERN_PROC_FILE sysctl allows a process to dump the file descriptor 252 * array of another process. 253 */ 254 #define KF_TYPE_NONE 0 255 #define KF_TYPE_VNODE 1 256 #define KF_TYPE_SOCKET 2 257 #define KF_TYPE_PIPE 3 258 #define KF_TYPE_FIFO 4 259 #define KF_TYPE_KQUEUE 5 260 #define KF_TYPE_CRYPTO 6 261 #define KF_TYPE_MQUEUE 7 262 #define KF_TYPE_SHM 8 263 #define KF_TYPE_SEM 9 264 #define KF_TYPE_PTS 10 265 #define KF_TYPE_UNKNOWN 255 266 267 #define KF_VTYPE_VNON 0 268 #define KF_VTYPE_VREG 1 269 #define KF_VTYPE_VDIR 2 270 #define KF_VTYPE_VBLK 3 271 #define KF_VTYPE_VCHR 4 272 #define KF_VTYPE_VLNK 5 273 #define KF_VTYPE_VSOCK 6 274 #define KF_VTYPE_VFIFO 7 275 #define KF_VTYPE_VBAD 8 276 #define KF_VTYPE_UNKNOWN 255 277 278 #define KF_FD_TYPE_CWD -1 /* Current working directory */ 279 #define KF_FD_TYPE_ROOT -2 /* Root directory */ 280 #define KF_FD_TYPE_JAIL -3 /* Jail directory */ 281 282 #define KF_FLAG_READ 0x00000001 283 #define KF_FLAG_WRITE 0x00000002 284 #define KF_FLAG_APPEND 0x00000004 285 #define KF_FLAG_ASYNC 0x00000008 286 #define KF_FLAG_FSYNC 0x00000010 287 #define KF_FLAG_NONBLOCK 0x00000020 288 #define KF_FLAG_DIRECT 0x00000040 289 #define KF_FLAG_HASLOCK 0x00000080 290 291 /* 292 * Old format. Has variable hidden padding due to alignment. 293 * This is a compatability hack for pre-build 7.1 packages. 294 */ 295 #if defined(__amd64__) 296 #define KINFO_OFILE_SIZE 1328 297 #endif 298 #if defined(__i386__) 299 #define KINFO_OFILE_SIZE 1324 300 #endif 301 302 struct kinfo_ofile { 303 int kf_structsize; /* Size of kinfo_file. */ 304 int kf_type; /* Descriptor type. */ 305 int kf_fd; /* Array index. */ 306 int kf_ref_count; /* Reference count. */ 307 int kf_flags; /* Flags. */ 308 /* XXX Hidden alignment padding here on amd64 */ 309 off_t kf_offset; /* Seek location. */ 310 int kf_vnode_type; /* Vnode type. */ 311 int kf_sock_domain; /* Socket domain. */ 312 int kf_sock_type; /* Socket type. */ 313 int kf_sock_protocol; /* Socket protocol. */ 314 char kf_path[PATH_MAX]; /* Path to file, if any. */ 315 struct sockaddr_storage kf_sa_local; /* Socket address. */ 316 struct sockaddr_storage kf_sa_peer; /* Peer address. */ 317 }; 318 319 #if defined(__amd64__) || defined(__i386__) 320 #define KINFO_FILE_SIZE 1392 321 #endif 322 323 struct kinfo_file { 324 int kf_structsize; /* Variable size of record. */ 325 int kf_type; /* Descriptor type. */ 326 int kf_fd; /* Array index. */ 327 int kf_ref_count; /* Reference count. */ 328 int kf_flags; /* Flags. */ 329 int _kf_pad0; /* Round to 64 bit alignment */ 330 int64_t kf_offset; /* Seek location. */ 331 int kf_vnode_type; /* Vnode type. */ 332 int kf_sock_domain; /* Socket domain. */ 333 int kf_sock_type; /* Socket type. */ 334 int kf_sock_protocol; /* Socket protocol. */ 335 struct sockaddr_storage kf_sa_local; /* Socket address. */ 336 struct sockaddr_storage kf_sa_peer; /* Peer address. */ 337 int _kf_ispare[16]; /* Space for more stuff. */ 338 /* Truncated before copyout in sysctl */ 339 char kf_path[PATH_MAX]; /* Path to file, if any. */ 340 }; 341 342 /* 343 * The KERN_PROC_VMMAP sysctl allows a process to dump the VM layout of 344 * another process as a series of entries. 345 */ 346 #define KVME_TYPE_NONE 0 347 #define KVME_TYPE_DEFAULT 1 348 #define KVME_TYPE_VNODE 2 349 #define KVME_TYPE_SWAP 3 350 #define KVME_TYPE_DEVICE 4 351 #define KVME_TYPE_PHYS 5 352 #define KVME_TYPE_DEAD 6 353 #define KVME_TYPE_SG 7 354 #define KVME_TYPE_UNKNOWN 255 355 356 #define KVME_PROT_READ 0x00000001 357 #define KVME_PROT_WRITE 0x00000002 358 #define KVME_PROT_EXEC 0x00000004 359 360 #define KVME_FLAG_COW 0x00000001 361 #define KVME_FLAG_NEEDS_COPY 0x00000002 362 363 #if defined(__amd64__) 364 #define KINFO_OVMENTRY_SIZE 1168 365 #endif 366 #if defined(__i386__) 367 #define KINFO_OVMENTRY_SIZE 1128 368 #endif 369 370 struct kinfo_ovmentry { 371 int kve_structsize; /* Size of kinfo_vmmapentry. */ 372 int kve_type; /* Type of map entry. */ 373 void *kve_start; /* Starting address. */ 374 void *kve_end; /* Finishing address. */ 375 int kve_flags; /* Flags on map entry. */ 376 int kve_resident; /* Number of resident pages. */ 377 int kve_private_resident; /* Number of private pages. */ 378 int kve_protection; /* Protection bitmask. */ 379 int kve_ref_count; /* VM obj ref count. */ 380 int kve_shadow_count; /* VM obj shadow count. */ 381 char kve_path[PATH_MAX]; /* Path to VM obj, if any. */ 382 void *_kve_pspare[8]; /* Space for more stuff. */ 383 off_t kve_offset; /* Mapping offset in object */ 384 uint64_t kve_fileid; /* inode number if vnode */ 385 dev_t kve_fsid; /* dev_t of vnode location */ 386 int _kve_ispare[3]; /* Space for more stuff. */ 387 }; 388 389 #if defined(__amd64__) || defined(__i386__) 390 #define KINFO_VMENTRY_SIZE 1160 391 #endif 392 393 struct kinfo_vmentry { 394 int kve_structsize; /* Variable size of record. */ 395 int kve_type; /* Type of map entry. */ 396 uint64_t kve_start; /* Starting address. */ 397 uint64_t kve_end; /* Finishing address. */ 398 uint64_t kve_offset; /* Mapping offset in object */ 399 uint64_t kve_fileid; /* inode number if vnode */ 400 uint32_t kve_fsid; /* dev_t of vnode location */ 401 int kve_flags; /* Flags on map entry. */ 402 int kve_resident; /* Number of resident pages. */ 403 int kve_private_resident; /* Number of private pages. */ 404 int kve_protection; /* Protection bitmask. */ 405 int kve_ref_count; /* VM obj ref count. */ 406 int kve_shadow_count; /* VM obj shadow count. */ 407 int _kve_pad0; /* 64bit align next field */ 408 int _kve_ispare[16]; /* Space for more stuff. */ 409 /* Truncated before copyout in sysctl */ 410 char kve_path[PATH_MAX]; /* Path to VM obj, if any. */ 411 }; 412 413 /* 414 * The KERN_PROC_KSTACK sysctl allows a process to dump the kernel stacks of 415 * another process as a series of entries. Each stack is represented by a 416 * series of symbol names and offsets as generated by stack_sbuf_print(9). 417 */ 418 #define KKST_MAXLEN 1024 419 420 #define KKST_STATE_STACKOK 0 /* Stack is valid. */ 421 #define KKST_STATE_SWAPPED 1 /* Stack swapped out. */ 422 #define KKST_STATE_RUNNING 2 /* Stack ephemeral. */ 423 424 #if defined(__amd64__) || defined(__i386__) 425 #define KINFO_KSTACK_SIZE 1096 426 #endif 427 428 struct kinfo_kstack { 429 lwpid_t kkst_tid; /* ID of thread. */ 430 int kkst_state; /* Validity of stack. */ 431 char kkst_trace[KKST_MAXLEN]; /* String representing stack. */ 432 int _kkst_ispare[16]; /* Space for more stuff. */ 433 }; 434 435 #endif 436