[deliverable/linux.git] / scripts / recordmcount.pl

#!/usr/bin/perl -w
# (c) 2008, Steven Rostedt <srostedt@redhat.com>
# Licensed under the terms of the GNU GPL License version 2
#
# recordmcount.pl - makes a section called __mcount_loc that holds
#                   all the offsets to the calls to mcount.
#
#
# What we want to end up with this is that each object file will have a
# section called __mcount_loc that will hold the list of pointers to mcount
# callers. After final linking, the vmlinux will have within .init.data the
# list of all callers to mcount between __start_mcount_loc and __stop_mcount_loc.
# Later on boot up, the kernel will read this list, save the locations and turn
# them into nops. When tracing or profiling is later enabled, these locations
# will then be converted back to pointers to some function.
#
# This is no easy feat. This script is called just after the original
# object is compiled and before it is linked.
#
# When parse this object file using 'objdump', the references to the call
# sites are offsets from the section that the call site is in. Hence, all
# functions in a section that has a call site to mcount, will have the
# offset from the beginning of the section and not the beginning of the
# function.
#
# But where this section will reside finally in vmlinx is undetermined at
# this point. So we can't use this kind of offsets to record the final
# address of this call site.
#
# The trick is to change the call offset referring the start of a section to
# referring a function symbol in this section. During the link step, 'ld' will
# compute the final address according to the information we record.
#
# e.g.
#
#  .section ".sched.text", "ax"
#        [...]
#  func1:
#        [...]
#        call mcount  (offset: 0x10)
#        [...]
#        ret
#  .globl fun2
#  func2:             (offset: 0x20)
#        [...]
#        [...]
#        ret
#  func3:
#        [...]
#        call mcount (offset: 0x30)
#        [...]
#
# Both relocation offsets for the mcounts in the above example will be
# offset from .sched.text. If we choose global symbol func2 as a reference and
# make another file called tmp.s with the new offsets:
#
#  .section __mcount_loc
#  .quad  func2 - 0x10
#  .quad  func2 + 0x10
#
# We can then compile this tmp.s into tmp.o, and link it back to the original
# object.
#
# In our algorithm, we will choose the first global function we meet in this
# section as the reference. But this gets hard if there is no global functions
# in this section. In such a case we have to select a local one. E.g. func1:
#
#  .section ".sched.text", "ax"
#  func1:
#        [...]
#        call mcount  (offset: 0x10)
#        [...]
#        ret
#  func2:
#        [...]
#        call mcount (offset: 0x20)
#        [...]
#  .section "other.section"
#
# If we make the tmp.s the same as above, when we link together with
# the original object, we will end up with two symbols for func1:
# one local, one global.  After final compile, we will end up with
# an undefined reference to func1 or a wrong reference to another global
# func1 in other files.
#
# Since local objects can reference local variables, we need to find
# a way to make tmp.o reference the local objects of the original object
# file after it is linked together. To do this, we convert func1
# into a global symbol before linking tmp.o. Then after we link tmp.o
# we will only have a single symbol for func1 that is global.
# We can convert func1 back into a local symbol and we are done.
#
# Here are the steps we take:
#
# 1) Record all the local and weak symbols by using 'nm'
# 2) Use objdump to find all the call site offsets and sections for
#    mcount.
# 3) Compile the list into its own object.
# 4) Do we have to deal with local functions? If not, go to step 8.
# 5) Make an object that converts these local functions to global symbols
#    with objcopy.
# 6) Link together this new object with the list object.
# 7) Convert the local functions back to local symbols and rename
#    the result as the original object.
# 8) Link the object with the list object.
# 9) Move the result back to the original object.
#

use strict;

my $P = $0;
$P =~ s@.*/@@g;

my $V = '0.1';

if ($#ARGV != 11) {
	print "usage: $P arch endian bits objdump objcopy cc ld nm rm mv is_module inputfile\n";
	print "version: $V\n";
	exit(1);
}

my ($arch, $endian, $bits, $objdump, $objcopy, $cc,
    $ld, $nm, $rm, $mv, $is_module, $inputfile) = @ARGV;

# This file refers to mcount and shouldn't be ftraced, so lets' ignore it
if ($inputfile =~ m,kernel/trace/ftrace\.o$,) {
    exit(0);
}

# Acceptable sections to record.
my %text_sections = (
     ".text" => 1,
     ".ref.text" => 1,
     ".sched.text" => 1,
     ".spinlock.text" => 1,
     ".irqentry.text" => 1,
     ".kprobes.text" => 1,
     ".text.unlikely" => 1,
);

# Note: we are nice to C-programmers here, thus we skip the '||='-idiom.
$objdump = 'objdump' if (!$objdump);
$objcopy = 'objcopy' if (!$objcopy);
$cc = 'gcc' if (!$cc);
$ld = 'ld' if (!$ld);
$nm = 'nm' if (!$nm);
$rm = 'rm' if (!$rm);
$mv = 'mv' if (!$mv);

