mk64/progress.py

352 lines
11 KiB
Python

#!/usr/bin/env python3
import argparse
import json
import csv
import os
import re
parser = argparse.ArgumentParser(description="Computes current progress throughout the whole project.")
parser.add_argument("format", nargs="?", default="text", choices=["text", "shield-json", "totalBadge", "gameBadge", "audioBadge", "bytesToDecompile", "m2cFuncs", "nonmatchingFuncs"])
parser.add_argument("-m", "--matching", dest='matching', action='store_true',
help="Output matching progress instead of decompilation progress")
args = parser.parse_args()
NON_MATCHING_PATTERN = r"#ifdef\s+NON_MATCHING.*?#pragma\s+GLOBAL_ASM\s*\(\s*\"(.*?)\"\s*\).*?#endif"
MIPS_TO_C_FUNC_COUNT_PATTERN = r"#ifdef\s+MIPS_TO_C.*?GLOBAL_ASM\s*\(\s*\"(.*?)\"\s*\).*?#endif"
NON_MATCHING_FUNC_COUNT_PATTERN = r"#ifdef\s+NON_MATCHING.*?GLOBAL_ASM\s*\(\s*\"(.*?)\"\s*\).*?#endif"
def GetNonMatchingFunctions(files):
functions = []
for file in files:
# credits.c contains Japanese characters which are not supported by utf-8
# To prevent errors it cannot be included.
if (file == "src/credits.c"):
continue
with open(file) as f:
functions += re.findall(NON_MATCHING_PATTERN, f.read(), re.DOTALL)
return functions
def CountMipsToCFunctions(files):
functions = []
for file in files:
if (file == "src/credits.c"):
continue
with open(file) as f:
functions += re.findall(MIPS_TO_C_FUNC_COUNT_PATTERN, f.read(), re.DOTALL)
return functions
def CountNonMatchingFunctions(files):
functions = []
for file in files:
if (file == "src/credits.c"):
continue
with open(file) as f:
functions += re.findall(NON_MATCHING_FUNC_COUNT_PATTERN, f.read(), re.DOTALL)
return functions
def ReadAllLines(fileName):
lineList = list()
with open(fileName) as f:
lineList = f.readlines()
return lineList
def GetFiles(path, ext):
files = []
for r, d, f in os.walk(path):
for file in f:
if file.endswith(ext):
files.append(os.path.join(r, file))
return files
nonMatchingFunctions = GetNonMatchingFunctions(GetFiles("src", ".c")) if not args.matching else []
TotalMipsToCFunctions = len(CountMipsToCFunctions(GetFiles("src", ".c")) if not args.matching else [])
TotalNonMatchingFunctions = len(CountNonMatchingFunctions(GetFiles("src", ".c")) if not args.matching else [])
mainSegFiles2 = [
"asm/non_matchings/code_80004740",
"asm/non_matchings/code_80005FD0",
"asm/non_matchings/code_8001F980",
"asm/non_matchings/code_80027D00",
"asm/non_matchings/hud_renderer",
"asm/non_matchings/code_80057C60",
"asm/non_matchings/code_8006E9C0",
"asm/non_matchings/code_80071F00",
"asm/non_matchings/code_80086E70",
"asm/non_matchings/code_8008C1D0",
"asm/non_matchings/code_80091750",
"asm/non_matchings/crash_screen",
"asm/non_matchings/menus",
"asm/non_matchings/staff_ghosts",
]
seg2Files2 = [
"asm/non_matchings/actors",
"asm/non_matchings/math_util",
"asm/non_matchings/memory",
"asm/non_matchings/race_logic",
"asm/non_matchings/render_courses",
"asm/non_matchings/skybox",
]
seg3Files2 = [
"asm/non_matchings/code_80280650",
"asm/non_matchings/code_802AAA70",
"asm/non_matchings/ceremony_and_credits",
]
audioFiles2 = [
"asm/non_matchings/audio"
]
def GetNonMatchingSize(path):
size = 0
if (path == "main"):
for file in mainSegFiles2:
size += getData(file)
elif (path == "seg2"):
for file in seg2Files2:
size += getData(file)
elif (path == "seg3"):
for file in seg3Files2:
size += getData(file)
elif (path == "os"):
size = getData("asm/os/func_800CE720.s")
elif (path == "audio"):
for file in audioFiles2:
size += getData(file)
else: size = getData("asm/non_matchings")
return size
def getData(path):
size = 0
asmFiles = GetFiles(path, ".s")
for asmFilePath in asmFiles:
#if path == asmFilePath.startswith("audio"):
# continue
if asmFilePath not in nonMatchingFunctions:
asmLines = ReadAllLines(asmFilePath)
for asmLine in asmLines:
if (asmLine.startswith("/*")):
size += 4
return size
mapFile = ReadAllLines("build/us/mk64.us.map")
src = 0
mainSeg = 0
seg2 = 0
seg3 = 0
audio = 0
libultra = 0
mainSegFiles = [
"build/us/src/code_800029B0",
"build/us/src/code_80004740",
"build/us/src/code_80005FD0",
"build/us/src/camera",
"build/us/src/code_8001F980",
"build/us/src/code_80027D00",
"build/us/src/hud_renderer",
"build/us/src/code_80057C60",
"build/us/src/code_8006E9C0",
"build/us/src/code_80071F00",
"build/us/src/code_80086E70",
"build/us/src/code_8008C1D0",
"build/us/src/code_80091750",
"build/us/src/code_800AF9B0",
"build/us/src/crash_screen",
"build/us/src/gbiMacro",
"build/us/src/kart_dma",
"build/us/src/main",
"build/us/src/math_util_2",
"build/us/src/profiler",
"build/us/src/spawn_players",
"build/us/src/staff_ghosts",
]
seg2Files = [
"build/us/src/actors",
"build/us/src/actors_extended",
"build/us/src/math_util",
"build/us/src/memory",
"build/us/src/race_logic",
"build/us/src/render_courses",
"build/us/src/skybox_and_splitscreen",
]
seg3Files = [
"build/us/src/camera_junk",
"build/us/src/code_80280000",
"build/us/src/code_80280650",
"build/us/src/code_80281780",
"build/us/src/code_80281C40",
"build/us/src/code_802AAA70",
"build/us/src/ceremony_and_credits",
]
segAudioFiles = [
"build/us/src/audio/effects",
"build/us/src/audio/external",
"build/us/src/audio/heap",
"build/us/src/audio/load",
"build/us/src/audio/playback",
"build/us/src/audio/port_eu",
"build/us/src/audio/seqplayer",
"build/us/src/audio/synthesis",
]
for line in mapFile:
lineSplit = list(filter(None, line.split(" ")))
if (len(lineSplit) == 4 and lineSplit[0].startswith(".")):
section = lineSplit[0]
size = int(lineSplit[2], 16)
objFile = lineSplit[3]
if (section == ".text"):
if (objFile.startswith("build/us/src")):
src += size
if (objFile.startswith(tuple(mainSegFiles))):
mainSeg += size
if (objFile.startswith(tuple(seg2Files))):
seg2 += size
if (objFile.startswith(tuple(seg3Files))):
seg3 += size
if (objFile.startswith("build/us/src/os")):
libultra += size
if (objFile.startswith(tuple(segAudioFiles))):
audio += size
nonMatchingASM = GetNonMatchingSize("asm/non_matchings")
nonMatchingMain = GetNonMatchingSize("main")
nonMatchingSeg2 = GetNonMatchingSize("seg2")
nonMatchingSeg3 = GetNonMatchingSize("seg3")
nonMatchingLibultra = GetNonMatchingSize("os")
nonMatchingASMAudio = GetNonMatchingSize("audio")
src -= nonMatchingASM
decompilable = src + audio + 448 # 448 = OS func_800CE720
mainSeg += libultra
mainSeg -= nonMatchingMain
seg2 -= nonMatchingSeg2
seg3 -= nonMatchingSeg3
audio -= nonMatchingASMAudio
libultra -= nonMatchingLibultra
mainSeg_size = 831024
seg2_size = 174224
seg3_size = 20032
mk64Code_size = 1025280
# handwritten is likely 4400 bytes which brings us to the grand total of 53248.
# for now the total is just a guess. 544 being non_matching funcs.
# osSyncPrintf and func_800CE720
#libultra non_matching
#osSyncPrintf 0x60 96
#func_800CE720 0x1C0 448
#guPerspectiveF 0x290 656
#__osLeoInterrupt 0x880 2176
#contramread 0x3B0 944
#contramwrite 0x3B0 944
#total 0x1490 5264
libultra_size = 43584 + 5264 # 53248 - 2112 # total - handwritten
audio_size = 86912
text_size = mk64Code_size - decompilable
srcPct = 100 * src / mk64Code_size
libultraPct = 100 * libultra / libultra_size
audioPct = 100 * audio / audio_size
mainSegPct = 100 * mainSeg / mainSeg_size
seg2Pct = 100 * seg2 / seg2_size
seg3Pct = 100 * seg3 / seg3_size
bytesPerHeartPiece = text_size // 80
#if args.format == 'csv':
# version = 1
# git_object = git.Repo().head.object
# timestamp = str(git_object.committed_date)
# git_hash = git_object.hexsha
# csv_list = [str(version), timestamp, git_hash,
# str(text_size), str(mk64Code_size), str(src), str(srcPct),
# str(audio), str(audio_size), str(audioPct), str(libultra),
# str(libultra_size), str(libultraPct), str(seg2), str(seg2_size),
# str(seg2Pct), str(seg3), str(seg3_size), str(seg3Pct),
# str(TotalNonMatchingFunctions), str(TotalMipsToCFunctions)]
# print(",".join(csv_list))
if args.format == 'shield-json':
# https://shields.io/endpoint
print(json.dumps({
"schemaVersion": 1,
"label": "progress",
"message": f"{srcPct:.3g}%",
"color": 'yellow',
}))
elif args.format == 'totalBadge':
print(str(round(((mk64Code_size - text_size) / mk64Code_size) * 100, 2))+"%")
elif args.format == 'gameBadge':
print(str(round(srcPct, 2))+"%")
elif args.format == 'audioBadge':
print(str(round(audioPct, 2))+"%")
elif args.format == 'bytesToDecompile':
print(str(text_size)+" of "+str(mk64Code_size)+"\n")
elif args.format == 'm2cFuncs':
print(str(TotalMipsToCFunctions))
elif args.format == 'nonmatchingFuncs':
print(str(TotalNonMatchingFunctions))
elif args.format == 'text':
adjective = "decompiled" if not args.matching else "matched"
print("Total decompilable bytes remaining: "+str(text_size)+" out of "+str(mk64Code_size)+"\n")
print(str(TotalMipsToCFunctions)+" Mips to C functions and")
print(str(TotalNonMatchingFunctions)+" non-matching functions remain to decomp."+"\n")
print(str(src) + " bytes " + adjective + " in game code " + str(srcPct) + "%\n")
print(str(audio) + "/" + str(audio_size) + " bytes " + adjective + " in audio " + str(audioPct) + "%\n")
print(str(libultra) + "/" + str(libultra_size) + " bytes " + adjective + " in libultra " + str(libultraPct) + "%\n")
print(str(mainSeg) + "/" + str(mainSeg_size) + " bytes " + adjective + " in mainSeg " + str(mainSegPct) + "%\n")
print(str(seg2) + "/" + str(seg2_size) + " bytes " + adjective + " in seg2 " + str(seg2Pct) + "%\n")
print(str(seg3) + "/" + str(seg3_size) + " bytes " + adjective + " in seg3 " + str(seg3Pct) + "%\n")
print("------------------------------------\n")
heartPieces = int(src / bytesPerHeartPiece)
rupees = int(((src % bytesPerHeartPiece) * 100) / bytesPerHeartPiece)
if (rupees > 0):
print("You have " + str(heartPieces) + "/80 GP Wins and " + str(rupees) + " bronze cup(s).\n")
else:
print("You have " + str(heartPieces) + "/80 GP Wins.\n")
else:
print("Unknown format argument: " + args.format)