summaryrefslogtreecommitdiff
path: root/docs/decompiling.md
diff options
context:
space:
mode:
authorAetias <aetias@outlook.com>2024-04-28 10:47:43 +0200
committerAetias <aetias@outlook.com>2024-04-28 10:47:43 +0200
commite34d85431b1b7527b7054dfb2ff90117e1ed74ff (patch)
tree45e125e9b4429905f7c7bcadbb74e6c560c360dd /docs/decompiling.md
parenta7b55a988347c64c2ac612d4ac3f738ad7473ef8 (diff)
Update `decompiling.md`
Diffstat (limited to 'docs/decompiling.md')
-rw-r--r--docs/decompiling.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/decompiling.md b/docs/decompiling.md
index bedb1cbb..e0ea60f5 100644
--- a/docs/decompiling.md
+++ b/docs/decompiling.md
@@ -22,7 +22,7 @@ again. Remember to make a pull request of any notable progress you made on the s
Say you've found a function you want to decompile. Here are the steps we recommend for decompiling it:
1. Visit [decomp.me](https://decomp.me/) and start decomping.
1. Under the platforms, select "Nintendo DS".
-1. Select compiler version `2.0sp1p5`.
+1. Select compiler preset "Phantom Hourglass".
1. Copy and paste the target assembly for your function, including the `func_start` and `func_end` macros, and the pool constants.
For example:
```arm
@@ -36,13 +36,9 @@ func_ov09_0211bf48: ; 0x0211bf48
thumb_func_end func_ov09_0211bf48
_0211bf50: .word data_ov09_0211f59c
```
-6. Run `m2ctx.py include/MyHeader.hpp -c` to generate a context and put it in your clipboard.
+5. Run `m2ctx.py include/MyHeader.hpp -c` to generate a context and put it in your clipboard.
- If no suitable header file exists, make a new one and put any structs and types you need in there.
1. Paste the context into decomp.me, and create the scratch.
-1. Copy the `CC_FLAGS` from `Makefile` into the arguments field in decomp.me.
- - Also copy `CXX_FLAGS` if your function comes from a `.cpp` file. Otherwise, copy `C_FLAGS` if it's a `.c` file.
- - Replace the `-d $(REGION)` flag with whichever region you intend to decompile for. You can also delete the flag entirely
- if the function contains no region differences.
1. Decompile the function and try to get a 100% match.
- There's no ARM decompiler in decomp.me yet, but Ghidra does the job quite well. See [the Ghidra section](#the-ghidra-project)
for more info.
@@ -70,6 +66,18 @@ is 12 (`0xc`) bytes long and is also implicit, so we don't need to define it our
> [!IMPORTANT]
> An important thing to keep in mind is that a static initializer can construct multiple global objects.
+## Decompiling data
+> [!NOTE]
+> Under construction! It's not fully clear how data is decompiled, as the compiler is strict on how it orders global variables.
+> Feel free to contribute to this section or provide us with more information!
+
+Other than `.text` and `.init` which contain code, there are the following sections for data:
+- `.rodata`: Global or static constants
+- `.data`: Global or static variables
+- `.bss`/`.sbss`: Global or static uninitialized variables
+
+You can see examples of these data sections in the [compilation section in `build_system.md`](/docs/build_system.md#compiling-code).
+
## The Ghidra project
We use a shared Ghidra project to analyze the game and decompile functions. To gain access to the project, install
[Ghidra version 10.2.3](https://github.com/NationalSecurityAgency/ghidra/releases/tag/Ghidra_10.2.3_build) and request access