fork/training-mode-ce
git clone https://git.julia.blue/fork/training-mode-ce
991fcc5
nix
files
| Additional Codes/ | |
| m-ex/ | |
| training-mode/ | |
| Globals.s | 29.0 KiB |
| Readme.md | 5.1 KiB |
ASM
Aitch: I don't write much melee asm, but here's some things I've picked up by hacking on unclepunch's asm. Here are some things you should know before diving into here, and some questions I have.
Clown: I have written a good amount of melee asm. I've added some useful information I have here. If you have any questions, reach out on the discord.
Overview
PowerPC (PPC) is an instruction set architecture (ISA) that used to be used in computers and game consoles in the 90s and 2000s, notably in several Apple products, the Xbox 360, the PS3, and the GC/Wii/Wii U. Specifically, the GameCube and Wii use an embedded, big-endian, 32-bit version of PowerPC on their CPUs.
Resources:
- IBM PPC User Instruction Set Architecture
- IBM PPC Compiler Writer's Guide
- Beginner to advanced tutorials for PowerPC
- rlwinm/rlwimi/rlwmn Decoder
- Decompilation project for Melee
- Decomp Intro
You should prioritize reading Section 2 and Appendix A of the Compiler's Writing Guide. Also, Section 1.6 and Appendix B of the User Instruction Set Architecture.
The decompilation project is useful for understanding Melee's code. If you have an address of a Melee function, you can grep the decomp codebase and see if it's been decompiled. Even if it hasn't been, it's easier to search around for related code within that repo than it is to work within the dolphin debugger. If you're interested in learning more, you should read the Decomp Intro.
Notes:
- The numbers 0..32 are allowed as registers!
You may run into silent errors where you expect to use a constant value but end up using a register.
The most common place to see this are in math instructions -
addi r3, r3, 10can be accidentally written asadd r3, r3, 10and introduce a bug. - If you see a load with offset around 0x23ec-0x2424 in OSD related code,
it's probably reading or writing to
struct MEXorstruct TMinstruct FighterDatainMexTK/include/fighter.h. - Don't be afraid of the dolphin debugger!. Use the latest version of dolphin.
- Everything in both
ASM/Globals.sandASM/training-mode/Globals.sare helper macros. These are imported into most other ASM files.ASM/Globals.sis outdated, useASM/training-mode/Globals.sfor new asm files.
mflr
Because ASM files could be placed anywhere, you can't exactly just load a label as an address in a register.
To get around this, there is an extremely common pattern using the mflr instruction.
When the bl <label> instruction is followed by an mflr <r> instruction, the address right after the bl is placed in r.
So often you will see something like:
bl SkipData .long 12345 # important data SkipData: mflr r4 lwz r3, 0x0(r4) # r3 now contains 12345
EventJumpTable
If you see the macro EventJumpTable in an ASM file somewhere, you're in for a wild ride.
This macro is defined as:
.macro EventJumpTable bl Minigames bl GeneralTech bl SpacieTech .endm
This allows event asm code to find global event data.
This macro is not useful by itself. If this macro is used, there will be another macro imported (eg. EventNameStrings).
That other macro will have three labels: Minigames, GeneralTech, and SpacieTech.
Under each label, for each event, with be ANOTHER macro for the data for that event.
There will also be definitions for EventID and PageID, and this piece of code:
SkipPageList: mflr r4 #Jump Table Start in r4 mulli r5, PageID, 0x4 #Each Pointer is 0x4 Long add r4, r4, r5 #Get Event's Pointer Address lwz r5, 0x0(r4) #Get bl Instruction rlwinm r5, r5, 0, 6, 29 #Mask Bits 6-29 (the offset) mr r3,EventID add r4, r4, r5 #Gets ASCII Address in r4
After this, in the address r4, will be a pointer to the data for the event (event name, event allowed characters, etc.). That is the entire purpose of all these imports and definitions and code. Yes, this code reads a branch instruction and extracts the offset XD. Absolutely bonkers.
R13
R13 is the small data area pointer.
This points to a small amount of static data contained inside the executable (Start.dol) itself, rather than the iso.
There are some offsets under the r13 Offsets header in ASM/training-mode/Globals.s, as well as in MexTK/include/offsets.h.
Look there for what is loaded if you see a load with negative offset into R13.
R13 = 0x804db6a0 always for melee. It is indexed by signed 16-bit integers. Generally you want to be careful modifying
memory in the small data area, but there is some code in the repository that does so in a region unused by melee.
PRIM Lite
PRIM Lite is a drawing module developed by punkline. There may be better ways to draw geometry, but I don't know how. Currently it's used by the DI draw code. See documentation at this smashboards thread