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 10 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 __powerpc__ 103 #define KINFO_PROC_SIZE 768 104 #endif 105 #ifdef __sparc64__ 106 #define KINFO_PROC_SIZE 1088 107 #endif 108 #ifndef KINFO_PROC_SIZE 109 #error "Unknown architecture" 110 #endif 111 112 #define WMESGLEN 8 /* size of returned wchan message */ 113 #define LOCKNAMELEN 8 /* size of returned lock name */ 114 #define OCOMMLEN 16 /* size of returned thread name */ 115 #define COMMLEN 19 /* size of returned ki_comm name */ 116 #define KI_EMULNAMELEN 16 /* size of returned ki_emul */ 117 #define KI_NGROUPS 16 /* number of groups in ki_groups */ 118 #define LOGNAMELEN 17 /* size of returned ki_login */ 119 120 struct kinfo_proc { 121 int ki_structsize; /* size of this structure */ 122 int ki_layout; /* reserved: layout identifier */ 123 struct pargs *ki_args; /* address of command arguments */ 124 struct proc *ki_paddr; /* address of proc */ 125 struct user *ki_addr; /* kernel virtual addr of u-area */ 126 struct vnode *ki_tracep; /* pointer to trace file */ 127 struct vnode *ki_textvp; /* pointer to executable file */ 128 struct filedesc *ki_fd; /* pointer to open file info */ 129 struct vmspace *ki_vmspace; /* pointer to kernel vmspace struct */ 130 void *ki_wchan; /* sleep address */ 131 pid_t ki_pid; /* Process identifier */ 132 pid_t ki_ppid; /* parent process id */ 133 pid_t ki_pgid; /* process group id */ 134 pid_t ki_tpgid; /* tty process group id */ 135 pid_t ki_sid; /* Process session ID */ 136 pid_t ki_tsid; /* Terminal session ID */ 137 short ki_jobc; /* job control counter */ 138 short ki_spare_short1; /* unused (just here for alignment) */ 139 dev_t ki_tdev; /* controlling tty dev */ 140 sigset_t ki_siglist; /* Signals arrived but not delivered */ 141 sigset_t ki_sigmask; /* Current signal mask */ 142 sigset_t ki_sigignore; /* Signals being ignored */ 143 sigset_t ki_sigcatch; /* Signals being caught by user */ 144 uid_t ki_uid; /* effective user id */ 145 uid_t ki_ruid; /* Real user id */ 146 uid_t ki_svuid; /* Saved effective user id */ 147 gid_t ki_rgid; /* Real group id */ 148 gid_t ki_svgid; /* Saved effective group id */ 149 short ki_ngroups; /* number of groups */ 150 short ki_spare_short2; /* unused (just here for alignment) */ 151 gid_t ki_groups[KI_NGROUPS]; /* groups */ 152 vm_size_t ki_size; /* virtual size */ 153 segsz_t ki_rssize; /* current resident set size in pages */ 154 segsz_t ki_swrss; /* resident set size before last swap */ 155 segsz_t ki_tsize; /* text size (pages) XXX */ 156 segsz_t ki_dsize; /* data size (pages) XXX */ 157 segsz_t ki_ssize; /* stack size (pages) */ 158 u_short ki_xstat; /* Exit status for wait & stop signal */ 159 u_short ki_acflag; /* Accounting flags */ 160 fixpt_t ki_pctcpu; /* %cpu for process during ki_swtime */ 161 u_int ki_estcpu; /* Time averaged value of ki_cpticks */ 162 u_int ki_slptime; /* Time since last blocked */ 163 u_int ki_swtime; /* Time swapped in or out */ 164 int ki_spareint1; /* unused (just here for alignment) */ 165 u_int64_t ki_runtime; /* Real time in microsec */ 166 struct timeval ki_start; /* starting time */ 167 struct timeval ki_childtime; /* time used by process children */ 168 long ki_flag; /* P_* flags */ 169 long ki_kiflag; /* KI_* flags (below) */ 170 int ki_traceflag; /* Kernel trace points */ 171 char ki_stat; /* S* process status */ 172 signed char ki_nice; /* Process "nice" value */ 173 char ki_lock; /* Process lock (prevent swap) count */ 174 char ki_rqindex; /* Run queue index */ 175 u_char ki_oncpu; /* Which cpu we are on */ 176 u_char ki_lastcpu; /* Last cpu we were on */ 177 char ki_ocomm[OCOMMLEN+1]; /* thread name */ 178 char ki_wmesg[WMESGLEN+1]; /* wchan message */ 179 char ki_login[LOGNAMELEN+1]; /* setlogin name */ 180 char ki_lockname[LOCKNAMELEN+1]; /* lock name */ 181 char ki_comm[COMMLEN+1]; /* command name */ 182 char ki_emul[KI_EMULNAMELEN+1]; /* emulation name */ 183 /* 184 * When adding new variables, take space for char-strings from the 185 * front of ki_sparestrings, and ints from the end of ki_spareints. 186 * That way the spare room from both arrays will remain contiguous. 187 */ 188 char ki_sparestrings[68]; /* spare string space */ 189 int ki_spareints[KI_NSPARE_INT]; /* spare room for growth */ 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 /* 201 * When adding new variables, take space for pointers from the 202 * front of ki_spareptrs, and longs from the end of ki_sparelongs. 203 * That way the spare room from both arrays will remain contiguous. 204 */ 205 void *ki_spareptrs[KI_NSPARE_PTR]; /* spare room for growth */ 206 long ki_sparelongs[KI_NSPARE_LONG]; /* spare room for growth */ 207 long ki_sflag; /* PS_* flags */ 208 long ki_tdflags; /* XXXKSE kthread flag */ 209 }; 210 void fill_kinfo_proc(struct proc *, struct kinfo_proc *); 211 /* XXX - the following two defines are temporary */ 212 #define ki_childstime ki_rusage_ch.ru_stime 213 #define ki_childutime ki_rusage_ch.ru_utime 214 215 /* 216 * Legacy PS_ flag. This moved to p_flag but is maintained for 217 * compatibility. 218 */ 219 #define PS_INMEM 0x00001 /* Loaded into memory. */ 220 221 /* ki_sessflag values */ 222 #define KI_CTTY 0x00000001 /* controlling tty vnode active */ 223 #define KI_SLEADER 0x00000002 /* session leader */ 224 #define KI_LOCKBLOCK 0x00000004 /* proc blocked on lock ki_lockname */ 225 226 /* 227 * This used to be the per-process structure containing data that 228 * isn't needed in core when the process is swapped out, but now it 229 * remains only for the benefit of a.out core dumps. 230 */ 231 struct user { 232 struct pstats u_stats; /* *p_stats */ 233 struct kinfo_proc u_kproc; /* eproc */ 234 }; 235 236 /* 237 * The KERN_PROC_FILE sysctl allows a process to dump the file descriptor 238 * array of another process. 239 */ 240 #define KF_TYPE_NONE 0 241 #define KF_TYPE_VNODE 1 242 #define KF_TYPE_SOCKET 2 243 #define KF_TYPE_PIPE 3 244 #define KF_TYPE_FIFO 4 245 #define KF_TYPE_KQUEUE 5 246 #define KF_TYPE_CRYPTO 6 247 #define KF_TYPE_MQUEUE 7 248 #define KF_TYPE_SHM 8 249 #define KF_TYPE_UNKNOWN 255 250 251 #define KF_VTYPE_VNON 0 252 #define KF_VTYPE_VREG 1 253 #define KF_VTYPE_VDIR 2 254 #define KF_VTYPE_VBLK 3 255 #define KF_VTYPE_VCHR 4 256 #define KF_VTYPE_VLNK 5 257 #define KF_VTYPE_VSOCK 6 258 #define KF_VTYPE_VFIFO 7 259 #define KF_VTYPE_VBAD 8 260 #define KF_VTYPE_UNKNOWN 255 261 262 #define KF_FD_TYPE_CWD -1 /* Current working directory */ 263 #define KF_FD_TYPE_ROOT -2 /* Root directory */ 264 #define KF_FD_TYPE_JAIL -3 /* Jail directory */ 265 266 #define KF_FLAG_READ 0x00000001 267 #define KF_FLAG_WRITE 0x00000002 268 #define KF_FLAG_APPEND 0x00000004 269 #define KF_FLAG_ASYNC 0x00000008 270 #define KF_FLAG_FSYNC 0x00000010 271 #define KF_FLAG_NONBLOCK 0x00000020 272 #define KF_FLAG_DIRECT 0x00000040 273 #define KF_FLAG_HASLOCK 0x00000080 274 275 struct kinfo_file { 276 int kf_structsize; /* Size of kinfo_file. */ 277 int kf_type; /* Descriptor type. */ 278 int kf_fd; /* Array index. */ 279 int kf_ref_count; /* Reference count. */ 280 int kf_flags; /* Flags. */ 281 off_t kf_offset; /* Seek location. */ 282 int kf_vnode_type; /* Vnode type. */ 283 int kf_sock_domain; /* Socket domain. */ 284 int kf_sock_type; /* Socket type. */ 285 int kf_sock_protocol; /* Socket protocol. */ 286 char kf_path[PATH_MAX]; /* Path to file, if any. */ 287 struct sockaddr_storage kf_sa_local; /* Socket address. */ 288 struct sockaddr_storage kf_sa_peer; /* Peer address. */ 289 }; 290 291 /* 292 * The KERN_PROC_VMMAP sysctl allows a process to dump the VM layout of 293 * another process as a series of entries. 294 */ 295 #define KVME_TYPE_NONE 0 296 #define KVME_TYPE_DEFAULT 1 297 #define KVME_TYPE_VNODE 2 298 #define KVME_TYPE_SWAP 3 299 #define KVME_TYPE_DEVICE 4 300 #define KVME_TYPE_PHYS 5 301 #define KVME_TYPE_DEAD 6 302 #define KVME_TYPE_UNKNOWN 255 303 304 #define KVME_PROT_READ 0x00000001 305 #define KVME_PROT_WRITE 0x00000002 306 #define KVME_PROT_EXEC 0x00000004 307 308 #define KVME_FLAG_COW 0x00000001 309 #define KVME_FLAG_NEEDS_COPY 0x00000002 310 311 struct kinfo_vmentry { 312 int kve_structsize; /* Size of kinfo_vmmapentry. */ 313 int kve_type; /* Type of map entry. */ 314 void *kve_start; /* Starting pointer. */ 315 void *kve_end; /* Finishing pointer. */ 316 int kve_flags; /* Flags on map entry. */ 317 int kve_resident; /* Number of resident pages. */ 318 int kve_private_resident; /* Number of private pages. */ 319 int kve_protection; /* Protection bitmask. */ 320 int kve_ref_count; /* VM obj ref count. */ 321 int kve_shadow_count; /* VM obj shadow count. */ 322 char kve_path[PATH_MAX]; /* Path to VM obj, if any. */ 323 void *_kve_pspare[8]; /* Space for more stuff. */ 324 int _kve_ispare[8]; /* Space for more stuff. */ 325 }; 326 327 /* 328 * The KERN_PROC_KSTACK sysctl allows a process to dump the kernel stacks of 329 * another process as a series of entries. Each stack is represented by a 330 * series of symbol names and offsets as generated by stack_sbuf_print(9). 331 */ 332 #define KKST_MAXLEN 1024 333 334 #define KKST_STATE_STACKOK 0 /* Stack is valid. */ 335 #define KKST_STATE_SWAPPED 1 /* Stack swapped out. */ 336 #define KKST_STATE_RUNNING 2 /* Stack ephemeral. */ 337 338 struct kinfo_kstack { 339 lwpid_t kkst_tid; /* ID of thread. */ 340 int kkst_state; /* Validity of stack. */ 341 char kkst_trace[KKST_MAXLEN]; /* String representing stack. */ 342 void *_kkst_pspare[8]; /* Space for more stuff. */ 343 int _kkst_ispare[8]; /* Space for more stuff. */ 344 }; 345 346 #endif 347