linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Adrian Hunter <adrian.hunter@intel.com>
To: Arnaldo Carvalho de Melo <acme@kernel.org>,
	Andi Kleen <ak@linux.intel.com>
Cc: linux-kernel@vger.kernel.org
Subject: [PATCH 03/37] perf intel-pt: Add documentation for new config terms
Date: Fri, 19 May 2017 11:54:02 +0300	[thread overview]
Message-ID: <1495184076-23805-4-git-send-email-adrian.hunter@intel.com> (raw)
In-Reply-To: <1495184076-23805-1-git-send-email-adrian.hunter@intel.com>

Add documentation for new config terms.

Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>
---
 tools/perf/Documentation/intel-pt.txt | 36 +++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/tools/perf/Documentation/intel-pt.txt b/tools/perf/Documentation/intel-pt.txt
index b0b3007d3c9c..d157dee7a4ec 100644
--- a/tools/perf/Documentation/intel-pt.txt
+++ b/tools/perf/Documentation/intel-pt.txt
@@ -364,6 +364,42 @@ cyc_thresh	Specifies how frequently CYC packets are produced - see cyc
 
 		CYC packets are not requested by default.
 
+pt		Specifies pass-through which enables the 'branch' config term.
+
+		The default config selects 'pt' if it is available, so a user will
+		never need to specify this term.
+
+branch		Enable branch tracing.  Branch tracing is enabled by default so to
+		disable branch tracing use 'branch=0'.
+
+		The default config selects 'branch' if it is available.
+
+ptw		Enable PTWRITE packets which are produced when a ptwrite instruction
+		is executed.
+
+		Support for this feature is indicated by:
+
+			/sys/bus/event_source/devices/intel_pt/caps/ptwrite
+
+		which contains "1" if the feature is supported and
+		"0" otherwise.
+
+fup_on_ptw	Enable a FUP packet to follow the PTWRITE packet.  The FUP packet
+		provides the address of the ptwrite instruction.  In the absence of
+		fup_on_ptw, the decoder will use the address of the previous branch
+		if branch tracing is enabled, otherwise the address will be zero.
+		Note that fup_on_ptw will work even when branch tracing is disabled.
+
+pwr_evt		Enable power events.  The power events provide information about
+		changes to the CPU C-state.
+
+		Support for this feature is indicated by:
+
+			/sys/bus/event_source/devices/intel_pt/caps/power_event_trace
+
+		which contains "1" if the feature is supported and
+		"0" otherwise.
+
 
 new snapshot option
 -------------------
