Differential D21658 Diff 62133 usr.sbin/pmcstat/pmcstat.8

Changeset View

Standalone View

usr.sbin/pmcstat/pmcstat.8

	Show All 19 Lines
	.\" or services; loss of use, data, or profits; or business interruption)			.\" or services; loss of use, data, or profits; or business interruption)
	.\" however caused and on any theory of liability, whether in contract, strict			.\" however caused and on any theory of liability, whether in contract, strict
	.\" liability, or tort (including negligence or otherwise) arising in any way			.\" 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			.\" out of the use of this software, even if advised of the possibility of
	.\" such damage.			.\" such damage.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd May 25, 2018			.Dd May 25, 2018
				lwhsuUnsubmitted Not Done Inline Actions don't forget to update the date. :-) lwhsu: don't forget to update the date. :-)
	.Dt PMCSTAT 8			.Dt PMCSTAT 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm pmcstat			.Nm pmcstat
	.Nd "performance measurement with performance monitoring hardware"			.Nd "performance measurement with performance monitoring hardware"
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
				.Op Fl A
	.Op Fl C			.Op Fl C
	.Op Fl D Ar pathname			.Op Fl D Ar pathname
	.Op Fl E			.Op Fl E
	.Op Fl F Ar pathname			.Op Fl F Ar pathname
	.Op Fl G Ar pathname			.Op Fl G Ar pathname
	.Op Fl I			.Op Fl I
	.Op Fl L			.Op Fl L
	.Op Fl M Ar mapfilename			.Op Fl M Ar mapfilename
	▲ Show 20 Lines • Show All 74 Lines • ▼ Show 20 Lines
	documented in			documented in
	.Xr pmc 3 .			.Xr pmc 3 .
	.Pp			.Pp
	A process-mode PMC may be configured to be inheritable by the target			A process-mode PMC may be configured to be inheritable by the target
	process' current and future children.			process' current and future children.
	.Sh OPTIONS			.Sh OPTIONS
	The following options are available:			The following options are available:
	.Bl -tag -width indent			.Bl -tag -width indent
				.It Fl A
				Skip symbol lookup and display address instead.
	.It Fl C			.It Fl C
	Toggle between showing cumulative or incremental counts for			Toggle between showing cumulative or incremental counts for
	subsequent counting mode PMCs specified on the command line.			subsequent counting mode PMCs specified on the command line.
	The default is to show incremental counts.			The default is to show incremental counts.
	.It Fl D Ar pathname			.It Fl D Ar pathname
	Create files with per-program samples in the directory named			Create files with per-program samples in the directory named
	by			by
	.Ar pathname .			.Ar pathname .
	Show All 22 Lines
	If argument			If argument
	.Ar pathname			.Ar pathname
	is a			is a
	.Dq Li -			.Dq Li -
	this information is sent to the output file specified by the			this information is sent to the output file specified by the
	.Fl o			.Fl o
	option.			option.
	.It Fl I			.It Fl I
	Skip symbol lookup and display address instead.			Show the offset of the instruction pointer into the symbol.
	.It Fl L			.It Fl L
	List all event names.			List all event names.
	.It Fl M Ar mapfilename			.It Fl M Ar mapfilename
	Write the mapping between executable objects encountered in the event			Write the mapping between executable objects encountered in the event
	log and the abbreviated pathnames used for			log and the abbreviated pathnames used for
	.Xr gprof 1			.Xr gprof 1
	profiles to file			profiles to file
	.Ar mapfilename .			.Ar mapfilename .
	▲ Show 20 Lines • Show All 44 Lines • ▼ Show 20 Lines
	Perform offline analysis using sampling data in file			Perform offline analysis using sampling data in file
	.Ar logfilename .			.Ar logfilename .
	.It Fl S Ar event-spec			.It Fl S Ar event-spec
	Allocate a system mode sampling PMC measuring hardware events			Allocate a system mode sampling PMC measuring hardware events
	specified in			specified in
	.Ar event-spec .			.Ar event-spec .
	.It Fl T			.It Fl T
	Use a top like mode for sampling PMCs. The following hotkeys			Use a top like mode for sampling PMCs. The following hotkeys
	can be used: 'c+a' switch to accumulative mode, 'c+d' switch			can be used: 'A' toggle symbol resolution, 'c+a' switch to accumulative mode, 'c+d'
	to delta mode, 'm' merge PMCs, 'n' change view, 'p' show next			switch to delta mode, 'I' toggle showing offsets into symbols, 'm' merge PMCs, 'n'
	PMC, ' ' pause, 'q' quit. calltree only: 'f' cost under threshold			change view, 'p' show next PMC, ' ' pause, 'q' quit. calltree only: 'f' cost under
				bcrUnsubmitted Not Done Inline Actions You need a line break after a sentence stop. bcr: You need a line break after a sentence stop.
	is seen as a dot.			threshold is seen as a dot.
				markjUnsubmitted Not Done Inline Actions "toggle symbol resolution" markj: "toggle symbol resolution"
	.It Fl U			.It Fl U
	Toggle capturing user-space call traces while in kernel mode.			Toggle capturing user-space call traces while in kernel mode.
	The default is for sampling PMCs to capture user-space callchain information			The default is for sampling PMCs to capture user-space callchain information
	while in user-space mode, and kernel callchain information while in kernel mode.			while in user-space mode, and kernel callchain information while in kernel mode.
	.It Fl W			.It Fl W
	Toggle logging the incremental counts seen by the threads of a			Toggle logging the incremental counts seen by the threads of a
	tracked process each time they are scheduled on a CPU.			tracked process each time they are scheduled on a CPU.
	This is an experimental feature intended to help analyse the			This is an experimental feature intended to help analyse the
	▲ Show 20 Lines • Show All 286 Lines • Show Last 20 Lines