user.h revision 249487
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: head/sys/sys/user.h 249487 2013-04-14 20:01:36Z trociny $ 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 TDNAMLEN 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#ifndef BURN_BRIDGES 106#define OCOMMLEN TDNAMLEN 107#define ki_ocomm ki_tdname 108#endif 109 110/* Flags for the process credential. */ 111#define KI_CRF_CAPABILITY_MODE 0x00000001 112/* 113 * Steal a bit from ki_cr_flags to indicate that the cred had more than 114 * KI_NGROUPS groups. 115 */ 116#define KI_CRF_GRP_OVERFLOW 0x80000000 117 118struct kinfo_proc { 119 int ki_structsize; /* size of this structure */ 120 int ki_layout; /* reserved: layout identifier */ 121 struct pargs *ki_args; /* address of command arguments */ 122 struct proc *ki_paddr; /* address of proc */ 123 struct user *ki_addr; /* kernel virtual addr of u-area */ 124 struct vnode *ki_tracep; /* pointer to trace file */ 125 struct vnode *ki_textvp; /* pointer to executable file */ 126 struct filedesc *ki_fd; /* pointer to open file info */ 127 struct vmspace *ki_vmspace; /* pointer to kernel vmspace struct */ 128 void *ki_wchan; /* sleep address */ 129 pid_t ki_pid; /* Process identifier */ 130 pid_t ki_ppid; /* parent process id */ 131 pid_t ki_pgid; /* process group id */ 132 pid_t ki_tpgid; /* tty process group id */ 133 pid_t ki_sid; /* Process session ID */ 134 pid_t ki_tsid; /* Terminal session ID */ 135 short ki_jobc; /* job control counter */ 136 short ki_spare_short1; /* unused (just here for alignment) */ 137 dev_t ki_tdev; /* controlling tty dev */ 138 sigset_t ki_siglist; /* Signals arrived but not delivered */ 139 sigset_t ki_sigmask; /* Current signal mask */ 140 sigset_t ki_sigignore; /* Signals being ignored */ 141 sigset_t ki_sigcatch; /* Signals being caught by user */ 142 uid_t ki_uid; /* effective user id */ 143 uid_t ki_ruid; /* Real user id */ 144 uid_t ki_svuid; /* Saved effective user id */ 145 gid_t ki_rgid; /* Real group id */ 146 gid_t ki_svgid; /* Saved effective group id */ 147 short ki_ngroups; /* number of groups */ 148 short ki_spare_short2; /* unused (just here for alignment) */ 149 gid_t ki_groups[KI_NGROUPS]; /* groups */ 150 vm_size_t ki_size; /* virtual size */ 151 segsz_t ki_rssize; /* current resident set size in pages */ 152 segsz_t ki_swrss; /* resident set size before last swap */ 153 segsz_t ki_tsize; /* text size (pages) XXX */ 154 segsz_t ki_dsize; /* data size (pages) XXX */ 155 segsz_t ki_ssize; /* stack size (pages) */ 156 u_short ki_xstat; /* Exit status for wait & stop signal */ 157 u_short ki_acflag; /* Accounting flags */ 158 fixpt_t ki_pctcpu; /* %cpu for process during ki_swtime */ 159 u_int ki_estcpu; /* Time averaged value of ki_cpticks */ 160 u_int ki_slptime; /* Time since last blocked */ 161 u_int ki_swtime; /* Time swapped in or out */ 162 u_int ki_cow; /* number of copy-on-write faults */ 163 u_int64_t ki_runtime; /* Real time in microsec */ 164 struct timeval ki_start; /* starting time */ 165 struct timeval ki_childtime; /* time used by process children */ 166 long ki_flag; /* P_* flags */ 167 long ki_kiflag; /* KI_* flags (below) */ 168 int ki_traceflag; /* Kernel trace points */ 169 char ki_stat; /* S* process status */ 170 signed char ki_nice; /* Process "nice" value */ 171 char ki_lock; /* Process lock (prevent swap) count */ 172 char ki_rqindex; /* Run queue index */ 173 u_char ki_oncpu; /* Which cpu we are on */ 174 u_char ki_lastcpu; /* Last cpu we were on */ 175 char ki_tdname[TDNAMLEN+1]; /* thread name */ 176 char ki_wmesg[WMESGLEN+1]; /* wchan message */ 177 char ki_login[LOGNAMELEN+1]; /* setlogin name */ 178 char ki_lockname[LOCKNAMELEN+1]; /* lock name */ 179 char ki_comm[COMMLEN+1]; /* command name */ 180 char ki_emul[KI_EMULNAMELEN+1]; /* emulation name */ 181 char ki_loginclass[LOGINCLASSLEN+1]; /* login class */ 182 /* 183 * When adding new variables, take space for char-strings from the 184 * front of ki_sparestrings, and ints from the end of ki_spareints. 185 * That way the spare room from both arrays will remain contiguous. 186 */ 187 char ki_sparestrings[50]; /* spare string space */ 188 int ki_spareints[KI_NSPARE_INT]; /* spare room for growth */ 189 u_int ki_cr_flags; /* Credential flags */ 190 int ki_jid; /* Process jail ID */ 191 int ki_numthreads; /* XXXKSE number of threads in total */ 192 lwpid_t ki_tid; /* XXXKSE thread id */ 193 struct priority ki_pri; /* process priority */ 194 struct rusage ki_rusage; /* process rusage statistics */ 195 /* XXX - most fields in ki_rusage_ch are not (yet) filled in */ 196 struct rusage ki_rusage_ch; /* rusage of children processes */ 197 struct pcb *ki_pcb; /* kernel virtual addr of pcb */ 198 void *ki_kstack; /* kernel virtual addr of stack */ 199 void *ki_udata; /* User convenience pointer */ 200 struct thread *ki_tdaddr; /* address of thread */ 201 /* 202 * When adding new variables, take space for pointers from the 203 * front of ki_spareptrs, and longs from the end of ki_sparelongs. 204 * That way the spare room from both arrays will remain contiguous. 205 */ 206 void *ki_spareptrs[KI_NSPARE_PTR]; /* spare room for growth */ 207 long ki_sparelongs[KI_NSPARE_LONG]; /* spare room for growth */ 208 long ki_sflag; /* PS_* flags */ 209 long ki_tdflags; /* XXXKSE kthread flag */ 210}; 211void fill_kinfo_proc(struct proc *, struct kinfo_proc *); 212/* XXX - the following two defines are temporary */ 213#define ki_childstime ki_rusage_ch.ru_stime 214#define ki_childutime ki_rusage_ch.ru_utime 215 216/* 217 * Legacy PS_ flag. This moved to p_flag but is maintained for 218 * compatibility. 219 */ 220#define PS_INMEM 0x00001 /* Loaded into memory. */ 221 222/* ki_sessflag values */ 223#define KI_CTTY 0x00000001 /* controlling tty vnode active */ 224#define KI_SLEADER 0x00000002 /* session leader */ 225#define KI_LOCKBLOCK 0x00000004 /* proc blocked on lock ki_lockname */ 226 227/* 228 * This used to be the per-process structure containing data that 229 * isn't needed in core when the process is swapped out, but now it 230 * remains only for the benefit of a.out core dumps. 231 */ 232struct user { 233 struct pstats u_stats; /* *p_stats */ 234 struct kinfo_proc u_kproc; /* eproc */ 235}; 236 237/* 238 * The KERN_PROC_FILE sysctl allows a process to dump the file descriptor 239 * array of another process. 240 */ 241#define KF_ATTR_VALID 0x0001 242 243#define KF_TYPE_NONE 0 244#define KF_TYPE_VNODE 1 245#define KF_TYPE_SOCKET 2 246#define KF_TYPE_PIPE 3 247#define KF_TYPE_FIFO 4 248#define KF_TYPE_KQUEUE 5 249#define KF_TYPE_CRYPTO 6 250#define KF_TYPE_MQUEUE 7 251#define KF_TYPE_SHM 8 252#define KF_TYPE_SEM 9 253#define KF_TYPE_PTS 10 254#define KF_TYPE_PROCDESC 11 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#define KF_FD_TYPE_TRACE -4 /* ptrace vnode */ 272#define KF_FD_TYPE_TEXT -5 /* Text vnode */ 273#define KF_FD_TYPE_CTTY -6 /* Controlling terminal */ 274 275#define KF_FLAG_READ 0x00000001 276#define KF_FLAG_WRITE 0x00000002 277#define KF_FLAG_APPEND 0x00000004 278#define KF_FLAG_ASYNC 0x00000008 279#define KF_FLAG_FSYNC 0x00000010 280#define KF_FLAG_NONBLOCK 0x00000020 281#define KF_FLAG_DIRECT 0x00000040 282#define KF_FLAG_HASLOCK 0x00000080 283#define KF_FLAG_SHLOCK 0x00000100 284#define KF_FLAG_EXLOCK 0x00000200 285#define KF_FLAG_NOFOLLOW 0x00000400 286#define KF_FLAG_CREAT 0x00000800 287#define KF_FLAG_TRUNC 0x00001000 288#define KF_FLAG_EXCL 0x00002000 289#define KF_FLAG_EXEC 0x00004000 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 302struct 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 323struct 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 union { 338 struct { 339 /* Address of so_pcb. */ 340 uint64_t kf_sock_pcb; 341 /* Address of inp_ppcb. */ 342 uint64_t kf_sock_inpcb; 343 /* Address of unp_conn. */ 344 uint64_t kf_sock_unpconn; 345 /* Send buffer state. */ 346 uint16_t kf_sock_snd_sb_state; 347 /* Receive buffer state. */ 348 uint16_t kf_sock_rcv_sb_state; 349 /* Round to 64 bit alignment. */ 350 uint32_t kf_sock_pad0; 351 } kf_sock; 352 struct { 353 /* Global file id. */ 354 uint64_t kf_file_fileid; 355 /* File size. */ 356 uint64_t kf_file_size; 357 /* Vnode filesystem id. */ 358 uint32_t kf_file_fsid; 359 /* File device. */ 360 uint32_t kf_file_rdev; 361 /* File mode. */ 362 uint16_t kf_file_mode; 363 /* Round to 64 bit alignment. */ 364 uint16_t kf_file_pad0; 365 uint32_t kf_file_pad1; 366 } kf_file; 367 struct { 368 uint64_t kf_pipe_addr; 369 uint64_t kf_pipe_peer; 370 uint32_t kf_pipe_buffer_cnt; 371 /* Round to 64 bit alignment. */ 372 uint32_t kf_pipe_pad0[3]; 373 } kf_pipe; 374 struct { 375 uint32_t kf_pts_dev; 376 /* Round to 64 bit alignment. */ 377 uint32_t kf_pts_pad0[7]; 378 } kf_pts; 379 struct { 380 pid_t kf_pid; 381 } kf_proc; 382 } kf_un; 383 uint16_t kf_status; /* Status flags. */ 384 uint16_t kf_pad1; /* Round to 32 bit alignment. */ 385 int _kf_ispare0; /* Space for more stuff. */ 386 cap_rights_t kf_cap_rights; /* Capability rights. */ 387 int _kf_ispare[4]; /* Space for more stuff. */ 388 /* Truncated before copyout in sysctl */ 389 char kf_path[PATH_MAX]; /* Path to file, if any. */ 390}; 391 392/* 393 * The KERN_PROC_VMMAP sysctl allows a process to dump the VM layout of 394 * another process as a series of entries. 395 */ 396#define KVME_TYPE_NONE 0 397#define KVME_TYPE_DEFAULT 1 398#define KVME_TYPE_VNODE 2 399#define KVME_TYPE_SWAP 3 400#define KVME_TYPE_DEVICE 4 401#define KVME_TYPE_PHYS 5 402#define KVME_TYPE_DEAD 6 403#define KVME_TYPE_SG 7 404#define KVME_TYPE_UNKNOWN 255 405 406#define KVME_PROT_READ 0x00000001 407#define KVME_PROT_WRITE 0x00000002 408#define KVME_PROT_EXEC 0x00000004 409 410#define KVME_FLAG_COW 0x00000001 411#define KVME_FLAG_NEEDS_COPY 0x00000002 412#define KVME_FLAG_NOCOREDUMP 0x00000004 413#define KVME_FLAG_SUPER 0x00000008 414#define KVME_FLAG_GROWS_UP 0x00000010 415#define KVME_FLAG_GROWS_DOWN 0x00000020 416 417#if defined(__amd64__) 418#define KINFO_OVMENTRY_SIZE 1168 419#endif 420#if defined(__i386__) 421#define KINFO_OVMENTRY_SIZE 1128 422#endif 423 424struct kinfo_ovmentry { 425 int kve_structsize; /* Size of kinfo_vmmapentry. */ 426 int kve_type; /* Type of map entry. */ 427 void *kve_start; /* Starting address. */ 428 void *kve_end; /* Finishing address. */ 429 int kve_flags; /* Flags on map entry. */ 430 int kve_resident; /* Number of resident pages. */ 431 int kve_private_resident; /* Number of private pages. */ 432 int kve_protection; /* Protection bitmask. */ 433 int kve_ref_count; /* VM obj ref count. */ 434 int kve_shadow_count; /* VM obj shadow count. */ 435 char kve_path[PATH_MAX]; /* Path to VM obj, if any. */ 436 void *_kve_pspare[8]; /* Space for more stuff. */ 437 off_t kve_offset; /* Mapping offset in object */ 438 uint64_t kve_fileid; /* inode number if vnode */ 439 dev_t kve_fsid; /* dev_t of vnode location */ 440 int _kve_ispare[3]; /* Space for more stuff. */ 441}; 442 443#if defined(__amd64__) || defined(__i386__) 444#define KINFO_VMENTRY_SIZE 1160 445#endif 446 447struct kinfo_vmentry { 448 int kve_structsize; /* Variable size of record. */ 449 int kve_type; /* Type of map entry. */ 450 uint64_t kve_start; /* Starting address. */ 451 uint64_t kve_end; /* Finishing address. */ 452 uint64_t kve_offset; /* Mapping offset in object */ 453 uint64_t kve_vn_fileid; /* inode number if vnode */ 454 uint32_t kve_vn_fsid; /* dev_t of vnode location */ 455 int kve_flags; /* Flags on map entry. */ 456 int kve_resident; /* Number of resident pages. */ 457 int kve_private_resident; /* Number of private pages. */ 458 int kve_protection; /* Protection bitmask. */ 459 int kve_ref_count; /* VM obj ref count. */ 460 int kve_shadow_count; /* VM obj shadow count. */ 461 int kve_vn_type; /* Vnode type. */ 462 uint64_t kve_vn_size; /* File size. */ 463 uint32_t kve_vn_rdev; /* Device id if device. */ 464 uint16_t kve_vn_mode; /* File mode. */ 465 uint16_t kve_status; /* Status flags. */ 466 int _kve_ispare[12]; /* Space for more stuff. */ 467 /* Truncated before copyout in sysctl */ 468 char kve_path[PATH_MAX]; /* Path to VM obj, if any. */ 469}; 470 471/* 472 * The KERN_PROC_KSTACK sysctl allows a process to dump the kernel stacks of 473 * another process as a series of entries. Each stack is represented by a 474 * series of symbol names and offsets as generated by stack_sbuf_print(9). 475 */ 476#define KKST_MAXLEN 1024 477 478#define KKST_STATE_STACKOK 0 /* Stack is valid. */ 479#define KKST_STATE_SWAPPED 1 /* Stack swapped out. */ 480#define KKST_STATE_RUNNING 2 /* Stack ephemeral. */ 481 482#if defined(__amd64__) || defined(__i386__) 483#define KINFO_KSTACK_SIZE 1096 484#endif 485 486struct kinfo_kstack { 487 lwpid_t kkst_tid; /* ID of thread. */ 488 int kkst_state; /* Validity of stack. */ 489 char kkst_trace[KKST_MAXLEN]; /* String representing stack. */ 490 int _kkst_ispare[16]; /* Space for more stuff. */ 491}; 492 493#ifdef _KERNEL 494/* Flags for kern_proc_out function. */ 495#define KERN_PROC_NOTHREADS 0x1 496#define KERN_PROC_MASK32 0x2 497 498struct sbuf; 499 500/* 501 * The kern_proc out functions are helper functions to dump process 502 * miscellaneous kinfo structures to sbuf. The main consumers are KERN_PROC 503 * sysctls but they may also be used by other kernel subsystems. 504 * 505 * The functions manipulate the process locking state and expect the process 506 * to be locked on enter. On return the process is unlocked. 507 */ 508 509int kern_proc_filedesc_out(struct proc *p, struct sbuf *sb, ssize_t maxlen); 510int kern_proc_out(struct proc *p, struct sbuf *sb, int flags); 511int kern_proc_vmmap_out(struct proc *p, struct sbuf *sb); 512 513int vntype_to_kinfo(int vtype); 514#endif /* !_KERNEL */ 515 516#endif 517