1 // SPDX-License-Identifier: GPL-2.0-only
3 * recordmcount.c: construct a table of the locations of calls to 'mcount'
4 * so that ftrace can find them quickly.
5 * Copyright 2009 John F. Reiser <jreiser@BitWagon.com>. All rights reserved.
7 * Restructured to fit Linux format, as well as other updates:
8 * Copyright 2010 Steven Rostedt <srostedt@redhat.com>, Red Hat Inc.
12 * Strategy: alter the .o file in-place.
14 * Append a new STRTAB that has the new section names, followed by a new array
15 * ElfXX_Shdr[] that has the new section headers, followed by the section
16 * contents for __mcount_loc and its relocations. The old shstrtab strings,
17 * and the old ElfXX_Shdr[] array, remain as "garbage" (commonly, a couple
18 * kilobytes.) Subsequent processing by /bin/ld (or the kernel module loader)
19 * will ignore the garbage regions, because they are not designated by the
20 * new .e_shoff nor the new ElfXX_Shdr[]. [In order to remove the garbage,
21 * then use "ld -r" to create a new file that omits the garbage.]
24 #include <sys/types.h>
36 #define EM_AARCH64 183
37 #define R_AARCH64_NONE 0
38 #define R_AARCH64_ABS64 257
42 #define EM_LOONGARCH 258
45 #define R_LARCH_MARK_LA 20
46 #define R_LARCH_SOP_PUSH_PLT_PCREL 29
50 #define R_ARM_THM_CALL 10
53 #define R_AARCH64_CALL26 283
55 static int fd_map; /* File descriptor for file being modified. */
56 static int mmap_failed; /* Boolean flag. */
57 static char gpfx; /* prefix for global symbol name (sometimes '_') */
58 static struct stat sb; /* Remember .st_size, etc. */
59 static const char *altmcount; /* alternate mcount symbol name */
60 static int warn_on_notrace_sect; /* warn when section has mcount not being recorded */
61 static void *file_map; /* pointer of the mapped file */
62 static void *file_end; /* pointer to the end of the mapped file */
63 static int file_updated; /* flag to state file was changed */
64 static void *file_ptr; /* current file pointer location */
66 static void *file_append; /* added to the end of the file */
67 static size_t file_append_size; /* how much is added to end of file */
69 /* Per-file resource cleanup when multiple files. */
70 static void file_append_cleanup(void)
78 static void mmap_cleanup(void)
81 munmap(file_map, sb.st_size);
87 /* ulseek, uwrite, ...: Check return value for errors. */
89 static off_t ulseek(off_t const offset, int const whence)
93 file_ptr = file_map + offset;
99 file_ptr = file_map + (sb.st_size - offset);
102 if (file_ptr < file_map) {
103 fprintf(stderr, "lseek: seek before file\n");
106 return file_ptr - file_map;
109 static ssize_t uwrite(void const *const buf, size_t const count)
117 if (file_ptr + count >= file_end) {
118 off_t aoffset = (file_ptr + count) - file_end;
120 if (aoffset > file_append_size) {
121 p = realloc(file_append, aoffset);
125 file_append_size = aoffset;
129 file_append_cleanup();
133 if (file_ptr < file_end) {
134 cnt = file_end - file_ptr;
137 idx = aoffset - count;
142 memcpy(file_ptr, buf, cnt);
145 memcpy(file_append + idx, buf + cnt, count - cnt);
151 static void * umalloc(size_t size)
153 void *const addr = malloc(size);
155 fprintf(stderr, "malloc failed: %zu bytes\n", size);
156 file_append_cleanup();
164 * Get the whole file as a programming convenience in order to avoid
165 * malloc+lseek+read+free of many pieces. If successful, then mmap
166 * avoids copying unused pieces; else just read the whole file.
167 * Open for both read and write; new info will be appended to the file.
168 * Use MAP_PRIVATE so that a few changes to the in-memory ElfXX_Ehdr
169 * do not propagate to the file until an explicit overwrite at the last.
170 * This preserves most aspects of consistency (all except .st_size)
171 * for simultaneous readers of the file while we are appending to it.
172 * However, multiple writers still are bad. We choose not to use
173 * locking because it is expensive and the use case of kernel build
174 * makes multiple writers unlikely.
176 static void *mmap_file(char const *fname)
178 /* Avoid problems if early cleanup() */
186 fd_map = open(fname, O_RDONLY);
191 if (fstat(fd_map, &sb) < 0) {
195 if (!S_ISREG(sb.st_mode)) {
196 fprintf(stderr, "not a regular file: %s\n", fname);
199 file_map = mmap(0, sb.st_size, PROT_READ|PROT_WRITE, MAP_PRIVATE,
201 if (file_map == MAP_FAILED) {
203 file_map = umalloc(sb.st_size);
208 if (read(fd_map, file_map, sb.st_size) != sb.st_size) {
220 file_end = file_map + sb.st_size;
226 static unsigned char ideal_nop5_x86_64[5] = { 0x0f, 0x1f, 0x44, 0x00, 0x00 };
227 static unsigned char ideal_nop5_x86_32[5] = { 0x3e, 0x8d, 0x74, 0x26, 0x00 };
228 static unsigned char *ideal_nop;
230 static char rel_type_nop;
232 static int (*make_nop)(void *map, size_t const offset);
234 static int make_nop_x86(void *map, size_t const offset)
239 /* Confirm we have 0xe8 0x0 0x0 0x0 0x0 */
244 op = map + offset - 1;
249 if (ulseek(offset - 1, SEEK_SET) < 0)
251 if (uwrite(ideal_nop, 5) < 0)
256 static unsigned char ideal_nop4_arm_le[4] = { 0x00, 0x00, 0xa0, 0xe1 }; /* mov r0, r0 */
257 static unsigned char ideal_nop4_arm_be[4] = { 0xe1, 0xa0, 0x00, 0x00 }; /* mov r0, r0 */
258 static unsigned char *ideal_nop4_arm;
260 static unsigned char bl_mcount_arm_le[4] = { 0xfe, 0xff, 0xff, 0xeb }; /* bl */
261 static unsigned char bl_mcount_arm_be[4] = { 0xeb, 0xff, 0xff, 0xfe }; /* bl */
262 static unsigned char *bl_mcount_arm;
264 static unsigned char push_arm_le[4] = { 0x04, 0xe0, 0x2d, 0xe5 }; /* push {lr} */
265 static unsigned char push_arm_be[4] = { 0xe5, 0x2d, 0xe0, 0x04 }; /* push {lr} */
266 static unsigned char *push_arm;
268 static unsigned char ideal_nop2_thumb_le[2] = { 0x00, 0xbf }; /* nop */
269 static unsigned char ideal_nop2_thumb_be[2] = { 0xbf, 0x00 }; /* nop */
270 static unsigned char *ideal_nop2_thumb;
272 static unsigned char push_bl_mcount_thumb_le[6] = { 0x00, 0xb5, 0xff, 0xf7, 0xfe, 0xff }; /* push {lr}, bl */
273 static unsigned char push_bl_mcount_thumb_be[6] = { 0xb5, 0x00, 0xf7, 0xff, 0xff, 0xfe }; /* push {lr}, bl */
274 static unsigned char *push_bl_mcount_thumb;
276 static int make_nop_arm(void *map, size_t const offset)
284 if (memcmp(ptr, bl_mcount_arm, 4) == 0) {
285 if (memcmp(ptr - 4, push_arm, 4) == 0) {
289 ideal_nop = ideal_nop4_arm;
291 } else if (memcmp(ptr - 2, push_bl_mcount_thumb, 6) == 0) {
295 ideal_nop = ideal_nop2_thumb;
300 if (ulseek(off, SEEK_SET) < 0)
304 if (uwrite(ideal_nop, nop_size) < 0)
311 static unsigned char ideal_nop4_arm64[4] = {0x1f, 0x20, 0x03, 0xd5};
312 static int make_nop_arm64(void *map, size_t const offset)
317 /* bl <_mcount> is 0x94000000 before relocation */
318 if (*ptr != 0x94000000)
322 if (ulseek(offset, SEEK_SET) < 0)
324 if (uwrite(ideal_nop, 4) < 0)
329 static int write_file(const char *fname)
331 char tmp_file[strlen(fname) + 4];
337 sprintf(tmp_file, "%s.rc", fname);
340 * After reading the entire file into memory, delete it
341 * and write it back, to prevent weird side effects of modifying
342 * an object file in place.
344 fd_map = open(tmp_file, O_WRONLY | O_TRUNC | O_CREAT, sb.st_mode);
349 n = write(fd_map, file_map, sb.st_size);
350 if (n != sb.st_size) {
355 if (file_append_size) {
356 n = write(fd_map, file_append, file_append_size);
357 if (n != file_append_size) {
364 if (rename(tmp_file, fname) < 0) {
371 /* w8rev, w8nat, ...: Handle endianness. */
373 static uint64_t w8rev(uint64_t const x)
375 return ((0xff & (x >> (0 * 8))) << (7 * 8))
376 | ((0xff & (x >> (1 * 8))) << (6 * 8))
377 | ((0xff & (x >> (2 * 8))) << (5 * 8))
378 | ((0xff & (x >> (3 * 8))) << (4 * 8))
379 | ((0xff & (x >> (4 * 8))) << (3 * 8))
380 | ((0xff & (x >> (5 * 8))) << (2 * 8))
381 | ((0xff & (x >> (6 * 8))) << (1 * 8))
382 | ((0xff & (x >> (7 * 8))) << (0 * 8));
385 static uint32_t w4rev(uint32_t const x)
387 return ((0xff & (x >> (0 * 8))) << (3 * 8))
388 | ((0xff & (x >> (1 * 8))) << (2 * 8))
389 | ((0xff & (x >> (2 * 8))) << (1 * 8))
390 | ((0xff & (x >> (3 * 8))) << (0 * 8));
393 static uint32_t w2rev(uint16_t const x)
395 return ((0xff & (x >> (0 * 8))) << (1 * 8))
396 | ((0xff & (x >> (1 * 8))) << (0 * 8));
399 static uint64_t w8nat(uint64_t const x)
404 static uint32_t w4nat(uint32_t const x)
409 static uint32_t w2nat(uint16_t const x)
414 static uint64_t (*w8)(uint64_t);
415 static uint32_t (*w)(uint32_t);
416 static uint32_t (*w2)(uint16_t);
418 /* Names of the sections that could contain calls to mcount. */
419 static int is_mcounted_section_name(char const *const txtname)
421 return strncmp(".text", txtname, 5) == 0 ||
422 strcmp(".init.text", txtname) == 0 ||
423 strcmp(".ref.text", txtname) == 0 ||
424 strcmp(".sched.text", txtname) == 0 ||
425 strcmp(".spinlock.text", txtname) == 0 ||
426 strcmp(".irqentry.text", txtname) == 0 ||
427 strcmp(".softirqentry.text", txtname) == 0 ||
428 strcmp(".kprobes.text", txtname) == 0 ||
429 strcmp(".cpuidle.text", txtname) == 0;
432 static char const *already_has_rel_mcount = "success"; /* our work here is done! */
434 /* 32 bit and 64 bit are very similar */
435 #include "recordmcount.h"
436 #define RECORD_MCOUNT_64
437 #include "recordmcount.h"
439 static int arm_is_fake_mcount(Elf32_Rel const *rp)
441 switch (ELF32_R_TYPE(w(rp->r_info))) {
451 static int arm64_is_fake_mcount(Elf64_Rel const *rp)
453 return ELF64_R_TYPE(w8(rp->r_info)) != R_AARCH64_CALL26;
456 static int LARCH32_is_fake_mcount(Elf32_Rel const *rp)
458 switch (ELF64_R_TYPE(w(rp->r_info))) {
459 case R_LARCH_MARK_LA:
460 case R_LARCH_SOP_PUSH_PLT_PCREL:
467 static int LARCH64_is_fake_mcount(Elf64_Rel const *rp)
469 switch (ELF64_R_TYPE(w(rp->r_info))) {
470 case R_LARCH_MARK_LA:
471 case R_LARCH_SOP_PUSH_PLT_PCREL:
478 /* 64-bit EM_MIPS has weird ELF64_Rela.r_info.
479 * http://techpubs.sgi.com/library/manuals/4000/007-4658-001/pdf/007-4658-001.pdf
480 * We interpret Table 29 Relocation Operation (Elf64_Rel, Elf64_Rela) [p.40]
481 * to imply the order of the members; the spec does not say so.
482 * typedef unsigned char Elf64_Byte;
483 * fails on MIPS64 because their <elf.h> already has it!
486 typedef uint8_t myElf64_Byte; /* Type for a 8-bit quantity. */
491 Elf64_Word r_sym; /* Symbol index. */
492 myElf64_Byte r_ssym; /* Special symbol. */
493 myElf64_Byte r_type3; /* Third relocation. */
494 myElf64_Byte r_type2; /* Second relocation. */
495 myElf64_Byte r_type; /* First relocation. */
499 static uint64_t MIPS64_r_sym(Elf64_Rel const *rp)
501 return w(((union mips_r_info){ .r_info = rp->r_info }).r_mips.r_sym);
504 static void MIPS64_r_info(Elf64_Rel *const rp, unsigned sym, unsigned type)
506 rp->r_info = ((union mips_r_info){
507 .r_mips = { .r_sym = w(sym), .r_type = type }
511 static int do_file(char const *const fname)
513 unsigned int reltype = 0;
517 ehdr = mmap_file(fname);
524 switch (ehdr->e_ident[EI_DATA]) {
525 static unsigned int const endian = 1;
527 fprintf(stderr, "unrecognized ELF data encoding %d: %s\n",
528 ehdr->e_ident[EI_DATA], fname);
531 if (*(unsigned char const *)&endian != 1) {
532 /* main() is big endian, file.o is little endian. */
537 ideal_nop4_arm = ideal_nop4_arm_le;
538 bl_mcount_arm = bl_mcount_arm_le;
539 push_arm = push_arm_le;
540 ideal_nop2_thumb = ideal_nop2_thumb_le;
541 push_bl_mcount_thumb = push_bl_mcount_thumb_le;
544 if (*(unsigned char const *)&endian != 0) {
545 /* main() is little endian, file.o is big endian. */
550 ideal_nop4_arm = ideal_nop4_arm_be;
551 bl_mcount_arm = bl_mcount_arm_be;
552 push_arm = push_arm_be;
553 ideal_nop2_thumb = ideal_nop2_thumb_be;
554 push_bl_mcount_thumb = push_bl_mcount_thumb_be;
557 if (memcmp(ELFMAG, ehdr->e_ident, SELFMAG) != 0 ||
558 w2(ehdr->e_type) != ET_REL ||
559 ehdr->e_ident[EI_VERSION] != EV_CURRENT) {
560 fprintf(stderr, "unrecognized ET_REL file %s\n", fname);
565 switch (w2(ehdr->e_machine)) {
567 fprintf(stderr, "unrecognized e_machine %u %s\n",
568 w2(ehdr->e_machine), fname);
572 rel_type_nop = R_386_NONE;
573 make_nop = make_nop_x86;
574 ideal_nop = ideal_nop5_x86_32;
575 mcount_adjust_32 = -1;
579 reltype = R_ARM_ABS32;
580 altmcount = "__gnu_mcount_nc";
581 make_nop = make_nop_arm;
582 rel_type_nop = R_ARM_NONE;
583 is_fake_mcount32 = arm_is_fake_mcount;
587 reltype = R_AARCH64_ABS64;
588 make_nop = make_nop_arm64;
589 rel_type_nop = R_AARCH64_NONE;
590 ideal_nop = ideal_nop4_arm64;
591 is_fake_mcount64 = arm64_is_fake_mcount;
593 case EM_IA_64: reltype = R_IA64_IMM64; break;
594 case EM_MIPS: /* reltype: e_class */ break;
595 case EM_LOONGARCH: /* reltype: e_class */ break;
596 case EM_PPC: reltype = R_PPC_ADDR32; break;
597 case EM_PPC64: reltype = R_PPC64_ADDR64; break;
598 case EM_S390: /* reltype: e_class */ break;
599 case EM_SH: reltype = R_SH_DIR32; gpfx = 0; break;
600 case EM_SPARCV9: reltype = R_SPARC_64; break;
602 make_nop = make_nop_x86;
603 ideal_nop = ideal_nop5_x86_64;
604 reltype = R_X86_64_64;
605 rel_type_nop = R_X86_64_NONE;
606 mcount_adjust_64 = -1;
611 switch (ehdr->e_ident[EI_CLASS]) {
613 fprintf(stderr, "unrecognized ELF class %d %s\n",
614 ehdr->e_ident[EI_CLASS], fname);
617 if (w2(ehdr->e_ehsize) != sizeof(Elf32_Ehdr)
618 || w2(ehdr->e_shentsize) != sizeof(Elf32_Shdr)) {
620 "unrecognized ET_REL file: %s\n", fname);
623 if (w2(ehdr->e_machine) == EM_MIPS) {
625 is_fake_mcount32 = MIPS32_is_fake_mcount;
627 if (w2(ehdr->e_machine) == EM_LOONGARCH) {
628 reltype = R_LARCH_32;
629 is_fake_mcount32 = LARCH32_is_fake_mcount;
631 if (do32(ehdr, fname, reltype) < 0)
635 Elf64_Ehdr *const ghdr = (Elf64_Ehdr *)ehdr;
636 if (w2(ghdr->e_ehsize) != sizeof(Elf64_Ehdr)
637 || w2(ghdr->e_shentsize) != sizeof(Elf64_Shdr)) {
639 "unrecognized ET_REL file: %s\n", fname);
642 if (w2(ghdr->e_machine) == EM_S390) {
644 mcount_adjust_64 = -14;
646 if (w2(ghdr->e_machine) == EM_MIPS) {
648 Elf64_r_sym = MIPS64_r_sym;
649 Elf64_r_info = MIPS64_r_info;
650 is_fake_mcount64 = MIPS64_is_fake_mcount;
652 if (w2(ghdr->e_machine) == EM_LOONGARCH) {
653 reltype = R_LARCH_64;
654 is_fake_mcount64 = LARCH64_is_fake_mcount;
656 if (do64(ghdr, fname, reltype) < 0)
662 rc = write_file(fname);
664 file_append_cleanup();
669 int main(int argc, char *argv[])
671 const char ftrace[] = "/ftrace.o";
672 int ftrace_size = sizeof(ftrace) - 1;
673 int n_error = 0; /* gcc-4.3.0 false positive complaint */
677 while ((c = getopt(argc, argv, "w")) >= 0) {
680 warn_on_notrace_sect = 1;
683 fprintf(stderr, "usage: recordmcount [-w] file.o...\n");
688 if ((argc - optind) < 1) {
689 fprintf(stderr, "usage: recordmcount [-w] file.o...\n");
693 /* Process each file in turn, allowing deep failure. */
694 for (i = optind; i < argc; i++) {
695 char *file = argv[i];
699 * The file kernel/trace/ftrace.o references the mcount
700 * function but does not call it. Since ftrace.o should
701 * not be traced anyway, we just skip it.
704 if (len >= ftrace_size &&
705 strcmp(file + (len - ftrace_size), ftrace) == 0)
709 fprintf(stderr, "%s: failed\n", file);