rndtrash/JSRF-Decompilation
1
0
Fork 0
mirror of https://codeberg.org/KeybadeBlox/JSRF-Decompilation.git synced 2026-02-20 18:27:04 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Complete "Setting Up Decompilation" documentation

Browse source
This commit is contained in:
KeybadeBlox 2025-12-17 22:08:15 -05:00
parent 1c8eb137ee
commit aabd8337b3
1 changed files with 41 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

48
contributing.md
View file

@ -72,15 +72,13 @@ summary after a moment (you'll probably see the message
`default.xbe` should now be visible in the file listing for the project. `default.xbe` should now be visible in the file listing for the project.
Double click it to open it in the CodeBrowser. The window that opens is where Double click it to open it in the CodeBrowser. The window that opens is where
you'll do all your in-situ analysis, should you choose to do so. You'll be you'll do all your in-situ analysis, should you choose to do so. You'll be
asked whether you want to run analyzers, which is strongly recommended unless asked whether you want to run analyzers; say yes. Afterwards, simply clicking
you're certain you won't be using Ghidra for anything else. If you do run the "Analyze" in the analysis options window without changing anything is fine, and
analyzers, simply clicking "Analyze" in the analysis options window without the analysis will probably take a couple minutes.
changing anything is fine, and the analysis will probably take a couple
minutes.
Now we'll import symbols from the JSRF decompilation repository. After running Now we'll import symbols from the JSRF decompilation repository. After running
or skipping the analysis, open the script manager (`Window > Script Manager`) the analysis, open the script manager (`Window > Script Manager`) and select
and select the "Data" folder in the left pane. Double click the script titled the "Data" folder in the left pane. Double click the script titled
`ImportSymbolsScript.py`, and a file picker will open after a moment. Select `ImportSymbolsScript.py`, and a file picker will open after a moment. Select
`symboltable.tsv` from the `delink/` directory of your cloned JSRF `symboltable.tsv` from the `delink/` directory of your cloned JSRF
decompilation repository, and you should see a bunch of `Created function...` decompilation repository, and you should see a bunch of `Created function...`
@ -130,8 +128,44 @@ listing the contents of the recompiled object file. If the right pane displays
an error like "program not found," the Visual C++ 7.0 compiler probably wasn't an error like "program not found," the Visual C++ 7.0 compiler probably wasn't
correctly set up on your `PATH`. correctly set up on your `PATH`.
One important piece of information, to make sure you get the correct match
percentages: set `Diff Options > Function relocation diffs` to "None."
Otherwise, approximately all references to functions and non-local variables
will be marked as nonmatching (this has to do with the delinking process not
applying name mangling, which isn't expected to be fixed).
### Using objdiff ### Using objdiff
The basic idea of objdiff is to match up the contents of an object file
compiled from our own decompiled code to the contents of an object file
extracted from the game. To that end, functions have to be matched up between
them. In the best case, corresponding functions in each file will have the
same name and be in the same section, at which point objdiff can link them
automatically. Otherwise, one has two click on one of the corresponding
functions in one pane and the other function in the other pane to tell objdiff
to link them. Common cases of this are class methods (the names won't match)
and implicitly generated functions, such as exception handling code placed in
`.text$x` in the recompiled object file.
Clicking on a function that's been linked across both object files shows a diff
of the disassembly of both versions of the function, with any differences
highlighted. The task at hand is to modify the function in the corresponding
source file such that the match percentage reaches 100%. Depending on how you
configure objdiff, it will rebuild automatically whenever you save a change to
a source file, or you can manually rebuild with the "Build" button at the top
of the right pane.
There are no hard instructions to give for writing decompiled code. Use
Ghidra's decompilation of the function in the CodeBrowser as a starting point,
and exercise whatever C++ and x86 assembly knowledge you have. Exception
handling code in particular can appear in unexpected places (around `new`
statements, in constructors) and has unambiguous but nonobvious signs in the
disassembly, so it might be worth
[reading](https://www.openrce.org/articles/full_view/21)
[up](https://www.openrce.org/articles/full_view/23)
[on](https://web.archive.org/web/20101007110629/http://www.microsoft.com/msj/0197/exception/exception.aspx)
how they're implemented to learn to recognize them in disassembly and recreate
them in C++ code.
## Contrbuting to Delinking ## Contrbuting to Delinking