#print STDERR "running: $P '$arch' '$objdump' '$objcopy' '$cc' '$ld' " .
#    "'$nm' '$rm' '$mv' '$inputfile'\n";

my %locals;		# List of local (static) functions
my %weak;		# List of weak functions
my %convert;		# List of local functions used that needs conversion

my $type;
my $local_regex;	# Match a local function (return function)
my $weak_regex; 	# Match a weak function (return function)
my $section_regex;	# Find the start of a section
my $function_regex;	# Find the name of a function
			#    (return offset and func name)
my $mcount_regex;	# Find the call site to mcount (return offset)
my $mcount_adjust;	# Address adjustment to mcount offset
my $alignment;		# The .align value to use for $mcount_section
my $section_type;	# Section header plus possible alignment command
my $can_use_local = 0; 	# If we can use local function references

# Shut up recordmcount if user has older objcopy
my $quiet_recordmcount = ".tmp_quiet_recordmcount";
my $print_warning = 1;
$print_warning = 0 if ( -f $quiet_recordmcount);

##
# check_objcopy - whether objcopy supports --globalize-symbols
#
#  --globalize-symbols came out in 2.17, we must test the version
#  of objcopy, and if it is less than 2.17, then we can not
#  record local functions.
sub check_objcopy
{
    open (IN, "$objcopy --version |") or die "error running $objcopy";
    while (<IN>) {
	if (/objcopy.*\s(\d+)\.(\d+)/) {
	    $can_use_local = 1 if ($1 > 2 || ($1 == 2 && $2 >= 17));
	    last;
	}
    }
    close (IN);

    if (!$can_use_local && $print_warning) {
	print STDERR "WARNING: could not find objcopy version or version " .
	    "is less than 2.17.\n" .
	    "\tLocal function references are disabled.\n";
	open (QUIET, ">$quiet_recordmcount");
	printf QUIET "Disables the warning from recordmcount.pl\n";
	close QUIET;
    }
}

if ($arch =~ /(x86(_64)?)|(i386)/) {
    if ($bits == 64) {
	$arch = "x86_64";
    } else {
	$arch = "i386";
    }
}

#
# We base the defaults off of i386, the other archs may
# feel free to change them in the below if statements.
#
$local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\S+)";
$weak_regex = "^[0-9a-fA-F]+\\s+([wW])\\s+(\\S+)";
$section_regex = "Disassembly of section\\s+(\\S+):";
$function_regex = "^([0-9a-fA-F]+)\\s+<(.*?)>:";
$mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\smcount\$";
$section_type = '@progbits';
$mcount_adjust = 0;
$type = ".long";

