mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 10:12:06 +00:00
342 lines
9.6 KiB
C++
342 lines
9.6 KiB
C++
// SPDX-License-Identifier: MIT
|
|
|
|
#include "link/section.hpp"
|
|
|
|
#include <inttypes.h>
|
|
#include <memory>
|
|
#include <stdint.h>
|
|
#include <stdlib.h>
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include "helpers.hpp"
|
|
#include "itertools.hpp" // InsertionOrderedMap
|
|
#include "linkdefs.hpp"
|
|
|
|
#include "link/main.hpp"
|
|
#include "link/warning.hpp"
|
|
|
|
static InsertionOrderedMap<std::unique_ptr<Section>> sections;
|
|
|
|
void sect_ForEach(void (*callback)(Section &)) {
|
|
for (std::unique_ptr<Section> &ptr : sections) {
|
|
callback(*ptr);
|
|
}
|
|
}
|
|
|
|
static void checkAgainstFixedAddress(Section const &target, Section const &other, uint16_t org) {
|
|
if (target.isAddressFixed) {
|
|
if (target.org != org) {
|
|
fatalTwoAt(
|
|
target,
|
|
other,
|
|
"Section \"%s\" is defined with address $%04" PRIx16
|
|
", but also with address $%04" PRIx16,
|
|
target.name.c_str(),
|
|
target.org,
|
|
other.org
|
|
);
|
|
}
|
|
} else if (target.isAlignFixed) {
|
|
if ((org - target.alignOfs) & target.alignMask) {
|
|
fatalTwoAt(
|
|
target,
|
|
other,
|
|
"Section \"%s\" is defined with %d-byte alignment (offset %" PRIu16
|
|
"), but also with address $%04" PRIx16,
|
|
target.name.c_str(),
|
|
target.alignMask + 1,
|
|
target.alignOfs,
|
|
other.org
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
static bool checkAgainstFixedAlign(Section const &target, Section const &other, uint32_t ofs) {
|
|
if (target.isAddressFixed) {
|
|
if ((target.org - ofs) & other.alignMask) {
|
|
fatalTwoAt(
|
|
target,
|
|
other,
|
|
"Section \"%s\" is defined with address $%04" PRIx16
|
|
", but also with %d-byte alignment (offset %" PRIu16 ")",
|
|
target.name.c_str(),
|
|
target.org,
|
|
other.alignMask + 1,
|
|
other.alignOfs
|
|
);
|
|
}
|
|
return false;
|
|
} else if (target.isAlignFixed
|
|
&& (other.alignMask & target.alignOfs) != (target.alignMask & ofs)) {
|
|
fatalTwoAt(
|
|
target,
|
|
other,
|
|
"Section \"%s\" is defined with %d-byte alignment (offset %" PRIu16
|
|
"), but also with %d-byte alignment (offset %" PRIu16 ")",
|
|
target.name.c_str(),
|
|
target.alignMask + 1,
|
|
target.alignOfs,
|
|
other.alignMask + 1,
|
|
other.alignOfs
|
|
);
|
|
} else {
|
|
return !target.isAlignFixed || (other.alignMask > target.alignMask);
|
|
}
|
|
}
|
|
|
|
static void checkSectUnionCompat(Section &target, Section &other) {
|
|
if (other.isAddressFixed) {
|
|
checkAgainstFixedAddress(target, other, other.org);
|
|
target.isAddressFixed = true;
|
|
target.org = other.org;
|
|
} else if (other.isAlignFixed) {
|
|
if (checkAgainstFixedAlign(target, other, other.alignOfs)) {
|
|
target.isAlignFixed = true;
|
|
target.alignMask = other.alignMask;
|
|
}
|
|
}
|
|
}
|
|
|
|
static void checkFragmentCompat(Section &target, Section &other) {
|
|
if (other.isAddressFixed) {
|
|
uint16_t org = other.org - target.size;
|
|
checkAgainstFixedAddress(target, other, org);
|
|
target.isAddressFixed = true;
|
|
target.org = org;
|
|
} else if (other.isAlignFixed) {
|
|
uint32_t ofs = (other.alignOfs - target.size) & other.alignMask;
|
|
if (checkAgainstFixedAlign(target, other, ofs)) {
|
|
target.isAlignFixed = true;
|
|
target.alignMask = other.alignMask;
|
|
target.alignOfs = ofs;
|
|
}
|
|
}
|
|
}
|
|
|
|
static void mergeSections(Section &target, std::unique_ptr<Section> &&other) {
|
|
if (target.modifier != other->modifier) {
|
|
fatalTwoAt(
|
|
target,
|
|
*other,
|
|
"Section \"%s\" is defined as `SECTION %s`, but also as `SECTION %s`",
|
|
target.name.c_str(),
|
|
sectionModNames[target.modifier],
|
|
sectionModNames[other->modifier]
|
|
);
|
|
} else if (other->modifier == SECTION_NORMAL) {
|
|
fatalTwoAt(target, *other, "Section \"%s\" is already defined", target.name.c_str());
|
|
} else if (target.type != other->type) {
|
|
fatalTwoAt(
|
|
target,
|
|
*other,
|
|
"Section \"%s\" is defined with type `%s`, but also with type `%s`",
|
|
target.name.c_str(),
|
|
sectionTypeInfo[target.type].name.c_str(),
|
|
sectionTypeInfo[other->type].name.c_str()
|
|
);
|
|
}
|
|
|
|
if (other->isBankFixed) {
|
|
if (!target.isBankFixed) {
|
|
target.isBankFixed = true;
|
|
target.bank = other->bank;
|
|
} else if (target.bank != other->bank) {
|
|
fatalTwoAt(
|
|
target,
|
|
*other,
|
|
"Section \"%s\" is defined with bank %" PRIu32 ", but also with bank %" PRIu32,
|
|
target.name.c_str(),
|
|
target.bank,
|
|
other->bank
|
|
);
|
|
}
|
|
}
|
|
|
|
switch (other->modifier) {
|
|
case SECTION_UNION:
|
|
checkSectUnionCompat(target, *other);
|
|
if (other->size > target.size) {
|
|
target.size = other->size;
|
|
}
|
|
break;
|
|
|
|
case SECTION_FRAGMENT:
|
|
checkFragmentCompat(target, *other);
|
|
// Append `other` to `target`
|
|
other->offset = target.size;
|
|
target.size += other->size;
|
|
// Normally we'd check that `sectTypeHasData`, but SDCC areas may be `_INVALID` here
|
|
if (!other->data.empty()) {
|
|
target.data.insert(target.data.end(), RANGE(other->data));
|
|
// Adjust patches' PC offsets
|
|
for (Patch &patch : other->patches) {
|
|
patch.pcOffset += other->offset;
|
|
}
|
|
} else if (!target.data.empty()) {
|
|
assume(other->size == 0);
|
|
}
|
|
break;
|
|
|
|
case SECTION_NORMAL:
|
|
// LCOV_EXCL_START
|
|
unreachable_();
|
|
}
|
|
// LCOV_EXCL_STOP
|
|
|
|
// Note that the order in which fragments are stored in the `nextPiece` list does not
|
|
// really matter, only that offsets were properly computed above
|
|
other->nextPiece = std::move(target.nextPiece);
|
|
target.nextPiece = std::move(other);
|
|
}
|
|
|
|
void sect_AddSection(std::unique_ptr<Section> &§ion) {
|
|
// Check if the section already exists; if not, add it
|
|
if (Section *target = sect_GetSection(section->name); target) {
|
|
mergeSections(*target, std::move(section));
|
|
} else if (section->modifier == SECTION_UNION && sectTypeHasData(section->type)) {
|
|
fatal(
|
|
"Section \"%s\" is of type `%s`, which cannot be `UNION`ized",
|
|
section->name.c_str(),
|
|
sectionTypeInfo[section->type].name.c_str()
|
|
);
|
|
} else {
|
|
sections.add(section->name, std::move(section));
|
|
}
|
|
}
|
|
|
|
Section *sect_GetSection(std::string const &name) {
|
|
auto index = sections.findIndex(name);
|
|
return index ? sections[*index].get() : nullptr;
|
|
}
|
|
|
|
static void doSanityChecks(Section §ion) {
|
|
// Sanity check the section's type
|
|
if (section.type < 0 || section.type >= SECTTYPE_INVALID) {
|
|
// This is trapped early in RGBDS objects (because then the format is not parseable),
|
|
// which leaves SDAS objects.
|
|
error(
|
|
"Section \"%s\" has not been assigned a type by a linker script", section.name.c_str()
|
|
);
|
|
return;
|
|
}
|
|
|
|
if (options.is32kMode && section.type == SECTTYPE_ROMX) {
|
|
if (section.isBankFixed && section.bank != 1) {
|
|
error(
|
|
"Section \"%s\" has type `ROMX`, which must be in bank 1 (if any) with option '-t'",
|
|
section.name.c_str()
|
|
);
|
|
} else {
|
|
section.type = SECTTYPE_ROM0;
|
|
}
|
|
}
|
|
if (options.isWRAM0Mode && section.type == SECTTYPE_WRAMX) {
|
|
if (section.isBankFixed && section.bank != 1) {
|
|
error(
|
|
"Section \"%s\" has type `WRAMX`, which must be in bank 1 with options '-w' or "
|
|
"'-d'",
|
|
section.name.c_str()
|
|
);
|
|
} else {
|
|
section.type = SECTTYPE_WRAM0;
|
|
}
|
|
}
|
|
if (options.isDmgMode && section.type == SECTTYPE_VRAM && section.bank == 1) {
|
|
error(
|
|
"Section \"%s\" has type `VRAM`, which must be in bank 0 with option '-d'",
|
|
section.name.c_str()
|
|
);
|
|
}
|
|
|
|
// Check if alignment is reasonable, this is important to avoid UB
|
|
// An alignment of zero is equivalent to no alignment, basically
|
|
if (section.isAlignFixed && section.alignMask == 0) {
|
|
section.isAlignFixed = false;
|
|
}
|
|
|
|
// Too large an alignment may not be satisfiable
|
|
if (section.isAlignFixed && (section.alignMask & sectionTypeInfo[section.type].startAddr)) {
|
|
error(
|
|
"Section \"%s\" has type `%s`, which cannot be aligned to $%04x bytes",
|
|
section.name.c_str(),
|
|
sectionTypeInfo[section.type].name.c_str(),
|
|
section.alignMask + 1
|
|
);
|
|
}
|
|
|
|
uint32_t minbank = sectionTypeInfo[section.type].firstBank,
|
|
maxbank = sectionTypeInfo[section.type].lastBank;
|
|
|
|
if (section.isBankFixed && section.bank < minbank && section.bank > maxbank) {
|
|
error(
|
|
minbank == maxbank
|
|
? "Cannot place section \"%s\" in bank %" PRIu32 ", it must be %" PRIu32
|
|
: "Cannot place section \"%s\" in bank %" PRIu32 ", it must be between %" PRIu32
|
|
" and %" PRIu32,
|
|
section.name.c_str(),
|
|
section.bank,
|
|
minbank,
|
|
maxbank
|
|
);
|
|
}
|
|
|
|
// Check if section has a chance to be placed
|
|
if (section.size > sectionTypeInfo[section.type].size) {
|
|
error(
|
|
"Section \"%s\" is bigger than the max size for that type: $%" PRIx16 " > $%" PRIx16,
|
|
section.name.c_str(),
|
|
section.size,
|
|
sectionTypeInfo[section.type].size
|
|
);
|
|
}
|
|
|
|
// Translate loose constraints to strong ones when they're equivalent
|
|
|
|
if (minbank == maxbank) {
|
|
section.bank = minbank;
|
|
section.isBankFixed = true;
|
|
}
|
|
|
|
if (section.isAddressFixed) {
|
|
// It doesn't make sense to have both org and alignment set
|
|
if (section.isAlignFixed) {
|
|
if ((section.org & section.alignMask) != section.alignOfs) {
|
|
error(
|
|
"Section \"%s\"'s fixed address does not match its alignment",
|
|
section.name.c_str()
|
|
);
|
|
}
|
|
section.isAlignFixed = false;
|
|
}
|
|
|
|
// Ensure the target address is valid
|
|
if (section.org < sectionTypeInfo[section.type].startAddr
|
|
|| section.org > sectTypeEndAddr(section.type)) {
|
|
error(
|
|
"Section \"%s\"'s fixed address $%04" PRIx16 " is outside of range [$%04" PRIx16
|
|
"; $%04" PRIx16 "]",
|
|
section.name.c_str(),
|
|
section.org,
|
|
sectionTypeInfo[section.type].startAddr,
|
|
sectTypeEndAddr(section.type)
|
|
);
|
|
}
|
|
|
|
if (section.org + section.size > sectTypeEndAddr(section.type) + 1) {
|
|
error(
|
|
"Section \"%s\"'s end address $%04x is greater than last address $%04x",
|
|
section.name.c_str(),
|
|
section.org + section.size,
|
|
sectTypeEndAddr(section.type) + 1
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
void sect_DoSanityChecks() {
|
|
sect_ForEach(doSanityChecks);
|
|
}
|