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 R_ARM_THM_CALL 10
45 #define R_AARCH64_CALL26 283
47 static int fd_map
; /* File descriptor for file being modified. */
48 static int mmap_failed
; /* Boolean flag. */
49 static char gpfx
; /* prefix for global symbol name (sometimes '_') */
50 static struct stat sb
; /* Remember .st_size, etc. */
51 static const char *altmcount
; /* alternate mcount symbol name */
52 static int warn_on_notrace_sect
; /* warn when section has mcount not being recorded */
53 static void *file_map
; /* pointer of the mapped file */
54 static void *file_end
; /* pointer to the end of the mapped file */
55 static int file_updated
; /* flag to state file was changed */
56 static void *file_ptr
; /* current file pointer location */
58 static void *file_append
; /* added to the end of the file */
59 static size_t file_append_size
; /* how much is added to end of file */
61 /* Per-file resource cleanup when multiple files. */
62 static void file_append_cleanup(void)
70 static void mmap_cleanup(void)
73 munmap(file_map
, sb
.st_size
);
79 /* ulseek, uwrite, ...: Check return value for errors. */
81 static off_t
ulseek(off_t
const offset
, int const whence
)
85 file_ptr
= file_map
+ offset
;
91 file_ptr
= file_map
+ (sb
.st_size
- offset
);
94 if (file_ptr
< file_map
) {
95 fprintf(stderr
, "lseek: seek before file\n");
98 return file_ptr
- file_map
;
101 static ssize_t
uwrite(void const *const buf
, size_t const count
)
108 if (file_ptr
+ count
>= file_end
) {
109 off_t aoffset
= (file_ptr
+ count
) - file_end
;
111 if (aoffset
> file_append_size
) {
112 file_append
= realloc(file_append
, aoffset
);
113 file_append_size
= aoffset
;
117 file_append_cleanup();
121 if (file_ptr
< file_end
) {
122 cnt
= file_end
- file_ptr
;
125 idx
= aoffset
- count
;
130 memcpy(file_ptr
, buf
, cnt
);
133 memcpy(file_append
+ idx
, buf
+ cnt
, count
- cnt
);
139 static void * umalloc(size_t size
)
141 void *const addr
= malloc(size
);
143 fprintf(stderr
, "malloc failed: %zu bytes\n", size
);
144 file_append_cleanup();
152 * Get the whole file as a programming convenience in order to avoid
153 * malloc+lseek+read+free of many pieces. If successful, then mmap
154 * avoids copying unused pieces; else just read the whole file.
155 * Open for both read and write; new info will be appended to the file.
156 * Use MAP_PRIVATE so that a few changes to the in-memory ElfXX_Ehdr
157 * do not propagate to the file until an explicit overwrite at the last.
158 * This preserves most aspects of consistency (all except .st_size)
159 * for simultaneous readers of the file while we are appending to it.
160 * However, multiple writers still are bad. We choose not to use
161 * locking because it is expensive and the use case of kernel build
162 * makes multiple writers unlikely.
164 static void *mmap_file(char const *fname
)
166 /* Avoid problems if early cleanup() */
174 fd_map
= open(fname
, O_RDONLY
);
179 if (fstat(fd_map
, &sb
) < 0) {
183 if (!S_ISREG(sb
.st_mode
)) {
184 fprintf(stderr
, "not a regular file: %s\n", fname
);
187 file_map
= mmap(0, sb
.st_size
, PROT_READ
|PROT_WRITE
, MAP_PRIVATE
,
189 if (file_map
== MAP_FAILED
) {
191 file_map
= umalloc(sb
.st_size
);
196 if (read(fd_map
, file_map
, sb
.st_size
) != sb
.st_size
) {
208 file_end
= file_map
+ sb
.st_size
;
214 static unsigned char ideal_nop5_x86_64
[5] = { 0x0f, 0x1f, 0x44, 0x00, 0x00 };
215 static unsigned char ideal_nop5_x86_32
[5] = { 0x3e, 0x8d, 0x74, 0x26, 0x00 };
216 static unsigned char *ideal_nop
;
218 static char rel_type_nop
;
220 static int (*make_nop
)(void *map
, size_t const offset
);
222 static int make_nop_x86(void *map
, size_t const offset
)
227 /* Confirm we have 0xe8 0x0 0x0 0x0 0x0 */
232 op
= map
+ offset
- 1;
237 if (ulseek(offset
- 1, SEEK_SET
) < 0)
239 if (uwrite(ideal_nop
, 5) < 0)
244 static unsigned char ideal_nop4_arm_le
[4] = { 0x00, 0x00, 0xa0, 0xe1 }; /* mov r0, r0 */
245 static unsigned char ideal_nop4_arm_be
[4] = { 0xe1, 0xa0, 0x00, 0x00 }; /* mov r0, r0 */
246 static unsigned char *ideal_nop4_arm
;
248 static unsigned char bl_mcount_arm_le
[4] = { 0xfe, 0xff, 0xff, 0xeb }; /* bl */
249 static unsigned char bl_mcount_arm_be
[4] = { 0xeb, 0xff, 0xff, 0xfe }; /* bl */
250 static unsigned char *bl_mcount_arm
;
252 static unsigned char push_arm_le
[4] = { 0x04, 0xe0, 0x2d, 0xe5 }; /* push {lr} */
253 static unsigned char push_arm_be
[4] = { 0xe5, 0x2d, 0xe0, 0x04 }; /* push {lr} */
254 static unsigned char *push_arm
;
256 static unsigned char ideal_nop2_thumb_le
[2] = { 0x00, 0xbf }; /* nop */
257 static unsigned char ideal_nop2_thumb_be
[2] = { 0xbf, 0x00 }; /* nop */
258 static unsigned char *ideal_nop2_thumb
;
260 static unsigned char push_bl_mcount_thumb_le
[6] = { 0x00, 0xb5, 0xff, 0xf7, 0xfe, 0xff }; /* push {lr}, bl */
261 static unsigned char push_bl_mcount_thumb_be
[6] = { 0xb5, 0x00, 0xf7, 0xff, 0xff, 0xfe }; /* push {lr}, bl */
262 static unsigned char *push_bl_mcount_thumb
;
264 static int make_nop_arm(void *map
, size_t const offset
)
272 if (memcmp(ptr
, bl_mcount_arm
, 4) == 0) {
273 if (memcmp(ptr
- 4, push_arm
, 4) == 0) {
277 ideal_nop
= ideal_nop4_arm
;
279 } else if (memcmp(ptr
- 2, push_bl_mcount_thumb
, 6) == 0) {
283 ideal_nop
= ideal_nop2_thumb
;
288 if (ulseek(off
, SEEK_SET
) < 0)
292 if (uwrite(ideal_nop
, nop_size
) < 0)
299 static unsigned char ideal_nop4_arm64
[4] = {0x1f, 0x20, 0x03, 0xd5};
300 static int make_nop_arm64(void *map
, size_t const offset
)
305 /* bl <_mcount> is 0x94000000 before relocation */
306 if (*ptr
!= 0x94000000)
310 if (ulseek(offset
, SEEK_SET
) < 0)
312 if (uwrite(ideal_nop
, 4) < 0)
317 static int write_file(const char *fname
)
319 char tmp_file
[strlen(fname
) + 4];
325 sprintf(tmp_file
, "%s.rc", fname
);
328 * After reading the entire file into memory, delete it
329 * and write it back, to prevent weird side effects of modifying
330 * an object file in place.
332 fd_map
= open(tmp_file
, O_WRONLY
| O_TRUNC
| O_CREAT
, sb
.st_mode
);
337 n
= write(fd_map
, file_map
, sb
.st_size
);
338 if (n
!= sb
.st_size
) {
343 if (file_append_size
) {
344 n
= write(fd_map
, file_append
, file_append_size
);
345 if (n
!= file_append_size
) {
352 if (rename(tmp_file
, fname
) < 0) {
359 /* w8rev, w8nat, ...: Handle endianness. */
361 static uint64_t w8rev(uint64_t const x
)
363 return ((0xff & (x
>> (0 * 8))) << (7 * 8))
364 | ((0xff & (x
>> (1 * 8))) << (6 * 8))
365 | ((0xff & (x
>> (2 * 8))) << (5 * 8))
366 | ((0xff & (x
>> (3 * 8))) << (4 * 8))
367 | ((0xff & (x
>> (4 * 8))) << (3 * 8))
368 | ((0xff & (x
>> (5 * 8))) << (2 * 8))
369 | ((0xff & (x
>> (6 * 8))) << (1 * 8))
370 | ((0xff & (x
>> (7 * 8))) << (0 * 8));
373 static uint32_t w4rev(uint32_t const x
)
375 return ((0xff & (x
>> (0 * 8))) << (3 * 8))
376 | ((0xff & (x
>> (1 * 8))) << (2 * 8))
377 | ((0xff & (x
>> (2 * 8))) << (1 * 8))
378 | ((0xff & (x
>> (3 * 8))) << (0 * 8));
381 static uint32_t w2rev(uint16_t const x
)
383 return ((0xff & (x
>> (0 * 8))) << (1 * 8))
384 | ((0xff & (x
>> (1 * 8))) << (0 * 8));
387 static uint64_t w8nat(uint64_t const x
)
392 static uint32_t w4nat(uint32_t const x
)
397 static uint32_t w2nat(uint16_t const x
)
402 static uint64_t (*w8
)(uint64_t);
403 static uint32_t (*w
)(uint32_t);
404 static uint32_t (*w2
)(uint16_t);
406 /* Names of the sections that could contain calls to mcount. */
407 static int is_mcounted_section_name(char const *const txtname
)
409 return strncmp(".text", txtname
, 5) == 0 ||
410 strcmp(".init.text", txtname
) == 0 ||
411 strcmp(".ref.text", txtname
) == 0 ||
412 strcmp(".sched.text", txtname
) == 0 ||
413 strcmp(".spinlock.text", txtname
) == 0 ||
414 strcmp(".irqentry.text", txtname
) == 0 ||
415 strcmp(".softirqentry.text", txtname
) == 0 ||
416 strcmp(".kprobes.text", txtname
) == 0 ||
417 strcmp(".cpuidle.text", txtname
) == 0;
420 static char const *already_has_rel_mcount
= "success"; /* our work here is done! */
422 /* 32 bit and 64 bit are very similar */
423 #include "recordmcount.h"
424 #define RECORD_MCOUNT_64
425 #include "recordmcount.h"
427 static int arm_is_fake_mcount(Elf32_Rel
const *rp
)
429 switch (ELF32_R_TYPE(w(rp
->r_info
))) {
439 static int arm64_is_fake_mcount(Elf64_Rel
const *rp
)
441 return ELF64_R_TYPE(w(rp
->r_info
)) != R_AARCH64_CALL26
;
444 /* 64-bit EM_MIPS has weird ELF64_Rela.r_info.
445 * http://techpubs.sgi.com/library/manuals/4000/007-4658-001/pdf/007-4658-001.pdf
446 * We interpret Table 29 Relocation Operation (Elf64_Rel, Elf64_Rela) [p.40]
447 * to imply the order of the members; the spec does not say so.
448 * typedef unsigned char Elf64_Byte;
449 * fails on MIPS64 because their <elf.h> already has it!
452 typedef uint8_t myElf64_Byte
; /* Type for a 8-bit quantity. */
457 Elf64_Word r_sym
; /* Symbol index. */
458 myElf64_Byte r_ssym
; /* Special symbol. */
459 myElf64_Byte r_type3
; /* Third relocation. */
460 myElf64_Byte r_type2
; /* Second relocation. */
461 myElf64_Byte r_type
; /* First relocation. */
465 static uint64_t MIPS64_r_sym(Elf64_Rel
const *rp
)
467 return w(((union mips_r_info
){ .r_info
= rp
->r_info
}).r_mips
.r_sym
);
470 static void MIPS64_r_info(Elf64_Rel
*const rp
, unsigned sym
, unsigned type
)
472 rp
->r_info
= ((union mips_r_info
){
473 .r_mips
= { .r_sym
= w(sym
), .r_type
= type
}
477 static int do_file(char const *const fname
)
479 unsigned int reltype
= 0;
483 ehdr
= mmap_file(fname
);
490 switch (ehdr
->e_ident
[EI_DATA
]) {
491 static unsigned int const endian
= 1;
493 fprintf(stderr
, "unrecognized ELF data encoding %d: %s\n",
494 ehdr
->e_ident
[EI_DATA
], fname
);
497 if (*(unsigned char const *)&endian
!= 1) {
498 /* main() is big endian, file.o is little endian. */
503 ideal_nop4_arm
= ideal_nop4_arm_le
;
504 bl_mcount_arm
= bl_mcount_arm_le
;
505 push_arm
= push_arm_le
;
506 ideal_nop2_thumb
= ideal_nop2_thumb_le
;
507 push_bl_mcount_thumb
= push_bl_mcount_thumb_le
;
510 if (*(unsigned char const *)&endian
!= 0) {
511 /* main() is little endian, file.o is big endian. */
516 ideal_nop4_arm
= ideal_nop4_arm_be
;
517 bl_mcount_arm
= bl_mcount_arm_be
;
518 push_arm
= push_arm_be
;
519 ideal_nop2_thumb
= ideal_nop2_thumb_be
;
520 push_bl_mcount_thumb
= push_bl_mcount_thumb_be
;
523 if (memcmp(ELFMAG
, ehdr
->e_ident
, SELFMAG
) != 0 ||
524 w2(ehdr
->e_type
) != ET_REL
||
525 ehdr
->e_ident
[EI_VERSION
] != EV_CURRENT
) {
526 fprintf(stderr
, "unrecognized ET_REL file %s\n", fname
);
531 switch (w2(ehdr
->e_machine
)) {
533 fprintf(stderr
, "unrecognized e_machine %u %s\n",
534 w2(ehdr
->e_machine
), fname
);
538 rel_type_nop
= R_386_NONE
;
539 make_nop
= make_nop_x86
;
540 ideal_nop
= ideal_nop5_x86_32
;
541 mcount_adjust_32
= -1;
545 reltype
= R_ARM_ABS32
;
546 altmcount
= "__gnu_mcount_nc";
547 make_nop
= make_nop_arm
;
548 rel_type_nop
= R_ARM_NONE
;
549 is_fake_mcount32
= arm_is_fake_mcount
;
553 reltype
= R_AARCH64_ABS64
;
554 make_nop
= make_nop_arm64
;
555 rel_type_nop
= R_AARCH64_NONE
;
556 ideal_nop
= ideal_nop4_arm64
;
557 is_fake_mcount64
= arm64_is_fake_mcount
;
559 case EM_IA_64
: reltype
= R_IA64_IMM64
; break;
560 case EM_MIPS
: /* reltype: e_class */ break;
561 case EM_PPC
: reltype
= R_PPC_ADDR32
; break;
562 case EM_PPC64
: reltype
= R_PPC64_ADDR64
; break;
563 case EM_S390
: /* reltype: e_class */ break;
564 case EM_SH
: reltype
= R_SH_DIR32
; gpfx
= 0; break;
565 case EM_SPARCV9
: reltype
= R_SPARC_64
; break;
567 make_nop
= make_nop_x86
;
568 ideal_nop
= ideal_nop5_x86_64
;
569 reltype
= R_X86_64_64
;
570 rel_type_nop
= R_X86_64_NONE
;
571 mcount_adjust_64
= -1;
576 switch (ehdr
->e_ident
[EI_CLASS
]) {
578 fprintf(stderr
, "unrecognized ELF class %d %s\n",
579 ehdr
->e_ident
[EI_CLASS
], fname
);
582 if (w2(ehdr
->e_ehsize
) != sizeof(Elf32_Ehdr
)
583 || w2(ehdr
->e_shentsize
) != sizeof(Elf32_Shdr
)) {
585 "unrecognized ET_REL file: %s\n", fname
);
588 if (w2(ehdr
->e_machine
) == EM_MIPS
) {
590 is_fake_mcount32
= MIPS32_is_fake_mcount
;
592 if (do32(ehdr
, fname
, reltype
) < 0)
596 Elf64_Ehdr
*const ghdr
= (Elf64_Ehdr
*)ehdr
;
597 if (w2(ghdr
->e_ehsize
) != sizeof(Elf64_Ehdr
)
598 || w2(ghdr
->e_shentsize
) != sizeof(Elf64_Shdr
)) {
600 "unrecognized ET_REL file: %s\n", fname
);
603 if (w2(ghdr
->e_machine
) == EM_S390
) {
605 mcount_adjust_64
= -14;
607 if (w2(ghdr
->e_machine
) == EM_MIPS
) {
609 Elf64_r_sym
= MIPS64_r_sym
;
610 Elf64_r_info
= MIPS64_r_info
;
611 is_fake_mcount64
= MIPS64_is_fake_mcount
;
613 if (do64(ghdr
, fname
, reltype
) < 0)
619 rc
= write_file(fname
);
621 file_append_cleanup();
626 int main(int argc
, char *argv
[])
628 const char ftrace
[] = "/ftrace.o";
629 int ftrace_size
= sizeof(ftrace
) - 1;
630 int n_error
= 0; /* gcc-4.3.0 false positive complaint */
634 while ((c
= getopt(argc
, argv
, "w")) >= 0) {
637 warn_on_notrace_sect
= 1;
640 fprintf(stderr
, "usage: recordmcount [-w] file.o...\n");
645 if ((argc
- optind
) < 1) {
646 fprintf(stderr
, "usage: recordmcount [-w] file.o...\n");
650 /* Process each file in turn, allowing deep failure. */
651 for (i
= optind
; i
< argc
; i
++) {
652 char *file
= argv
[i
];
656 * The file kernel/trace/ftrace.o references the mcount
657 * function but does not call it. Since ftrace.o should
658 * not be traced anyway, we just skip it.
661 if (len
>= ftrace_size
&&
662 strcmp(file
+ (len
- ftrace_size
), ftrace
) == 0)
666 fprintf(stderr
, "%s: failed\n", file
);