]>
Commit | Line | Data |
---|---|---|
5f9c39dc FW |
1 | #include "builtin.h" |
2 | ||
b7eead86 | 3 | #include "perf.h" |
5f9c39dc | 4 | #include "util/cache.h" |
b7eead86 AG |
5 | #include "util/debug.h" |
6 | #include "util/exec_cmd.h" | |
7 | #include "util/header.h" | |
8 | #include "util/parse-options.h" | |
9 | #include "util/session.h" | |
45694aa7 | 10 | #include "util/tool.h" |
5f9c39dc FW |
11 | #include "util/symbol.h" |
12 | #include "util/thread.h" | |
cf72344d | 13 | #include "util/trace-event.h" |
b7eead86 | 14 | #include "util/util.h" |
1424dc96 DA |
15 | #include "util/evlist.h" |
16 | #include "util/evsel.h" | |
36385be5 | 17 | #include "util/sort.h" |
5d67be97 | 18 | #include <linux/bitmap.h> |
5f9c39dc | 19 | |
956ffd02 TZ |
20 | static char const *script_name; |
21 | static char const *generate_script_lang; | |
ffabd99e | 22 | static bool debug_mode; |
e1889d75 | 23 | static u64 last_timestamp; |
6fcf7ddb | 24 | static u64 nr_unordered; |
34c86ea9 | 25 | extern const struct option record_options[]; |
c0230b2b | 26 | static bool no_callchain; |
47390ae2 | 27 | static bool latency_format; |
317df650 | 28 | static bool system_wide; |
5d67be97 AB |
29 | static const char *cpu_list; |
30 | static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); | |
956ffd02 | 31 | |
745f43e3 DA |
32 | enum perf_output_field { |
33 | PERF_OUTPUT_COMM = 1U << 0, | |
34 | PERF_OUTPUT_TID = 1U << 1, | |
35 | PERF_OUTPUT_PID = 1U << 2, | |
36 | PERF_OUTPUT_TIME = 1U << 3, | |
37 | PERF_OUTPUT_CPU = 1U << 4, | |
38 | PERF_OUTPUT_EVNAME = 1U << 5, | |
39 | PERF_OUTPUT_TRACE = 1U << 6, | |
787bef17 DA |
40 | PERF_OUTPUT_IP = 1U << 7, |
41 | PERF_OUTPUT_SYM = 1U << 8, | |
610723f2 | 42 | PERF_OUTPUT_DSO = 1U << 9, |
7cec0922 | 43 | PERF_OUTPUT_ADDR = 1U << 10, |
a978f2ab | 44 | PERF_OUTPUT_SYMOFFSET = 1U << 11, |
745f43e3 DA |
45 | }; |
46 | ||
47 | struct output_option { | |
48 | const char *str; | |
49 | enum perf_output_field field; | |
50 | } all_output_options[] = { | |
51 | {.str = "comm", .field = PERF_OUTPUT_COMM}, | |
52 | {.str = "tid", .field = PERF_OUTPUT_TID}, | |
53 | {.str = "pid", .field = PERF_OUTPUT_PID}, | |
54 | {.str = "time", .field = PERF_OUTPUT_TIME}, | |
55 | {.str = "cpu", .field = PERF_OUTPUT_CPU}, | |
56 | {.str = "event", .field = PERF_OUTPUT_EVNAME}, | |
57 | {.str = "trace", .field = PERF_OUTPUT_TRACE}, | |
787bef17 | 58 | {.str = "ip", .field = PERF_OUTPUT_IP}, |
c0230b2b | 59 | {.str = "sym", .field = PERF_OUTPUT_SYM}, |
610723f2 | 60 | {.str = "dso", .field = PERF_OUTPUT_DSO}, |
7cec0922 | 61 | {.str = "addr", .field = PERF_OUTPUT_ADDR}, |
a978f2ab | 62 | {.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET}, |
745f43e3 DA |
63 | }; |
64 | ||
65 | /* default set to maintain compatibility with current format */ | |
2c9e45f7 DA |
66 | static struct { |
67 | bool user_set; | |
9cbdb702 | 68 | bool wildcard_set; |
a6ffaf91 | 69 | unsigned int print_ip_opts; |
2c9e45f7 DA |
70 | u64 fields; |
71 | u64 invalid_fields; | |
72 | } output[PERF_TYPE_MAX] = { | |
73 | ||
74 | [PERF_TYPE_HARDWARE] = { | |
75 | .user_set = false, | |
76 | ||
77 | .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | | |
78 | PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | | |
787bef17 | 79 | PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | |
610723f2 | 80 | PERF_OUTPUT_SYM | PERF_OUTPUT_DSO, |
2c9e45f7 DA |
81 | |
82 | .invalid_fields = PERF_OUTPUT_TRACE, | |
83 | }, | |
84 | ||
85 | [PERF_TYPE_SOFTWARE] = { | |
86 | .user_set = false, | |
87 | ||
88 | .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | | |
89 | PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | | |
787bef17 | 90 | PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | |
610723f2 | 91 | PERF_OUTPUT_SYM | PERF_OUTPUT_DSO, |
2c9e45f7 DA |
92 | |
93 | .invalid_fields = PERF_OUTPUT_TRACE, | |
94 | }, | |
95 | ||
96 | [PERF_TYPE_TRACEPOINT] = { | |
97 | .user_set = false, | |
98 | ||
99 | .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | | |
100 | PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | | |
101 | PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE, | |
102 | }, | |
0817a6a3 AS |
103 | |
104 | [PERF_TYPE_RAW] = { | |
105 | .user_set = false, | |
106 | ||
107 | .fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID | | |
108 | PERF_OUTPUT_CPU | PERF_OUTPUT_TIME | | |
787bef17 | 109 | PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP | |
610723f2 | 110 | PERF_OUTPUT_SYM | PERF_OUTPUT_DSO, |
0817a6a3 AS |
111 | |
112 | .invalid_fields = PERF_OUTPUT_TRACE, | |
113 | }, | |
1424dc96 | 114 | }; |
745f43e3 | 115 | |
2c9e45f7 DA |
116 | static bool output_set_by_user(void) |
117 | { | |
118 | int j; | |
119 | for (j = 0; j < PERF_TYPE_MAX; ++j) { | |
120 | if (output[j].user_set) | |
121 | return true; | |
122 | } | |
123 | return false; | |
124 | } | |
745f43e3 | 125 | |
9cbdb702 DA |
126 | static const char *output_field2str(enum perf_output_field field) |
127 | { | |
128 | int i, imax = ARRAY_SIZE(all_output_options); | |
129 | const char *str = ""; | |
130 | ||
131 | for (i = 0; i < imax; ++i) { | |
132 | if (all_output_options[i].field == field) { | |
133 | str = all_output_options[i].str; | |
134 | break; | |
135 | } | |
136 | } | |
137 | return str; | |
138 | } | |
139 | ||
2c9e45f7 | 140 | #define PRINT_FIELD(x) (output[attr->type].fields & PERF_OUTPUT_##x) |
1424dc96 | 141 | |
5bff01f6 ACM |
142 | static int perf_evsel__check_stype(struct perf_evsel *evsel, |
143 | u64 sample_type, const char *sample_msg, | |
144 | enum perf_output_field field) | |
1424dc96 | 145 | { |
5bff01f6 | 146 | struct perf_event_attr *attr = &evsel->attr; |
9cbdb702 DA |
147 | int type = attr->type; |
148 | const char *evname; | |
149 | ||
150 | if (attr->sample_type & sample_type) | |
151 | return 0; | |
152 | ||
153 | if (output[type].user_set) { | |
5bff01f6 | 154 | evname = perf_evsel__name(evsel); |
9cbdb702 DA |
155 | pr_err("Samples for '%s' event do not have %s attribute set. " |
156 | "Cannot print '%s' field.\n", | |
157 | evname, sample_msg, output_field2str(field)); | |
158 | return -1; | |
159 | } | |
160 | ||
161 | /* user did not ask for it explicitly so remove from the default list */ | |
162 | output[type].fields &= ~field; | |
5bff01f6 | 163 | evname = perf_evsel__name(evsel); |
9cbdb702 DA |
164 | pr_debug("Samples for '%s' event do not have %s attribute set. " |
165 | "Skipping '%s' field.\n", | |
166 | evname, sample_msg, output_field2str(field)); | |
167 | ||
168 | return 0; | |
169 | } | |
170 | ||
171 | static int perf_evsel__check_attr(struct perf_evsel *evsel, | |
172 | struct perf_session *session) | |
173 | { | |
174 | struct perf_event_attr *attr = &evsel->attr; | |
175 | ||
1424dc96 DA |
176 | if (PRINT_FIELD(TRACE) && |
177 | !perf_session__has_traces(session, "record -R")) | |
178 | return -EINVAL; | |
179 | ||
787bef17 | 180 | if (PRINT_FIELD(IP)) { |
5bff01f6 ACM |
181 | if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", |
182 | PERF_OUTPUT_IP)) | |
1424dc96 | 183 | return -EINVAL; |
9cbdb702 | 184 | |
1424dc96 | 185 | if (!no_callchain && |
9cbdb702 | 186 | !(attr->sample_type & PERF_SAMPLE_CALLCHAIN)) |
1424dc96 DA |
187 | symbol_conf.use_callchain = false; |
188 | } | |
7cec0922 DA |
189 | |
190 | if (PRINT_FIELD(ADDR) && | |
5bff01f6 ACM |
191 | perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", |
192 | PERF_OUTPUT_ADDR)) | |
7cec0922 DA |
193 | return -EINVAL; |
194 | ||
195 | if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { | |
196 | pr_err("Display of symbols requested but neither sample IP nor " | |
197 | "sample address\nis selected. Hence, no addresses to convert " | |
198 | "to symbols.\n"); | |
787bef17 DA |
199 | return -EINVAL; |
200 | } | |
a978f2ab AN |
201 | if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) { |
202 | pr_err("Display of offsets requested but symbol is not" | |
203 | "selected.\n"); | |
204 | return -EINVAL; | |
205 | } | |
7cec0922 DA |
206 | if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) { |
207 | pr_err("Display of DSO requested but neither sample IP nor " | |
208 | "sample address\nis selected. Hence, no addresses to convert " | |
209 | "to DSO.\n"); | |
610723f2 DA |
210 | return -EINVAL; |
211 | } | |
1424dc96 DA |
212 | |
213 | if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) && | |
5bff01f6 ACM |
214 | perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", |
215 | PERF_OUTPUT_TID|PERF_OUTPUT_PID)) | |
1424dc96 | 216 | return -EINVAL; |
1424dc96 DA |
217 | |
218 | if (PRINT_FIELD(TIME) && | |
5bff01f6 ACM |
219 | perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", |
220 | PERF_OUTPUT_TIME)) | |
1424dc96 | 221 | return -EINVAL; |
1424dc96 DA |
222 | |
223 | if (PRINT_FIELD(CPU) && | |
5bff01f6 ACM |
224 | perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU", |
225 | PERF_OUTPUT_CPU)) | |
1424dc96 | 226 | return -EINVAL; |
9cbdb702 DA |
227 | |
228 | return 0; | |
229 | } | |
230 | ||
231 | /* | |
232 | * verify all user requested events exist and the samples | |
233 | * have the expected data | |
234 | */ | |
235 | static int perf_session__check_output_opt(struct perf_session *session) | |
236 | { | |
237 | int j; | |
238 | struct perf_evsel *evsel; | |
a6ffaf91 | 239 | struct perf_event_attr *attr; |
9cbdb702 DA |
240 | |
241 | for (j = 0; j < PERF_TYPE_MAX; ++j) { | |
242 | evsel = perf_session__find_first_evtype(session, j); | |
243 | ||
244 | /* | |
245 | * even if fields is set to 0 (ie., show nothing) event must | |
246 | * exist if user explicitly includes it on the command line | |
247 | */ | |
248 | if (!evsel && output[j].user_set && !output[j].wildcard_set) { | |
249 | pr_err("%s events do not exist. " | |
250 | "Remove corresponding -f option to proceed.\n", | |
251 | event_type(j)); | |
252 | return -1; | |
253 | } | |
254 | ||
255 | if (evsel && output[j].fields && | |
256 | perf_evsel__check_attr(evsel, session)) | |
257 | return -1; | |
a6ffaf91 DA |
258 | |
259 | if (evsel == NULL) | |
260 | continue; | |
261 | ||
262 | attr = &evsel->attr; | |
263 | ||
264 | output[j].print_ip_opts = 0; | |
265 | if (PRINT_FIELD(IP)) | |
266 | output[j].print_ip_opts |= PRINT_IP_OPT_IP; | |
267 | ||
268 | if (PRINT_FIELD(SYM)) | |
269 | output[j].print_ip_opts |= PRINT_IP_OPT_SYM; | |
270 | ||
271 | if (PRINT_FIELD(DSO)) | |
272 | output[j].print_ip_opts |= PRINT_IP_OPT_DSO; | |
273 | ||
274 | if (PRINT_FIELD(SYMOFFSET)) | |
275 | output[j].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET; | |
1424dc96 DA |
276 | } |
277 | ||
278 | return 0; | |
279 | } | |
745f43e3 | 280 | |
fcf65bf1 | 281 | static void print_sample_start(struct perf_sample *sample, |
1424dc96 | 282 | struct thread *thread, |
5bff01f6 | 283 | struct perf_evsel *evsel) |
c70c94b4 | 284 | { |
5bff01f6 | 285 | struct perf_event_attr *attr = &evsel->attr; |
c70c94b4 DA |
286 | const char *evname = NULL; |
287 | unsigned long secs; | |
288 | unsigned long usecs; | |
745f43e3 DA |
289 | unsigned long long nsecs; |
290 | ||
291 | if (PRINT_FIELD(COMM)) { | |
292 | if (latency_format) | |
293 | printf("%8.8s ", thread->comm); | |
787bef17 | 294 | else if (PRINT_FIELD(IP) && symbol_conf.use_callchain) |
c0230b2b | 295 | printf("%s ", thread->comm); |
745f43e3 DA |
296 | else |
297 | printf("%16s ", thread->comm); | |
298 | } | |
c70c94b4 | 299 | |
745f43e3 DA |
300 | if (PRINT_FIELD(PID) && PRINT_FIELD(TID)) |
301 | printf("%5d/%-5d ", sample->pid, sample->tid); | |
302 | else if (PRINT_FIELD(PID)) | |
303 | printf("%5d ", sample->pid); | |
304 | else if (PRINT_FIELD(TID)) | |
305 | printf("%5d ", sample->tid); | |
306 | ||
307 | if (PRINT_FIELD(CPU)) { | |
308 | if (latency_format) | |
309 | printf("%3d ", sample->cpu); | |
310 | else | |
311 | printf("[%03d] ", sample->cpu); | |
312 | } | |
c70c94b4 | 313 | |
745f43e3 DA |
314 | if (PRINT_FIELD(TIME)) { |
315 | nsecs = sample->time; | |
316 | secs = nsecs / NSECS_PER_SEC; | |
317 | nsecs -= secs * NSECS_PER_SEC; | |
318 | usecs = nsecs / NSECS_PER_USEC; | |
319 | printf("%5lu.%06lu: ", secs, usecs); | |
320 | } | |
c70c94b4 | 321 | |
745f43e3 | 322 | if (PRINT_FIELD(EVNAME)) { |
fcf65bf1 | 323 | evname = perf_evsel__name(evsel); |
547a92e0 | 324 | printf("%s: ", evname ? evname : "[unknown]"); |
745f43e3 | 325 | } |
c70c94b4 DA |
326 | } |
327 | ||
95582596 AN |
328 | static bool is_bts_event(struct perf_event_attr *attr) |
329 | { | |
330 | return ((attr->type == PERF_TYPE_HARDWARE) && | |
331 | (attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) && | |
332 | (attr->sample_period == 1)); | |
333 | } | |
334 | ||
7cec0922 DA |
335 | static bool sample_addr_correlates_sym(struct perf_event_attr *attr) |
336 | { | |
337 | if ((attr->type == PERF_TYPE_SOFTWARE) && | |
338 | ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) || | |
339 | (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) || | |
340 | (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ))) | |
341 | return true; | |
342 | ||
95582596 AN |
343 | if (is_bts_event(attr)) |
344 | return true; | |
345 | ||
7cec0922 DA |
346 | return false; |
347 | } | |
348 | ||
349 | static void print_sample_addr(union perf_event *event, | |
350 | struct perf_sample *sample, | |
743eb868 | 351 | struct machine *machine, |
7cec0922 DA |
352 | struct thread *thread, |
353 | struct perf_event_attr *attr) | |
354 | { | |
355 | struct addr_location al; | |
356 | u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK; | |
7cec0922 DA |
357 | |
358 | printf("%16" PRIx64, sample->addr); | |
359 | ||
360 | if (!sample_addr_correlates_sym(attr)) | |
361 | return; | |
362 | ||
743eb868 | 363 | thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION, |
326f59bf | 364 | sample->addr, &al); |
7cec0922 | 365 | if (!al.map) |
743eb868 | 366 | thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE, |
326f59bf | 367 | sample->addr, &al); |
7cec0922 DA |
368 | |
369 | al.cpu = sample->cpu; | |
370 | al.sym = NULL; | |
371 | ||
372 | if (al.map) | |
373 | al.sym = map__find_symbol(al.map, al.addr, NULL); | |
374 | ||
375 | if (PRINT_FIELD(SYM)) { | |
547a92e0 | 376 | printf(" "); |
a978f2ab AN |
377 | if (PRINT_FIELD(SYMOFFSET)) |
378 | symbol__fprintf_symname_offs(al.sym, &al, stdout); | |
379 | else | |
380 | symbol__fprintf_symname(al.sym, stdout); | |
7cec0922 DA |
381 | } |
382 | ||
383 | if (PRINT_FIELD(DSO)) { | |
547a92e0 AN |
384 | printf(" ("); |
385 | map__fprintf_dsoname(al.map, stdout); | |
386 | printf(")"); | |
7cec0922 DA |
387 | } |
388 | } | |
389 | ||
95582596 AN |
390 | static void print_sample_bts(union perf_event *event, |
391 | struct perf_sample *sample, | |
392 | struct perf_evsel *evsel, | |
393 | struct machine *machine, | |
394 | struct thread *thread) | |
395 | { | |
396 | struct perf_event_attr *attr = &evsel->attr; | |
397 | ||
398 | /* print branch_from information */ | |
399 | if (PRINT_FIELD(IP)) { | |
400 | if (!symbol_conf.use_callchain) | |
401 | printf(" "); | |
402 | else | |
403 | printf("\n"); | |
71ad0f5e | 404 | perf_evsel__print_ip(evsel, event, sample, machine, |
307cbb92 DA |
405 | output[attr->type].print_ip_opts, |
406 | PERF_MAX_STACK_DEPTH); | |
95582596 AN |
407 | } |
408 | ||
409 | printf(" => "); | |
410 | ||
411 | /* print branch_to information */ | |
243be3dd AH |
412 | if (PRINT_FIELD(ADDR) || |
413 | ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) && | |
414 | !output[attr->type].user_set)) | |
95582596 AN |
415 | print_sample_addr(event, sample, machine, thread, attr); |
416 | ||
417 | printf("\n"); | |
418 | } | |
419 | ||
97822433 ACM |
420 | static void process_event(union perf_event *event, struct perf_sample *sample, |
421 | struct perf_evsel *evsel, struct machine *machine, | |
2eaa1b40 DA |
422 | struct thread *thread, |
423 | struct addr_location *al __maybe_unused) | |
be6d842a | 424 | { |
9e69c210 | 425 | struct perf_event_attr *attr = &evsel->attr; |
1424dc96 | 426 | |
2c9e45f7 | 427 | if (output[attr->type].fields == 0) |
1424dc96 DA |
428 | return; |
429 | ||
fcf65bf1 | 430 | print_sample_start(sample, thread, evsel); |
745f43e3 | 431 | |
95582596 AN |
432 | if (is_bts_event(attr)) { |
433 | print_sample_bts(event, sample, evsel, machine, thread); | |
434 | return; | |
435 | } | |
436 | ||
745f43e3 | 437 | if (PRINT_FIELD(TRACE)) |
fcf65bf1 ACM |
438 | event_format__print(evsel->tp_format, sample->cpu, |
439 | sample->raw_data, sample->raw_size); | |
7cec0922 | 440 | if (PRINT_FIELD(ADDR)) |
743eb868 | 441 | print_sample_addr(event, sample, machine, thread, attr); |
7cec0922 | 442 | |
787bef17 | 443 | if (PRINT_FIELD(IP)) { |
c0230b2b DA |
444 | if (!symbol_conf.use_callchain) |
445 | printf(" "); | |
446 | else | |
447 | printf("\n"); | |
a6ffaf91 | 448 | |
71ad0f5e | 449 | perf_evsel__print_ip(evsel, event, sample, machine, |
307cbb92 DA |
450 | output[attr->type].print_ip_opts, |
451 | PERF_MAX_STACK_DEPTH); | |
c0230b2b DA |
452 | } |
453 | ||
c70c94b4 | 454 | printf("\n"); |
be6d842a DA |
455 | } |
456 | ||
1d037ca1 IT |
457 | static int default_start_script(const char *script __maybe_unused, |
458 | int argc __maybe_unused, | |
459 | const char **argv __maybe_unused) | |
956ffd02 TZ |
460 | { |
461 | return 0; | |
462 | } | |
463 | ||
464 | static int default_stop_script(void) | |
465 | { | |
466 | return 0; | |
467 | } | |
468 | ||
1d037ca1 IT |
469 | static int default_generate_script(struct pevent *pevent __maybe_unused, |
470 | const char *outfile __maybe_unused) | |
956ffd02 TZ |
471 | { |
472 | return 0; | |
473 | } | |
474 | ||
475 | static struct scripting_ops default_scripting_ops = { | |
476 | .start_script = default_start_script, | |
477 | .stop_script = default_stop_script, | |
be6d842a | 478 | .process_event = process_event, |
956ffd02 TZ |
479 | .generate_script = default_generate_script, |
480 | }; | |
481 | ||
482 | static struct scripting_ops *scripting_ops; | |
483 | ||
484 | static void setup_scripting(void) | |
485 | { | |
16c632de | 486 | setup_perl_scripting(); |
7e4b21b8 | 487 | setup_python_scripting(); |
16c632de | 488 | |
956ffd02 TZ |
489 | scripting_ops = &default_scripting_ops; |
490 | } | |
491 | ||
492 | static int cleanup_scripting(void) | |
493 | { | |
133dc4c3 | 494 | pr_debug("\nperf script stopped\n"); |
3824a4e8 | 495 | |
956ffd02 TZ |
496 | return scripting_ops->stop_script(); |
497 | } | |
498 | ||
1d037ca1 | 499 | static int process_sample_event(struct perf_tool *tool __maybe_unused, |
d20deb64 | 500 | union perf_event *event, |
8115d60c | 501 | struct perf_sample *sample, |
9e69c210 | 502 | struct perf_evsel *evsel, |
743eb868 | 503 | struct machine *machine) |
5f9c39dc | 504 | { |
e7984b7b | 505 | struct addr_location al; |
ef89325f AH |
506 | struct thread *thread = machine__findnew_thread(machine, sample->pid, |
507 | sample->tid); | |
6ddf259d | 508 | |
5f9c39dc | 509 | if (thread == NULL) { |
6beba7ad ACM |
510 | pr_debug("problem processing %d event, skipping it.\n", |
511 | event->header.type); | |
5f9c39dc FW |
512 | return -1; |
513 | } | |
514 | ||
1424dc96 DA |
515 | if (debug_mode) { |
516 | if (sample->time < last_timestamp) { | |
517 | pr_err("Samples misordered, previous: %" PRIu64 | |
518 | " this: %" PRIu64 "\n", last_timestamp, | |
519 | sample->time); | |
520 | nr_unordered++; | |
e1889d75 | 521 | } |
1424dc96 DA |
522 | last_timestamp = sample->time; |
523 | return 0; | |
5f9c39dc | 524 | } |
5d67be97 | 525 | |
e44baa3e | 526 | if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) { |
e7984b7b DA |
527 | pr_err("problem processing %d event, skipping it.\n", |
528 | event->header.type); | |
529 | return -1; | |
530 | } | |
531 | ||
532 | if (al.filtered) | |
533 | return 0; | |
534 | ||
5d67be97 AB |
535 | if (cpu_list && !test_bit(sample->cpu, cpu_bitmap)) |
536 | return 0; | |
537 | ||
2eaa1b40 | 538 | scripting_ops->process_event(event, sample, evsel, machine, thread, &al); |
5f9c39dc | 539 | |
743eb868 | 540 | evsel->hists.stats.total_period += sample->period; |
5f9c39dc FW |
541 | return 0; |
542 | } | |
543 | ||
97822433 ACM |
544 | static struct perf_tool perf_script = { |
545 | .sample = process_sample_event, | |
546 | .mmap = perf_event__process_mmap, | |
5c5e854b | 547 | .mmap2 = perf_event__process_mmap2, |
97822433 | 548 | .comm = perf_event__process_comm, |
f62d3f0f ACM |
549 | .exit = perf_event__process_exit, |
550 | .fork = perf_event__process_fork, | |
97822433 | 551 | .attr = perf_event__process_attr, |
97822433 ACM |
552 | .tracing_data = perf_event__process_tracing_data, |
553 | .build_id = perf_event__process_build_id, | |
554 | .ordered_samples = true, | |
555 | .ordering_requires_timestamps = true, | |
016e92fb FW |
556 | }; |
557 | ||
1d037ca1 | 558 | static void sig_handler(int sig __maybe_unused) |
c239da3b TZ |
559 | { |
560 | session_done = 1; | |
561 | } | |
562 | ||
133dc4c3 | 563 | static int __cmd_script(struct perf_session *session) |
5f9c39dc | 564 | { |
6fcf7ddb FW |
565 | int ret; |
566 | ||
c239da3b TZ |
567 | signal(SIGINT, sig_handler); |
568 | ||
97822433 | 569 | ret = perf_session__process_events(session, &perf_script); |
6fcf7ddb | 570 | |
6d8afb56 | 571 | if (debug_mode) |
9486aa38 | 572 | pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered); |
6fcf7ddb FW |
573 | |
574 | return ret; | |
5f9c39dc FW |
575 | } |
576 | ||
956ffd02 TZ |
577 | struct script_spec { |
578 | struct list_head node; | |
579 | struct scripting_ops *ops; | |
580 | char spec[0]; | |
581 | }; | |
582 | ||
eccdfe2d | 583 | static LIST_HEAD(script_specs); |
956ffd02 TZ |
584 | |
585 | static struct script_spec *script_spec__new(const char *spec, | |
586 | struct scripting_ops *ops) | |
587 | { | |
588 | struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1); | |
589 | ||
590 | if (s != NULL) { | |
591 | strcpy(s->spec, spec); | |
592 | s->ops = ops; | |
593 | } | |
594 | ||
595 | return s; | |
596 | } | |
597 | ||
956ffd02 TZ |
598 | static void script_spec__add(struct script_spec *s) |
599 | { | |
600 | list_add_tail(&s->node, &script_specs); | |
601 | } | |
602 | ||
603 | static struct script_spec *script_spec__find(const char *spec) | |
604 | { | |
605 | struct script_spec *s; | |
606 | ||
607 | list_for_each_entry(s, &script_specs, node) | |
608 | if (strcasecmp(s->spec, spec) == 0) | |
609 | return s; | |
610 | return NULL; | |
611 | } | |
612 | ||
613 | static struct script_spec *script_spec__findnew(const char *spec, | |
614 | struct scripting_ops *ops) | |
615 | { | |
616 | struct script_spec *s = script_spec__find(spec); | |
617 | ||
618 | if (s) | |
619 | return s; | |
620 | ||
621 | s = script_spec__new(spec, ops); | |
622 | if (!s) | |
466e2876 | 623 | return NULL; |
956ffd02 TZ |
624 | |
625 | script_spec__add(s); | |
626 | ||
627 | return s; | |
956ffd02 TZ |
628 | } |
629 | ||
630 | int script_spec_register(const char *spec, struct scripting_ops *ops) | |
631 | { | |
632 | struct script_spec *s; | |
633 | ||
634 | s = script_spec__find(spec); | |
635 | if (s) | |
636 | return -1; | |
637 | ||
638 | s = script_spec__findnew(spec, ops); | |
639 | if (!s) | |
640 | return -1; | |
641 | ||
642 | return 0; | |
643 | } | |
644 | ||
645 | static struct scripting_ops *script_spec__lookup(const char *spec) | |
646 | { | |
647 | struct script_spec *s = script_spec__find(spec); | |
648 | if (!s) | |
649 | return NULL; | |
650 | ||
651 | return s->ops; | |
652 | } | |
653 | ||
654 | static void list_available_languages(void) | |
655 | { | |
656 | struct script_spec *s; | |
657 | ||
658 | fprintf(stderr, "\n"); | |
659 | fprintf(stderr, "Scripting language extensions (used in " | |
133dc4c3 | 660 | "perf script -s [spec:]script.[spec]):\n\n"); |
956ffd02 TZ |
661 | |
662 | list_for_each_entry(s, &script_specs, node) | |
663 | fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name); | |
664 | ||
665 | fprintf(stderr, "\n"); | |
666 | } | |
667 | ||
1d037ca1 IT |
668 | static int parse_scriptname(const struct option *opt __maybe_unused, |
669 | const char *str, int unset __maybe_unused) | |
956ffd02 TZ |
670 | { |
671 | char spec[PATH_MAX]; | |
672 | const char *script, *ext; | |
673 | int len; | |
674 | ||
f526d68b | 675 | if (strcmp(str, "lang") == 0) { |
956ffd02 | 676 | list_available_languages(); |
f526d68b | 677 | exit(0); |
956ffd02 TZ |
678 | } |
679 | ||
680 | script = strchr(str, ':'); | |
681 | if (script) { | |
682 | len = script - str; | |
683 | if (len >= PATH_MAX) { | |
684 | fprintf(stderr, "invalid language specifier"); | |
685 | return -1; | |
686 | } | |
687 | strncpy(spec, str, len); | |
688 | spec[len] = '\0'; | |
689 | scripting_ops = script_spec__lookup(spec); | |
690 | if (!scripting_ops) { | |
691 | fprintf(stderr, "invalid language specifier"); | |
692 | return -1; | |
693 | } | |
694 | script++; | |
695 | } else { | |
696 | script = str; | |
d1e95bb5 | 697 | ext = strrchr(script, '.'); |
956ffd02 TZ |
698 | if (!ext) { |
699 | fprintf(stderr, "invalid script extension"); | |
700 | return -1; | |
701 | } | |
702 | scripting_ops = script_spec__lookup(++ext); | |
703 | if (!scripting_ops) { | |
704 | fprintf(stderr, "invalid script extension"); | |
705 | return -1; | |
706 | } | |
707 | } | |
708 | ||
709 | script_name = strdup(script); | |
710 | ||
711 | return 0; | |
712 | } | |
713 | ||
1d037ca1 IT |
714 | static int parse_output_fields(const struct option *opt __maybe_unused, |
715 | const char *arg, int unset __maybe_unused) | |
745f43e3 DA |
716 | { |
717 | char *tok; | |
50ca19ae | 718 | int i, imax = ARRAY_SIZE(all_output_options); |
2c9e45f7 | 719 | int j; |
745f43e3 DA |
720 | int rc = 0; |
721 | char *str = strdup(arg); | |
1424dc96 | 722 | int type = -1; |
745f43e3 DA |
723 | |
724 | if (!str) | |
725 | return -ENOMEM; | |
726 | ||
2c9e45f7 DA |
727 | /* first word can state for which event type the user is specifying |
728 | * the fields. If no type exists, the specified fields apply to all | |
729 | * event types found in the file minus the invalid fields for a type. | |
1424dc96 | 730 | */ |
2c9e45f7 DA |
731 | tok = strchr(str, ':'); |
732 | if (tok) { | |
733 | *tok = '\0'; | |
734 | tok++; | |
735 | if (!strcmp(str, "hw")) | |
736 | type = PERF_TYPE_HARDWARE; | |
737 | else if (!strcmp(str, "sw")) | |
738 | type = PERF_TYPE_SOFTWARE; | |
739 | else if (!strcmp(str, "trace")) | |
740 | type = PERF_TYPE_TRACEPOINT; | |
0817a6a3 AS |
741 | else if (!strcmp(str, "raw")) |
742 | type = PERF_TYPE_RAW; | |
2c9e45f7 DA |
743 | else { |
744 | fprintf(stderr, "Invalid event type in field string.\n"); | |
38efb539 RR |
745 | rc = -EINVAL; |
746 | goto out; | |
2c9e45f7 DA |
747 | } |
748 | ||
749 | if (output[type].user_set) | |
750 | pr_warning("Overriding previous field request for %s events.\n", | |
751 | event_type(type)); | |
752 | ||
753 | output[type].fields = 0; | |
754 | output[type].user_set = true; | |
9cbdb702 | 755 | output[type].wildcard_set = false; |
2c9e45f7 DA |
756 | |
757 | } else { | |
758 | tok = str; | |
759 | if (strlen(str) == 0) { | |
760 | fprintf(stderr, | |
761 | "Cannot set fields to 'none' for all event types.\n"); | |
762 | rc = -EINVAL; | |
763 | goto out; | |
764 | } | |
765 | ||
766 | if (output_set_by_user()) | |
767 | pr_warning("Overriding previous field request for all events.\n"); | |
768 | ||
769 | for (j = 0; j < PERF_TYPE_MAX; ++j) { | |
770 | output[j].fields = 0; | |
771 | output[j].user_set = true; | |
9cbdb702 | 772 | output[j].wildcard_set = true; |
2c9e45f7 | 773 | } |
745f43e3 DA |
774 | } |
775 | ||
2c9e45f7 DA |
776 | tok = strtok(tok, ","); |
777 | while (tok) { | |
745f43e3 | 778 | for (i = 0; i < imax; ++i) { |
2c9e45f7 | 779 | if (strcmp(tok, all_output_options[i].str) == 0) |
745f43e3 | 780 | break; |
745f43e3 DA |
781 | } |
782 | if (i == imax) { | |
2c9e45f7 | 783 | fprintf(stderr, "Invalid field requested.\n"); |
745f43e3 | 784 | rc = -EINVAL; |
2c9e45f7 | 785 | goto out; |
745f43e3 DA |
786 | } |
787 | ||
2c9e45f7 DA |
788 | if (type == -1) { |
789 | /* add user option to all events types for | |
790 | * which it is valid | |
791 | */ | |
792 | for (j = 0; j < PERF_TYPE_MAX; ++j) { | |
793 | if (output[j].invalid_fields & all_output_options[i].field) { | |
794 | pr_warning("\'%s\' not valid for %s events. Ignoring.\n", | |
795 | all_output_options[i].str, event_type(j)); | |
796 | } else | |
797 | output[j].fields |= all_output_options[i].field; | |
798 | } | |
799 | } else { | |
800 | if (output[type].invalid_fields & all_output_options[i].field) { | |
801 | fprintf(stderr, "\'%s\' not valid for %s events.\n", | |
802 | all_output_options[i].str, event_type(type)); | |
803 | ||
804 | rc = -EINVAL; | |
805 | goto out; | |
806 | } | |
807 | output[type].fields |= all_output_options[i].field; | |
808 | } | |
809 | ||
810 | tok = strtok(NULL, ","); | |
745f43e3 DA |
811 | } |
812 | ||
2c9e45f7 DA |
813 | if (type >= 0) { |
814 | if (output[type].fields == 0) { | |
815 | pr_debug("No fields requested for %s type. " | |
816 | "Events will not be displayed.\n", event_type(type)); | |
817 | } | |
818 | } | |
745f43e3 | 819 | |
2c9e45f7 | 820 | out: |
745f43e3 DA |
821 | free(str); |
822 | return rc; | |
823 | } | |
824 | ||
008f29d3 SB |
825 | /* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */ |
826 | static int is_directory(const char *base_path, const struct dirent *dent) | |
827 | { | |
828 | char path[PATH_MAX]; | |
829 | struct stat st; | |
830 | ||
831 | sprintf(path, "%s/%s", base_path, dent->d_name); | |
832 | if (stat(path, &st)) | |
833 | return 0; | |
834 | ||
835 | return S_ISDIR(st.st_mode); | |
836 | } | |
837 | ||
838 | #define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\ | |
4b9c0c59 TZ |
839 | while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \ |
840 | lang_next) \ | |
008f29d3 SB |
841 | if ((lang_dirent.d_type == DT_DIR || \ |
842 | (lang_dirent.d_type == DT_UNKNOWN && \ | |
843 | is_directory(scripts_path, &lang_dirent))) && \ | |
4b9c0c59 TZ |
844 | (strcmp(lang_dirent.d_name, ".")) && \ |
845 | (strcmp(lang_dirent.d_name, ".."))) | |
846 | ||
008f29d3 | 847 | #define for_each_script(lang_path, lang_dir, script_dirent, script_next)\ |
4b9c0c59 TZ |
848 | while (!readdir_r(lang_dir, &script_dirent, &script_next) && \ |
849 | script_next) \ | |
008f29d3 SB |
850 | if (script_dirent.d_type != DT_DIR && \ |
851 | (script_dirent.d_type != DT_UNKNOWN || \ | |
852 | !is_directory(lang_path, &script_dirent))) | |
4b9c0c59 TZ |
853 | |
854 | ||
855 | #define RECORD_SUFFIX "-record" | |
856 | #define REPORT_SUFFIX "-report" | |
857 | ||
858 | struct script_desc { | |
859 | struct list_head node; | |
860 | char *name; | |
861 | char *half_liner; | |
862 | char *args; | |
863 | }; | |
864 | ||
eccdfe2d | 865 | static LIST_HEAD(script_descs); |
4b9c0c59 TZ |
866 | |
867 | static struct script_desc *script_desc__new(const char *name) | |
868 | { | |
869 | struct script_desc *s = zalloc(sizeof(*s)); | |
870 | ||
b5b87312 | 871 | if (s != NULL && name) |
4b9c0c59 TZ |
872 | s->name = strdup(name); |
873 | ||
874 | return s; | |
875 | } | |
876 | ||
877 | static void script_desc__delete(struct script_desc *s) | |
878 | { | |
879 | free(s->name); | |
e8719adf TZ |
880 | free(s->half_liner); |
881 | free(s->args); | |
4b9c0c59 TZ |
882 | free(s); |
883 | } | |
884 | ||
885 | static void script_desc__add(struct script_desc *s) | |
886 | { | |
887 | list_add_tail(&s->node, &script_descs); | |
888 | } | |
889 | ||
890 | static struct script_desc *script_desc__find(const char *name) | |
891 | { | |
892 | struct script_desc *s; | |
893 | ||
894 | list_for_each_entry(s, &script_descs, node) | |
895 | if (strcasecmp(s->name, name) == 0) | |
896 | return s; | |
897 | return NULL; | |
898 | } | |
899 | ||
900 | static struct script_desc *script_desc__findnew(const char *name) | |
901 | { | |
902 | struct script_desc *s = script_desc__find(name); | |
903 | ||
904 | if (s) | |
905 | return s; | |
906 | ||
907 | s = script_desc__new(name); | |
908 | if (!s) | |
909 | goto out_delete_desc; | |
910 | ||
911 | script_desc__add(s); | |
912 | ||
913 | return s; | |
914 | ||
915 | out_delete_desc: | |
916 | script_desc__delete(s); | |
917 | ||
918 | return NULL; | |
919 | } | |
920 | ||
965bb6be | 921 | static const char *ends_with(const char *str, const char *suffix) |
4b9c0c59 TZ |
922 | { |
923 | size_t suffix_len = strlen(suffix); | |
965bb6be | 924 | const char *p = str; |
4b9c0c59 TZ |
925 | |
926 | if (strlen(str) > suffix_len) { | |
927 | p = str + strlen(str) - suffix_len; | |
928 | if (!strncmp(p, suffix, suffix_len)) | |
929 | return p; | |
930 | } | |
931 | ||
932 | return NULL; | |
933 | } | |
934 | ||
4b9c0c59 TZ |
935 | static int read_script_info(struct script_desc *desc, const char *filename) |
936 | { | |
937 | char line[BUFSIZ], *p; | |
938 | FILE *fp; | |
939 | ||
940 | fp = fopen(filename, "r"); | |
941 | if (!fp) | |
942 | return -1; | |
943 | ||
944 | while (fgets(line, sizeof(line), fp)) { | |
945 | p = ltrim(line); | |
946 | if (strlen(p) == 0) | |
947 | continue; | |
948 | if (*p != '#') | |
949 | continue; | |
950 | p++; | |
951 | if (strlen(p) && *p == '!') | |
952 | continue; | |
953 | ||
954 | p = ltrim(p); | |
955 | if (strlen(p) && p[strlen(p) - 1] == '\n') | |
956 | p[strlen(p) - 1] = '\0'; | |
957 | ||
958 | if (!strncmp(p, "description:", strlen("description:"))) { | |
959 | p += strlen("description:"); | |
960 | desc->half_liner = strdup(ltrim(p)); | |
961 | continue; | |
962 | } | |
963 | ||
964 | if (!strncmp(p, "args:", strlen("args:"))) { | |
965 | p += strlen("args:"); | |
966 | desc->args = strdup(ltrim(p)); | |
967 | continue; | |
968 | } | |
969 | } | |
970 | ||
971 | fclose(fp); | |
972 | ||
973 | return 0; | |
974 | } | |
975 | ||
38efb539 RR |
976 | static char *get_script_root(struct dirent *script_dirent, const char *suffix) |
977 | { | |
978 | char *script_root, *str; | |
979 | ||
980 | script_root = strdup(script_dirent->d_name); | |
981 | if (!script_root) | |
982 | return NULL; | |
983 | ||
984 | str = (char *)ends_with(script_root, suffix); | |
985 | if (!str) { | |
986 | free(script_root); | |
987 | return NULL; | |
988 | } | |
989 | ||
990 | *str = '\0'; | |
991 | return script_root; | |
992 | } | |
993 | ||
1d037ca1 IT |
994 | static int list_available_scripts(const struct option *opt __maybe_unused, |
995 | const char *s __maybe_unused, | |
996 | int unset __maybe_unused) | |
4b9c0c59 TZ |
997 | { |
998 | struct dirent *script_next, *lang_next, script_dirent, lang_dirent; | |
999 | char scripts_path[MAXPATHLEN]; | |
1000 | DIR *scripts_dir, *lang_dir; | |
1001 | char script_path[MAXPATHLEN]; | |
1002 | char lang_path[MAXPATHLEN]; | |
1003 | struct script_desc *desc; | |
1004 | char first_half[BUFSIZ]; | |
1005 | char *script_root; | |
4b9c0c59 TZ |
1006 | |
1007 | snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); | |
1008 | ||
1009 | scripts_dir = opendir(scripts_path); | |
1010 | if (!scripts_dir) | |
1011 | return -1; | |
1012 | ||
008f29d3 | 1013 | for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { |
4b9c0c59 TZ |
1014 | snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, |
1015 | lang_dirent.d_name); | |
1016 | lang_dir = opendir(lang_path); | |
1017 | if (!lang_dir) | |
1018 | continue; | |
1019 | ||
008f29d3 | 1020 | for_each_script(lang_path, lang_dir, script_dirent, script_next) { |
38efb539 RR |
1021 | script_root = get_script_root(&script_dirent, REPORT_SUFFIX); |
1022 | if (script_root) { | |
4b9c0c59 TZ |
1023 | desc = script_desc__findnew(script_root); |
1024 | snprintf(script_path, MAXPATHLEN, "%s/%s", | |
1025 | lang_path, script_dirent.d_name); | |
1026 | read_script_info(desc, script_path); | |
38efb539 | 1027 | free(script_root); |
4b9c0c59 | 1028 | } |
4b9c0c59 TZ |
1029 | } |
1030 | } | |
1031 | ||
1032 | fprintf(stdout, "List of available trace scripts:\n"); | |
1033 | list_for_each_entry(desc, &script_descs, node) { | |
1034 | sprintf(first_half, "%s %s", desc->name, | |
1035 | desc->args ? desc->args : ""); | |
1036 | fprintf(stdout, " %-36s %s\n", first_half, | |
1037 | desc->half_liner ? desc->half_liner : ""); | |
1038 | } | |
1039 | ||
1040 | exit(0); | |
1041 | } | |
1042 | ||
49e639e2 FT |
1043 | /* |
1044 | * Some scripts specify the required events in their "xxx-record" file, | |
1045 | * this function will check if the events in perf.data match those | |
1046 | * mentioned in the "xxx-record". | |
1047 | * | |
1048 | * Fixme: All existing "xxx-record" are all in good formats "-e event ", | |
1049 | * which is covered well now. And new parsing code should be added to | |
1050 | * cover the future complexing formats like event groups etc. | |
1051 | */ | |
1052 | static int check_ev_match(char *dir_name, char *scriptname, | |
1053 | struct perf_session *session) | |
1054 | { | |
1055 | char filename[MAXPATHLEN], evname[128]; | |
1056 | char line[BUFSIZ], *p; | |
1057 | struct perf_evsel *pos; | |
1058 | int match, len; | |
1059 | FILE *fp; | |
1060 | ||
1061 | sprintf(filename, "%s/bin/%s-record", dir_name, scriptname); | |
1062 | ||
1063 | fp = fopen(filename, "r"); | |
1064 | if (!fp) | |
1065 | return -1; | |
1066 | ||
1067 | while (fgets(line, sizeof(line), fp)) { | |
1068 | p = ltrim(line); | |
1069 | if (*p == '#') | |
1070 | continue; | |
1071 | ||
1072 | while (strlen(p)) { | |
1073 | p = strstr(p, "-e"); | |
1074 | if (!p) | |
1075 | break; | |
1076 | ||
1077 | p += 2; | |
1078 | p = ltrim(p); | |
1079 | len = strcspn(p, " \t"); | |
1080 | if (!len) | |
1081 | break; | |
1082 | ||
1083 | snprintf(evname, len + 1, "%s", p); | |
1084 | ||
1085 | match = 0; | |
1086 | list_for_each_entry(pos, | |
1087 | &session->evlist->entries, node) { | |
1088 | if (!strcmp(perf_evsel__name(pos), evname)) { | |
1089 | match = 1; | |
1090 | break; | |
1091 | } | |
1092 | } | |
1093 | ||
1094 | if (!match) { | |
1095 | fclose(fp); | |
1096 | return -1; | |
1097 | } | |
1098 | } | |
1099 | } | |
1100 | ||
1101 | fclose(fp); | |
1102 | return 0; | |
1103 | } | |
1104 | ||
e5f3705e FT |
1105 | /* |
1106 | * Return -1 if none is found, otherwise the actual scripts number. | |
1107 | * | |
1108 | * Currently the only user of this function is the script browser, which | |
1109 | * will list all statically runnable scripts, select one, execute it and | |
1110 | * show the output in a perf browser. | |
1111 | */ | |
1112 | int find_scripts(char **scripts_array, char **scripts_path_array) | |
1113 | { | |
1114 | struct dirent *script_next, *lang_next, script_dirent, lang_dirent; | |
49e639e2 | 1115 | char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN]; |
e5f3705e | 1116 | DIR *scripts_dir, *lang_dir; |
49e639e2 | 1117 | struct perf_session *session; |
e5f3705e FT |
1118 | char *temp; |
1119 | int i = 0; | |
1120 | ||
49e639e2 FT |
1121 | session = perf_session__new(input_name, O_RDONLY, 0, false, NULL); |
1122 | if (!session) | |
1123 | return -1; | |
1124 | ||
e5f3705e FT |
1125 | snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); |
1126 | ||
1127 | scripts_dir = opendir(scripts_path); | |
49e639e2 FT |
1128 | if (!scripts_dir) { |
1129 | perf_session__delete(session); | |
e5f3705e | 1130 | return -1; |
49e639e2 | 1131 | } |
e5f3705e FT |
1132 | |
1133 | for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { | |
1134 | snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path, | |
1135 | lang_dirent.d_name); | |
1136 | #ifdef NO_LIBPERL | |
1137 | if (strstr(lang_path, "perl")) | |
1138 | continue; | |
1139 | #endif | |
1140 | #ifdef NO_LIBPYTHON | |
1141 | if (strstr(lang_path, "python")) | |
1142 | continue; | |
1143 | #endif | |
1144 | ||
1145 | lang_dir = opendir(lang_path); | |
1146 | if (!lang_dir) | |
1147 | continue; | |
1148 | ||
1149 | for_each_script(lang_path, lang_dir, script_dirent, script_next) { | |
1150 | /* Skip those real time scripts: xxxtop.p[yl] */ | |
1151 | if (strstr(script_dirent.d_name, "top.")) | |
1152 | continue; | |
1153 | sprintf(scripts_path_array[i], "%s/%s", lang_path, | |
1154 | script_dirent.d_name); | |
1155 | temp = strchr(script_dirent.d_name, '.'); | |
1156 | snprintf(scripts_array[i], | |
1157 | (temp - script_dirent.d_name) + 1, | |
1158 | "%s", script_dirent.d_name); | |
49e639e2 FT |
1159 | |
1160 | if (check_ev_match(lang_path, | |
1161 | scripts_array[i], session)) | |
1162 | continue; | |
1163 | ||
e5f3705e FT |
1164 | i++; |
1165 | } | |
49e639e2 | 1166 | closedir(lang_dir); |
e5f3705e FT |
1167 | } |
1168 | ||
49e639e2 FT |
1169 | closedir(scripts_dir); |
1170 | perf_session__delete(session); | |
e5f3705e FT |
1171 | return i; |
1172 | } | |
1173 | ||
3875294f TZ |
1174 | static char *get_script_path(const char *script_root, const char *suffix) |
1175 | { | |
1176 | struct dirent *script_next, *lang_next, script_dirent, lang_dirent; | |
1177 | char scripts_path[MAXPATHLEN]; | |
1178 | char script_path[MAXPATHLEN]; | |
1179 | DIR *scripts_dir, *lang_dir; | |
1180 | char lang_path[MAXPATHLEN]; | |
38efb539 | 1181 | char *__script_root; |
3875294f TZ |
1182 | |
1183 | snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path()); | |
1184 | ||
1185 | scripts_dir = opendir(scripts_path); | |
1186 | if (!scripts_dir) | |
1187 | return NULL; | |
1188 | ||
008f29d3 | 1189 | for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) { |
3875294f TZ |
1190 | snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path, |
1191 | lang_dirent.d_name); | |
1192 | lang_dir = opendir(lang_path); | |
1193 | if (!lang_dir) | |
1194 | continue; | |
1195 | ||
008f29d3 | 1196 | for_each_script(lang_path, lang_dir, script_dirent, script_next) { |
38efb539 RR |
1197 | __script_root = get_script_root(&script_dirent, suffix); |
1198 | if (__script_root && !strcmp(script_root, __script_root)) { | |
1199 | free(__script_root); | |
946ef2a2 NK |
1200 | closedir(lang_dir); |
1201 | closedir(scripts_dir); | |
3875294f TZ |
1202 | snprintf(script_path, MAXPATHLEN, "%s/%s", |
1203 | lang_path, script_dirent.d_name); | |
38efb539 | 1204 | return strdup(script_path); |
3875294f TZ |
1205 | } |
1206 | free(__script_root); | |
1207 | } | |
946ef2a2 | 1208 | closedir(lang_dir); |
3875294f | 1209 | } |
946ef2a2 | 1210 | closedir(scripts_dir); |
3875294f | 1211 | |
38efb539 | 1212 | return NULL; |
3875294f TZ |
1213 | } |
1214 | ||
b5b87312 TZ |
1215 | static bool is_top_script(const char *script_path) |
1216 | { | |
965bb6be | 1217 | return ends_with(script_path, "top") == NULL ? false : true; |
b5b87312 TZ |
1218 | } |
1219 | ||
1220 | static int has_required_arg(char *script_path) | |
1221 | { | |
1222 | struct script_desc *desc; | |
1223 | int n_args = 0; | |
1224 | char *p; | |
1225 | ||
1226 | desc = script_desc__new(NULL); | |
1227 | ||
1228 | if (read_script_info(desc, script_path)) | |
1229 | goto out; | |
1230 | ||
1231 | if (!desc->args) | |
1232 | goto out; | |
1233 | ||
1234 | for (p = desc->args; *p; p++) | |
1235 | if (*p == '<') | |
1236 | n_args++; | |
1237 | out: | |
1238 | script_desc__delete(desc); | |
1239 | ||
1240 | return n_args; | |
1241 | } | |
1242 | ||
69b6470e ACM |
1243 | static int have_cmd(int argc, const char **argv) |
1244 | { | |
1245 | char **__argv = malloc(sizeof(const char *) * argc); | |
1246 | ||
1247 | if (!__argv) { | |
1248 | pr_err("malloc failed\n"); | |
1249 | return -1; | |
1250 | } | |
1251 | ||
1252 | memcpy(__argv, argv, sizeof(const char *) * argc); | |
1253 | argc = parse_options(argc, (const char **)__argv, record_options, | |
1254 | NULL, PARSE_OPT_STOP_AT_NON_OPTION); | |
1255 | free(__argv); | |
5f9c39dc | 1256 | |
69b6470e ACM |
1257 | system_wide = (argc == 0); |
1258 | ||
1259 | return 0; | |
1260 | } | |
1261 | ||
1262 | int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused) | |
1263 | { | |
1264 | bool show_full_info = false; | |
69b6470e ACM |
1265 | char *rec_script_path = NULL; |
1266 | char *rep_script_path = NULL; | |
1267 | struct perf_session *session; | |
1268 | char *script_path = NULL; | |
1269 | const char **__argv; | |
1270 | int i, j, err; | |
1271 | const struct option options[] = { | |
5f9c39dc FW |
1272 | OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, |
1273 | "dump raw trace in ASCII"), | |
c0555642 | 1274 | OPT_INCR('v', "verbose", &verbose, |
69b6470e | 1275 | "be more verbose (show symbol address, etc)"), |
4b9c0c59 | 1276 | OPT_BOOLEAN('L', "Latency", &latency_format, |
cda48461 | 1277 | "show latency attributes (irqs/preemption disabled, etc)"), |
4b9c0c59 TZ |
1278 | OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts", |
1279 | list_available_scripts), | |
956ffd02 TZ |
1280 | OPT_CALLBACK('s', "script", NULL, "name", |
1281 | "script file name (lang:script name, script name, or *)", | |
1282 | parse_scriptname), | |
1283 | OPT_STRING('g', "gen-script", &generate_script_lang, "lang", | |
133dc4c3 | 1284 | "generate perf-script.xx script in specified language"), |
69b6470e | 1285 | OPT_STRING('i', "input", &input_name, "file", "input file name"), |
ffabd99e FW |
1286 | OPT_BOOLEAN('d', "debug-mode", &debug_mode, |
1287 | "do various checks like samples ordering and lost events"), | |
c0230b2b DA |
1288 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
1289 | "file", "vmlinux pathname"), | |
1290 | OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, | |
1291 | "file", "kallsyms pathname"), | |
1292 | OPT_BOOLEAN('G', "hide-call-graph", &no_callchain, | |
1293 | "When printing symbols do not display call chain"), | |
1294 | OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", | |
1295 | "Look for files with symbols relative to this directory"), | |
745f43e3 | 1296 | OPT_CALLBACK('f', "fields", NULL, "str", |
a978f2ab AN |
1297 | "comma separated output fields prepend with 'type:'. " |
1298 | "Valid types: hw,sw,trace,raw. " | |
1299 | "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso," | |
69b6470e | 1300 | "addr,symoff", parse_output_fields), |
317df650 | 1301 | OPT_BOOLEAN('a', "all-cpus", &system_wide, |
69b6470e | 1302 | "system-wide collection from all CPUs"), |
36385be5 FT |
1303 | OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]", |
1304 | "only consider these symbols"), | |
c8e66720 | 1305 | OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"), |
e7984b7b DA |
1306 | OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]", |
1307 | "only display events for these comms"), | |
fbe96f29 SE |
1308 | OPT_BOOLEAN('I', "show-info", &show_full_info, |
1309 | "display extended information from perf.data file"), | |
0bc8d205 AN |
1310 | OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path, |
1311 | "Show the path of [kernel.kallsyms]"), | |
1909629f | 1312 | OPT_END() |
69b6470e ACM |
1313 | }; |
1314 | const char * const script_usage[] = { | |
1315 | "perf script [<options>]", | |
1316 | "perf script [<options>] record <script> [<record-options>] <command>", | |
1317 | "perf script [<options>] report <script> [script-args]", | |
1318 | "perf script [<options>] <script> [<record-options>] <command>", | |
1319 | "perf script [<options>] <top-script> [script-args]", | |
1320 | NULL | |
1321 | }; | |
3875294f | 1322 | |
b5b87312 TZ |
1323 | setup_scripting(); |
1324 | ||
133dc4c3 | 1325 | argc = parse_options(argc, argv, options, script_usage, |
b5b87312 TZ |
1326 | PARSE_OPT_STOP_AT_NON_OPTION); |
1327 | ||
1328 | if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) { | |
1329 | rec_script_path = get_script_path(argv[1], RECORD_SUFFIX); | |
1330 | if (!rec_script_path) | |
1331 | return cmd_record(argc, argv, NULL); | |
3875294f TZ |
1332 | } |
1333 | ||
b5b87312 TZ |
1334 | if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) { |
1335 | rep_script_path = get_script_path(argv[1], REPORT_SUFFIX); | |
1336 | if (!rep_script_path) { | |
3875294f | 1337 | fprintf(stderr, |
b5b87312 | 1338 | "Please specify a valid report script" |
133dc4c3 | 1339 | "(see 'perf script -l' for listing)\n"); |
3875294f TZ |
1340 | return -1; |
1341 | } | |
3875294f TZ |
1342 | } |
1343 | ||
44e668c6 BH |
1344 | /* make sure PERF_EXEC_PATH is set for scripts */ |
1345 | perf_set_argv_exec_path(perf_exec_path()); | |
1346 | ||
b5b87312 | 1347 | if (argc && !script_name && !rec_script_path && !rep_script_path) { |
a0cccc2e | 1348 | int live_pipe[2]; |
b5b87312 | 1349 | int rep_args; |
a0cccc2e TZ |
1350 | pid_t pid; |
1351 | ||
b5b87312 TZ |
1352 | rec_script_path = get_script_path(argv[0], RECORD_SUFFIX); |
1353 | rep_script_path = get_script_path(argv[0], REPORT_SUFFIX); | |
1354 | ||
1355 | if (!rec_script_path && !rep_script_path) { | |
1356 | fprintf(stderr, " Couldn't find script %s\n\n See perf" | |
133dc4c3 IM |
1357 | " script -l for available scripts.\n", argv[0]); |
1358 | usage_with_options(script_usage, options); | |
a0cccc2e TZ |
1359 | } |
1360 | ||
b5b87312 TZ |
1361 | if (is_top_script(argv[0])) { |
1362 | rep_args = argc - 1; | |
1363 | } else { | |
1364 | int rec_args; | |
1365 | ||
1366 | rep_args = has_required_arg(rep_script_path); | |
1367 | rec_args = (argc - 1) - rep_args; | |
1368 | if (rec_args < 0) { | |
1369 | fprintf(stderr, " %s script requires options." | |
133dc4c3 | 1370 | "\n\n See perf script -l for available " |
b5b87312 | 1371 | "scripts and options.\n", argv[0]); |
133dc4c3 | 1372 | usage_with_options(script_usage, options); |
b5b87312 | 1373 | } |
a0cccc2e TZ |
1374 | } |
1375 | ||
1376 | if (pipe(live_pipe) < 0) { | |
1377 | perror("failed to create pipe"); | |
d54b1a9e | 1378 | return -1; |
a0cccc2e TZ |
1379 | } |
1380 | ||
1381 | pid = fork(); | |
1382 | if (pid < 0) { | |
1383 | perror("failed to fork"); | |
d54b1a9e | 1384 | return -1; |
a0cccc2e TZ |
1385 | } |
1386 | ||
1387 | if (!pid) { | |
b5b87312 TZ |
1388 | j = 0; |
1389 | ||
a0cccc2e TZ |
1390 | dup2(live_pipe[1], 1); |
1391 | close(live_pipe[0]); | |
1392 | ||
317df650 RR |
1393 | if (is_top_script(argv[0])) { |
1394 | system_wide = true; | |
1395 | } else if (!system_wide) { | |
d54b1a9e DA |
1396 | if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) { |
1397 | err = -1; | |
1398 | goto out; | |
1399 | } | |
317df650 | 1400 | } |
b5b87312 TZ |
1401 | |
1402 | __argv = malloc((argc + 6) * sizeof(const char *)); | |
d54b1a9e DA |
1403 | if (!__argv) { |
1404 | pr_err("malloc failed\n"); | |
1405 | err = -ENOMEM; | |
1406 | goto out; | |
1407 | } | |
e8719adf | 1408 | |
b5b87312 TZ |
1409 | __argv[j++] = "/bin/sh"; |
1410 | __argv[j++] = rec_script_path; | |
1411 | if (system_wide) | |
1412 | __argv[j++] = "-a"; | |
1413 | __argv[j++] = "-q"; | |
1414 | __argv[j++] = "-o"; | |
1415 | __argv[j++] = "-"; | |
1416 | for (i = rep_args + 1; i < argc; i++) | |
1417 | __argv[j++] = argv[i]; | |
1418 | __argv[j++] = NULL; | |
a0cccc2e TZ |
1419 | |
1420 | execvp("/bin/sh", (char **)__argv); | |
e8719adf | 1421 | free(__argv); |
a0cccc2e TZ |
1422 | exit(-1); |
1423 | } | |
1424 | ||
1425 | dup2(live_pipe[0], 0); | |
1426 | close(live_pipe[1]); | |
1427 | ||
b5b87312 | 1428 | __argv = malloc((argc + 4) * sizeof(const char *)); |
d54b1a9e DA |
1429 | if (!__argv) { |
1430 | pr_err("malloc failed\n"); | |
1431 | err = -ENOMEM; | |
1432 | goto out; | |
1433 | } | |
1434 | ||
b5b87312 TZ |
1435 | j = 0; |
1436 | __argv[j++] = "/bin/sh"; | |
1437 | __argv[j++] = rep_script_path; | |
1438 | for (i = 1; i < rep_args + 1; i++) | |
1439 | __argv[j++] = argv[i]; | |
1440 | __argv[j++] = "-i"; | |
1441 | __argv[j++] = "-"; | |
1442 | __argv[j++] = NULL; | |
a0cccc2e TZ |
1443 | |
1444 | execvp("/bin/sh", (char **)__argv); | |
e8719adf | 1445 | free(__argv); |
a0cccc2e TZ |
1446 | exit(-1); |
1447 | } | |
1448 | ||
b5b87312 TZ |
1449 | if (rec_script_path) |
1450 | script_path = rec_script_path; | |
1451 | if (rep_script_path) | |
1452 | script_path = rep_script_path; | |
34c86ea9 | 1453 | |
b5b87312 | 1454 | if (script_path) { |
b5b87312 | 1455 | j = 0; |
3875294f | 1456 | |
317df650 RR |
1457 | if (!rec_script_path) |
1458 | system_wide = false; | |
d54b1a9e DA |
1459 | else if (!system_wide) { |
1460 | if (have_cmd(argc - 1, &argv[1]) != 0) { | |
1461 | err = -1; | |
1462 | goto out; | |
1463 | } | |
1464 | } | |
34c86ea9 | 1465 | |
b5b87312 | 1466 | __argv = malloc((argc + 2) * sizeof(const char *)); |
d54b1a9e DA |
1467 | if (!__argv) { |
1468 | pr_err("malloc failed\n"); | |
1469 | err = -ENOMEM; | |
1470 | goto out; | |
1471 | } | |
1472 | ||
34c86ea9 TZ |
1473 | __argv[j++] = "/bin/sh"; |
1474 | __argv[j++] = script_path; | |
1475 | if (system_wide) | |
1476 | __argv[j++] = "-a"; | |
b5b87312 | 1477 | for (i = 2; i < argc; i++) |
34c86ea9 TZ |
1478 | __argv[j++] = argv[i]; |
1479 | __argv[j++] = NULL; | |
3875294f TZ |
1480 | |
1481 | execvp("/bin/sh", (char **)__argv); | |
e8719adf | 1482 | free(__argv); |
3875294f TZ |
1483 | exit(-1); |
1484 | } | |
956ffd02 | 1485 | |
655000e7 ACM |
1486 | if (symbol__init() < 0) |
1487 | return -1; | |
cf4fee50 TZ |
1488 | if (!script_name) |
1489 | setup_pager(); | |
5f9c39dc | 1490 | |
da378962 | 1491 | session = perf_session__new(input_name, O_RDONLY, 0, false, |
97822433 | 1492 | &perf_script); |
d8f66248 ACM |
1493 | if (session == NULL) |
1494 | return -ENOMEM; | |
1495 | ||
5d67be97 AB |
1496 | if (cpu_list) { |
1497 | if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap)) | |
1498 | return -1; | |
1499 | } | |
1500 | ||
bdb71db2 TZ |
1501 | if (!script_name && !generate_script_lang) |
1502 | perf_session__fprintf_info(session, stdout, show_full_info); | |
fbe96f29 | 1503 | |
1424dc96 | 1504 | if (!no_callchain) |
c0230b2b DA |
1505 | symbol_conf.use_callchain = true; |
1506 | else | |
1507 | symbol_conf.use_callchain = false; | |
1508 | ||
956ffd02 TZ |
1509 | if (generate_script_lang) { |
1510 | struct stat perf_stat; | |
745f43e3 DA |
1511 | int input; |
1512 | ||
2c9e45f7 | 1513 | if (output_set_by_user()) { |
745f43e3 DA |
1514 | fprintf(stderr, |
1515 | "custom fields not supported for generated scripts"); | |
1516 | return -1; | |
1517 | } | |
956ffd02 | 1518 | |
efad1415 | 1519 | input = open(session->filename, O_RDONLY); /* input_name */ |
956ffd02 TZ |
1520 | if (input < 0) { |
1521 | perror("failed to open file"); | |
d54b1a9e | 1522 | return -1; |
956ffd02 TZ |
1523 | } |
1524 | ||
1525 | err = fstat(input, &perf_stat); | |
1526 | if (err < 0) { | |
1527 | perror("failed to stat file"); | |
d54b1a9e | 1528 | return -1; |
956ffd02 TZ |
1529 | } |
1530 | ||
1531 | if (!perf_stat.st_size) { | |
1532 | fprintf(stderr, "zero-sized file, nothing to do!\n"); | |
d54b1a9e | 1533 | return 0; |
956ffd02 TZ |
1534 | } |
1535 | ||
1536 | scripting_ops = script_spec__lookup(generate_script_lang); | |
1537 | if (!scripting_ops) { | |
1538 | fprintf(stderr, "invalid language specifier"); | |
1539 | return -1; | |
1540 | } | |
1541 | ||
da378962 ACM |
1542 | err = scripting_ops->generate_script(session->pevent, |
1543 | "perf-script"); | |
956ffd02 TZ |
1544 | goto out; |
1545 | } | |
1546 | ||
1547 | if (script_name) { | |
586bc5cc | 1548 | err = scripting_ops->start_script(script_name, argc, argv); |
956ffd02 TZ |
1549 | if (err) |
1550 | goto out; | |
133dc4c3 | 1551 | pr_debug("perf script started with script %s\n\n", script_name); |
956ffd02 TZ |
1552 | } |
1553 | ||
9cbdb702 DA |
1554 | |
1555 | err = perf_session__check_output_opt(session); | |
1556 | if (err < 0) | |
1557 | goto out; | |
1558 | ||
133dc4c3 | 1559 | err = __cmd_script(session); |
956ffd02 | 1560 | |
d8f66248 | 1561 | perf_session__delete(session); |
956ffd02 TZ |
1562 | cleanup_scripting(); |
1563 | out: | |
1564 | return err; | |
5f9c39dc | 1565 | } |