xref: /openbmc/linux/tools/perf/util/trace-event.h (revision 5efb685b)
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 struct tracing_data {
66 	/* size is only valid if temp is 'true' */
67 	ssize_t size;
68 	bool temp;
69 	char temp_file[50];
70 };
71 
72 struct tracing_data *tracing_data_get(struct list_head *pattrs,
73 				      int fd, bool temp);
74 int tracing_data_put(struct tracing_data *tdata);
75 
76 
77 struct addr_location;
78 
79 struct perf_session;
80 struct perf_stat_config;
81 
82 struct scripting_ops {
83 	const char *name;
84 	const char *dirname; /* For script path .../scripts/<dirname>/... */
85 	int (*start_script)(const char *script, int argc, const char **argv,
86 			    struct perf_session *session);
87 	int (*flush_script) (void);
88 	int (*stop_script) (void);
89 	void (*process_event) (union perf_event *event,
90 			       struct perf_sample *sample,
91 			       struct evsel *evsel,
92 			       struct addr_location *al,
93 			       struct addr_location *addr_al);
94 	void (*process_switch)(union perf_event *event,
95 			       struct perf_sample *sample,
96 			       struct machine *machine);
97 	void (*process_auxtrace_error)(struct perf_session *session,
98 				       union perf_event *event);
99 	void (*process_stat)(struct perf_stat_config *config,
100 			     struct evsel *evsel, u64 tstamp);
101 	void (*process_stat_interval)(u64 tstamp);
102 	void (*process_throttle)(union perf_event *event,
103 				 struct perf_sample *sample,
104 				 struct machine *machine);
105 	int (*generate_script) (struct tep_handle *pevent, const char *outfile);
106 };
107 
108 extern unsigned int scripting_max_stack;
109 
110 int script_spec_register(const char *spec, struct scripting_ops *ops);
111 
112 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
113 		       struct machine *machine);
114 
115 void setup_perl_scripting(void);
116 void setup_python_scripting(void);
117 
118 struct scripting_context {
119 	struct tep_handle *pevent;
120 	void *event_data;
121 	union perf_event *event;
122 	struct perf_sample *sample;
123 	struct evsel *evsel;
124 	struct addr_location *al;
125 	struct addr_location *addr_al;
126 	struct perf_session *session;
127 };
128 
129 void scripting_context__update(struct scripting_context *scripting_context,
130 			       union perf_event *event,
131 			       struct perf_sample *sample,
132 			       struct evsel *evsel,
133 			       struct addr_location *al,
134 			       struct addr_location *addr_al);
135 
136 int common_pc(struct scripting_context *context);
137 int common_flags(struct scripting_context *context);
138 int common_lock_depth(struct scripting_context *context);
139 
140 #define SAMPLE_FLAGS_BUF_SIZE 64
141 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz);
142 
143 #if defined(LIBTRACEEVENT_VERSION) &&  LIBTRACEEVENT_VERSION >= MAKE_LIBTRACEEVENT_VERSION(1, 5, 0)
144 #include <traceevent/event-parse.h>
145 
146 static inline bool tep_field_is_relative(unsigned long flags)
147 {
148 	return (flags & TEP_FIELD_IS_RELATIVE) != 0;
149 }
150 #else
151 #include <linux/compiler.h>
152 
153 static inline bool tep_field_is_relative(unsigned long flags __maybe_unused)
154 {
155 	return false;
156 }
157 #endif
158 
159 #endif /* _PERF_UTIL_TRACE_EVENT_H */
160