X-Git-Url: https://git.xonotic.org/?p=xonotic%2Fxonotic.git;a=blobdiff_plain;f=misc%2Ftools%2Fprogs-analyzer.pl;h=5701c3a8bf945b977bee6b18630b6393abc8166f;hp=6ba7de89c4d8ba6d912059d51f34728ea3c317a4;hb=4cd99969a936844c374f169f590a9d3b1f2d89b7;hpb=1f5d74bfbf3e6e79e72d81fdd3d2dd39caef6398

diff --git a/misc/tools/progs-analyzer.pl b/misc/tools/progs-analyzer.pl
old mode 100644
new mode 100755
index 6ba7de89..5701c3a8
--- a/misc/tools/progs-analyzer.pl
+++ b/misc/tools/progs-analyzer.pl
@@ -1,3 +1,5 @@
+#!/usr/bin/perl
+
 use strict;
 use warnings;
 use Digest::SHA;
@@ -125,6 +127,10 @@ sub checkop($)
 	{
 		return { a => 'inglobal', b => 'inglobalfunc' };
 	}
+	if($op =~ /^INVALID#/)
+	{
+		return { isinvalid => 1 };
+	}
 	return { a => 'inglobal', b => 'inglobal', c => 'outglobal' };
 }
 
@@ -185,6 +191,19 @@ 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) = @_;
@@ -277,9 +296,8 @@ sub run_nfa($$$$$$)
 			elsif($c->{iscall})
 			{
 				my $func = $s->{a};
-				my $funcid = $progs->{globals}[$func]{v}{int};
 				last
-					if $progs->{error_func}{$funcid};
+					if $progs->{builtins}{error}{$func};
 				$ip += 1;
 			}
 			elsif($c->{isjump})
@@ -317,28 +335,32 @@ sub run_nfa($$$$$$)
 	$nfa->($ip, $copy_handler->($state));
 }
 
-sub get_constant($$)
+sub get_constant($$$)
 {
-	my ($progs, $g) = @_;
-	if($g->{int} == 0)
-	{
-		return 0;
-	}
-	elsif($g->{int} > 0 && $g->{int} < 8388608)
-	{
-		if($g->{int} < length $progs->{strings} && $g->{int} > 0)
-		{
-			return str($progs->{getstring}->($g->{int}));
-		}
-		else
-		{
-			return $g->{int} . "i";
-		}
-	}
-	else
-	{
-		return $g->{float};
+	my ($progs, $g, $type) = @_;
+
+	if (!defined $type) {
+		$type = 'float';
+		$type = 'int'
+			if $g->{int} > 0 && $g->{int} < 8388608;
+		$type = 'string'
+			if $g->{int} > 0 && $g->{int} < length $progs->{strings};
 	}
+
+	return str($progs->{getstring}->($g->{int}))
+		if $type eq 'string';
+	return $g->{float}
+		if $type eq 'float';
+	return "'$g->{float} _ _'"
+		if $type eq 'vector';
+	return "entity $g->{int}"
+		if $type eq 'entity';
+	return ".$progs->{entityfieldnames}[$g->{int}][0]"
+		if $type eq 'field' and defined $progs->{entityfieldnames}[$g->{int}][0];
+	return "$g->{int}i"
+		if $type eq 'int';
+
+	return "$type($g->{int})";
 }
 
 use constant PRE_MARK_STATEMENT => "";
@@ -358,6 +380,20 @@ 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) = @_;
@@ -375,7 +411,8 @@ sub disassemble_function($$;$)
 	my $initializer = sub
 	{
 		my ($ofs) = @_;
-		my $g = get_constant($progs, $progs->{globals}[$ofs]{v});
+		# TODO: Can we know its type?
+		my $g = get_constant($progs, $progs->{globals}[$ofs]{v}, undef);
 		print " = $g"
 			if defined $g;
 	};
@@ -501,11 +538,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;
 				}
 			}
@@ -673,6 +711,10 @@ sub find_uninitialized_locals($$)
 				}
 			}
 
