]> git.xonotic.org Git - xonotic/xonotic.git/blobdiff - misc/tools/progs-analyzer.pl
LNO support.
[xonotic/xonotic.git] / misc / tools / progs-analyzer.pl
old mode 100644 (file)
new mode 100755 (executable)
index ff6edec..026d6af
@@ -1,6 +1,9 @@
+#!/usr/bin/perl
+
 use strict;
 use warnings;
 use Digest::SHA;
+use Carp;
 
 sub id()
 {
@@ -120,6 +123,14 @@ sub checkop($)
        {
                return { a => 'inglobalvec', isreturn => 1 };
        }
+       if($op eq 'STATE')
+       {
+               return { a => 'inglobal', b => 'inglobalfunc' };
+       }
+       if($op =~ /^INVALID#/)
+       {
+               return { isinvalid => 1 };
+       }
        return { a => 'inglobal', b => 'inglobal', c => 'outglobal' };
 }
 
@@ -180,13 +191,26 @@ use constant DFUNCTION_T => [
        [uchar8 => 'parm_size'],
 ];
 
+use constant LNOHEADER_T => [
+       [int => 'lnotype'],
+       [int => 'version'],
+       [int => 'numglobaldefs'],
+       [int => 'numglobals'],
+       [int => 'numfielddefs'],
+       [int => 'numstatements'],
+];
+
+use constant LNO_T => [
+       [int => 'v'],
+];
+
 sub get_section($$$)
 {
        my ($fh, $start, $len) = @_;
        seek $fh, $start, 0
                or die "seek: $!";
        $len == read $fh, my $buf, $len
-               or die "short read";
+               or die "short read from $start length $len (malformed progs header)";
        return $buf;
 }
 
@@ -214,7 +238,7 @@ sub parse_section($$$$$)
        my @out = map
        {
                $itemlen == read $fh, my $buf, $itemlen
-                       or die "short read";
+                       or die "short read from $start length $cnt * $itemlen $(malformed progs header)";
                my %h = ();
                @h{@packnames} = unpack $packspec, $buf;
                $h{$_->[1]} = TYPES->{$_->[0]}->[2]->($h{$_->[1]})
@@ -353,12 +377,34 @@ sub str($)
        return "\"$str\"";
 }
 
+sub debugpos($$$) {
+       my ($progs, $func, $ip) = @_;
+       my $s = $func->{debugname};
+       if ($progs->{cno}) {
+               my $column = $progs->{cno}[$ip]{v};
+               $s =~ s/:/:$column:/;
+       }
+       if ($progs->{lno}) {
+               my $line = $progs->{lno}[$ip]{v};
+               $s =~ s/:/:$line:/;
+       }
+       return $s;
+}
+
 sub disassemble_function($$;$)
 {
        my ($progs, $func, $highlight) = @_;
 
        print "$func->{debugname}:\n";
 
+       if($func->{first_statement} < 0) # builtin
+       {
+               printf INSTRUCTION_FORMAT, '', '', '.BUILTIN';
+               printf OPERAND_FORMAT, -$func->{first_statement};
+               print INSTRUCTION_SEPARATOR;
+               return;
+       }
+
        my $initializer = sub
        {
                my ($ofs) = @_;
@@ -488,11 +534,12 @@ sub disassemble_function($$;$)
                {
                        for(values %{$highlight->{$ip}})
                        {
-                               for(@$_)
+                               for(sort keys %$_)
                                {
                                        print PRE_MARK_STATEMENT;
                                        printf INSTRUCTION_FORMAT, '', '<!>', '.WARN';
-                                       printf OPERAND_FORMAT, "$_ (in $func->{debugname})";
+                                       my $pos = debugpos $progs, $func, $ip;
+                                       printf OPERAND_FORMAT, "$_ (in $pos)";
                                        print INSTRUCTION_SEPARATOR;
                                }
                        }
@@ -529,7 +576,6 @@ sub find_uninitialized_locals($$)
 {
        my ($progs, $func) = @_;
 
-
        return
                if $func->{first_statement} < 0; # builtin
 
@@ -661,6 +707,10 @@ sub find_uninitialized_locals($$)
                                }
                        }
 
+                       if($c->{isinvalid})
+                       {
+                               ++$warned{$ip}{''}{"Invalid opcode"};
+                       }
                        for(qw(a b c))
                        {
                                my $type = $c->{$_};
@@ -682,7 +732,7 @@ sub find_uninitialized_locals($$)
                                                # COMPILER BUG of FTEQCC: AND and OR may take uninitialized as second argument (logicops)
                                                if($return_hack <= 2 and ($op ne 'OR' && $op ne 'AND' || $_ ne 'b'))
                                                {
-                                                       push @{$warned{$ip}{$_}}, "Use of uninitialized value";
+                                                       ++$warned{$ip}{$_}{"Use of uninitialized value"};
                                                }
                                        }
                                        elsif($valid->[0] < 0)
@@ -690,7 +740,7 @@ sub find_uninitialized_locals($$)
                                                # COMPILER BUG of FTEQCC: AND and OR may take uninitialized as second argument (logicops)
                                                if($return_hack <= 2 and ($op ne 'OR' && $op ne 'AND' || $_ ne 'b'))
                                                {
-                                                       push @{$warned{$ip}{$_}}, "Use of temporary across CALL";
+                                                       ++$warned{$ip}{$_}{"Use of temporary across CALL"};
                                                }
                                        }
                                        else
@@ -729,6 +779,13 @@ sub find_uninitialized_locals($$)
                                        $write->($ofs+1);
                                        $write->($ofs+2);
                                }
+                               elsif($type eq 'ipoffset')
+                               {
+                                       ++$warned{$ip}{$_}{"Endless loop"}
+                                               if $ofs == 0;
+                                       ++$warned{$ip}{$_}{"No-operation jump"}
+                                               if $ofs == 1;
+                               }
                        }
                        if($c->{iscall})
                        {
@@ -817,7 +874,7 @@ sub find_uninitialized_locals($$)
 
                        if(!$isread)
                        {
-                               push @{$warned{$ip}{$operand}}, "Value is never used";
+                               ++$warned{$ip}{$operand}{"Value is never used"};
                        }
                }
        }
