xref: /freebsd/sys/sys/user.h (revision f1f230439fa48581f40a57f095627f667a9713c3)
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	4
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_uerrmsg;		/* address of the ext err msg place */
216 	void	*ki_spareptrs[KI_NSPARE_PTR];	/* spare room for growth */
217 	long	ki_sparelongs[KI_NSPARE_LONG];	/* spare room for growth */
218 	long	ki_sflag;		/* PS_* flags */
219 	long	ki_tdflags;		/* XXXKSE kthread flag */
220 };
221 void fill_kinfo_proc(struct proc *, struct kinfo_proc *);
222 /* XXX - the following two defines are temporary */
223 #define	ki_childstime	ki_rusage_ch.ru_stime
224 #define	ki_childutime	ki_rusage_ch.ru_utime
225 
226 /*
227  *  Legacy PS_ flag.  This moved to p_flag but is maintained for
228  *  compatibility.
229  */
230 #define	PS_INMEM	0x00001		/* Loaded into memory, always true. */
231 
232 /* ki_sessflag values */
233 #define	KI_CTTY		0x00000001	/* controlling tty vnode active */
234 #define	KI_SLEADER	0x00000002	/* session leader */
235 #define	KI_LOCKBLOCK	0x00000004	/* proc blocked on lock ki_lockname */
236 
237 /*
238  * This used to be the per-process structure containing data that
239  * isn't needed in core when the process is swapped out, but now it
240  * remains only for the benefit of a.out core dumps.
241  */
242 struct user {
243 	struct	pstats u_stats;		/* *p_stats */
244 	struct	kinfo_proc u_kproc;	/* eproc */
245 };
246 
247 /*
248  * The KERN_PROC_FILE sysctl allows a process to dump the file descriptor
249  * array of another process.
250  */
251 #define	KF_ATTR_VALID	0x0001
252 
253 #define	KF_TYPE_NONE	0
254 #define	KF_TYPE_VNODE	1
255 #define	KF_TYPE_SOCKET	2
256 #define	KF_TYPE_PIPE	3
257 #define	KF_TYPE_FIFO	4
258 #define	KF_TYPE_KQUEUE	5
259 /* was	KF_TYPE_CRYPTO	6 */
260 #define	KF_TYPE_MQUEUE	7
261 #define	KF_TYPE_SHM	8
262 #define	KF_TYPE_SEM	9
263 #define	KF_TYPE_PTS	10
264 #define	KF_TYPE_PROCDESC	11
265 #define	KF_TYPE_DEV	12
266 #define	KF_TYPE_EVENTFD	13
267 #define	KF_TYPE_TIMERFD	14
268 #define	KF_TYPE_INOTIFY	15
269 #define	KF_TYPE_UNKNOWN	255
270 
271 #define	KF_VTYPE_VNON	0
272 #define	KF_VTYPE_VREG	1
273 #define	KF_VTYPE_VDIR	2
274 #define	KF_VTYPE_VBLK	3
275 #define	KF_VTYPE_VCHR	4
276 #define	KF_VTYPE_VLNK	5
277 #define	KF_VTYPE_VSOCK	6
278 #define	KF_VTYPE_VFIFO	7
279 #define	KF_VTYPE_VBAD	8
280 #define	KF_VTYPE_UNKNOWN	255
281 
282 #define	KF_FD_TYPE_CWD	-1	/* Current working directory */
283 #define	KF_FD_TYPE_ROOT	-2	/* Root directory */
284 #define	KF_FD_TYPE_JAIL	-3	/* Jail directory */
285 #define	KF_FD_TYPE_TRACE	-4	/* Ktrace vnode */
286 #define	KF_FD_TYPE_TEXT	-5	/* Text vnode */
287 #define	KF_FD_TYPE_CTTY	-6	/* Controlling terminal */
288 
289 #define	KF_FLAG_READ		0x00000001
290 #define	KF_FLAG_WRITE		0x00000002
291 #define	KF_FLAG_APPEND		0x00000004
292 #define	KF_FLAG_ASYNC		0x00000008
293 #define	KF_FLAG_FSYNC		0x00000010
294 #define	KF_FLAG_NONBLOCK	0x00000020
295 #define	KF_FLAG_DIRECT		0x00000040
296 #define	KF_FLAG_HASLOCK		0x00000080
297 #define	KF_FLAG_SHLOCK		0x00000100
298 #define	KF_FLAG_EXLOCK		0x00000200
299 #define	KF_FLAG_NOFOLLOW	0x00000400
300 #define	KF_FLAG_CREAT		0x00000800
301 #define	KF_FLAG_TRUNC		0x00001000
302 #define	KF_FLAG_EXCL		0x00002000
303 #define	KF_FLAG_EXEC		0x00004000
304 
305 /*
306  * Old format.  Has variable hidden padding due to alignment.
307  * This is a compatibility hack for pre-build 7.1 packages.
308  */
309 #if defined(__amd64__)
310 #define	KINFO_OFILE_SIZE	1328
311 #endif
312 #if defined(__i386__)
313 #define	KINFO_OFILE_SIZE	1324
314 #endif
315 
316 struct kinfo_ofile {
317 	int	kf_structsize;			/* Size of kinfo_file. */
318 	int	kf_type;			/* Descriptor type. */
319 	int	kf_fd;				/* Array index. */
320 	int	kf_ref_count;			/* Reference count. */
321 	int	kf_flags;			/* Flags. */
322 	/* XXX Hidden alignment padding here on amd64 */
323 	off_t	kf_offset;			/* Seek location. */
324 	int	kf_vnode_type;			/* Vnode type. */
325 	int	kf_sock_domain;			/* Socket domain. */
326 	int	kf_sock_type;			/* Socket type. */
327 	int	kf_sock_protocol;		/* Socket protocol. */
328 	char	kf_path[PATH_MAX];	/* Path to file, if any. */
329 	struct sockaddr_storage kf_sa_local;	/* Socket address. */
330 	struct sockaddr_storage	kf_sa_peer;	/* Peer address. */
331 };
332 
333 #if defined(__amd64__) || defined(__i386__)
334 /*
335  * This size should never be changed. If you really need to, you must provide
336  * backward ABI compatibility by allocating a new sysctl MIB that will return
337  * the new structure. The current structure has to be returned by the current
338  * sysctl MIB. See how it is done for the kinfo_ofile structure.
339  */
340 #define	KINFO_FILE_SIZE	1392
341 #endif
342 
343 struct kinfo_file {
344 	int		kf_structsize;		/* Variable size of record. */
345 	int		kf_type;		/* Descriptor type. */
346 	int		kf_fd;			/* Array index. */
347 	int		kf_ref_count;		/* Reference count. */
348 	int		kf_flags;		/* Flags. */
349 	int		kf_pad0;		/* Round to 64 bit alignment. */
350 	int64_t		kf_offset;		/* Seek location. */
351 	union {
352 		struct {
353 			/* API compatibility with FreeBSD < 12. */
354 			int		kf_vnode_type;
355 			int		kf_sock_domain;
356 			int		kf_sock_type;
357 			int		kf_sock_protocol;
358 			struct sockaddr_storage kf_sa_local;
359 			struct sockaddr_storage	kf_sa_peer;
360 		};
361 		union {
362 			struct {
363 				/* Sendq size */
364 				uint32_t	kf_sock_sendq;
365 				/* Socket domain. */
366 				int		kf_sock_domain0;
367 				/* Socket type. */
368 				int		kf_sock_type0;
369 				/* Socket protocol. */
370 				int		kf_sock_protocol0;
371 				/* Socket address. */
372 				struct sockaddr_storage kf_sa_local;
373 				/* Peer address. */
374 				struct sockaddr_storage	kf_sa_peer;
375 				/* Address of so_pcb. */
376 				uint64_t	kf_sock_pcb;
377 				/* Obsolete! May be reused as a spare. */
378 				uint64_t	kf_sock_inpcb;
379 				/* Address of unp_conn. */
380 				uint64_t	kf_sock_unpconn;
381 				/* Send buffer state. */
382 				uint16_t	kf_sock_snd_sb_state;
383 				/* Receive buffer state. */
384 				uint16_t	kf_sock_rcv_sb_state;
385 				/* Recvq size. */
386 				uint32_t	kf_sock_recvq;
387 			} kf_sock;
388 			struct {
389 				/* Vnode type. */
390 				int		kf_file_type;
391 				/* Space for future use */
392 				int		kf_spareint[3];
393 				uint64_t	kf_spareint64[29];
394 				/* Number of references to file. */
395 				uint64_t	kf_file_nlink;
396 				/* Vnode filesystem id. */
397 				uint64_t	kf_file_fsid;
398 				/* File device. */
399 				uint64_t	kf_file_rdev;
400 				/* Global file id. */
401 				uint64_t	kf_file_fileid;
402 				/* File size. */
403 				uint64_t	kf_file_size;
404 				/* Vnode filesystem id, FreeBSD 11 compat. */
405 				uint32_t	kf_file_fsid_freebsd11;
406 				/* File device, FreeBSD 11 compat. */
407 				uint32_t	kf_file_rdev_freebsd11;
408 				/* File mode. */
409 				uint16_t	kf_file_mode;
410 				/* Round to 64 bit alignment. */
411 				uint16_t	kf_file_pad0;
412 				uint32_t	kf_file_pad1;
413 			} kf_file;
414 			struct {
415 				uint32_t	kf_spareint[4];
416 				uint64_t	kf_spareint64[32];
417 				uint32_t	kf_sem_value;
418 				uint16_t	kf_sem_mode;
419 			} kf_sem;
420 			struct {
421 				uint32_t	kf_spareint[4];
422 				uint64_t	kf_spareint64[32];
423 				uint64_t	kf_pipe_addr;
424 				uint64_t	kf_pipe_peer;
425 				uint32_t	kf_pipe_buffer_cnt;
426 				uint32_t	kf_pipe_buffer_in;
427 				uint32_t	kf_pipe_buffer_out;
428 				uint32_t	kf_pipe_buffer_size;
429 			} kf_pipe;
430 			struct {
431 				uint32_t	kf_spareint[4];
432 				uint64_t	kf_spareint64[32];
433 				uint32_t	kf_pts_dev_freebsd11;
434 				uint32_t	kf_pts_pad0;
435 				uint64_t	kf_pts_dev;
436 				/* Round to 64 bit alignment. */
437 				uint32_t	kf_pts_pad1[4];
438 			} kf_pts;
439 			struct {
440 				uint32_t	kf_spareint[4];
441 				uint64_t	kf_spareint64[32];
442 				pid_t		kf_pid;
443 			} kf_proc;
444 			struct {
445 				uint64_t	kf_eventfd_value;
446 				uint32_t	kf_eventfd_flags;
447 				uint32_t	kf_eventfd_spareint[3];
448 				uint64_t	kf_eventfd_addr;
449 			} kf_eventfd;
450 			struct {
451 				uint32_t	kf_timerfd_clockid;
452 				uint32_t	kf_timerfd_flags;
453 				uint64_t	kf_timerfd_addr;
454 			} kf_timerfd;
455 			struct {
456 				uint64_t	kf_kqueue_addr;
457 				int32_t		kf_kqueue_count;
458 				int32_t		kf_kqueue_state;
459 			} kf_kqueue;
460 			struct {
461 				uint64_t	kf_inotify_npending;
462 				uint64_t	kf_inotify_nbpending;
463 			} kf_inotify;
464 		} kf_un;
465 	};
466 	uint16_t	kf_status;		/* Status flags. */
467 	uint16_t	kf_pad1;		/* Round to 32 bit alignment. */
468 	int		_kf_ispare0;		/* Space for more stuff. */
469 	cap_rights_t	kf_cap_rights;		/* Capability rights. */
470 	uint64_t	_kf_cap_spare;		/* Space for future cap_rights_t. */
471 	/* Truncated before copyout in sysctl */
472 	char		kf_path[PATH_MAX];	/* Path to file, if any. */
473 };
474 
475 struct kinfo_lockf {
476 	int		kl_structsize;		/* Variable size of record. */
477 	int		kl_rw;
478 	int		kl_type;
479 	int		kl_pid;
480 	int		kl_sysid;
481 	int		kl_pad0;
482 	uint64_t	kl_file_fsid;
483 	uint64_t	kl_file_rdev;
484 	uint64_t	kl_file_fileid;
485 	off_t		kl_start;
486 	off_t		kl_len;			/* len == 0 till the EOF */
487 	char		kl_path[PATH_MAX];
488 };
489 
490 #define	KLOCKF_RW_READ		0x01
491 #define	KLOCKF_RW_WRITE		0x02
492 
493 #define	KLOCKF_TYPE_FLOCK	0x01
494 #define	KLOCKF_TYPE_PID		0x02
495 #define	KLOCKF_TYPE_REMOTE	0x03
496 
497 /*
498  * The KERN_PROC_VMMAP sysctl allows a process to dump the VM layout of
499  * another process as a series of entries.
500  */
501 #define	KVME_TYPE_NONE		0
502 #define	KVME_TYPE_DEFAULT	1		/* no longer returned */
503 #define	KVME_TYPE_VNODE		2
504 #define	KVME_TYPE_SWAP		3
505 #define	KVME_TYPE_DEVICE	4
506 #define	KVME_TYPE_PHYS		5
507 #define	KVME_TYPE_DEAD		6
508 #define	KVME_TYPE_SG		7
509 #define	KVME_TYPE_MGTDEVICE	8
510 #define	KVME_TYPE_GUARD		9
511 #define	KVME_TYPE_UNKNOWN	255
512 
513 #define	KVME_PROT_READ		0x00000001
514 #define	KVME_PROT_WRITE		0x00000002
515 #define	KVME_PROT_EXEC		0x00000004
516 #define	KVME_MAX_PROT_READ	0x00010000
517 #define	KVME_MAX_PROT_WRITE	0x00020000
518 #define	KVME_MAX_PROT_EXEC	0x00040000
519 
520 #define	KVME_FLAG_COW		0x00000001
521 #define	KVME_FLAG_NEEDS_COPY	0x00000002
522 #define	KVME_FLAG_NOCOREDUMP	0x00000004
523 #define	KVME_FLAG_SUPER		0x00000008
524 #define	KVME_FLAG_GROWS_UP	0x00000010
525 #define	KVME_FLAG_GROWS_DOWN	0x00000020
526 #define	KVME_FLAG_USER_WIRED	0x00000040
527 #define	KVME_FLAG_SYSVSHM	0x00000080
528 #define	KVME_FLAG_POSIXSHM	0x00000100
529 
530 #if defined(__amd64__)
531 #define	KINFO_OVMENTRY_SIZE	1168
532 #endif
533 #if defined(__i386__)
534 #define	KINFO_OVMENTRY_SIZE	1128
535 #endif
536 
537 struct kinfo_ovmentry {
538 	int	 kve_structsize;		/* Size of kinfo_vmmapentry. */
539 	int	 kve_type;			/* Type of map entry. */
540 	void	*kve_start;			/* Starting address. */
541 	void	*kve_end;			/* Finishing address. */
542 	int	 kve_flags;			/* Flags on map entry. */
543 	int	 kve_resident;			/* Number of resident pages. */
544 	int	 kve_private_resident;		/* Number of private pages. */
545 	int	 kve_protection;		/* Protection bitmask. */
546 	int	 kve_ref_count;			/* VM obj ref count. */
547 	int	 kve_shadow_count;		/* VM obj shadow count. */
548 	char	 kve_path[PATH_MAX];		/* Path to VM obj, if any. */
549 	void	*_kve_pspare[8];		/* Space for more stuff. */
550 	off_t	 kve_offset;			/* Mapping offset in object */
551 	uint64_t kve_fileid;			/* inode number if vnode */
552 	uint32_t kve_fsid;			/* dev_t of vnode location */
553 	int	 _kve_ispare[3];		/* Space for more stuff. */
554 };
555 
556 #if defined(__amd64__) || defined(__i386__)
557 #define	KINFO_VMENTRY_SIZE	1160
558 #endif
559 
560 struct kinfo_vmentry {
561 	int	 kve_structsize;		/* Variable size of record. */
562 	int	 kve_type;			/* Type of map entry. */
563 	uint64_t kve_start;			/* Starting address. */
564 	uint64_t kve_end;			/* Finishing address. */
565 	uint64_t kve_offset;			/* Mapping offset in object */
566 	uint64_t kve_vn_fileid;			/* inode number if vnode */
567 	uint32_t kve_vn_fsid_freebsd11;		/* dev_t of vnode location */
568 	int	 kve_flags;			/* Flags on map entry. */
569 	int	 kve_resident;			/* Number of resident pages. */
570 	int	 kve_private_resident;		/* Number of private pages. */
571 	int	 kve_protection;		/* Protection bitmask. */
572 	int	 kve_ref_count;			/* VM obj ref count. */
573 	int	 kve_shadow_count;		/* VM obj shadow count. */
574 	int	 kve_vn_type;			/* Vnode type. */
575 	uint64_t kve_vn_size;			/* File size. */
576 	uint32_t kve_vn_rdev_freebsd11;		/* Device id if device. */
577 	uint16_t kve_vn_mode;			/* File mode. */
578 	uint16_t kve_status;			/* Status flags. */
579 	union {
580 		uint64_t _kve_vn_fsid;		/* dev_t of vnode location */
581 		uint64_t _kve_obj;		/* handle of anon obj */
582 	} kve_type_spec;
583 	uint64_t kve_vn_rdev;			/* Device id if device. */
584 	int	 _kve_ispare[8];		/* Space for more stuff. */
585 	/* Truncated before copyout in sysctl */
586 	char	 kve_path[PATH_MAX];		/* Path to VM obj, if any. */
587 };
588 #define	kve_vn_fsid	kve_type_spec._kve_vn_fsid
589 #define	kve_obj		kve_type_spec._kve_obj
590 
591 #define	KVMO_FLAG_SYSVSHM	0x0001
592 #define	KVMO_FLAG_POSIXSHM	0x0002
593 
594 /*
595  * The "vm.objects" sysctl provides a list of all VM objects in the system
596  * via an array of these entries.
597  */
598 struct kinfo_vmobject {
599 	int	kvo_structsize;			/* Variable size of record. */
600 	int	kvo_type;			/* Object type: KVME_TYPE_*. */
601 	uint64_t kvo_size;			/* Object size in pages. */
602 	uint64_t kvo_vn_fileid;			/* inode number if vnode. */
603 	uint32_t kvo_vn_fsid_freebsd11;		/* dev_t of vnode location. */
604 	int	kvo_ref_count;			/* Reference count. */
605 	int	kvo_shadow_count;		/* Shadow count. */
606 	int	kvo_memattr;			/* Memory attribute. */
607 	uint64_t kvo_resident;			/* Number of resident pages. */
608 	uint64_t kvo_active;			/* Number of active pages. */
609 	uint64_t kvo_inactive;			/* Number of inactive pages. */
610 	union {
611 		uint64_t _kvo_vn_fsid;
612 		uint64_t _kvo_backing_obj;	/* Handle for the backing obj */
613 	} kvo_type_spec;			/* Type-specific union */
614 	uint64_t kvo_me;			/* Uniq handle for anon obj */
615 	uint64_t kvo_laundry;			/* Number of laundry pages. */
616 	uint64_t _kvo_qspare[5];
617 	uint32_t kvo_swapped;			/* Number of swapped pages */
618 	uint32_t kvo_flags;
619 	uint32_t _kvo_ispare[6];
620 	char	kvo_path[PATH_MAX];		/* Pathname, if any. */
621 };
622 #define	kvo_vn_fsid	kvo_type_spec._kvo_vn_fsid
623 #define	kvo_backing_obj	kvo_type_spec._kvo_backing_obj
624 
625 /*
626  * The KERN_PROC_KSTACK sysctl allows a process to dump the kernel stacks of
627  * another process as a series of entries.  Each stack is represented by a
628  * series of symbol names and offsets as generated by stack_sbuf_print(9).
629  */
630 #define	KKST_MAXLEN	1024
631 
632 #define	KKST_STATE_STACKOK	0		/* Stack is valid. */
633 #define	KKST_STATE_SWAPPED	1		/* Stack swapped out, obsolete. */
634 #define	KKST_STATE_RUNNING	2		/* Stack ephemeral. */
635 
636 #if defined(__amd64__) || defined(__i386__)
637 #define	KINFO_KSTACK_SIZE	1096
638 #endif
639 
640 struct kinfo_kstack {
641 	lwpid_t	 kkst_tid;			/* ID of thread. */
642 	int	 kkst_state;			/* Validity of stack. */
643 	char	 kkst_trace[KKST_MAXLEN];	/* String representing stack. */
644 	int	 _kkst_ispare[16];		/* Space for more stuff. */
645 };
646 
647 struct kinfo_sigtramp {
648 	void	*ksigtramp_start;
649 	void	*ksigtramp_end;
650 	void	*ksigtramp_spare[4];
651 };
652 
653 #define	KMAP_FLAG_WIREFUTURE	0x01	/* all future mappings wil be wired */
654 #define	KMAP_FLAG_ASLR		0x02	/* ASLR is applied to mappings */
655 #define	KMAP_FLAG_ASLR_IGNSTART	0x04	/* ASLR may map into sbrk grow region */
656 #define	KMAP_FLAG_WXORX		0x08	/* W^X mapping policy is enforced */
657 #define	KMAP_FLAG_ASLR_STACK	0x10	/* the stack location is randomized */
658 #define	KMAP_FLAG_ASLR_SHARED_PAGE 0x20	/* the shared page location is randomized */
659 
660 struct kinfo_vm_layout {
661 	uintptr_t	kvm_min_user_addr;
662 	uintptr_t	kvm_max_user_addr;
663 	uintptr_t	kvm_text_addr;
664 	size_t		kvm_text_size;
665 	uintptr_t	kvm_data_addr;
666 	size_t		kvm_data_size;
667 	uintptr_t	kvm_stack_addr;
668 	size_t		kvm_stack_size;
669 	int		kvm_map_flags;
670 	uintptr_t	kvm_shp_addr;
671 	size_t		kvm_shp_size;
672 	uintptr_t	kvm_spare[12];
673 };
674 
675 #define	KNOTE_STATUS_ACTIVE		0x00000001
676 #define	KNOTE_STATUS_QUEUED		0x00000002
677 #define	KNOTE_STATUS_DISABLED		0x00000004
678 #define	KNOTE_STATUS_DETACHED		0x00000008
679 #define	KNOTE_STATUS_KQUEUE		0x00000010
680 
681 #define	KNOTE_EXTDATA_NONE		0
682 #define	KNOTE_EXTDATA_VNODE		1
683 #define	KNOTE_EXTDATA_PIPE		2
684 
685 struct kinfo_knote {
686 	int		knt_kq_fd;
687 	struct kevent	knt_event;
688 	int		knt_status;
689 	int		knt_extdata;
690 	uint64_t	knt_spare0[4];
691 	union {
692 		struct {
693 			int		knt_vnode_type;
694 			uint64_t	knt_vnode_fsid;
695 			uint64_t	knt_vnode_fileid;
696 			char		knt_vnode_fullpath[PATH_MAX];
697 		} knt_vnode;
698 		struct {
699 			ino_t		knt_pipe_ino;
700 		} knt_pipe;
701 	};
702 };
703 
704 #ifdef _KERNEL
705 /* Flags for kern_proc_out function. */
706 #define KERN_PROC_NOTHREADS	0x1
707 #define KERN_PROC_MASK32	0x2
708 
709 /* Flags for kern_proc_filedesc_out. */
710 #define	KERN_FILEDESC_PACK_KINFO	0x00000001U
711 
712 /* Flags for kern_proc_vmmap_out. */
713 #define	KERN_VMMAP_PACK_KINFO		0x00000001U
714 struct sbuf;
715 
716 /*
717  * The kern_proc out functions are helper functions to dump process
718  * miscellaneous kinfo structures to sbuf.  The main consumers are KERN_PROC
719  * sysctls but they may also be used by other kernel subsystems.
720  *
721  * The functions manipulate the process locking state and expect the process
722  * to be locked on enter.  On return the process is unlocked.
723  */
724 
725 int	kern_proc_filedesc_out(struct proc *p, struct sbuf *sb, ssize_t maxlen,
726 	int flags);
727 int	kern_proc_cwd_out(struct proc *p, struct sbuf *sb, ssize_t maxlen);
728 int	kern_proc_out(struct proc *p, struct sbuf *sb, int flags);
729 int	kern_proc_vmmap_out(struct proc *p, struct sbuf *sb, ssize_t maxlen,
730 	int flags);
731 int	kern_proc_kqueues_out(struct proc *p, struct sbuf *s, size_t maxlen,
732 	bool compat32);
733 
734 int	vntype_to_kinfo(int vtype);
735 void	pack_kinfo(struct kinfo_file *kif);
736 #endif /* !_KERNEL */
737 
738 #endif
739