+			if($c->{isinvalid})
+			{
+				++$warned{$ip}{''}{"Invalid opcode"};
+			}
 			for(qw(a b c))
 			{
 				my $type = $c->{$_};
@@ -694,7 +736,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)
@@ -702,7 +744,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
@@ -741,6 +783,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})
 			{
@@ -829,11 +878,63 @@ sub find_uninitialized_locals($$)
 
 			if(!$isread)
 			{
-				push @{$warned{$ip}{$operand}}, "Value is never used";
+				++$warned{$ip}{$operand}{"Value is never used"};
 			}
 		}
 	}
-	
+
+	my %solid_seen = ();
+	run_nfa $progs, $func->{first_statement}, do { my $state = -1; \$state; },
+		sub
+		{
+			my $state = ${$_[0]};
+			return \$state;
+		},
+		sub
+		{
+			my ($ip, $state) = @_;
+			return $solid_seen{"$ip $$state"}++;
+		},
+		sub
+		{
+			my ($ip, $state, $s, $c) = @_;
+
+			if($s->{op} eq 'ADDRESS')
+			{
+				my $field_ptr_ofs = $s->{b};
+				my $def = $progs->{globaldef_byoffset}->($field_ptr_ofs);
+				use Data::Dumper;
+				if (($def->{globaltype} eq 'read_only' || $def->{globaltype} eq 'const') &&
+						grep { $_ eq 'solid' } @{$progs->{entityfieldnames}[$progs->{globals}[$field_ptr_ofs]{v}{int}]})
+				{
+					# Taking address of 'solid' for subsequent write!
+					# TODO check if this address is then actually used in STOREP.
+					$$state = $ip;
+				}
+			}
+
+			if($c->{iscall})
+			{
+				# TODO check if the entity passed is actually the one on which solid was set.
+				my $func = $s->{a};
+				if ($progs->{builtins}{setmodel}{$func} || $progs->{builtins}{setorigin}{$func} || $progs->{builtins}{setsize}{$func})
+				{
+					# All is clean.
+					$$state = -1;
+				}
+			}
+
+			if($c->{isreturn})
+			{
+				if ($$state >= 0) {
+					++$warned{$$state}{''}{"Changing .solid without setmodel/setorigin/setsize breaks area grid linking in Quake [write is here]"};
+					++$warned{$ip}{''}{"Changing .solid without setmodel/setorigin/setsize breaks area grid linking in Quake [return is here]"};
+				}
+			}
+
+			return 0;
+		};
+
 	disassemble_function($progs, $func, \%warned)
 		if keys %warned;
 }
