xref: /openbmc/linux/tools/perf/util/trace-event.h (revision f412eef0)
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 typedef char *(tep_func_resolver_t)(void *priv,
25 				    unsigned long long *addrp, char **modp);
26 
27 bool have_tracepoints(struct list_head *evlist);
28 
29 int trace_event__init(struct trace_event *t);
30 void trace_event__cleanup(struct trace_event *t);
31 int trace_event__register_resolver(struct machine *machine,
32 				   tep_func_resolver_t *func);
33 struct tep_event*
34 trace_event__tp_format(const char *sys, const char *name);
35 
36 struct tep_event *trace_event__tp_format_id(int id);
37 
38 void event_format__fprintf(struct tep_event *event,
39 			   int cpu, void *data, int size, FILE *fp);
40 
41 void event_format__print(struct tep_event *event,
42 			 int cpu, void *data, int size);
43 
44 int parse_ftrace_file(struct tep_handle *pevent, char *buf, unsigned long size);
45 int parse_event_file(struct tep_handle *pevent,
46 		     char *buf, unsigned long size, char *sys);
47 
48 unsigned long long
49 raw_field_value(struct tep_event *event, const char *name, void *data);
50 
51 void parse_proc_kallsyms(struct tep_handle *pevent, char *file, unsigned int size);
52 void parse_ftrace_printk(struct tep_handle *pevent, char *file, unsigned int size);
53 void parse_saved_cmdline(struct tep_handle *pevent, char *file, unsigned int size);
54 
55 ssize_t trace_report(int fd, struct trace_event *tevent, bool repipe);
56 
57 unsigned long long read_size(struct tep_event *event, void *ptr, int size);
58 unsigned long long eval_flag(const char *flag);
59 
60 int read_tracing_data(int fd, struct list_head *pattrs);
61 
62 struct tracing_data {
63 	/* size is only valid if temp is 'true' */
64 	ssize_t size;
65 	bool temp;
66 	char temp_file[50];
67 };
68 
69 struct tracing_data *tracing_data_get(struct list_head *pattrs,
70 				      int fd, bool temp);
71 int tracing_data_put(struct tracing_data *tdata);
72 
73 
74 struct addr_location;
75 
76 struct perf_session;
77 struct perf_stat_config;
78 
79 struct scripting_ops {
80 	const char *name;
81 	const char *dirname; /* For script path .../scripts/<dirname>/... */
82 	int (*start_script)(const char *script, int argc, const char **argv,
83 			    struct perf_session *session);
84 	int (*flush_script) (void);
85 	int (*stop_script) (void);
86 	void (*process_event) (union perf_event *event,
87 			       struct perf_sample *sample,
88 			       struct evsel *evsel,
89 			       struct addr_location *al,
90 			       struct addr_location *addr_al);
91 	void (*process_switch)(union perf_event *event,
92 			       struct perf_sample *sample,
93 			       struct machine *machine);
94 	void (*process_auxtrace_error)(struct perf_session *session,
95 				       union perf_event *event);
96 	void (*process_stat)(struct perf_stat_config *config,
97 			     struct evsel *evsel, u64 tstamp);
98 	void (*process_stat_interval)(u64 tstamp);
99 	void (*process_throttle)(union perf_event *event,
100 				 struct perf_sample *sample,
101 				 struct machine *machine);
102 	int (*generate_script) (struct tep_handle *pevent, const char *outfile);
103 };
104 
105 extern unsigned int scripting_max_stack;
106 
107 int script_spec_register(const char *spec, struct scripting_ops *ops);
108 
109 void script_fetch_insn(struct perf_sample *sample, struct thread *thread,
110 		       struct machine *machine);
111 
112 void setup_perl_scripting(void);
113 void setup_python_scripting(void);
114 
115 struct scripting_context {
116 	struct tep_handle *pevent;
117 	void *event_data;
118 	union perf_event *event;
119 	struct perf_sample *sample;
120 	struct evsel *evsel;
121 	struct addr_location *al;
122 	struct addr_location *addr_al;
123 	struct perf_session *session;
124 };
125 
126 void scripting_context__update(struct scripting_context *scripting_context,
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 
133 int common_pc(struct scripting_context *context);
134 int common_flags(struct scripting_context *context);
135 int common_lock_depth(struct scripting_context *context);
136 
137 #define SAMPLE_FLAGS_BUF_SIZE 64
138 int perf_sample__sprintf_flags(u32 flags, char *str, size_t sz);
139 
140 #endif /* _PERF_UTIL_TRACE_EVENT_H */
141