/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_PARSE_EVENTS_H
#define __PERF_PARSE_EVENTS_H
/*
* Parse symbolic events/counts passed in as options:
*/
#include <linux/list.h>
#include <stdbool.h>
#include <linux/types.h>
#include <linux/perf_event.h>
#include <stdio.h>
#include <string.h>
struct evsel;
struct evlist;
struct parse_events_error;
struct option;
struct perf_pmu;
struct strbuf;
const char *event_type(int type);
/* Arguments encoded in opt->value. */
struct parse_events_option_args {
struct evlist **evlistp;
const char *pmu_filter;
};
int parse_events_option(const struct option *opt, const char *str, int unset);
int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset);
__attribute__((nonnull(1, 2, 4)))
int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter,
struct parse_events_error *error, bool fake_pmu,
bool warn_if_reordered, bool fake_tp);
__attribute__((nonnull(1, 2, 3)))
static inline int parse_events(struct evlist *evlist, const char *str,
struct parse_events_error *err)
{
return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/false,
/*warn_if_reordered=*/true, /*fake_tp=*/false);
}
int parse_event(struct evlist *evlist, const char *str);
int parse_filter(const struct option *opt, const char *str, int unset);
int exclude_perf(const struct option *opt, const char *arg, int unset);
enum parse_events__term_val_type {
PARSE_EVENTS__TERM_TYPE_NUM,
PARSE_EVENTS__TERM_TYPE_STR,
};
enum parse_events__term_type {
PARSE_EVENTS__TERM_TYPE_USER,
PARSE_EVENTS__TERM_TYPE_CONFIG,
PARSE_EVENTS__TERM_TYPE_CONFIG1,
PARSE_EVENTS__TERM_TYPE_CONFIG2,
PARSE_EVENTS__TERM_TYPE_CONFIG3,
PARSE_EVENTS__TERM_TYPE_NAME,
PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
PARSE_EVENTS__TERM_TYPE_TIME,
PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
PARSE_EVENTS__TERM_TYPE_STACKSIZE,
PARSE_EVENTS__TERM_TYPE_NOINHERIT,
PARSE_EVENTS__TERM_TYPE_INHERIT,
PARSE_EVENTS__TERM_TYPE_MAX_STACK,
PARSE_EVENTS__TERM_TYPE_MAX_EVENTS,
PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
PARSE_EVENTS__TERM_TYPE_OVERWRITE,
PARSE_EVENTS__TERM_TYPE_DRV_CFG,
PARSE_EVENTS__TERM_TYPE_PERCORE,
PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT,
PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE,
PARSE_EVENTS__TERM_TYPE_METRIC_ID,
PARSE_EVENTS__TERM_TYPE_RAW,
PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE,
PARSE_EVENTS__TERM_TYPE_HARDWARE,
#define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_HARDWARE + 1)
};
struct parse_events_term {
/** @list: The term list the term is a part of. */
struct list_head list;
/**
* @config: The left-hand side of a term assignment, so the term
* "event=8" would have the config be "event"
*/
const char *config;
/**
* @val: The right-hand side of a term assignment that can either be a
* string or a number depending on type_val.
*/
union {
char *str;
u64 num;
} val;
/** @type_val: The union variable in val to be used for the term. */
enum parse_events__term_val_type type_val;
/**
* @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER
* when not inbuilt.
*/
enum parse_events__term_type type_term;
/**
* @err_term: The column index of the term from parsing, used during
* error output.
*/
int err_term;
/**
* @err_val: The column index of the val from parsing, used during error
* output.
*/
int err_val;
/** @used: Was the term used during parameterized-eval. */
bool used;
/**
* @weak: A term from the sysfs or json encoding of an event that
* shouldn't override terms coming from the command line.
*/
bool weak;
/**
* @no_value: Is there no value. If a numeric term has no value then the
* value is assumed to be 1. An event name also has no value.
*/
bool no_value;
};
struct parse_events_error {
/** @list: The head of a list of errors. */
struct list_head list;
};
/* A wrapper around a list of terms for the sake of better type safety. */
struct parse_events_terms {
struct list_head terms;
};
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;
/* Holds returned terms for term parsing. */
struct parse_events_terms *terms;
/* Start token. */
int stoken;
/* Use the fake PMU marker for testing. */
bool fake_pmu;
/* Skip actual tracepoint processing for testing. */
bool fake_tp;
/* 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;
};
bool parse_events__filter_pmu(const struct parse_events_state *parse_state,
const struct perf_pmu *pmu);
void parse_events__shrink_config_terms(void);
int parse_events__is_hardcoded_term(struct parse_events_term *term);
int parse_events_term__num(struct parse_events_term **term,
enum parse_events__term_type type_term,
const char *config, u64 num,
bool novalue,
void *loc_term, void *loc_val);
int parse_events_term__str(struct parse_events_term **term,
enum parse_events__term_type type_term,
char *config, char *str,
void *loc_term, void *loc_val);
int parse_events_term__term(struct parse_events_term **term,
enum parse_events__term_type term_lhs,
enum parse_events__term_type term_rhs,
void *loc_term, void *loc_val);
int parse_events_term__clone(struct parse_events_term **new,
const struct parse_events_term *term);
void parse_events_term__delete(struct parse_events_term *term);
void parse_events_terms__delete(struct parse_events_terms *terms);
void parse_events_terms__init(struct parse_events_terms *terms);
void parse_events_terms__exit(struct parse_events_terms *terms);
int parse_events_terms(struct parse_events_terms *terms, const char *str, FILE *input);
int parse_events_terms__to_strbuf(const struct parse_events_terms *terms, struct strbuf *sb);
struct parse_events_modifier {
u8 precise; /* Number of repeated 'p' for precision. */
bool precise_max : 1; /* 'P' */
bool non_idle : 1; /* 'I' */
bool sample_read : 1; /* 'S' */
bool pinned : 1; /* 'D' */
bool exclusive : 1; /* 'e' */
bool weak : 1; /* 'W' */
bool bpf : 1; /* 'b' */
bool user : 1; /* 'u' */
bool kernel : 1; /* 'k' */
bool hypervisor : 1; /* 'h' */
bool guest : 1; /* 'G' */
bool host : 1; /* 'H' */
bool retire_lat : 1; /* 'R' */
};
int parse_events__modifier_event(struct parse_events_state *parse_state, void *loc,
struct list_head *list, struct parse_events_modifier mod);
int parse_events__modifier_group(struct parse_events_state *parse_state, void *loc,
struct list_head *list, struct parse_events_modifier mod);
int parse_events__set_default_name(struct list_head *list, char *name);
int parse_events_add_tracepoint(struct parse_events_state *parse_state,
struct list_head *list,
const char *sys, const char *event,
struct parse_events_error *error,
struct parse_events_terms *head_config, void *loc);
int parse_events_add_numeric(struct parse_events_state *parse_state,
struct list_head *list,
u32 type, u64 config,
const struct parse_events_terms *head_config,
bool wildcard);
int parse_events_add_tool(struct parse_events_state *parse_state,
struct list_head *list,
int tool_event);
int parse_events_add_cache(struct list_head *list, int *idx, const char *name,
struct parse_events_state *parse_state,
struct parse_events_terms *parsed_terms);
int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config);
int parse_events_add_breakpoint(struct parse_events_state *parse_state,
struct list_head *list,
u64 addr, char *type, u64 len,
struct parse_events_terms *head_config);
struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
const char *name, const char *metric_id,
struct perf_pmu *pmu);
int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
const char *event_name,
const struct parse_events_terms *const_parsed_terms,
struct list_head **listp, void *loc);
int parse_events_multi_pmu_add_or_add_pmu(struct parse_events_state *parse_state,
const char *event_or_pmu,
const struct parse_events_terms *const_parsed_terms,
struct list_head **listp,
void *loc_);
void parse_events__set_leader(char *name, struct list_head *list);
struct event_symbol {
const char *symbol;
const char *alias;
};
extern const struct event_symbol event_symbols_hw[];
extern const struct event_symbol event_symbols_sw[];
char *parse_events_formats_error_string(char *additional_terms);
void parse_events_error__init(struct parse_events_error *err);
void parse_events_error__exit(struct parse_events_error *err);
void parse_events_error__handle(struct parse_events_error *err, int idx,
char *str, char *help);
void parse_events_error__print(const struct parse_events_error *err,
const char *event);
bool parse_events_error__contains(const struct parse_events_error *err,
const char *needle);
#ifdef HAVE_LIBELF_SUPPORT
/*
* If the probe point starts with '%',
* or starts with "sdt_" and has a ':' but no '=',
* then it should be a SDT/cached probe point.
*/
static inline bool is_sdt_event(char *str)
{
return (str[0] == '%' ||
(!strncmp(str, "sdt_", 4) &&
!!strchr(str, ':') && !strchr(str, '=')));
}
#else
static inline bool is_sdt_event(char *str __maybe_unused)
{
return false;
}
#endif /* HAVE_LIBELF_SUPPORT */
size_t default_breakpoint_len(void);
#endif /* __PERF_PARSE_EVENTS_H */
Codebase Browser
linux