6faf6c654e8f32d39803e7c379e44e780168aebd
2 * recordmcount.c: construct a table of the locations of calls to 'mcount'
3 * so that ftrace can find them quickly.
4 * Copyright 2009 John F. Reiser <jreiser@BitWagon.com>. All rights reserved.
5 * Licensed under the GNU General Public License, version 2 (GPLv2).
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>
37 /* Remove this when these make it to the standard system elf.h. */
39 #define R_METAG_ADDR32 2
40 #define R_METAG_NONE 3
44 #define EM_AARCH64 183
45 #define R_AARCH64_ABS64 257
48 static int fd_map
; /* File descriptor for file being modified. */
49 static int mmap_failed
; /* Boolean flag. */
50 static void *ehdr_curr
; /* current ElfXX_Ehdr * for resource cleanup */
51 static char gpfx
; /* prefix for global symbol name (sometimes '_') */
52 static struct stat sb
; /* Remember .st_size, etc. */
53 static jmp_buf jmpenv
; /* setjmp/longjmp per-file error escape */
54 static const char *altmcount
; /* alternate mcount symbol name */
55 static int warn_on_notrace_sect
; /* warn when section has mcount not being recorded */
57 /* setjmp() return values */
59 SJ_SETJMP
= 0, /* hardwired first return */
64 /* Per-file resource cleanup when multiple files. */
69 munmap(ehdr_curr
, sb
.st_size
);
75 static void __attribute__((noreturn
))
79 longjmp(jmpenv
, SJ_FAIL
);
82 static void __attribute__((noreturn
))
86 longjmp(jmpenv
, SJ_SUCCEED
);
89 /* ulseek, uread, ...: Check return value for errors. */
92 ulseek(int const fd
, off_t
const offset
, int const whence
)
94 off_t
const w
= lseek(fd
, offset
, whence
);
103 uread(int const fd
, void *const buf
, size_t const count
)
105 size_t const n
= read(fd
, buf
, count
);
114 uwrite(int const fd
, void const *const buf
, size_t const count
)
116 size_t const n
= write(fd
, buf
, count
);
127 void *const addr
= malloc(size
);
129 fprintf(stderr
, "malloc failed: %zu bytes\n", size
);
135 static unsigned char ideal_nop5_x86_64
[5] = { 0x0f, 0x1f, 0x44, 0x00, 0x00 };
136 static unsigned char ideal_nop5_x86_32
[5] = { 0x3e, 0x8d, 0x74, 0x26, 0x00 };
137 static unsigned char *ideal_nop
;
139 static char rel_type_nop
;
141 static int (*make_nop
)(void *map
, size_t const offset
);
143 static int make_nop_x86(void *map
, size_t const offset
)
148 /* Confirm we have 0xe8 0x0 0x0 0x0 0x0 */
153 op
= map
+ offset
- 1;
158 ulseek(fd_map
, offset
- 1, SEEK_SET
);
159 uwrite(fd_map
, ideal_nop
, 5);
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
)
180 fd_map
= open(fname
, O_RDWR
);
181 if (fd_map
< 0 || fstat(fd_map
, &sb
) < 0) {
185 if (!S_ISREG(sb
.st_mode
)) {
186 fprintf(stderr
, "not a regular file: %s\n", fname
);
189 addr
= mmap(0, sb
.st_size
, PROT_READ
|PROT_WRITE
, MAP_PRIVATE
,
192 if (addr
== MAP_FAILED
) {
194 addr
= umalloc(sb
.st_size
);
195 uread(fd_map
, addr
, sb
.st_size
);
197 if (sb
.st_nlink
!= 1) {
198 /* file is hard-linked, break the hard link */
200 if (unlink(fname
) < 0) {
204 fd_map
= open(fname
, O_RDWR
| O_CREAT
, sb
.st_mode
);
209 uwrite(fd_map
, addr
, sb
.st_size
);
214 /* w8rev, w8nat, ...: Handle endianness. */
216 static uint64_t w8rev(uint64_t const x
)
218 return ((0xff & (x
>> (0 * 8))) << (7 * 8))
219 | ((0xff & (x
>> (1 * 8))) << (6 * 8))
220 | ((0xff & (x
>> (2 * 8))) << (5 * 8))
221 | ((0xff & (x
>> (3 * 8))) << (4 * 8))
222 | ((0xff & (x
>> (4 * 8))) << (3 * 8))
223 | ((0xff & (x
>> (5 * 8))) << (2 * 8))
224 | ((0xff & (x
>> (6 * 8))) << (1 * 8))
225 | ((0xff & (x
>> (7 * 8))) << (0 * 8));
228 static uint32_t w4rev(uint32_t const x
)
230 return ((0xff & (x
>> (0 * 8))) << (3 * 8))
231 | ((0xff & (x
>> (1 * 8))) << (2 * 8))
232 | ((0xff & (x
>> (2 * 8))) << (1 * 8))
233 | ((0xff & (x
>> (3 * 8))) << (0 * 8));
236 static uint32_t w2rev(uint16_t const x
)
238 return ((0xff & (x
>> (0 * 8))) << (1 * 8))
239 | ((0xff & (x
>> (1 * 8))) << (0 * 8));
242 static uint64_t w8nat(uint64_t const x
)
247 static uint32_t w4nat(uint32_t const x
)
252 static uint32_t w2nat(uint16_t const x
)
257 static uint64_t (*w8
)(uint64_t);
258 static uint32_t (*w
)(uint32_t);
259 static uint32_t (*w2
)(uint16_t);
261 /* Names of the sections that could contain calls to mcount. */
263 is_mcounted_section_name(char const *const txtname
)
265 return strcmp(".text", txtname
) == 0 ||
266 strcmp(".ref.text", txtname
) == 0 ||
267 strcmp(".sched.text", txtname
) == 0 ||
268 strcmp(".spinlock.text", txtname
) == 0 ||
269 strcmp(".irqentry.text", txtname
) == 0 ||
270 strcmp(".kprobes.text", txtname
) == 0 ||
271 strcmp(".text.unlikely", txtname
) == 0;
274 /* 32 bit and 64 bit are very similar */
275 #include "recordmcount.h"
276 #define RECORD_MCOUNT_64
277 #include "recordmcount.h"
279 /* 64-bit EM_MIPS has weird ELF64_Rela.r_info.
280 * http://techpubs.sgi.com/library/manuals/4000/007-4658-001/pdf/007-4658-001.pdf
281 * We interpret Table 29 Relocation Operation (Elf64_Rel, Elf64_Rela) [p.40]
282 * to imply the order of the members; the spec does not say so.
283 * typedef unsigned char Elf64_Byte;
284 * fails on MIPS64 because their <elf.h> already has it!
287 typedef uint8_t myElf64_Byte
; /* Type for a 8-bit quantity. */
292 Elf64_Word r_sym
; /* Symbol index. */
293 myElf64_Byte r_ssym
; /* Special symbol. */
294 myElf64_Byte r_type3
; /* Third relocation. */
295 myElf64_Byte r_type2
; /* Second relocation. */
296 myElf64_Byte r_type
; /* First relocation. */
300 static uint64_t MIPS64_r_sym(Elf64_Rel
const *rp
)
302 return w(((union mips_r_info
){ .r_info
= rp
->r_info
}).r_mips
.r_sym
);
305 static void MIPS64_r_info(Elf64_Rel
*const rp
, unsigned sym
, unsigned type
)
307 rp
->r_info
= ((union mips_r_info
){
308 .r_mips
= { .r_sym
= w(sym
), .r_type
= type
}
313 do_file(char const *const fname
)
315 Elf32_Ehdr
*const ehdr
= mmap_file(fname
);
316 unsigned int reltype
= 0;
322 switch (ehdr
->e_ident
[EI_DATA
]) {
323 static unsigned int const endian
= 1;
325 fprintf(stderr
, "unrecognized ELF data encoding %d: %s\n",
326 ehdr
->e_ident
[EI_DATA
], fname
);
330 if (*(unsigned char const *)&endian
!= 1) {
331 /* main() is big endian, file.o is little endian. */
338 if (*(unsigned char const *)&endian
!= 0) {
339 /* main() is little endian, file.o is big endian. */
346 if (memcmp(ELFMAG
, ehdr
->e_ident
, SELFMAG
) != 0
347 || w2(ehdr
->e_type
) != ET_REL
348 || ehdr
->e_ident
[EI_VERSION
] != EV_CURRENT
) {
349 fprintf(stderr
, "unrecognized ET_REL file %s\n", fname
);
354 switch (w2(ehdr
->e_machine
)) {
356 fprintf(stderr
, "unrecognized e_machine %d %s\n",
357 w2(ehdr
->e_machine
), fname
);
362 make_nop
= make_nop_x86
;
363 ideal_nop
= ideal_nop5_x86_32
;
364 mcount_adjust_32
= -1;
366 case EM_ARM
: reltype
= R_ARM_ABS32
;
367 altmcount
= "__gnu_mcount_nc";
370 reltype
= R_AARCH64_ABS64
; gpfx
= '_'; break;
371 case EM_IA_64
: reltype
= R_IA64_IMM64
; gpfx
= '_'; break;
372 case EM_METAG
: reltype
= R_METAG_ADDR32
;
373 altmcount
= "_mcount_wrapper";
374 rel_type_nop
= R_METAG_NONE
;
375 /* We happen to have the same requirement as MIPS */
376 is_fake_mcount32
= MIPS32_is_fake_mcount
;
378 case EM_MIPS
: /* reltype: e_class */ gpfx
= '_'; break;
379 case EM_PPC
: reltype
= R_PPC_ADDR32
; gpfx
= '_'; break;
380 case EM_PPC64
: reltype
= R_PPC64_ADDR64
; gpfx
= '_'; break;
381 case EM_S390
: /* reltype: e_class */ gpfx
= '_'; break;
382 case EM_SH
: reltype
= R_SH_DIR32
; break;
383 case EM_SPARCV9
: reltype
= R_SPARC_64
; gpfx
= '_'; break;
385 make_nop
= make_nop_x86
;
386 ideal_nop
= ideal_nop5_x86_64
;
387 reltype
= R_X86_64_64
;
388 mcount_adjust_64
= -1;
392 switch (ehdr
->e_ident
[EI_CLASS
]) {
394 fprintf(stderr
, "unrecognized ELF class %d %s\n",
395 ehdr
->e_ident
[EI_CLASS
], fname
);
399 if (w2(ehdr
->e_ehsize
) != sizeof(Elf32_Ehdr
)
400 || w2(ehdr
->e_shentsize
) != sizeof(Elf32_Shdr
)) {
402 "unrecognized ET_REL file: %s\n", fname
);
405 if (w2(ehdr
->e_machine
) == EM_S390
) {
407 mcount_adjust_32
= -4;
409 if (w2(ehdr
->e_machine
) == EM_MIPS
) {
411 is_fake_mcount32
= MIPS32_is_fake_mcount
;
413 do32(ehdr
, fname
, reltype
);
416 Elf64_Ehdr
*const ghdr
= (Elf64_Ehdr
*)ehdr
;
417 if (w2(ghdr
->e_ehsize
) != sizeof(Elf64_Ehdr
)
418 || w2(ghdr
->e_shentsize
) != sizeof(Elf64_Shdr
)) {
420 "unrecognized ET_REL file: %s\n", fname
);
423 if (w2(ghdr
->e_machine
) == EM_S390
) {
425 mcount_adjust_64
= -8;
427 if (w2(ghdr
->e_machine
) == EM_MIPS
) {
429 Elf64_r_sym
= MIPS64_r_sym
;
430 Elf64_r_info
= MIPS64_r_info
;
431 is_fake_mcount64
= MIPS64_is_fake_mcount
;
433 do64(ghdr
, fname
, reltype
);
442 main(int argc
, char *argv
[])
444 const char ftrace
[] = "/ftrace.o";
445 int ftrace_size
= sizeof(ftrace
) - 1;
446 int n_error
= 0; /* gcc-4.3.0 false positive complaint */
450 while ((c
= getopt(argc
, argv
, "w")) >= 0) {
453 warn_on_notrace_sect
= 1;
456 fprintf(stderr
, "usage: recordmcount [-w] file.o...\n");
461 if ((argc
- optind
) < 1) {
462 fprintf(stderr
, "usage: recordmcount [-w] file.o...\n");
466 /* Process each file in turn, allowing deep failure. */
467 for (i
= optind
; i
< argc
; i
++) {
468 char *file
= argv
[i
];
469 int const sjval
= setjmp(jmpenv
);
473 * The file kernel/trace/ftrace.o references the mcount
474 * function but does not call it. Since ftrace.o should
475 * not be traced anyway, we just skip it.
478 if (len
>= ftrace_size
&&
479 strcmp(file
+ (len
- ftrace_size
), ftrace
) == 0)
484 fprintf(stderr
, "internal error: %s\n", file
);
487 case SJ_SETJMP
: /* normal sequence */
488 /* Avoid problems if early cleanup() */
494 case SJ_FAIL
: /* error in do_file or below */
497 case SJ_SUCCEED
: /* premature success */