13 return sub { $_[0] >= (2**($bits-1)) ? $_[0]-(2**$bits) : $_[0]; };
16 use constant OPCODE_E => [qw[
18 MUL_F MUL_V MUL_FV MUL_VF
22 EQ_F EQ_V EQ_S EQ_E EQ_FNC
23 NE_F NE_V NE_S NE_E NE_FNC
25 LOAD_F LOAD_V LOAD_S LOAD_ENT LOAD_FLD LOAD_FNC
27 STORE_F STORE_V STORE_S STORE_ENT STORE_FLD STORE_FNC
28 STOREP_F STOREP_V STOREP_S STOREP_ENT STOREP_FLD STOREP_FNC
30 NOT_F NOT_V NOT_S NOT_ENT NOT_FNC
32 CALL0 CALL1 CALL2 CALL3 CALL4 CALL5 CALL6 CALL7 CALL8
38 use constant ETYPE_E => [qw[
48 use constant DEF_SAVEGLOBAL => 32768;
52 return 3 if $type eq 'vector';
61 return { a => 'inglobalvec', b => 'ipoffset', isjump => 'b', isconditional => 1 };
65 return { a => 'inglobal', b => 'ipoffset', isjump => 'b', isconditional => 1 };
69 return { a => 'ipoffset', isjump => 'a', isconditional => 0 };
71 if($op =~ /^ADD_V$|^SUB_V$/)
73 return { a => 'inglobalvec', b => 'inglobalvec', c => 'outglobalvec' };
75 if($op =~ /^MUL_V$|^EQ_V$|^NE_V$/)
77 return { a => 'inglobalvec', b => 'inglobalvec', c => 'outglobal' };
81 return { a => 'inglobal', b => 'inglobalvec', c => 'outglobalvec' };
85 return { a => 'inglobalvec', b => 'inglobal', c => 'outglobalvec' };
89 return { a => 'inglobal', b => 'inglobal', c => 'outglobalvec' };
93 return { a => 'inglobalvec', c => 'outglobal' };
97 return { a => 'inglobal', c => 'outglobal' };
101 return { a => 'inglobalvec', b => 'inglobal' };
105 return { a => 'inglobalvec', b => 'outglobalvec' };
107 if($op =~ /^STOREP_/)
109 return { a => 'inglobal', b => 'inglobal' };
113 return { a => 'inglobal', b => 'outglobal' };
117 return { a => 'inglobalfunc', iscall => 1 };
119 if($op =~ /^DONE$|^RETURN$/)
121 return { a => 'inglobal', isreturn => 1 };
123 return { a => 'inglobal', b => 'inglobal', c => 'outglobal' };
126 use constant TYPES => {
127 int => ['V', 4, signed 32],
128 ushort => ['v', 2, id],
129 short => ['v', 2, signed 16],
130 opcode => ['v', 2, sub { OPCODE_E->[$_[0]] or die "Invalid opcode: $_[0]"; }],
131 float => ['f', 4, id],
132 uchar8 => ['a8', 8, sub { [unpack 'C8', $_[0]] }],
133 global => ['i', 4, sub { { int => $_[0], float => unpack "f", pack "L", $_[0] }; }],
134 deftype => ['v', 2, sub { { type => ETYPE_E->[$_[0] & ~DEF_SAVEGLOBAL], save => !!($_[0] & DEF_SAVEGLOBAL) }; }],
137 use constant DPROGRAMS_T => [
140 [int => 'ofs_statements'],
141 [int => 'numstatements'],
142 [int => 'ofs_globaldefs'],
143 [int => 'numglobaldefs'],
144 [int => 'ofs_fielddefs'],
145 [int => 'numfielddefs'],
146 [int => 'ofs_functions'],
147 [int => 'numfunctions'],
148 [int => 'ofs_strings'],
149 [int => 'numstrings'],
150 [int => 'ofs_globals'],
151 [int => 'numglobals'],
152 [int => 'entityfields']
155 use constant DSTATEMENT_T => [
162 use constant DDEF_T => [
168 use constant DGLOBAL_T => [
172 use constant DFUNCTION_T => [
173 [int => 'first_statement'],
174 [int => 'parm_start'],
180 [uchar8 => 'parm_size'],
185 my ($fh, $start, $len) = @_;
188 $len == read $fh, my $buf, $len
193 sub parse_section($$$$$)
195 my ($fh, $struct, $start, $len, $cnt) = @_;
198 $itemlen += TYPES->{$_->[0]}->[1]
200 my $packspec = join '', map { TYPES->{$_->[0]}->[0]; } @$struct;
201 my @packnames = map { $_->[1]; } @$struct;
203 $len = $cnt * $itemlen
204 if not defined $len and defined $cnt;
205 $cnt = int($len / $itemlen)
206 if not defined $cnt and defined $len;
207 die "Invalid length specification"
208 unless defined $len and defined $cnt and $len == $cnt * $itemlen;
209 die "Invalid length specification in scalar context"
210 unless wantarray or $cnt == 1;
216 $itemlen == read $fh, my $buf, $itemlen
219 @h{@packnames} = unpack $packspec, $buf;
220 $h{$_->[1]} = TYPES->{$_->[0]}->[2]->($h{$_->[1]})
230 sub nfa_default_state_checker()
235 my ($ip, $state) = @_;
236 return $seen{"$ip $state"}++;
242 my ($progs, $ip, $state, $copy_handler, $state_checker, $instruction_handler) = @_;
244 my $statements = $progs->{statements};
249 no warnings 'recursion';
251 my ($ip, $state) = @_;
256 if $state_checker->($ip, $state);
258 my $s = $statements->[$ip];
259 my $c = checkop $s->{op};
261 if($instruction_handler->($ip, $state, $s, $c))
273 if($c->{isconditional})
277 $nfa->($ip+$s->{$c->{isjump}}, $copy_handler->($state));
282 $nfa->($ip+1, $copy_handler->($state));
283 $ip += $s->{$c->{isjump}};
288 $ip += $s->{$c->{isjump}};
298 $nfa->($ip, $copy_handler->($state));
303 my ($progs, $g) = @_;
308 elsif($g->{int} > 0 && $g->{int} < 8388608)
310 if($g->{int} < length $progs->{strings} && $g->{int} > 0)
312 return str($progs->{getstring}->($g->{int}));
316 return $g->{int} . "i";
325 use constant PRE_MARK_STATEMENT => "";
326 use constant POST_MARK_STATEMENT => "";
327 use constant PRE_MARK_OPERAND => "*** ";
328 use constant POST_MARK_OPERAND => " ***";
330 use constant INSTRUCTION_FORMAT => "%8s %3s | %-12s ";
331 use constant OPERAND_FORMAT => "%s";
332 use constant OPERAND_SEPARATOR => ", ";
333 use constant INSTRUCTION_SEPARATOR => "\n";
338 $str =~ s/[\000-\037\\\"\177-\377]/sprintf "\\%03o", ord $&/ge;
342 sub disassemble_function($$;$)
344 my ($progs, $func, $highlight) = @_;
346 print "$func->{debugname}:\n";
348 my $initializer = sub
351 my $g = get_constant($progs, $progs->{globals}[$ofs]{v});
356 printf INSTRUCTION_FORMAT, '', '', '.PARM_START';
357 printf OPERAND_FORMAT, "$func->{parm_start}";
358 print INSTRUCTION_SEPARATOR;
360 printf INSTRUCTION_FORMAT, '', '', '.LOCALS';
361 printf OPERAND_FORMAT, "$func->{locals}";
362 print INSTRUCTION_SEPARATOR;
364 my %override_locals = ();
365 my $p = $func->{parm_start};
366 for(0..($func->{numparms}-1))
368 $override_locals{$p} //= "argv_$_";
369 for my $comp(0..($func->{parm_size}[$_]-1))
371 $override_locals{$p} //= "argv_$_\[$comp]";
374 printf INSTRUCTION_FORMAT, '', '', '.ARG';
375 printf OPERAND_FORMAT, "argv_$_";
376 print OPERAND_SEPARATOR;
377 printf OPERAND_FORMAT, $func->{parm_size}[$_];
378 print INSTRUCTION_SEPARATOR;
380 for($func->{parm_start}..($func->{parm_start} + $func->{locals} - 1))
383 if exists $override_locals{$_};
384 $override_locals{$_} = "local_$_";
386 printf INSTRUCTION_FORMAT, '', '', '.LOCAL';
387 printf OPERAND_FORMAT, "local_$_";
389 print INSTRUCTION_SEPARATOR;
395 return $override_locals{$ofs}
396 if exists $override_locals{$ofs};
397 my $def = $progs->{globaldef_byoffset}->($ofs);
398 return $def->{debugname};
403 my ($ip, $type, $operand) = @_;
404 if($type eq 'inglobal')
406 my $name = $getname->($operand);
407 printf OPERAND_FORMAT, "$name";
409 elsif($type eq 'outglobal')
411 my $name = $getname->($operand);
412 printf OPERAND_FORMAT, "&$name";
414 elsif($type eq 'inglobalvec')
416 my $name = $getname->($operand);
417 printf OPERAND_FORMAT, "$name\[\]";
419 elsif($type eq 'outglobalvec')
421 my $name = $getname->($operand);
422 printf OPERAND_FORMAT, "&$name\[\]";
424 elsif($type eq 'inglobalfunc')
426 my $name = $getname->($operand);
427 printf OPERAND_FORMAT, "$name()";
429 elsif($type eq 'ipoffset')
431 printf OPERAND_FORMAT, "@{[$ip + $operand]}" . sprintf ' ($%+d)', $operand;
435 die "unknown type: $type";
441 run_nfa $progs, $func->{first_statement}, "", id, nfa_default_state_checker,
444 my ($ip, $state, $s, $c) = @_;
447 if(my $j = $c->{isjump})
449 my $t = $ip + $s->{$j};
450 $come_from{$t}{$ip} = $c->{isconditional};
457 for my $ip(sort { $a <=> $b } keys %statements)
459 if($ip == $func->{first_statement})
461 printf INSTRUCTION_FORMAT, $ip, '', '.ENTRY';
462 print INSTRUCTION_SEPARATOR;
464 if(defined $ipprev && $ip != $ipprev + 1)
466 printf INSTRUCTION_FORMAT, $ip, '', '.SKIP';
467 printf OPERAND_FORMAT, $ip - $ipprev - 1;
468 print INSTRUCTION_SEPARATOR;
470 if(my $cf = $come_from{$ip})
472 printf INSTRUCTION_FORMAT, $ip, '', '.XREF';
474 for(sort { $a <=> $b } keys %$cf)
476 print OPERAND_SEPARATOR
478 printf OPERAND_FORMAT, ($cf->{$_} ? 'c' : 'j') . $_ . sprintf ' ($%+d)', $_ - $ip;
480 print INSTRUCTION_SEPARATOR;
483 my $op = $progs->{statements}[$ip]{op};
484 my $ipt = $progs->{statements}[$ip];
485 my $opprop = checkop $op;
487 print PRE_MARK_STATEMENT
488 if $highlight and $highlight->{$ip};
490 my $showip = $opprop->{isjump};
491 printf INSTRUCTION_FORMAT, $showip ? $ip : '', $highlight->{$ip} ? "<!>" : "", $op;
497 if not defined $opprop->{$o};
498 print OPERAND_SEPARATOR
500 print PRE_MARK_OPERAND
501 if $highlight and $highlight->{$ip} and $highlight->{$ip}{$o};
502 $operand->($ip, $opprop->{$o}, $ipt->{$o});
503 print POST_MARK_OPERAND
504 if $highlight and $highlight->{$ip} and $highlight->{$ip}{$o};
507 print POST_MARK_STATEMENT
508 if $highlight and $highlight->{$ip};
510 print INSTRUCTION_SEPARATOR;
514 sub find_uninitialized_locals($$)
516 my ($progs, $func) = @_;
519 if $func->{first_statement} < 0; # builtin
521 print STDERR "Checking $func->{debugname}...\n";
523 my $p = $func->{parm_start};
524 for(0..($func->{numparms}-1))
526 $p += $func->{parm_size}[$_];
529 use constant WATCHME_R => 1;
530 use constant WATCHME_W => 2;
531 use constant WATCHME_X => 4;
532 use constant WATCHME_T => 8;
533 my %watchme = map { $_ => WATCHME_X } ($func->{parm_start} .. ($func->{parm_start} + $func->{locals} - 1));
535 for(keys %{$progs->{temps}})
537 $watchme{$_} = WATCHME_T | WATCHME_X
538 if not exists $watchme{$_};
541 run_nfa $progs, $func->{first_statement}, "", id, nfa_default_state_checker,
544 my ($ip, $state, $s, $c) = @_;
549 unless defined $type;
552 if($type eq 'inglobal' || $type eq 'inglobalfunc')
554 $watchme{$ofs} |= WATCHME_R;
556 elsif($type eq 'inglobalvec')
558 $watchme{$ofs} |= WATCHME_R;
559 $watchme{$ofs+1} |= WATCHME_R;
560 $watchme{$ofs+2} |= WATCHME_R;
562 elsif($type eq 'outglobal')
564 $watchme{$ofs} |= WATCHME_W;
566 elsif($type eq 'outglobalvec')
568 $watchme{$ofs} |= WATCHME_W;
569 $watchme{$ofs+1} |= WATCHME_W;
570 $watchme{$ofs+2} |= WATCHME_W;
580 if ($watchme{$_} & (WATCHME_R | WATCHME_W | WATCHME_X)) != (WATCHME_R | WATCHME_W | WATCHME_X);
584 if not keys %watchme;
589 flags => $watchme{$_},
594 # mark parameters as initialized
595 for($func->{parm_start} .. ($p-1))
597 $watchme{$_}{valid} = 1
598 if defined $watchme{$_};
600 # an initial run of STORE instruction is for receiving extra parameters
601 # (beyond 8). Only possible if the function is declared as having 8 params.
602 # Extra parameters behave otherwise like temps, but are initialized at
604 for($func->{first_statement} .. (@{$progs->{statements}}-1))
606 my $s = $progs->{statements}[$_];
607 if($s->{op} eq 'STORE_V')
609 $watchme{$s->{a}}{valid} = 1
610 if defined $watchme{$s->{a}};
611 $watchme{$s->{a}+1}{valid} = 1
612 if defined $watchme{$s->{a}+1};
613 $watchme{$s->{a}+2}{valid} = 1
614 if defined $watchme{$s->{a}+2};
616 elsif($s->{op} =~ /^STORE_/)
618 $watchme{$s->{a}}{valid} = 1
619 if defined $watchme{$s->{a}};
629 run_nfa $progs, $func->{first_statement}, \%watchme,
632 return { map { $_ => { %{$h->{$_}} } } keys %$h };
635 my ($ip, $state) = @_;
636 my $s = $ip_seen{$ip};
639 # if $state is stronger or equal to $s, return 1
642 if($state->{$_}{valid} < $s->{$_})
644 # The current state is LESS valid than the previously run one. We NEED to run this.
645 # The saved state can safely become the intersection [citation needed].
648 $s->{$_} = $state->{$_}{valid}
649 if $state->{$_}{valid} < $s->{$_};
654 # if we get here, $state is stronger or equal. No need to try it.
659 # Never seen this IP yet.
660 $ip_seen{$ip} = { map { ($_ => $state->{$_}{valid}); } keys %$state };
665 my ($ip, $state, $s, $c) = @_;
671 unless defined $type;
679 if not exists $state->{$ofs};
680 my $valid = $state->{$ofs}{valid};
683 print "; Use of uninitialized value $ofs in $func->{debugname} at $ip.$_\n";
688 print "; Use of temporary $ofs across CALL in $func->{debugname} at $ip.$_\n";
695 $state->{$ofs}{valid} = 1
696 if exists $state->{$ofs};
699 if($type eq 'inglobal' || $type eq 'inglobalfunc')
701 if($op ne 'OR' && $op ne 'AND') # fteqcc logicops cause this
706 elsif($type eq 'inglobalvec')
708 if($op ne 'OR' && $op ne 'AND') # fteqcc logicops cause this
715 elsif($type eq 'outglobal')
719 elsif($type eq 'outglobalvec')
728 # builtin calls may clobber stuff
730 my $funcid = $progs->{globals}[$func]{v}{int};
731 my $funcobj = $progs->{functions}[$funcid];
732 if(!$funcobj || $funcobj->{first_statement} >= 0)
737 if($_->{flags} & WATCHME_T)
745 my $def = $progs->{globaldef_byoffset}->($func);
747 if $def->{debugname} eq '$error';
754 disassemble_function($progs, $func, \%warned)
758 use constant DEFAULTGLOBALS => [
792 if($ofs < @{(DEFAULTGLOBALS)})
794 return { ofs => $ofs, s_name => undef, debugname => DEFAULTGLOBALS->[$ofs], type => undef };
796 return { ofs => $ofs, s_name => undef, debugname => "<undefined>\@$ofs", type => undef };
805 print STDERR "Parsing header...\n";
806 $p{header} = parse_section $fh, DPROGRAMS_T, 0, undef, 1;
808 print STDERR "Parsing strings...\n";
809 $p{strings} = get_section $fh, $p{header}{ofs_strings}, $p{header}{numstrings};
813 my $endpos = index $p{strings}, "\0", $startpos;
814 return substr $p{strings}, $startpos, $endpos - $startpos;
817 print STDERR "Parsing statements...\n";
818 $p{statements} = [parse_section $fh, DSTATEMENT_T, $p{header}{ofs_statements}, undef, $p{header}{numstatements}];
820 print STDERR "Parsing globaldefs...\n";
821 $p{globaldefs} = [parse_section $fh, DDEF_T, $p{header}{ofs_globaldefs}, undef, $p{header}{numglobaldefs}];
823 print STDERR "Parsing fielddefs...\n";
824 $p{fielddefs} = [parse_section $fh, DDEF_T, $p{header}{ofs_fielddefs}, undef, $p{header}{numfielddefs}];
826 print STDERR "Parsing globals...\n";
827 $p{globals} = [parse_section $fh, DGLOBAL_T, $p{header}{ofs_globals}, undef, $p{header}{numglobals}];
829 print STDERR "Parsing functions...\n";
830 $p{functions} = [parse_section $fh, DFUNCTION_T, $p{header}{ofs_functions}, undef, $p{header}{numfunctions}];
832 print STDERR "Detecting constants and temps...\n";
833 use constant GLOBALFLAG_R => 1;
834 use constant GLOBALFLAG_W => 2;
835 use constant GLOBALFLAG_S => 4;
836 use constant GLOBALFLAG_I => 8;
837 use constant GLOBALFLAG_N => 16;
838 my @globalflags = (0) x @{$p{globals}};
839 for my $s(@{$p{statements}})
841 my $c = checkop $s->{op};
847 unless defined $type;
854 $globalflags[$ofs] |= GLOBALFLAG_R;
859 $globalflags[$ofs] |= GLOBALFLAG_W;
862 if($type eq 'inglobal' || $type eq 'inglobalfunc')
864 $s->{$_} = $ofs = ($ofs & 0xFFFF);
867 elsif($type eq 'inglobalvec')
869 $s->{$_} = $ofs = ($ofs & 0xFFFF);
874 elsif($type eq 'outglobal')
876 $s->{$_} = $ofs = ($ofs & 0xFFFF);
879 elsif($type eq 'outglobalvec')
881 $s->{$_} = $ofs = ($ofs & 0xFFFF);
890 my %offsets_saved = ();
891 for(@{$p{globaldefs}})
893 my $type = $_->{type};
894 my $name = $p{getstring}->($_->{s_name});
897 for my $i(0..(typesize($_->{type}{type})-1))
899 $globalflags[$_->{ofs}] |= GLOBALFLAG_S;
904 for my $i(0..(typesize($_->{type}{type})-1))
906 $globalflags[$_->{ofs}] |= GLOBALFLAG_N;
910 my %offsets_initialized = ();
911 for(0..(@{$p{globals}}-1))
913 if($p{globals}[$_]{v}{int})
915 $globalflags[$_] |= GLOBALFLAG_I;
919 my @globaltypes = (undef) x @{$p{globals}};
922 for(0..(@{$p{globals}}-1))
925 if $_ < @{(DEFAULTGLOBALS)};
926 if(($globalflags[$_] & (GLOBALFLAG_R | GLOBALFLAG_W)) == 0)
928 $globaltypes[$_] = "unused";
930 elsif(($globalflags[$_] & (GLOBALFLAG_R | GLOBALFLAG_W)) == GLOBALFLAG_R)
933 if(($globalflags[$_] & GLOBALFLAG_N) == GLOBALFLAG_N)
935 $globaltypes[$_] = "read_only";
937 elsif(($globalflags[$_] & GLOBALFLAG_S) == 0)
939 $globaltypes[$_] = "const";
943 $globaltypes[$_] = "read_only";
946 elsif(($globalflags[$_] & (GLOBALFLAG_R | GLOBALFLAG_W)) == GLOBALFLAG_W)
948 $globaltypes[$_] = "write_only";
952 # now we know it is rw
953 if(($globalflags[$_] & GLOBALFLAG_N) == GLOBALFLAG_N)
955 $globaltypes[$_] = "global";
957 elsif(($globalflags[$_] & (GLOBALFLAG_S | GLOBALFLAG_I)) == 0)
959 $globaltypes[$_] = "temp";
962 elsif(($globalflags[$_] & (GLOBALFLAG_S | GLOBALFLAG_I)) == GLOBALFLAG_I)
964 $globaltypes[$_] = "not_saved";
968 $globaltypes[$_] = "global";
972 $p{temps} = \%istemp;
974 print STDERR "Naming...\n";
976 my @globaldefs = (undef) x @{$p{globaldefs}};
977 for(@{$p{globaldefs}})
979 my $s = $p{getstring}->($_->{s_name});
980 $_->{debugname} //= "\$" . "$s"
983 for(@{$p{globaldefs}})
985 $globaldefs[$_->{ofs}] //= $_
986 if defined $_->{debugname};
988 for(@{$p{globaldefs}})
990 $globaldefs[$_->{ofs}] //= $_;
992 for(0..(@{$p{globals}}-1))
994 $globaldefs[$_] //= {
1000 my %globaldefs = ();
1001 for(0..(@{(DEFAULTGLOBALS)}-1))
1003 $globaldefs[$_] = { ofs => $_, s_name => undef, debugname => DEFAULTGLOBALS->[$_], type => undef };
1004 $globaltypes[$_] = 'defglobal';
1008 if(defined $_->{debugname})
1010 # already has debugname
1012 elsif($globaltypes[$_->{ofs}] eq 'const')
1014 $_->{debugname} = get_constant(\%p, $p{globals}[$_->{ofs}]{v});
1018 $_->{debugname} = "$globaltypes[$_->{ofs}]_$_->{ofs}";
1020 ++$globaldefs{$_->{debugname}};
1025 if $globaldefs{$_->{debugname}} <= 1;
1026 #print "Not unique: $_->{debugname} at $_->{ofs}\n";
1027 $_->{debugname} .= "\@$_->{ofs}";
1029 $p{globaldef_byoffset} = sub
1032 my $def = $globaldefs[$ofs];
1038 for(@{$p{functions}})
1040 my $file = $p{getstring}->($_->{s_file});
1041 my $name = $p{getstring}->($_->{s_name});
1042 $name = "$file:$name"
1044 $_->{debugname} = $name;
1045 $functions{$_->{first_statement}} = $_;
1047 $p{function_byoffset} = sub
1050 return $functions{$ofs};
1053 # what do we want to do?
1054 my $checkfunc = \&find_uninitialized_locals;
1055 #my $checkfunc = \&disassemble_function;
1056 for(sort { $a->{debugname} cmp $b->{debugname} } @{$p{functions}})
1058 $checkfunc->(\%p, $_);
1062 open my $fh, '<', $ARGV[0];