tracing: Move mcount section search to front of loop in recordmcount.pl
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / scripts / recordmcount.pl
CommitLineData
8da3821b
SR
1#!/usr/bin/perl -w
2# (c) 2008, Steven Rostedt <srostedt@redhat.com>
3# Licensed under the terms of the GNU GPL License version 2
4#
5# recordmcount.pl - makes a section called __mcount_loc that holds
6# all the offsets to the calls to mcount.
7#
8#
d49f6aa7
LH
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.
8da3821b
SR
16#
17# This is no easy feat. This script is called just after the original
18# object is compiled and before it is linked.
19#
d49f6aa7
LH
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
24# function.
25#
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.
29#
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.
8da3821b 33#
8da3821b
SR
34# e.g.
35#
31b6e76e 36# .section ".sched.text", "ax"
8da3821b 37# [...]
d49f6aa7
LH
38# func1:
39# [...]
40# call mcount (offset: 0x10)
41# [...]
42# ret
43# .globl fun2
44# func2: (offset: 0x20)
45# [...]
8da3821b
SR
46# [...]
47# ret
d49f6aa7 48# func3:
8da3821b 49# [...]
d49f6aa7 50# call mcount (offset: 0x30)
8da3821b
SR
51# [...]
52#
53# Both relocation offsets for the mcounts in the above example will be
d49f6aa7
LH
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:
8da3821b
SR
56#
57# .section __mcount_loc
d49f6aa7
LH
58# .quad func2 - 0x10
59# .quad func2 + 0x10
8da3821b 60#
d49f6aa7 61# We can then compile this tmp.s into tmp.o, and link it back to the original
8da3821b
SR
62# object.
63#
d49f6aa7
LH
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:
8da3821b 67#
31b6e76e 68# .section ".sched.text", "ax"
d49f6aa7 69# func1:
8da3821b 70# [...]
d49f6aa7 71# call mcount (offset: 0x10)
8da3821b
SR
72# [...]
73# ret
d49f6aa7 74# func2:
8da3821b 75# [...]
d49f6aa7 76# call mcount (offset: 0x20)
8da3821b 77# [...]
d49f6aa7 78# .section "other.section"
8da3821b
SR
79#
80# If we make the tmp.s the same as above, when we link together with
d49f6aa7 81# the original object, we will end up with two symbols for func1:
8da3821b 82# one local, one global. After final compile, we will end up with
d49f6aa7
LH
83# an undefined reference to func1 or a wrong reference to another global
84# func1 in other files.
8da3821b
SR
85#
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
d49f6aa7 88# file after it is linked together. To do this, we convert func1
8da3821b 89# into a global symbol before linking tmp.o. Then after we link tmp.o
d49f6aa7
LH
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.
8da3821b
SR
92#
93# Here are the steps we take:
94#
95# 1) Record all the local symbols by using 'nm'
96# 2) Use objdump to find all the call site offsets and sections for
97# mcount.
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
101# with objcopy.
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.
8da3821b
SR
105# 8) Link the object with the list object.
106# 9) Move the result back to the original object.
8da3821b
SR
107#
108
109use strict;
110
111my $P = $0;
112$P =~ s@.*/@@g;
113
114my $V = '0.1';
115
e2d753fa 116if ($#ARGV != 10) {
b43f7093 117 print "usage: $P arch bits objdump objcopy cc ld nm rm mv is_module inputfile\n";
8da3821b
SR
118 print "version: $V\n";
119 exit(1);
120}
121
dce9d18a 122my ($arch, $bits, $objdump, $objcopy, $cc,
18c167fd 123 $ld, $nm, $rm, $mv, $is_module, $inputfile) = @ARGV;
8da3821b 124
25aac9dc 125# This file refers to mcount and shouldn't be ftraced, so lets' ignore it
bdd3b052 126if ($inputfile =~ m,kernel/trace/ftrace\.o$,) {
25aac9dc
SL
127 exit(0);
128}
129
34698bcb
SR
130# Acceptable sections to record.
131my %text_sections = (
132 ".text" => 1,
d144d5ee
LW
133 ".sched.text" => 1,
134 ".spinlock.text" => 1,
a0343e82 135 ".irqentry.text" => 1,
4d828949 136 ".text.unlikely" => 1,
34698bcb
SR
137);
138
8da3821b
SR
139$objdump = "objdump" if ((length $objdump) == 0);
140$objcopy = "objcopy" if ((length $objcopy) == 0);
141$cc = "gcc" if ((length $cc) == 0);
142$ld = "ld" if ((length $ld) == 0);
143$nm = "nm" if ((length $nm) == 0);
144$rm = "rm" if ((length $rm) == 0);
145$mv = "mv" if ((length $mv) == 0);
146
147#print STDERR "running: $P '$arch' '$objdump' '$objcopy' '$cc' '$ld' " .
148# "'$nm' '$rm' '$mv' '$inputfile'\n";
149
8feff1ca
SR
150my %locals; # List of local (static) functions
151my %weak; # List of weak functions
152my %convert; # List of local functions used that needs conversion
8da3821b
SR
153
154my $type;
42e007d0 155my $nm_regex; # Find the local functions (return function)
8da3821b 156my $section_regex; # Find the start of a section
8feff1ca
SR
157my $function_regex; # Find the name of a function
158 # (return offset and func name)
8da3821b 159my $mcount_regex; # Find the call site to mcount (return offset)
3a3d04ae 160my $alignment; # The .align value to use for $mcount_section
e58918ab 161my $section_type; # Section header plus possible alignment command
7b7edc27
LH
162my $can_use_local = 0; # If we can use local function references
163
164##
165# check_objcopy - whether objcopy supports --globalize-symbols
166#
167# --globalize-symbols came out in 2.17, we must test the version
168# of objcopy, and if it is less than 2.17, then we can not
169# record local functions.
170sub check_objcopy
171{
172 open (IN, "$objcopy --version |") or die "error running $objcopy";
173 while (<IN>) {
174 if (/objcopy.*\s(\d+)\.(\d+)/) {
175 $can_use_local = 1 if ($1 > 2 || ($1 == 2 && $2 >= 17));
176 last;
177 }
178 }
179 close (IN);
180
181 if (!$can_use_local) {
182 print STDERR "WARNING: could not find objcopy version or version " .
183 "is less than 2.17.\n" .
184 "\tLocal function references is disabled.\n";
185 }
186}
8da3821b 187
dce9d18a
SR
188if ($arch eq "x86") {
189 if ($bits == 64) {
190 $arch = "x86_64";
191 } else {
192 $arch = "i386";
193 }
194}
195
c204f726
SR
196#
197# We base the defaults off of i386, the other archs may
198# feel free to change them in the below if statements.
199#
200$nm_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\S+)";
201$section_regex = "Disassembly of section\\s+(\\S+):";
202$function_regex = "^([0-9a-fA-F]+)\\s+<(.*?)>:";
203$mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\smcount\$";
e58918ab 204$section_type = '@progbits';
c204f726
SR
205$type = ".long";
206
8da3821b 207if ($arch eq "x86_64") {
8da3821b
SR
208 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\smcount([+-]0x[0-9a-zA-Z]+)?\$";
209 $type = ".quad";
7d5222a6 210 $alignment = 8;
d74fcd1e
SR
211
212 # force flags for this arch
213 $ld .= " -m elf_x86_64";
214 $objdump .= " -M x86-64";
215 $objcopy .= " -O elf64-x86-64";
216 $cc .= " -m64";
217
8da3821b 218} elsif ($arch eq "i386") {
7d5222a6 219 $alignment = 4;
d74fcd1e
SR
220
221 # force flags for this arch
222 $ld .= " -m elf_i386";
223 $objdump .= " -M i386";
224 $objcopy .= " -O elf32-i386";
225 $cc .= " -m32";
226
dfd9f7ab
HC
227} elsif ($arch eq "s390" && $bits == 32) {
228 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_390_32\\s+_mcount\$";
229 $alignment = 4;
230 $ld .= " -m elf_s390";
231 $cc .= " -m31";
232
233} elsif ($arch eq "s390" && $bits == 64) {
234 $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_390_(PC|PLT)32DBL\\s+_mcount\\+0x2\$";
235 $alignment = 8;
236 $type = ".quad";
237 $ld .= " -m elf64_s390";
238 $cc .= " -m64";
239
0da85c09 240} elsif ($arch eq "sh") {
3a3d04ae 241 $alignment = 2;
0da85c09
MF
242
243 # force flags for this arch
244 $ld .= " -m shlelf_linux";
245 $objcopy .= " -O elf32-sh-linux";
246 $cc .= " -m32";
247
42e007d0
SR
248} elsif ($arch eq "powerpc") {
249 $nm_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\.?\\S+)";
42e007d0
SR
250 $function_regex = "^([0-9a-fA-F]+)\\s+<(\\.?.*?)>:";
251 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s\\.?_mcount\$";
c204f726 252
42e007d0
SR
253 if ($bits == 64) {
254 $type = ".quad";
42e007d0
SR
255 }
256
e58918ab
JR
257} elsif ($arch eq "arm") {
258 $alignment = 2;
259 $section_type = '%progbits';
260
418071eb
SL
261} elsif ($arch eq "ia64") {
262 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
263 $type = "data8";
264
265 if ($is_module eq "0") {
266 $cc .= " -mconstant-gp";
267 }
9be12f9b
DM
268} elsif ($arch eq "sparc64") {
269 # In the objdump output there are giblets like:
270 # 0000000000000000 <igmp_net_exit-0x18>:
271 # As there's some data blobs that get emitted into the
272 # text section before the first instructions and the first
273 # real symbols. We don't want to match that, so to combat
274 # this we use '\w' so we'll match just plain symbol names,
275 # and not those that also include hex offsets inside of the
276 # '<>' brackets. Actually the generic function_regex setting
277 # could safely use this too.
278 $function_regex = "^([0-9a-fA-F]+)\\s+<(\\w*?)>:";
279
280 # Sparc64 calls '_mcount' instead of plain 'mcount'.
281 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
282
283 $alignment = 8;
284 $type = ".xword";
285 $ld .= " -m elf64_sparc";
286 $cc .= " -m64";
287 $objcopy .= " -O elf64-sparc";
8da3821b
SR
288} else {
289 die "Arch $arch is not supported with CONFIG_FTRACE_MCOUNT_RECORD";
290}
291
292my $text_found = 0;
293my $read_function = 0;
294my $opened = 0;
8da3821b
SR
295my $mcount_section = "__mcount_loc";
296
297my $dirname;
298my $filename;
299my $prefix;
300my $ext;
301
302if ($inputfile =~ m,^(.*)/([^/]*)$,) {
303 $dirname = $1;
304 $filename = $2;
305} else {
306 $dirname = ".";
307 $filename = $inputfile;
308}
309
310if ($filename =~ m,^(.*)(\.\S),) {
311 $prefix = $1;
312 $ext = $2;
313} else {
314 $prefix = $filename;
315 $ext = "";
316}
317
318my $mcount_s = $dirname . "/.tmp_mc_" . $prefix . ".s";
319my $mcount_o = $dirname . "/.tmp_mc_" . $prefix . ".o";
320
7b7edc27 321check_objcopy();
f2f8458e 322
8da3821b 323#
8feff1ca
SR
324# Step 1: find all the local (static functions) and weak symbols.
325# 't' is local, 'w/W' is weak (we never use a weak function)
8da3821b
SR
326#
327open (IN, "$nm $inputfile|") || die "error running $nm";
328while (<IN>) {
42e007d0 329 if (/$nm_regex/) {
8da3821b 330 $locals{$1} = 1;
8feff1ca
SR
331 } elsif (/^[0-9a-fA-F]+\s+([wW])\s+(\S+)/) {
332 $weak{$2} = $1;
8da3821b
SR
333 }
334}
335close(IN);
336
8feff1ca
SR
337my @offsets; # Array of offsets of mcount callers
338my $ref_func; # reference function to use for offsets
339my $offset = 0; # offset of ref_func to section beginning
340
341##
342# update_funcs - print out the current mcount callers
343#
344# Go through the list of offsets to callers and write them to
345# the output file in a format that can be read by an assembler.
346#
347sub update_funcs
348{
349 return if ($#offsets < 0);
350
351 defined($ref_func) || die "No function to reference";
352
353 # A section only had a weak function, to represent it.
354 # Unfortunately, a weak function may be overwritten by another
355 # function of the same name, making all these offsets incorrect.
356 # To be safe, we simply print a warning and bail.
357 if (defined $weak{$ref_func}) {
358 print STDERR
359 "$inputfile: WARNING: referencing weak function" .
360 " $ref_func for mcount\n";
361 return;
362 }
363
364 # is this function static? If so, note this fact.
365 if (defined $locals{$ref_func}) {
f2f8458e
SR
366
367 # only use locals if objcopy supports globalize-symbols
7b7edc27 368 if (!$can_use_local) {
f2f8458e
SR
369 return;
370 }
8feff1ca
SR
371 $convert{$ref_func} = 1;
372 }
373
374 # Loop through all the mcount caller offsets and print a reference
375 # to the caller based from the ref_func.
376 for (my $i=0; $i <= $#offsets; $i++) {
377 if (!$opened) {
378 open(FILE, ">$mcount_s") || die "can't create $mcount_s\n";
379 $opened = 1;
e58918ab 380 print FILE "\t.section $mcount_section,\"a\",$section_type\n";
42e007d0 381 print FILE "\t.align $alignment\n" if (defined($alignment));
8feff1ca
SR
382 }
383 printf FILE "\t%s %s + %d\n", $type, $ref_func, $offsets[$i] - $offset;
384 }
385}
386
8da3821b
SR
387#
388# Step 2: find the sections and mcount call sites
389#
b43f7093 390open(IN, "$objdump -hdr $inputfile|") || die "error running $objdump";
8da3821b 391
8feff1ca
SR
392my $text;
393
db24c7dc
LH
394
395# read headers first
b43f7093
SR
396my $read_headers = 1;
397
8da3821b 398while (<IN>) {
db24c7dc
LH
399
400 if ($read_headers && /$mcount_section/) {
401 #
402 # Somehow the make process can execute this script on an
403 # object twice. If it does, we would duplicate the mcount
404 # section and it will cause the function tracer self test
405 # to fail. Check if the mcount section exists, and if it does,
406 # warn and exit.
407 #
408 print STDERR "ERROR: $mcount_section already in $inputfile\n" .
409 "\tThis may be an indication that your build is corrupted.\n" .
410 "\tDelete $inputfile and try again. If the same object file\n" .
411 "\tstill causes an issue, then disable CONFIG_DYNAMIC_FTRACE.\n";
412 exit(-1);
413 }
414
8da3821b
SR
415 # is it a section?
416 if (/$section_regex/) {
b43f7093 417 $read_headers = 0;
34698bcb
SR
418
419 # Only record text sections that we know are safe
420 if (defined($text_sections{$1})) {
421 $read_function = 1;
422 } else {
423 $read_function = 0;
424 }
8feff1ca 425 # print out any recorded offsets
7dbdee2e 426 update_funcs() if (defined($ref_func));
8feff1ca
SR
427
428 # reset all markers and arrays
8da3821b 429 $text_found = 0;
8feff1ca
SR
430 undef($ref_func);
431 undef(@offsets);
432
8da3821b
SR
433 # section found, now is this a start of a function?
434 } elsif ($read_function && /$function_regex/) {
8da3821b 435 $text_found = 1;
8feff1ca
SR
436 $text = $2;
437
438 # if this is either a local function or a weak function
439 # keep looking for functions that are global that
440 # we can use safely.
441 if (!defined($locals{$text}) && !defined($weak{$text})) {
442 $ref_func = $text;
443 $read_function = 0;
bd171d5f 444 $offset = hex $1;
8feff1ca
SR
445 } else {
446 # if we already have a function, and this is weak, skip it
3f6e968e
SR
447 if (!defined($ref_func) && !defined($weak{$text}) &&
448 # PPC64 can have symbols that start with .L and
449 # gcc considers these special. Don't use them!
450 $text !~ /^\.L/) {
8feff1ca 451 $ref_func = $text;
bd171d5f 452 $offset = hex $1;
8feff1ca 453 }
8da3821b 454 }
8feff1ca 455 }
8feff1ca
SR
456 # is this a call site to mcount? If so, record it to print later
457 if ($text_found && /$mcount_regex/) {
458 $offsets[$#offsets + 1] = hex $1;
8da3821b
SR
459 }
460}
461
8feff1ca 462# dump out anymore offsets that may have been found
7dbdee2e 463update_funcs() if (defined($ref_func));
8feff1ca 464
8da3821b
SR
465# If we did not find any mcount callers, we are done (do nothing).
466if (!$opened) {
467 exit(0);
468}
469
470close(FILE);
471
472#
473# Step 3: Compile the file that holds the list of call sites to mcount.
474#
475`$cc -o $mcount_o -c $mcount_s`;
476
477my @converts = keys %convert;
478
479#
480# Step 4: Do we have sections that started with local functions?
481#
482if ($#converts >= 0) {
483 my $globallist = "";
484 my $locallist = "";
485
486 foreach my $con (@converts) {
487 $globallist .= " --globalize-symbol $con";
488 $locallist .= " --localize-symbol $con";
489 }
490
491 my $globalobj = $dirname . "/.tmp_gl_" . $filename;
492 my $globalmix = $dirname . "/.tmp_mx_" . $filename;
493
494 #
495 # Step 5: set up each local function as a global
496 #
497 `$objcopy $globallist $inputfile $globalobj`;
498
499 #
500 # Step 6: Link the global version to our list.
501 #
502 `$ld -r $globalobj $mcount_o -o $globalmix`;
503
504 #
505 # Step 7: Convert the local functions back into local symbols
506 #
507 `$objcopy $locallist $globalmix $inputfile`;
508
509 # Remove the temp files
510 `$rm $globalobj $globalmix`;
511
512} else {
513
514 my $mix = $dirname . "/.tmp_mx_" . $filename;
515
516 #
517 # Step 8: Link the object with our list of call sites object.
518 #
519 `$ld -r $inputfile $mcount_o -o $mix`;
520
521 #
522 # Step 9: Move the result back to the original object.
523 #
524 `$mv $mix $inputfile`;
525}
526
527# Clean up the temp files
528`$rm $mcount_o $mcount_s`;
529
530exit(0);