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 is a section in vmlinux called
10 # __mcount_loc that contains a list of pointers to all the
11 # call sites in the kernel that call mcount. Later on boot up, the kernel
12 # will read this list, save the locations and turn them into nops.
13 # When tracing or profiling is later enabled, these locations will then
14 # be converted back to pointers to some function.
16 # This is no easy feat. This script is called just after the original
17 # object is compiled and before it is linked.
19 # The references to the call sites are offsets from the section of text
20 # that the call site is in. Hence, all functions in a section that
21 # has a call site to mcount, will have the offset from the beginning of
22 # the section and not the beginning of the function.
24 # The trick is to find a way to record the beginning of the section.
25 # The way we do this is to look at the first function in the section
26 # which will also be the location of that section after final link.
29 # .section ".sched.text", "ax"
33 # call mcount (offset: 0x5)
38 # call mcount (offset: 0x1b)
41 # Both relocation offsets for the mcounts in the above example will be
42 # offset from .sched.text. If we make another file called tmp.s with:
44 # .section __mcount_loc
46 # .quad my_func + 0x1b
48 # We can then compile this tmp.s into tmp.o, and link it to the original
51 # But this gets hard if my_func is not globl (a static function).
52 # In such a case we have:
54 # .section ".sched.text", "ax"
57 # call mcount (offset: 0x5)
62 # call mcount (offset: 0x1b)
65 # If we make the tmp.s the same as above, when we link together with
66 # the original object, we will end up with two symbols for my_func:
67 # one local, one global. After final compile, we will end up with
68 # an undefined reference to my_func.
70 # Since local objects can reference local variables, we need to find
71 # a way to make tmp.o reference the local objects of the original object
72 # file after it is linked together. To do this, we convert the my_func
73 # into a global symbol before linking tmp.o. Then after we link tmp.o
74 # we will only have a single symbol for my_func that is global.
75 # We can convert my_func back into a local symbol and we are done.
77 # Here are the steps we take:
79 # 1) Record all the local symbols by using 'nm'
80 # 2) Use objdump to find all the call site offsets and sections for
82 # 3) Compile the list into its own object.
83 # 4) Do we have to deal with local functions? If not, go to step 8.
84 # 5) Make an object that converts these local functions to global symbols
86 # 6) Link together this new object with the list object.
87 # 7) Convert the local functions back to local symbols and rename
88 # the result as the original object.
90 # 8) Link the object with the list object.
91 # 9) Move the result back to the original object.
103 print "usage: $P arch bits objdump objcopy cc ld nm rm mv is_module inputfile\n";
104 print "version: $V\n";
108 my ($arch, $bits, $objdump, $objcopy, $cc,
109 $ld, $nm, $rm, $mv, $is_module, $inputfile) = @ARGV;
111 # This file refers to mcount and shouldn't be ftraced, so lets' ignore it
112 if ($inputfile eq "kernel/trace/ftrace.o") {
116 # Acceptable sections to record.
117 my %text_sections = (
120 ".spinlock.text" => 1,
121 ".irqentry.text" => 1,
124 $objdump = "objdump" if ((length $objdump) == 0);
125 $objcopy = "objcopy" if ((length $objcopy) == 0);
126 $cc = "gcc" if ((length $cc) == 0);
127 $ld = "ld" if ((length $ld) == 0);
128 $nm = "nm" if ((length $nm) == 0);
129 $rm = "rm" if ((length $rm) == 0);
130 $mv = "mv" if ((length $mv) == 0);
132 #print STDERR "running: $P '$arch' '$objdump' '$objcopy' '$cc' '$ld' " .
133 # "'$nm' '$rm' '$mv' '$inputfile'\n";
135 my %locals; # List of local (static) functions
136 my %weak; # List of weak functions
137 my %convert; # List of local functions used that needs conversion
140 my $nm_regex; # Find the local functions (return function)
141 my $section_regex; # Find the start of a section
142 my $function_regex; # Find the name of a function
143 # (return offset and func name)
144 my $mcount_regex; # Find the call site to mcount (return offset)
145 my $alignment; # The .align value to use for $mcount_section
146 my $section_type; # Section header plus possible alignment command
148 if ($arch eq "x86") {
157 # We base the defaults off of i386, the other archs may
158 # feel free to change them in the below if statements.
160 $nm_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\S+)";
161 $section_regex = "Disassembly of section\\s+(\\S+):";
162 $function_regex = "^([0-9a-fA-F]+)\\s+<(.*?)>:";
163 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\smcount\$";
164 $section_type = '@progbits';
167 if ($arch eq "x86_64") {
168 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\smcount([+-]0x[0-9a-zA-Z]+)?\$";
172 # force flags for this arch
173 $ld .= " -m elf_x86_64";
174 $objdump .= " -M x86-64";
175 $objcopy .= " -O elf64-x86-64";
178 } elsif ($arch eq "i386") {
181 # force flags for this arch
182 $ld .= " -m elf_i386";
183 $objdump .= " -M i386";
184 $objcopy .= " -O elf32-i386";
187 } elsif ($arch eq "s390" && $bits == 32) {
188 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_390_32\\s+_mcount\$";
190 $ld .= " -m elf_s390";
193 } elsif ($arch eq "s390" && $bits == 64) {
194 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_390_(PC|PLT)32DBL\\s+_mcount\\+0x2\$";
197 $ld .= " -m elf64_s390";
200 } elsif ($arch eq "sh") {
203 # force flags for this arch
204 $ld .= " -m shlelf_linux";
205 $objcopy .= " -O elf32-sh-linux";
208 } elsif ($arch eq "powerpc") {
209 $nm_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\.?\\S+)";
210 $function_regex = "^([0-9a-fA-F]+)\\s+<(\\.?.*?)>:";
211 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s\\.?_mcount\$";
217 } elsif ($arch eq "arm") {
219 $section_type = '%progbits';
221 } elsif ($arch eq "ia64") {
222 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
225 if ($is_module eq "0") {
226 $cc .= " -mconstant-gp";
228 } elsif ($arch eq "sparc64") {
229 # In the objdump output there are giblets like:
230 # 0000000000000000 <igmp_net_exit-0x18>:
231 # As there's some data blobs that get emitted into the
232 # text section before the first instructions and the first
233 # real symbols. We don't want to match that, so to combat
234 # this we use '\w' so we'll match just plain symbol names,
235 # and not those that also include hex offsets inside of the
236 # '<>' brackets. Actually the generic function_regex setting
237 # could safely use this too.
238 $function_regex = "^([0-9a-fA-F]+)\\s+<(\\w*?)>:";
240 # Sparc64 calls '_mcount' instead of plain 'mcount'.
241 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
245 $ld .= " -m elf64_sparc";
247 $objcopy .= " -O elf64-sparc";
249 die "Arch $arch is not supported with CONFIG_FTRACE_MCOUNT_RECORD";
253 my $read_function = 0;
255 my $mcount_section = "__mcount_loc";
262 if ($inputfile =~ m
,^(.*)/([^/]*)$,) {
267 $filename = $inputfile;
270 if ($filename =~ m
,^(.*)(\
.\S
),) {
278 my $mcount_s = $dirname . "/.tmp_mc_" . $prefix . ".s";
279 my $mcount_o = $dirname . "/.tmp_mc_" . $prefix . ".o";
282 # --globalize-symbols came out in 2.17, we must test the version
283 # of objcopy, and if it is less than 2.17, then we can not
284 # record local functions.
286 my $local_warn_once = 0;
287 my $found_version = 0;
289 open (IN
, "$objcopy --version |") || die "error running $objcopy";
291 if (/objcopy.*\s(\d+)\.(\d+)/) {
297 ($major == 2 && $minor < 17)) {
305 if (!$found_version) {
306 print STDERR
"WARNING: could not find objcopy version.\n" .
307 "\tDisabling local function references.\n";
311 # Step 1: find all the local (static functions) and weak symbols.
312 # 't' is local, 'w/W' is weak (we never use a weak function)
314 open (IN
, "$nm $inputfile|") || die "error running $nm";
318 } elsif (/^[0-9a-fA-F]+\s+([wW])\s+(\S+)/) {
324 my @offsets; # Array of offsets of mcount callers
325 my $ref_func; # reference function to use for offsets
326 my $offset = 0; # offset of ref_func to section beginning
329 # update_funcs - print out the current mcount callers
331 # Go through the list of offsets to callers and write them to
332 # the output file in a format that can be read by an assembler.
336 return if ($#offsets < 0);
338 defined($ref_func) || die "No function to reference";
340 # A section only had a weak function, to represent it.
341 # Unfortunately, a weak function may be overwritten by another
342 # function of the same name, making all these offsets incorrect.
343 # To be safe, we simply print a warning and bail.
344 if (defined $weak{$ref_func}) {
346 "$inputfile: WARNING: referencing weak function" .
347 " $ref_func for mcount\n";
351 # is this function static? If so, note this fact.
352 if (defined $locals{$ref_func}) {
354 # only use locals if objcopy supports globalize-symbols
358 $convert{$ref_func} = 1;
361 # Loop through all the mcount caller offsets and print a reference
362 # to the caller based from the ref_func.
363 for (my $i=0; $i <= $#offsets; $i++) {
365 open(FILE
, ">$mcount_s") || die "can't create $mcount_s\n";
367 print FILE
"\t.section $mcount_section,\"a\",$section_type\n";
368 print FILE
"\t.align $alignment\n" if (defined($alignment));
370 printf FILE
"\t%s %s + %d\n", $type, $ref_func, $offsets[$i] - $offset;
375 # Step 2: find the sections and mcount call sites
377 open(IN
, "$objdump -hdr $inputfile|") || die "error running $objdump";
381 my $read_headers = 1;
385 if (/$section_regex/) {
388 # Only record text sections that we know are safe
389 if (defined($text_sections{$1})) {
394 # print out any recorded offsets
395 update_funcs
() if (defined($ref_func));
397 # reset all markers and arrays
402 # section found, now is this a start of a function?
403 } elsif ($read_function && /$function_regex/) {
407 # if this is either a local function or a weak function
408 # keep looking for functions that are global that
410 if (!defined($locals{$text}) && !defined($weak{$text})) {
415 # if we already have a function, and this is weak, skip it
416 if (!defined($ref_func) && !defined($weak{$text}) &&
417 # PPC64 can have symbols that start with .L and
418 # gcc considers these special. Don't use them!
424 } elsif ($read_headers && /$mcount_section/) {
426 # Somehow the make process can execute this script on an
427 # object twice. If it does, we would duplicate the mcount
428 # section and it will cause the function tracer self test
429 # to fail. Check if the mcount section exists, and if it does,
432 print STDERR
"ERROR: $mcount_section already in $inputfile\n" .
433 "\tThis may be an indication that your build is corrupted.\n" .
434 "\tDelete $inputfile and try again. If the same object file\n" .
435 "\tstill causes an issue, then disable CONFIG_DYNAMIC_FTRACE.\n";
439 # is this a call site to mcount? If so, record it to print later
440 if ($text_found && /$mcount_regex/) {
441 $offsets[$#offsets + 1] = hex $1;
445 # dump out anymore offsets that may have been found
446 update_funcs
() if (defined($ref_func));
448 # If we did not find any mcount callers, we are done (do nothing).
456 # Step 3: Compile the file that holds the list of call sites to mcount.
458 `$cc -o $mcount_o -c $mcount_s`;
460 my @converts = keys %convert;
463 # Step 4: Do we have sections that started with local functions?
465 if ($#converts >= 0) {
469 foreach my $con (@converts) {
470 $globallist .= " --globalize-symbol $con";
471 $locallist .= " --localize-symbol $con";
474 my $globalobj = $dirname . "/.tmp_gl_" . $filename;
475 my $globalmix = $dirname . "/.tmp_mx_" . $filename;
478 # Step 5: set up each local function as a global
480 `$objcopy $globallist $inputfile $globalobj`;
483 # Step 6: Link the global version to our list.
485 `$ld -r $globalobj $mcount_o -o $globalmix`;
488 # Step 7: Convert the local functions back into local symbols
490 `$objcopy $locallist $globalmix $inputfile`;
492 # Remove the temp files
493 `$rm $globalobj $globalmix`;
497 my $mix = $dirname . "/.tmp_mx_" . $filename;
500 # Step 8: Link the object with our list of call sites object.
502 `$ld -r $inputfile $mcount_o -o $mix`;
505 # Step 9: Move the result back to the original object.
507 `$mv $mix $inputfile`;
510 # Clean up the temp files
511 `$rm $mcount_o $mcount_s`;