xref: /freebsd/usr.bin/procstat/procstat.h (revision a7623790fb345e6dc986dfd31df0ace115e6f2e4)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2007 Robert N. M. Watson
5  * Copyright (c) 2015 Allan Jude <allanjude@freebsd.org>
6  * Copyright (c) 2017 Dell EMC
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  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #include <libxo/xo.h>
34 
35 #ifndef PROCSTAT_H
36 #define	PROCSTAT_H
37 
38 #define PROCSTAT_XO_VERSION "1"
39 
40 enum {
41 	PS_OPT_CAPABILITIES	= 0x01,
42 	PS_OPT_NOHEADER		= 0x02,
43 	PS_OPT_PERTHREAD	= 0x04,
44 	PS_OPT_SIGNUM		= 0x08,
45 	PS_OPT_VERBOSE		= 0x10,
46 	PS_MODE_COMPAT		= 0x20,
47 };
48 
49 #define PS_SUBCOMMAND_OPTS			\
50 	(PS_OPT_CAPABILITIES | PS_OPT_SIGNUM |	\
51 	    PS_OPT_PERTHREAD | PS_OPT_VERBOSE)
52 
53 extern int	procstat_opts;
54 
55 struct kinfo_proc;
56 void	kinfo_proc_sort(struct kinfo_proc *kipp, int count);
57 const char *	kinfo_proc_thread_name(const struct kinfo_proc *kipp);
58 
59 void	procstat_args(struct procstat *prstat, struct kinfo_proc *kipp);
60 void	procstat_auxv(struct procstat *prstat, struct kinfo_proc *kipp);
61 void	procstat_basic(struct procstat *prstat, struct kinfo_proc *kipp);
62 void	procstat_bin(struct procstat *prstat, struct kinfo_proc *kipp);
63 void	procstat_cred(struct procstat *prstat, struct kinfo_proc *kipp);
64 void	procstat_cs(struct procstat *prstat, struct kinfo_proc *kipp);
65 void	procstat_env(struct procstat *prstat, struct kinfo_proc *kipp);
66 void	procstat_files(struct procstat *prstat, struct kinfo_proc *kipp);
67 void	procstat_kstack(struct procstat *prstat, struct kinfo_proc *kipp);
68 void	procstat_pargs(struct procstat *prstat, struct kinfo_proc *kipp);
69 void	procstat_penv(struct procstat *prstat, struct kinfo_proc *kipp);
70 void	procstat_ptlwpinfo(struct procstat *prstat, struct kinfo_proc *kipp);
71 void	procstat_pwdx(struct procstat *prstat, struct kinfo_proc *kipp);
72 void	procstat_rlimit(struct procstat *prstat, struct kinfo_proc *kipp);
73 void	procstat_rusage(struct procstat *prstat, struct kinfo_proc *kipp);
74 void	procstat_sigfastblock(struct procstat *procstat,
75 	    struct kinfo_proc *kipp);
76 void	procstat_sigs(struct procstat *prstat, struct kinfo_proc *kipp);
77 void	procstat_threads(struct procstat *prstat, struct kinfo_proc *kipp);
78 void	procstat_threads_sigs(struct procstat *prstat, struct kinfo_proc *kipp);
79 void	procstat_vm(struct procstat *prstat, struct kinfo_proc *kipp);
80 
81 #endif /* !PROCSTAT_H */
82