# Contributing

To contribute to the project, you will need a disassembler or a decompiler such as Hex-Rays or Ghidra.

Experience with reverse engineering optimized C++ code is very useful but not necessary if you already know how to decompile C code.

Using a decompiler is strongly recommended for efficiency reasons. 

Feel free to join the [SMO Modding Hub](https://discord.gg/u2dfaQpDh5) Discord server if you have any questions.

## Language

This project is mostly written in C++17.

Unlike the vast majority of games that are being decompiled in 2021, *Super Mario Odyssey* is a large modern game that is written in C++. While C and C++ have a similar syntax, C++ is somewhat more complex than C. To avoid getting lost in C++ code, please familiarize yourself with the following basic language concepts *before* decompiling:

* [namespaces](https://en.cppreference.com/w/cpp/language/namespace)
    * Instead of using prefixes such as `z_` to avoid name conflicts, C++ code instead relies on namespaces.
* [classes](https://en.cppreference.com/w/cpp/language/class), including inheritance, polymorphism, virtual functions
    * C++ classes/structs are basically C structs on steroids. Notably, C++ classes can contain member functions.
    * Member functions get an implicit `this` argument, which is passed as if it were the first argument.
    * [Virtual member functions](https://en.cppreference.com/w/cpp/language/virtual) are member functions that can be overridden in derived classes.
    * Virtual member functions are usually implemented with a virtual function table or "vtable", which is a table of function pointers.
* [const correctness](https://isocpp.org/wiki/faq/const-correctness) for member functions
* iterators and range-based for loops (e.g. `for (int i : my_list_of_ints) {}`)

## Editor/IDE setup

OdysseyDecomp is mostly set up like a normal C++ project using standard build tools and compilers like Clang, CMake, Ninja, etc. so autocomplete and "IntelliSense" style features should work almost out-of-the-box.

### VSCode

Make sure you have the C++ and the CMake Tools extensions installed and enabled. And then just answer "yes" when you're asked whether you would like CMake Tools to configure IntelliSense for you.

### CLion

CLion interacts with CMake directly, so you need to make sure CLion's build profile is configured correctly.

1. Open the Settings window and go to the Build > CMake pane.
2. Remove all existing build profiles, and add a new build profile (call it whatever you want):
    * Build type: RelWithDebInfo
    * CMake options: `-DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_TOOLCHAIN_FILE=toolchain/ToolchainNX64.cmake -GNinja`
    * Build directory: `build`
3. Press OK; CLion will automatically reload the CMake project.

## How to decompile

0. Open the NSO executable in the disassembler of your choice.
   * If you are using IDA, make sure you have the [NSO loader](https://github.com/reswitched/loaders) set up first!

1. **Pick a function that you want to decompile.**
    * Prefer choosing a function that you understand or that is already named in your IDA/Ghidra database.
    * To see if the function has already been decompiled, just search for a known name in the `src/`-directory.
    * You do not need to fully understand the function, but you should at least have a rough idea of what it does.
    * If you are feeling more ambitious, pick an entire C++ class! This usually allows understanding the code better.

2. **Try to understand** what the function does using Hex-Rays or Ghidra.
    * Understanding the function is very important.
    * Rename variables, add structures, do everything you can to make the output as clean as possible.
    * C++ code tends to make heavy use of inline functions. For example, inlined string comparisons or copies are very common and tend to obscure what the function does. Focus on the outline of the function.
    * The [cheatsheet](https://botw.link/cheatsheet) (of the BotW project) might help you recognize inline functions.

3. **Implement the function in C++.**
    * Stay close to the original code, but not too close: your code should mostly look like normal, clean C++ code. If it does not, chances are that you won't get a good match at all.
    * Do **NOT** copy and paste any pseudocode. **Reimplement it**. While we cannot go for a fully "clean room" approach, you should be reimplementing code, not copy/pasting anything from the original executable.
        * PRs that violate this rule will be rejected.
    * Keep in mind that decompilers can only produce C pseudocode. Some function calls may be member function calls.
    * Identify inlined functions and *uninline* them. For example, if you see a string copy, do **not** write the copy loop manually! Instead, call the inline function and let the compiler inline the function for you.
    * Identify duplicate pieces of code: those are usually a sign that functions have been inlined.
    * Non-inline function calls can just be stubbed if you don't feel like decompiling them at the moment. To "stub" a function, just declare the function (and the enclosing class/namespace/etc. if needed) without implementing/defining it.

4. **Build**.

5. **Compare the assembly** with `tools/check -mw <function name>`
    * This will bring up a two-column diff. The code on the left is the original code; the code on the right is your version of the function.
    * You may ignore address differences (which often show up in adrp+ldr pairs or bl or b).
    * If you modify a source file while the diff is visible, it will be automatically rebuilt and the diff will update to match the new assembly code.
      * Remove `-mw` from the command if you do not want automatic rebuilds.
    * Other useful flags:
      * To show C++ source code interleaved with the assembly in the diff, pass `-c` or `--source`.
      * To get a three-column diff (original, decomp, diff with last decomp attempt), pass `-3` (do not use with `-c`).

6. **Tweak the code to get a perfectly matching function**.
    * Clang is usually quite reasonable so it is very common for functions -- even complicated code -- to match on the first try.
    * **Focus on large differences.** If you have large differences (e.g. entire sections of code being at the wrong location), focus on getting rid of them first and ignore small differences like regalloc or trivial reorderings.
    * **Regalloc:** If you only have regalloc differences left in a function that *looks* semantically equivalent, double-check whether it is truly equivalent: such differences are typically caused by using the wrong variable. It is rare for LLVM to use a different set of registers if the code is equivalent.
    * This is usually the most difficult part of matching decomp. Please ask on Discord if you need help!
    * The [cheatsheet](https://github.com/zeldaret/botw/blob/master/Cheatsheet.md) (of the BotW project) might help you recognize code patterns and contains a checklist for common matching issues.

7. **Update the list of decompiled functions**.
    * If you have a function that matches perfectly, great!
    * If there are still minor differences left, write add a comment to explain what is wrong (if you think that is necessary), and change the status (the second column) to `m` (minor difference) in the CSV.
    * For major differences (lots of entirely red/green/blue lines in the diff), use a capital `M` (major difference) in place of `m`.

8. Before opening a PR, reformat the code with clang-format and run `tools/check`.
    * You can use clang-format via your editor – VSCode and CLion have built-in clang-format support — or by calling `git clang-format` (for files you have `git add`ed and not yet committed).
    * If your editor does not have built-in support for clang-format, or if you need to invoke clang-format in a terminal, you'll need to install it manually.
        * If your Linux distro or system (e.g. macOS) does not package clang-format, you can download it from [the LLVM project website here](https://releases.llvm.org/download.html)

## Code style

Super Mario Odyssey has 31MB of code and contributors *need* to read and modify existing parts of the codebase very often: inconsistencies lead to a loss of efficiency, and we literally cannot afford that considering our small number of contributors. To avoid wasting time on formatting issues, we use clang-format to automatically enforce a consistent coding style.

Before opening a PR, please format your code with clang-format and ensure the following guidelines are followed. This will allow your contributions to be reviewed more quickly.

### General

* Lines should not be longer than 100 characters.
* Use 4 spaces to indent.
* Use `nullptr`, not `NULL` or `0`.
* Only use `auto` if the variable type is obvious, too long to type or if it doesn't matter.
* To compare an integer against zero, write `if (value == 0)`, not `if (!value)`. (This rule doesn't apply to booleans.)
* To compare a value against nullptr, either `if (pointer != nullptr)` or `if (pointer)` is fine.

### Header files

* Use `#pragma once` for header guards.
* Avoid unnecessary includes. Forward declare types when possible to reduce compilation times.

### Includes

* Use `#include "..."` when including `al` and `rs` (SMO) header files.
    * Include paths should be relative to `lib/al` or `src`.
        * OK: `#include "Library/LiveActor/LiveActor.h"`
        * Not OK: `#include "LiveActor.h"`

* Use `#include <...>` for system or library includes. Examples:
    * Standard C++ library headers (e.g. `<optional>`, `<type_traits>`, `<limits>`, ...)
    * sead (e.g. `<prim/seadSafeString.h>`)
    * Other Nintendo libraries like agl, eui, ...

* Format `#include`s in three blocks, separating them by one empty line.
    * First up, all includes with angle brackets (`<>`)
    * Then, all includes from `al`, starting with `Library` and `Project` (`""`)
    * Finally, all game headers with no common prefix (`""`)
    * For ordering within the blocks, run `clang-format`

### Naming

* Type names (classes/structs, enums, typedefs/alias declarations) and compile-time constants should be in UpperCamelCase.
    * `class PlayerActorBase`
    * `constexpr int NumActors = 42;`

* Function names should be in camelCase.
    * `void doStuff()`
    * `void SomeClass::doThis()` (for a member function)

* Variables should be in lowercase_snake_case, except for class member variables, which should be prefixed with 'm' and writtenLikeThis.
    * `int a_dummy_variable = 42;`
    * `void test(int first_argument, bool second_argument) { ... }`
    * `class SomeClass { int mMemberVariable; };` (m prefix + camelCase)
    * `struct SomeStruct { int member_variable; };` (regular snake_case)

* Static variables should be prefixed with 's' and globals with 'g'.
    * `s_static_variable`
    * `sStaticVariable` if it's a static member variable

### Classes
* Ordering
   * Put access specifiers in this order: `public`, `protected`, `private`.
   * Declare member functions in this order: constructor, destructor, operators, other member functions.
   * Declare non-static member variables after function declarations.
   * Declare static member variables before non-static variables.
   * Virtual functions need to match the original order in the executable, though, so ignore this rule if following it would require reordering virtual functions.
* If a class uses a macro like `SEAD_SINGLETON_DISPOSER` or one of the SEAD_RTTI macros, put the macro right after the opening brace, before `public:`.
* Use `= default;` instead of constructors/destructors with an empty body.
* Use the `override` keyword instead of `virtual` when overriding virtual functions from a parent class.
* Mark member functions as const if they do not modify any non-static member variables.
* Do not use `this->` to refer to member variables or member functions unless it is necessary. (It is usually unnecessary.)

```cpp
class Test {
    SEAD_RTTI_BASE(Test)

public:
    Test();
    virtual ~Test() = default;
    virtual bool isTest() const { return true; }
    void doStuff() {}

private:
    static bool sFoo = false;
    bool mMemberVariable = true;
};

class TestDerived : public Test {
public:
    bool isTest() const override { return false; }
};
```

## Non-inlined functions

When **implementing non-inlined functions**, please compare the assembly output against the original function and make it match the original code. At this scale, that is pretty much the only reliable way to ensure accuracy and functional equivalency.

However, given the large number of functions, certain kinds of small differences can be ignored when a function would otherwise be equivalent:

* Regalloc differences.
    * Warning: ensure that the return type of the function is correct. Differences that involve the X0-X7, W0-W7 or S0-S3 registers at the end of a function are suspicious.

* Instruction reorderings when it is obvious the function is still semantically equivalent (e.g. two add/mov instructions that operate on entirely different registers being reordered)

## Header utilities or inlined functions

For **header-only utilities** (like container classes), use pilot/debug builds, assertion messages and common sense to try to undo function inlining. For example, if you see the same assertion appear in many functions and the file name is a header file, or if you see identical snippets of code in many different places, chances are that you are dealing with an inlined function. In that case, you should refactor the inlined code into its own function.

Also note that introducing inlined functions is sometimes necessary to get the desired codegen.

If a function is inlined, you should try as hard as possible to make it match perfectly. For inlined functions, it is better to use weird code or small hacks to force a match as differences would otherwise appear in every single function that inlines the non-matching code, which drastically complicates matching other functions. If a hack is used, wrap it inside a `#ifdef MATCHING_HACK_{PLATFORM}` (see below for a list of defines).

### Matching hacks

This project sometimes uses small hacks to force particular code to be generated by the compiler. Those have no semantic effects but can help with matching assembly code especially when the hacks are used for functions that are inlined.

* `MATCHING_HACK_NX_CLANG`: Hacks for Switch, when compiling with Clang.

## The file list format

This project uses a file list yaml file to keep track of functions in the target executable and metadata, for example their decompilation status and location (object file).
At the top scope of the file list are the names of objects we created based on alphabetical ordering. Those objects each contain a text section which has an array of functions that should be implemented in that object. Note that the name and functions of objects are not final and sometimes need adjustment as more information about the objects is obtained. Alphabetical order should be maintained in these adjustments.
Each function in the `.text` section of an object has the following required fields:

* `offset`: a 32-bit unsigned integer formatted as hex (padded to 6 hex digits) that is the offset of the function in the target executable
* `size`: a 32-bit unsigned integer that is the size of the function in the target executable in bytes
* `label`: usually a string that is the mangled symbol of the function. In the case that there are multiple symbols for the same offset, this is a string array of mangled symbols instead
* `status`: the status of the decompilation for this function. This is an enum with the following possible values: `Matching`, `NonMatchingMinor`, `NonMatchingMajor`, `NotDecompiled`, `Wip` and `Library`

In addition to these required fields, there are also two optional boolean fields that only appear if they are set to `true` (default to `false`):
* `lazy`: set to true if the symbol(s) for the function are lazy/weak (marked with `W` or `V` in `llvm-nm`)
* `guess`: set to true if the symbol for the function is a guess and does not appear in the target executable

## Project tools

* Check all decompiled functions for issues: `tools/check`
* To compare assembly: `tools/check <mangled function name>`
    * The function **must be listed in data/file_list.yml first**.
        * To do so, search for the name or the offset of function you have decompiled and compare the `label` field of your target function in the file list to the symbol of your function
    * Pass the `--source` flag to show source code interleaved with assembly code.
    * Add the `--inlines` flag to show inline function calls. This is not enabled by default because it usually produces too much output to be useful.
    * Pass `-mw3` for automatic rebuilds whenever a source file is modified.
    * For more options, see [asm-differ](https://github.com/simonlindholm/asm-differ).
* To print progress: `tools/file_list_progress.py`
    * Note that progress is only approximate because of inline functions, templating and compiler-generated functions.
* To list symbols: `tools/listsym` (pass --help to see available options)