if ($arch eq "x86_64") {
    $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\smcount([+-]0x[0-9a-zA-Z]+)?\$";
    $type = ".quad";
    $alignment = 8;

    # force flags for this arch
    $ld .= " -m elf_x86_64";
    $objdump .= " -M x86-64";
    $objcopy .= " -O elf64-x86-64";
    $cc .= " -m64";

} elsif ($arch eq "i386") {
    $alignment = 4;

    # force flags for this arch
    $ld .= " -m elf_i386";
    $objdump .= " -M i386";
    $objcopy .= " -O elf32-i386";
    $cc .= " -m32";

} elsif ($arch eq "s390" && $bits == 32) {
    $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_390_32\\s+_mcount\$";
    $alignment = 4;
    $ld .= " -m elf_s390";
    $cc .= " -m31";

} elsif ($arch eq "s390" && $bits == 64) {
    $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_390_(PC|PLT)32DBL\\s+_mcount\\+0x2\$";
    $alignment = 8;
    $type = ".quad";
    $ld .= " -m elf64_s390";
    $cc .= " -m64";

} elsif ($arch eq "sh") {
    $alignment = 2;

    # force flags for this arch
    $ld .= " -m shlelf_linux";
    $objcopy .= " -O elf32-sh-linux";
    $cc .= " -m32";

} elsif ($arch eq "powerpc") {
    $local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\.?\\S+)";
    $function_regex = "^([0-9a-fA-F]+)\\s+<(\\.?.*?)>:";
    $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s\\.?_mcount\$";

    if ($bits == 64) {
	$type = ".quad";
    }

} elsif ($arch eq "arm") {
    $alignment = 2;
    $section_type = '%progbits';
    $mcount_regex = "^\\s*([0-9a-fA-F]+):\\s*R_ARM_(CALL|PC24|THM_CALL)" .
			"\\s+(__gnu_mcount_nc|mcount)\$";

} elsif ($arch eq "ia64") {
    $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
    $type = "data8";

    if ($is_module eq "0") {
        $cc .= " -mconstant-gp";
    }
} elsif ($arch eq "sparc64") {
    # In the objdump output there are giblets like:
    # 0000000000000000 <igmp_net_exit-0x18>:
    # As there's some data blobs that get emitted into the
    # text section before the first instructions and the first
    # real symbols.  We don't want to match that, so to combat
    # this we use '\w' so we'll match just plain symbol names,
    # and not those that also include hex offsets inside of the
    # '<>' brackets.  Actually the generic function_regex setting
    # could safely use this too.
    $function_regex = "^([0-9a-fA-F]+)\\s+<(\\w*?)>:";

    # Sparc64 calls '_mcount' instead of plain 'mcount'.
    $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";

    $alignment = 8;
    $type = ".xword";
    $ld .= " -m elf64_sparc";
    $cc .= " -m64";
    $objcopy .= " -O elf64-sparc";
} elsif ($arch eq "mips") {
    # To enable module support, we need to enable the -mlong-calls option
    # of gcc for module, after using this option, we can not get the real
    # offset of the calling to _mcount, but the offset of the lui
    # instruction or the addiu one. herein, we record the address of the
    # first one, and then we can replace this instruction by a branch
    # instruction to jump over the profiling function to filter the
    # indicated functions, or swith back to the lui instruction to trace
    # them, which means dynamic tracing.
    #
    #       c:	3c030000 	lui	v1,0x0
    #			c: R_MIPS_HI16	_mcount
    #			c: R_MIPS_NONE	*ABS*
    #			c: R_MIPS_NONE	*ABS*
    #      10:	64630000 	daddiu	v1,v1,0
    #			10: R_MIPS_LO16	_mcount
    #			10: R_MIPS_NONE	*ABS*
    #			10: R_MIPS_NONE	*ABS*
    #      14:	03e0082d 	move	at,ra
    #      18:	0060f809 	jalr	v1
    #
    # for the kernel:
    #
    #     10:   03e0082d        move    at,ra
    #	  14:   0c000000        jal     0 <loongson_halt>
    #                    14: R_MIPS_26   _mcount
    #                    14: R_MIPS_NONE *ABS*
    #                    14: R_MIPS_NONE *ABS*
    #	 18:   00020021        nop
    if ($is_module eq "0") {
	    $mcount_regex = "^\\s*([0-9a-fA-F]+): R_MIPS_26\\s+_mcount\$";
    } else {
	    $mcount_regex = "^\\s*([0-9a-fA-F]+): R_MIPS_HI16\\s+_mcount\$";
    }
    $objdump .= " -Melf-trad".$endian."mips ";

    if ($endian eq "big") {
	    $endian = " -EB ";
	    $ld .= " -melf".$bits."btsmip";
    } else {
	    $endian = " -EL ";
	    $ld .= " -melf".$bits."ltsmip";
    }

    $cc .= " -mno-abicalls -fno-pic -mabi=" . $bits . $endian;
    $ld .= $endian;

    if ($bits == 64) {
	    $function_regex =
		"^([0-9a-fA-F]+)\\s+<(.|[^\$]L.*?|\$[^L].*?|[^\$][^L].*?)>:";
	    $type = ".dword";
    }
} elsif ($arch eq "microblaze") {
    # Microblaze calls '_mcount' instead of plain 'mcount'.
    $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s_mcount\$";
} elsif ($arch eq "blackfin") {
    $mcount_regex = "^\\s*([0-9a-fA-F]+):.*\\s__mcount\$";
    $mcount_adjust = -4;
} else {
    die "Arch $arch is not supported with CONFIG_FTRACE_MCOUNT_RECORD";
}

my $text_found = 0;
my $read_function = 0;
my $opened = 0;
my $mcount_section = "__mcount_loc";

my $dirname;
my $filename;
my $prefix;
my $ext;

if ($inputfile =~ m,^(.*)/([^/]*)$,) {
    $dirname = $1;
    $filename = $2;
} else {
    $dirname = ".";
    $filename = $inputfile;
}

if ($filename =~ m,^(.*)(\.\S),) {
    $prefix = $1;
    $ext = $2;
} else {
    $prefix = $filename;
    $ext = "";
}

my $mcount_s = $dirname . "/.tmp_mc_" . $prefix . ".s";
my $mcount_o = $dirname . "/.tmp_mc_" . $prefix . ".o";

check_objcopy();

#
# Step 1: find all the local (static functions) and weak symbols.
#         't' is local, 'w/W' is weak
#
open (IN, "$nm $inputfile|") || die "error running $nm";
while (<IN>) {
    if (/$local_regex/) {
	$locals{$1} = 1;
    } elsif (/$weak_regex/) {
	$weak{$2} = $1;
    }
}
close(IN);

my @offsets;		# Array of offsets of mcount callers
my $ref_func;		# reference function to use for offsets
my $offset = 0;		# offset of ref_func to section beginning

