From 3f182095cce6a97c6b95352b2efea455d06b5502 Mon Sep 17 00:00:00 2001
From: Antonio Castelli <aatcastelli@gmail.com>
Date: Wed, 26 May 2021 20:30:44 -0700
Subject: [PATCH] Added tool to find undeclared glabels.

---
 tools/python/find_glabels.py | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 tools/python/find_glabels.py

diff --git a/tools/python/find_glabels.py b/tools/python/find_glabels.py
new file mode 100644
index 00000000..ab307308
--- /dev/null
+++ b/tools/python/find_glabels.py
@@ -0,0 +1,32 @@
+import re
+
+from file_util import FileUtil
+
+LINE_START_REGEX = r'\n/\* ([0-9A-F]{6}) [0-9A-F]{8} [0-9A-F]{8} \*/\s+'
+REG_REGEX = r'(\$(at|v[0-1]|a[0-3]|t[0-9]|s[0-7]|k[0-1]|gp|sp|fp|ra))'
+GLABEL_UPPER_REGEX = '(' + LINE_START_REGEX + r'lui\s+' + REG_REGEX + r',\s+(0x80[0-9a-f]{2}))'
+GLABEL_LOWER_REGEX = '(' + LINE_START_REGEX + r'l[bhw]\s+\3,\s+(0x[0-9a-f]{4})\(' + REG_REGEX + '\))'
+GLABEL_REGEX = GLABEL_UPPER_REGEX + '(' + LINE_START_REGEX + '((?!\n|jr|\sb\w*\s).)*(?=\n)){0,10}' + GLABEL_LOWER_REGEX
+
+def _find_glabels(asm):
+    glabels = []
+    for file in FileUtil.get_filenames_from_directory_recursive('.', '.s'):
+        matches = re.findall(GLABEL_REGEX, FileUtil.get_text_from_file(file))
+        for match in matches:
+            offsets = (match[1], match[8])  # ROM offsets of the lu and lw
+            glabel_upper = int(match[4], 16)  # upper immediate of glabel
+            glabel_lower = int(match[10], 16)  # lower immediate of the glabel
+            if glabel_lower & 0x8000:
+                glabel_upper -= 1
+            glabel = 'D_%08X' % (glabel_upper << 16 | glabel_lower)
+            glabels.append((glabel, *offsets))
+    return glabels
+
+def main():
+    FileUtil.set_working_dir_to_project_base()
+    contents = FileUtil.get_text_from_file('asm/non_matchings/unknown_005740/func_80005254.s')
+    glabels = _find_glabels(contents)
+    print(len(glabels))
+
+if __name__ == '__main__':
+    main()