1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _PERF_UTIL_TRACE_EVENT_H
3#define _PERF_UTIL_TRACE_EVENT_H
4
5#include <stdbool.h>
6#include <stdio.h>
7#include <sys/types.h>
8#include <linux/types.h>
9
10struct evlist;
11struct machine;
12struct perf_sample;
13union perf_event;
14struct perf_tool;
15struct thread;
16struct tep_plugin_list;
17struct evsel;
18struct tep_format_field;
19
20struct trace_event {
21 struct tep_handle *pevent;
22 struct tep_plugin_list *plugin_list;
23};
24
25/* Computes a version number comparable with LIBTRACEEVENT_VERSION from Makefile.config. */
26#define MAKE_LIBTRACEEVENT_VERSION(a, b, c) ((a)*255*255+(b)*255+(c))
27
28typedef char *(tep_func_resolver_t)(void *priv,
29 unsigned long long *addrp, char **modp);
30
31bool have_tracepoints(struct list_head *evlist);
32
33int trace_event__init(struct trace_event *t);
34void trace_event__cleanup(struct trace_event *t);
35int trace_event__register_resolver(struct machine *machine,
36 tep_func_resolver_t *func);
37struct tep_event*
38trace_event__tp_format(const char *sys, const char *name);
39
40struct tep_event *trace_event__tp_format_id(int id);
41
42void event_format__fprintf(const struct tep_event *event,
43 int cpu, void *data, int size, FILE *fp);
44
45int parse_ftrace_file(struct tep_handle *pevent, char *buf, unsigned long size);
46int parse_event_file(struct tep_handle *pevent,
47 char *buf, unsigned long size, char *sys);
48
49unsigned long long
50raw_field_value(struct tep_event *event, const char *name, void *data);
51
52const char *parse_task_states(struct tep_format_field *state_field);
53
54void parse_proc_kallsyms(struct tep_handle *pevent, char *file, unsigned int size);
55void parse_ftrace_printk(struct tep_handle *pevent, char *file, unsigned int size);
56void parse_saved_cmdline(struct tep_handle *pevent, char *file, unsigned int size);
57
58ssize_t trace_report(int fd, struct trace_event *tevent, bool repipe);
59
60unsigned long long read_size(struct tep_event *event, void *ptr, int size);
61unsigned long long eval_flag(const char *flag);
62
63int read_tracing_data(int fd, struct list_head *pattrs);
64
65/*
66 * Return the tracepoint name in the format "subsystem:event_name",
67 * callers should free the returned string.
68 */
69char *tracepoint_id_to_name(u64 config);
70
71struct tracing_data {
72 /* size is only valid if temp is 'true' */
73 ssize_t size;
74 bool temp;
75 char temp_file[50];
76};
77
78struct tracing_data *tracing_data_get(struct list_head *pattrs,
79 int fd, bool temp);
80int tracing_data_put(struct tracing_data *tdata);
81
82
83struct addr_location;
84
85struct perf_session;
86struct perf_stat_config;
87
88struct scripting_ops {
89 const char *name;
90 const char *dirname; /* For script path .../scripts/<dirname>/... */
91 int (*start_script)(const char *script, int argc, const char **argv,
92 struct perf_session *session);
93 int (*flush_script) (void);
94 int (*stop_script) (void);
95 void (*process_event) (union perf_event *event,
96 struct perf_sample *sample,
97 struct evsel *evsel,
98 struct addr_location *al,
99 struct addr_location *addr_al);
100 void (*process_switch)(union perf_event *event,
101 struct perf_sample *sample,
102 struct machine *machine);
103 void (*process_auxtrace_error)(struct perf_session *session,
104 union perf_event *event);
105 void (*process_stat)(struct perf_stat_config *config,
106 struct evsel *evsel, u64 tstamp);
107 void (*process_stat_interval)(u64 tstamp);
108 void (*process_throttle)(union perf_event *event,
109 struct perf_sample *sample,
110 struct machine *machine);
111 int (*generate_script) (struct tep_handle *pevent, const char *outfile);
112};
113
114extern unsigned int scripting_max_stack;
115
116struct scripting_ops *script_spec__lookup(const char *spec);
117int script_spec__for_each(int (*cb)(struct scripting_ops *ops, const char *spec));
118
119void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
120 struct machine *machine, bool native_arch);
121
122void setup_perl_scripting(void);
123void setup_python_scripting(void);
124
125struct scripting_context {
126 struct tep_handle *pevent;
127 void *event_data;
128 union perf_event *event;
129 struct perf_sample *sample;
130 struct evsel *evsel;
131 struct addr_location *al;
132 struct addr_location *addr_al;
133 struct perf_session *session;
134};
135
136void scripting_context__update(struct scripting_context *scripting_context,
137 union perf_event *event,
138 struct perf_sample *sample,
139 struct evsel *evsel,
140 struct addr_location *al,
141 struct addr_location *addr_al);
142
143int common_pc(struct scripting_context *context);
144int common_flags(struct scripting_context *context);
145int common_lock_depth(struct scripting_context *context);
146
147#define SAMPLE_FLAGS_BUF_SIZE 64
148#define SAMPLE_FLAGS_STR_ALIGNED_SIZE 21
149
150int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz);
151
152#if defined(LIBTRACEEVENT_VERSION) && LIBTRACEEVENT_VERSION >= MAKE_LIBTRACEEVENT_VERSION(1, 5, 0)
153#include <event-parse.h>
154
155static inline bool tep_field_is_relative(unsigned long flags)
156{
157 return (flags & TEP_FIELD_IS_RELATIVE) != 0;
158}
159#else
160#include <linux/compiler.h>
161
162static inline bool tep_field_is_relative(unsigned long flags __maybe_unused)
163{
164 return false;
165}
166#endif
167
168#endif /* _PERF_UTIL_TRACE_EVENT_H */
169

source code of linux/tools/perf/util/trace-event.h