2 * SPDX-License-Identifier: BSD-2-Clause
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/param.h>
32 #include <sys/sysctl.h>
36 #include <libprocstat.h>
53 const char *xocontainer;
55 void (*cmd)(struct procstat *, struct kinfo_proc *);
56 void (*opt)(int, char * const *);
60 int procstat_opts = 0;
62 static void cmdopt_none(int argc, char * const argv[]);
63 static void cmdopt_verbose(int argc, char * const argv[]);
64 static void cmdopt_signals(int argc, char * const argv[]);
65 static void cmdopt_rusage(int argc, char * const argv[]);
66 static void cmdopt_files(int argc, char * const argv[]);
67 static void cmdopt_cpuset(int argc, char * const argv[]);
69 static const char *progname;
71 /* aliased program parameters and arguments
72 * - usage field is abused to hold the pointer to the function
73 * displaying program usage
75 static const struct procstat_cmd pacmd_table[] = {
76 /* arguments are the same as for pwdx: pid or core file */
77 { "pargs", "args", NULL, &procstat_pargs, &cmdopt_none,
78 PS_CMP_NORMAL | PS_MODE_COMPAT },
79 { "penv", "env", NULL, &procstat_penv, &cmdopt_none,
80 PS_CMP_NORMAL | PS_MODE_COMPAT },
81 { "pwdx", "pwd", NULL, &procstat_pwdx, &cmdopt_none,
82 PS_CMP_NORMAL | PS_MODE_COMPAT }
85 /* procstat parameters and arguments */
86 static const struct procstat_cmd cmd_table[] = {
87 { "advlock", "advisory_locks", NULL, &procstat_advlocks, &cmdopt_none,
88 PS_CMP_PLURAL | PS_CMP_SUBSTR | PS_MODE_NO_KINFO_PROC },
89 { "argument", "arguments", NULL, &procstat_args, &cmdopt_none,
90 PS_CMP_PLURAL | PS_CMP_SUBSTR },
91 { "auxv", "auxv", NULL, &procstat_auxv, &cmdopt_none, PS_CMP_NORMAL },
92 { "basic", "basic", NULL, &procstat_basic, &cmdopt_none,
94 { "binary", "binary", NULL, &procstat_bin, &cmdopt_none,
96 { "cpuset", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
97 { "cs", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
98 { "credential", "credentials", NULL, &procstat_cred, &cmdopt_none,
99 PS_CMP_PLURAL | PS_CMP_SUBSTR },
100 { "environment", "environment", NULL, &procstat_env, &cmdopt_none,
102 { "fd", "files", "[-C]", &procstat_files, &cmdopt_files,
104 { "file", "files", "[-C]", &procstat_files, &cmdopt_files,
106 { "kstack", "kstack", "[-v]", &procstat_kstack, &cmdopt_verbose,
108 { "pargs", "args", NULL, &procstat_pargs, &cmdopt_none,
110 { "penv", "env", NULL, &procstat_penv, &cmdopt_none,
112 { "ptlwpinfo", "ptlwpinfo", NULL, &procstat_ptlwpinfo, &cmdopt_none,
114 { "pwdx", "pwd", NULL, &procstat_pwdx, &cmdopt_none,
116 { "rlimit", "rlimit", NULL, &procstat_rlimit, &cmdopt_none,
118 { "rusage", "rusage", "[-Ht]", &procstat_rusage, &cmdopt_rusage,
120 { "sigfastblock", "sigfastblock", NULL, &procstat_sigfastblock,
121 &cmdopt_none, PS_CMP_NORMAL },
122 { "signal", "signals", "[-n]", &procstat_sigs, &cmdopt_signals,
123 PS_CMP_PLURAL | PS_CMP_SUBSTR },
124 { "thread", "threads", NULL, &procstat_threads, &cmdopt_none,
126 { "tsignal", "thread_signals", "[-n]", &procstat_threads_sigs,
127 &cmdopt_signals, PS_CMP_PLURAL | PS_CMP_SUBSTR },
128 { "vm", "vm", NULL, &procstat_vm, &cmdopt_none, PS_CMP_NORMAL }
132 usage(const struct procstat_cmd *cmd)
137 if (cmd == NULL || (cmd->cmp & PS_MODE_COMPAT) == 0) {
138 xo_error("usage: procstat [--libxo] [-h] [-M core] [-N system]"
139 " [-w interval] command\n"
140 " [pid ... | core ...]\n"
141 " procstat [--libxo] -a [-h] [-M core] [-N system] "
142 " [-w interval] command\n"
143 " procstat [--libxo] [-h] [-M core] [-N system]"
145 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
146 "-j [-n] | -k [-k] |\n"
147 " -l | -r [-H] | -s | -t | -v | -x] "
148 "[pid ... | core ...]\n"
149 " procstat [--libxo] -a [-h] [-M core] [-N system]"
151 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
152 "-j [-n] | -k [-k] |\n"
153 " -l | -r [-H] | -s | -t | -v | -x]\n"
154 " procstat [--libxo] -L [-h] [-M core] [-N system] core ...\n"
155 "Available commands:\n");
156 for (i = 0, l = nitems(cmd_table); i < l; i++) {
157 multi = i + 1 < l && cmd_table[i].cmd ==
158 cmd_table[i + 1].cmd;
159 xo_error(" %s%s%s", multi ? "[" : "",
160 cmd_table[i].command, (cmd_table[i].cmp &
161 PS_CMP_PLURAL) ? "(s)" : "");
162 for (; i + 1 < l && cmd_table[i].cmd ==
163 cmd_table[i + 1].cmd; i++)
164 xo_error(" | %s%s", cmd_table[i + 1].command,
165 (cmd_table[i].cmp & PS_CMP_PLURAL) ?
169 if (cmd_table[i].usage != NULL)
170 xo_error(" %s", cmd_table[i].usage);
174 xo_error("usage: %s [--libxo] pid ...\n", progname);
181 procstat(const struct procstat_cmd *cmd, struct procstat *prstat,
182 struct kinfo_proc *kipp)
186 asprintf(&pidstr, "%d", kipp->ki_pid);
188 xo_errc(1, ENOMEM, "Failed to allocate memory in procstat()");
189 xo_open_container(pidstr);
190 cmd->cmd(prstat, kipp);
191 xo_close_container(pidstr);
196 * Sort processes first by pid and then tid.
199 kinfo_proc_compare(const void *a, const void *b)
203 i = ((const struct kinfo_proc *)a)->ki_pid -
204 ((const struct kinfo_proc *)b)->ki_pid;
207 i = ((const struct kinfo_proc *)a)->ki_tid -
208 ((const struct kinfo_proc *)b)->ki_tid;
213 kinfo_proc_sort(struct kinfo_proc *kipp, int count)
216 qsort(kipp, count, sizeof(*kipp), kinfo_proc_compare);
220 kinfo_proc_thread_name(const struct kinfo_proc *kipp)
222 static char name[MAXCOMLEN+1];
224 strlcpy(name, kipp->ki_tdname, sizeof(name));
225 strlcat(name, kipp->ki_moretdname, sizeof(name));
226 if (name[0] == '\0' || strcmp(kipp->ki_comm, name) == 0) {
234 static const struct procstat_cmd *
235 getcmdbyprogname(const char *pprogname)
240 if (pprogname == NULL)
243 for (i = 0; i < nitems(pacmd_table); i++) {
244 ca = pacmd_table[i].command;
245 if (ca != NULL && strcmp(ca, pprogname) == 0)
246 return (&pacmd_table[i]);
252 static const struct procstat_cmd *
253 getcmd(const char *str)
255 const struct procstat_cmd *cmd;
262 if ((l = strlen(str)) == 0)
263 return (getcmd("basic"));
264 s = l > 1 && strcasecmp(str + l - 1, "s") == 0;
265 for (i = 0; i < nitems(cmd_table); i++) {
267 * After the first match substring matches are disabled,
268 * allowing subsequent full matches to take precedence.
270 if (cmd == NULL && (cmd_table[i].cmp & PS_CMP_SUBSTR))
271 cmp = strncasecmp(str, cmd_table[i].command, l -
272 ((cmd_table[i].cmp & PS_CMP_PLURAL) && s ? 1 : 0));
273 else if ((cmd_table[i].cmp & PS_CMP_PLURAL) && s &&
274 l == strlen(cmd_table[i].command) + 1)
275 cmp = strncasecmp(str, cmd_table[i].command, l - 1);
277 cmp = strcasecmp(str, cmd_table[i].command);
285 main(int argc, char *argv[])
287 struct kinfo_proc *p;
288 const struct procstat_cmd *cmd;
289 struct procstat *prstat, *cprstat;
290 char *dummy, *nlistf, *memf;
291 const char *xocontainer;
294 int aflag, ch, cnt, i, interval;
298 memf = nlistf = NULL;
300 argc = xo_parse_args(argc, argv);
302 progname = getprogname();
303 cmd = getcmdbyprogname(progname);
305 while ((ch = getopt(argc, argv, "abCcefHhijkLlM:N:nrSstvw:x")) != -1) {
313 cmd = getcmd("binary");
316 procstat_opts |= PS_OPT_CAPABILITIES;
321 cmd = getcmd("arguments");
326 cmd = getcmd("environment");
331 cmd = getcmd("files");
334 procstat_opts |= PS_OPT_PERTHREAD;
337 procstat_opts |= PS_OPT_NOHEADER;
342 cmd = getcmd("signals");
347 cmd = getcmd("tsignals");
350 if (cmd != NULL && cmd->cmd == procstat_kstack) {
351 if ((procstat_opts & PS_OPT_VERBOSE) != 0)
353 procstat_opts |= PS_OPT_VERBOSE;
357 cmd = getcmd("kstack");
363 cmd = getcmd("ptlwpinfo");
368 cmd = getcmd("rlimit");
377 procstat_opts |= PS_OPT_SIGNUM;
382 cmd = getcmd("rusage");
387 cmd = getcmd("cpuset");
392 cmd = getcmd("credentials");
397 cmd = getcmd("threads");
405 l = strtol(optarg, &dummy, 10);
408 if (l < 1 || l > INT_MAX)
415 cmd = getcmd("auxv");
426 if (cmd == NULL && argv[0] != NULL && (cmd = getcmd(argv[0])) != NULL) {
427 if ((procstat_opts & PS_SUBCOMMAND_OPTS) != 0)
429 if (cmd->opt != NULL) {
432 cmd->opt(argc, argv);
433 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
443 cmd = getcmd("basic");
444 if (cmd->cmd != procstat_files &&
445 (procstat_opts & PS_OPT_CAPABILITIES) != 0 &&
446 (cmd->cmp & PS_MODE_COMPAT) == 0)
450 /* Must specify either the -a flag or a list of pids. */
451 if (!(aflag == 1 && argc == 0) && !(aflag == 0 && argc > 0) &&
452 (cmd->cmp & PS_MODE_NO_KINFO_PROC) == 0)
456 prstat = procstat_open_kvm(nlistf, memf);
458 prstat = procstat_open_sysctl();
460 xo_errx(1, "procstat_open()");
462 xocontainer = cmd->xocontainer != NULL ? cmd->xocontainer :
464 xo_set_version(PROCSTAT_XO_VERSION);
465 xo_open_container(progname);
466 xo_open_container(xocontainer);
468 if ((cmd->cmp & PS_MODE_NO_KINFO_PROC) != 0) {
469 cmd->cmd(prstat, NULL);
474 p = procstat_getprocs(prstat, KERN_PROC_PROC, 0, &cnt);
476 xo_errx(1, "procstat_getprocs()");
477 kinfo_proc_sort(p, cnt);
478 for (i = 0; i < cnt; i++) {
479 procstat(cmd, prstat, &p[i]);
481 /* Suppress header after first process. */
482 procstat_opts |= PS_OPT_NOHEADER;
485 procstat_freeprocs(prstat, p);
487 for (i = 0; i < argc; i++) {
488 l = strtol(argv[i], &dummy, 10);
489 if (*dummy == '\0') {
494 p = procstat_getprocs(prstat, KERN_PROC_PID,
497 xo_errx(1, "procstat_getprocs()");
499 procstat(cmd, prstat, p);
500 procstat_freeprocs(prstat, p);
502 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
503 cprstat = procstat_open_core(argv[i]);
504 if (cprstat == NULL) {
505 warnx("procstat_open()");
508 p = procstat_getprocs(cprstat,
509 KERN_PROC_PID, -1, &cnt);
512 "procstat_getprocs()");
515 procstat(cmd, cprstat, p);
516 procstat_freeprocs(cprstat, p);
517 procstat_close(cprstat);
522 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
523 /* Suppress header after first process. */
524 procstat_opts |= PS_OPT_NOHEADER;
529 xo_close_container(xocontainer);
530 xo_close_container(progname);
536 procstat_close(prstat);
542 cmdopt_none(int argc, char * const argv[])
546 while ((ch = getopt(argc, argv, "")) != -1) {
556 cmdopt_verbose(int argc, char * const argv[])
560 while ((ch = getopt(argc, argv, "v")) != -1) {
563 procstat_opts |= PS_OPT_VERBOSE;
573 cmdopt_signals(int argc, char * const argv[])
577 while ((ch = getopt(argc, argv, "n")) != -1) {
580 procstat_opts |= PS_OPT_SIGNUM;
590 cmdopt_rusage(int argc, char * const argv[])
594 while ((ch = getopt(argc, argv, "Ht")) != -1) {
599 procstat_opts |= PS_OPT_PERTHREAD;
609 cmdopt_files(int argc, char * const argv[])
613 while ((ch = getopt(argc, argv, "C")) != -1) {
616 procstat_opts |= PS_OPT_CAPABILITIES;
626 cmdopt_cpuset(int argc, char * const argv[])
629 procstat_opts |= PS_OPT_PERTHREAD;
630 cmdopt_none(argc, argv);