// SPDX-License-Identifier: GPL-3.0-or-later #include "CodeGenTarget.h" #include "rcc/CodeGen/GenericOpcodes.h" #include "rcc/CodeGen/LowLevelType.h" #include "rcc/CodeGen/MachineOperand.h" #include #include #include #include #include #include #include #include #include #include #include namespace rcc::targetgen { namespace { [[nodiscard]] std::optional genericOpcodeValue(std::string_view Symbol) { #define RCC_CORE_OPCODE(Name) \ if (Symbol == #Name) \ return static_cast(GenericOpcode::Name); #define RCC_GENERIC_OPCODE(Name) RCC_CORE_OPCODE(Name) #include "rcc/CodeGen/GenericOpcode.def" #undef RCC_GENERIC_OPCODE #undef RCC_CORE_OPCODE return std::nullopt; } [[nodiscard]] const NormalizedInstruction * findInstructionBySymbol(const NormalizedTargetModel &Model, std::string_view Symbol) { const auto Position = std::ranges::find(Model.Instructions, Symbol, &NormalizedInstruction::Symbol); return Position == Model.Instructions.end() ? nullptr : &*Position; } [[nodiscard]] std::optional resolveOpcode(const NormalizedTargetModel &Model, std::string_view Symbol) { if (const NormalizedInstruction *Instruction = findInstructionBySymbol(Model, Symbol)) return Instruction->ID; return genericOpcodeValue(Symbol); } [[nodiscard]] bool isRegisterOperand(const NormalizedInstruction &Instruction, std::uint32_t Index) { return Index < Instruction.Operands.size() && std::ranges::contains(Instruction.Operands[Index].Kinds, "Register"); } [[nodiscard]] std::optional integerPredicateValue(std::string_view Symbol) noexcept { static constexpr std::array, 2> Predicates = {{ {"eq", IntegerPredicate::Equal}, {"ne", IntegerPredicate::NotEqual}, }}; if (Symbol == "sgt") return static_cast(IntegerPredicate::SignedGreaterThan); if (Symbol == "sge") return static_cast(IntegerPredicate::SignedGreaterEqual); if (Symbol == "sle") return static_cast(IntegerPredicate::SignedLessEqual); if (Symbol == "slt") return static_cast(IntegerPredicate::SignedLessThan); if (Symbol == "ugt") return static_cast(IntegerPredicate::UnsignedGreaterThan); if (Symbol == "uge") return static_cast(IntegerPredicate::UnsignedGreaterEqual); if (Symbol == "ult") return static_cast(IntegerPredicate::UnsignedLessThan); if (Symbol == "ule") return static_cast(IntegerPredicate::UnsignedLessEqual); const auto *const Position = std::ranges::find(Predicates, Symbol, &decltype(Predicates)::value_type::first); if (Position == Predicates.end()) return std::nullopt; return static_cast(Position->second); } [[nodiscard]] const NormalizedRegister *findRegisterBySymbol(const NormalizedTargetModel &Model, std::string_view Symbol) { const auto Position = std::ranges::find(Model.Registers, Symbol, &NormalizedRegister::Symbol); return Position == Model.Registers.end() ? nullptr : &*Position; } [[nodiscard]] std::optional registerOperandFlags(std::span Names) noexcept { RegisterOperandFlags Flags; for (const std::string &Name : Names) { const auto Set = [&Flags](RegisterOperandFlag Flag) { Flags.set(Flag); return true; }; if (Name == "define") Set(RegisterOperandFlag::Define); else if (Name == "use") Set(RegisterOperandFlag::Use); else if (Name == "implicit") Set(RegisterOperandFlag::Implicit); else if (Name == "kill") Set(RegisterOperandFlag::Kill); else if (Name == "dead") Set(RegisterOperandFlag::Dead); else if (Name == "undef") Set(RegisterOperandFlag::Undef); else if (Name == "early_clobber") Set(RegisterOperandFlag::EarlyClobber); else if (Name == "internal_read") Set(RegisterOperandFlag::InternalRead); else if (Name == "renamable") Set(RegisterOperandFlag::Renamable); else if (Name == "debug") Set(RegisterOperandFlag::Debug); else return std::nullopt; } return Flags; } [[nodiscard]] bool validRegisterOperandFlags(RegisterOperandFlags Flags) noexcept { const bool IsDef = Flags.has(RegisterOperandFlag::Define); const bool IsUse = Flags.has(RegisterOperandFlag::Use); return (IsDef || IsUse) && (!Flags.has(RegisterOperandFlag::Kill) || IsUse) && (!Flags.has(RegisterOperandFlag::Dead) || IsDef) && (!Flags.has(RegisterOperandFlag::Undef) || IsUse) && (!Flags.has(RegisterOperandFlag::EarlyClobber) || IsDef) && (!Flags.has(RegisterOperandFlag::InternalRead) || (IsDef && IsUse)) && (!(IsDef && IsUse) || Flags.has(RegisterOperandFlag::InternalRead)) && (!Flags.has(RegisterOperandFlag::Debug) || (IsUse && !IsDef)); } } // namespace bool CodeGenTarget::normalizeSelectionRules(NormalizedTargetModel &Result) { std::unordered_set Symbols; for (const SourceSelectionRule &Rule : Input.SelectionRules) { const auto MatchOpcode = resolveOpcode(Result, Rule.MatchOpcodeSymbol); const NormalizedInstruction *MatchInstruction = findInstructionBySymbol(Result, Rule.MatchOpcodeSymbol); if (!isIdentifier(Rule.Symbol) || !Symbols.insert(Rule.Symbol).second || !MatchOpcode) { fail(Rule.Range, "selection rules require a unique identifier and declared match opcode"); return false; } if (MatchInstruction != nullptr && !std::ranges::contains(MatchInstruction->Flags, "Generic")) { fail(Rule.Range, "selection rule match opcode must be generic"); return false; } if (Rule.Actions.empty()) { fail(Rule.Range, "selection rule requires at least one generated instruction"); return false; } const auto NormalizeType = [this](const SourceSelectionTypePredicate &Source) -> std::optional { NormalizedSelectionTypeKind Kind = NormalizedSelectionTypeKind::Any; if (Source.Kind == "scalar") Kind = NormalizedSelectionTypeKind::Scalar; else if (Source.Kind == "pointer") Kind = NormalizedSelectionTypeKind::Pointer; else if (Source.Kind != "any") { fail(Source.Range, "selection type kind must be 'any', 'scalar', or 'pointer'"); return std::nullopt; } if (Source.Bits > LowLevelType::MaxBitWidth || (Kind != NormalizedSelectionTypeKind::Any && Source.Bits == 0)) { fail(Source.Range, "selection type bit width is invalid for its kind"); return std::nullopt; } return NormalizedSelectionTypePredicate{.Kind = Kind, .Bits = Source.Bits}; }; const auto NormalizeRanges = [this](const std::vector &Ranges, TextRange PredicateRange, std::string_view PredicateName) -> std::optional> { if (Ranges.empty()) { fail(PredicateRange, std::string(PredicateName) + " requires at least one range"); return std::nullopt; } std::vector NormalizedRanges; NormalizedRanges.reserve(Ranges.size()); for (const SourceSelectionConstantRange &Range : Ranges) { if (Range.Minimum > Range.Maximum) { fail(Range.SourceRange, std::string(PredicateName) + " range is invalid"); return std::nullopt; } NormalizedRanges.push_back({ .Minimum = Range.Minimum, .Maximum = Range.Maximum, }); } std::ranges::sort(NormalizedRanges, {}, &NormalizedSelectionConstantRange::Minimum); for (std::size_t Index = 1; Index < NormalizedRanges.size(); ++Index) { const auto &Previous = NormalizedRanges[Index - 1]; const auto &Current = NormalizedRanges[Index]; if (Current.Minimum <= Previous.Maximum) { fail(PredicateRange, std::string(PredicateName) + " ranges overlap"); return std::nullopt; } } return NormalizedRanges; }; NormalizedSelectionRule Normalized; Normalized.Symbol = Rule.Symbol; Normalized.Priority = Rule.Priority; Normalized.Specificity = 1; Normalized.MatchOpcode = *MatchOpcode; Normalized.EraseOperandDefinitions = Rule.EraseOperandDefinitions; if (Rule.ResultType) { auto Type = NormalizeType(*Rule.ResultType); if (!Type) return false; if (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, 0)) { fail(Rule.ResultType->Range, "selection result type predicate requires register operand zero"); return false; } Normalized.ResultType = *Type; ++Normalized.Specificity; } if (Rule.IntegerPredicate) { const auto Predicate = integerPredicateValue(Rule.IntegerPredicate->Predicate); if (!Predicate) { fail(Rule.IntegerPredicate->Range, "selection integer predicate is not a recognized integer predicate"); return false; } if (MatchInstruction != nullptr && (Rule.IntegerPredicate->OperandIndex >= MatchInstruction->Operands.size() || !std::ranges::contains( MatchInstruction->Operands[Rule.IntegerPredicate->OperandIndex].Kinds, "Predicate"))) { fail(Rule.IntegerPredicate->Range, "selection integer predicate requires a predicate operand"); return false; } Normalized.IntegerPredicate = { .OperandIndex = Rule.IntegerPredicate->OperandIndex, .Predicate = *Predicate, }; ++Normalized.Specificity; } std::unordered_set TargetPredicateSymbols; for (const SourceSelectionTargetPredicate &Predicate : Rule.TargetPredicates) { if (!isIdentifier(Predicate.Symbol) || !TargetPredicateSymbols.insert(Predicate.Symbol).second) { fail(Predicate.Range, "selection target predicates require distinct identifiers"); return false; } Normalized.TargetPredicates.push_back(Predicate.Symbol); ++Normalized.Specificity; } std::unordered_set TypeOperands; for (const SourceSelectionOperandTypePredicate &Predicate : Rule.OperandTypes) { auto Type = NormalizeType(Predicate.Type); if (!Type) return false; if (!TypeOperands.insert(Predicate.OperandIndex).second || (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, Predicate.OperandIndex))) { fail(Predicate.Range, "selection operand type predicates require distinct register operands"); return false; } Normalized.OperandTypes.push_back({.OperandIndex = Predicate.OperandIndex, .Type = *Type}); ++Normalized.Specificity; } std::unordered_set BankOperands; for (const SourceSelectionOperandBankPredicate &Predicate : Rule.OperandBanks) { const auto Bank = BankBySymbol.find(Predicate.BankSymbol); if (!BankOperands.insert(Predicate.OperandIndex).second || Bank == BankBySymbol.end() || (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, Predicate.OperandIndex))) { fail(Predicate.Range, "selection operand bank predicates require distinct register operands and declared " "banks"); return false; } Normalized.OperandBanks.push_back( {.OperandIndex = Predicate.OperandIndex, .Bank = Bank->second}); ++Normalized.Specificity; } std::unordered_set ClassOperands; for (const SourceSelectionOperandClassPredicate &Predicate : Rule.OperandClasses) { const auto RegClass = ClassBySymbol.find(Predicate.ClassSymbol); if (!ClassOperands.insert(Predicate.OperandIndex).second || RegClass == ClassBySymbol.end() || (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, Predicate.OperandIndex))) { fail(Predicate.Range, "selection operand class predicates require distinct register operands and declared " "classes"); return false; } Normalized.OperandClasses.push_back( {.OperandIndex = Predicate.OperandIndex, .RegClass = RegClass->second}); ++Normalized.Specificity; } std::unordered_set ImmediateOperands; for (const SourceSelectionOperandImmediatePredicate &Predicate : Rule.OperandImmediates) { if (!ImmediateOperands.insert(Predicate.OperandIndex).second) { fail(Predicate.Range, "selection operand immediate predicates require distinct operands"); return false; } auto Ranges = NormalizeRanges(Predicate.Ranges, Predicate.Range, "selection operand immediate predicate"); if (!Ranges) return false; Normalized.OperandImmediates.push_back({ .OperandIndex = Predicate.OperandIndex, .Ranges = std::move(*Ranges), }); ++Normalized.Specificity; } std::unordered_set ConstantOperands; for (const SourceSelectionOperandDefConstantPredicate &Predicate : Rule.OperandDefConstants) { if (!ConstantOperands.insert(Predicate.OperandIndex).second || (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, Predicate.OperandIndex))) { fail(Predicate.Range, "selection operand definition constant predicates require distinct register operands"); return false; } auto Ranges = NormalizeRanges(Predicate.Ranges, Predicate.Range, "selection operand definition constant predicate"); if (!Ranges) return false; Normalized.OperandDefConstants.push_back({ .OperandIndex = Predicate.OperandIndex, .Ranges = std::move(*Ranges), }); ++Normalized.Specificity; } std::unordered_map CaptureIDs; std::unordered_set DefUseRootOperands; for (const SourceSelectionDefUsePredicate &Predicate : Rule.DefUsePredicates) { const auto DefOpcode = resolveOpcode(Result, Predicate.OpcodeSymbol); if (!DefOpcode || !isGenericOpcode(Opcode::fromValue(*DefOpcode)) || !DefUseRootOperands.insert(Predicate.RootOperandIndex).second || (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, Predicate.RootOperandIndex))) { fail(Predicate.Range, "selection def-use predicates require distinct register operands and generic opcodes"); return false; } NormalizedSelectionDefUsePredicate NormalizedPredicate{ .RootOperandIndex = Predicate.RootOperandIndex, .Opcode = *DefOpcode, .Captures = {}, .OperandDefConstants = {}, }; std::unordered_set CapturedOperands; for (const SourceSelectionDefUseCapture &Capture : Predicate.Captures) { if (!isIdentifier(Capture.Symbol) || !CapturedOperands.insert(Capture.OperandIndex).second || !CaptureIDs.emplace(Capture.Symbol, CaptureIDs.size() + 1U).second) { fail(Capture.Range, "selection def-use captures require unique identifiers and distinct operands"); return false; } NormalizedPredicate.Captures.push_back({ .ID = CaptureIDs.at(Capture.Symbol), .OperandIndex = Capture.OperandIndex, }); } std::unordered_set ConstantOperandsInDef; for (const SourceSelectionOperandDefConstantPredicate &Constant : Predicate.OperandDefConstants) { if (!ConstantOperandsInDef.insert(Constant.OperandIndex).second) { fail(Constant.Range, "selection def-use constant predicates require distinct operands"); return false; } auto Ranges = NormalizeRanges(Constant.Ranges, Constant.Range, "selection def-use constant predicate"); if (!Ranges) return false; NormalizedPredicate.OperandDefConstants.push_back({ .OperandIndex = Constant.OperandIndex, .Ranges = std::move(*Ranges), }); } Normalized.DefUsePredicates.push_back(std::move(NormalizedPredicate)); Normalized.Specificity += 1U + static_cast(Predicate.Captures.size()) + static_cast(Predicate.OperandDefConstants.size()); } std::unordered_map TemporaryIDs; for (const SourceSelectionTemporary &Temporary : Rule.Temporaries) { if (!isIdentifier(Temporary.Symbol) || !TemporaryIDs.emplace(Temporary.Symbol, TemporaryIDs.size() + 1U).second || (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, Temporary.TypeFromOperand))) { fail(Temporary.Range, "selection temporary requires a unique identifier and a register type source"); return false; } Normalized.Temporaries.push_back({ .ID = TemporaryIDs.at(Temporary.Symbol), .TypeFromOperand = Temporary.TypeFromOperand, }); } bool HasRootAction = false; for (std::size_t ActionIndex = 0; ActionIndex < Rule.Actions.size(); ++ActionIndex) { const SourceSelectionAction &Action = Rule.Actions[ActionIndex]; const auto ResultOpcode = resolveOpcode(Result, Action.ResultOpcodeSymbol); const NormalizedInstruction *ResultInstruction = findInstructionBySymbol(Result, Action.ResultOpcodeSymbol); const bool IsCorePseudo = ResultOpcode && isCorePseudoOpcode(Opcode::fromValue(*ResultOpcode)); if (!ResultOpcode || (ResultInstruction == nullptr && !IsCorePseudo) || (ResultInstruction != nullptr && (isGenericOpcode(Opcode::fromValue(*ResultOpcode)) || std::ranges::contains(ResultInstruction->Flags, "Generic")))) { fail(Action.Range, "selection instruction opcode must name a declared target instruction or core pseudo"); return false; } if (Action.ReplacesRoot == HasRootAction || (Action.ReplacesRoot && ActionIndex != 0)) { fail(Action.Range, "selection instructions require exactly one root replacement as their first action"); return false; } HasRootAction |= Action.ReplacesRoot; if (ResultInstruction != nullptr && ResultInstruction->Operands.size() != Action.OperandRenderers.size()) { fail(Action.Range, "selection instruction has an incompatible operand count"); return false; } NormalizedSelectionAction NormalizedAction{ .ResultOpcode = *ResultOpcode, .ReplacesRoot = Action.ReplacesRoot, .OperandRenderers = {}, }; NormalizedAction.OperandRenderers.reserve(Action.OperandRenderers.size()); for (const SourceSelectionOperandRenderer &Renderer : Action.OperandRenderers) { if (Renderer.ComplexOperandIndex) { if (Renderer.ComplexRendererSymbol.empty() || !Renderer.Flags.empty() || Renderer.ImmediateTransform != "identity") { fail(Renderer.Range, "selection complex operand renderer requires a matcher and no flags or transform"); return false; } NormalizedAction.OperandRenderers.push_back({ .SourceKind = NormalizedSelectionOperandRenderer::Kind::ComplexOperand, .Value = *Renderer.ComplexOperandIndex, .ComplexRenderer = Renderer.ComplexRendererSymbol, .Flags = 0, }); continue; } if (Renderer.OperandIndex) { if (MatchInstruction != nullptr && *Renderer.OperandIndex >= MatchInstruction->Operands.size()) { fail(Renderer.Range, "selection operand renderer references an unknown operand"); return false; } if (!Renderer.Flags.empty()) { fail(Renderer.Range, "selection operand renderer cannot replace source register flags"); return false; } NormalizedAction.OperandRenderers.push_back({ .SourceKind = NormalizedSelectionOperandRenderer::Kind::Operand, .Value = *Renderer.OperandIndex, .ComplexRenderer = {}, .Flags = 0, }); continue; } if (!Renderer.PhysicalRegisterSymbol.empty()) { const NormalizedRegister *Physical = findRegisterBySymbol(Result, Renderer.PhysicalRegisterSymbol); const auto Flags = registerOperandFlags(Renderer.Flags); if (Physical == nullptr || Physical->ID == 0 || !Flags || !validRegisterOperandFlags(*Flags)) { fail(Renderer.Range, "selection physical register renderer requires a declared register and valid " "register flags"); return false; } NormalizedAction.OperandRenderers.push_back({ .SourceKind = NormalizedSelectionOperandRenderer::Kind::PhysicalRegister, .Value = Physical->ID, .ComplexRenderer = {}, .Flags = Flags->rawValue(), }); continue; } if (!Renderer.TemporarySymbol.empty()) { const auto Temporary = TemporaryIDs.find(Renderer.TemporarySymbol); const auto Flags = registerOperandFlags(Renderer.Flags); if (Temporary == TemporaryIDs.end() || !Flags || !validRegisterOperandFlags(*Flags)) { fail(Renderer.Range, "selection temporary renderer requires a declared temporary and valid register " "flags"); return false; } NormalizedAction.OperandRenderers.push_back({ .SourceKind = NormalizedSelectionOperandRenderer::Kind::Temporary, .Value = Temporary->second, .ComplexRenderer = {}, .Flags = Flags->rawValue(), }); continue; } if (!Renderer.CapturedOperandSymbol.empty()) { const auto Capture = CaptureIDs.find(Renderer.CapturedOperandSymbol); if (Capture == CaptureIDs.end() || !Renderer.Flags.empty() || Renderer.ImmediateTransform != "identity") { fail(Renderer.Range, "selection captured operand renderer requires a matched capture and no flags"); return false; } NormalizedAction.OperandRenderers.push_back({ .SourceKind = NormalizedSelectionOperandRenderer::Kind::CapturedOperand, .Value = Capture->second, .ComplexRenderer = {}, .Flags = 0, }); continue; } if (Renderer.CapturedImmediateOperand) { const auto Transform = [&Renderer]() -> std::optional { if (Renderer.ImmediateTransform == "identity") return NormalizedSelectionImmediateTransform::Identity; if (Renderer.ImmediateTransform == "negate") return NormalizedSelectionImmediateTransform::Negate; if (Renderer.ImmediateTransform == "plus_one") return NormalizedSelectionImmediateTransform::PlusOne; return std::nullopt; }(); if (!ConstantOperands.contains(*Renderer.CapturedImmediateOperand) || !Transform || !Renderer.Flags.empty()) { fail(Renderer.Range, "selection captured immediate renderer requires a matched constant and known " "transform"); return false; } NormalizedAction.OperandRenderers.push_back({ .SourceKind = NormalizedSelectionOperandRenderer::Kind::CapturedImmediate, .Value = *Renderer.CapturedImmediateOperand, .ComplexRenderer = {}, .Flags = 0, .Transform = *Transform, }); continue; } if (Renderer.Immediate) { if (!Renderer.Flags.empty() || Renderer.ImmediateTransform != "identity") { fail(Renderer.Range, "selection immediate renderer cannot carry register flags"); return false; } NormalizedAction.OperandRenderers.push_back({ .SourceKind = NormalizedSelectionOperandRenderer::Kind::Immediate, .Value = 0, .ComplexRenderer = {}, .Flags = 0, .Immediate = *Renderer.Immediate, }); continue; } fail(Renderer.Range, "selection operand renderer has no normalized source"); return false; } Normalized.Actions.push_back(std::move(NormalizedAction)); } if (!HasRootAction) { fail(Rule.Range, "selection instructions require exactly one root replacement"); return false; } std::unordered_set ErasedOperands; for (const std::uint32_t OperandIndex : Rule.EraseOperandDefinitions) { if (!ErasedOperands.insert(OperandIndex).second || (MatchInstruction != nullptr && !isRegisterOperand(*MatchInstruction, OperandIndex))) { fail(Rule.Range, "selection erased definitions require distinct register operands"); return false; } if (!ConstantOperands.contains(OperandIndex) && !DefUseRootOperands.contains(OperandIndex)) { fail(Rule.Range, "selection erased definition requires a matched constant or def-use operand"); return false; } } Result.SelectionRules.push_back(std::move(Normalized)); } std::ranges::sort(Result.SelectionRules, [](const NormalizedSelectionRule &Left, const NormalizedSelectionRule &Right) { if (Left.Priority != Right.Priority) return Left.Priority > Right.Priority; if (Left.Specificity != Right.Specificity) return Left.Specificity > Right.Specificity; return Left.Symbol < Right.Symbol; }); return true; } } // namespace rcc::targetgen