d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
freebsd-skq/usr.bin/procstat/procstat.h

82 lines
3.4 KiB
C
Raw Permalink Normal View History

Add procstat(1), a process inspection utility. This provides both some of the missing functionality from procfs(4) and new functionality for monitoring and debugging specific processes. procstat(1) operates in the following modes: -b Display binary information for the process. -c Display command line arguments for the process. -f Display file descriptor information for the process. -k Display the stacks of kernel threads in the process. -s Display security credential information for the process. -t Display thread information for the process. -v Display virtual memory mappings for the process. Further revision and modes are expected. Testing, ideas, etc: cognet, sam, Skip Ford <skip at menantico dot com> Wesley Shields <wxs at atarininja dot org>
2007-12-02 23:31:45 +00:00
/*-
various: general adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. No functional change intended.
2017-11-27 15:37:16 +00:00
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
Add procstat(1), a process inspection utility. This provides both some of the missing functionality from procfs(4) and new functionality for monitoring and debugging specific processes. procstat(1) operates in the following modes: -b Display binary information for the process. -c Display command line arguments for the process. -f Display file descriptor information for the process. -k Display the stacks of kernel threads in the process. -s Display security credential information for the process. -t Display thread information for the process. -v Display virtual memory mappings for the process. Further revision and modes are expected. Testing, ideas, etc: cognet, sam, Skip Ford <skip at menantico dot com> Wesley Shields <wxs at atarininja dot org>
2007-12-02 23:31:45 +00:00
* Copyright (c) 2007 Robert N. M. Watson
Introduce libxo to procstat(1) Reviewed by: rodrigc, bapt Approved by: marcel (mentor) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2446
2015-09-05 17:02:01 +00:00
* Copyright (c) 2015 Allan Jude <allanjude@freebsd.org>
Add support for capturing 'struct ptrace_lwpinfo' for signals resulting in a process dumping core in the corefile. Also extend procstat to view select members of 'struct ptrace_lwpinfo' from the contents of the note. Sponsored by: Dell EMC Isilon
2017-03-30 18:21:36 +00:00
* Copyright (c) 2017 Dell EMC
Add procstat(1), a process inspection utility. This provides both some of the missing functionality from procfs(4) and new functionality for monitoring and debugging specific processes. procstat(1) operates in the following modes: -b Display binary information for the process. -c Display command line arguments for the process. -f Display file descriptor information for the process. -k Display the stacks of kernel threads in the process. -s Display security credential information for the process. -t Display thread information for the process. -v Display virtual memory mappings for the process. Further revision and modes are expected. Testing, ideas, etc: cognet, sam, Skip Ford <skip at menantico dot com> Wesley Shields <wxs at atarininja dot org>
2007-12-02 23:31:45 +00:00
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
Introduce libxo to procstat(1) Reviewed by: rodrigc, bapt Approved by: marcel (mentor) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2446
2015-09-05 17:02:01 +00:00
#include <libxo/xo.h>
Add procstat(1), a process inspection utility. This provides both some of the missing functionality from procfs(4) and new functionality for monitoring and debugging specific processes. procstat(1) operates in the following modes: -b Display binary information for the process. -c Display command line arguments for the process. -f Display file descriptor information for the process. -k Display the stacks of kernel threads in the process. -s Display security credential information for the process. -t Display thread information for the process. -v Display virtual memory mappings for the process. Further revision and modes are expected. Testing, ideas, etc: cognet, sam, Skip Ford <skip at menantico dot com> Wesley Shields <wxs at atarininja dot org>
2007-12-02 23:31:45 +00:00
#ifndef PROCSTAT_H
#define PROCSTAT_H
Introduce libxo to procstat(1) Reviewed by: rodrigc, bapt Approved by: marcel (mentor) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2446
2015-09-05 17:02:01 +00:00
#define PROCSTAT_XO_VERSION "1"
Switch procstat from subcommand flags to verbs - Use an enumerated value instead of separate flags for commands - Look for a verb if no command flag is set - Lookup the "xocontainer" value based on the command - Document the new command verbs in the man-page Submitted by: kdrakehp@zoho.com Differential Revision: https://reviews.freebsd.org/D10916
2017-10-14 18:38:36 +00:00
enum {
PS_OPT_CAPABILITIES = 0x01,
PS_OPT_NOHEADER = 0x02,
PS_OPT_PERTHREAD = 0x04,
PS_OPT_SIGNUM = 0x08,
Add pargs, penv, pwdx commands and aliases to procstat(1). Intent is to mimic Solaris commands with the same names. Submitted by: Juraj Lutter <juraj@lutter.sk> MFC after: 1 week Differential revision: https://reviews.freebsd.org/D26310
2020-09-18 12:59:27 +00:00
PS_OPT_VERBOSE = 0x10,
PS_MODE_COMPAT = 0x20,
Switch procstat from subcommand flags to verbs - Use an enumerated value instead of separate flags for commands - Look for a verb if no command flag is set - Lookup the "xocontainer" value based on the command - Document the new command verbs in the man-page Submitted by: kdrakehp@zoho.com Differential Revision: https://reviews.freebsd.org/D10916
2017-10-14 18:38:36 +00:00
};
#define PS_SUBCOMMAND_OPTS \
(PS_OPT_CAPABILITIES | PS_OPT_SIGNUM | \
PS_OPT_PERTHREAD | PS_OPT_VERBOSE)
extern int procstat_opts;
Add procstat(1), a process inspection utility. This provides both some of the missing functionality from procfs(4) and new functionality for monitoring and debugging specific processes. procstat(1) operates in the following modes: -b Display binary information for the process. -c Display command line arguments for the process. -f Display file descriptor information for the process. -k Display the stacks of kernel threads in the process. -s Display security credential information for the process. -t Display thread information for the process. -v Display virtual memory mappings for the process. Further revision and modes are expected. Testing, ideas, etc: cognet, sam, Skip Ford <skip at menantico dot com> Wesley Shields <wxs at atarininja dot org>
2007-12-02 23:31:45 +00:00
struct kinfo_proc;
void kinfo_proc_sort(struct kinfo_proc *kipp, int count);
Export the whole thread name in kinfo_proc kinfo_proc::ki_tdname is three characters shorter than thread::td_name. Add a ki_moretdname field for these three extra characters. Add the new field to kinfo_proc32, as well. Update all in-tree consumers to read the new field and assemble the full name, except for lldb's HostThreadFreeBSD.cpp, which I will handle separately. Bump __FreeBSD_version. Reviewed by: kib MFC after: 1 week Relnotes: yes Sponsored by: Dell EMC Differential Revision: https://reviews.freebsd.org/D8722
2016-12-07 15:04:22 +00:00
const char * kinfo_proc_thread_name(const struct kinfo_proc *kipp);
Add procstat(1), a process inspection utility. This provides both some of the missing functionality from procfs(4) and new functionality for monitoring and debugging specific processes. procstat(1) operates in the following modes: -b Display binary information for the process. -c Display command line arguments for the process. -f Display file descriptor information for the process. -k Display the stacks of kernel threads in the process. -s Display security credential information for the process. -t Display thread information for the process. -v Display virtual memory mappings for the process. Further revision and modes are expected. Testing, ideas, etc: cognet, sam, Skip Ford <skip at menantico dot com> Wesley Shields <wxs at atarininja dot org>
2007-12-02 23:31:45 +00:00
Use libprocstat(3) to retrieve process command line arguments and environment variables. MFC after: 1 month
2013-04-20 08:08:29 +00:00
void procstat_args(struct procstat *prstat, struct kinfo_proc *kipp);
Use libprocstat(3) to retrieve ELF auxiliary vector. MFC after: 1 month
2013-04-20 08:15:43 +00:00
void procstat_auxv(struct procstat *prstat, struct kinfo_proc *kipp);
Switch procstat from subcommand flags to verbs - Use an enumerated value instead of separate flags for commands - Look for a verb if no command flag is set - Lookup the "xocontainer" value based on the command - Document the new command verbs in the man-page Submitted by: kdrakehp@zoho.com Differential Revision: https://reviews.freebsd.org/D10916
2017-10-14 18:38:36 +00:00
void procstat_basic(struct procstat *prstat, struct kinfo_proc *kipp);
Use libprocstat(3) when retrieving binary information for a process. MFC after: 1 month
2013-04-20 08:05:04 +00:00
void procstat_bin(struct procstat *prstat, struct kinfo_proc *kipp);
Use procstat_getgroups(3) for retrieving groups information instead of direct sysctl. MFC after: 1 month
2013-04-20 07:55:31 +00:00
void procstat_cred(struct procstat *prstat, struct kinfo_proc *kipp);
Implement basic cpuset reporting in procstat via the -S flag. Obtained from: Netflix, Inc. MFC after: 3 days
2015-03-10 09:41:48 +00:00
void procstat_cs(struct procstat *prstat, struct kinfo_proc *kipp);
Use libprocstat(3) to retrieve process command line arguments and environment variables. MFC after: 1 month
2013-04-20 08:08:29 +00:00
void procstat_env(struct procstat *prstat, struct kinfo_proc *kipp);
- Commit work from libprocstat project. These patches add support for runtime file and processes information retrieval from the running kernel via sysctl in the form of new library, libprocstat. The library also supports KVM backend for analyzing memory crash dumps. Both procstat(1) and fstat(1) utilities have been modified to take advantage of the library (as the bonus point the fstat(1) utility no longer need superuser privileges to operate), and the procstat(1) utility is now able to display information from memory dumps as well. The newly introduced fuser(1) utility also uses this library and able to operate via sysctl and kvm backends. The library is by no means complete (e.g. KVM backend is missing vnode name resolution routines, and there're no manpages for the library itself) so I plan to improve it further. I'm commiting it so it will get wider exposure and review. We won't be able to MFC this work as it relies on changes in HEAD, which was introduced some time ago, that break kernel ABI. OTOH we may be able to merge the library with KVM backend if we really need it there. Discussed with: rwatson
2011-05-12 10:11:39 +00:00
void procstat_files(struct procstat *prstat, struct kinfo_proc *kipp);
Switch procstat from subcommand flags to verbs - Use an enumerated value instead of separate flags for commands - Look for a verb if no command flag is set - Lookup the "xocontainer" value based on the command - Document the new command verbs in the man-page Submitted by: kdrakehp@zoho.com Differential Revision: https://reviews.freebsd.org/D10916
2017-10-14 18:38:36 +00:00
void procstat_kstack(struct procstat *prstat, struct kinfo_proc *kipp);
Add pargs, penv, pwdx commands and aliases to procstat(1). Intent is to mimic Solaris commands with the same names. Submitted by: Juraj Lutter <juraj@lutter.sk> MFC after: 1 week Differential revision: https://reviews.freebsd.org/D26310
2020-09-18 12:59:27 +00:00
void procstat_pargs(struct procstat *prstat, struct kinfo_proc *kipp);
void procstat_penv(struct procstat *prstat, struct kinfo_proc *kipp);
Switch procstat from subcommand flags to verbs - Use an enumerated value instead of separate flags for commands - Look for a verb if no command flag is set - Lookup the "xocontainer" value based on the command - Document the new command verbs in the man-page Submitted by: kdrakehp@zoho.com Differential Revision: https://reviews.freebsd.org/D10916
2017-10-14 18:38:36 +00:00
void procstat_ptlwpinfo(struct procstat *prstat, struct kinfo_proc *kipp);
Add pargs, penv, pwdx commands and aliases to procstat(1). Intent is to mimic Solaris commands with the same names. Submitted by: Juraj Lutter <juraj@lutter.sk> MFC after: 1 week Differential revision: https://reviews.freebsd.org/D26310
2020-09-18 12:59:27 +00:00
void procstat_pwdx(struct procstat *prstat, struct kinfo_proc *kipp);
Use procstat_getrlimit(3) for retrieving rlimit information instead of direct sysctl calls. MFC after: 1 month
2013-04-20 08:01:00 +00:00
void procstat_rlimit(struct procstat *prstat, struct kinfo_proc *kipp);
- Add support for dumping current resource usage for processes via a new -r flag to procstat. - Add an -H flag to request information about threads rather than processes when dumping statistics. Currently it is only used for -r to display resource usage for individual threads instead of the entire process. Reviewed by: kib (older version without -H) MFC after: 1 month
2014-05-17 03:54:51 +00:00
void procstat_rusage(struct procstat *prstat, struct kinfo_proc *kipp);
Add procstat(1) sigfastblock command to show process sigfastblock word address. Tested by: pho Disscussed with: cem, emaste, jilles Sponsored by: The FreeBSD Foundation Differential revision: https://reviews.freebsd.org/D12773
2020-02-09 12:30:50 +00:00
void procstat_sigfastblock(struct procstat *procstat,
struct kinfo_proc *kipp);
- Commit work from libprocstat project. These patches add support for runtime file and processes information retrieval from the running kernel via sysctl in the form of new library, libprocstat. The library also supports KVM backend for analyzing memory crash dumps. Both procstat(1) and fstat(1) utilities have been modified to take advantage of the library (as the bonus point the fstat(1) utility no longer need superuser privileges to operate), and the procstat(1) utility is now able to display information from memory dumps as well. The newly introduced fuser(1) utility also uses this library and able to operate via sysctl and kvm backends. The library is by no means complete (e.g. KVM backend is missing vnode name resolution routines, and there're no manpages for the library itself) so I plan to improve it further. I'm commiting it so it will get wider exposure and review. We won't be able to MFC this work as it relies on changes in HEAD, which was introduced some time ago, that break kernel ABI. OTOH we may be able to merge the library with KVM backend if we really need it there. Discussed with: rwatson
2011-05-12 10:11:39 +00:00
void procstat_sigs(struct procstat *prstat, struct kinfo_proc *kipp);
Use procstat_getprocs(3) for retrieving thread information instead of direct sysctl calls. MFC after: 1 month
2013-04-20 07:50:59 +00:00
void procstat_threads(struct procstat *prstat, struct kinfo_proc *kipp);
- Commit work from libprocstat project. These patches add support for runtime file and processes information retrieval from the running kernel via sysctl in the form of new library, libprocstat. The library also supports KVM backend for analyzing memory crash dumps. Both procstat(1) and fstat(1) utilities have been modified to take advantage of the library (as the bonus point the fstat(1) utility no longer need superuser privileges to operate), and the procstat(1) utility is now able to display information from memory dumps as well. The newly introduced fuser(1) utility also uses this library and able to operate via sysctl and kvm backends. The library is by no means complete (e.g. KVM backend is missing vnode name resolution routines, and there're no manpages for the library itself) so I plan to improve it further. I'm commiting it so it will get wider exposure and review. We won't be able to MFC this work as it relies on changes in HEAD, which was introduced some time ago, that break kernel ABI. OTOH we may be able to merge the library with KVM backend if we really need it there. Discussed with: rwatson
2011-05-12 10:11:39 +00:00
void procstat_threads_sigs(struct procstat *prstat, struct kinfo_proc *kipp);
Use more generic procstat_getvmmap(3) for retrieving VM layout of a process. MFC after: 1 month
2013-04-20 07:52:23 +00:00
void procstat_vm(struct procstat *prstat, struct kinfo_proc *kipp);
Add procstat(1), a process inspection utility. This provides both some of the missing functionality from procfs(4) and new functionality for monitoring and debugging specific processes. procstat(1) operates in the following modes: -b Display binary information for the process. -c Display command line arguments for the process. -f Display file descriptor information for the process. -k Display the stacks of kernel threads in the process. -s Display security credential information for the process. -t Display thread information for the process. -v Display virtual memory mappings for the process. Further revision and modes are expected. Testing, ideas, etc: cognet, sam, Skip Ford <skip at menantico dot com> Wesley Shields <wxs at atarininja dot org>
2007-12-02 23:31:45 +00:00
#endif /* !PROCSTAT_H */
Reference in New Issue Copy Permalink