2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2007, 2011 Robert N. M. Watson
5 * Copyright (c) 2015 Allan Jude <allanjude@freebsd.org>
6 * Copyright (c) 2017 Dell EMC
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/sysctl.h>
39 #include <libprocstat.h>
56 const char *xocontainer;
58 void (*cmd)(struct procstat *, struct kinfo_proc *);
59 void (*opt)(int, char * const *);
63 int procstat_opts = 0;
65 static void cmdopt_none(int argc, char * const argv[]);
66 static void cmdopt_verbose(int argc, char * const argv[]);
67 static void cmdopt_signals(int argc, char * const argv[]);
68 static void cmdopt_rusage(int argc, char * const argv[]);
69 static void cmdopt_files(int argc, char * const argv[]);
70 static void cmdopt_cpuset(int argc, char * const argv[]);
72 static const char *progname;
74 /* aliased program parameters and arguments
75 * - usage field is abused to hold the pointer to the function
76 * displaying program usage
78 static const struct procstat_cmd pacmd_table[] = {
79 /* arguments are the same as for pwdx: pid or core file */
80 { "pargs", "args", NULL, &procstat_pargs, &cmdopt_none,
81 PS_CMP_NORMAL | PS_MODE_COMPAT },
82 { "penv", "env", NULL, &procstat_penv, &cmdopt_none,
83 PS_CMP_NORMAL | PS_MODE_COMPAT },
84 { "pwdx", "pwd", NULL, &procstat_pwdx, &cmdopt_none,
85 PS_CMP_NORMAL | PS_MODE_COMPAT }
88 /* procstat parameters and arguments */
89 static const struct procstat_cmd cmd_table[] = {
90 { "argument", "arguments", NULL, &procstat_args, &cmdopt_none,
91 PS_CMP_PLURAL | PS_CMP_SUBSTR },
92 { "auxv", "auxv", NULL, &procstat_auxv, &cmdopt_none, PS_CMP_NORMAL },
93 { "basic", "basic", NULL, &procstat_basic, &cmdopt_none,
95 { "binary", "binary", NULL, &procstat_bin, &cmdopt_none,
97 { "cpuset", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
98 { "cs", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
99 { "credential", "credentials", NULL, &procstat_cred, &cmdopt_none,
100 PS_CMP_PLURAL | PS_CMP_SUBSTR },
101 { "environment", "environment", NULL, &procstat_env, &cmdopt_none,
103 { "fd", "files", "[-C]", &procstat_files, &cmdopt_files,
105 { "file", "files", "[-C]", &procstat_files, &cmdopt_files,
107 { "kstack", "kstack", "[-v]", &procstat_kstack, &cmdopt_verbose,
109 { "pargs", "args", NULL, &procstat_pargs, &cmdopt_none,
111 { "penv", "env", NULL, &procstat_penv, &cmdopt_none,
113 { "ptlwpinfo", "ptlwpinfo", NULL, &procstat_ptlwpinfo, &cmdopt_none,
115 { "pwdx", "pwd", NULL, &procstat_pwdx, &cmdopt_none,
117 { "rlimit", "rlimit", NULL, &procstat_rlimit, &cmdopt_none,
119 { "rusage", "rusage", "[-Ht]", &procstat_rusage, &cmdopt_rusage,
121 { "sigfastblock", "sigfastblock", NULL, &procstat_sigfastblock,
122 &cmdopt_none, PS_CMP_NORMAL },
123 { "signal", "signals", "[-n]", &procstat_sigs, &cmdopt_signals,
124 PS_CMP_PLURAL | PS_CMP_SUBSTR },
125 { "thread", "threads", NULL, &procstat_threads, &cmdopt_none,
127 { "tsignal", "thread_signals", "[-n]", &procstat_threads_sigs,
128 &cmdopt_signals, PS_CMP_PLURAL | PS_CMP_SUBSTR },
129 { "vm", "vm", NULL, &procstat_vm, &cmdopt_none, PS_CMP_NORMAL }
133 usage(const struct procstat_cmd *cmd)
138 if (cmd == NULL || (cmd->cmp & PS_MODE_COMPAT) == 0) {
139 xo_error("usage: procstat [--libxo] [-h] [-M core] [-N system]"
140 " [-w interval] command\n"
141 " [pid ... | core ...]\n"
142 " procstat [--libxo] -a [-h] [-M core] [-N system] "
143 " [-w interval] command\n"
144 " procstat [--libxo] [-h] [-M core] [-N system]"
146 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
147 "-j [-n] | -k [-k] |\n"
148 " -l | -r [-H] | -s | -t | -v | -x] "
149 "[pid ... | core ...]\n"
150 " procstat [--libxo] -a [-h] [-M core] [-N system]"
152 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
153 "-j [-n] | -k [-k] |\n"
154 " -l | -r [-H] | -s | -t | -v | -x]\n"
155 " procstat [--libxo] -L [-h] [-M core] [-N system] core ...\n"
156 "Available commands:\n");
157 for (i = 0, l = nitems(cmd_table); i < l; i++) {
158 multi = i + 1 < l && cmd_table[i].cmd ==
159 cmd_table[i + 1].cmd;
160 xo_error(" %s%s%s", multi ? "[" : "",
161 cmd_table[i].command, (cmd_table[i].cmp &
162 PS_CMP_PLURAL) ? "(s)" : "");
163 for (; i + 1 < l && cmd_table[i].cmd ==
164 cmd_table[i + 1].cmd; i++)
165 xo_error(" | %s%s", cmd_table[i + 1].command,
166 (cmd_table[i].cmp & PS_CMP_PLURAL) ?
170 if (cmd_table[i].usage != NULL)
171 xo_error(" %s", cmd_table[i].usage);
175 xo_error("usage: %s [--libxo] pid ...\n", progname);
182 procstat(const struct procstat_cmd *cmd, struct procstat *prstat,
183 struct kinfo_proc *kipp)
187 asprintf(&pidstr, "%d", kipp->ki_pid);
189 xo_errc(1, ENOMEM, "Failed to allocate memory in procstat()");
190 xo_open_container(pidstr);
191 cmd->cmd(prstat, kipp);
192 xo_close_container(pidstr);
197 * Sort processes first by pid and then tid.
200 kinfo_proc_compare(const void *a, const void *b)
204 i = ((const struct kinfo_proc *)a)->ki_pid -
205 ((const struct kinfo_proc *)b)->ki_pid;
208 i = ((const struct kinfo_proc *)a)->ki_tid -
209 ((const struct kinfo_proc *)b)->ki_tid;
214 kinfo_proc_sort(struct kinfo_proc *kipp, int count)
217 qsort(kipp, count, sizeof(*kipp), kinfo_proc_compare);
221 kinfo_proc_thread_name(const struct kinfo_proc *kipp)
223 static char name[MAXCOMLEN+1];
225 strlcpy(name, kipp->ki_tdname, sizeof(name));
226 strlcat(name, kipp->ki_moretdname, sizeof(name));
227 if (name[0] == '\0' || strcmp(kipp->ki_comm, name) == 0) {
235 static const struct procstat_cmd *
236 getcmdbyprogname(const char *pprogname)
241 if (pprogname == NULL)
243 len = strlen(pprogname);
245 for (i = 0; i < nitems(pacmd_table); i++) {
246 ca = pacmd_table[i].command;
247 if (ca != NULL && strcmp(ca, pprogname) == 0)
248 return (&pacmd_table[i]);
254 static const struct procstat_cmd *
255 getcmd(const char *str)
257 const struct procstat_cmd *cmd;
264 if ((l = strlen(str)) == 0)
265 return (getcmd("basic"));
266 s = l > 1 && strcasecmp(str + l - 1, "s") == 0;
267 for (i = 0; i < nitems(cmd_table); i++) {
269 * After the first match substring matches are disabled,
270 * allowing subsequent full matches to take precedence.
272 if (cmd == NULL && (cmd_table[i].cmp & PS_CMP_SUBSTR))
273 cmp = strncasecmp(str, cmd_table[i].command, l -
274 ((cmd_table[i].cmp & PS_CMP_PLURAL) && s ? 1 : 0));
275 else if ((cmd_table[i].cmp & PS_CMP_PLURAL) && s &&
276 l == strlen(cmd_table[i].command) + 1)
277 cmp = strncasecmp(str, cmd_table[i].command, l - 1);
279 cmp = strcasecmp(str, cmd_table[i].command);
287 main(int argc, char *argv[])
289 struct kinfo_proc *p;
290 const struct procstat_cmd *cmd;
291 struct procstat *prstat, *cprstat;
292 char *dummy, *nlistf, *memf;
293 const char *xocontainer;
296 int aflag, ch, cnt, i, interval;
300 memf = nlistf = NULL;
302 argc = xo_parse_args(argc, argv);
304 progname = getprogname();
305 cmd = getcmdbyprogname(progname);
307 while ((ch = getopt(argc, argv, "abCcefHhijkLlM:N:nrSstvw:x")) != -1) {
315 cmd = getcmd("binary");
318 procstat_opts |= PS_OPT_CAPABILITIES;
323 cmd = getcmd("arguments");
328 cmd = getcmd("environment");
333 cmd = getcmd("files");
336 procstat_opts |= PS_OPT_PERTHREAD;
339 procstat_opts |= PS_OPT_NOHEADER;
344 cmd = getcmd("signals");
349 cmd = getcmd("tsignals");
352 if (cmd != NULL && cmd->cmd == procstat_kstack) {
353 if ((procstat_opts & PS_OPT_VERBOSE) != 0)
355 procstat_opts |= PS_OPT_VERBOSE;
359 cmd = getcmd("kstack");
365 cmd = getcmd("ptlwpinfo");
370 cmd = getcmd("rlimit");
379 procstat_opts |= PS_OPT_SIGNUM;
384 cmd = getcmd("rusage");
389 cmd = getcmd("cpuset");
394 cmd = getcmd("credentials");
399 cmd = getcmd("threads");
407 l = strtol(optarg, &dummy, 10);
410 if (l < 1 || l > INT_MAX)
417 cmd = getcmd("auxv");
428 if (cmd == NULL && argv[0] != NULL && (cmd = getcmd(argv[0])) != NULL) {
429 if ((procstat_opts & PS_SUBCOMMAND_OPTS) != 0)
431 if (cmd->opt != NULL) {
434 cmd->opt(argc, argv);
435 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
445 cmd = getcmd("basic");
446 if (cmd->cmd != procstat_files &&
447 (procstat_opts & PS_OPT_CAPABILITIES) != 0 &&
448 (cmd->cmp & PS_MODE_COMPAT) == 0)
452 /* Must specify either the -a flag or a list of pids. */
453 if (!(aflag == 1 && argc == 0) && !(aflag == 0 && argc > 0))
457 prstat = procstat_open_kvm(nlistf, memf);
459 prstat = procstat_open_sysctl();
461 xo_errx(1, "procstat_open()");
463 xocontainer = cmd->xocontainer != NULL ? cmd->xocontainer :
465 xo_set_version(PROCSTAT_XO_VERSION);
466 xo_open_container(progname);
467 xo_open_container(xocontainer);
470 p = procstat_getprocs(prstat, KERN_PROC_PROC, 0, &cnt);
472 xo_errx(1, "procstat_getprocs()");
473 kinfo_proc_sort(p, cnt);
474 for (i = 0; i < cnt; i++) {
475 procstat(cmd, prstat, &p[i]);
477 /* Suppress header after first process. */
478 procstat_opts |= PS_OPT_NOHEADER;
481 procstat_freeprocs(prstat, p);
483 for (i = 0; i < argc; i++) {
484 l = strtol(argv[i], &dummy, 10);
485 if (*dummy == '\0') {
490 p = procstat_getprocs(prstat, KERN_PROC_PID,
493 xo_errx(1, "procstat_getprocs()");
495 procstat(cmd, prstat, p);
496 procstat_freeprocs(prstat, p);
498 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
499 cprstat = procstat_open_core(argv[i]);
500 if (cprstat == NULL) {
501 warnx("procstat_open()");
504 p = procstat_getprocs(cprstat,
505 KERN_PROC_PID, -1, &cnt);
508 "procstat_getprocs()");
511 procstat(cmd, cprstat, p);
512 procstat_freeprocs(cprstat, p);
513 procstat_close(cprstat);
518 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
519 /* Suppress header after first process. */
520 procstat_opts |= PS_OPT_NOHEADER;
524 xo_close_container(xocontainer);
525 xo_close_container(progname);
531 procstat_close(prstat);
537 cmdopt_none(int argc, char * const argv[])
541 while ((ch = getopt(argc, argv, "")) != -1) {
551 cmdopt_verbose(int argc, char * const argv[])
555 while ((ch = getopt(argc, argv, "v")) != -1) {
558 procstat_opts |= PS_OPT_VERBOSE;
568 cmdopt_signals(int argc, char * const argv[])
572 while ((ch = getopt(argc, argv, "n")) != -1) {
575 procstat_opts |= PS_OPT_SIGNUM;
585 cmdopt_rusage(int argc, char * const argv[])
589 while ((ch = getopt(argc, argv, "Ht")) != -1) {
594 procstat_opts |= PS_OPT_PERTHREAD;
604 cmdopt_files(int argc, char * const argv[])
608 while ((ch = getopt(argc, argv, "C")) != -1) {
611 procstat_opts |= PS_OPT_CAPABILITIES;
621 cmdopt_cpuset(int argc, char * const argv[])
624 procstat_opts |= PS_OPT_PERTHREAD;
625 cmdopt_none(argc, argv);