1e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao#!/usr/bin/perl 2e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 3e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaouse Getopt::Std; 4e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao$DEBUG = 0; 5e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 6e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaosub parse_objdump_file { 7e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my ($filename) = @_; 8e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my @result; 9e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao open (INPUT, $filename) or die "$filename: $!\n"; 10e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao print "opened objdump output file $filename\n" if $DEBUG; 11e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao while (<INPUT>) { 12e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao if (/\s*([0-9a-f]*):\t(([0-9a-f]{2} )+) *\t(.*)$/) { 13e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my ($addr, $bytes, $instr) = ($1, $2, $4); 14e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $addr = "0x" . $addr; 15e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $bytes =~ s/\s*(.*\S)\s*/$1/; # trim any remaining whitespace 16e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $instr =~ s/\s*(.*\S)\s*/$1/; 17e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao push (@result, {'addr' => $addr, 'bytes' => $bytes, 'instr' => $instr}); 18e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao print "addr=$addr bytes='$bytes' instr='$instr'\n" if $DEBUG; 19e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 20e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 21e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao close INPUT; 22e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao return @result; 23e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao} 24e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 25e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaosub parse_gdb_file { 26e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my ($filename) = @_; 27e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my @result; 28e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my $got_addr; 29e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao open (INPUT, $filename) or die "$filename: $!\n"; 30e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao print "opened gdb output file $filename\n" if $DEBUG; 31e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao while (<INPUT>) { 32e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao if (/^(0x[0-9a-f]*):\t([^\t]*)\t[^:]*:\t((0x[0-9a-f]{2}\s*)+)\s*$/) { 33e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my ($addr, $bytes, $instr) = ($1, $3, $2); 34e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $bytes =~ s/0x//g; 35e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $bytes =~ s/\s+/ /g; # regularize whitespace 36e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $bytes =~ s/\s*(.*\S)\s*/$1/; # trim any remaining whitespace 37e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $instr =~ s/\s*(.*\S)\s*/$1/; 38e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao push (@result, {'addr' => $addr, 'bytes' => $bytes, 'instr' => $instr}); 39e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao print "addr=$addr bytes='$bytes' instr='$instr'\n" if $DEBUG; 40e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } elsif (/^(0x[0-9a-f]*):\t$/) { # deal with gdb's line breaker 41e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $got_addr = $1; 42e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } elsif ($got_addr && /^ ([^\t]*)\t[^:]*:\t((0x[0-9a-f]{2}\s*)+)\s*$/) { 43e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my ($addr, $bytes, $instr) = ($got_addr, $2, $1); 44e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $bytes =~ s/0x//g; 45e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $bytes =~ s/\s+/ /g; # regularize whitespace 46e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $bytes =~ s/\s*(.*\S)\s*/$1/; # trim any remaining whitespace 47e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao $instr =~ s/\s*(.*\S)\s*/$1/; 48e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao push (@result, {'addr' => $addr, 'bytes' => $bytes, 'instr' => $instr}); 49e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao print "addr=$addr bytes='$bytes' instr='$instr'\n" if $DEBUG; 50e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao undef $got_addr; 51e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 52e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 53e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao close INPUT; 54e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao return @result; 55e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao} 56e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 57e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaosub binary_diffs { 58e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my ($objdump_file, $gdb_file) = @_; 59e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my @file1 = parse_objdump_file ($objdump_file); 60e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my @file2 = parse_gdb_file ($gdb_file); 61e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my $lastrecord = ($#file1 >= $#file2) ? ($#file1) : ($#file2); 62e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao for (my $i = 0; $i <= $lastrecord; ++$i) { 63e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my $d1 = $file1[$i]; 64e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao my $d2 = $file2[$i]; 65e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao if ($d1->{'bytes'} ne $d2->{'bytes'}) { 66e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao next if (($d1->{'instr'} eq $d2->{'instr'}) && $opt_d); 67e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao printf "0x%08x:\t%30s \t%s\n", 0+$d1->{'addr'}, $d1->{'bytes'}, $d1->{'instr'}; 68e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao printf "0x%08x:\t%30s \t%s\n\n", 0+$d2->{'addr'}, $d2->{'bytes'}, $d2->{'instr'}; 69e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 70e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao } 71e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao} 72e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 73e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao&getopts('d'); 74e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao$objdump_file = $ARGV[0]; 75e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao$gdb_file = $ARGV[1]; 76e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaobinary_diffs ($objdump_file, $gdb_file); 77e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaoexit (0); 78e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao__END__ 79e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=pod 80e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 81e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=head1 NAME 82e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 83e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaocodegen-diff 84e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 85e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=head1 SYNOPSIS 86e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 87e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaocodegen-diff [-d] I<OBJDUMP-OUTPUT-FILE> I<GDB-DISASSEMBLY-FILE> 88e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 89e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=head1 DESCRIPTION 90e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 91e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoB<codegen-diff> is a program that tries to show you the differences 92e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaobetween the code that B<llc> generated and the code that B<lli> generated. 93e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 94e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoThe way you use it is as follows: first, you create I<OBJDUMP-OUTPUT-FILE> 95e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaoby running B<objdump> on the B<llc> compiled and linked binary. You need to 96e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaotrim down the result so it contains only the function of interest. 97e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 98e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoSecond, you create I<GDB-DISASSEMBLY-FILE> by running B<gdb>, with my patch 99e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaoto print out hex bytes in the B<disassemble> command output, on 100e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoB<lli>. Set a breakpoint in C<Emitter::finishFunction()> and wait until 101e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaothe function you want is compiled. Then use the B<disassemble> command 102e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaoto print out the assembly dump of the function B<lli> just compiled. 103e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao(Use C<lli -debug> to find out where the function starts and ends in memory.) 104e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoIt's easiest to save this output by using B<script>. 105e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 106e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoFinally, you run B<codegen-diff>, as indicated in the Synopsis section of 107e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaothis manpage. It will print out a two-line stanza for each mismatched 108e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaoinstruction, with the B<llc> version first, and the B<lli> version second. 109e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 110e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=head1 OPTIONS 111e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 112e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=over 4 113e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 114e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=item -d 115e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 116e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoDon't show instructions where the bytes are different but they 117e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaodisassemble to the same thing. This puts a lot of trust in the 118e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaodisassembler, but it might help you highlight the more egregious cases 119e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liaoof misassembly. 120e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 121e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=back 122e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 123e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=head1 AUTHOR 124e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 125e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoB<codegen-diff> was written by Brian Gaeke. 126e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 127e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=head1 SEE ALSO 128e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 129e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoL<gdb(1)>, L<objdump(1)>, L<script(1)>. 130e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 131e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei LiaoYou will need my B<gdb> patch: 132e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 133e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao http://llvm.cs.uiuc.edu/~gaeke/gdb-disassembly-print-bytes.patch 134e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao 135e264f62ca09a8f65c87a46d562a4d0f9ec5d457Shih-wei Liao=cut 136