Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[platform/kernel/linux-starfive.git] / scripts / recordmcount.pl
1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0-only
3 # (c) 2008, Steven Rostedt <srostedt@redhat.com>
4 #
5 # recordmcount.pl - makes a section called __mcount_loc that holds
6 #                   all the offsets to the calls to mcount.
7 #
8 #
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.
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 #
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.
33 #
34 # e.g.
35 #
36 #  .section ".sched.text", "ax"
37 #        [...]
38 #  func1:
39 #        [...]
40 #        call mcount  (offset: 0x10)
41 #        [...]
42 #        ret
43 #  .globl fun2
44 #  func2:             (offset: 0x20)
45 #        [...]
46 #        [...]
47 #        ret
48 #  func3:
49 #        [...]
50 #        call mcount (offset: 0x30)
51 #        [...]
52 #
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:
56 #
57 #  .section __mcount_loc
58 #  .quad  func2 - 0x10
59 #  .quad  func2 + 0x10
60 #
61 # We can then compile this tmp.s into tmp.o, and link it back to the original
62 # object.
63 #
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:
67 #
68 #  .section ".sched.text", "ax"
69 #  func1:
70 #        [...]
71 #        call mcount  (offset: 0x10)
72 #        [...]
73 #        ret
74 #  func2:
75 #        [...]
76 #        call mcount (offset: 0x20)
77 #        [...]
78 #  .section "other.section"
79 #
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.
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
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.
92 #
93 # Here are the steps we take:
94 #
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
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.
105 # 8) Link the object with the list object.
106 # 9) Move the result back to the original object.
107 #
108
109 use warnings;
110 use strict;
111
112 my $P = $0;
113 $P =~ s@.*/@@g;
114
115 my $V = '0.1';
116
117 if ($#ARGV != 11) {
118         print "usage: $P arch endian bits objdump objcopy cc ld nm rm mv is_module inputfile\n";
119         print "version: $V\n";
120         exit(1);
121 }
122
123 my ($arch, $endian, $bits, $objdump, $objcopy, $cc,
124     $ld, $nm, $rm, $mv, $is_module, $inputfile) = @ARGV;
125
126 # This file refers to mcount and shouldn't be ftraced, so lets' ignore it
127 if ($inputfile =~ m,kernel/trace/ftrace\.o$,) {
128     exit(0);
129 }
130
131 # Acceptable sections to record.
132 my %text_sections = (
133      ".text" => 1,
134      ".init.text" => 1,
135      ".ref.text" => 1,
136      ".sched.text" => 1,
137      ".spinlock.text" => 1,
138      ".irqentry.text" => 1,
139      ".softirqentry.text" => 1,
140      ".kprobes.text" => 1,
141      ".cpuidle.text" => 1,
142      ".text.unlikely" => 1,
143 );
144
145 # Acceptable section-prefixes to record.
146 my %text_section_prefixes = (
147      ".text." => 1,
148 );
149
150 # Note: we are nice to C-programmers here, thus we skip the '||='-idiom.
151 $objdump = 'objdump' if (!$objdump);
152 $objcopy = 'objcopy' if (!$objcopy);
153 $cc = 'gcc' if (!$cc);
154 $ld = 'ld' if (!$ld);
155 $nm = 'nm' if (!$nm);
156 $rm = 'rm' if (!$rm);
157 $mv = 'mv' if (!$mv);
158
159 #print STDERR "running: $P '$arch' '$objdump' '$objcopy' '$cc' '$ld' " .
160 #    "'$nm' '$rm' '$mv' '$inputfile'\n";
161
162 my %locals;             # List of local (static) functions
163 my %weak;               # List of weak functions
164 my %convert;            # List of local functions used that needs conversion
165
166 my $type;
167 my $local_regex;        # Match a local function (return function)
168 my $weak_regex;         # Match a weak function (return function)
169 my $section_regex;      # Find the start of a section
170 my $function_regex;     # Find the name of a function
171                         #    (return offset and func name)
172 my $mcount_regex;       # Find the call site to mcount (return offset)
173 my $mcount_adjust;      # Address adjustment to mcount offset
174 my $alignment;          # The .align value to use for $mcount_section
175 my $section_type;       # Section header plus possible alignment command
176
177 if ($arch =~ /(x86(_64)?)|(i386)/) {
178     if ($bits == 64) {
179         $arch = "x86_64";
180     } else {
181         $arch = "i386";
182     }
183 }
184
185 #
186 # We base the defaults off of i386, the other archs may
187 # feel free to change them in the below if statements.
188 #
189 $local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\S+)";
190 $weak_regex = "^[0-9a-fA-F]+\\s+([wW])\\s+(\\S+)";
191 $section_regex = "Disassembly of section\\s+(\\S+):";
192 $function_regex = "^([0-9a-fA-F]+)\\s+<([^^]*?)>:";
193 $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s(mcount|__fentry__)\$";
194 $section_type = '@progbits';
195 $mcount_adjust = 0;
196 $type = ".long";
197
198 if ($arch eq "x86_64") {
199     $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s(mcount|__fentry__)([+-]0x[0-9a-zA-Z]+)?\$";
200     $type = ".quad";
201     $alignment = 8;
202     $mcount_adjust = -1;
203
204     # force flags for this arch
205     $ld .= " -m elf_x86_64";
206     $objdump .= " -M x86-64";
207     $objcopy .= " -O elf64-x86-64";
208     $cc .= " -m64";
209
210 } elsif ($arch eq "i386") {
211     $alignment = 4;
212     $mcount_adjust = -1;
213
214     # force flags for this arch
215     $ld .= " -m elf_i386";
216     $objdump .= " -M i386";
217     $objcopy .= " -O elf32-i386";
218     $cc .= " -m32";
219
220 } elsif ($arch eq "s390" && $bits == 64) {
221     if ($cc =~ /-DCC_USING_HOTPATCH/) {
222         $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*c0 04 00 00 00 00\\s*(brcl\\s*0,|jgnop\\s*)[0-9a-f]+ <([^\+]*)>\$";
223         $mcount_adjust = 0;
224     }
225     $alignment = 8;
226     $type = ".quad";
227     $ld .= " -m elf64_s390";
228     $cc .= " -m64";
229
230 } elsif ($arch eq "sh") {
231     $alignment = 2;
232
233     # force flags for this arch
234     $ld .= " -m shlelf_linux";
235     if ($endian eq "big") {
236         $objcopy .= " -O elf32-shbig-linux";
237     } else {
238         $objcopy .= " -O elf32-sh-linux";
239     }
240
241 } elsif ($arch eq "powerpc") {
242     my $ldemulation;
243
244     $local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\.?\\S+)";
245     # See comment in the sparc64 section for why we use '\w'.
246     $function_regex = "^([0-9a-fA-F]+)\\s+<(\\.?\\w*?)>:";
247     $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s\\.?_mcount\$";
248
249     if ($endian eq "big") {
250             $cc .= " -mbig-endian ";
251             $ld .= " -EB ";
252             $ldemulation = "ppc"
253     } else {
254             $cc .= " -mlittle-endian ";
255             $ld .= " -EL ";
256             $ldemulation = "lppc"
257     }
258     if ($bits == 64) {
259         $type = ".quad";
260         $cc .= " -m64 ";
261         $ld .= " -m elf64".$ldemulation." ";
262     } else {
263         $cc .= " -m32 ";
264         $ld .= " -m elf32".$ldemulation." ";
265     }
266
267 } elsif ($arch eq "arm") {
268     $alignment = 2;
269     $section_type = '%progbits';
270     $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_ARM_(CALL|PC24|THM_CALL)" .
271                         "\\s+(__gnu_mcount_nc|mcount)\$";
272
273 } elsif ($arch eq "arm64") {
274     $alignment = 3;
275     $section_type = '%progbits';
276     $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_AARCH64_CALL26\\s+_mcount\$";
277     $type = ".quad";
278 } elsif ($arch eq "ia64") {
279     $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
280     $type = "data8";
281
282     if ($is_module eq "0") {
283         $cc .= " -mconstant-gp";
284     }
285 } elsif ($arch eq "sparc64") {
286     # In the objdump output there are giblets like:
287     # 0000000000000000 <igmp_net_exit-0x18>:
288     # As there's some data blobs that get emitted into the
289     # text section before the first instructions and the first
290     # real symbols.  We don't want to match that, so to combat
291     # this we use '\w' so we'll match just plain symbol names,
292     # and not those that also include hex offsets inside of the
293     # '<>' brackets.  Actually the generic function_regex setting
294     # could safely use this too.
295     $function_regex = "^([0-9a-fA-F]+)\\s+<(\\w*?)>:";
296
297     # Sparc64 calls '_mcount' instead of plain 'mcount'.
298     $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
299
300     $alignment = 8;
301     $type = ".xword";
302     $ld .= " -m elf64_sparc";
303     $cc .= " -m64";
304     $objcopy .= " -O elf64-sparc";
305 } elsif ($arch eq "mips") {
306     # To enable module support, we need to enable the -mlong-calls option
307     # of gcc for module, after using this option, we can not get the real
308     # offset of the calling to _mcount, but the offset of the lui
309     # instruction or the addiu one. herein, we record the address of the
310     # first one, and then we can replace this instruction by a branch
311     # instruction to jump over the profiling function to filter the
312     # indicated functions, or switch back to the lui instruction to trace
313     # them, which means dynamic tracing.
314     #
315     #       c:  3c030000        lui     v1,0x0
316     #                   c: R_MIPS_HI16  _mcount
317     #                   c: R_MIPS_NONE  *ABS*
318     #                   c: R_MIPS_NONE  *ABS*
319     #      10:  64630000        daddiu  v1,v1,0
320     #                   10: R_MIPS_LO16 _mcount
321     #                   10: R_MIPS_NONE *ABS*
322     #                   10: R_MIPS_NONE *ABS*
323     #      14:  03e0082d        move    at,ra
324     #      18:  0060f809        jalr    v1
325     #
326     # for the kernel:
327     #
328     #     10:   03e0082d        move    at,ra
329     #     14:   0c000000        jal     0 <loongson_halt>
330     #                    14: R_MIPS_26   _mcount
331     #                    14: R_MIPS_NONE *ABS*
332     #                    14: R_MIPS_NONE *ABS*
333     #    18:   00020021        nop
334     if ($is_module eq "0") {
335             $mcount_regex = "^\\s*([0-9a-fA-F]+): R_MIPS_26\\s+_mcount\$";
336     } else {
337             $mcount_regex = "^\\s*([0-9a-fA-F]+): R_MIPS_HI16\\s+_mcount\$";
338     }
339     $objdump .= " -Melf-trad".$endian."mips ";
340
341     if ($endian eq "big") {
342             $endian = " -EB ";
343             $ld .= " -melf".$bits."btsmip";
344     } else {
345             $endian = " -EL ";
346             $ld .= " -melf".$bits."ltsmip";
347     }
348
349     $cc .= " -mno-abicalls -fno-pic -mabi=" . $bits . $endian;
350     $ld .= $endian;
351
352     if ($bits == 64) {
353             $function_regex =
354                 "^([0-9a-fA-F]+)\\s+<(.|[^\$]L.*?|\$[^L].*?|[^\$][^L].*?)>:";
355             $type = ".dword";
356     }
357 } elsif ($arch eq "microblaze") {
358     # Microblaze calls '_mcount' instead of plain 'mcount'.
359     $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
360 } elsif ($arch eq "riscv") {
361     $function_regex = "^([0-9a-fA-F]+)\\s+<([^.0-9][0-9a-zA-Z_\\.]+)>:";
362     $mcount_regex = "^\\s*([0-9a-fA-F]+):\\sR_RISCV_CALL(_PLT)?\\s_?mcount\$";
363     $type = ".quad";
364     $alignment = 2;
365 } elsif ($arch eq "csky") {
366     $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_CKCORE_PCREL_JSR_IMM26BY2\\s+_mcount\$";
367     $alignment = 2;
368 } else {
369     die "Arch $arch is not supported with CONFIG_FTRACE_MCOUNT_RECORD";
370 }
371
372 my $text_found = 0;
373 my $read_function = 0;
374 my $opened = 0;
375 my $mcount_section = "__mcount_loc";
376
377 my $dirname;
378 my $filename;
379 my $prefix;
380 my $ext;
381
382 if ($inputfile =~ m,^(.*)/([^/]*)$,) {
383     $dirname = $1;
384     $filename = $2;
385 } else {
386     $dirname = ".";
387     $filename = $inputfile;
388 }
389
390 if ($filename =~ m,^(.*)(\.\S),) {
391     $prefix = $1;
392     $ext = $2;
393 } else {
394     $prefix = $filename;
395     $ext = "";
396 }
397
398 my $mcount_s = $dirname . "/.tmp_mc_" . $prefix . ".s";
399 my $mcount_o = $dirname . "/.tmp_mc_" . $prefix . ".o";
400
401 #
402 # Step 1: find all the local (static functions) and weak symbols.
403 #         't' is local, 'w/W' is weak
404 #
405 open (IN, "$nm $inputfile|") || die "error running $nm";
406 while (<IN>) {
407     if (/$local_regex/) {
408         $locals{$1} = 1;
409     } elsif (/$weak_regex/) {
410         $weak{$2} = $1;
411     }
412 }
413 close(IN);
414
415 my @offsets;            # Array of offsets of mcount callers
416 my $ref_func;           # reference function to use for offsets
417 my $offset = 0;         # offset of ref_func to section beginning
418
419 ##
420 # update_funcs - print out the current mcount callers
421 #
422 #  Go through the list of offsets to callers and write them to
423 #  the output file in a format that can be read by an assembler.
424 #
425 sub update_funcs
426 {
427     return unless ($ref_func and @offsets);
428
429     # Sanity check on weak function. A weak function may be overwritten by
430     # another function of the same name, making all these offsets incorrect.
431     if (defined $weak{$ref_func}) {
432         die "$inputfile: ERROR: referencing weak function" .
433             " $ref_func for mcount\n";
434     }
435
436     # is this function static? If so, note this fact.
437     if (defined $locals{$ref_func}) {
438         $convert{$ref_func} = 1;
439     }
440
441     # Loop through all the mcount caller offsets and print a reference
442     # to the caller based from the ref_func.
443     if (!$opened) {
444         open(FILE, ">$mcount_s") || die "can't create $mcount_s\n";
445         $opened = 1;
446         print FILE "\t.section $mcount_section,\"a\",$section_type\n";
447         print FILE "\t.align $alignment\n" if (defined($alignment));
448     }
449     foreach my $cur_offset (@offsets) {
450         printf FILE "\t%s %s + %d\n", $type, $ref_func, $cur_offset - $offset;
451     }
452 }
453
454 #
455 # Step 2: find the sections and mcount call sites
456 #
457 open(IN, "LC_ALL=C $objdump -hdr $inputfile|") || die "error running $objdump";
458
459 my $text;
460
461
462 # read headers first
463 my $read_headers = 1;
464
465 while (<IN>) {
466
467     if ($read_headers && /$mcount_section/) {
468         #
469         # Somehow the make process can execute this script on an
470         # object twice. If it does, we would duplicate the mcount
471         # section and it will cause the function tracer self test
472         # to fail. Check if the mcount section exists, and if it does,
473         # warn and exit.
474         #
475         print STDERR "ERROR: $mcount_section already in $inputfile\n" .
476             "\tThis may be an indication that your build is corrupted.\n" .
477             "\tDelete $inputfile and try again. If the same object file\n" .
478             "\tstill causes an issue, then disable CONFIG_DYNAMIC_FTRACE.\n";
479         exit(-1);
480     }
481
482     # is it a section?
483     if (/$section_regex/) {
484         $read_headers = 0;
485
486         # Only record text sections that we know are safe
487         $read_function = defined($text_sections{$1});
488         if (!$read_function) {
489             foreach my $prefix (keys %text_section_prefixes) {
490                 if (substr($1, 0, length $prefix) eq $prefix) {
491                     $read_function = 1;
492                     last;
493                 }
494             }
495         }
496         # print out any recorded offsets
497         update_funcs();
498
499         # reset all markers and arrays
500         $text_found = 0;
501         undef($ref_func);
502         undef(@offsets);
503
504     # section found, now is this a start of a function?
505     } elsif ($read_function && /$function_regex/) {
506         $text_found = 1;
507         $text = $2;
508
509         # if this is either a local function or a weak function
510         # keep looking for functions that are global that
511         # we can use safely.
512         if (!defined($locals{$text}) && !defined($weak{$text})) {
513             $ref_func = $text;
514             $read_function = 0;
515             $offset = hex $1;
516         } else {
517             # if we already have a function, and this is weak, skip it
518             if (!defined($ref_func) && !defined($weak{$text}) &&
519                  # PPC64 can have symbols that start with .L and
520                  # gcc considers these special. Don't use them!
521                  $text !~ /^\.L/) {
522                 $ref_func = $text;
523                 $offset = hex $1;
524             }
525         }
526     }
527     # is this a call site to mcount? If so, record it to print later
528     if ($text_found && /$mcount_regex/) {
529         push(@offsets, (hex $1) + $mcount_adjust);
530     }
531 }
532
533 # dump out anymore offsets that may have been found
534 update_funcs();
535
536 # If we did not find any mcount callers, we are done (do nothing).
537 if (!$opened) {
538     exit(0);
539 }
540
541 close(FILE);
542
543 #
544 # Step 3: Compile the file that holds the list of call sites to mcount.
545 #
546 `$cc -o $mcount_o -c $mcount_s`;
547
548 my @converts = keys %convert;
549
550 #
551 # Step 4: Do we have sections that started with local functions?
552 #
553 if ($#converts >= 0) {
554     my $globallist = "";
555     my $locallist = "";
556
557     foreach my $con (@converts) {
558         $globallist .= " --globalize-symbol $con";
559         $locallist .= " --localize-symbol $con";
560     }
561
562     my $globalobj = $dirname . "/.tmp_gl_" . $filename;
563     my $globalmix = $dirname . "/.tmp_mx_" . $filename;
564
565     #
566     # Step 5: set up each local function as a global
567     #
568     `$objcopy $globallist $inputfile $globalobj`;
569
570     #
571     # Step 6: Link the global version to our list.
572     #
573     `$ld -r $globalobj $mcount_o -o $globalmix`;
574
575     #
576     # Step 7: Convert the local functions back into local symbols
577     #
578     `$objcopy $locallist $globalmix $inputfile`;
579
580     # Remove the temp files
581     `$rm $globalobj $globalmix`;
582
583 } else {
584
585     my $mix = $dirname . "/.tmp_mx_" . $filename;
586
587     #
588     # Step 8: Link the object with our list of call sites object.
589     #
590     `$ld -r $inputfile $mcount_o -o $mix`;
591
592     #
593     # Step 9: Move the result back to the original object.
594     #
595     `$mv $mix $inputfile`;
596 }
597
598 # Clean up the temp files
599 `$rm $mcount_o $mcount_s`;
600
601 exit(0);
602
603 # vim: softtabstop=4