From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756063AbcJLVpC (ORCPT ); Wed, 12 Oct 2016 17:45:02 -0400 Received: from mga05.intel.com ([192.55.52.43]:17787 "EHLO mga05.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751959AbcJLVoy (ORCPT ); Wed, 12 Oct 2016 17:44:54 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,485,1473145200"; d="scan'208";a="889400693" From: Andi Kleen To: acme@kernel.org Cc: jolsa@kernel.org, linux-kernel@vger.kernel.org, Andi Kleen Subject: [PATCH 2/2] perf, tools: Add documentation for perf user event parameters Date: Wed, 12 Oct 2016 14:02:07 -0700 Message-Id: <1476306127-19721-2-git-send-email-andi@firstfloor.org> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1476306127-19721-1-git-send-email-andi@firstfloor.org> References: <1476306127-19721-1-git-send-email-andi@firstfloor.org> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Andi Kleen There was no proper documention for the user parameters for events that the perf parser implements. Document them all in the perf list manpage. Signed-off-by: Andi Kleen --- tools/perf/Documentation/perf-list.txt | 42 ++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt index 41857cce5e86..511adc684148 100644 --- a/tools/perf/Documentation/perf-list.txt +++ b/tools/perf/Documentation/perf-list.txt @@ -119,6 +119,48 @@ be specified as perf stat -e cpu/event=0xa8,umask=0x1,name=LSD.UOPS_CYCLES,cmask=1/ ... +EVENT PARAMETERS +---------------- + +The pmu// syntax in perf uses parameters to configure the event for the +PMU. + +For a list of available parameters for each PMU please use + + ls /sys/devices/*/format + +Common parameters are + +. event=NUM: Event code +. umask=NUM: Event umask + +In addition perf supports some extra parameters to further configure then +event + +. name=name: Use name to display the event in perf +. period=NUM: Use sampling period NUM for the event. Similar to the -c parameter, +but only applies to this event. Only valid for perf record and top. +. freq=NUM: Use sampling frequency NUM for the event. Similar to the -c parameter, +but only applies to this event. Only valid for perf record and top. +. branch_type=TYPE: Enable last branch sampling for event. TYPE is the same +as the argument to perf record's -j option. Use any to be equivalent to -b. +when no is specified branch sampling is disabled for this event. Only valid +for perf record and top. +. time=NUM: When NUM is non zero collect a time stamp for the event. +. call-graph=type: Enable call graph mode for the event. When no is specified call +graph is disabled. The parameters are the as to the --call-graph option of +perf record. Only valid for perf record and top. +. stack-size=BYTES: For dwarf unwinding call graph mode limit the number of stack +bytes collected to BYTES. +. max-stack=NUM: For call graph mode limit the number of entries to NUM. +. inherit: Inherit the event to child processes. +. no-inherit: Do not inherit the event to child processes. +. overwrite: Enable overwrite mode in the perf buffer. +. no-overwrite: Do not enable overwrite mode in the perf buffer. +. config=NUM: Configure config parameter in perf event attribute. +. config1=NUM: Configure config1 parameter in perf event attribute. +. config2=NUM: Configure config2 parameter in perf event attribute. + PER SOCKET PMUS --------------- -- 2.5.5