##
# update_funcs - print out the current mcount callers
#
#  Go through the list of offsets to callers and write them to
#  the output file in a format that can be read by an assembler.
#
sub update_funcs
{
    return unless ($ref_func and @offsets);

    # Sanity check on weak function. A weak function may be overwritten by
    # another function of the same name, making all these offsets incorrect.
    if (defined $weak{$ref_func}) {
	die "$inputfile: ERROR: referencing weak function" .
	    " $ref_func for mcount\n";
    }

    # is this function static? If so, note this fact.
    if (defined $locals{$ref_func}) {

	# only use locals if objcopy supports globalize-symbols
	if (!$can_use_local) {
	    return;
	}
	$convert{$ref_func} = 1;
    }

    # Loop through all the mcount caller offsets and print a reference
    # to the caller based from the ref_func.
    if (!$opened) {
	open(FILE, ">$mcount_s") || die "can't create $mcount_s\n";
	$opened = 1;
	print FILE "\t.section $mcount_section,\"a\",$section_type\n";
	print FILE "\t.align $alignment\n" if (defined($alignment));
    }
    foreach my $cur_offset (@offsets) {
	printf FILE "\t%s %s + %d\n", $type, $ref_func, $cur_offset - $offset;
    }
}

#
# Step 2: find the sections and mcount call sites
#
open(IN, "$objdump -hdr $inputfile|") || die "error running $objdump";

my $text;


# read headers first
my $read_headers = 1;

while (<IN>) {

    if ($read_headers && /$mcount_section/) {
	#
	# Somehow the make process can execute this script on an
	# object twice. If it does, we would duplicate the mcount
	# section and it will cause the function tracer self test
	# to fail. Check if the mcount section exists, and if it does,
	# warn and exit.
	#
	print STDERR "ERROR: $mcount_section already in $inputfile\n" .
	    "\tThis may be an indication that your build is corrupted.\n" .
	    "\tDelete $inputfile and try again. If the same object file\n" .
	    "\tstill causes an issue, then disable CONFIG_DYNAMIC_FTRACE.\n";
	exit(-1);
    }

    # is it a section?
    if (/$section_regex/) {
	$read_headers = 0;

	# Only record text sections that we know are safe
	$read_function = defined($text_sections{$1});
	# print out any recorded offsets
	update_funcs();

	# reset all markers and arrays
	$text_found = 0;
	undef($ref_func);
	undef(@offsets);

    # section found, now is this a start of a function?
    } elsif ($read_function && /$function_regex/) {
	$text_found = 1;
	$text = $2;

	# if this is either a local function or a weak function
	# keep looking for functions that are global that
	# we can use safely.
	if (!defined($locals{$text}) && !defined($weak{$text})) {
	    $ref_func = $text;
	    $read_function = 0;
	    $offset = hex $1;
	} else {
	    # if we already have a function, and this is weak, skip it
	    if (!defined($ref_func) && !defined($weak{$text}) &&
		 # PPC64 can have symbols that start with .L and
		 # gcc considers these special. Don't use them!
		 $text !~ /^\.L/) {
		$ref_func = $text;
		$offset = hex $1;
	    }
	}
    }
    # is this a call site to mcount? If so, record it to print later
    if ($text_found && /$mcount_regex/) {
	push(@offsets, (hex $1) + $mcount_adjust);
    }
}

# dump out anymore offsets that may have been found
update_funcs();

# If we did not find any mcount callers, we are done (do nothing).
if (!$opened) {
    exit(0);
}

close(FILE);

#
# Step 3: Compile the file that holds the list of call sites to mcount.
#
`$cc -o $mcount_o -c $mcount_s`;

my @converts = keys %convert;

#
# Step 4: Do we have sections that started with local functions?
#
if ($#converts >= 0) {
    my $globallist = "";
    my $locallist = "";

    foreach my $con (@converts) {
	$globallist .= " --globalize-symbol $con";
	$locallist .= " --localize-symbol $con";
    }

    my $globalobj = $dirname . "/.tmp_gl_" . $filename;
    my $globalmix = $dirname . "/.tmp_mx_" . $filename;

    #
    # Step 5: set up each local function as a global
    #
    `$objcopy $globallist $inputfile $globalobj`;

    #
    # Step 6: Link the global version to our list.
    #
    `$ld -r $globalobj $mcount_o -o $globalmix`;

    #
    # Step 7: Convert the local functions back into local symbols
    #
    `$objcopy $locallist $globalmix $inputfile`;

    # Remove the temp files
    `$rm $globalobj $globalmix`;

} else {

    my $mix = $dirname . "/.tmp_mx_" . $filename;

    #
    # Step 8: Link the object with our list of call sites object.
    #
    `$ld -r $inputfile $mcount_o -o $mix`;

    #
    # Step 9: Move the result back to the original object.
    #
    `$mv $mix $inputfile`;
}

