Setup calcrom.pl (Manual OK bot)

.github/calcrom/calcrom.pl

@@ -0,0 +1,299 @@
+#!/usr/bin/perl
+
+# Usage:
+#   calcrom.pl <mapfile> [--verbose]
+#
+#   mapfile: path to .map file output by LD
+#   verbose: set to get more detailed output
+
+use IPC::Cmd qw[ run ];
+use Getopt::Long;
+
+my $usage = "Usage: calcrom.pl file.map [--verbose]\n";
+my $verbose = "";
+
+GetOptions("verbose" => \$verbose) or die $usage;
+(@ARGV == 1)
+    or die $usage;
+open(my $file, $ARGV[0])
+    or die "ERROR: could not open file '$ARGV[0]'.\n";
+
+my $src = 0;
+my $lib = 0;
+my $asm = 0;
+my $srcdata = 0;
+my $data = 0;
+my @pairs = ();
+
+my $processlines = 0;
+
+while (my $line = <$file>)
+{
+    # Prevent everything before Memory Configuration from being considered, most notably discarded sections
+    if (rindex($line, 'Memory Configuration', 0) == 0)
+    {
+        $processlines = 1;
+    }
+
+    if (!$processlines)
+    {
+        next;
+    }
+
+    if ($line =~ /^ \.(\w+)\s+0x[0-9a-f]+\s+(0x[0-9a-f]+) ([\w\.]+)\/(.+)\.o/)
+    {
+        my $section = $1;
+        my $size = hex($2);
+        my $dir = $3;
+        my $basename = $4;
+        if ($size & 3)
+        {
+            $size += 4 - ($size & 3);
+        }
+
+        if ($section =~ /text/)
+        {
+            if ($dir eq 'src')
+            {
+                $src += $size;
+            }
+            elsif ($dir eq '..')
+            {
+                $lib += $size;
+            }
+            elsif ($dir eq 'asm')
+            {
+                if (!($basename =~ /(crt0|libagbsyscall|libgcnmultiboot|m4a_1)/))
+                {
+                    push @pairs, [$basename, $size];
+                }
+                $asm += $size;
+            }
+        }
+        elsif ($section =~ /rodata/)
+        {
+            if ($dir eq 'src')
+            {
+                print "$line";
+                $srcdata += $size;
+            }
+            elsif ($dir eq 'data')
+            {
+                $data += $size;
+            }
+        }
+    }
+}
+
+my @sorted = sort { $a->[1] <=> $b->[1] } @pairs;
+(my $elffname = $ARGV[0]) =~ s/\.map/.elf/;
+
+
+
+# Note that the grep filters out all branch labels. It also requires a minimum
+# line length of 5, to filter out a ton of generated symbols (like AcCn). No
+# settings to nm seem to remove these symbols. Finally, nm prints out a separate
+# entry for whenever a name appears in a file, not just where it's defined. uniq
+# removes all the duplicate entries.
+#
+#
+# You'd expect this to take a while, because of uniq. It runs in under a second,
+# though. Uniq is pretty fast!
+my $base_cmd = "nm $elffname | awk '{print \$3}' | grep '^[^_].\\{4\\}' | uniq";
+
+# This looks for Unknown_, Unknown_, or sub_, followed by just numbers. Note that
+# it matches even if stuff precedes the unknown, like sUnknown/gUnknown.
+# 'sub_' anchors to the start so it does not consider symbols like 'nullsub_12' undocumented.
+my $undoc_cmd = "grep -E '[Uu]nknown_[0-9a-fA-F]{4,}\$|^sub_[0-9a-fA-F]{4,}\$'";
+
+# This looks for every symbol with an address at the end of it. Some things are
+# given a name based on their type / location, but still have an unknown purpose.
+# For example, FooMap_EventScript_FFFFFFF.
+my $partial_doc_cmd = "grep -E '_[0-9a-fA-F]{4,}\$'";
+
+my $count_cmd = "wc -l";
+
+my $incbin_cmd = "find \"\$(dirname $elffname)\" \\( -name '*.s' -o -name '*.inc' \\) -exec cat {} ';' | grep -oE '^\\s*\\.incbin\\s*\"[^\"]+\"\s*,\\s*(0x)?[0-9a-fA-F]+\\s*,\\s*(0x)?[0-9a-fA-F]+' -";
+
+my $nonmatching_cmd = "git grep -E '#if[n]?def NONMATCHING' ':/' ':(exclude).'";
+
+my $todo_cmd = "git grep 'TODO' ':/' ':(exclude).'";
+
+# It sucks that we have to run this three times, but I can't figure out how to get
+# stdin working for subcommands in perl while still having a timeout. It's decently
+# fast anyway.
+my $total_syms_as_string;
+(run (
+    command => "$base_cmd | $count_cmd",
+    buffer => \$total_syms_as_string,
+    timeout => 60
+))
+    or die "ERROR: Error while getting all symbols: $?";
+
+my $undocumented_as_string;
+(run (
+    command => "$base_cmd | $undoc_cmd | $count_cmd",
+    buffer => \$undocumented_as_string,
+    timeout => 60
+))
+    or die "ERROR: Error while filtering for undocumented symbols: $?";
+
+my $partial_documented_as_string;
+(run (
+    command => "$base_cmd | $partial_doc_cmd | $count_cmd",
+    buffer => \$partial_documented_as_string,
+    timeout => 60
+))
+    or die "ERROR: Error while filtering for partial symbols: $?";
+
+my $incbin_count_as_string;
+(run (
+    command => "$incbin_cmd | $count_cmd",
+    buffer => \$incbin_count_as_string,
+    timeout => 60
+))
+    or die "ERROR: Error while counting incbins: $?";
+
+my $incbin_bytes_as_string;
+(run (
+    command => "(echo -n 'ibase=16;' ; $incbin_cmd | sed -E 's/.*,\\s*0x([0-9a-fA-F]+)/\\1/' | tr '\\n' '+'; echo '0' ) | bc",
+    buffer => \$incbin_bytes_as_string,
+    timeout => 60
+))
+    or die "ERROR: Error while calculating incbin totals: $?";
+
+my $nonmatching_as_string;
+(run (
+    command => "$nonmatching_cmd | $count_cmd",
+    buffer => \$nonmatching_as_string,
+    timeout => 60
+))
+    or die "ERROR: Error while calculating NONMATCHING totals: $?";
+
+my $todo_as_string;
+(run (
+    command => "$todo_cmd | $count_cmd",
+    buffer => \$todo_as_string,
+    timeout => 60
+))
+    or die "ERROR: Error while calculating TODO totals: $?";
+
+# Performing addition on a string converts it to a number. Any string that fails
+# to convert to a number becomes 0. So if our converted number is 0, but our string
+# is nonzero, then the conversion was an error.
+my $undocumented = $undocumented_as_string + 0;
+(($undocumented != 0) and ($undocumented_as_string ne "0"))
+    or die "ERROR: Cannot convert string to num: '$undocumented_as_string'";
+
+my $partial_documented = $partial_documented_as_string + 0;
+(($partial_documented != 0) and ($partial_documented_as_string ne "0"))
+	or die "ERROR: Cannot convert string to num: '$partial_documented_as_string'";
+
+my $total_syms = $total_syms_as_string + 0;
+(($total_syms != 0) and ($total_syms_as_string ne "0"))
+    or die "ERROR: Cannot convert string to num: '$total_syms_as_string'";
+
+($total_syms != 0)
+    or die "ERROR: No symbols found.";
+
+my $incbin_count = $incbin_count_as_string + 0;
+(($incbin_count != 0) and ($incbin_count_as_string ne "0"))
+    or die "ERROR: Cannot convert string to num: '$incbin_count_as_string'";
+
+my $incbin_bytes = $incbin_bytes_as_string + 0;
+(($incbin_bytes != 0) and ($incbin_bytes_as_string ne "0"))
+    or die "ERROR: Cannot convert string to num: '$incbin_bytes_as_string'";
+
+my $nonmatching_count = $nonmatching_as_string + 0;
+(($nonmatching_count != 0) and ($nonmatching_as_string ne "0"))
+    or die "ERROR: Cannot convert string to num: '$nonmatching_as_string'";
+
+my $todo_count = $todo_as_string + 0;
+(($todo_count != 0) and ($todo_as_string ne "0"))
+    or die "ERROR: Cannot convert string to num: '$todo_as_string'";
+
+
+
+my $total = $src + $lib + $asm;
+my $srcPct = 100 * $src / $total;
+my $libPct = 100 * $lib / $total;
+my $asmPct = 100 * $asm / $total;
+
+if ($asm == 0)
+{
+    print "Code decompilation is 100% complete\n"
+}
+else
+{
+    printf "%8d total bytes of code\n", $total;
+    printf "%8d bytes of code in src (%.4f%%)\n", $src, $srcPct;
+    printf "%8d bytes of code in agbcc libraries (%.4f%%)\n", $lib, $libPct;
+    printf "%8d bytes of code in asm (%.4f%%)\n", $asm, $asmPct;
+}
+print "\n";
+
+if ($verbose != 0)
+{
+    print "BREAKDOWN\n";
+    foreach my $item (@sorted)
+    {
+        printf "%8d bytes in asm/$item->[0].s\n", $item->[1];
+    }
+    print "\n";
+}
+
+
+
+# partial_documented is double-counting the unknown_* and sub_* symbols.
+$partial_documented = $partial_documented - $undocumented;
+
+my $documented = $total_syms - ($undocumented + $partial_documented);
+my $docPct = 100 * $documented / $total_syms;
+my $partialPct = 100 * $partial_documented / $total_syms;
+my $undocPct = 100 * $undocumented / $total_syms;
+
+if ($partial_documented == 0 && $undocumented == 0)
+{
+    print "Documentation is 100% complete\n"
+}
+else
+{
+    printf "%8d total symbols\n", $total_syms;
+    printf "%8d symbols documented (%.4f%%)\n", $documented, $docPct;
+    printf "%8d symbols partially documented (%.4f%%)\n", $partial_documented, $partialPct;
+    printf "%8d symbols undocumented (%.4f%%)\n", $undocumented, $undocPct;
+}
+print "\n";
+
+
+
+my $dataTotal = $srcdata + $data;
+# Bytes in incbins are also in data. For cleaner presentation, separate these out.
+$data -= $incbin_bytes;
+my $srcDataPct = 100 * $srcdata / $dataTotal;
+my $dataPct = 100 * $data / $dataTotal;
+my $incPct = 100 * $incbin_bytes / $dataTotal;
+
+if ($data == 0 && $incbin_bytes == 0)
+{
+    print "Data porting to C is 100% complete\n"
+}
+else
+{
+    printf "%8d total bytes of data\n", $dataTotal;
+    printf "%8d bytes of data in src (%.4f%%)\n", $srcdata, $srcDataPct;
+    printf "%8d bytes of data in data (%.4f%%)\n", $data, $dataPct;
+}
+
+if ($incbin_count == 0) {
+    print "All incbins have been eliminated\n";
+} else {
+    printf "%8d bytes of data in $incbin_count incbins (%.4f%%)\n", $incbin_bytes, $incPct;
+}
+
+if ($verbose != 0)
+{
+    print "\n";
+    printf "%8d functions are NONMATCHING\n", $nonmatching_count;
+    printf "%8d comments are labeled TODO\n", $todo_count;
+}

