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 *	@(#)user.h	8.2 (Berkeley) 9/23/93
34 * $FreeBSD$
35 */
36
37#ifndef _SYS_USER_H_
38#define _SYS_USER_H_
39
40#include <machine/pcb.h>
41#ifndef _KERNEL
42/* stuff that *used* to be included by user.h, or is now needed */
43#include <sys/errno.h>
44#include <sys/time.h>
45#include <sys/resource.h>
46#include <sys/ucred.h>
47#include <sys/uio.h>
48#include <sys/queue.h>
49#include <sys/_lock.h>
50#include <sys/_mutex.h>
51#include <sys/proc.h>
52#include <vm/vm.h>		/* XXX */
53#include <vm/vm_param.h>	/* XXX */
54#include <vm/pmap.h>		/* XXX */
55#include <vm/vm_map.h>		/* XXX */
56#endif /* !_KERNEL */
57#ifndef _SYS_RESOURCEVAR_H_
58#include <sys/resourcevar.h>
59#endif
60#ifndef _SYS_SIGNALVAR_H_
61#include <sys/signalvar.h>
62#endif
63#ifndef _SYS_SOCKET_VAR_H_
64#include <sys/socket.h>
65#endif
66#include <sys/caprights.h>
67
68/*
69 * KERN_PROC subtype ops return arrays of selected proc structure entries:
70 *
71 * This struct includes several arrays of spare space, with different arrays
72 * for different standard C-types.  When adding new variables to this struct,
73 * the space for byte-aligned data should be taken from the ki_sparestring,
74 * pointers from ki_spareptrs, word-aligned data from ki_spareints, and
75 * doubleword-aligned data from ki_sparelongs.  Make sure the space for new
76 * variables come from the array which matches the size and alignment of
77 * those variables on ALL hardware platforms, and then adjust the appropriate
78 * KI_NSPARE_* value(s) to match.
79 *
80 * Always verify that sizeof(struct kinfo_proc) == KINFO_PROC_SIZE on all
81 * platforms after you have added new variables.  Note that if you change
82 * the value of KINFO_PROC_SIZE, then many userland programs will stop
83 * working until they are recompiled!
84 *
85 * Once you have added the new field, you will need to add code to initialize
86 * it in two places: function fill_kinfo_proc in sys/kern/kern_proc.c and
87 * function kvm_proclist in lib/libkvm/kvm_proc.c .
88 */
89#define	KI_NSPARE_INT	2
90#define	KI_NSPARE_LONG	12
91#define	KI_NSPARE_PTR	5
92
93#ifndef _KERNEL
94#ifndef KINFO_PROC_SIZE
95#error "Unknown architecture"
96#endif
97#endif /* !_KERNEL */
98
99#define	WMESGLEN	8		/* size of returned wchan message */
100#define	LOCKNAMELEN	8		/* size of returned lock name */
101#define	TDNAMLEN	16		/* size of returned thread name */
102#define	COMMLEN		19		/* size of returned ki_comm name */
103#define	KI_EMULNAMELEN	16		/* size of returned ki_emul */
104#define	KI_NGROUPS	16		/* number of groups in ki_groups */
105#define	LOGNAMELEN	17		/* size of returned ki_login */
106#define	LOGINCLASSLEN	17		/* size of returned ki_loginclass */
107
108#ifndef BURN_BRIDGES
109#define	OCOMMLEN	TDNAMLEN
110#define	ki_ocomm	ki_tdname
111#endif
112
113/* Flags for the process credential. */
114#define	KI_CRF_CAPABILITY_MODE	0x00000001
115/*
116 * Steal a bit from ki_cr_flags to indicate that the cred had more than
117 * KI_NGROUPS groups.
118 */
119#define KI_CRF_GRP_OVERFLOW	0x80000000
120
121struct kinfo_proc {
122	int	ki_structsize;		/* size of this structure */
123	int	ki_layout;		/* reserved: layout identifier */
124	struct	pargs *ki_args;		/* address of command arguments */
125	struct	proc *ki_paddr;		/* address of proc */
126	struct	user *ki_addr;		/* kernel virtual addr of u-area */
127	struct	vnode *ki_tracep;	/* pointer to trace file */
128	struct	vnode *ki_textvp;	/* pointer to executable file */
129	struct	filedesc *ki_fd;	/* pointer to open file info */
130	struct	vmspace *ki_vmspace;	/* pointer to kernel vmspace struct */
131	const void *ki_wchan;		/* sleep address */
132	pid_t	ki_pid;			/* Process identifier */
133	pid_t	ki_ppid;		/* parent process id */
134	pid_t	ki_pgid;		/* process group id */
135	pid_t	ki_tpgid;		/* tty process group id */
136	pid_t	ki_sid;			/* Process session ID */
137	pid_t	ki_tsid;		/* Terminal session ID */
138	short	ki_jobc;		/* job control counter */
139	short	ki_spare_short1;	/* unused (just here for alignment) */
140	uint32_t ki_tdev_freebsd11;	/* controlling tty dev */
141	sigset_t ki_siglist;		/* Signals arrived but not delivered */
142	sigset_t ki_sigmask;		/* Current signal mask */
143	sigset_t ki_sigignore;		/* Signals being ignored */
144	sigset_t ki_sigcatch;		/* Signals being caught by user */
145	uid_t	ki_uid;			/* effective user id */
146	uid_t	ki_ruid;		/* Real user id */
147	uid_t	ki_svuid;		/* Saved effective user id */
148	gid_t	ki_rgid;		/* Real group id */
149	gid_t	ki_svgid;		/* Saved effective group id */
150	short	ki_ngroups;		/* number of groups */
151	short	ki_spare_short2;	/* unused (just here for alignment) */
152	gid_t	ki_groups[KI_NGROUPS];	/* groups */
153	vm_size_t ki_size;		/* virtual size */
154	segsz_t ki_rssize;		/* current resident set size in pages */
155	segsz_t ki_swrss;		/* resident set size before last swap */
156	segsz_t ki_tsize;		/* text size (pages) XXX */
157	segsz_t ki_dsize;		/* data size (pages) XXX */
158	segsz_t ki_ssize;		/* stack size (pages) */
159	u_short	ki_xstat;		/* Exit status for wait & stop signal */
160	u_short	ki_acflag;		/* Accounting flags */
161	fixpt_t	ki_pctcpu;	 	/* %cpu for process during ki_swtime */
162	u_int	ki_estcpu;	 	/* Time averaged value of ki_cpticks */
163	u_int	ki_slptime;	 	/* Time since last blocked */
164	u_int	ki_swtime;	 	/* Time swapped in or out */
165	u_int	ki_cow;			/* number of copy-on-write faults */
166	u_int64_t ki_runtime;		/* Real time in microsec */
167	struct	timeval ki_start;	/* starting time */
168	struct	timeval ki_childtime;	/* time used by process children */
169	long	ki_flag;		/* P_* flags */
170	long	ki_kiflag;		/* KI_* flags (below) */
171	int	ki_traceflag;		/* Kernel trace points */
172	char	ki_stat;		/* S* process status */
173	signed char ki_nice;		/* Process "nice" value */
174	char	ki_lock;		/* Process lock (prevent swap) count */
175	char	ki_rqindex;		/* Run queue index */
176	u_char	ki_oncpu_old;		/* Which cpu we are on (legacy) */
177	u_char	ki_lastcpu_old;		/* Last cpu we were on (legacy) */
178	char	ki_tdname[TDNAMLEN+1];	/* thread name */
179	char	ki_wmesg[WMESGLEN+1];	/* wchan message */
180	char	ki_login[LOGNAMELEN+1];	/* setlogin name */
181	char	ki_lockname[LOCKNAMELEN+1]; /* lock name */
182	char	ki_comm[COMMLEN+1];	/* command name */
183	char	ki_emul[KI_EMULNAMELEN+1];  /* emulation name */
184	char	ki_loginclass[LOGINCLASSLEN+1]; /* login class */
185	char	ki_moretdname[MAXCOMLEN-TDNAMLEN+1];	/* more thread name */
186	/*
187	 * When adding new variables, take space for char-strings from the
188	 * front of ki_sparestrings, and ints from the end of ki_spareints.
189	 * That way the spare room from both arrays will remain contiguous.
190	 */
191	char	ki_sparestrings[46];	/* spare string space */
192	int	ki_spareints[KI_NSPARE_INT];	/* spare room for growth */
193	uint64_t ki_tdev;		/* controlling tty dev */
194	int	ki_oncpu;		/* Which cpu we are on */
195	int	ki_lastcpu;		/* Last cpu we were on */
196	int	ki_tracer;		/* Pid of tracing process */
197	int	ki_flag2;		/* P2_* flags */
198	int	ki_fibnum;		/* Default FIB number */
199	u_int	ki_cr_flags;		/* Credential flags */
200	int	ki_jid;			/* Process jail ID */
201	int	ki_numthreads;		/* XXXKSE number of threads in total */
202	lwpid_t	ki_tid;			/* XXXKSE thread id */
203	struct	priority ki_pri;	/* process priority */
204	struct	rusage ki_rusage;	/* process rusage statistics */
205	/* XXX - most fields in ki_rusage_ch are not (yet) filled in */
206	struct	rusage ki_rusage_ch;	/* rusage of children processes */
207	struct	pcb *ki_pcb;		/* kernel virtual addr of pcb */
208	void	*ki_kstack;		/* kernel virtual addr of stack */
209	void	*ki_udata;		/* User convenience pointer */
210	struct	thread *ki_tdaddr;	/* address of thread */
211	/*
212	 * When adding new variables, take space for pointers from the
213	 * front of ki_spareptrs, and longs from the end of ki_sparelongs.
214	 * That way the spare room from both arrays will remain contiguous.
215	 */
216	struct	pwddesc *ki_pd;	/* pointer to process paths info */
217	void	*ki_spareptrs[KI_NSPARE_PTR];	/* spare room for growth */
218	long	ki_sparelongs[KI_NSPARE_LONG];	/* spare room for growth */
219	long	ki_sflag;		/* PS_* flags */
220	long	ki_tdflags;		/* XXXKSE kthread flag */
221};
222void fill_kinfo_proc(struct proc *, struct kinfo_proc *);
223/* XXX - the following two defines are temporary */
224#define	ki_childstime	ki_rusage_ch.ru_stime
225#define	ki_childutime	ki_rusage_ch.ru_utime
226
227/*
228 *  Legacy PS_ flag.  This moved to p_flag but is maintained for
229 *  compatibility.
230 */
231#define	PS_INMEM	0x00001		/* Loaded into memory. */
232
233/* ki_sessflag values */
234#define	KI_CTTY		0x00000001	/* controlling tty vnode active */
235#define	KI_SLEADER	0x00000002	/* session leader */
236#define	KI_LOCKBLOCK	0x00000004	/* proc blocked on lock ki_lockname */
237
238/*
239 * This used to be the per-process structure containing data that
240 * isn't needed in core when the process is swapped out, but now it
241 * remains only for the benefit of a.out core dumps.
242 */
243struct user {
244	struct	pstats u_stats;		/* *p_stats */
245	struct	kinfo_proc u_kproc;	/* eproc */
246};
247
248/*
249 * The KERN_PROC_FILE sysctl allows a process to dump the file descriptor
250 * array of another process.
251 */
252#define	KF_ATTR_VALID	0x0001
253
254#define	KF_TYPE_NONE	0
255#define	KF_TYPE_VNODE	1
256#define	KF_TYPE_SOCKET	2
257#define	KF_TYPE_PIPE	3
258#define	KF_TYPE_FIFO	4
259#define	KF_TYPE_KQUEUE	5
260/* was	KF_TYPE_CRYPTO	6 */
261#define	KF_TYPE_MQUEUE	7
262#define	KF_TYPE_SHM	8
263#define	KF_TYPE_SEM	9
264#define	KF_TYPE_PTS	10
265#define	KF_TYPE_PROCDESC	11
266#define	KF_TYPE_DEV	12
267#define	KF_TYPE_EVENTFD	13
268#define	KF_TYPE_UNKNOWN	255
269
270#define	KF_VTYPE_VNON	0
271#define	KF_VTYPE_VREG	1
272#define	KF_VTYPE_VDIR	2
273#define	KF_VTYPE_VBLK	3
274#define	KF_VTYPE_VCHR	4
275#define	KF_VTYPE_VLNK	5
276#define	KF_VTYPE_VSOCK	6
277#define	KF_VTYPE_VFIFO	7
278#define	KF_VTYPE_VBAD	8
279#define	KF_VTYPE_UNKNOWN	255
280
281#define	KF_FD_TYPE_CWD	-1	/* Current working directory */
282#define	KF_FD_TYPE_ROOT	-2	/* Root directory */
283#define	KF_FD_TYPE_JAIL	-3	/* Jail directory */
284#define	KF_FD_TYPE_TRACE	-4	/* Ktrace vnode */
285#define	KF_FD_TYPE_TEXT	-5	/* Text vnode */
286#define	KF_FD_TYPE_CTTY	-6	/* Controlling terminal */
287
288#define	KF_FLAG_READ		0x00000001
289#define	KF_FLAG_WRITE		0x00000002
290#define	KF_FLAG_APPEND		0x00000004
291#define	KF_FLAG_ASYNC		0x00000008
292#define	KF_FLAG_FSYNC		0x00000010
293#define	KF_FLAG_NONBLOCK	0x00000020
294#define	KF_FLAG_DIRECT		0x00000040
295#define	KF_FLAG_HASLOCK		0x00000080
296#define	KF_FLAG_SHLOCK		0x00000100
297#define	KF_FLAG_EXLOCK		0x00000200
298#define	KF_FLAG_NOFOLLOW	0x00000400
299#define	KF_FLAG_CREAT		0x00000800
300#define	KF_FLAG_TRUNC		0x00001000
301#define	KF_FLAG_EXCL		0x00002000
302#define	KF_FLAG_EXEC		0x00004000
303
304/*
305 * Old format.  Has variable hidden padding due to alignment.
306 * This is a compatibility hack for pre-build 7.1 packages.
307 */
308#if defined(__amd64__)
309#define	KINFO_OFILE_SIZE	1328
310#endif
311#if defined(__i386__)
312#define	KINFO_OFILE_SIZE	1324
313#endif
314
315struct kinfo_ofile {
316	int	kf_structsize;			/* Size of kinfo_file. */
317	int	kf_type;			/* Descriptor type. */
318	int	kf_fd;				/* Array index. */
319	int	kf_ref_count;			/* Reference count. */
320	int	kf_flags;			/* Flags. */
321	/* XXX Hidden alignment padding here on amd64 */
322	off_t	kf_offset;			/* Seek location. */
323	int	kf_vnode_type;			/* Vnode type. */
324	int	kf_sock_domain;			/* Socket domain. */
325	int	kf_sock_type;			/* Socket type. */
326	int	kf_sock_protocol;		/* Socket protocol. */
327	char	kf_path[PATH_MAX];	/* Path to file, if any. */
328	struct sockaddr_storage kf_sa_local;	/* Socket address. */
329	struct sockaddr_storage	kf_sa_peer;	/* Peer address. */
330};
331
332#if defined(__amd64__) || defined(__i386__)
333/*
334 * This size should never be changed. If you really need to, you must provide
335 * backward ABI compatibility by allocating a new sysctl MIB that will return
336 * the new structure. The current structure has to be returned by the current
337 * sysctl MIB. See how it is done for the kinfo_ofile structure.
338 */
339#define	KINFO_FILE_SIZE	1392
340#endif
341
342struct kinfo_file {
343	int		kf_structsize;		/* Variable size of record. */
344	int		kf_type;		/* Descriptor type. */
345	int		kf_fd;			/* Array index. */
346	int		kf_ref_count;		/* Reference count. */
347	int		kf_flags;		/* Flags. */
348	int		kf_pad0;		/* Round to 64 bit alignment. */
349	int64_t		kf_offset;		/* Seek location. */
350	union {
351		struct {
352			/* API compatiblity with FreeBSD < 12. */
353			int		kf_vnode_type;
354			int		kf_sock_domain;
355			int		kf_sock_type;
356			int		kf_sock_protocol;
357			struct sockaddr_storage kf_sa_local;
358			struct sockaddr_storage	kf_sa_peer;
359		};
360		union {
361			struct {
362				/* Sendq size */
363				uint32_t	kf_sock_sendq;
364				/* Socket domain. */
365				int		kf_sock_domain0;
366				/* Socket type. */
367				int		kf_sock_type0;
368				/* Socket protocol. */
369				int		kf_sock_protocol0;
370				/* Socket address. */
371				struct sockaddr_storage kf_sa_local;
372				/* Peer address. */
373				struct sockaddr_storage	kf_sa_peer;
374				/* Address of so_pcb. */
375				uint64_t	kf_sock_pcb;
376				/* Address of inp_ppcb. */
377				uint64_t	kf_sock_inpcb;
378				/* Address of unp_conn. */
379				uint64_t	kf_sock_unpconn;
380				/* Send buffer state. */
381				uint16_t	kf_sock_snd_sb_state;
382				/* Receive buffer state. */
383				uint16_t	kf_sock_rcv_sb_state;
384				/* Recvq size. */
385				uint32_t	kf_sock_recvq;
386			} kf_sock;
387			struct {
388				/* Vnode type. */
389				int		kf_file_type;
390				/* Space for future use */
391				int		kf_spareint[3];
392				uint64_t	kf_spareint64[30];
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				/* Round to 64 bit alignment. */
424				uint32_t	kf_pipe_pad0[3];
425			} kf_pipe;
426			struct {
427				uint32_t	kf_spareint[4];
428				uint64_t	kf_spareint64[32];
429				uint32_t	kf_pts_dev_freebsd11;
430				uint32_t	kf_pts_pad0;
431				uint64_t	kf_pts_dev;
432				/* Round to 64 bit alignment. */
433				uint32_t	kf_pts_pad1[4];
434			} kf_pts;
435			struct {
436				uint32_t	kf_spareint[4];
437				uint64_t	kf_spareint64[32];
438				pid_t		kf_pid;
439			} kf_proc;
440			struct {
441				uint64_t	kf_eventfd_value;
442				uint32_t	kf_eventfd_flags;
443			} kf_eventfd;
444		} kf_un;
445	};
446	uint16_t	kf_status;		/* Status flags. */
447	uint16_t	kf_pad1;		/* Round to 32 bit alignment. */
448	int		_kf_ispare0;		/* Space for more stuff. */
449	cap_rights_t	kf_cap_rights;		/* Capability rights. */
450	uint64_t	_kf_cap_spare;		/* Space for future cap_rights_t. */
451	/* Truncated before copyout in sysctl */
452	char		kf_path[PATH_MAX];	/* Path to file, if any. */
453};
454
455/*
456 * The KERN_PROC_VMMAP sysctl allows a process to dump the VM layout of
457 * another process as a series of entries.
458 */
459#define	KVME_TYPE_NONE		0
460#define	KVME_TYPE_DEFAULT	1
461#define	KVME_TYPE_VNODE		2
462#define	KVME_TYPE_SWAP		3
463#define	KVME_TYPE_DEVICE	4
464#define	KVME_TYPE_PHYS		5
465#define	KVME_TYPE_DEAD		6
466#define	KVME_TYPE_SG		7
467#define	KVME_TYPE_MGTDEVICE	8
468#define	KVME_TYPE_GUARD		9
469#define	KVME_TYPE_UNKNOWN	255
470
471#define	KVME_PROT_READ		0x00000001
472#define	KVME_PROT_WRITE		0x00000002
473#define	KVME_PROT_EXEC		0x00000004
474
475#define	KVME_FLAG_COW		0x00000001
476#define	KVME_FLAG_NEEDS_COPY	0x00000002
477#define	KVME_FLAG_NOCOREDUMP	0x00000004
478#define	KVME_FLAG_SUPER		0x00000008
479#define	KVME_FLAG_GROWS_UP	0x00000010
480#define	KVME_FLAG_GROWS_DOWN	0x00000020
481#define	KVME_FLAG_USER_WIRED	0x00000040
482
483#if defined(__amd64__)
484#define	KINFO_OVMENTRY_SIZE	1168
485#endif
486#if defined(__i386__)
487#define	KINFO_OVMENTRY_SIZE	1128
488#endif
489
490struct kinfo_ovmentry {
491	int	 kve_structsize;		/* Size of kinfo_vmmapentry. */
492	int	 kve_type;			/* Type of map entry. */
493	void	*kve_start;			/* Starting address. */
494	void	*kve_end;			/* Finishing address. */
495	int	 kve_flags;			/* Flags on map entry. */
496	int	 kve_resident;			/* Number of resident pages. */
497	int	 kve_private_resident;		/* Number of private pages. */
498	int	 kve_protection;		/* Protection bitmask. */
499	int	 kve_ref_count;			/* VM obj ref count. */
500	int	 kve_shadow_count;		/* VM obj shadow count. */
501	char	 kve_path[PATH_MAX];		/* Path to VM obj, if any. */
502	void	*_kve_pspare[8];		/* Space for more stuff. */
503	off_t	 kve_offset;			/* Mapping offset in object */
504	uint64_t kve_fileid;			/* inode number if vnode */
505	uint32_t kve_fsid;			/* dev_t of vnode location */
506	int	 _kve_ispare[3];		/* Space for more stuff. */
507};
508
509#if defined(__amd64__) || defined(__i386__)
510#define	KINFO_VMENTRY_SIZE	1160
511#endif
512
513struct kinfo_vmentry {
514	int	 kve_structsize;		/* Variable size of record. */
515	int	 kve_type;			/* Type of map entry. */
516	uint64_t kve_start;			/* Starting address. */
517	uint64_t kve_end;			/* Finishing address. */
518	uint64_t kve_offset;			/* Mapping offset in object */
519	uint64_t kve_vn_fileid;			/* inode number if vnode */
520	uint32_t kve_vn_fsid_freebsd11;		/* dev_t of vnode location */
521	int	 kve_flags;			/* Flags on map entry. */
522	int	 kve_resident;			/* Number of resident pages. */
523	int	 kve_private_resident;		/* Number of private pages. */
524	int	 kve_protection;		/* Protection bitmask. */
525	int	 kve_ref_count;			/* VM obj ref count. */
526	int	 kve_shadow_count;		/* VM obj shadow count. */
527	int	 kve_vn_type;			/* Vnode type. */
528	uint64_t kve_vn_size;			/* File size. */
529	uint32_t kve_vn_rdev_freebsd11;		/* Device id if device. */
530	uint16_t kve_vn_mode;			/* File mode. */
531	uint16_t kve_status;			/* Status flags. */
532	union {
533		uint64_t _kve_vn_fsid;		/* dev_t of vnode location */
534		uint64_t _kve_obj;		/* handle of anon obj */
535	} kve_type_spec;
536	uint64_t kve_vn_rdev;			/* Device id if device. */
537	int	 _kve_ispare[8];		/* Space for more stuff. */
538	/* Truncated before copyout in sysctl */
539	char	 kve_path[PATH_MAX];		/* Path to VM obj, if any. */
540};
541#define	kve_vn_fsid	kve_type_spec._kve_vn_fsid
542#define	kve_obj		kve_type_spec._kve_obj
543
544/*
545 * The "vm.objects" sysctl provides a list of all VM objects in the system
546 * via an array of these entries.
547 */
548struct kinfo_vmobject {
549	int	kvo_structsize;			/* Variable size of record. */
550	int	kvo_type;			/* Object type: KVME_TYPE_*. */
551	uint64_t kvo_size;			/* Object size in pages. */
552	uint64_t kvo_vn_fileid;			/* inode number if vnode. */
553	uint32_t kvo_vn_fsid_freebsd11;		/* dev_t of vnode location. */
554	int	kvo_ref_count;			/* Reference count. */
555	int	kvo_shadow_count;		/* Shadow count. */
556	int	kvo_memattr;			/* Memory attribute. */
557	uint64_t kvo_resident;			/* Number of resident pages. */
558	uint64_t kvo_active;			/* Number of active pages. */
559	uint64_t kvo_inactive;			/* Number of inactive pages. */
560	union {
561		uint64_t _kvo_vn_fsid;
562		uint64_t _kvo_backing_obj;	/* Handle for the backing obj */
563	} kvo_type_spec;			/* Type-specific union */
564	uint64_t kvo_me;			/* Uniq handle for anon obj */
565	uint64_t _kvo_qspare[6];
566	uint32_t kvo_swapped;			/* Number of swapped pages */
567	uint32_t _kvo_ispare[7];
568	char	kvo_path[PATH_MAX];		/* Pathname, if any. */
569};
570#define	kvo_vn_fsid	kvo_type_spec._kvo_vn_fsid
571#define	kvo_backing_obj	kvo_type_spec._kvo_backing_obj
572
573/*
574 * The KERN_PROC_KSTACK sysctl allows a process to dump the kernel stacks of
575 * another process as a series of entries.  Each stack is represented by a
576 * series of symbol names and offsets as generated by stack_sbuf_print(9).
577 */
578#define	KKST_MAXLEN	1024
579
580#define	KKST_STATE_STACKOK	0		/* Stack is valid. */
581#define	KKST_STATE_SWAPPED	1		/* Stack swapped out. */
582#define	KKST_STATE_RUNNING	2		/* Stack ephemeral. */
583
584#if defined(__amd64__) || defined(__i386__)
585#define	KINFO_KSTACK_SIZE	1096
586#endif
587
588struct kinfo_kstack {
589	lwpid_t	 kkst_tid;			/* ID of thread. */
590	int	 kkst_state;			/* Validity of stack. */
591	char	 kkst_trace[KKST_MAXLEN];	/* String representing stack. */
592	int	 _kkst_ispare[16];		/* Space for more stuff. */
593};
594
595struct kinfo_sigtramp {
596	void	*ksigtramp_start;
597	void	*ksigtramp_end;
598	void	*ksigtramp_spare[4];
599};
600
601#ifdef _KERNEL
602/* Flags for kern_proc_out function. */
603#define KERN_PROC_NOTHREADS	0x1
604#define KERN_PROC_MASK32	0x2
605
606/* Flags for kern_proc_filedesc_out. */
607#define	KERN_FILEDESC_PACK_KINFO	0x00000001U
608
609/* Flags for kern_proc_vmmap_out. */
610#define	KERN_VMMAP_PACK_KINFO		0x00000001U
611struct sbuf;
612
613/*
614 * The kern_proc out functions are helper functions to dump process
615 * miscellaneous kinfo structures to sbuf.  The main consumers are KERN_PROC
616 * sysctls but they may also be used by other kernel subsystems.
617 *
618 * The functions manipulate the process locking state and expect the process
619 * to be locked on enter.  On return the process is unlocked.
620 */
621
622int	kern_proc_filedesc_out(struct proc *p, struct sbuf *sb, ssize_t maxlen,
623	int flags);
624int	kern_proc_cwd_out(struct proc *p, struct sbuf *sb, ssize_t maxlen);
625int	kern_proc_out(struct proc *p, struct sbuf *sb, int flags);
626int	kern_proc_vmmap_out(struct proc *p, struct sbuf *sb, ssize_t maxlen,
627	int flags);
628
629int	vntype_to_kinfo(int vtype);
630void	pack_kinfo(struct kinfo_file *kif);
631#endif /* !_KERNEL */
632
633#endif
634