Tyler Wilding
9c631e11fe
This solves two main problems: - the looming threat of running out of memory since every thread would consume duplicate (and probably not needed) resources - though I will point out, jak 2's offline tests seem to hardly use any memory even with 400+ files, duplicated across many threads. Where as jak 1 does indeed use tons more memory. So I think there is something going on besides just the source files - condense the output so it's much easier to see what is happening / how close the test is to completing. - one annoying thing about the multiple thread change was errors were typically buried far in the middle of the output, this fixes that - refactors the offline test code in general to be a lot more modular The pretty printing is not enabled by default, run with `-p` or `--pretty-print` if you want to use it https://user-images.githubusercontent.com/13153231/205513212-a65c20d4-ce36-44f6-826a-cd475505dbf9.mp4
Offline Reference Test
The offline reference test runs the decompiler on all files that have a corresponding _REF.gc, then compiles them.
The test passes if all files compile and all decompiler outputs match the _REF.gc.
The purpose of the offline reference test is:
- To make sure the output of the decompiler can be compiled
- To let us easily see "what source should change, if I changed this type?". This allows us to safely update types without worrying that we forgot to update some other file.
This test doesn't run as part of CI, so it relies on us running it manually. As a result, from time to time, it can be broken on master.
Running the test
Just run offline-test in the build directory. It takes about a minute and will display diffs of any files that don't match and compiler errors on the first failing file.
What to do if the diff test fails
First, manually read the diff and make sure that it's a good change.
If so, re-run the offline-test program with the --dump-mode flag. It will save copies of any differing output in a failures folder (make sure this is empty before running). To apply these to the _REF.gc files automatically, there's a python script that you can run like this:
cd jak-project/build
python3 ../scripts/update_decomp_reference.py ./failures ../test/decompiler/referenc
Next, make sure the actual .gc files in goal_src/ are updated, if they need to be. For large changes, this part can be pretty annoying. There is a update-goal-src.py script that is helpful for huge changes.
What to do if the compile test fails
Ideally we'd make all code compile successfully without any manual changes. But sometimes there's just one function that doesn't work in a big file, and you'd like to get the rest of it. There's a config.jsonc file in the test/offline folder that lets you identify functions by name to skip compiling in the ref tests.