Commit 485fcaed authored Oct 15, 2021 by Ian Rogers Committed by Arnaldo Carvalho de Melo Oct 20, 2021

perf metric: Document the internal 'struct metric'



Add documentation as part of code tidying.

Signed-off-by: Ian Rogers <irogers@google.com>
Acked-by: Andi Kleen <ak@linux.intel.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Antonov <alexander.antonov@linux.intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Andrew Kilroy <andrew.kilroy@arm.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Changbin Du <changbin.du@intel.com>
Cc: Denys Zagorui <dzagorui@cisco.com>
Cc: Fabian Hemmer <copy@copy.sh>
Cc: Felix Fietkau <nbd@nbd.name>
Cc: Heiko Carstens <hca@linux.ibm.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jacob Keller <jacob.e.keller@intel.com>
Cc: Jiapeng Chong <jiapeng.chong@linux.alibaba.com>
Cc: Jin Yao <yao.jin@linux.intel.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Joakim Zhang <qiangqing.zhang@nxp.com>
Cc: John Garry <john.garry@huawei.com>
Cc: Kajol Jain <kjain@linux.ibm.com>
Cc: Kan Liang <kan.liang@linux.intel.com>
Cc: Kees Kook <keescook@chromium.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Nicholas Fraser <nfraser@codeweavers.com>
Cc: Nick Desaulniers <ndesaulniers@google.com>
Cc: Paul Clarke <pc@us.ibm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Riccardo Mancini <rickyman7@gmail.com>
Cc: Sami Tolvanen <samitolvanen@google.com>
Cc: ShihCheng Tu <mrtoastcheng@gmail.com>
Cc: Song Liu <songliubraving@fb.com>
Cc: Stephane Eranian <eranian@google.com>
Cc: Sumanth Korikkar <sumanthk@linux.ibm.com>
Cc: Thomas Richter <tmricht@linux.ibm.com>
Cc: Wan Jiabing <wanjiabing@vivo.com>
Cc: Zhen Lei <thunder.leizhen@huawei.com>
Link: https://lore.kernel.org/r/20211015172132.1162559-12-irogers@google.com


Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

parent 4d61aef9

tools/perf/util/metricgroup.c

+20 −0

Original line number	Diff line number	Diff line
		@@ -117,14 +117,34 @@ struct metric_ref_node {
		struct list_head list;
		};

		/**
		* The metric under construction. The data held here will be placed in a
		* metric_expr.
		*/
		struct metric {
		struct list_head nd;
		/**
		* The expression parse context importantly holding the IDs contained
		* within the expression.
		*/
		struct expr_parse_ctx *pctx;
		/** The name of the metric such as "IPC". */
		const char *metric_name;
		/** The expression to parse, for example, "instructions/cycles". */
		const char *metric_expr;
		/**
		* The "ScaleUnit" that scales and adds a unit to the metric during
		* output.
		*/
		const char *metric_unit;
		/** The list of metrics referenced by this one. */
		struct list_head metric_refs;
		/** The size of the metric_refs list. */
		int metric_refs_cnt;
		/**
		* Is there a constraint on the group of events? In which case the
		* events won't be grouped.
		*/
		bool has_constraint;
		};