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