@@ -878,7 +935,8 @@ sub detect_constants($)
        use constant GLOBALFLAG_Q => 32; # unique to function
        use constant GLOBALFLAG_U => 64; # unused
        use constant GLOBALFLAG_P => 128; # possibly parameter passing
-       my @globalflags = (GLOBALFLAG_Q | GLOBALFLAG_U) x @{$progs->{globals}};
+       use constant GLOBALFLAG_D => 256; # has a def
+       my @globalflags = (GLOBALFLAG_Q | GLOBALFLAG_U) x (@{$progs->{globals}} + 2);
 
        for(@{$progs->{functions}})
        {
@@ -897,6 +955,8 @@ sub detect_constants($)
                        for keys %{$_->{globals_read}};
                $globalflags[$_] |= GLOBALFLAG_W
                        for keys %{$_->{globals_written}};
+               next
+                       if $_->{first_statement} < 0;
                for my $ip($_->{first_statement} .. (@{$progs->{statements}}-1))
                {
                        my $s = $progs->{statements}[$ip];
@@ -955,22 +1015,45 @@ sub detect_constants($)
                my $type = $_->{type};
                my $name = $progs->{getstring}->($_->{s_name});
                $name = ''
-                       if $name eq 'IMMEDIATE';
+                       if $name eq 'IMMEDIATE' or $name =~ /^\./;
+               $_->{debugname} = $name
+                       if $name ne '';
+               $globalflags[$_->{ofs}] |= GLOBALFLAG_D;
                if($type->{save})
                {
-                       for my $i(0..(typesize($_->{type}{type})-1))
-                       {
-                               $globalflags[$_->{ofs}] |= GLOBALFLAG_S;
-                       }
+                       $globalflags[$_->{ofs}] |= GLOBALFLAG_S;
                }
-               if($name ne "")
+               if(defined $_->{debugname})
                {
-                       for my $i(0..(typesize($_->{type}{type})-1))
+                       $globalflags[$_->{ofs}] |= GLOBALFLAG_N;
+               }
+       }
+       # fix up vectors
+       my @extradefs = ();
+       for(@{$progs->{globaldefs}})
+       {
+               my $type = $_->{type};
+               for my $i(1..(typesize($type->{type})-1))
+               {
+                       # add missing def
+                       if(!($globalflags[$_->{ofs}+$i] & GLOBALFLAG_D))
                        {
-                               $globalflags[$_->{ofs}] |= GLOBALFLAG_N;
+                               print "Missing globaldef for a component@{[defined $_->{debugname} ? ' of ' . $_->{debugname} : '']} at $_->{ofs}+$i\n";
+                               push @extradefs, {
+                                       type => {
+                                               saved => 0,
+                                               type => 'float'
+                                       },
+                                       ofs => $_->{ofs} + $i,
+                                       debugname => defined $_->{debugname} ? $_->{debugname} . "[$i]" : undef
+                               };
                        }
+                       # "saved" and "named" states hit adjacent globals too
+                       $globalflags[$_->{ofs}+$i] |= $globalflags[$_->{ofs}] & (GLOBALFLAG_S | GLOBALFLAG_N | GLOBALFLAG_D);
                }
        }
+       push @{$progs->{globaldefs}}, @extradefs;
+
        my %offsets_initialized = ();
        for(0..(@{$progs->{globals}}-1))
        {
@@ -1048,15 +1131,7 @@ sub detect_constants($)
        $progs->{temps} = \%istemp;
 
        # globaldefs
-       my @globaldefs = (undef) x @{$progs->{globaldefs}};
-       for(@{$progs->{globaldefs}})
-       {
-               my $s = $progs->{getstring}->($_->{s_name});
-               $s = ''
-                       if $s eq 'IMMEDIATE';
-               $_->{debugname} //= "\$" . "$s"
-                       if length $s;
-       }
+       my @globaldefs = (undef) x @{$progs->{globals}};
        for(@{$progs->{globaldefs}})
        {
                $globaldefs[$_->{ofs}] //= $_
@@ -1071,7 +1146,8 @@ sub detect_constants($)
                $globaldefs[$_] //= {
                        ofs => $_,
                        s_name => undef,
-                       debugname => undef
+                       debugname => undef,
+                       type => undef
                };
        }
        for(0..(@{(DEFAULTGLOBALS)}-1))
@@ -1100,7 +1176,7 @@ sub detect_constants($)
        for(@globaldefs)
        {
                next
-                       if $globaldefs_namecount{$_->{debugname}} <= 1;
+                       if $globaldefs_namecount{$_->{debugname}} <= 1 && !$ENV{FORCE_OFFSETS};
                #print "Not unique: $_->{debugname} at $_->{ofs}\n";
                $_->{debugname} .= "\@$_->{ofs}";
        }
@@ -1112,15 +1188,40 @@ sub detect_constants($)
        };
 }
 
