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 { "advlock", "advisory_locks", NULL, &procstat_advlocks, &cmdopt_none,
91 PS_CMP_PLURAL | PS_CMP_SUBSTR | PS_MODE_NO_KINFO_PROC },
92 { "argument", "arguments", NULL, &procstat_args, &cmdopt_none,
93 PS_CMP_PLURAL | PS_CMP_SUBSTR },
94 { "auxv", "auxv", NULL, &procstat_auxv, &cmdopt_none, PS_CMP_NORMAL },
95 { "basic", "basic", NULL, &procstat_basic, &cmdopt_none,
97 { "binary", "binary", NULL, &procstat_bin, &cmdopt_none,
99 { "cpuset", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
100 { "cs", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
101 { "credential", "credentials", NULL, &procstat_cred, &cmdopt_none,
102 PS_CMP_PLURAL | PS_CMP_SUBSTR },
103 { "environment", "environment", NULL, &procstat_env, &cmdopt_none,
105 { "fd", "files", "[-C]", &procstat_files, &cmdopt_files,
107 { "file", "files", "[-C]", &procstat_files, &cmdopt_files,
109 { "kstack", "kstack", "[-v]", &procstat_kstack, &cmdopt_verbose,
111 { "pargs", "args", NULL, &procstat_pargs, &cmdopt_none,
113 { "penv", "env", NULL, &procstat_penv, &cmdopt_none,
115 { "ptlwpinfo", "ptlwpinfo", NULL, &procstat_ptlwpinfo, &cmdopt_none,
117 { "pwdx", "pwd", NULL, &procstat_pwdx, &cmdopt_none,
119 { "rlimit", "rlimit", NULL, &procstat_rlimit, &cmdopt_none,
121 { "rusage", "rusage", "[-Ht]", &procstat_rusage, &cmdopt_rusage,
123 { "sigfastblock", "sigfastblock", NULL, &procstat_sigfastblock,
124 &cmdopt_none, PS_CMP_NORMAL },
125 { "signal", "signals", "[-n]", &procstat_sigs, &cmdopt_signals,
126 PS_CMP_PLURAL | PS_CMP_SUBSTR },
127 { "thread", "threads", NULL, &procstat_threads, &cmdopt_none,
129 { "tsignal", "thread_signals", "[-n]", &procstat_threads_sigs,
130 &cmdopt_signals, PS_CMP_PLURAL | PS_CMP_SUBSTR },
131 { "vm", "vm", NULL, &procstat_vm, &cmdopt_none, PS_CMP_NORMAL }
135 usage(const struct procstat_cmd *cmd)
140 if (cmd == NULL || (cmd->cmp & PS_MODE_COMPAT) == 0) {
141 xo_error("usage: procstat [--libxo] [-h] [-M core] [-N system]"
142 " [-w interval] command\n"
143 " [pid ... | core ...]\n"
144 " procstat [--libxo] -a [-h] [-M core] [-N system] "
145 " [-w interval] command\n"
146 " procstat [--libxo] [-h] [-M core] [-N system]"
148 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
149 "-j [-n] | -k [-k] |\n"
150 " -l | -r [-H] | -s | -t | -v | -x] "
151 "[pid ... | core ...]\n"
152 " procstat [--libxo] -a [-h] [-M core] [-N system]"
154 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
155 "-j [-n] | -k [-k] |\n"
156 " -l | -r [-H] | -s | -t | -v | -x]\n"
157 " procstat [--libxo] -L [-h] [-M core] [-N system] core ...\n"
158 "Available commands:\n");
159 for (i = 0, l = nitems(cmd_table); i < l; i++) {
160 multi = i + 1 < l && cmd_table[i].cmd ==
161 cmd_table[i + 1].cmd;
162 xo_error(" %s%s%s", multi ? "[" : "",
163 cmd_table[i].command, (cmd_table[i].cmp &
164 PS_CMP_PLURAL) ? "(s)" : "");
165 for (; i + 1 < l && cmd_table[i].cmd ==
166 cmd_table[i + 1].cmd; i++)
167 xo_error(" | %s%s", cmd_table[i + 1].command,
168 (cmd_table[i].cmp & PS_CMP_PLURAL) ?
172 if (cmd_table[i].usage != NULL)
173 xo_error(" %s", cmd_table[i].usage);
177 xo_error("usage: %s [--libxo] pid ...\n", progname);
184 procstat(const struct procstat_cmd *cmd, struct procstat *prstat,
185 struct kinfo_proc *kipp)
189 asprintf(&pidstr, "%d", kipp->ki_pid);
191 xo_errc(1, ENOMEM, "Failed to allocate memory in procstat()");
192 xo_open_container(pidstr);
193 cmd->cmd(prstat, kipp);
194 xo_close_container(pidstr);
199 * Sort processes first by pid and then tid.
202 kinfo_proc_compare(const void *a, const void *b)
206 i = ((const struct kinfo_proc *)a)->ki_pid -
207 ((const struct kinfo_proc *)b)->ki_pid;
210 i = ((const struct kinfo_proc *)a)->ki_tid -
211 ((const struct kinfo_proc *)b)->ki_tid;
216 kinfo_proc_sort(struct kinfo_proc *kipp, int count)
219 qsort(kipp, count, sizeof(*kipp), kinfo_proc_compare);
223 kinfo_proc_thread_name(const struct kinfo_proc *kipp)
225 static char name[MAXCOMLEN+1];
227 strlcpy(name, kipp->ki_tdname, sizeof(name));
228 strlcat(name, kipp->ki_moretdname, sizeof(name));
229 if (name[0] == '\0' || strcmp(kipp->ki_comm, name) == 0) {
237 static const struct procstat_cmd *
238 getcmdbyprogname(const char *pprogname)
243 if (pprogname == NULL)
246 for (i = 0; i < nitems(pacmd_table); i++) {
247 ca = pacmd_table[i].command;
248 if (ca != NULL && strcmp(ca, pprogname) == 0)
249 return (&pacmd_table[i]);
255 static const struct procstat_cmd *
256 getcmd(const char *str)
258 const struct procstat_cmd *cmd;
265 if ((l = strlen(str)) == 0)
266 return (getcmd("basic"));
267 s = l > 1 && strcasecmp(str + l - 1, "s") == 0;
268 for (i = 0; i < nitems(cmd_table); i++) {
270 * After the first match substring matches are disabled,
271 * allowing subsequent full matches to take precedence.
273 if (cmd == NULL && (cmd_table[i].cmp & PS_CMP_SUBSTR))
274 cmp = strncasecmp(str, cmd_table[i].command, l -
275 ((cmd_table[i].cmp & PS_CMP_PLURAL) && s ? 1 : 0));
276 else if ((cmd_table[i].cmp & PS_CMP_PLURAL) && s &&
277 l == strlen(cmd_table[i].command) + 1)
278 cmp = strncasecmp(str, cmd_table[i].command, l - 1);
280 cmp = strcasecmp(str, cmd_table[i].command);
288 main(int argc, char *argv[])
290 struct kinfo_proc *p;
291 const struct procstat_cmd *cmd;
292 struct procstat *prstat, *cprstat;
293 char *dummy, *nlistf, *memf;
294 const char *xocontainer;
297 int aflag, ch, cnt, i, interval;
301 memf = nlistf = NULL;
303 argc = xo_parse_args(argc, argv);
305 progname = getprogname();
306 cmd = getcmdbyprogname(progname);
308 while ((ch = getopt(argc, argv, "abCcefHhijkLlM:N:nrSstvw:x")) != -1) {
316 cmd = getcmd("binary");
319 procstat_opts |= PS_OPT_CAPABILITIES;
324 cmd = getcmd("arguments");
329 cmd = getcmd("environment");
334 cmd = getcmd("files");
337 procstat_opts |= PS_OPT_PERTHREAD;
340 procstat_opts |= PS_OPT_NOHEADER;
345 cmd = getcmd("signals");
350 cmd = getcmd("tsignals");
353 if (cmd != NULL && cmd->cmd == procstat_kstack) {
354 if ((procstat_opts & PS_OPT_VERBOSE) != 0)
356 procstat_opts |= PS_OPT_VERBOSE;
360 cmd = getcmd("kstack");
366 cmd = getcmd("ptlwpinfo");
371 cmd = getcmd("rlimit");
380 procstat_opts |= PS_OPT_SIGNUM;
385 cmd = getcmd("rusage");
390 cmd = getcmd("cpuset");
395 cmd = getcmd("credentials");
400 cmd = getcmd("threads");
408 l = strtol(optarg, &dummy, 10);
411 if (l < 1 || l > INT_MAX)
418 cmd = getcmd("auxv");
429 if (cmd == NULL && argv[0] != NULL && (cmd = getcmd(argv[0])) != NULL) {
430 if ((procstat_opts & PS_SUBCOMMAND_OPTS) != 0)
432 if (cmd->opt != NULL) {
435 cmd->opt(argc, argv);
436 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
446 cmd = getcmd("basic");
447 if (cmd->cmd != procstat_files &&
448 (procstat_opts & PS_OPT_CAPABILITIES) != 0 &&
449 (cmd->cmp & PS_MODE_COMPAT) == 0)
453 /* Must specify either the -a flag or a list of pids. */
454 if (!(aflag == 1 && argc == 0) && !(aflag == 0 && argc > 0) &&
455 (cmd->cmp & PS_MODE_NO_KINFO_PROC) == 0)
459 prstat = procstat_open_kvm(nlistf, memf);
461 prstat = procstat_open_sysctl();
463 xo_errx(1, "procstat_open()");
465 xocontainer = cmd->xocontainer != NULL ? cmd->xocontainer :
467 xo_set_version(PROCSTAT_XO_VERSION);
468 xo_open_container(progname);
469 xo_open_container(xocontainer);
471 if ((cmd->cmp & PS_MODE_NO_KINFO_PROC) != 0) {
472 cmd->cmd(prstat, NULL);
477 p = procstat_getprocs(prstat, KERN_PROC_PROC, 0, &cnt);
479 xo_errx(1, "procstat_getprocs()");
480 kinfo_proc_sort(p, cnt);
481 for (i = 0; i < cnt; i++) {
482 procstat(cmd, prstat, &p[i]);
484 /* Suppress header after first process. */
485 procstat_opts |= PS_OPT_NOHEADER;
488 procstat_freeprocs(prstat, p);
490 for (i = 0; i < argc; i++) {
491 l = strtol(argv[i], &dummy, 10);
492 if (*dummy == '\0') {
497 p = procstat_getprocs(prstat, KERN_PROC_PID,
500 xo_errx(1, "procstat_getprocs()");
502 procstat(cmd, prstat, p);
503 procstat_freeprocs(prstat, p);
505 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
506 cprstat = procstat_open_core(argv[i]);
507 if (cprstat == NULL) {
508 warnx("procstat_open()");
511 p = procstat_getprocs(cprstat,
512 KERN_PROC_PID, -1, &cnt);
515 "procstat_getprocs()");
518 procstat(cmd, cprstat, p);
519 procstat_freeprocs(cprstat, p);
520 procstat_close(cprstat);
525 if ((cmd->cmp & PS_MODE_COMPAT) == 0) {
526 /* Suppress header after first process. */
527 procstat_opts |= PS_OPT_NOHEADER;
532 xo_close_container(xocontainer);
533 xo_close_container(progname);
539 procstat_close(prstat);
545 cmdopt_none(int argc, char * const argv[])
549 while ((ch = getopt(argc, argv, "")) != -1) {
559 cmdopt_verbose(int argc, char * const argv[])
563 while ((ch = getopt(argc, argv, "v")) != -1) {
566 procstat_opts |= PS_OPT_VERBOSE;
576 cmdopt_signals(int argc, char * const argv[])
580 while ((ch = getopt(argc, argv, "n")) != -1) {
583 procstat_opts |= PS_OPT_SIGNUM;
593 cmdopt_rusage(int argc, char * const argv[])
597 while ((ch = getopt(argc, argv, "Ht")) != -1) {
602 procstat_opts |= PS_OPT_PERTHREAD;
612 cmdopt_files(int argc, char * const argv[])
616 while ((ch = getopt(argc, argv, "C")) != -1) {
619 procstat_opts |= PS_OPT_CAPABILITIES;
629 cmdopt_cpuset(int argc, char * const argv[])
632 procstat_opts |= PS_OPT_PERTHREAD;
633 cmdopt_none(argc, argv);