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