-sub parse_progs($)
+sub parse_progs($$)
 {
-       my ($fh) = @_;
+       my ($fh, $lnofh) = @_;
 
        my %p = ();
 
        print STDERR "Parsing header...\n";
        $p{header} = parse_section $fh, DPROGRAMS_T, 0, undef, 1;
        
+       if (defined $lnofh) {
+               print STDERR "Parsing LNO...\n";
+               my $lnoheader = parse_section $lnofh, LNOHEADER_T, 0, undef, 1;
+               eval {
+                       die "Not a LNOF"
+                               if $lnoheader->{lnotype} != unpack 'V', 'LNOF';
+                       die "Not version 1"
+                               if $lnoheader->{version} != 1;
+                       die "Not same count of globaldefs"
+                               if $lnoheader->{numglobaldefs} != $p{header}{numglobaldefs};
+                       die "Not same count of globals"
+                               if $lnoheader->{numglobals} != $p{header}{numglobals};
+                       die "Not same count of fielddefs"
+                               if $lnoheader->{numfielddefs} != $p{header}{numfielddefs};
+                       die "Not same count of statements"
+                               if $lnoheader->{numstatements} != $p{header}{numstatements};
+                       $p{lno} = [parse_section $lnofh, LNO_T, 24, undef, $lnoheader->{numstatements}];
+                       eval {
+                               $p{lno} = [parse_section $lnofh, LNO_T, 24, undef, $lnoheader->{numstatements} * 2];
+                               $p{cno} = [splice $p{lno}, $lnoheader->{numstatements}];
+                               print STDERR "Cool, this LNO even has column number info!\n";
+                       };
+               } or warn "Skipping LNO: $@";
+       }
+
        print STDERR "Parsing strings...\n";
        $p{strings} = get_section $fh, $p{header}{ofs_strings}, $p{header}{numstrings};
        $p{getstring} = sub
@@ -1130,12 +1231,81 @@ sub parse_progs($)
                return substr $p{strings}, $startpos, $endpos - $startpos;
        };
 
