xref: /openbmc/linux/tools/perf/util/trace-event.h (revision 4cfb9080)
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 
10 struct evlist;
11 struct machine;
12 struct perf_sample;
13 union perf_event;
14 struct perf_tool;
15 struct thread;
16 struct tep_plugin_list;
17 struct evsel;
18 
19 struct trace_event {
20 	struct tep_handle	*pevent;
21 	struct tep_plugin_list	*plugin_list;
22 };
23 
24 /* Computes a version number comparable with LIBTRACEEVENT_VERSION from Makefile.config. */
25 #define MAKE_LIBTRACEEVENT_VERSION(a, b, c) ((a)*255*255+(b)*255+(c))
26 
27 typedef char *(tep_func_resolver_t)(void *priv,
28 				    unsigned long long *addrp, char **modp);
29 
30 bool have_tracepoints(struct list_head *evlist);
31 
32 int trace_event__init(struct trace_event *t);
33 void trace_event__cleanup(struct trace_event *t);
34 int trace_event__register_resolver(struct machine *machine,
35 				   tep_func_resolver_t *func);
36 struct tep_event*
37 trace_event__tp_format(const char *sys, const char *name);
38 
39 struct tep_event *trace_event__tp_format_id(int id);
40 
41 void event_format__fprintf(struct tep_event *event,
42 			   int cpu, void *data, int size, FILE *fp);
43 
44 void event_format__print(struct tep_event *event,
45 			 int cpu, void *data, int size);
46 
47 int parse_ftrace_file(struct tep_handle *pevent, char *buf, unsigned long size);
48 int parse_event_file(struct tep_handle *pevent,
49 		     char *buf, unsigned long size, char *sys);
50 
51 unsigned long long
52 raw_field_value(struct tep_event *event, const char *name, void *data);
53 
54 void parse_proc_kallsyms(struct tep_handle *pevent, char *file, unsigned int size);
55 void parse_ftrace_printk(struct tep_handle *pevent, char *file, unsigned int size);
56 void parse_saved_cmdline(struct tep_handle *pevent, char *file, unsigned int size);
57 
58 ssize_t trace_report(int fd, struct trace_event *tevent, bool repipe);
59 
60 unsigned long long read_size(struct tep_event *event, void *ptr, int size);
61 unsigned long long eval_flag(const char *flag);
62 
63 int 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  */
69 char *tracepoint_id_to_name(u64 config);
70 
71 struct 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 
78 struct tracing_data *tracing_data_get(struct list_head *pattrs,
79 				      int fd, bool temp);
80 int tracing_data_put(struct tracing_data *tdata);
81 
82 
83 struct addr_location;
84 
85 struct perf_session;
86 struct perf_stat_config;
87 
88 struct 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 
114 extern unsigned int scripting_max_stack;
115 
116 int script_spec_register(const char *spec, struct scripting_ops *ops);
117 
118 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
119 		       struct machine *machine);
120 
121 void setup_perl_scripting(void);
122 void setup_python_scripting(void);
123 
124 struct scripting_context {
125 	struct tep_handle *pevent;
126 	void *event_data;
127 	union perf_event *event;
128 	struct perf_sample *sample;
129 	struct evsel *evsel;
130 	struct addr_location *al;
131 	struct addr_location *addr_al;
132 	struct perf_session *session;
133 };
134 
135 void scripting_context__update(struct scripting_context *scripting_context,
136 			       union perf_event *event,
137 			       struct perf_sample *sample,
138 			       struct evsel *evsel,
139 			       struct addr_location *al,
140 			       struct addr_location *addr_al);
141 
142 int common_pc(struct scripting_context *context);
143 int common_flags(struct scripting_context *context);
144 int common_lock_depth(struct scripting_context *context);
145 
146 #define SAMPLE_FLAGS_BUF_SIZE 64
147 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz);
148 
149 #if defined(LIBTRACEEVENT_VERSION) &&  LIBTRACEEVENT_VERSION >= MAKE_LIBTRACEEVENT_VERSION(1, 5, 0)
150 #include <traceevent/event-parse.h>
151 
152 static inline bool tep_field_is_relative(unsigned long flags)
153 {
154 	return (flags & TEP_FIELD_IS_RELATIVE) != 0;
155 }
156 #else
157 #include <linux/compiler.h>
158 
159 static inline bool tep_field_is_relative(unsigned long flags __maybe_unused)
160 {
161 	return false;
162 }
163 #endif
164 
165 #endif /* _PERF_UTIL_TRACE_EVENT_H */
166