Commit 22881e2b authored by Ian Rogers's avatar Ian Rogers Committed by Arnaldo Carvalho de Melo
Browse files

perf parse-events: Add more comments to 'struct parse_events_state' 



Improve documentation of 'struct parse_events_state'.

Signed-off-by: default avatarIan Rogers <irogers@google.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Athira Rajeev <atrajeev@linux.vnet.ibm.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Kan Liang <kan.liang@linux.intel.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: bpf@vger.kernel.org
Link: https://lore.kernel.org/r/20230627181030.95608-5-irogers@google.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 7e34daa5

tools/perf/util/parse-events.h

+8 −0
Original line number Diff line number Diff line
@@ -121,17 +121,25 @@ struct parse_events_error { 
};



struct parse_events_state {

	/* The list parsed events are placed on. */

	struct list_head	   list;

	/* The updated index used by entries as they are added. */

	int			   idx;

	/* Error information. */

	struct parse_events_error *error;

	/* Used by BPF event creation. */

	struct evlist		  *evlist;

	/* Holds returned terms for term parsing. */

	struct list_head	  *terms;

	/* Start token. */

	int			   stoken;

	/* Special fake PMU marker for testing. */

	struct perf_pmu		  *fake_pmu;

	/* If non-null, when wildcard matching only match the given PMU. */

	const char		  *pmu_filter;

	/* Should PE_LEGACY_NAME tokens be generated for config terms? */

	bool			   match_legacy_cache_terms;

	/* Were multiple PMUs scanned to find events? */

	bool			   wild_card_pmus;

};