+       print STDERR "Parsing globals...\n";
+       $p{globals} = [parse_section $fh, DGLOBAL_T, $p{header}{ofs_globals}, undef, $p{header}{numglobals}];
+
+       print STDERR "Parsing globaldefs...\n";
+       $p{globaldefs} = [parse_section $fh, DDEF_T, $p{header}{ofs_globaldefs}, undef, $p{header}{numglobaldefs}];
+
+       print STDERR "Range checking globaldefs...\n";
+       for(0 .. (@{$p{globaldefs}}-1))
+       {
+               my $g = $p{globaldefs}[$_];
+               die "Out of range name in globaldef $_"
+                       if $g->{s_name} < 0 || $g->{s_name} >= length $p{strings};
+               my $name = $p{getstring}->($g->{s_name});
+               die "Out of range ofs $g->{ofs} in globaldef $_ (name: \"$name\")"
+                       if $g->{ofs} >= $p{globals};
+       }
+
+       print STDERR "Parsing fielddefs...\n";
+       $p{fielddefs} = [parse_section $fh, DDEF_T, $p{header}{ofs_fielddefs}, undef, $p{header}{numfielddefs}];
+
+       print STDERR "Range checking fielddefs...\n";
+       for(0 .. (@{$p{fielddefs}}-1))
+       {
+               my $g = $p{fielddefs}[$_];
+               die "Out of range name in fielddef $_"
+                       if $g->{s_name} < 0 || $g->{s_name} >= length $p{strings};
+               my $name = $p{getstring}->($g->{s_name});
+               die "Out of range ofs $g->{ofs} in fielddef $_ (name: \"$name\")"
+                       if $g->{ofs} >= $p{header}{entityfields};
+       }
+
        print STDERR "Parsing statements...\n";
        $p{statements} = [parse_section $fh, DSTATEMENT_T, $p{header}{ofs_statements}, undef, $p{header}{numstatements}];
 
