encounter/dtk-template
1
0
Fork 0
mirror of https://github.com/encounter/dtk-template.git synced 2025-10-27 11:20:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
dtk-template/docs/splits.md
Luke Street 83e44bbec3 Documentation updates 
Resolves #28
2024-09-17 19:20:51 -06:00

2.2 KiB
Raw Blame History

splits.txt

This file contains file splits for a module.

Example:

path/to/file.cpp:
	.text       start:0x80047E5C end:0x8004875C
	.ctors      start:0x803A54C4 end:0x803A54C8
	.data       start:0x803B1B40 end:0x803B1B60
	.bss        start:0x803DF828 end:0x803DFA8C
	.bss        start:0x8040D4AC end:0x8040D4D8 common

Format

path/to/file.cpp: [file attributes]
    section     [section attributes]
    ...
  • path/to/file.cpp The name of the source file, usually relative to src. The file does not need to exist to start.
    This corresponds to an entry in configure.py for specifying compiler flags and other options.

File attributes

  • comment: Overrides the mw_comment_version setting in config.yml for this file. See Comment section.

    • comment:0 is used to disable .comment section generation for a file that wasn't compiled with mwcc.
      Example: TRK_MINNOW_DOLPHIN/ppc/Export/targsupp.s: comment:0
      This file was assembled and only contains label symbols. Generating a .comment section for it will crash mwld.

  • order: Allows influencing the resolved link order of objects. This is not required, as decomp-toolkit will generate the link order automatically. This can be used to fine-tune the link order for ambiguous cases.
    Example:

    file1.cpp: order:0
  ...

file2.cpp: order:1
  ...

file3.cpp: order:2
  ...

    This ensures that file2.cpp is always anchored in between 1 and 3 when resolving the final link order.

Section attributes

  • start: The start address of the section within the file. For DOLs, this is the absolute address (e.g. 0x80001234). For RELs, this is the section-relative address (e.g. 0x1234).
  • end: The end address of the section within the file.
  • align: Specifies the alignment of the section. If not specified, the default alignment for the section is used.
  • rename: Writes this section under a different name when generating the split object. Used for .ctors$10, etc.
  • common Only valid for .bss. See Common BSS.
  • skip Skips this data when writing the object file. Used for ignoring data that's linker-generated.