2 # (c) 2008, Steven Rostedt <srostedt@redhat.com>
3 # Licensed under the terms of the GNU GPL License version 2
5 # recordmcount.pl - makes a section called __mcount_loc that holds
6 # all the offsets to the calls to mcount.
9 # What we want to end up with this is that each object file will have a
10 # section called __mcount_loc that will hold the list of pointers to mcount
11 # callers. After final linking, the vmlinux will have within .init.data the
12 # list of all callers to mcount between __start_mcount_loc and __stop_mcount_loc.
13 # Later on boot up, the kernel will read this list, save the locations and turn
14 # them into nops. When tracing or profiling is later enabled, these locations
15 # will then be converted back to pointers to some function.
17 # This is no easy feat. This script is called just after the original
18 # object is compiled and before it is linked.
20 # When parse this object file using 'objdump', the references to the call
21 # sites are offsets from the section that the call site is in. Hence, all
22 # functions in a section that has a call site to mcount, will have the
23 # offset from the beginning of the section and not the beginning of the
26 # But where this section will reside finally in vmlinx is undetermined at
27 # this point. So we can't use this kind of offsets to record the final
28 # address of this call site.
30 # The trick is to change the call offset referring the start of a section to
31 # referring a function symbol in this section. During the link step, 'ld' will
32 # compute the final address according to the information we record.
36 # .section ".sched.text", "ax"
40 # call mcount (offset: 0x10)
44 # func2: (offset: 0x20)
50 # call mcount (offset: 0x30)
53 # Both relocation offsets for the mcounts in the above example will be
54 # offset from .sched.text. If we choose global symbol func2 as a reference and
55 # make another file called tmp.s with the new offsets:
57 # .section __mcount_loc
61 # We can then compile this tmp.s into tmp.o, and link it back to the original
64 # In our algorithm, we will choose the first global function we meet in this
65 # section as the reference. But this gets hard if there is no global functions
66 # in this section. In such a case we have to select a local one. E.g. func1:
68 # .section ".sched.text", "ax"
71 # call mcount (offset: 0x10)
76 # call mcount (offset: 0x20)
78 # .section "other.section"
80 # If we make the tmp.s the same as above, when we link together with
81 # the original object, we will end up with two symbols for func1:
82 # one local, one global. After final compile, we will end up with
83 # an undefined reference to func1 or a wrong reference to another global
84 # func1 in other files.
86 # Since local objects can reference local variables, we need to find
87 # a way to make tmp.o reference the local objects of the original object
88 # file after it is linked together. To do this, we convert func1
89 # into a global symbol before linking tmp.o. Then after we link tmp.o
90 # we will only have a single symbol for func1 that is global.
91 # We can convert func1 back into a local symbol and we are done.
93 # Here are the steps we take:
95 # 1) Record all the local and weak symbols by using 'nm'
96 # 2) Use objdump to find all the call site offsets and sections for
98 # 3) Compile the list into its own object.
99 # 4) Do we have to deal with local functions? If not, go to step 8.
100 # 5) Make an object that converts these local functions to global symbols
102 # 6) Link together this new object with the list object.
103 # 7) Convert the local functions back to local symbols and rename
104 # the result as the original object.
105 # 8) Link the object with the list object.
106 # 9) Move the result back to the original object.
117 print "usage: $P arch endian bits objdump objcopy cc ld nm rm mv is_module inputfile\n";
118 print "version: $V\n";
122 my ($arch, $endian, $bits, $objdump, $objcopy, $cc,
123 $ld, $nm, $rm, $mv, $is_module, $inputfile) = @ARGV;
125 # This file refers to mcount and shouldn't be ftraced, so lets' ignore it
126 if ($inputfile =~ m,kernel/trace/ftrace\.o$,) {
130 # Acceptable sections to record.
131 my %text_sections = (
135 ".spinlock.text" => 1,
136 ".irqentry.text" => 1,
137 ".softirqentry.text" => 1,
138 ".kprobes.text" => 1,
139 ".cpuidle.text" => 1,
140 ".text.unlikely" => 1,
143 # Acceptable section-prefixes to record.
144 my %text_section_prefixes = (
148 # Note: we are nice to C-programmers here, thus we skip the '||='-idiom.
149 $objdump = 'objdump' if (!$objdump);
150 $objcopy = 'objcopy' if (!$objcopy);
151 $cc = 'gcc' if (!$cc);
152 $ld = 'ld' if (!$ld);
153 $nm = 'nm' if (!$nm);
154 $rm = 'rm' if (!$rm);
155 $mv = 'mv' if (!$mv);
157 #print STDERR "running: $P '$arch' '$objdump' '$objcopy' '$cc' '$ld' " .
158 # "'$nm' '$rm' '$mv' '$inputfile'\n";
160 my %locals; # List of local (static) functions
161 my %weak; # List of weak functions
162 my %convert; # List of local functions used that needs conversion
165 my $local_regex; # Match a local function (return function)
166 my $weak_regex; # Match a weak function (return function)
167 my $section_regex; # Find the start of a section
168 my $function_regex; # Find the name of a function
169 # (return offset and func name)
170 my $mcount_regex; # Find the call site to mcount (return offset)
171 my $mcount_adjust; # Address adjustment to mcount offset
172 my $alignment; # The .align value to use for $mcount_section
173 my $section_type; # Section header plus possible alignment command
174 my $can_use_local = 0; # If we can use local function references
176 # Shut up recordmcount if user has older objcopy
177 my $quiet_recordmcount = ".tmp_quiet_recordmcount";
178 my $print_warning = 1;
179 $print_warning = 0 if ( -f $quiet_recordmcount);
182 # check_objcopy - whether objcopy supports --globalize-symbols
184 # --globalize-symbols came out in 2.17, we must test the version
185 # of objcopy, and if it is less than 2.17, then we can not
186 # record local functions.
189 open (IN, "$objcopy --version |") or die "error running $objcopy";
191 if (/objcopy.*\s(\d+)\.(\d+)/) {
192 $can_use_local = 1 if ($1 > 2 || ($1 == 2 && $2 >= 17));
198 if (!$can_use_local && $print_warning) {
199 print STDERR "WARNING: could not find objcopy version or version " .
200 "is less than 2.17.\n" .
201 "\tLocal function references are disabled.\n";
202 open (QUIET, ">$quiet_recordmcount");
203 printf QUIET "Disables the warning from recordmcount.pl\n";
208 if ($arch =~ /(x86(_64)?)|(i386)/) {
217 # We base the defaults off of i386, the other archs may
218 # feel free to change them in the below if statements.
220 $local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\S+)";
221 $weak_regex = "^[0-9a-fA-F]+\\s+([wW])\\s+(\\S+)";
222 $section_regex = "Disassembly of section\\s+(\\S+):";
223 $function_regex = "^([0-9a-fA-F]+)\\s+<(.*?)>:";
224 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s(mcount|__fentry__)\$";
225 $section_type = '@progbits';
229 if ($arch eq "x86_64") {
230 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s(mcount|__fentry__)([+-]0x[0-9a-zA-Z]+)?\$";
235 # force flags for this arch
236 $ld .= " -m elf_x86_64";
237 $objdump .= " -M x86-64";
238 $objcopy .= " -O elf64-x86-64";
241 } elsif ($arch eq "i386") {
245 # force flags for this arch
246 $ld .= " -m elf_i386";
247 $objdump .= " -M i386";
248 $objcopy .= " -O elf32-i386";
251 } elsif ($arch eq "s390" && $bits == 64) {
252 if ($cc =~ /-DCC_USING_HOTPATCH/) {
253 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*c0 04 00 00 00 00\\s*(brcl\\s*0,|jgnop\\s*)[0-9a-f]+ <([^\+]*)>\$";
256 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_390_(PC|PLT)32DBL\\s+_mcount\\+0x2\$";
257 $mcount_adjust = -14;
261 $ld .= " -m elf64_s390";
264 } elsif ($arch eq "sh") {
267 # force flags for this arch
268 $ld .= " -m shlelf_linux";
269 if ($endian eq "big") {
270 $objcopy .= " -O elf32-shbig-linux";
272 $objcopy .= " -O elf32-sh-linux";
275 } elsif ($arch eq "powerpc") {
276 $local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\.?\\S+)";
277 # See comment in the sparc64 section for why we use '\w'.
278 $function_regex = "^([0-9a-fA-F]+)\\s+<(\\.?\\w*?)>:";
279 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s\\.?_mcount\$";
285 } elsif ($arch eq "arm") {
287 $section_type = '%progbits';
288 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_ARM_(CALL|PC24|THM_CALL)" .
289 "\\s+(__gnu_mcount_nc|mcount)\$";
291 } elsif ($arch eq "arm64") {
293 $section_type = '%progbits';
294 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_AARCH64_CALL26\\s+_mcount\$";
296 } elsif ($arch eq "ia64") {
297 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
300 if ($is_module eq "0") {
301 $cc .= " -mconstant-gp";
303 } elsif ($arch eq "sparc64") {
304 # In the objdump output there are giblets like:
305 # 0000000000000000 <igmp_net_exit-0x18>:
306 # As there's some data blobs that get emitted into the
307 # text section before the first instructions and the first
308 # real symbols. We don't want to match that, so to combat
309 # this we use '\w' so we'll match just plain symbol names,
310 # and not those that also include hex offsets inside of the
311 # '<>' brackets. Actually the generic function_regex setting
312 # could safely use this too.
313 $function_regex = "^([0-9a-fA-F]+)\\s+<(\\w*?)>:";
315 # Sparc64 calls '_mcount' instead of plain 'mcount'.
316 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
320 $ld .= " -m elf64_sparc";
322 $objcopy .= " -O elf64-sparc";
323 } elsif ($arch eq "mips") {
324 # To enable module support, we need to enable the -mlong-calls option
325 # of gcc for module, after using this option, we can not get the real
326 # offset of the calling to _mcount, but the offset of the lui
327 # instruction or the addiu one. herein, we record the address of the
328 # first one, and then we can replace this instruction by a branch
329 # instruction to jump over the profiling function to filter the
330 # indicated functions, or swith back to the lui instruction to trace
331 # them, which means dynamic tracing.
333 # c: 3c030000 lui v1,0x0
334 # c: R_MIPS_HI16 _mcount
335 # c: R_MIPS_NONE *ABS*
336 # c: R_MIPS_NONE *ABS*
337 # 10: 64630000 daddiu v1,v1,0
338 # 10: R_MIPS_LO16 _mcount
339 # 10: R_MIPS_NONE *ABS*
340 # 10: R_MIPS_NONE *ABS*
341 # 14: 03e0082d move at,ra
342 # 18: 0060f809 jalr v1
346 # 10: 03e0082d move at,ra
347 # 14: 0c000000 jal 0 <loongson_halt>
348 # 14: R_MIPS_26 _mcount
349 # 14: R_MIPS_NONE *ABS*
350 # 14: R_MIPS_NONE *ABS*
352 if ($is_module eq "0") {
353 $mcount_regex = "^\\s*([0-9a-fA-F]+): R_MIPS_26\\s+_mcount\$";
355 $mcount_regex = "^\\s*([0-9a-fA-F]+): R_MIPS_HI16\\s+_mcount\$";
357 $objdump .= " -Melf-trad".$endian."mips ";
359 if ($endian eq "big") {
361 $ld .= " -melf".$bits."btsmip";
364 $ld .= " -melf".$bits."ltsmip";
367 $cc .= " -mno-abicalls -fno-pic -mabi=" . $bits . $endian;
372 "^([0-9a-fA-F]+)\\s+<(.|[^\$]L.*?|\$[^L].*?|[^\$][^L].*?)>:";
375 } elsif ($arch eq "microblaze") {
376 # Microblaze calls '_mcount' instead of plain 'mcount'.
377 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
378 } elsif ($arch eq "blackfin") {
379 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s__mcount\$";
381 } elsif ($arch eq "tilegx" || $arch eq "tile") {
382 # Default to the newer TILE-Gx architecture if only "tile" is given.
383 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s__mcount\$";
387 die "Arch $arch is not supported with CONFIG_FTRACE_MCOUNT_RECORD";
391 my $read_function = 0;
393 my $mcount_section = "__mcount_loc";
400 if ($inputfile =~ m,^(.*)/([^/]*)$,) {
405 $filename = $inputfile;
408 if ($filename =~ m,^(.*)(\.\S),) {
416 my $mcount_s = $dirname . "/.tmp_mc_" . $prefix . ".s";
417 my $mcount_o = $dirname . "/.tmp_mc_" . $prefix . ".o";
422 # Step 1: find all the local (static functions) and weak symbols.
423 # 't' is local, 'w/W' is weak
425 open (IN, "$nm $inputfile|") || die "error running $nm";
427 if (/$local_regex/) {
429 } elsif (/$weak_regex/) {
435 my @offsets; # Array of offsets of mcount callers
436 my $ref_func; # reference function to use for offsets
437 my $offset = 0; # offset of ref_func to section beginning
440 # update_funcs - print out the current mcount callers
442 # Go through the list of offsets to callers and write them to
443 # the output file in a format that can be read by an assembler.
447 return unless ($ref_func and @offsets);
449 # Sanity check on weak function. A weak function may be overwritten by
450 # another function of the same name, making all these offsets incorrect.
451 if (defined $weak{$ref_func}) {
452 die "$inputfile: ERROR: referencing weak function" .
453 " $ref_func for mcount\n";
456 # is this function static? If so, note this fact.
457 if (defined $locals{$ref_func}) {
459 # only use locals if objcopy supports globalize-symbols
460 if (!$can_use_local) {
463 $convert{$ref_func} = 1;
466 # Loop through all the mcount caller offsets and print a reference
467 # to the caller based from the ref_func.
469 open(FILE, ">$mcount_s") || die "can't create $mcount_s\n";
471 print FILE "\t.section $mcount_section,\"a\",$section_type\n";
472 print FILE "\t.align $alignment\n" if (defined($alignment));
474 foreach my $cur_offset (@offsets) {
475 printf FILE "\t%s %s + %d\n", $type, $ref_func, $cur_offset - $offset;
480 # Step 2: find the sections and mcount call sites
482 open(IN, "$objdump -hdr $inputfile|") || die "error running $objdump";
488 my $read_headers = 1;
492 if ($read_headers && /$mcount_section/) {
494 # Somehow the make process can execute this script on an
495 # object twice. If it does, we would duplicate the mcount
496 # section and it will cause the function tracer self test
497 # to fail. Check if the mcount section exists, and if it does,
500 print STDERR "ERROR: $mcount_section already in $inputfile\n" .
501 "\tThis may be an indication that your build is corrupted.\n" .
502 "\tDelete $inputfile and try again. If the same object file\n" .
503 "\tstill causes an issue, then disable CONFIG_DYNAMIC_FTRACE.\n";
508 if (/$section_regex/) {
511 # Only record text sections that we know are safe
512 $read_function = defined($text_sections{$1});
513 if (!$read_function) {
514 foreach my $prefix (keys %text_section_prefixes) {
515 if (substr($1, 0, length $prefix) eq $prefix) {
521 # print out any recorded offsets
524 # reset all markers and arrays
529 # section found, now is this a start of a function?
530 } elsif ($read_function && /$function_regex/) {
534 # if this is either a local function or a weak function
535 # keep looking for functions that are global that
537 if (!defined($locals{$text}) && !defined($weak{$text})) {
542 # if we already have a function, and this is weak, skip it
543 if (!defined($ref_func) && !defined($weak{$text}) &&
544 # PPC64 can have symbols that start with .L and
545 # gcc considers these special. Don't use them!
552 # is this a call site to mcount? If so, record it to print later
553 if ($text_found && /$mcount_regex/) {
554 push(@offsets, (hex $1) + $mcount_adjust);
558 # dump out anymore offsets that may have been found
561 # If we did not find any mcount callers, we are done (do nothing).
569 # Step 3: Compile the file that holds the list of call sites to mcount.
571 `$cc -o $mcount_o -c $mcount_s`;
573 my @converts = keys %convert;
576 # Step 4: Do we have sections that started with local functions?
578 if ($#converts >= 0) {
582 foreach my $con (@converts) {
583 $globallist .= " --globalize-symbol $con";
584 $locallist .= " --localize-symbol $con";
587 my $globalobj = $dirname . "/.tmp_gl_" . $filename;
588 my $globalmix = $dirname . "/.tmp_mx_" . $filename;
591 # Step 5: set up each local function as a global
593 `$objcopy $globallist $inputfile $globalobj`;
596 # Step 6: Link the global version to our list.
598 `$ld -r $globalobj $mcount_o -o $globalmix`;
601 # Step 7: Convert the local functions back into local symbols
603 `$objcopy $locallist $globalmix $inputfile`;
605 # Remove the temp files
606 `$rm $globalobj $globalmix`;
610 my $mix = $dirname . "/.tmp_mx_" . $filename;
613 # Step 8: Link the object with our list of call sites object.
615 `$ld -r $inputfile $mcount_o -o $mix`;
618 # Step 9: Move the result back to the original object.
620 `$mv $mix $inputfile`;
623 # Clean up the temp files
624 `$rm $mcount_o $mcount_s`;