-       print STDERR "Fixing statements...\n";
-       for my $s(@{$p{statements}})
+       print STDERR "Parsing functions...\n";
+       $p{functions} = [parse_section $fh, DFUNCTION_T, $p{header}{ofs_functions}, undef, $p{header}{numfunctions}];
+
+       print STDERR "Range checking functions...\n";
+       for(0 .. (@{$p{functions}} - 1))
        {
+               my $f = $p{functions}[$_];
+               die "Out of range name in function $_"
+                       if $f->{s_name} < 0 || $f->{s_name} >= length $p{strings};
+               my $name = $p{getstring}->($f->{s_name});
+               die "Out of range file in function $_"
+                       if $f->{s_file} < 0 || $f->{s_file} >= length $p{strings};
+               my $file = $p{getstring}->($f->{s_file});
+               die "Out of range first_statement in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
+                       if $f->{first_statement} >= @{$p{statements}};
+               if($f->{first_statement} >= 0)
+               {
+                       die "Out of range parm_start in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
+                               if $f->{parm_start} < 0 || $f->{parm_start} >= @{$p{globals}};
+                       die "Out of range locals in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
+                               if $f->{locals} < 0 || $f->{parm_start} + $f->{locals} > @{$p{globals}};
+                       die "Out of range numparms $f->{numparms} in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
+                               if $f->{numparms} < 0 || $f->{numparms} > 8;
+                       my $totalparms = 0;
+                       for(0..($f->{numparms}-1))
+                       {
+                               die "Out of range parm_size[$_] in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
+                                       unless { 0 => 1, 1 => 1, 3 => 1 }->{$f->{parm_size}[$_]};
+                               $totalparms += $f->{parm_size}[$_];
+                       }
+                       die "Out of range parms in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
+                               if $f->{parm_start} + $totalparms > @{$p{globals}};
+                       die "More parms than locals in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
+                               if $totalparms > $f->{locals};
+               }
+       }
+
+       print STDERR "Range checking statements...\n";
+       for my $ip(0 .. (@{$p{statements}}-1))
+       {
+               my $s = $p{statements}[$ip];
                my $c = checkop $s->{op};
 
                for(qw(a b c))
@@ -1147,34 +1317,45 @@ sub parse_progs($)
                        if($type eq 'inglobal' || $type eq 'inglobalfunc')
                        {
                                $s->{$_} &= 0xFFFF;
+                               die "Out of range global offset in statement $ip - cannot continue"
+                                       if $s->{$_} >= @{$p{globals}};
                        }
                        elsif($type eq 'inglobalvec')
                        {
                                $s->{$_} &= 0xFFFF;
+                               if($c->{isreturn})
+                               {
+                                       die "Out of range global offset in statement $ip - cannot continue"
+                                               if $s->{$_} >= @{$p{globals}};
+                                       print "Potentially out of range global offset in statement $ip - may crash engines"
+                                               if $s->{$_} >= @{$p{globals}}-2;
+                               }
+                               else
+                               {
+                                       die "Out of range global offset in statement $ip - cannot continue"
+                                               if $s->{$_} >= @{$p{globals}}-2;
+                               }
                        }
                        elsif($type eq 'outglobal')
                        {
                                $s->{$_} &= 0xFFFF;
+                               die "Out of range global offset in statement $ip - cannot continue"
+                                       if $s->{$_} >= @{$p{globals}};
                        }
                        elsif($type eq 'outglobalvec')
                        {
                                $s->{$_} &= 0xFFFF;
+                               die "Out of range global offset in statement $ip - cannot continue"
+                                       if $s->{$_} >= @{$p{globals}}-2;
+                       }
+                       elsif($type eq 'ipoffset')
+                       {
+                               die "Out of range GOTO/IF/IFNOT in statement $ip - cannot continue"
+                                       if $ip + $s->{$_} < 0 || $ip + $s->{$_} >= @{$p{statements}};
                        }
                }
        }
 
-       print STDERR "Parsing globaldefs...\n";
-       $p{globaldefs} = [parse_section $fh, DDEF_T, $p{header}{ofs_globaldefs}, undef, $p{header}{numglobaldefs}];
-
-       print STDERR "Parsing fielddefs...\n";
-       $p{fielddefs} = [parse_section $fh, DDEF_T, $p{header}{ofs_fielddefs}, undef, $p{header}{numfielddefs}];
-
-       print STDERR "Parsing globals...\n";
-       $p{globals} = [parse_section $fh, DGLOBAL_T, $p{header}{ofs_globals}, undef, $p{header}{numglobals}];
-
-       print STDERR "Parsing functions...\n";
-       $p{functions} = [parse_section $fh, DFUNCTION_T, $p{header}{ofs_functions}, undef, $p{header}{numfunctions}];
-
        print STDERR "Looking for error()...\n";
        $p{error_func} = {};
        for(@{$p{globaldefs}})
@@ -1210,62 +1391,65 @@ sub parse_progs($)
                my %globals_written = ();
                my %globals_used = ();
 
