2 * Copyright (c) 2007, 2011 Robert N. M. Watson
3 * Copyright (c) 2015 Allan Jude <allanjude@freebsd.org>
4 * Copyright (c) 2017 Dell EMC
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * 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 struct procstat_cmd cmd_table[] = {
70 { "argument", "arguments", NULL, &procstat_args, &cmdopt_none,
71 PS_CMP_PLURAL | PS_CMP_SUBSTR },
72 { "auxv", "auxv", NULL, &procstat_auxv, &cmdopt_none, PS_CMP_NORMAL },
73 { "basic", "basic", NULL, &procstat_basic, &cmdopt_none,
75 { "binary", "binary", NULL, &procstat_bin, &cmdopt_none,
77 { "cpuset", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
78 { "cs", "cs", NULL, &procstat_cs, &cmdopt_cpuset, PS_CMP_NORMAL },
79 { "credential", "credentials", NULL, &procstat_cred, &cmdopt_none,
80 PS_CMP_PLURAL | PS_CMP_SUBSTR },
81 { "environment", "environment", NULL, &procstat_env, &cmdopt_none,
83 { "fd", "files", "[-C]", &procstat_files, &cmdopt_files,
85 { "file", "files", "[-C]", &procstat_files, &cmdopt_files,
87 { "kstack", "kstack", "[-v]", &procstat_kstack, &cmdopt_verbose,
89 { "ptlwpinfo", "ptlwpinfo", NULL, &procstat_ptlwpinfo, &cmdopt_none,
91 { "rlimit", "rlimit", NULL, &procstat_rlimit, &cmdopt_none,
93 { "rusage", "rusage", "[-Ht]", &procstat_rusage, &cmdopt_rusage,
95 { "signal", "signals", "[-n]", &procstat_sigs, &cmdopt_signals,
96 PS_CMP_PLURAL | PS_CMP_SUBSTR },
97 { "thread", "threads", NULL, &procstat_threads, &cmdopt_none,
99 { "tsignal", "thread_signals", "[-n]", &procstat_threads_sigs,
100 &cmdopt_signals, PS_CMP_PLURAL | PS_CMP_SUBSTR },
101 { "vm", "vm", NULL, &procstat_vm, &cmdopt_none, PS_CMP_NORMAL }
110 xo_error("usage: procstat [--libxo] [-h] [-M core] [-N system]"
111 " [-w interval] command\n"
112 " [pid ... | core ...]\n"
113 " procstat [--libxo] -a [-h] [-M core] [-N system] "
114 " [-w interval] command\n"
115 " procstat [--libxo] [-h] [-M core] [-N system]"
117 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
118 "-j [-n] | -k [-k] |\n"
119 " -l | -r [-H] | -s | -t | -v | -x] "
120 "[pid ... | core ...]\n"
121 " procstat [--libxo] -a [-h] [-M core] [-N system]"
123 " [-S | -b | -c | -e | -f [-C] | -i [-n] | "
124 "-j [-n] | -k [-k] |\n"
125 " -l | -r [-H] | -s | -t | -v | -x]\n"
126 " procstat [--libxo] -L [-h] [-M core] [-N system] core ...\n"
127 "Available commands:\n");
128 for (i = 0, l = nitems(cmd_table); i < l; i++) {
129 multi = i + 1 < l && cmd_table[i].cmd == cmd_table[i + 1].cmd;
130 xo_error(" %s%s%s", multi ? "[" : "",
131 cmd_table[i].command, (cmd_table[i].cmp & PS_CMP_PLURAL) ?
133 for (; i + 1 < l && cmd_table[i].cmd == cmd_table[i + 1].cmd;
135 xo_error(" | %s%s", cmd_table[i + 1].command,
136 (cmd_table[i].cmp & PS_CMP_PLURAL) ? "(s)" : "");
139 if (cmd_table[i].usage != NULL)
140 xo_error(" %s", cmd_table[i].usage);
148 procstat(const struct procstat_cmd *cmd, struct procstat *prstat,
149 struct kinfo_proc *kipp)
153 asprintf(&pidstr, "%d", kipp->ki_pid);
155 xo_errc(1, ENOMEM, "Failed to allocate memory in procstat()");
156 xo_open_container(pidstr);
157 cmd->cmd(prstat, kipp);
158 xo_close_container(pidstr);
163 * Sort processes first by pid and then tid.
166 kinfo_proc_compare(const void *a, const void *b)
170 i = ((const struct kinfo_proc *)a)->ki_pid -
171 ((const struct kinfo_proc *)b)->ki_pid;
174 i = ((const struct kinfo_proc *)a)->ki_tid -
175 ((const struct kinfo_proc *)b)->ki_tid;
180 kinfo_proc_sort(struct kinfo_proc *kipp, int count)
183 qsort(kipp, count, sizeof(*kipp), kinfo_proc_compare);
187 kinfo_proc_thread_name(const struct kinfo_proc *kipp)
189 static char name[MAXCOMLEN+1];
191 strlcpy(name, kipp->ki_tdname, sizeof(name));
192 strlcat(name, kipp->ki_moretdname, sizeof(name));
193 if (name[0] == '\0' || strcmp(kipp->ki_comm, name) == 0) {
201 static const struct procstat_cmd *
202 getcmd(const char *str)
204 const struct procstat_cmd *cmd;
211 if ((l = strlen(str)) == 0)
212 return (getcmd("basic"));
213 s = l > 1 && strcasecmp(str + l - 1, "s") == 0;
214 for (i = 0; i < nitems(cmd_table); i++) {
216 * After the first match substring matches are disabled,
217 * allowing subsequent full matches to take precedence.
219 if (cmd == NULL && (cmd_table[i].cmp & PS_CMP_SUBSTR))
220 cmp = strncasecmp(str, cmd_table[i].command, l -
221 ((cmd_table[i].cmp & PS_CMP_PLURAL) && s ? 1 : 0));
222 else if ((cmd_table[i].cmp & PS_CMP_PLURAL) && s &&
223 l == strlen(cmd_table[i].command) + 1)
224 cmp = strncasecmp(str, cmd_table[i].command, l - 1);
226 cmp = strcasecmp(str, cmd_table[i].command);
234 main(int argc, char *argv[])
238 struct kinfo_proc *p;
239 const struct procstat_cmd *cmd;
240 struct procstat *prstat, *cprstat;
250 memf = nlistf = NULL;
252 argc = xo_parse_args(argc, argv);
254 while ((ch = getopt(argc, argv, "abCcefHhijkLlM:N:nrSstvw:x")) != -1) {
262 cmd = getcmd("binary");
265 procstat_opts |= PS_OPT_CAPABILITIES;
270 cmd = getcmd("arguments");
275 cmd = getcmd("environment");
280 cmd = getcmd("files");
283 procstat_opts |= PS_OPT_PERTHREAD;
286 procstat_opts |= PS_OPT_NOHEADER;
291 cmd = getcmd("signals");
296 cmd = getcmd("tsignals");
299 if (cmd != NULL && cmd->cmd == procstat_kstack) {
300 if ((procstat_opts & PS_OPT_VERBOSE) != 0)
302 procstat_opts |= PS_OPT_VERBOSE;
306 cmd = getcmd("kstack");
312 cmd = getcmd("ptlwpinfo");
317 cmd = getcmd("rlimit");
326 procstat_opts |= PS_OPT_SIGNUM;
331 cmd = getcmd("rusage");
336 cmd = getcmd("cpuset");
341 cmd = getcmd("credentials");
346 cmd = getcmd("threads");
354 l = strtol(optarg, &dummy, 10);
357 if (l < 1 || l > INT_MAX)
364 cmd = getcmd("auxv");
375 if (cmd == NULL && argv[0] != NULL && (cmd = getcmd(argv[0])) != NULL) {
376 if ((procstat_opts & PS_SUBCOMMAND_OPTS) != 0)
378 if (cmd->opt != NULL) {
381 cmd->opt(argc, argv);
390 cmd = getcmd("basic");
391 if (cmd->cmd != procstat_files &&
392 (procstat_opts & PS_OPT_CAPABILITIES) != 0)
396 /* Must specify either the -a flag or a list of pids. */
397 if (!(aflag == 1 && argc == 0) && !(aflag == 0 && argc > 0))
401 prstat = procstat_open_kvm(nlistf, memf);
403 prstat = procstat_open_sysctl();
405 xo_errx(1, "procstat_open()");
407 xo_set_version(PROCSTAT_XO_VERSION);
408 xo_open_container("procstat");
409 xo_open_container(cmd->xocontainer);
412 p = procstat_getprocs(prstat, KERN_PROC_PROC, 0, &cnt);
414 xo_errx(1, "procstat_getprocs()");
415 kinfo_proc_sort(p, cnt);
416 for (i = 0; i < cnt; i++) {
417 procstat(cmd, prstat, &p[i]);
419 /* Suppress header after first process. */
420 procstat_opts |= PS_OPT_NOHEADER;
423 procstat_freeprocs(prstat, p);
425 for (i = 0; i < argc; i++) {
426 l = strtol(argv[i], &dummy, 10);
427 if (*dummy == '\0') {
432 p = procstat_getprocs(prstat, KERN_PROC_PID,
435 xo_errx(1, "procstat_getprocs()");
437 procstat(cmd, prstat, p);
438 procstat_freeprocs(prstat, p);
440 cprstat = procstat_open_core(argv[i]);
441 if (cprstat == NULL) {
442 warnx("procstat_open()");
445 p = procstat_getprocs(cprstat, KERN_PROC_PID,
448 xo_errx(1, "procstat_getprocs()");
450 procstat(cmd, cprstat, p);
451 procstat_freeprocs(cprstat, p);
452 procstat_close(cprstat);
454 /* Suppress header after first process. */
455 procstat_opts |= PS_OPT_NOHEADER;
458 xo_close_container(cmd->xocontainer);
459 xo_close_container("procstat");
465 procstat_close(prstat);
471 cmdopt_none(int argc, char * const argv[])
475 while ((ch = getopt(argc, argv, "")) != -1) {
485 cmdopt_verbose(int argc, char * const argv[])
489 while ((ch = getopt(argc, argv, "v")) != -1) {
492 procstat_opts |= PS_OPT_VERBOSE;
502 cmdopt_signals(int argc, char * const argv[])
506 while ((ch = getopt(argc, argv, "n")) != -1) {
509 procstat_opts |= PS_OPT_SIGNUM;
519 cmdopt_rusage(int argc, char * const argv[])
523 while ((ch = getopt(argc, argv, "Ht")) != -1) {
528 procstat_opts |= PS_OPT_PERTHREAD;
538 cmdopt_files(int argc, char * const argv[])
542 while ((ch = getopt(argc, argv, "C")) != -1) {
545 procstat_opts |= PS_OPT_CAPABILITIES;
555 cmdopt_cpuset(int argc, char * const argv[])
558 procstat_opts |= PS_OPT_PERTHREAD;
559 cmdopt_none(argc, argv);