# Clean up the temp files
`$rm $mcount_o $mcount_s`;

exit(0);
Commit	Line	Data
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.
8da3821b SR	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	# [...]
8da3821b SR	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
d49f6aa7 LH	55	# make another file called tmp.s with the new offsets:
8da3821b SR	56	#
8da3821b SR	57	# .section __mcount_loc
d49f6aa7 LH	58	# .quad func2 - 0x10
d49f6aa7 LH	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.
8da3821b SR	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	# [...]
8da3821b SR	73	# ret
d49f6aa7	74	# func2:
8da3821b	75	# [...]
d49f6aa7	76	# call mcount (offset: 0x20)
8da3821b	77	# [...]
d49f6aa7	78	# .section "other.section"
8da3821b SR	79	#
8da3821b SR	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
d49f6aa7 LH	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.
d49f6aa7 LH	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	#
306dcf47	95	# 1) Record all the local and weak symbols by using 'nm'
8da3821b SR	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.
8da3821b SR	106	# 9) Move the result back to the original object.
8da3821b SR	107	#
	108
	109	use strict;
	110
	111	my $P = $0;
	112	$P =~ s@.*/@@g;
	113
	114	my $V = '0.1';
	115
e6299d26 WZ	116	if ($#ARGV != 11) {
e6299d26 WZ	117	print "usage: $P arch endian bits objdump objcopy cc ld nm rm mv is_module inputfile\n";
8da3821b SR	118	print "version: $V\n";
	119	exit(1);
	120	}
	121
e6299d26	122	my ($arch, $endian, $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	126	if ($inputfile =~ m,kernel/trace/ftrace\.o$,) {
25aac9dc SL	127	exit(0);
	128	}
	129
34698bcb SR	130	# Acceptable sections to record.
	131	my %text_sections = (
	132	".text" => 1,
1274a9c2	133	".ref.text" => 1,
d144d5ee LW	134	".sched.text" => 1,
d144d5ee LW	135	".spinlock.text" => 1,
a0343e82	136	".irqentry.text" => 1,
9f087e76	137	".kprobes.text" => 1,
4d828949	138	".text.unlikely" => 1,
34698bcb SR	139	);
34698bcb SR	140
dfaa9e2c WS	141	# Note: we are nice to C-programmers here, thus we skip the '\|\|='-idiom.
	142	$objdump = 'objdump' if (!$objdump);
	143	$objcopy = 'objcopy' if (!$objcopy);
	144	$cc = 'gcc' if (!$cc);
	145	$ld = 'ld' if (!$ld);
	146	$nm = 'nm' if (!$nm);
	147	$rm = 'rm' if (!$rm);
	148	$mv = 'mv' if (!$mv);
8da3821b SR	149
	150	#print STDERR "running: $P '$arch' '$objdump' '$objcopy' '$cc' '$ld' " .
	151	# "'$nm' '$rm' '$mv' '$inputfile'\n";
	152
8feff1ca SR	153	my %locals; # List of local (static) functions
	154	my %weak; # List of weak functions
	155	my %convert; # List of local functions used that needs conversion
8da3821b SR	156
8da3821b SR	157	my $type;
306dcf47 LH	158	my $local_regex; # Match a local function (return function)
306dcf47 LH	159	my $weak_regex; # Match a weak function (return function)
8da3821b	160	my $section_regex; # Find the start of a section
8feff1ca SR	161	my $function_regex; # Find the name of a function
8feff1ca SR	162	# (return offset and func name)
8da3821b	163	my $mcount_regex; # Find the call site to mcount (return offset)
465c6cca	164	my $mcount_adjust; # Address adjustment to mcount offset
3a3d04ae	165	my $alignment; # The .align value to use for $mcount_section
e58918ab	166	my $section_type; # Section header plus possible alignment command
7b7edc27 LH	167	my $can_use_local = 0; # If we can use local function references
7b7edc27 LH	168
638adb05 SR	169	# Shut up recordmcount if user has older objcopy
	170	my $quiet_recordmcount = ".tmp_quiet_recordmcount";
	171	my $print_warning = 1;
	172	$print_warning = 0 if ( -f $quiet_recordmcount);
	173
7b7edc27 LH	174	##
	175	# check_objcopy - whether objcopy supports --globalize-symbols
	176	#
	177	# --globalize-symbols came out in 2.17, we must test the version
	178	# of objcopy, and if it is less than 2.17, then we can not
	179	# record local functions.
	180	sub check_objcopy
	181	{
	182	open (IN, "$objcopy --version \|") or die "error running $objcopy";
	183	while (<IN>) {
	184	if (/objcopy.*\s(\d+)\.(\d+)/) {
	185	$can_use_local = 1 if ($1 > 2 \|\| ($1 == 2 && $2 >= 17));
	186	last;
	187	}
	188	}
	189	close (IN);
	190
638adb05	191	if (!$can_use_local && $print_warning) {
7b7edc27 LH	192	print STDERR "WARNING: could not find objcopy version or version " .
7b7edc27 LH	193	"is less than 2.17.\n" .
638adb05 SR	194	"\tLocal function references are disabled.\n";
	195	open (QUIET, ">$quiet_recordmcount");
	196	printf QUIET "Disables the warning from recordmcount.pl\n";
	197	close QUIET;
7b7edc27 LH	198	}
7b7edc27 LH	199	}
8da3821b	200
b82a4045	201	if ($arch =~ /(x86(_64)?)\|(i386)/) {
dce9d18a SR	202	if ($bits == 64) {
	203	$arch = "x86_64";
	204	} else {
	205	$arch = "i386";
	206	}
	207	}
	208
c204f726 SR	209	#
	210	# We base the defaults off of i386, the other archs may
	211	# feel free to change them in the below if statements.
	212	#
306dcf47 LH	213	$local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\S+)";
306dcf47 LH	214	$weak_regex = "^[0-9a-fA-F]+\\s+([wW])\\s+(\\S+)";
c204f726 SR	215	$section_regex = "Disassembly of section\\s+(\\S+):";
	216	$function_regex = "^([0-9a-fA-F]+)\\s+<(.*?)>:";
	217	$mcount_regex = "^\\s([0-9a-fA-F]+):.\\smcount\$";
