]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - tools/perf/tests/code-reading.c
Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[mirror_ubuntu-focal-kernel.git] / tools / perf / tests / code-reading.c
CommitLineData
a43783ae 1#include <errno.h>
877a7a11 2#include <linux/kernel.h>
d944c4ee 3#include <linux/types.h>
fd20e811 4#include <inttypes.h>
b55ae0a9
AH
5#include <stdlib.h>
6#include <unistd.h>
7#include <stdio.h>
b55ae0a9 8#include <string.h>
391e4206 9#include <sys/param.h>
b55ae0a9
AH
10
11#include "parse-events.h"
12#include "evlist.h"
13#include "evsel.h"
14#include "thread_map.h"
15#include "cpumap.h"
16#include "machine.h"
17#include "event.h"
18#include "thread.h"
19
20#include "tests.h"
21
3d689ed6
ACM
22#include "sane_ctype.h"
23
b55ae0a9
AH
24#define BUFSZ 1024
25#define READLEN 128
26
7a77bc2c
AH
27struct state {
28 u64 done[1024];
29 size_t done_cnt;
30};
31
b55ae0a9
AH
32static unsigned int hex(char c)
33{
34 if (c >= '0' && c <= '9')
35 return c - '0';
36 if (c >= 'a' && c <= 'f')
37 return c - 'a' + 10;
38 return c - 'A' + 10;
39}
40
b2d0dbf0
JS
41static size_t read_objdump_chunk(const char **line, unsigned char **buf,
42 size_t *buf_len)
b55ae0a9 43{
b2d0dbf0
JS
44 size_t bytes_read = 0;
45 unsigned char *chunk_start = *buf;
b55ae0a9
AH
46
47 /* Read bytes */
b2d0dbf0 48 while (*buf_len > 0) {
b55ae0a9
AH
49 char c1, c2;
50
b55ae0a9 51 /* Get 2 hex digits */
b2d0dbf0
JS
52 c1 = *(*line)++;
53 if (!isxdigit(c1))
b55ae0a9 54 break;
b2d0dbf0
JS
55 c2 = *(*line)++;
56 if (!isxdigit(c2))
b55ae0a9 57 break;
b2d0dbf0
JS
58
59 /* Store byte and advance buf */
60 **buf = (hex(c1) << 4) | hex(c2);
61 (*buf)++;
62 (*buf_len)--;
63 bytes_read++;
64
65 /* End of chunk? */
66 if (isspace(**line))
b55ae0a9 67 break;
b55ae0a9 68 }
b2d0dbf0
JS
69
70 /*
71 * objdump will display raw insn as LE if code endian
72 * is LE and bytes_per_chunk > 1. In that case reverse
73 * the chunk we just read.
74 *
75 * see disassemble_bytes() at binutils/objdump.c for details
76 * how objdump chooses display endian)
77 */
78 if (bytes_read > 1 && !bigendian()) {
79 unsigned char *chunk_end = chunk_start + bytes_read - 1;
80 unsigned char tmp;
81
82 while (chunk_start < chunk_end) {
83 tmp = *chunk_start;
84 *chunk_start = *chunk_end;
85 *chunk_end = tmp;
86 chunk_start++;
87 chunk_end--;
88 }
89 }
90
91 return bytes_read;
92}
93
94static size_t read_objdump_line(const char *line, unsigned char *buf,
95 size_t buf_len)
96{
97 const char *p;
98 size_t ret, bytes_read = 0;
99
100 /* Skip to a colon */
101 p = strchr(line, ':');
102 if (!p)
103 return 0;
104 p++;
105
106 /* Skip initial spaces */
107 while (*p) {
108 if (!isspace(*p))
109 break;
110 p++;
111 }
112
113 do {
114 ret = read_objdump_chunk(&p, &buf, &buf_len);
115 bytes_read += ret;
116 p++;
117 } while (ret > 0);
118
729a7ed1 119 /* return number of successfully read bytes */
b2d0dbf0 120 return bytes_read;
b55ae0a9
AH
121}
122
729a7ed1 123static int read_objdump_output(FILE *f, void *buf, size_t *len, u64 start_addr)
b55ae0a9
AH
124{
125 char *line = NULL;
729a7ed1 126 size_t line_len, off_last = 0;
b55ae0a9
AH
127 ssize_t ret;
128 int err = 0;
edfdb7ea 129 u64 addr, last_addr = start_addr;
729a7ed1
JS
130
131 while (off_last < *len) {
132 size_t off, read_bytes, written_bytes;
133 unsigned char tmp[BUFSZ];
b55ae0a9 134
b55ae0a9
AH
135 ret = getline(&line, &line_len, f);
136 if (feof(f))
137 break;
138 if (ret < 0) {
139 pr_debug("getline failed\n");
140 err = -1;
141 break;
142 }
729a7ed1
JS
143
144 /* read objdump data into temporary buffer */
b2d0dbf0 145 read_bytes = read_objdump_line(line, tmp, sizeof(tmp));
729a7ed1
JS
146 if (!read_bytes)
147 continue;
148
149 if (sscanf(line, "%"PRIx64, &addr) != 1)
150 continue;
edfdb7ea
JS
151 if (addr < last_addr) {
152 pr_debug("addr going backwards, read beyond section?\n");
153 break;
154 }
155 last_addr = addr;
729a7ed1
JS
156
157 /* copy it from temporary buffer to 'buf' according
158 * to address on current objdump line */
159 off = addr - start_addr;
160 if (off >= *len)
161 break;
162 written_bytes = MIN(read_bytes, *len - off);
163 memcpy(buf + off, tmp, written_bytes);
164 off_last = off + written_bytes;
b55ae0a9
AH
165 }
166
729a7ed1
JS
167 /* len returns number of bytes that could not be read */
168 *len -= off_last;
169
b55ae0a9
AH
170 free(line);
171
172 return err;
173}
174
175static int read_via_objdump(const char *filename, u64 addr, void *buf,
176 size_t len)
177{
178 char cmd[PATH_MAX * 2];
179 const char *fmt;
180 FILE *f;
181 int ret;
182
06f679c1 183 fmt = "%s -z -d --start-address=0x%"PRIx64" --stop-address=0x%"PRIx64" %s";
b55ae0a9
AH
184 ret = snprintf(cmd, sizeof(cmd), fmt, "objdump", addr, addr + len,
185 filename);
186 if (ret <= 0 || (size_t)ret >= sizeof(cmd))
187 return -1;
188
189 pr_debug("Objdump command is: %s\n", cmd);
190
7a77bc2c
AH
191 /* Ignore objdump errors */
192 strcat(cmd, " 2>/dev/null");
193
b55ae0a9
AH
194 f = popen(cmd, "r");
195 if (!f) {
196 pr_debug("popen failed\n");
197 return -1;
198 }
199
729a7ed1 200 ret = read_objdump_output(f, buf, &len, addr);
b55ae0a9 201 if (len) {
b2d0dbf0 202 pr_debug("objdump read too few bytes: %zd\n", len);
b55ae0a9
AH
203 if (!ret)
204 ret = len;
205 }
206
207 pclose(f);
208
209 return ret;
210}
211
fd405cf6
JS
212static void dump_buf(unsigned char *buf, size_t len)
213{
214 size_t i;
215
216 for (i = 0; i < len; i++) {
217 pr_debug("0x%02x ", buf[i]);
218 if (i % 16 == 15)
219 pr_debug("\n");
220 }
221 pr_debug("\n");
222}
223
b55ae0a9 224static int read_object_code(u64 addr, size_t len, u8 cpumode,
29f9e521 225 struct thread *thread, struct state *state)
b55ae0a9
AH
226{
227 struct addr_location al;
228 unsigned char buf1[BUFSZ];
229 unsigned char buf2[BUFSZ];
230 size_t ret_len;
231 u64 objdump_addr;
94df1040
NK
232 const char *objdump_name;
233 char decomp_name[KMOD_DECOMP_LEN];
b55ae0a9
AH
234 int ret;
235
236 pr_debug("Reading object code for memory address: %#"PRIx64"\n", addr);
237
bb871a9c 238 thread__find_addr_map(thread, cpumode, MAP__FUNCTION, addr, &al);
b55ae0a9 239 if (!al.map || !al.map->dso) {
9a805d86
RB
240 if (cpumode == PERF_RECORD_MISC_HYPERVISOR) {
241 pr_debug("Hypervisor address can not be resolved - skipping\n");
242 return 0;
243 }
244
b55ae0a9
AH
245 pr_debug("thread__find_addr_map failed\n");
246 return -1;
247 }
248
249 pr_debug("File is: %s\n", al.map->dso->long_name);
250
7a77bc2c
AH
251 if (al.map->dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
252 !dso__is_kcore(al.map->dso)) {
b55ae0a9
AH
253 pr_debug("Unexpected kernel address - skipping\n");
254 return 0;
255 }
256
257 pr_debug("On file address is: %#"PRIx64"\n", al.addr);
258
259 if (len > BUFSZ)
260 len = BUFSZ;
261
262 /* Do not go off the map */
263 if (addr + len > al.map->end)
264 len = al.map->end - addr;
265
266 /* Read the object code using perf */
29f9e521
ACM
267 ret_len = dso__data_read_offset(al.map->dso, thread->mg->machine,
268 al.addr, buf1, len);
b55ae0a9
AH
269 if (ret_len != len) {
270 pr_debug("dso__data_read_offset failed\n");
271 return -1;
272 }
273
274 /*
275 * Converting addresses for use by objdump requires more information.
276 * map__load() does that. See map__rip_2objdump() for details.
277 */
be39db9f 278 if (map__load(al.map))
b55ae0a9
AH
279 return -1;
280
7a77bc2c
AH
281 /* objdump struggles with kcore - try each map only once */
282 if (dso__is_kcore(al.map->dso)) {
283 size_t d;
284
285 for (d = 0; d < state->done_cnt; d++) {
286 if (state->done[d] == al.map->start) {
287 pr_debug("kcore map tested already");
288 pr_debug(" - skipping\n");
289 return 0;
290 }
291 }
292 if (state->done_cnt >= ARRAY_SIZE(state->done)) {
293 pr_debug("Too many kcore maps - skipping\n");
294 return 0;
295 }
296 state->done[state->done_cnt++] = al.map->start;
297 }
298
94df1040
NK
299 objdump_name = al.map->dso->long_name;
300 if (dso__needs_decompress(al.map->dso)) {
301 if (dso__decompress_kmodule_path(al.map->dso, objdump_name,
302 decomp_name,
303 sizeof(decomp_name)) < 0) {
304 pr_debug("decompression failed\n");
305 return -1;
306 }
307
308 objdump_name = decomp_name;
309 }
310
b55ae0a9
AH
311 /* Read the object code using objdump */
312 objdump_addr = map__rip_2objdump(al.map, al.addr);
94df1040
NK
313 ret = read_via_objdump(objdump_name, objdump_addr, buf2, len);
314
315 if (dso__needs_decompress(al.map->dso))
316 unlink(objdump_name);
317
b55ae0a9
AH
318 if (ret > 0) {
319 /*
320 * The kernel maps are inaccurate - assume objdump is right in
321 * that case.
322 */
323 if (cpumode == PERF_RECORD_MISC_KERNEL ||
324 cpumode == PERF_RECORD_MISC_GUEST_KERNEL) {
325 len -= ret;
7a77bc2c 326 if (len) {
b55ae0a9 327 pr_debug("Reducing len to %zu\n", len);
7a77bc2c
AH
328 } else if (dso__is_kcore(al.map->dso)) {
329 /*
330 * objdump cannot handle very large segments
331 * that may be found in kcore.
332 */
333 pr_debug("objdump failed for kcore");
334 pr_debug(" - skipping\n");
335 return 0;
336 } else {
b55ae0a9 337 return -1;
7a77bc2c 338 }
b55ae0a9
AH
339 }
340 }
341 if (ret < 0) {
342 pr_debug("read_via_objdump failed\n");
343 return -1;
344 }
345
346 /* The results should be identical */
347 if (memcmp(buf1, buf2, len)) {
348 pr_debug("Bytes read differ from those read by objdump\n");
fd405cf6
JS
349 pr_debug("buf1 (dso):\n");
350 dump_buf(buf1, len);
351 pr_debug("buf2 (objdump):\n");
352 dump_buf(buf2, len);
b55ae0a9
AH
353 return -1;
354 }
355 pr_debug("Bytes read match those read by objdump\n");
356
357 return 0;
358}
359
360static int process_sample_event(struct machine *machine,
361 struct perf_evlist *evlist,
7a77bc2c 362 union perf_event *event, struct state *state)
b55ae0a9
AH
363{
364 struct perf_sample sample;
365 struct thread *thread;
b91fc39f 366 int ret;
b55ae0a9
AH
367
368 if (perf_evlist__parse_sample(evlist, event, &sample)) {
369 pr_debug("perf_evlist__parse_sample failed\n");
370 return -1;
371 }
372
13ce34df 373 thread = machine__findnew_thread(machine, sample.pid, sample.tid);
b55ae0a9
AH
374 if (!thread) {
375 pr_debug("machine__findnew_thread failed\n");
376 return -1;
377 }
378
473398a2 379 ret = read_object_code(sample.ip, READLEN, sample.cpumode, thread, state);
b91fc39f
ACM
380 thread__put(thread);
381 return ret;
b55ae0a9
AH
382}
383
384static int process_event(struct machine *machine, struct perf_evlist *evlist,
7a77bc2c 385 union perf_event *event, struct state *state)
b55ae0a9
AH
386{
387 if (event->header.type == PERF_RECORD_SAMPLE)
7a77bc2c 388 return process_sample_event(machine, evlist, event, state);
b55ae0a9 389
48095b72
AH
390 if (event->header.type == PERF_RECORD_THROTTLE ||
391 event->header.type == PERF_RECORD_UNTHROTTLE)
392 return 0;
393
394 if (event->header.type < PERF_RECORD_MAX) {
395 int ret;
396
397 ret = machine__process_event(machine, event, NULL);
398 if (ret < 0)
399 pr_debug("machine__process_event failed, event type %u\n",
400 event->header.type);
401 return ret;
402 }
b55ae0a9
AH
403
404 return 0;
405}
406
7a77bc2c
AH
407static int process_events(struct machine *machine, struct perf_evlist *evlist,
408 struct state *state)
b55ae0a9
AH
409{
410 union perf_event *event;
411 int i, ret;
412
413 for (i = 0; i < evlist->nr_mmaps; i++) {
414 while ((event = perf_evlist__mmap_read(evlist, i)) != NULL) {
7a77bc2c 415 ret = process_event(machine, evlist, event, state);
8e50d384 416 perf_evlist__mmap_consume(evlist, i);
b55ae0a9
AH
417 if (ret < 0)
418 return ret;
419 }
420 }
421 return 0;
422}
423
424static int comp(const void *a, const void *b)
425{
426 return *(int *)a - *(int *)b;
427}
428
429static void do_sort_something(void)
430{
309b5185 431 int buf[40960], i;
b55ae0a9 432
309b5185
DA
433 for (i = 0; i < (int)ARRAY_SIZE(buf); i++)
434 buf[i] = ARRAY_SIZE(buf) - i - 1;
b55ae0a9 435
309b5185 436 qsort(buf, ARRAY_SIZE(buf), sizeof(int), comp);
b55ae0a9 437
309b5185 438 for (i = 0; i < (int)ARRAY_SIZE(buf); i++) {
b55ae0a9
AH
439 if (buf[i] != i) {
440 pr_debug("qsort failed\n");
441 break;
442 }
443 }
444}
445
446static void sort_something(void)
447{
448 int i;
449
450 for (i = 0; i < 10; i++)
451 do_sort_something();
452}
453
454static void syscall_something(void)
455{
456 int pipefd[2];
457 int i;
458
459 for (i = 0; i < 1000; i++) {
460 if (pipe(pipefd) < 0) {
461 pr_debug("pipe failed\n");
462 break;
463 }
464 close(pipefd[1]);
465 close(pipefd[0]);
466 }
467}
468
469static void fs_something(void)
470{
471 const char *test_file_name = "temp-perf-code-reading-test-file--";
472 FILE *f;
473 int i;
474
475 for (i = 0; i < 1000; i++) {
476 f = fopen(test_file_name, "w+");
477 if (f) {
478 fclose(f);
479 unlink(test_file_name);
480 }
481 }
482}
483
484static void do_something(void)
485{
486 fs_something();
487
488 sort_something();
489
490 syscall_something();
491}
492
493enum {
494 TEST_CODE_READING_OK,
495 TEST_CODE_READING_NO_VMLINUX,
7a77bc2c 496 TEST_CODE_READING_NO_KCORE,
b55ae0a9 497 TEST_CODE_READING_NO_ACCESS,
7a77bc2c 498 TEST_CODE_READING_NO_KERNEL_OBJ,
b55ae0a9
AH
499};
500
7a77bc2c 501static int do_test_code_reading(bool try_kcore)
b55ae0a9 502{
b55ae0a9
AH
503 struct machine *machine;
504 struct thread *thread;
b4006796 505 struct record_opts opts = {
b55ae0a9
AH
506 .mmap_pages = UINT_MAX,
507 .user_freq = UINT_MAX,
508 .user_interval = ULLONG_MAX,
5243ba76 509 .freq = 500,
b55ae0a9
AH
510 .target = {
511 .uses_mmap = true,
512 },
513 };
7a77bc2c
AH
514 struct state state = {
515 .done_cnt = 0,
516 };
b55ae0a9
AH
517 struct thread_map *threads = NULL;
518 struct cpu_map *cpus = NULL;
519 struct perf_evlist *evlist = NULL;
520 struct perf_evsel *evsel = NULL;
521 int err = -1, ret;
522 pid_t pid;
523 struct map *map;
7a77bc2c 524 bool have_vmlinux, have_kcore, excl_kernel = false;
b55ae0a9
AH
525
526 pid = getpid();
527
0fd4008e 528 machine = machine__new_host();
b55ae0a9
AH
529
530 ret = machine__create_kernel_maps(machine);
531 if (ret < 0) {
532 pr_debug("machine__create_kernel_maps failed\n");
533 goto out_err;
534 }
535
7a77bc2c
AH
536 /* Force the use of kallsyms instead of vmlinux to try kcore */
537 if (try_kcore)
538 symbol_conf.kallsyms_name = "/proc/kallsyms";
539
b55ae0a9 540 /* Load kernel map */
a5e813c6 541 map = machine__kernel_map(machine);
be39db9f 542 ret = map__load(map);
b55ae0a9
AH
543 if (ret < 0) {
544 pr_debug("map__load failed\n");
545 goto out_err;
546 }
7a77bc2c
AH
547 have_vmlinux = dso__is_vmlinux(map->dso);
548 have_kcore = dso__is_kcore(map->dso);
549
550 /* 2nd time through we just try kcore */
551 if (try_kcore && !have_kcore)
552 return TEST_CODE_READING_NO_KCORE;
553
554 /* No point getting kernel events if there is no kernel object */
555 if (!have_vmlinux && !have_kcore)
b55ae0a9
AH
556 excl_kernel = true;
557
558 threads = thread_map__new_by_tid(pid);
559 if (!threads) {
560 pr_debug("thread_map__new_by_tid failed\n");
561 goto out_err;
562 }
563
564 ret = perf_event__synthesize_thread_map(NULL, threads,
9d9cad76 565 perf_event__process, machine, false, 500);
b55ae0a9
AH
566 if (ret < 0) {
567 pr_debug("perf_event__synthesize_thread_map failed\n");
568 goto out_err;
569 }
570
314add6b 571 thread = machine__findnew_thread(machine, pid, pid);
b55ae0a9
AH
572 if (!thread) {
573 pr_debug("machine__findnew_thread failed\n");
b91fc39f 574 goto out_put;
b55ae0a9
AH
575 }
576
577 cpus = cpu_map__new(NULL);
578 if (!cpus) {
579 pr_debug("cpu_map__new failed\n");
b91fc39f 580 goto out_put;
b55ae0a9
AH
581 }
582
583 while (1) {
584 const char *str;
585
586 evlist = perf_evlist__new();
587 if (!evlist) {
588 pr_debug("perf_evlist__new failed\n");
b91fc39f 589 goto out_put;
b55ae0a9
AH
590 }
591
592 perf_evlist__set_maps(evlist, cpus, threads);
593
594 if (excl_kernel)
595 str = "cycles:u";
596 else
597 str = "cycles";
598 pr_debug("Parsing event '%s'\n", str);
b39b8393 599 ret = parse_events(evlist, str, NULL);
b55ae0a9
AH
600 if (ret < 0) {
601 pr_debug("parse_events failed\n");
b91fc39f 602 goto out_put;
b55ae0a9
AH
603 }
604
e68ae9cf 605 perf_evlist__config(evlist, &opts, NULL);
b55ae0a9
AH
606
607 evsel = perf_evlist__first(evlist);
608
609 evsel->attr.comm = 1;
610 evsel->attr.disabled = 1;
611 evsel->attr.enable_on_exec = 0;
612
613 ret = perf_evlist__open(evlist);
614 if (ret < 0) {
615 if (!excl_kernel) {
616 excl_kernel = true;
7320b1b3
JO
617 /*
618 * Both cpus and threads are now owned by evlist
619 * and will be freed by following perf_evlist__set_maps
620 * call. Getting refference to keep them alive.
621 */
622 cpu_map__get(cpus);
623 thread_map__get(threads);
ae450a7d 624 perf_evlist__set_maps(evlist, NULL, NULL);
b55ae0a9
AH
625 perf_evlist__delete(evlist);
626 evlist = NULL;
627 continue;
628 }
6880bbf9 629
bb963e16 630 if (verbose > 0) {
6880bbf9
ACM
631 char errbuf[512];
632 perf_evlist__strerror_open(evlist, errno, errbuf, sizeof(errbuf));
633 pr_debug("perf_evlist__open() failed!\n%s\n", errbuf);
634 }
635
b91fc39f 636 goto out_put;
b55ae0a9
AH
637 }
638 break;
639 }
640
641 ret = perf_evlist__mmap(evlist, UINT_MAX, false);
642 if (ret < 0) {
643 pr_debug("perf_evlist__mmap failed\n");
b91fc39f 644 goto out_put;
b55ae0a9
AH
645 }
646
647 perf_evlist__enable(evlist);
648
649 do_something();
650
651 perf_evlist__disable(evlist);
652
7a77bc2c 653 ret = process_events(machine, evlist, &state);
b55ae0a9 654 if (ret < 0)
b91fc39f 655 goto out_put;
b55ae0a9 656
7a77bc2c
AH
657 if (!have_vmlinux && !have_kcore && !try_kcore)
658 err = TEST_CODE_READING_NO_KERNEL_OBJ;
659 else if (!have_vmlinux && !try_kcore)
b55ae0a9
AH
660 err = TEST_CODE_READING_NO_VMLINUX;
661 else if (excl_kernel)
662 err = TEST_CODE_READING_NO_ACCESS;
663 else
664 err = TEST_CODE_READING_OK;
b91fc39f
ACM
665out_put:
666 thread__put(thread);
b55ae0a9 667out_err:
b91fc39f 668
b55ae0a9 669 if (evlist) {
b55ae0a9 670 perf_evlist__delete(evlist);
03ad9747 671 } else {
f30a79b0 672 cpu_map__put(cpus);
186fbb74 673 thread_map__put(threads);
03ad9747 674 }
b55ae0a9 675 machine__delete_threads(machine);
0fd4008e 676 machine__delete(machine);
b55ae0a9
AH
677
678 return err;
679}
680
81f17c90 681int test__code_reading(struct test *test __maybe_unused, int subtest __maybe_unused)
b55ae0a9
AH
682{
683 int ret;
684
7a77bc2c
AH
685 ret = do_test_code_reading(false);
686 if (!ret)
687 ret = do_test_code_reading(true);
b55ae0a9
AH
688
689 switch (ret) {
690 case TEST_CODE_READING_OK:
691 return 0;
692 case TEST_CODE_READING_NO_VMLINUX:
597bdeb4 693 pr_debug("no vmlinux\n");
b55ae0a9 694 return 0;
7a77bc2c 695 case TEST_CODE_READING_NO_KCORE:
597bdeb4 696 pr_debug("no kcore\n");
7a77bc2c 697 return 0;
b55ae0a9 698 case TEST_CODE_READING_NO_ACCESS:
597bdeb4 699 pr_debug("no access\n");
b55ae0a9 700 return 0;
7a77bc2c 701 case TEST_CODE_READING_NO_KERNEL_OBJ:
597bdeb4 702 pr_debug("no kernel obj\n");
7a77bc2c 703 return 0;
b55ae0a9
AH
704 default:
705 return -1;
706 };
707}