Makefile

@@ -140,15 +140,11 @@ include graphics_rules.mk
 %.lz: % ; $(GFX) $< $@
 %.rl: % ; $(GFX) $< $@
 
-
+# TODO: why does rom_850.c need old_agbcc here but not in nonmatching-18?
 $(C_BUILDDIR)/rom_850.o: CC1 := tools/agbcc/bin/old_agbcc
+# TODO: figure out what compiler and flags gbplayer.c uses
 $(C_BUILDDIR)/gbplayer.o: CC1 := tools/agbcc/bin/old_agbcc
 
-$(C_BUILDDIR)/libc.o: CC1 := tools/agbcc/bin/old_agbcc
-$(C_BUILDDIR)/libc.o: CFLAGS := -O2
-
-$(C_BUILDDIR)/m4a_2.o: CC1 := tools/agbcc/bin/old_agbcc
-$(C_BUILDDIR)/m4a_4.o: CC1 := tools/agbcc/bin/old_agbcc
 $(C_BUILDDIR)/m4a.o: CC1 := tools/agbcc/bin/old_agbcc
 
 $(C_BUILDDIR)/agb_sram.o: CFLAGS := -mthumb-interwork -Wimplicit -Wparentheses -Werror -O1

asm/ereader.s

@@ -137,8 +137,8 @@ sub_2C78: @ 0x08002C78
 	bl sub_394C
 	movs r0, #5
 	bl m4aSongNumStart