e58918ab	218	$section_type = '@progbits';
465c6cca	219	$mcount_adjust = 0;
c204f726 SR	220	$type = ".long";
c204f726 SR	221
8da3821b	222	if ($arch eq "x86_64") {
8da3821b SR	223	$mcount_regex = "^\\s([0-9a-fA-F]+):.\\smcount([+-]0x[0-9a-zA-Z]+)?\$";
8da3821b SR	224	$type = ".quad";
7d5222a6	225	$alignment = 8;
d74fcd1e SR	226
	227	# force flags for this arch
	228	$ld .= " -m elf_x86_64";
	229	$objdump .= " -M x86-64";
	230	$objcopy .= " -O elf64-x86-64";
	231	$cc .= " -m64";
	232
8da3821b	233	} elsif ($arch eq "i386") {
7d5222a6	234	$alignment = 4;
d74fcd1e SR	235
	236	# force flags for this arch
	237	$ld .= " -m elf_i386";
	238	$objdump .= " -M i386";
	239	$objcopy .= " -O elf32-i386";
	240	$cc .= " -m32";
	241
dfd9f7ab HC	242	} elsif ($arch eq "s390" && $bits == 32) {
	243	$mcount_regex = "^\\s([0-9a-fA-F]+):\\sR_390_32\\s+_mcount\$";
	244	$alignment = 4;
	245	$ld .= " -m elf_s390";
	246	$cc .= " -m31";
	247
	248	} elsif ($arch eq "s390" && $bits == 64) {
	249	$mcount_regex = "^\\s([0-9a-fA-F]+):\\sR_390_(PC\|PLT)32DBL\\s+_mcount\\+0x2\$";
	250	$alignment = 8;
	251	$type = ".quad";
	252	$ld .= " -m elf64_s390";
	253	$cc .= " -m64";
	254
0da85c09	255	} elsif ($arch eq "sh") {
3a3d04ae	256	$alignment = 2;
0da85c09 MF	257
	258	# force flags for this arch
	259	$ld .= " -m shlelf_linux";
	260	$objcopy .= " -O elf32-sh-linux";
	261	$cc .= " -m32";
	262
42e007d0	263	} elsif ($arch eq "powerpc") {
306dcf47	264	$local_regex = "^[0-9a-fA-F]+\\s+t\\s+(\\.?\\S+)";
42e007d0 SR	265	$function_regex = "^([0-9a-fA-F]+)\\s+<(\\.?.*?)>:";
42e007d0 SR	266	$mcount_regex = "^\\s([0-9a-fA-F]+):.\\s\\.?_mcount\$";
c204f726	267
42e007d0 SR	268	if ($bits == 64) {
42e007d0 SR	269	$type = ".quad";
42e007d0 SR	270	}
42e007d0 SR	271
e58918ab JR	272	} elsif ($arch eq "arm") {
	273	$alignment = 2;
	274	$section_type = '%progbits';
72dc43a9	275	$mcount_regex = "^\\s([0-9a-fA-F]+):\\sR_ARM_(CALL\|PC24\|THM_CALL)" .
3b6c223b	276	"\\s+(__gnu_mcount_nc\|mcount)\$";
e58918ab	277
418071eb SL	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	}
9be12f9b DM	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";
538f1952 WZ	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 swith 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") {
a484e54f	335	$mcount_regex = "^\\s*([0-9a-fA-F]+): R_MIPS_26\\s+_mcount\$";
538f1952 WZ	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	}
7d241ff0 MS	357	} elsif ($arch eq "microblaze") {
	358	# Microblaze calls '_mcount' instead of plain 'mcount'.
	359	$mcount_regex = "^\\s([0-9a-fA-F]+):.\\s_mcount\$";
465c6cca MF	360	} elsif ($arch eq "blackfin") {
	361	$mcount_regex = "^\\s([0-9a-fA-F]+):.\\s__mcount\$";
	362	$mcount_adjust = -4;
8da3821b SR	363	} else {
	364	die "Arch $arch is not supported with CONFIG_FTRACE_MCOUNT_RECORD";
	365	}
	366
	367	my $text_found = 0;
	368	my $read_function = 0;
	369	my $opened = 0;
