xref: /freebsd/sys/sys/user.h (revision e60f608eb9cf3b38099948545934d699de9bbcea)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1989, 1991, 1993
5  *	The Regents of the University of California.
6  * Copyright (c) 2007 Robert N. M. Watson
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #ifndef _SYS_USER_H_
35 #define _SYS_USER_H_
36 
37 #include <machine/pcb.h>
38 #ifndef _KERNEL
39 /* stuff that *used* to be included by user.h, or is now needed */
40 #include <sys/errno.h>
41 #include <sys/event.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 #include <sys/caprights.h>
65 
66 /*
67  * KERN_PROC subtype ops return arrays of selected proc structure entries:
68  *
69  * This struct includes several arrays of spare space, with different arrays
70  * for different standard C-types.  When adding new variables to this struct,
71  * the space for byte-aligned data should be taken from the ki_sparestring,
72  * pointers from ki_spareptrs, word-aligned data from ki_spareints, and
73  * doubleword-aligned data from ki_sparelongs.  Make sure the space for new
74  * variables come from the array which matches the size and alignment of
75  * those variables on ALL hardware platforms, and then adjust the appropriate
76  * KI_NSPARE_* value(s) to match.
77  *
78  * Always verify that sizeof(struct kinfo_proc) == KINFO_PROC_SIZE on all
79  * platforms after you have added new variables.  Note that if you change
80  * the value of KINFO_PROC_SIZE, then many userland programs will stop
81  * working until they are recompiled!
82  *
83  * Once you have added the new field, you will need to add code to initialize
84  * it in two places: function fill_kinfo_proc in sys/kern/kern_proc.c and
85  * function kvm_proclist in lib/libkvm/kvm_proc.c .
86  */
87 #define	KI_NSPARE_INT	2
88 #define	KI_NSPARE_LONG	12
89 #define	KI_NSPARE_PTR	5
90 
91 #ifndef _KERNEL
92 #ifndef KINFO_PROC_SIZE
93 #error "Unknown architecture"
94 #endif
95 #endif /* !_KERNEL */
96 
97 #define	WMESGLEN	8		/* size of returned wchan message */
98 #define	LOCKNAMELEN	8		/* size of returned lock name */
99 #define	TDNAMLEN	16		/* size of returned thread name */
100 #define	COMMLEN		19		/* size of returned ki_comm name */
101 #define	KI_EMULNAMELEN	16		/* size of returned ki_emul */
102 #define	KI_NGROUPS	16		/* number of groups in ki_groups */
103 #define	LOGNAMELEN	17		/* size of returned ki_login */
104 #define	LOGINCLASSLEN	17		/* size of returned ki_loginclass */
105 
106 #ifndef BURN_BRIDGES
107 #define	OCOMMLEN	TDNAMLEN
108 #define	ki_ocomm	ki_tdname
109 #endif
110 
111 /* Flags for the process credential. */
112 #define	KI_CRF_CAPABILITY_MODE	0x00000001
113 /*
114  * Steal a bit from ki_cr_flags to indicate that the cred had more than
115  * KI_NGROUPS groups.
116  */
117 #define KI_CRF_GRP_OVERFLOW	0x80000000
118 
119 struct kinfo_proc {
120 	int	ki_structsize;		/* size of this structure */
121 	int	ki_layout;		/* reserved: layout identifier */
122 	struct	pargs *ki_args;		/* address of command arguments */
123 	struct	proc *ki_paddr;		/* address of proc */
124 	struct	user *ki_addr;		/* kernel virtual addr of u-area */
125 	struct	vnode *ki_tracep;	/* pointer to trace file */
126 	struct	vnode *ki_textvp;	/* pointer to executable file */
127 	struct	filedesc *ki_fd;	/* pointer to open file info */
128 	struct	vmspace *ki_vmspace;	/* pointer to kernel vmspace struct */
129 	const void *ki_wchan;		/* sleep address */
130 	pid_t	ki_pid;			/* Process identifier */
131 	pid_t	ki_ppid;		/* parent process id */
132 	pid_t	ki_pgid;		/* process group id */
133 	pid_t	ki_tpgid;		/* tty process group id */
134 	pid_t	ki_sid;			/* Process session ID */
135 	pid_t	ki_tsid;		/* Terminal session ID */
136 	short	ki_jobc;		/* job control counter */
137 	short	ki_spare_short1;	/* unused (just here for alignment) */
138 	uint32_t ki_tdev_freebsd11;	/* controlling tty dev */
139 	sigset_t ki_siglist;		/* Signals arrived but not delivered */
140 	sigset_t ki_sigmask;		/* Current signal mask */
141 	sigset_t ki_sigignore;		/* Signals being ignored */
142 	sigset_t ki_sigcatch;		/* Signals being caught by user */
143 	uid_t	ki_uid;			/* effective user id */
144 	uid_t	ki_ruid;		/* Real user id */
145 	uid_t	ki_svuid;		/* Saved effective user id */
146 	gid_t	ki_rgid;		/* Real group id */
147 	gid_t	ki_svgid;		/* Saved effective group id */
148 	short	ki_ngroups;		/* number of groups */
149 	short	ki_spare_short2;	/* unused (just here for alignment) */
150 	gid_t	ki_groups[KI_NGROUPS];	/* groups */
151 	vm_size_t ki_size;		/* virtual size */
152 	segsz_t ki_rssize;		/* current resident set size in pages */
153 	segsz_t ki_swrss;		/* resident set size before last swap */
154 	segsz_t ki_tsize;		/* text size (pages) XXX */
155 	segsz_t ki_dsize;		/* data size (pages) XXX */
156 	segsz_t ki_ssize;		/* stack size (pages) */
157 	u_short	ki_xstat;		/* Exit status for wait & stop signal */
158 	u_short	ki_acflag;		/* Accounting flags */
159 	fixpt_t	ki_pctcpu;	 	/* %cpu for process during ki_swtime */
160 	u_int	ki_estcpu;	 	/* Time averaged value of ki_cpticks */
161 	u_int	ki_slptime;	 	/* Time since last blocked */
162 	u_int	ki_swtime;	 	/* Time swapped in or out */
163 	u_int	ki_cow;			/* number of copy-on-write faults */
164 	u_int64_t ki_runtime;		/* Real time in microsec */
165 	struct	timeval ki_start;	/* starting time */
166 	struct	timeval ki_childtime;	/* time used by process children */
167 	long	ki_flag;		/* P_* flags */
168 	long	ki_kiflag;		/* KI_* flags (below) */
169 	int	ki_traceflag;		/* Kernel trace points */
170 	char	ki_stat;		/* S* process status */
171 	signed char ki_nice;		/* Process "nice" value */
172 	char	ki_lock;		/* Process lock (prevent swap) count */
173 	char	ki_rqindex;		/* Run queue index */
174 	u_char	ki_oncpu_old;		/* Which cpu we are on (legacy) */
175 	u_char	ki_lastcpu_old;		/* Last cpu we were on (legacy) */
176 	char	ki_tdname[TDNAMLEN+1];	/* thread name */
177 	char	ki_wmesg[WMESGLEN+1];	/* wchan message */
178 	char	ki_login[LOGNAMELEN+1];	/* setlogin name */
179 	char	ki_lockname[LOCKNAMELEN+1]; /* lock name */
180 	char	ki_comm[COMMLEN+1];	/* command name */
181 	char	ki_emul[KI_EMULNAMELEN+1];  /* emulation name */
182 	char	ki_loginclass[LOGINCLASSLEN+1]; /* login class */
183 	char	ki_moretdname[MAXCOMLEN-TDNAMLEN+1];	/* more thread name */
184 	/*
185 	 * When adding new variables, take space for char-strings from the
186 	 * front of ki_sparestrings, and ints from the end of ki_spareints.
187 	 * That way the spare room from both arrays will remain contiguous.
188 	 */
189 	char	ki_sparestrings[46];	/* spare string space */
190 	int	ki_spareints[KI_NSPARE_INT];	/* spare room for growth */
191 	uint64_t ki_tdev;		/* controlling tty dev */
192 	int	ki_oncpu;		/* Which cpu we are on */
193 	int	ki_lastcpu;		/* Last cpu we were on */
194 	int	ki_tracer;		/* Pid of tracing process */
195 	int	ki_flag2;		/* P2_* flags */
196 	int	ki_fibnum;		/* Default FIB number */
197 	u_int	ki_cr_flags;		/* Credential flags */
198 	int	ki_jid;			/* Process jail ID */
199 	int	ki_numthreads;		/* XXXKSE number of threads in total */
200 	lwpid_t	ki_tid;			/* XXXKSE thread id */
201 	struct	priority ki_pri;	/* process priority */
202 	struct	rusage ki_rusage;	/* process rusage statistics */
203 	/* XXX - most fields in ki_rusage_ch are not (yet) filled in */
204 	struct	rusage ki_rusage_ch;	/* rusage of children processes */
205 	struct	pcb *ki_pcb;		/* kernel virtual addr of pcb */
206 	void	*ki_kstack;		/* kernel virtual addr of stack */
207 	void	*ki_udata;		/* User convenience pointer */
208 	struct	thread *ki_tdaddr;	/* address of thread */
209 	/*
210 	 * When adding new variables, take space for pointers from the
211 	 * front of ki_spareptrs, and longs from the end of ki_sparelongs.
212 	 * That way the spare room from both arrays will remain contiguous.
213 	 */
214 	struct	pwddesc *ki_pd;	/* pointer to process paths info */
215 	void	*ki_spareptrs[KI_NSPARE_PTR];	/* spare room for growth */
216 	long	ki_sparelongs[KI_NSPARE_LONG];	/* spare room for growth */
217 	long	ki_sflag;		/* PS_* flags */
218 	long	ki_tdflags;		/* XXXKSE kthread flag */
219 };
220 void fill_kinfo_proc(struct proc *, struct kinfo_proc *);
221 /* XXX - the following two defines are temporary */
222 #define	ki_childstime	ki_rusage_ch.ru_stime
223 #define	ki_childutime	ki_rusage_ch.ru_utime
224 
225 /*
226  *  Legacy PS_ flag.  This moved to p_flag but is maintained for
227  *  compatibility.
228  */
229 #define	PS_INMEM	0x00001		/* Loaded into memory, always true. */
230 
231 /* ki_sessflag values */
232 #define	KI_CTTY		0x00000001	/* controlling tty vnode active */
233 #define	KI_SLEADER	0x00000002	/* session leader */
234 #define	KI_LOCKBLOCK	0x00000004	/* proc blocked on lock ki_lockname */
235 
236 /*
237  * This used to be the per-process structure containing data that
238  * isn't needed in core when the process is swapped out, but now it
239  * remains only for the benefit of a.out core dumps.
240  */
241 struct user {
242 	struct	pstats u_stats;		/* *p_stats */
243 	struct	kinfo_proc u_kproc;	/* eproc */
244 };
245 
246 /*
247  * The KERN_PROC_FILE sysctl allows a process to dump the file descriptor
248  * array of another process.
249  */
250 #define	KF_ATTR_VALID	0x0001
251 
252 #define	KF_TYPE_NONE	0
253 #define	KF_TYPE_VNODE	1
254 #define	KF_TYPE_SOCKET	2
255 #define	KF_TYPE_PIPE	3
256 #define	KF_TYPE_FIFO	4
257 #define	KF_TYPE_KQUEUE	5
258 /* was	KF_TYPE_CRYPTO	6 */
259 #define	KF_TYPE_MQUEUE	7
260 #define	KF_TYPE_SHM	8
261 #define	KF_TYPE_SEM	9
262 #define	KF_TYPE_PTS	10
263 #define	KF_TYPE_PROCDESC	11
264 #define	KF_TYPE_DEV	12
265 #define	KF_TYPE_EVENTFD	13
266 #define	KF_TYPE_TIMERFD	14
267 #define	KF_TYPE_UNKNOWN	255
268 
269 #define	KF_VTYPE_VNON	0
270 #define	KF_VTYPE_VREG	1
271 #define	KF_VTYPE_VDIR	2
272 #define	KF_VTYPE_VBLK	3
273 #define	KF_VTYPE_VCHR	4
274 #define	KF_VTYPE_VLNK	5
275 #define	KF_VTYPE_VSOCK	6
276 #define	KF_VTYPE_VFIFO	7
277 #define	KF_VTYPE_VBAD	8
278 #define	KF_VTYPE_UNKNOWN	255
279 
280 #define	KF_FD_TYPE_CWD	-1	/* Current working directory */
281 #define	KF_FD_TYPE_ROOT	-2	/* Root directory */
282 #define	KF_FD_TYPE_JAIL	-3	/* Jail directory */
283 #define	KF_FD_TYPE_TRACE	-4	/* Ktrace vnode */
284 #define	KF_FD_TYPE_TEXT	-5	/* Text vnode */
285 #define	KF_FD_TYPE_CTTY	-6	/* Controlling terminal */
286 
287 #define	KF_FLAG_READ		0x00000001
288 #define	KF_FLAG_WRITE		0x00000002
289 #define	KF_FLAG_APPEND		0x00000004
290 #define	KF_FLAG_ASYNC		0x00000008
291 #define	KF_FLAG_FSYNC		0x00000010
292 #define	KF_FLAG_NONBLOCK	0x00000020
293 #define	KF_FLAG_DIRECT		0x00000040
294 #define	KF_FLAG_HASLOCK		0x00000080
295 #define	KF_FLAG_SHLOCK		0x00000100
296 #define	KF_FLAG_EXLOCK		0x00000200
297 #define	KF_FLAG_NOFOLLOW	0x00000400
298 #define	KF_FLAG_CREAT		0x00000800
299 #define	KF_FLAG_TRUNC		0x00001000
300 #define	KF_FLAG_EXCL		0x00002000
301 #define	KF_FLAG_EXEC		0x00004000
302 
303 /*
304  * Old format.  Has variable hidden padding due to alignment.
305  * This is a compatibility hack for pre-build 7.1 packages.
306  */
307 #if defined(__amd64__)
308 #define	KINFO_OFILE_SIZE	1328
309 #endif
310 #if defined(__i386__)
311 #define	KINFO_OFILE_SIZE	1324
312 #endif
313 
314 struct kinfo_ofile {
315 	int	kf_structsize;			/* Size of kinfo_file. */
316 	int	kf_type;			/* Descriptor type. */
317 	int	kf_fd;				/* Array index. */
318 	int	kf_ref_count;			/* Reference count. */
319 	int	kf_flags;			/* Flags. */
320 	/* XXX Hidden alignment padding here on amd64 */
321 	off_t	kf_offset;			/* Seek location. */
322 	int	kf_vnode_type;			/* Vnode type. */
323 	int	kf_sock_domain;			/* Socket domain. */
324 	int	kf_sock_type;			/* Socket type. */
325 	int	kf_sock_protocol;		/* Socket protocol. */
326 	char	kf_path[PATH_MAX];	/* Path to file, if any. */
327 	struct sockaddr_storage kf_sa_local;	/* Socket address. */
328 	struct sockaddr_storage	kf_sa_peer;	/* Peer address. */
329 };
330 
331 #if defined(__amd64__) || defined(__i386__)
332 /*
333  * This size should never be changed. If you really need to, you must provide
334  * backward ABI compatibility by allocating a new sysctl MIB that will return
335  * the new structure. The current structure has to be returned by the current
336  * sysctl MIB. See how it is done for the kinfo_ofile structure.
337  */
338 #define	KINFO_FILE_SIZE	1392
339 #endif
340 
341 struct kinfo_file {
342 	int		kf_structsize;		/* Variable size of record. */
343 	int		kf_type;		/* Descriptor type. */
344 	int		kf_fd;			/* Array index. */
345 	int		kf_ref_count;		/* Reference count. */
346 	int		kf_flags;		/* Flags. */
347 	int		kf_pad0;		/* Round to 64 bit alignment. */
348 	int64_t		kf_offset;		/* Seek location. */
349 	union {
350 		struct {
351 			/* API compatibility with FreeBSD < 12. */
352 			int		kf_vnode_type;
353 			int		kf_sock_domain;
354 			int		kf_sock_type;
355 			int		kf_sock_protocol;
356 			struct sockaddr_storage kf_sa_local;
357 			struct sockaddr_storage	kf_sa_peer;
358 		};
359 		union {
360 			struct {
361 				/* Sendq size */
362 				uint32_t	kf_sock_sendq;
363 				/* Socket domain. */
364 				int		kf_sock_domain0;
365 				/* Socket type. */
366 				int		kf_sock_type0;
367 				/* Socket protocol. */
368 				int		kf_sock_protocol0;
369 				/* Socket address. */
370 				struct sockaddr_storage kf_sa_local;
371 				/* Peer address. */
372 				struct sockaddr_storage	kf_sa_peer;
373 				/* Address of so_pcb. */
374 				uint64_t	kf_sock_pcb;
375 				/* Obsolete! May be reused as a spare. */
376 				uint64_t	kf_sock_inpcb;
377 				/* Address of unp_conn. */
378 				uint64_t	kf_sock_unpconn;
379 				/* Send buffer state. */
380 				uint16_t	kf_sock_snd_sb_state;
381 				/* Receive buffer state. */
382 				uint16_t	kf_sock_rcv_sb_state;
383 				/* Recvq size. */
384 				uint32_t	kf_sock_recvq;
385 			} kf_sock;
386 			struct {
387 				/* Vnode type. */
388 				int		kf_file_type;
389 				/* Space for future use */
390 				int		kf_spareint[3];
391 				uint64_t	kf_spareint64[29];
392 				/* Number of references to file. */
393 				uint64_t	kf_file_nlink;
394 				/* Vnode filesystem id. */
395 				uint64_t	kf_file_fsid;
396 				/* File device. */
397 				uint64_t	kf_file_rdev;
398 				/* Global file id. */
399 				uint64_t	kf_file_fileid;
400 				/* File size. */
401 				uint64_t	kf_file_size;
402 				/* Vnode filesystem id, FreeBSD 11 compat. */
403 				uint32_t	kf_file_fsid_freebsd11;
404 				/* File device, FreeBSD 11 compat. */
405 				uint32_t	kf_file_rdev_freebsd11;
406 				/* File mode. */
407 				uint16_t	kf_file_mode;
408 				/* Round to 64 bit alignment. */
409 				uint16_t	kf_file_pad0;
410 				uint32_t	kf_file_pad1;
411 			} kf_file;
412 			struct {
413 				uint32_t	kf_spareint[4];
414 				uint64_t	kf_spareint64[32];
415 				uint32_t	kf_sem_value;
416 				uint16_t	kf_sem_mode;
417 			} kf_sem;
418 			struct {
419 				uint32_t	kf_spareint[4];
420 				uint64_t	kf_spareint64[32];
421 				uint64_t	kf_pipe_addr;
422 				uint64_t	kf_pipe_peer;
423 				uint32_t	kf_pipe_buffer_cnt;
424 				uint32_t	kf_pipe_buffer_in;
425 				uint32_t	kf_pipe_buffer_out;
426 				uint32_t	kf_pipe_buffer_size;
427 			} kf_pipe;
428 			struct {
429 				uint32_t	kf_spareint[4];
430 				uint64_t	kf_spareint64[32];
431 				uint32_t	kf_pts_dev_freebsd11;
432 				uint32_t	kf_pts_pad0;
433 				uint64_t	kf_pts_dev;
434 				/* Round to 64 bit alignment. */
435 				uint32_t	kf_pts_pad1[4];
436 			} kf_pts;
437 			struct {
438 				uint32_t	kf_spareint[4];
439 				uint64_t	kf_spareint64[32];
440 				pid_t		kf_pid;
441 			} kf_proc;
442 			struct {
443 				uint64_t	kf_eventfd_value;
444 				uint32_t	kf_eventfd_flags;
445 				uint32_t	kf_eventfd_spareint[3];
446 				uint64_t	kf_eventfd_addr;
447 			} kf_eventfd;
448 			struct {
449 				uint32_t	kf_timerfd_clockid;
450 				uint32_t	kf_timerfd_flags;
451 				uint64_t	kf_timerfd_addr;
452 			} kf_timerfd;
453 			struct {
454 				uint64_t	kf_kqueue_addr;
455 				int32_t		kf_kqueue_count;
456 				int32_t		kf_kqueue_state;
457 			} kf_kqueue;
458 		} kf_un;
459 	};
460 	uint16_t	kf_status;		/* Status flags. */
461 	uint16_t	kf_pad1;		/* Round to 32 bit alignment. */
462 	int		_kf_ispare0;		/* Space for more stuff. */
463 	cap_rights_t	kf_cap_rights;		/* Capability rights. */
464 	uint64_t	_kf_cap_spare;		/* Space for future cap_rights_t. */
465 	/* Truncated before copyout in sysctl */
466 	char		kf_path[PATH_MAX];	/* Path to file, if any. */
467 };
468 
469 struct kinfo_lockf {
470 	int		kl_structsize;		/* Variable size of record. */
471 	int		kl_rw;
472 	int		kl_type;
473 	int		kl_pid;
474 	int		kl_sysid;
475 	int		kl_pad0;
476 	uint64_t	kl_file_fsid;
477 	uint64_t	kl_file_rdev;
478 	uint64_t	kl_file_fileid;
479 	off_t		kl_start;
480 	off_t		kl_len;			/* len == 0 till the EOF */
481 	char		kl_path[PATH_MAX];
482 };
483 
484 #define	KLOCKF_RW_READ		0x01
485 #define	KLOCKF_RW_WRITE		0x02
486 
487 #define	KLOCKF_TYPE_FLOCK	0x01
488 #define	KLOCKF_TYPE_PID		0x02
489 #define	KLOCKF_TYPE_REMOTE	0x03
490 
491 /*
492  * The KERN_PROC_VMMAP sysctl allows a process to dump the VM layout of
493  * another process as a series of entries.
494  */
495 #define	KVME_TYPE_NONE		0
496 #define	KVME_TYPE_DEFAULT	1		/* no longer returned */
497 #define	KVME_TYPE_VNODE		2
498 #define	KVME_TYPE_SWAP		3
499 #define	KVME_TYPE_DEVICE	4
500 #define	KVME_TYPE_PHYS		5
501 #define	KVME_TYPE_DEAD		6
502 #define	KVME_TYPE_SG		7
503 #define	KVME_TYPE_MGTDEVICE	8
504 #define	KVME_TYPE_GUARD		9
505 #define	KVME_TYPE_UNKNOWN	255
506 
507 #define	KVME_PROT_READ		0x00000001
508 #define	KVME_PROT_WRITE		0x00000002
509 #define	KVME_PROT_EXEC		0x00000004
510 #define	KVME_MAX_PROT_READ	0x00010000
511 #define	KVME_MAX_PROT_WRITE	0x00020000
512 #define	KVME_MAX_PROT_EXEC	0x00040000
513 
514 #define	KVME_FLAG_COW		0x00000001
515 #define	KVME_FLAG_NEEDS_COPY	0x00000002
516 #define	KVME_FLAG_NOCOREDUMP	0x00000004
517 #define	KVME_FLAG_SUPER		0x00000008
518 #define	KVME_FLAG_GROWS_UP	0x00000010
519 #define	KVME_FLAG_GROWS_DOWN	0x00000020
520 #define	KVME_FLAG_USER_WIRED	0x00000040
521 #define	KVME_FLAG_SYSVSHM	0x00000080
522 #define	KVME_FLAG_POSIXSHM	0x00000100
523 
524 #if defined(__amd64__)
525 #define	KINFO_OVMENTRY_SIZE	1168
526 #endif
527 #if defined(__i386__)
528 #define	KINFO_OVMENTRY_SIZE	1128
529 #endif
530 
531 struct kinfo_ovmentry {
532 	int	 kve_structsize;		/* Size of kinfo_vmmapentry. */
533 	int	 kve_type;			/* Type of map entry. */
534 	void	*kve_start;			/* Starting address. */
535 	void	*kve_end;			/* Finishing address. */
536 	int	 kve_flags;			/* Flags on map entry. */
537 	int	 kve_resident;			/* Number of resident pages. */
538 	int	 kve_private_resident;		/* Number of private pages. */
539 	int	 kve_protection;		/* Protection bitmask. */
540 	int	 kve_ref_count;			/* VM obj ref count. */
541 	int	 kve_shadow_count;		/* VM obj shadow count. */
542 	char	 kve_path[PATH_MAX];		/* Path to VM obj, if any. */
543 	void	*_kve_pspare[8];		/* Space for more stuff. */
544 	off_t	 kve_offset;			/* Mapping offset in object */
545 	uint64_t kve_fileid;			/* inode number if vnode */
546 	uint32_t kve_fsid;			/* dev_t of vnode location */
547 	int	 _kve_ispare[3];		/* Space for more stuff. */
548 };
549 
550 #if defined(__amd64__) || defined(__i386__)
551 #define	KINFO_VMENTRY_SIZE	1160
552 #endif
553 
554 struct kinfo_vmentry {
555 	int	 kve_structsize;		/* Variable size of record. */
556 	int	 kve_type;			/* Type of map entry. */
557 	uint64_t kve_start;			/* Starting address. */
558 	uint64_t kve_end;			/* Finishing address. */
559 	uint64_t kve_offset;			/* Mapping offset in object */
560 	uint64_t kve_vn_fileid;			/* inode number if vnode */
561 	uint32_t kve_vn_fsid_freebsd11;		/* dev_t of vnode location */
562 	int	 kve_flags;			/* Flags on map entry. */
563 	int	 kve_resident;			/* Number of resident pages. */
564 	int	 kve_private_resident;		/* Number of private pages. */
565 	int	 kve_protection;		/* Protection bitmask. */
566 	int	 kve_ref_count;			/* VM obj ref count. */
567 	int	 kve_shadow_count;		/* VM obj shadow count. */
568 	int	 kve_vn_type;			/* Vnode type. */
569 	uint64_t kve_vn_size;			/* File size. */
570 	uint32_t kve_vn_rdev_freebsd11;		/* Device id if device. */
571 	uint16_t kve_vn_mode;			/* File mode. */
572 	uint16_t kve_status;			/* Status flags. */
573 	union {
574 		uint64_t _kve_vn_fsid;		/* dev_t of vnode location */
575 		uint64_t _kve_obj;		/* handle of anon obj */
576 	} kve_type_spec;
577 	uint64_t kve_vn_rdev;			/* Device id if device. */
578 	int	 _kve_ispare[8];		/* Space for more stuff. */
579 	/* Truncated before copyout in sysctl */
580 	char	 kve_path[PATH_MAX];		/* Path to VM obj, if any. */
581 };
582 #define	kve_vn_fsid	kve_type_spec._kve_vn_fsid
583 #define	kve_obj		kve_type_spec._kve_obj
584 
585 #define	KVMO_FLAG_SYSVSHM	0x0001
586 #define	KVMO_FLAG_POSIXSHM	0x0002
587 
588 /*
589  * The "vm.objects" sysctl provides a list of all VM objects in the system
590  * via an array of these entries.
591  */
592 struct kinfo_vmobject {
593 	int	kvo_structsize;			/* Variable size of record. */
594 	int	kvo_type;			/* Object type: KVME_TYPE_*. */
595 	uint64_t kvo_size;			/* Object size in pages. */
596 	uint64_t kvo_vn_fileid;			/* inode number if vnode. */
597 	uint32_t kvo_vn_fsid_freebsd11;		/* dev_t of vnode location. */
598 	int	kvo_ref_count;			/* Reference count. */
599 	int	kvo_shadow_count;		/* Shadow count. */
600 	int	kvo_memattr;			/* Memory attribute. */
601 	uint64_t kvo_resident;			/* Number of resident pages. */
602 	uint64_t kvo_active;			/* Number of active pages. */
603 	uint64_t kvo_inactive;			/* Number of inactive pages. */
604 	union {
605 		uint64_t _kvo_vn_fsid;
606 		uint64_t _kvo_backing_obj;	/* Handle for the backing obj */
607 	} kvo_type_spec;			/* Type-specific union */
608 	uint64_t kvo_me;			/* Uniq handle for anon obj */
609 	uint64_t kvo_laundry;			/* Number of laundry pages. */
610 	uint64_t _kvo_qspare[5];
611 	uint32_t kvo_swapped;			/* Number of swapped pages */
612 	uint32_t kvo_flags;
613 	uint32_t _kvo_ispare[6];
614 	char	kvo_path[PATH_MAX];		/* Pathname, if any. */
615 };
616 #define	kvo_vn_fsid	kvo_type_spec._kvo_vn_fsid
617 #define	kvo_backing_obj	kvo_type_spec._kvo_backing_obj
618 
619 /*
620  * The KERN_PROC_KSTACK sysctl allows a process to dump the kernel stacks of
621  * another process as a series of entries.  Each stack is represented by a
622  * series of symbol names and offsets as generated by stack_sbuf_print(9).
623  */
624 #define	KKST_MAXLEN	1024
625 
626 #define	KKST_STATE_STACKOK	0		/* Stack is valid. */
627 #define	KKST_STATE_SWAPPED	1		/* Stack swapped out, obsolete. */
628 #define	KKST_STATE_RUNNING	2		/* Stack ephemeral. */
629 
630 #if defined(__amd64__) || defined(__i386__)
631 #define	KINFO_KSTACK_SIZE	1096
632 #endif
633 
634 struct kinfo_kstack {
635 	lwpid_t	 kkst_tid;			/* ID of thread. */
636 	int	 kkst_state;			/* Validity of stack. */
637 	char	 kkst_trace[KKST_MAXLEN];	/* String representing stack. */
638 	int	 _kkst_ispare[16];		/* Space for more stuff. */
639 };
640 
641 struct kinfo_sigtramp {
642 	void	*ksigtramp_start;
643 	void	*ksigtramp_end;
644 	void	*ksigtramp_spare[4];
645 };
646 
647 #define	KMAP_FLAG_WIREFUTURE	0x01	/* all future mappings wil be wired */
648 #define	KMAP_FLAG_ASLR		0x02	/* ASLR is applied to mappings */
649 #define	KMAP_FLAG_ASLR_IGNSTART	0x04	/* ASLR may map into sbrk grow region */
650 #define	KMAP_FLAG_WXORX		0x08	/* W^X mapping policy is enforced */
651 #define	KMAP_FLAG_ASLR_STACK	0x10	/* the stack location is randomized */
652 #define	KMAP_FLAG_ASLR_SHARED_PAGE 0x20	/* the shared page location is randomized */
653 
654 struct kinfo_vm_layout {
655 	uintptr_t	kvm_min_user_addr;
656 	uintptr_t	kvm_max_user_addr;
657 	uintptr_t	kvm_text_addr;
658 	size_t		kvm_text_size;
659 	uintptr_t	kvm_data_addr;
660 	size_t		kvm_data_size;
661 	uintptr_t	kvm_stack_addr;
662 	size_t		kvm_stack_size;
663 	int		kvm_map_flags;
664 	uintptr_t	kvm_shp_addr;
665 	size_t		kvm_shp_size;
666 	uintptr_t	kvm_spare[12];
667 };
668 
669 #define	KNOTE_STATUS_ACTIVE		0x00000001
670 #define	KNOTE_STATUS_QUEUED		0x00000002
671 #define	KNOTE_STATUS_DISABLED		0x00000004
672 #define	KNOTE_STATUS_DETACHED		0x00000008
673 #define	KNOTE_STATUS_KQUEUE		0x00000010
674 
675 #define	KNOTE_EXTDATA_NONE		0
676 #define	KNOTE_EXTDATA_VNODE		1
677 #define	KNOTE_EXTDATA_PIPE		2
678 
679 struct kinfo_knote {
680 	struct kevent	knt_event;
681 	int		knt_status;
682 	int		knt_extdata;
683 	union {
684 		struct {
685 			int		knt_vnode_type;
686 			uint64_t	knt_vnode_fsid;
687 			uint64_t	knt_vnode_fileid;
688 			char		knt_vnode_fullpath[PATH_MAX];
689 		} knt_vnode;
690 		struct {
691 			ino_t		knt_pipe_ino;
692 		} knt_pipe;
693 	};
694 };
695 
696 #ifdef _KERNEL
697 /* Flags for kern_proc_out function. */
698 #define KERN_PROC_NOTHREADS	0x1
699 #define KERN_PROC_MASK32	0x2
700 
701 /* Flags for kern_proc_filedesc_out. */
702 #define	KERN_FILEDESC_PACK_KINFO	0x00000001U
703 
704 /* Flags for kern_proc_vmmap_out. */
705 #define	KERN_VMMAP_PACK_KINFO		0x00000001U
706 struct sbuf;
707 
708 /*
709  * The kern_proc out functions are helper functions to dump process
710  * miscellaneous kinfo structures to sbuf.  The main consumers are KERN_PROC
711  * sysctls but they may also be used by other kernel subsystems.
712  *
713  * The functions manipulate the process locking state and expect the process
714  * to be locked on enter.  On return the process is unlocked.
715  */
716 
717 int	kern_proc_filedesc_out(struct proc *p, struct sbuf *sb, ssize_t maxlen,
718 	int flags);
719 int	kern_proc_cwd_out(struct proc *p, struct sbuf *sb, ssize_t maxlen);
720 int	kern_proc_out(struct proc *p, struct sbuf *sb, int flags);
721 int	kern_proc_vmmap_out(struct proc *p, struct sbuf *sb, ssize_t maxlen,
722 	int flags);
723 
724 int	vntype_to_kinfo(int vtype);
725 void	pack_kinfo(struct kinfo_file *kif);
726 #endif /* !_KERNEL */
727 
728 #endif
729