1 // SPDX-License-Identifier: GPL-2.0
2 #include <sys/sysmacros.h>
15 #include <linux/stringify.h>
21 #include "namespaces.h"
32 #include <linux/ctype.h>
33 #include <linux/zalloc.h>
36 struct perf_data *output;
37 struct perf_session *session;
38 struct machine *machine;
40 union jr_entry *entry;
45 bool needs_bswap; /* handles cross-endianness */
46 bool use_arch_timestamp;
49 uint64_t unwinding_size;
50 uint64_t unwinding_mapped_size;
51 uint64_t eh_frame_hdr_size;
52 size_t nr_debug_entries;
53 uint32_t code_load_count;
55 struct rb_root code_root;
59 struct debug_line_info {
62 /* The filename format is unspecified, absolute path, relative etc. */
63 char const filename[];
67 struct perf_tool tool;
68 struct perf_data output;
69 struct perf_data input;
73 #define hmax(a, b) ((a) > (b) ? (a) : (b))
74 #define get_jit_tool(t) (container_of(tool, struct jit_tool, tool))
77 jit_emit_elf(struct jit_buf_desc *jd,
86 uint32_t unwinding_header_size,
87 uint32_t unwinding_size)
89 int ret, fd, saved_errno;
93 fprintf(stderr, "write ELF image %s\n", filename);
95 nsinfo__mountns_enter(jd->nsi, &nsc);
96 fd = open(filename, O_CREAT|O_TRUNC|O_WRONLY, 0644);
98 nsinfo__mountns_exit(&nsc);
100 pr_warning("cannot create jit ELF %s: %s\n", filename, strerror(saved_errno));
104 ret = jit_write_elf(fd, code_addr, sym, (const void *)code, csize, debug, nr_debug_entries,
105 unwinding, unwinding_header_size, unwinding_size);
110 nsinfo__mountns_enter(jd->nsi, &nsc);
112 nsinfo__mountns_exit(&nsc);
119 jit_close(struct jit_buf_desc *jd)
129 jit_validate_events(struct perf_session *session)
134 * check that all events use CLOCK_MONOTONIC
136 evlist__for_each_entry(session->evlist, evsel) {
137 if (evsel->core.attr.use_clockid == 0 || evsel->core.attr.clockid != CLOCK_MONOTONIC)
144 jit_open(struct jit_buf_desc *jd, const char *name)
146 struct jitheader header;
148 struct jr_prefix *prefix;
150 void *n, *buf = NULL;
151 int ret, retval = -1;
153 nsinfo__mountns_enter(jd->nsi, &nsc);
154 jd->in = fopen(name, "r");
155 nsinfo__mountns_exit(&nsc);
159 bsz = hmax(sizeof(header), sizeof(*prefix));
166 * protect from writer modifying the file while we are reading it
170 ret = fread(buf, sizeof(header), 1, jd->in);
174 memcpy(&header, buf, sizeof(header));
176 if (header.magic != JITHEADER_MAGIC) {
177 if (header.magic != JITHEADER_MAGIC_SW)
179 jd->needs_bswap = true;
182 if (jd->needs_bswap) {
183 header.version = bswap_32(header.version);
184 header.total_size = bswap_32(header.total_size);
185 header.pid = bswap_32(header.pid);
186 header.elf_mach = bswap_32(header.elf_mach);
187 header.timestamp = bswap_64(header.timestamp);
188 header.flags = bswap_64(header.flags);
191 jd->use_arch_timestamp = header.flags & JITDUMP_FLAGS_ARCH_TIMESTAMP;
194 pr_debug("version=%u\nhdr.size=%u\nts=0x%llx\npid=%d\nelf_mach=%d\nuse_arch_timestamp=%d\n",
197 (unsigned long long)header.timestamp,
200 jd->use_arch_timestamp);
202 if (header.version > JITHEADER_VERSION) {
203 pr_err("wrong jitdump version %u, expected " __stringify(JITHEADER_VERSION),
208 if (header.flags & JITDUMP_FLAGS_RESERVED) {
209 pr_err("jitdump file contains invalid or unsupported flags 0x%llx\n",
210 (unsigned long long)header.flags & JITDUMP_FLAGS_RESERVED);
214 if (jd->use_arch_timestamp && !jd->session->time_conv.time_mult) {
215 pr_err("jitdump file uses arch timestamps but there is no timestamp conversion\n");
220 * validate event is using the correct clockid
222 if (!jd->use_arch_timestamp && jit_validate_events(jd->session)) {
223 pr_err("error, jitted code must be sampled with perf record -k 1\n");
227 bs = header.total_size - sizeof(header);
230 n = realloc(buf, bs);
235 /* read extra we do not know about */
236 ret = fread(buf, bs - bsz, 1, jd->in);
241 * keep dirname for generating files and mmap records
243 strcpy(jd->dir, name);
253 static union jr_entry *
254 jit_get_next_entry(struct jit_buf_desc *jd)
256 struct jr_prefix *prefix;
265 if (jd->buf == NULL) {
266 size_t sz = getpagesize();
267 if (sz < sizeof(*prefix))
268 sz = sizeof(*prefix);
270 jd->buf = malloc(sz);
280 * file is still locked at this point
282 ret = fread(prefix, sizeof(*prefix), 1, jd->in);
286 if (jd->needs_bswap) {
287 prefix->id = bswap_32(prefix->id);
288 prefix->total_size = bswap_32(prefix->total_size);
289 prefix->timestamp = bswap_64(prefix->timestamp);
292 size = prefix->total_size;
295 if (bs < sizeof(*prefix))
298 if (id >= JIT_CODE_MAX) {
299 pr_warning("next_entry: unknown record type %d, skipping\n", id);
301 if (bs > jd->bufsize) {
303 n = realloc(jd->buf, bs);
310 addr = ((void *)jd->buf) + sizeof(*prefix);
312 ret = fread(addr, bs - sizeof(*prefix), 1, jd->in);
316 jr = (union jr_entry *)jd->buf;
319 case JIT_CODE_DEBUG_INFO:
320 if (jd->needs_bswap) {
322 jr->info.code_addr = bswap_64(jr->info.code_addr);
323 jr->info.nr_entry = bswap_64(jr->info.nr_entry);
324 for (n = 0 ; n < jr->info.nr_entry; n++) {
325 jr->info.entries[n].addr = bswap_64(jr->info.entries[n].addr);
326 jr->info.entries[n].lineno = bswap_32(jr->info.entries[n].lineno);
327 jr->info.entries[n].discrim = bswap_32(jr->info.entries[n].discrim);
331 case JIT_CODE_UNWINDING_INFO:
332 if (jd->needs_bswap) {
333 jr->unwinding.unwinding_size = bswap_64(jr->unwinding.unwinding_size);
334 jr->unwinding.eh_frame_hdr_size = bswap_64(jr->unwinding.eh_frame_hdr_size);
335 jr->unwinding.mapped_size = bswap_64(jr->unwinding.mapped_size);
341 if (jd->needs_bswap) {
342 jr->load.pid = bswap_32(jr->load.pid);
343 jr->load.tid = bswap_32(jr->load.tid);
344 jr->load.vma = bswap_64(jr->load.vma);
345 jr->load.code_addr = bswap_64(jr->load.code_addr);
346 jr->load.code_size = bswap_64(jr->load.code_size);
347 jr->load.code_index= bswap_64(jr->load.code_index);
349 jd->code_load_count++;
352 if (jd->needs_bswap) {
353 jr->move.pid = bswap_32(jr->move.pid);
354 jr->move.tid = bswap_32(jr->move.tid);
355 jr->move.vma = bswap_64(jr->move.vma);
356 jr->move.old_code_addr = bswap_64(jr->move.old_code_addr);
357 jr->move.new_code_addr = bswap_64(jr->move.new_code_addr);
358 jr->move.code_size = bswap_64(jr->move.code_size);
359 jr->move.code_index = bswap_64(jr->move.code_index);
364 /* skip unknown record (we have read them) */
371 jit_inject_event(struct jit_buf_desc *jd, union perf_event *event)
375 size = perf_data__write(jd->output, event, event->header.size);
379 jd->bytes_written += size;
383 static pid_t jr_entry_pid(struct jit_buf_desc *jd, union jr_entry *jr)
385 if (jd->nsi && jd->nsi->in_pidns)
386 return jd->nsi->tgid;
390 static pid_t jr_entry_tid(struct jit_buf_desc *jd, union jr_entry *jr)
392 if (jd->nsi && jd->nsi->in_pidns)
397 static uint64_t convert_timestamp(struct jit_buf_desc *jd, uint64_t timestamp)
399 struct perf_tsc_conversion tc;
401 if (!jd->use_arch_timestamp)
404 tc.time_shift = jd->session->time_conv.time_shift;
405 tc.time_mult = jd->session->time_conv.time_mult;
406 tc.time_zero = jd->session->time_conv.time_zero;
407 tc.time_cycles = jd->session->time_conv.time_cycles;
408 tc.time_mask = jd->session->time_conv.time_mask;
409 tc.cap_user_time_zero = jd->session->time_conv.cap_user_time_zero;
410 tc.cap_user_time_short = jd->session->time_conv.cap_user_time_short;
412 if (!tc.cap_user_time_zero)
415 return tsc_to_perf_time(timestamp, &tc);
418 static int jit_repipe_code_load(struct jit_buf_desc *jd, union jr_entry *jr)
420 struct perf_sample sample;
421 union perf_event *event;
422 struct perf_tool *tool = jd->session->tool;
431 int ret, csize, usize;
432 pid_t nspid, pid, tid;
438 nspid = jr->load.pid;
439 pid = jr_entry_pid(jd, jr);
440 tid = jr_entry_tid(jd, jr);
441 csize = jr->load.code_size;
442 usize = jd->unwinding_mapped_size;
443 addr = jr->load.code_addr;
444 sym = (void *)((unsigned long)jr + sizeof(jr->load));
445 code = (unsigned long)jr + jr->load.p.total_size - csize;
446 count = jr->load.code_index;
447 idr_size = jd->machine->id_hdr_size;
449 event = calloc(1, sizeof(*event) + idr_size);
453 filename = event->mmap2.filename;
454 size = snprintf(filename, PATH_MAX, "%s/jitted-%d-%" PRIu64 ".so",
461 size = PERF_ALIGN(size, sizeof(u64));
462 uaddr = (uintptr_t)code;
463 ret = jit_emit_elf(jd, filename, sym, addr, (const void *)uaddr, csize, jd->debug_data, jd->nr_debug_entries,
464 jd->unwinding_data, jd->eh_frame_hdr_size, jd->unwinding_size);
466 if (jd->debug_data && jd->nr_debug_entries) {
467 zfree(&jd->debug_data);
468 jd->nr_debug_entries = 0;
471 if (jd->unwinding_data && jd->eh_frame_hdr_size) {
472 zfree(&jd->unwinding_data);
473 jd->eh_frame_hdr_size = 0;
474 jd->unwinding_mapped_size = 0;
475 jd->unwinding_size = 0;
482 if (nsinfo__stat(filename, &st, jd->nsi))
483 memset(&st, 0, sizeof(st));
485 event->mmap2.header.type = PERF_RECORD_MMAP2;
486 event->mmap2.header.misc = PERF_RECORD_MISC_USER;
487 event->mmap2.header.size = (sizeof(event->mmap2) -
488 (sizeof(event->mmap2.filename) - size) + idr_size);
490 event->mmap2.pgoff = GEN_ELF_TEXT_OFFSET;
491 event->mmap2.start = addr;
492 event->mmap2.len = usize ? ALIGN_8(csize) + usize : csize;
493 event->mmap2.pid = pid;
494 event->mmap2.tid = tid;
495 event->mmap2.ino = st.st_ino;
496 event->mmap2.maj = major(st.st_dev);
497 event->mmap2.min = minor(st.st_dev);
498 event->mmap2.prot = st.st_mode;
499 event->mmap2.flags = MAP_SHARED;
500 event->mmap2.ino_generation = 1;
502 id = (void *)((unsigned long)event + event->mmap.header.size - idr_size);
503 if (jd->sample_type & PERF_SAMPLE_TID) {
507 if (jd->sample_type & PERF_SAMPLE_TIME)
508 id->time = convert_timestamp(jd, jr->load.p.timestamp);
511 * create pseudo sample to induce dso hit increment
512 * use first address as sample address
514 memset(&sample, 0, sizeof(sample));
515 sample.cpumode = PERF_RECORD_MISC_USER;
518 sample.time = id->time;
521 ret = perf_event__process_mmap2(tool, event, &sample, jd->machine);
525 ret = jit_inject_event(jd, event);
527 * mark dso as use to generate buildid in the header
530 build_id__mark_dso_hit(tool, event, &sample, NULL, jd->machine);
535 static int jit_repipe_code_move(struct jit_buf_desc *jd, union jr_entry *jr)
537 struct perf_sample sample;
538 union perf_event *event;
539 struct perf_tool *tool = jd->session->tool;
546 pid_t nspid, pid, tid;
552 nspid = jr->load.pid;
553 pid = jr_entry_pid(jd, jr);
554 tid = jr_entry_tid(jd, jr);
555 usize = jd->unwinding_mapped_size;
556 idr_size = jd->machine->id_hdr_size;
559 * +16 to account for sample_id_all (hack)
561 event = calloc(1, sizeof(*event) + 16);
565 filename = event->mmap2.filename;
566 size = snprintf(filename, PATH_MAX, "%s/jitted-%d-%" PRIu64 ".so",
569 jr->move.code_index);
573 if (nsinfo__stat(filename, &st, jd->nsi))
574 memset(&st, 0, sizeof(st));
576 size = PERF_ALIGN(size, sizeof(u64));
578 event->mmap2.header.type = PERF_RECORD_MMAP2;
579 event->mmap2.header.misc = PERF_RECORD_MISC_USER;
580 event->mmap2.header.size = (sizeof(event->mmap2) -
581 (sizeof(event->mmap2.filename) - size) + idr_size);
582 event->mmap2.pgoff = GEN_ELF_TEXT_OFFSET;
583 event->mmap2.start = jr->move.new_code_addr;
584 event->mmap2.len = usize ? ALIGN_8(jr->move.code_size) + usize
585 : jr->move.code_size;
586 event->mmap2.pid = pid;
587 event->mmap2.tid = tid;
588 event->mmap2.ino = st.st_ino;
589 event->mmap2.maj = major(st.st_dev);
590 event->mmap2.min = minor(st.st_dev);
591 event->mmap2.prot = st.st_mode;
592 event->mmap2.flags = MAP_SHARED;
593 event->mmap2.ino_generation = 1;
595 id = (void *)((unsigned long)event + event->mmap.header.size - idr_size);
596 if (jd->sample_type & PERF_SAMPLE_TID) {
600 if (jd->sample_type & PERF_SAMPLE_TIME)
601 id->time = convert_timestamp(jd, jr->load.p.timestamp);
604 * create pseudo sample to induce dso hit increment
605 * use first address as sample address
607 memset(&sample, 0, sizeof(sample));
608 sample.cpumode = PERF_RECORD_MISC_USER;
611 sample.time = id->time;
612 sample.ip = jr->move.new_code_addr;
614 ret = perf_event__process_mmap2(tool, event, &sample, jd->machine);
618 ret = jit_inject_event(jd, event);
620 build_id__mark_dso_hit(tool, event, &sample, NULL, jd->machine);
625 static int jit_repipe_debug_info(struct jit_buf_desc *jd, union jr_entry *jr)
633 sz = jr->prefix.total_size - sizeof(jr->info);
638 memcpy(data, &jr->info.entries, sz);
640 jd->debug_data = data;
643 * we must use nr_entry instead of size here because
644 * we cannot distinguish actual entry from padding otherwise
646 jd->nr_debug_entries = jr->info.nr_entry;
652 jit_repipe_unwinding_info(struct jit_buf_desc *jd, union jr_entry *jr)
654 void *unwinding_data;
655 uint32_t unwinding_data_size;
660 unwinding_data_size = jr->prefix.total_size - sizeof(jr->unwinding);
661 unwinding_data = malloc(unwinding_data_size);
665 memcpy(unwinding_data, &jr->unwinding.unwinding_data,
666 unwinding_data_size);
668 jd->eh_frame_hdr_size = jr->unwinding.eh_frame_hdr_size;
669 jd->unwinding_size = jr->unwinding.unwinding_size;
670 jd->unwinding_mapped_size = jr->unwinding.mapped_size;
671 jd->unwinding_data = unwinding_data;
677 jit_process_dump(struct jit_buf_desc *jd)
682 while ((jr = jit_get_next_entry(jd))) {
683 switch(jr->prefix.id) {
685 ret = jit_repipe_code_load(jd, jr);
688 ret = jit_repipe_code_move(jd, jr);
690 case JIT_CODE_DEBUG_INFO:
691 ret = jit_repipe_debug_info(jd, jr);
693 case JIT_CODE_UNWINDING_INFO:
694 ret = jit_repipe_unwinding_info(jd, jr);
705 jit_inject(struct jit_buf_desc *jd, char *path)
710 fprintf(stderr, "injecting: %s\n", path);
712 ret = jit_open(jd, path);
716 ret = jit_process_dump(jd);
721 fprintf(stderr, "injected: %s (%d)\n", path, ret);
727 * File must be with pattern .../jit-XXXX.dump
728 * where XXXX is the PID of the process which did the mmap()
729 * as captured in the RECORD_MMAP record
732 jit_detect(char *mmap_name, pid_t pid, struct nsinfo *nsi)
739 fprintf(stderr, "jit marker trying : %s\n", mmap_name);
743 p = strrchr(mmap_name, '/');
750 if (strncmp(p, "/jit-", 5))
759 * must be followed by a pid
764 pid2 = (int)strtol(p, &end, 10);
769 * pid does not match mmap pid
770 * pid==0 in system-wide mode (synthesized)
772 if (pid && pid2 != nsi->nstgid)
777 if (strcmp(end, ".dump"))
781 fprintf(stderr, "jit marker found: %s\n", mmap_name);
786 static void jit_add_pid(struct machine *machine, pid_t pid)
788 struct thread *thread = machine__findnew_thread(machine, pid, pid);
791 pr_err("%s: thread %d not found or created\n", __func__, pid);
795 thread->priv = (void *)1;
798 static bool jit_has_pid(struct machine *machine, pid_t pid)
800 struct thread *thread = machine__find_thread(machine, pid, pid);
805 return (bool)thread->priv;
809 jit_process(struct perf_session *session,
810 struct perf_data *output,
811 struct machine *machine,
817 struct thread *thread;
820 struct jit_buf_desc jd;
823 thread = machine__findnew_thread(machine, pid, tid);
824 if (thread == NULL) {
825 pr_err("problem processing JIT mmap event, skipping it.\n");
829 nsi = nsinfo__get(thread->nsinfo);
833 * first, detect marker mmap (i.e., the jitdump mmap)
835 if (jit_detect(filename, pid, nsi)) {
838 // Strip //anon* mmaps if we processed a jitdump for this pid
839 if (jit_has_pid(machine, pid) && (strncmp(filename, "//anon", 6) == 0))
845 memset(&jd, 0, sizeof(jd));
847 jd.session = session;
849 jd.machine = machine;
853 * track sample_type to compute id_all layout
854 * perf sets the same sample type to all events as of now
856 first = evlist__first(session->evlist);
857 jd.sample_type = first->core.attr.sample_type;
861 ret = jit_inject(&jd, filename);
863 jit_add_pid(machine, pid);
864 *nbytes = jd.bytes_written;