8da3821b SR	370	my $mcount_section = "__mcount_loc";
	371
	372	my $dirname;
	373	my $filename;
	374	my $prefix;
	375	my $ext;
	376
	377	if ($inputfile =~ m,^(.)/([^/])$,) {
	378	$dirname = $1;
	379	$filename = $2;
	380	} else {
	381	$dirname = ".";
	382	$filename = $inputfile;
	383	}
	384
	385	if ($filename =~ m,^(.*)(\.\S),) {
	386	$prefix = $1;
	387	$ext = $2;
	388	} else {
	389	$prefix = $filename;
	390	$ext = "";
	391	}
	392
	393	my $mcount_s = $dirname . "/.tmp_mc_" . $prefix . ".s";
	394	my $mcount_o = $dirname . "/.tmp_mc_" . $prefix . ".o";
	395
7b7edc27	396	check_objcopy();
f2f8458e	397
8da3821b	398	#
8feff1ca	399	# Step 1: find all the local (static functions) and weak symbols.
306dcf47	400	# 't' is local, 'w/W' is weak
8da3821b SR	401	#
	402	open (IN, "$nm $inputfile\|") \|\| die "error running $nm";
	403	while (<IN>) {
306dcf47	404	if (/$local_regex/) {
8da3821b	405	$locals{$1} = 1;
306dcf47	406	} elsif (/$weak_regex/) {
8feff1ca	407	$weak{$2} = $1;
8da3821b SR	408	}
	409	}
	410	close(IN);
	411
8feff1ca SR	412	my @offsets; # Array of offsets of mcount callers
	413	my $ref_func; # reference function to use for offsets
	414	my $offset = 0; # offset of ref_func to section beginning
	415
	416	##
	417	# update_funcs - print out the current mcount callers
	418	#
	419	# Go through the list of offsets to callers and write them to
	420	# the output file in a format that can be read by an assembler.
	421	#
	422	sub update_funcs
	423	{
6092858c	424	return unless ($ref_func and @offsets);
8feff1ca	425
c4b8ac2c LH	426	# Sanity check on weak function. A weak function may be overwritten by
c4b8ac2c LH	427	# another function of the same name, making all these offsets incorrect.
8feff1ca	428	if (defined $weak{$ref_func}) {
c4b8ac2c	429	die "$inputfile: ERROR: referencing weak function" .
8feff1ca	430	" $ref_func for mcount\n";
8feff1ca SR	431	}
	432
	433	# is this function static? If so, note this fact.
	434	if (defined $locals{$ref_func}) {
f2f8458e SR	435
f2f8458e SR	436	# only use locals if objcopy supports globalize-symbols
7b7edc27	437	if (!$can_use_local) {
f2f8458e SR	438	return;
f2f8458e SR	439	}
8feff1ca SR	440	$convert{$ref_func} = 1;
	441	}
	442
	443	# Loop through all the mcount caller offsets and print a reference
	444	# to the caller based from the ref_func.
dc4f8845 WS	445	if (!$opened) {
	446	open(FILE, ">$mcount_s") \|\| die "can't create $mcount_s\n";
	447	$opened = 1;
	448	print FILE "\t.section $mcount_section,\"a\",$section_type\n";
	449	print FILE "\t.align $alignment\n" if (defined($alignment));
	450	}
	451	foreach my $cur_offset (@offsets) {
	452	printf FILE "\t%s %s + %d\n", $type, $ref_func, $cur_offset - $offset;
8feff1ca SR	453	}
	454	}
	455
8da3821b SR	456	#
	457	# Step 2: find the sections and mcount call sites
	458	#
