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