@@ -890,7 +991,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}})
 	{
@@ -969,24 +1071,45 @@ sub detect_constants($)
 		my $type = $_->{type};
 		my $name = $progs->{getstring}->($_->{s_name});
 		$name = ''
-			if $name eq 'IMMEDIATE' or $name =~ /^\./;
+			if $name eq 'IMMEDIATE'; # for fteqcc I had: 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(defined $_->{debugname})
+		{
+			$globalflags[$_->{ofs}] |= GLOBALFLAG_N;
 		}
-		if($name ne '')
+	}
+	# fix up vectors
+	my @extradefs = ();
+	for(@{$progs->{globaldefs}})
+	{
+		my $type = $_->{type};
+		for my $i(1..(typesize($type->{type})-1))
 		{
-			for my $i(0..(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))
 	{
@@ -1079,7 +1202,8 @@ sub detect_constants($)
 		$globaldefs[$_] //= {
 			ofs => $_,
 			s_name => undef,
-			debugname => undef
+			debugname => undef,
+			type => undef
 		};
 	}
 	for(0..(@{(DEFAULTGLOBALS)}-1))
@@ -1097,7 +1221,7 @@ sub detect_constants($)
 		}
 		elsif($_->{globaltype} eq 'const')
 		{
-			$_->{debugname} = get_constant($progs, $progs->{globals}[$_->{ofs}]{v});
+			$_->{debugname} = get_constant($progs, $progs->{globals}[$_->{ofs}]{v}, $_->{type}{type});
 		}
 		else
 		{
@@ -1120,15 +1244,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
@@ -1151,7 +1300,7 @@ sub parse_progs($)
 		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 in globaldef $_ (name: \"$name\")"
+		die "Out of range ofs $g->{ofs} in globaldef $_ (name: \"$name\")"
 			if $g->{ofs} >= $p{globals};
 	}
 
@@ -1165,8 +1314,9 @@ sub parse_progs($)
 		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 in globaldef $_ (name: \"$name\")"
+		die "Out of range ofs $g->{ofs} in fielddef $_ (name: \"$name\")"
 			if $g->{ofs} >= $p{header}{entityfields};
+		push @{$p{entityfieldnames}[$g->{ofs}]}, $name;
 	}
 
 	print STDERR "Parsing statements...\n";
@@ -1185,23 +1335,28 @@ sub parse_progs($)
 		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\")"
+		die "Out of range first_statement in function $_ (name: \"$name\", file: \"$file\", first statement: $f->{first_statement})"
 			if $f->{first_statement} >= @{$p{statements}};
-		die "Out of range parm_start in function $_ (name: \"$name\", file: \"$file\")"
-			if $f->{parm_start} < 0 || $f->{parm_start} >= @{$p{globals}};
-		die "Out of range locals in function $_ (name: \"$name\", file: \"$file\")"
-			if $f->{locals} < 0 || $f->{parm_start} + $f->{locals} >= @{$p{globals}};
-		die "Out of range numparms in function $_ (name: \"$name\", file: \"$file\")"
-			if $f->{numparms} < 0 || $f->{numparms} > 8;
-		my $totalparms = 0;
-		for(0..($f->{numparms}-1))
+		if($f->{first_statement} >= 0)
 		{
-			die "Out of range parm_size[$_] in function $_ (name: \"$name\", file: \"$file\")"
-				unless { 0 => 1, 1 => 1, 3 => 1 }->{$f->{parm_size}[$_]};
-			$totalparms += $f->{parm_size}[$_];
+			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};
 		}
-		die "Out of range parms in function $_ (name: \"$name\", file: \"$file\")"
-			if $f->{locals} < 0 || $f->{parm_start} + $totalparms >= @{$p{globals}};
 	}
 
 	print STDERR "Range checking statements...\n";
@@ -1225,8 +1380,18 @@ sub parse_progs($)
 			elsif($type eq 'inglobalvec')
 			{
 				$s->{$_} &= 0xFFFF;
-				die "Out of range global offset in statement $ip - cannot continue"
-					if $s->{$_} >= @{$p{globals}}-2;
+				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')
 			{
@@ -1248,20 +1413,21 @@ sub parse_progs($)
 		}
 	}
 
-	print STDERR "Looking for error()...\n";
-	$p{error_func} = {};
+	print STDERR "Looking for error(), setmodel(), setorigin(), setsize()...\n";
+	$p{builtins} = { error => {}, setmodel => {}, setorigin => {}, setsize => {} };
 	for(@{$p{globaldefs}})
 	{
+		my $name = $p{getstring}($_->{s_name});
 		next
-			if $p{getstring}($_->{s_name}) ne 'error';
+			if not exists $p{builtins}{$name};
 		my $v = $p{globals}[$_->{ofs}]{v}{int};
 		next
 			if $v <= 0 || $v >= @{$p{functions}};
 		my $first = $p{functions}[$v]{first_statement};
 		next
 			if $first >= 0;
-		print STDERR "Detected error() at offset $_->{ofs} (builtin #@{[-$first]})\n";
-		$p{error_func}{$_->{ofs}} = 1;
+		print STDERR "Detected $name() at offset $_->{ofs} (builtin #@{[-$first]})\n";
+		$p{builtins}{$name}{$_->{ofs}} = 1;
 	}
 
 	print STDERR "Scanning functions...\n";
@@ -1375,5 +1541,15 @@ sub parse_progs($)
 	}
 }
 
-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;
+}