b43f7093	459	open(IN, "$objdump -hdr $inputfile\|") \|\| die "error running $objdump";
8da3821b	460
8feff1ca SR	461	my $text;
8feff1ca SR	462
db24c7dc LH	463
db24c7dc LH	464	# read headers first
b43f7093 SR	465	my $read_headers = 1;
b43f7093 SR	466
8da3821b	467	while (<IN>) {
db24c7dc LH	468
	469	if ($read_headers && /$mcount_section/) {
	470	#
	471	# Somehow the make process can execute this script on an
	472	# object twice. If it does, we would duplicate the mcount
	473	# section and it will cause the function tracer self test
	474	# to fail. Check if the mcount section exists, and if it does,
	475	# warn and exit.
	476	#
	477	print STDERR "ERROR: $mcount_section already in $inputfile\n" .
	478	"\tThis may be an indication that your build is corrupted.\n" .
	479	"\tDelete $inputfile and try again. If the same object file\n" .
	480	"\tstill causes an issue, then disable CONFIG_DYNAMIC_FTRACE.\n";
	481	exit(-1);
	482	}
	483
8da3821b SR	484	# is it a section?
8da3821b SR	485	if (/$section_regex/) {
b43f7093	486	$read_headers = 0;
34698bcb SR	487
34698bcb SR	488	# Only record text sections that we know are safe
dfaa9e2c	489	$read_function = defined($text_sections{$1});
8feff1ca	490	# print out any recorded offsets
6092858c	491	update_funcs();
8feff1ca SR	492
8feff1ca SR	493	# reset all markers and arrays
8da3821b	494	$text_found = 0;
8feff1ca SR	495	undef($ref_func);
	496	undef(@offsets);
	497
8da3821b SR	498	# section found, now is this a start of a function?
8da3821b SR	499	} elsif ($read_function && /$function_regex/) {
8da3821b	500	$text_found = 1;
8feff1ca SR	501	$text = $2;
	502
	503	# if this is either a local function or a weak function
	504	# keep looking for functions that are global that
	505	# we can use safely.
	506	if (!defined($locals{$text}) && !defined($weak{$text})) {
	507	$ref_func = $text;
	508	$read_function = 0;
bd171d5f	509	$offset = hex $1;
8feff1ca SR	510	} else {
8feff1ca SR	511	# if we already have a function, and this is weak, skip it
3f6e968e SR	512	if (!defined($ref_func) && !defined($weak{$text}) &&
	513	# PPC64 can have symbols that start with .L and
	514	# gcc considers these special. Don't use them!
	515	$text !~ /^\.L/) {
8feff1ca	516	$ref_func = $text;
bd171d5f	517	$offset = hex $1;
8feff1ca	518	}
8da3821b	519	}
8feff1ca	520	}
8feff1ca SR	521	# is this a call site to mcount? If so, record it to print later
8feff1ca SR	522	if ($text_found && /$mcount_regex/) {
465c6cca	523	push(@offsets, (hex $1) + $mcount_adjust);
8da3821b SR	524	}
	525	}
	526
8feff1ca	527	# dump out anymore offsets that may have been found
6092858c	528	update_funcs();
8feff1ca	529
8da3821b SR	530	# If we did not find any mcount callers, we are done (do nothing).
	531	if (!$opened) {
	532	exit(0);
	533	}
	534
	535	close(FILE);
	536
	537	#
	538	# Step 3: Compile the file that holds the list of call sites to mcount.
	539	#
	540	`$cc -o $mcount_o -c $mcount_s`;
	541
	542	my @converts = keys %convert;
	543
	544	#
	545	# Step 4: Do we have sections that started with local functions?
	546	#
	547	if ($#converts >= 0) {
	548	my $globallist = "";
	549	my $locallist = "";
	550
	551	foreach my $con (@converts) {
	552	$globallist .= " --globalize-symbol $con";
	553	$locallist .= " --localize-symbol $con";
	554	}
	555
	556	my $globalobj = $dirname . "/.tmp_gl_" . $filename;
	557	my $globalmix = $dirname . "/.tmp_mx_" . $filename;
	558
	559	#
	560	# Step 5: set up each local function as a global
	561	#
	562	`$objcopy $globallist $inputfile $globalobj`;
	563
	564	#
	565	# Step 6: Link the global version to our list.
	566	#
	567	`$ld -r $globalobj $mcount_o -o $globalmix`;
	568
	569	#
	570	# Step 7: Convert the local functions back into local symbols
	571	#
	572	`$objcopy $locallist $globalmix $inputfile`;
	573
	574	# Remove the temp files
	575	`$rm $globalobj $globalmix`;
	576
	577	} else {
	578
	579	my $mix = $dirname . "/.tmp_mx_" . $filename;
	580
	581	#
	582	# Step 8: Link the object with our list of call sites object.
	583	#
	584	`$ld -r $inputfile $mcount_o -o $mix`;
	585
	586	#
	587	# Step 9: Move the result back to the original object.
	588	#
	589	`$mv $mix $inputfile`;
	590	}
	591
	592	# Clean up the temp files
	593	`$rm $mcount_o $mcount_s`;
594
595	exit(0);