-- 
1.9.1

  parent reply	other threads:[~2017-05-19  9:00 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-19  8:53 [PATCH 00/37] perf intel-pt: Power events and PTWRITE Adrian Hunter
2017-05-19  8:54 ` [PATCH 01/37] perf intel-pt: Allow decoding with branch tracing disabled Adrian Hunter
2017-05-19  8:54 ` [PATCH 02/37] perf intel-pt: Add default config for pass-through branch enable Adrian Hunter
2017-05-19  8:54 ` Adrian Hunter [this message]
2017-05-19  8:54 ` [PATCH 04/37] perf intel-pt: Fix missing stack clear Adrian Hunter
2017-05-19  8:54 ` [PATCH 05/37] perf intel-pt: Ensure IP is zero when state is INTEL_PT_STATE_NO_IP Adrian Hunter
2017-05-19  8:54 ` [PATCH 06/37] perf intel-pt: Fix last_ip usage Adrian Hunter
2017-05-19  8:54 ` [PATCH 07/37] perf intel-pt: Ensure never to set 'last_ip' when packet 'count' is zero Adrian Hunter
2017-05-19  8:54 ` [PATCH 08/37] perf intel-pt: Use FUP always when scanning for an IP Adrian Hunter
2017-05-19  8:54 ` [PATCH 09/37] perf intel-pt: Add missing __fallthrough Adrian Hunter
2017-05-19  8:54 ` [PATCH 10/37] perf intel-pt: Clear FUP flag on error Adrian Hunter
2017-05-19  8:54 ` [PATCH 11/37] perf intel-pt: Add decoder support for ptwrite and power event packets Adrian Hunter
2017-05-19  8:54 ` [PATCH 12/37] perf intel-pt: Add reserved byte to CBR packet payload Adrian Hunter
2017-05-19  8:54 ` [PATCH 13/37] perf intel-pt: Move decoder error setting into one condition Adrian Hunter
2017-05-19  8:54 ` [PATCH 14/37] perf intel-pt: Add decoder support for CBR events Adrian Hunter
2017-05-19  8:54 ` [PATCH 15/37] perf intel-pt: Remove redundant initial_skip checks Adrian Hunter
2017-05-19  8:54 ` [PATCH 16/37] perf intel-pt: Fix transactions_sample_type Adrian Hunter
2017-05-19  8:54 ` [PATCH 17/37] perf tools: Fix message because cpu list option is -C not -c Adrian Hunter
2017-05-19  8:54 ` [PATCH 18/37] perf script: Fix message because field list option is -F not -f Adrian Hunter
2017-05-19  8:54 ` [PATCH 19/37] perf script: Add 'synth' event type for synthesized events Adrian Hunter
2017-05-19  8:54 ` [PATCH 20/37] perf script: Add 'synth' field for synthesized event payloads Adrian Hunter
2017-05-19  8:54 ` [PATCH 21/37] tools include: Add byte-swapping macros to kernel.h Adrian Hunter
2017-05-19  8:54 ` [PATCH 22/37] perf auxtrace: Add itrace option to output ptwrite events Adrian Hunter
2017-05-19  8:54 ` [PATCH 23/37] perf auxtrace: Add itrace option to output power events Adrian Hunter
2017-05-19  8:54 ` [PATCH 24/37] perf script: Add synthesized Intel PT power and ptwrite events Adrian Hunter
2017-05-19  8:54 ` [PATCH 25/37] perf intel-pt: Factor out common code synthesizing event samples Adrian Hunter
2017-05-19  8:54 ` [PATCH 26/37] perf intel-pt: Remove unused instructions_sample_period Adrian Hunter
2017-05-19  8:54 ` [PATCH 27/37] perf intel-pt: Join needlessly wrapped lines Adrian Hunter
2017-05-19  8:54 ` [PATCH 28/37] perf intel-pt: Tidy Intel PT evsel lookup into separate function Adrian Hunter
2017-05-19  8:54 ` [PATCH 29/37] perf intel-pt: Tidy messages into called function intel_pt_synth_event() Adrian Hunter
2017-05-19  8:54 ` [PATCH 30/37] perf intel-pt: Factor out intel_pt_set_event_name() Adrian Hunter
2017-05-19  8:54 ` [PATCH 31/37] perf intel-pt: Move code in intel_pt_synth_events() to simplify attr setting Adrian Hunter
2017-05-19  8:54 ` [PATCH 32/37] perf intel-pt: Synthesize new power and ptwrite events Adrian Hunter
2017-05-19  8:54 ` [PATCH 33/37] perf intel-pt: Add example script for power events and PTWRITE Adrian Hunter
2017-05-19  8:54 ` [PATCH 34/37] perf intel-pt: Update documentation to include new ptwrite and power events Adrian Hunter
2017-05-19  8:54 ` [PATCH 35/37] perf intel-pt: Do not use TSC packets for calculating CPU cycles to TSC Adrian Hunter
2017-05-19  8:54 ` [PATCH 36/37] perf auxtrace: Add CPU filter support Adrian Hunter
2017-05-19  8:54 ` [PATCH 37/37] perf intel-pt: Improve sample timestamp Adrian Hunter
2017-05-19 14:34   ` Andi Kleen
2017-05-26  8:26     ` Adrian Hunter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1495184076-23805-4-git-send-email-adrian.hunter@intel.com \
    --to=adrian.hunter@intel.com \
    --cc=acme@kernel.org \
    --cc=ak@linux.intel.com \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).