-	bl sub_CBC
-	bl sub_24C
+	bl sub_0CBC
+	bl sub_024C
 	movs r0, #1
 	strb r0, [r6, #3]
 	pop {r3, r4}
@@ -467,9 +467,9 @@ sub_304C: @ 0x0800304C
 	beq _08003076
 	bl sub_2568
 	bl sub_1AA4
-	bl sub_2B4
+	bl sub_02B4
 	bl m4aMPlayAllStop
-	bl sub_D10
+	bl sub_0D10
 	movs r0, #0
 	strb r0, [r5, #3]
 _08003076:
@@ -803,9 +803,9 @@ _08003330:
 	bne _08003358
 	bl sub_2568
 	bl sub_1AA4
-	bl sub_2B4
+	bl sub_02B4
 	bl m4aMPlayAllStop
-	bl sub_D10
+	bl sub_0D10
 	strb r4, [r7, #3]
 	b _0800336E
 	.align 2, 0
@@ -880,9 +880,9 @@ _080033E4: .4byte gUnknown_0202A58C
 _080033E8:
 	movs r0, #0
 	strh r0, [r2]
-	bl sub_2B4
+	bl sub_02B4
 	bl m4aMPlayAllStop
-	bl sub_D10
+	bl sub_0D10
 	ldr r1, _0800342C @ =gMain
 	movs r0, #6
 	strb r0, [r1, #3]
@@ -1039,8 +1039,8 @@ sub_343C: @ 0x0800343C
 	bl sub_394C
 	movs r0, #5
 	bl m4aSongNumStart
-	bl sub_CBC
-	bl sub_24C
+	bl sub_0CBC
+	bl sub_024C
 	movs r0, #7
 	strb r0, [r6, #3]
 	pop {r3, r4}
@@ -1266,9 +1266,9 @@ _08003748: .4byte 0x80001800
 	thumb_func_start sub_374C
 sub_374C: @ 0x0800374C
 	push {lr}
-	bl sub_2B4
+	bl sub_02B4
 	bl m4aMPlayAllStop
-	bl sub_D10
+	bl sub_0D10
 	ldr r1, _08003774 @ =gAutoDisplayTitlescreenMenu
 	movs r0, #1
 	strb r0, [r1]