Blame view
scripts/recordmcount.c
15 KB
81d3858d3
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
/* * recordmcount.c: construct a table of the locations of calls to 'mcount' * so that ftrace can find them quickly. * Copyright 2009 John F. Reiser <jreiser@BitWagon.com>. All rights reserved. * Licensed under the GNU General Public License, version 2 (GPLv2). * * Restructured to fit Linux format, as well as other updates: * Copyright 2010 Steven Rostedt <srostedt@redhat.com>, Red Hat Inc. */ /* * Strategy: alter the .o file in-place. * * Append a new STRTAB that has the new section names, followed by a new array * ElfXX_Shdr[] that has the new section headers, followed by the section * contents for __mcount_loc and its relocations. The old shstrtab strings, * and the old ElfXX_Shdr[] array, remain as "garbage" (commonly, a couple * kilobytes.) Subsequent processing by /bin/ld (or the kernel module loader) * will ignore the garbage regions, because they are not designated by the * new .e_shoff nor the new ElfXX_Shdr[]. [In order to remove the garbage, * then use "ld -r" to create a new file that omits the garbage.] */ #include <sys/types.h> #include <sys/mman.h> #include <sys/stat.h> |
dfad3d598
|
27 |
#include <getopt.h> |
81d3858d3
|
28 29 30 31 32 33 34 |
#include <elf.h> #include <fcntl.h> #include <setjmp.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <unistd.h> |
b2e1c26f0
|
35 36 37 38 |
/* * glibc synced up and added the metag number but didn't add the relocations. * Work around this in a crude manner for now. */ |
00512bdd4
|
39 |
#ifndef EM_METAG |
00512bdd4
|
40 |
#define EM_METAG 174 |
b2e1c26f0
|
41 42 |
#endif #ifndef R_METAG_ADDR32 |
00512bdd4
|
43 |
#define R_METAG_ADDR32 2 |
b2e1c26f0
|
44 45 |
#endif #ifndef R_METAG_NONE |
00512bdd4
|
46 47 |
#define R_METAG_NONE 3 #endif |
af64d2aa8
|
48 49 |
#ifndef EM_AARCH64 #define EM_AARCH64 183 |
2ee8a74f2
|
50 |
#define R_AARCH64_NONE 0 |
af64d2aa8
|
51 52 |
#define R_AARCH64_ABS64 257 #endif |
81d3858d3
|
53 54 |
static int fd_map; /* File descriptor for file being modified. */ static int mmap_failed; /* Boolean flag. */ |
81d3858d3
|
55 56 57 |
static char gpfx; /* prefix for global symbol name (sometimes '_') */ static struct stat sb; /* Remember .st_size, etc. */ static jmp_buf jmpenv; /* setjmp/longjmp per-file error escape */ |
ed60453fa
|
58 |
static const char *altmcount; /* alternate mcount symbol name */ |
dfad3d598
|
59 |
static int warn_on_notrace_sect; /* warn when section has mcount not being recorded */ |
a50bd4393
|
60 61 62 63 64 65 |
static void *file_map; /* pointer of the mapped file */ static void *file_end; /* pointer to the end of the mapped file */ static int file_updated; /* flag to state file was changed */ static void *file_ptr; /* current file pointer location */ static void *file_append; /* added to the end of the file */ static size_t file_append_size; /* how much is added to end of file */ |
81d3858d3
|
66 67 68 69 70 71 72 73 74 75 76 77 78 |
/* setjmp() return values */ enum { SJ_SETJMP = 0, /* hardwired first return */ SJ_FAIL, SJ_SUCCEED }; /* Per-file resource cleanup when multiple files. */ static void cleanup(void) { if (!mmap_failed) |
a50bd4393
|
79 |
munmap(file_map, sb.st_size); |
81d3858d3
|
80 |
else |
a50bd4393
|
81 82 83 84 85 86 |
free(file_map); file_map = NULL; free(file_append); file_append = NULL; file_append_size = 0; file_updated = 0; |
81d3858d3
|
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
} static void __attribute__((noreturn)) fail_file(void) { cleanup(); longjmp(jmpenv, SJ_FAIL); } static void __attribute__((noreturn)) succeed_file(void) { cleanup(); longjmp(jmpenv, SJ_SUCCEED); } /* ulseek, uread, ...: Check return value for errors. */ static off_t ulseek(int const fd, off_t const offset, int const whence) { |
a50bd4393
|
108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
switch (whence) { case SEEK_SET: file_ptr = file_map + offset; break; case SEEK_CUR: file_ptr += offset; break; case SEEK_END: file_ptr = file_map + (sb.st_size - offset); break; } if (file_ptr < file_map) { fprintf(stderr, "lseek: seek before file "); |
81d3858d3
|
122 123 |
fail_file(); } |
a50bd4393
|
124 |
return file_ptr - file_map; |
81d3858d3
|
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
} static size_t uread(int const fd, void *const buf, size_t const count) { size_t const n = read(fd, buf, count); if (n != count) { perror("read"); fail_file(); } return n; } static size_t uwrite(int const fd, void const *const buf, size_t const count) { |
a50bd4393
|
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
size_t cnt = count; off_t idx = 0; file_updated = 1; if (file_ptr + count >= file_end) { off_t aoffset = (file_ptr + count) - file_end; if (aoffset > file_append_size) { file_append = realloc(file_append, aoffset); file_append_size = aoffset; } if (!file_append) { perror("write"); fail_file(); } if (file_ptr < file_end) { cnt = file_end - file_ptr; } else { cnt = 0; idx = aoffset - count; } |
81d3858d3
|
163 |
} |
a50bd4393
|
164 165 166 167 168 169 170 171 172 |
if (cnt) memcpy(file_ptr, buf, cnt); if (cnt < count) memcpy(file_append + idx, buf + cnt, count - cnt); file_ptr += count; return count; |
81d3858d3
|
173 174 175 176 177 178 |
} static void * umalloc(size_t size) { void *const addr = malloc(size); |
dd5477ff3
|
179 |
if (addr == 0) { |
81d3858d3
|
180 181 182 183 184 185 |
fprintf(stderr, "malloc failed: %zu bytes ", size); fail_file(); } return addr; } |
ffd618fa3
|
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
static unsigned char ideal_nop5_x86_64[5] = { 0x0f, 0x1f, 0x44, 0x00, 0x00 }; static unsigned char ideal_nop5_x86_32[5] = { 0x3e, 0x8d, 0x74, 0x26, 0x00 }; static unsigned char *ideal_nop; static char rel_type_nop; static int (*make_nop)(void *map, size_t const offset); static int make_nop_x86(void *map, size_t const offset) { uint32_t *ptr; unsigned char *op; /* Confirm we have 0xe8 0x0 0x0 0x0 0x0 */ ptr = map + offset; if (*ptr != 0) return -1; op = map + offset - 1; if (*op != 0xe8) return -1; /* convert to nop */ ulseek(fd_map, offset - 1, SEEK_SET); uwrite(fd_map, ideal_nop, 5); return 0; } |
2ee8a74f2
|
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
static unsigned char ideal_nop4_arm64[4] = {0x1f, 0x20, 0x03, 0xd5}; static int make_nop_arm64(void *map, size_t const offset) { uint32_t *ptr; ptr = map + offset; /* bl <_mcount> is 0x94000000 before relocation */ if (*ptr != 0x94000000) return -1; /* Convert to nop */ ulseek(fd_map, offset, SEEK_SET); uwrite(fd_map, ideal_nop, 4); return 0; } |
81d3858d3
|
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
/* * Get the whole file as a programming convenience in order to avoid * malloc+lseek+read+free of many pieces. If successful, then mmap * avoids copying unused pieces; else just read the whole file. * Open for both read and write; new info will be appended to the file. * Use MAP_PRIVATE so that a few changes to the in-memory ElfXX_Ehdr * do not propagate to the file until an explicit overwrite at the last. * This preserves most aspects of consistency (all except .st_size) * for simultaneous readers of the file while we are appending to it. * However, multiple writers still are bad. We choose not to use * locking because it is expensive and the use case of kernel build * makes multiple writers unlikely. */ static void *mmap_file(char const *fname) { |
a50bd4393
|
243 |
fd_map = open(fname, O_RDONLY); |
dd5477ff3
|
244 |
if (fd_map < 0 || fstat(fd_map, &sb) < 0) { |
81d3858d3
|
245 246 247 248 249 250 251 252 |
perror(fname); fail_file(); } if (!S_ISREG(sb.st_mode)) { fprintf(stderr, "not a regular file: %s ", fname); fail_file(); } |
a50bd4393
|
253 254 |
file_map = mmap(0, sb.st_size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd_map, 0); |
81d3858d3
|
255 |
mmap_failed = 0; |
a50bd4393
|
256 |
if (file_map == MAP_FAILED) { |
81d3858d3
|
257 |
mmap_failed = 1; |
a50bd4393
|
258 259 |
file_map = umalloc(sb.st_size); uread(fd_map, file_map, sb.st_size); |
81d3858d3
|
260 |
} |
a50bd4393
|
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
close(fd_map); file_end = file_map + sb.st_size; return file_map; } static void write_file(const char *fname) { char tmp_file[strlen(fname) + 4]; size_t n; if (!file_updated) return; sprintf(tmp_file, "%s.rc", fname); /* * After reading the entire file into memory, delete it * and write it back, to prevent weird side effects of modifying * an object file in place. */ fd_map = open(tmp_file, O_WRONLY | O_TRUNC | O_CREAT, sb.st_mode); if (fd_map < 0) { perror(fname); fail_file(); } n = write(fd_map, file_map, sb.st_size); if (n != sb.st_size) { perror("write"); fail_file(); } if (file_append_size) { n = write(fd_map, file_append, file_append_size); if (n != file_append_size) { perror("write"); |
dd39a2653
|
297 298 |
fail_file(); } |
dd39a2653
|
299 |
} |
a50bd4393
|
300 301 302 303 304 |
close(fd_map); if (rename(tmp_file, fname) < 0) { perror(fname); fail_file(); } |
81d3858d3
|
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
} /* w8rev, w8nat, ...: Handle endianness. */ static uint64_t w8rev(uint64_t const x) { return ((0xff & (x >> (0 * 8))) << (7 * 8)) | ((0xff & (x >> (1 * 8))) << (6 * 8)) | ((0xff & (x >> (2 * 8))) << (5 * 8)) | ((0xff & (x >> (3 * 8))) << (4 * 8)) | ((0xff & (x >> (4 * 8))) << (3 * 8)) | ((0xff & (x >> (5 * 8))) << (2 * 8)) | ((0xff & (x >> (6 * 8))) << (1 * 8)) | ((0xff & (x >> (7 * 8))) << (0 * 8)); } static uint32_t w4rev(uint32_t const x) { return ((0xff & (x >> (0 * 8))) << (3 * 8)) | ((0xff & (x >> (1 * 8))) << (2 * 8)) | ((0xff & (x >> (2 * 8))) << (1 * 8)) | ((0xff & (x >> (3 * 8))) << (0 * 8)); } static uint32_t w2rev(uint16_t const x) { return ((0xff & (x >> (0 * 8))) << (1 * 8)) | ((0xff & (x >> (1 * 8))) << (0 * 8)); } static uint64_t w8nat(uint64_t const x) { return x; } static uint32_t w4nat(uint32_t const x) { return x; } static uint32_t w2nat(uint16_t const x) { return x; } static uint64_t (*w8)(uint64_t); static uint32_t (*w)(uint32_t); static uint32_t (*w2)(uint16_t); /* Names of the sections that could contain calls to mcount. */ static int is_mcounted_section_name(char const *const txtname) { |
dd5477ff3
|
358 359 360 361 362 |
return strcmp(".text", txtname) == 0 || strcmp(".ref.text", txtname) == 0 || strcmp(".sched.text", txtname) == 0 || strcmp(".spinlock.text", txtname) == 0 || strcmp(".irqentry.text", txtname) == 0 || |
9f087e761
|
363 |
strcmp(".kprobes.text", txtname) == 0 || |
dd5477ff3
|
364 |
strcmp(".text.unlikely", txtname) == 0; |
81d3858d3
|
365 |
} |
c28d5077f
|
366 367 368 369 |
/* 32 bit and 64 bit are very similar */ #include "recordmcount.h" #define RECORD_MCOUNT_64 #include "recordmcount.h" |
81d3858d3
|
370 |
|
a2d49358b
|
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 |
/* 64-bit EM_MIPS has weird ELF64_Rela.r_info. * http://techpubs.sgi.com/library/manuals/4000/007-4658-001/pdf/007-4658-001.pdf * We interpret Table 29 Relocation Operation (Elf64_Rel, Elf64_Rela) [p.40] * to imply the order of the members; the spec does not say so. * typedef unsigned char Elf64_Byte; * fails on MIPS64 because their <elf.h> already has it! */ typedef uint8_t myElf64_Byte; /* Type for a 8-bit quantity. */ union mips_r_info { Elf64_Xword r_info; struct { Elf64_Word r_sym; /* Symbol index. */ myElf64_Byte r_ssym; /* Special symbol. */ myElf64_Byte r_type3; /* Third relocation. */ myElf64_Byte r_type2; /* Second relocation. */ myElf64_Byte r_type; /* First relocation. */ } r_mips; }; static uint64_t MIPS64_r_sym(Elf64_Rel const *rp) { return w(((union mips_r_info){ .r_info = rp->r_info }).r_mips.r_sym); } static void MIPS64_r_info(Elf64_Rel *const rp, unsigned sym, unsigned type) { rp->r_info = ((union mips_r_info){ .r_mips = { .r_sym = w(sym), .r_type = type } }).r_info; } |
81d3858d3
|
403 404 405 406 407 |
static void do_file(char const *const fname) { Elf32_Ehdr *const ehdr = mmap_file(fname); unsigned int reltype = 0; |
81d3858d3
|
408 409 410 411 412 |
w = w4nat; w2 = w2nat; w8 = w8nat; switch (ehdr->e_ident[EI_DATA]) { static unsigned int const endian = 1; |
e90b0c8bf
|
413 |
default: |
81d3858d3
|
414 415 416 417 |
fprintf(stderr, "unrecognized ELF data encoding %d: %s ", ehdr->e_ident[EI_DATA], fname); fail_file(); |
e90b0c8bf
|
418 419 |
break; case ELFDATA2LSB: |
dd5477ff3
|
420 |
if (*(unsigned char const *)&endian != 1) { |
81d3858d3
|
421 422 423 424 425 |
/* main() is big endian, file.o is little endian. */ w = w4rev; w2 = w2rev; w8 = w8rev; } |
e90b0c8bf
|
426 427 |
break; case ELFDATA2MSB: |
dd5477ff3
|
428 |
if (*(unsigned char const *)&endian != 0) { |
81d3858d3
|
429 430 431 432 433 |
/* main() is little endian, file.o is big endian. */ w = w4rev; w2 = w2rev; w8 = w8rev; } |
e90b0c8bf
|
434 |
break; |
81d3858d3
|
435 |
} /* end switch */ |
dd5477ff3
|
436 437 438 |
if (memcmp(ELFMAG, ehdr->e_ident, SELFMAG) != 0 || w2(ehdr->e_type) != ET_REL || ehdr->e_ident[EI_VERSION] != EV_CURRENT) { |
81d3858d3
|
439 440 441 442 443 444 445 |
fprintf(stderr, "unrecognized ET_REL file %s ", fname); fail_file(); } gpfx = 0; switch (w2(ehdr->e_machine)) { |
e90b0c8bf
|
446 |
default: |
81d3858d3
|
447 448 449 450 |
fprintf(stderr, "unrecognized e_machine %d %s ", w2(ehdr->e_machine), fname); fail_file(); |
e90b0c8bf
|
451 |
break; |
ffd618fa3
|
452 453 |
case EM_386: reltype = R_386_32; |
46a2b61ec
|
454 |
rel_type_nop = R_386_NONE; |
ffd618fa3
|
455 456 |
make_nop = make_nop_x86; ideal_nop = ideal_nop5_x86_32; |
521ccb5c4
|
457 |
mcount_adjust_32 = -1; |
ffd618fa3
|
458 |
break; |
ed60453fa
|
459 460 461 |
case EM_ARM: reltype = R_ARM_ABS32; altmcount = "__gnu_mcount_nc"; break; |
af64d2aa8
|
462 |
case EM_AARCH64: |
2ee8a74f2
|
463 464 465 466 467 468 |
reltype = R_AARCH64_ABS64; make_nop = make_nop_arm64; rel_type_nop = R_AARCH64_NONE; ideal_nop = ideal_nop4_arm64; gpfx = '_'; break; |
81d3858d3
|
469 |
case EM_IA_64: reltype = R_IA64_IMM64; gpfx = '_'; break; |
00512bdd4
|
470 471 472 473 474 475 |
case EM_METAG: reltype = R_METAG_ADDR32; altmcount = "_mcount_wrapper"; rel_type_nop = R_METAG_NONE; /* We happen to have the same requirement as MIPS */ is_fake_mcount32 = MIPS32_is_fake_mcount; break; |
a2d49358b
|
476 |
case EM_MIPS: /* reltype: e_class */ gpfx = '_'; break; |
81d3858d3
|
477 478 479 480 481 |
case EM_PPC: reltype = R_PPC_ADDR32; gpfx = '_'; break; case EM_PPC64: reltype = R_PPC64_ADDR64; gpfx = '_'; break; case EM_S390: /* reltype: e_class */ gpfx = '_'; break; case EM_SH: reltype = R_SH_DIR32; break; case EM_SPARCV9: reltype = R_SPARC_64; gpfx = '_'; break; |
ffd618fa3
|
482 483 484 485 |
case EM_X86_64: make_nop = make_nop_x86; ideal_nop = ideal_nop5_x86_64; reltype = R_X86_64_64; |
46a2b61ec
|
486 |
rel_type_nop = R_X86_64_NONE; |
521ccb5c4
|
487 |
mcount_adjust_64 = -1; |
ffd618fa3
|
488 |
break; |
81d3858d3
|
489 490 491 |
} /* end switch */ switch (ehdr->e_ident[EI_CLASS]) { |
e90b0c8bf
|
492 |
default: |
81d3858d3
|
493 494 495 496 |
fprintf(stderr, "unrecognized ELF class %d %s ", ehdr->e_ident[EI_CLASS], fname); fail_file(); |
e90b0c8bf
|
497 498 |
break; case ELFCLASS32: |
dd5477ff3
|
499 500 |
if (w2(ehdr->e_ehsize) != sizeof(Elf32_Ehdr) || w2(ehdr->e_shentsize) != sizeof(Elf32_Shdr)) { |
81d3858d3
|
501 502 503 504 505 |
fprintf(stderr, "unrecognized ET_REL file: %s ", fname); fail_file(); } |
dd5477ff3
|
506 |
if (w2(ehdr->e_machine) == EM_MIPS) { |
a2d49358b
|
507 |
reltype = R_MIPS_32; |
412910cd0
|
508 509 |
is_fake_mcount32 = MIPS32_is_fake_mcount; } |
81d3858d3
|
510 |
do32(ehdr, fname, reltype); |
e90b0c8bf
|
511 |
break; |
81d3858d3
|
512 513 |
case ELFCLASS64: { Elf64_Ehdr *const ghdr = (Elf64_Ehdr *)ehdr; |
dd5477ff3
|
514 515 |
if (w2(ghdr->e_ehsize) != sizeof(Elf64_Ehdr) || w2(ghdr->e_shentsize) != sizeof(Elf64_Shdr)) { |
81d3858d3
|
516 517 518 519 520 |
fprintf(stderr, "unrecognized ET_REL file: %s ", fname); fail_file(); } |
f29638868
|
521 |
if (w2(ghdr->e_machine) == EM_S390) { |
81d3858d3
|
522 |
reltype = R_390_64; |
c933146a5
|
523 |
mcount_adjust_64 = -14; |
f29638868
|
524 |
} |
dd5477ff3
|
525 |
if (w2(ghdr->e_machine) == EM_MIPS) { |
a2d49358b
|
526 527 528 |
reltype = R_MIPS_64; Elf64_r_sym = MIPS64_r_sym; Elf64_r_info = MIPS64_r_info; |
412910cd0
|
529 |
is_fake_mcount64 = MIPS64_is_fake_mcount; |
a2d49358b
|
530 |
} |
81d3858d3
|
531 |
do64(ghdr, fname, reltype); |
e90b0c8bf
|
532 533 |
break; } |
81d3858d3
|
534 |
} /* end switch */ |
a50bd4393
|
535 |
write_file(fname); |
81d3858d3
|
536 537 538 539 |
cleanup(); } int |
dfad3d598
|
540 |
main(int argc, char *argv[]) |
81d3858d3
|
541 |
{ |
cd3478f2b
|
542 |
const char ftrace[] = "/ftrace.o"; |
444758636
|
543 |
int ftrace_size = sizeof(ftrace) - 1; |
81d3858d3
|
544 |
int n_error = 0; /* gcc-4.3.0 false positive complaint */ |
dfad3d598
|
545 546 |
int c; int i; |
444758636
|
547 |
|
dfad3d598
|
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 |
while ((c = getopt(argc, argv, "w")) >= 0) { switch (c) { case 'w': warn_on_notrace_sect = 1; break; default: fprintf(stderr, "usage: recordmcount [-w] file.o... "); return 0; } } if ((argc - optind) < 1) { fprintf(stderr, "usage: recordmcount [-w] file.o... "); |
444758636
|
563 564 565 566 |
return 0; } /* Process each file in turn, allowing deep failure. */ |
dfad3d598
|
567 568 |
for (i = optind; i < argc; i++) { char *file = argv[i]; |
81d3858d3
|
569 |
int const sjval = setjmp(jmpenv); |
444758636
|
570 571 572 573 574 575 576 |
int len; /* * The file kernel/trace/ftrace.o references the mcount * function but does not call it. Since ftrace.o should * not be traced anyway, we just skip it. */ |
dfad3d598
|
577 |
len = strlen(file); |
444758636
|
578 |
if (len >= ftrace_size && |
dfad3d598
|
579 |
strcmp(file + (len - ftrace_size), ftrace) == 0) |
444758636
|
580 |
continue; |
81d3858d3
|
581 |
switch (sjval) { |
e90b0c8bf
|
582 |
default: |
dfad3d598
|
583 584 |
fprintf(stderr, "internal error: %s ", file); |
81d3858d3
|
585 |
exit(1); |
e90b0c8bf
|
586 587 |
break; case SJ_SETJMP: /* normal sequence */ |
81d3858d3
|
588 589 |
/* Avoid problems if early cleanup() */ fd_map = -1; |
81d3858d3
|
590 |
mmap_failed = 1; |
a50bd4393
|
591 592 593 |
file_map = NULL; file_ptr = NULL; file_updated = 0; |
dfad3d598
|
594 |
do_file(file); |
e90b0c8bf
|
595 596 |
break; case SJ_FAIL: /* error in do_file or below */ |
713a3e4de
|
597 598 |
fprintf(stderr, "%s: failed ", file); |
81d3858d3
|
599 |
++n_error; |
e90b0c8bf
|
600 601 |
break; case SJ_SUCCEED: /* premature success */ |
81d3858d3
|
602 |
/* do nothing */ |
e90b0c8bf
|
603 |
break; |
81d3858d3
|
604 605 606 607 |
} /* end switch */ } return !!n_error; } |