-               run_nfa \%p, $_->{first_statement}, "", id, nfa_default_state_checker,
-                       sub
-                       {
-                               my ($ip, $state, $s, $c) = @_;
-                               ++$statements{$ip};
-
-                               if(my $j = $c->{isjump})
-                               {
-                                       my $t = $ip + $s->{$j};
-                                       $come_from{$t}{$ip} = $c->{isconditional};
-                                       $go_to{$ip}{$t} = $c->{isconditional};
-                               }
-
-                               for my $o(qw(a b c))
+               if($_->{first_statement} >= 0)
+               {
+                       run_nfa \%p, $_->{first_statement}, "", id, nfa_default_state_checker,
+                               sub
                                {
-                                       my $type = $c->{$o}
-                                               or next;
-                                       my $ofs = $s->{$o};
-
-                                       my $read = sub
-                                       {
-                                               my ($ofs) = @_;
-                                               $globals_read{$ofs}{$ip}{$o} = 1;
-                                               $globals_used{$ofs} = 1;
-                                       };
-                                       my $write = sub
-                                       {
-                                               my ($ofs) = @_;
-                                               $globals_written{$ofs}{$ip}{$o} = 1;
-                                               $globals_used{$ofs} = 1;
-                                       };
+                                       my ($ip, $state, $s, $c) = @_;
+                                       ++$statements{$ip};
 
-                                       if($type eq 'inglobal' || $type eq 'inglobalfunc')
-                                       {
-                                               $read->($ofs);
-                                       }
-                                       elsif($type eq 'inglobalvec')
+                                       if(my $j = $c->{isjump})
                                        {
-                                               $read->($ofs);
-                                               $read->($ofs+1);
-                                               $read->($ofs+2);
+                                               my $t = $ip + $s->{$j};
+                                               $come_from{$t}{$ip} = $c->{isconditional};
+                                               $go_to{$ip}{$t} = $c->{isconditional};
                                        }
-                                       elsif($type eq 'outglobal')
-                                       {
-                                               $write->($ofs);
-                                       }
-                                       elsif($type eq 'outglobalvec')
+
+                                       for my $o(qw(a b c))
                                        {
-                                               $write->($ofs);
-                                               $write->($ofs+1);
-                                               $write->($ofs+2);
+                                               my $type = $c->{$o}
+                                                       or next;
+                                               my $ofs = $s->{$o};
+
+                                               my $read = sub
+                                               {
+                                                       my ($ofs) = @_;
+                                                       $globals_read{$ofs}{$ip}{$o} = 1;
+                                                       $globals_used{$ofs} = 1;
+                                               };
+                                               my $write = sub
+                                               {
+                                                       my ($ofs) = @_;
+                                                       $globals_written{$ofs}{$ip}{$o} = 1;
+                                                       $globals_used{$ofs} = 1;
+                                               };
+
+                                               if($type eq 'inglobal' || $type eq 'inglobalfunc')
+                                               {
+                                                       $read->($ofs);
+                                               }
+                                               elsif($type eq 'inglobalvec')
+                                               {
+                                                       $read->($ofs);
+                                                       $read->($ofs+1);
+                                                       $read->($ofs+2);
+                                               }
+                                               elsif($type eq 'outglobal')
+                                               {
+                                                       $write->($ofs);
+                                               }
+                                               elsif($type eq 'outglobalvec')
+                                               {
+                                                       $write->($ofs);
+                                                       $write->($ofs+1);
+                                                       $write->($ofs+2);
+                                               }
                                        }
-                               }
 
-                               return 0;
-                       };
+                                       return 0;
+                               };
+               }
 
                $_->{statements} = \%statements;
                $_->{come_from} = \%come_from;
@@ -1280,14 +1464,34 @@ sub parse_progs($)
        print STDERR "Detecting constants and temps, and naming...\n";
        detect_constants \%p;
 
+       if($ENV{DUMP})
+       {
+               use Data::Dumper;
+               print Dumper \%p;
+               return;
+       }
+
        # what do we want to do?
        my $checkfunc = \&find_uninitialized_locals;
-       #my $checkfunc = \&disassemble_function;
+       if($ENV{DISASSEMBLE})
+       {
+               $checkfunc = \&disassemble_function;
+       }
        for(sort { $a->{debugname} cmp $b->{debugname} } @{$p{functions}})
        {
                $checkfunc->(\%p, $_);
        }
 }
 
-open my $fh, '<', $ARGV[0];
-parse_progs $fh;
+for my $progs (@ARGV) {
+       my $lno = "$progs.lno";
+       $lno =~ s/\.dat\.lno$/.lno/;
+
+       open my $fh, '<', $progs
+               or die "$progs: $!";
+
+       open my $lnofh, '<', $lno
+               or warn "$lno: $!";
+
+       parse_progs $fh, $lnofh;
+}