235 lines
9 KiB
C++
235 lines
9 KiB
C++
|
//===------ MacroFusionPredicatorEmitter.cpp - Generator for Fusion ------===//
|
||
|
//
|
||
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
||
|
// See https://llvm.org/LICENSE.txt for license information.
|
||
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||
|
//
|
||
|
//===---------------------------------------------------------------------===//
|
||
|
//
|
||
|
// MacroFusionPredicatorEmitter implements a TableGen-driven predicators
|
||
|
// generator for macro-op fusions.
|
||
|
//
|
||
|
// This TableGen backend processes `Fusion` definitions and generates
|
||
|
// predicators for checking if input instructions can be fused. These
|
||
|
// predicators can used in `MacroFusion` DAG mutation.
|
||
|
//
|
||
|
// The generated header file contains two parts: one for predicator
|
||
|
// declarations and one for predicator implementations. The user can get them
|
||
|
// by defining macro `GET_<TargetName>_MACRO_FUSION_PRED_DECL` or
|
||
|
// `GET_<TargetName>_MACRO_FUSION_PRED_IMPL` and then including the generated
|
||
|
// header file.
|
||
|
//
|
||
|
// The generated predicator will be like:
|
||
|
//
|
||
|
// ```
|
||
|
// bool isNAME(const TargetInstrInfo &TII,
|
||
|
// const TargetSubtargetInfo &STI,
|
||
|
// const MachineInstr *FirstMI,
|
||
|
// const MachineInstr &SecondMI) {
|
||
|
// auto &MRI = SecondMI.getMF()->getRegInfo();
|
||
|
// /* Predicates */
|
||
|
// return true;
|
||
|
// }
|
||
|
// ```
|
||
|
//
|
||
|
// The `Predicates` part is generated from a list of `FusionPredicate`, which
|
||
|
// can be predefined predicates, a raw code string or `MCInstPredicate` defined
|
||
|
// in TargetInstrPredicate.td.
|
||
|
//
|
||
|
//===---------------------------------------------------------------------===//
|
||
|
|
||
|
#include "CodeGenTarget.h"
|
||
|
#include "PredicateExpander.h"
|
||
|
#include "llvm/ADT/SmallVector.h"
|
||
|
#include "llvm/Support/Debug.h"
|
||
|
#include "llvm/TableGen/Error.h"
|
||
|
#include "llvm/TableGen/Record.h"
|
||
|
#include "llvm/TableGen/TableGenBackend.h"
|
||
|
#include <set>
|
||
|
#include <vector>
|
||
|
|
||
|
using namespace llvm;
|
||
|
|
||
|
#define DEBUG_TYPE "macro-fusion-predicator"
|
||
|
|
||
|
namespace {
|
||
|
class MacroFusionPredicatorEmitter {
|
||
|
RecordKeeper &Records;
|
||
|
CodeGenTarget Target;
|
||
|
|
||
|
void emitMacroFusionDecl(std::vector<Record *> Fusions, PredicateExpander &PE,
|
||
|
raw_ostream &OS);
|
||
|
void emitMacroFusionImpl(std::vector<Record *> Fusions, PredicateExpander &PE,
|
||
|
raw_ostream &OS);
|
||
|
void emitPredicates(std::vector<Record *> &FirstPredicate,
|
||
|
PredicateExpander &PE, raw_ostream &OS);
|
||
|
void emitFirstPredicate(Record *SecondPredicate, PredicateExpander &PE,
|
||
|
raw_ostream &OS);
|
||
|
void emitSecondPredicate(Record *SecondPredicate, PredicateExpander &PE,
|
||
|
raw_ostream &OS);
|
||
|
void emitBothPredicate(Record *Predicates, PredicateExpander &PE,
|
||
|
raw_ostream &OS);
|
||
|
|
||
|
public:
|
||
|
MacroFusionPredicatorEmitter(RecordKeeper &R) : Records(R), Target(R) {}
|
||
|
|
||
|
void run(raw_ostream &OS);
|
||
|
};
|
||
|
} // End anonymous namespace.
|
||
|
|
||
|
void MacroFusionPredicatorEmitter::emitMacroFusionDecl(
|
||
|
std::vector<Record *> Fusions, PredicateExpander &PE, raw_ostream &OS) {
|
||
|
OS << "#ifdef GET_" << Target.getName() << "_MACRO_FUSION_PRED_DECL\n";
|
||
|
OS << "#undef GET_" << Target.getName() << "_MACRO_FUSION_PRED_DECL\n\n";
|
||
|
OS << "namespace llvm {\n";
|
||
|
|
||
|
for (Record *Fusion : Fusions) {
|
||
|
OS << "bool is" << Fusion->getName() << "(const TargetInstrInfo &, "
|
||
|
<< "const TargetSubtargetInfo &, "
|
||
|
<< "const MachineInstr *, "
|
||
|
<< "const MachineInstr &);\n";
|
||
|
}
|
||
|
|
||
|
OS << "} // end namespace llvm\n";
|
||
|
OS << "\n#endif\n";
|
||
|
}
|
||
|
|
||
|
void MacroFusionPredicatorEmitter::emitMacroFusionImpl(
|
||
|
std::vector<Record *> Fusions, PredicateExpander &PE, raw_ostream &OS) {
|
||
|
OS << "#ifdef GET_" << Target.getName() << "_MACRO_FUSION_PRED_IMPL\n";
|
||
|
OS << "#undef GET_" << Target.getName() << "_MACRO_FUSION_PRED_IMPL\n\n";
|
||
|
OS << "namespace llvm {\n";
|
||
|
|
||
|
for (Record *Fusion : Fusions) {
|
||
|
std::vector<Record *> Predicates =
|
||
|
Fusion->getValueAsListOfDefs("Predicates");
|
||
|
|
||
|
OS << "bool is" << Fusion->getName() << "(\n";
|
||
|
OS.indent(4) << "const TargetInstrInfo &TII,\n";
|
||
|
OS.indent(4) << "const TargetSubtargetInfo &STI,\n";
|
||
|
OS.indent(4) << "const MachineInstr *FirstMI,\n";
|
||
|
OS.indent(4) << "const MachineInstr &SecondMI) {\n";
|
||
|
OS.indent(2) << "auto &MRI = SecondMI.getMF()->getRegInfo();\n";
|
||
|
|
||
|
emitPredicates(Predicates, PE, OS);
|
||
|
|
||
|
OS.indent(2) << "return true;\n";
|
||
|
OS << "}\n";
|
||
|
}
|
||
|
|
||
|
OS << "} // end namespace llvm\n";
|
||
|
OS << "\n#endif\n";
|
||
|
}
|
||
|
|
||
|
void MacroFusionPredicatorEmitter::emitPredicates(
|
||
|
std::vector<Record *> &Predicates, PredicateExpander &PE, raw_ostream &OS) {
|
||
|
for (Record *Predicate : Predicates) {
|
||
|
Record *Target = Predicate->getValueAsDef("Target");
|
||
|
if (Target->getName() == "first_fusion_target")
|
||
|
emitFirstPredicate(Predicate, PE, OS);
|
||
|
else if (Target->getName() == "second_fusion_target")
|
||
|
emitSecondPredicate(Predicate, PE, OS);
|
||
|
else if (Target->getName() == "both_fusion_target")
|
||
|
emitBothPredicate(Predicate, PE, OS);
|
||
|
else
|
||
|
PrintFatalError(Target->getLoc(),
|
||
|
"Unsupported 'FusionTarget': " + Target->getName());
|
||
|
}
|
||
|
}
|
||
|
|
||
|
void MacroFusionPredicatorEmitter::emitFirstPredicate(Record *Predicate,
|
||
|
PredicateExpander &PE,
|
||
|
raw_ostream &OS) {
|
||
|
if (Predicate->isSubClassOf("WildcardPred")) {
|
||
|
OS.indent(2) << "if (!FirstMI)\n";
|
||
|
OS.indent(2) << " return "
|
||
|
<< (Predicate->getValueAsBit("ReturnValue") ? "true" : "false")
|
||
|
<< ";\n";
|
||
|
} else if (Predicate->isSubClassOf("OneUsePred")) {
|
||
|
OS.indent(2) << "{\n";
|
||
|
OS.indent(4) << "Register FirstDest = FirstMI->getOperand(0).getReg();\n";
|
||
|
OS.indent(4)
|
||
|
<< "if (FirstDest.isVirtual() && !MRI.hasOneNonDBGUse(FirstDest))\n";
|
||
|
OS.indent(4) << " return false;\n";
|
||
|
OS.indent(2) << "}\n";
|
||
|
} else if (Predicate->isSubClassOf("FusionPredicateWithMCInstPredicate")) {
|
||
|
OS.indent(2) << "{\n";
|
||
|
OS.indent(4) << "const MachineInstr *MI = FirstMI;\n";
|
||
|
OS.indent(4) << "if (";
|
||
|
PE.setNegatePredicate(true);
|
||
|
PE.setIndentLevel(3);
|
||
|
PE.expandPredicate(OS, Predicate->getValueAsDef("Predicate"));
|
||
|
OS << ")\n";
|
||
|
OS.indent(4) << " return false;\n";
|
||
|
OS.indent(2) << "}\n";
|
||
|
} else {
|
||
|
PrintFatalError(Predicate->getLoc(),
|
||
|
"Unsupported predicate for first instruction: " +
|
||
|
Predicate->getType()->getAsString());
|
||
|
}
|
||
|
}
|
||
|
|
||
|
void MacroFusionPredicatorEmitter::emitSecondPredicate(Record *Predicate,
|
||
|
PredicateExpander &PE,
|
||
|
raw_ostream &OS) {
|
||
|
if (Predicate->isSubClassOf("FusionPredicateWithMCInstPredicate")) {
|
||
|
OS.indent(2) << "{\n";
|
||
|
OS.indent(4) << "const MachineInstr *MI = &SecondMI;\n";
|
||
|
OS.indent(4) << "if (";
|
||
|
PE.setNegatePredicate(true);
|
||
|
PE.setIndentLevel(3);
|
||
|
PE.expandPredicate(OS, Predicate->getValueAsDef("Predicate"));
|
||
|
OS << ")\n";
|
||
|
OS.indent(4) << " return false;\n";
|
||
|
OS.indent(2) << "}\n";
|
||
|
} else {
|
||
|
PrintFatalError(Predicate->getLoc(),
|
||
|
"Unsupported predicate for second instruction: " +
|
||
|
Predicate->getType()->getAsString());
|
||
|
}
|
||
|
}
|
||
|
|
||
|
void MacroFusionPredicatorEmitter::emitBothPredicate(Record *Predicate,
|
||
|
PredicateExpander &PE,
|
||
|
raw_ostream &OS) {
|
||
|
if (Predicate->isSubClassOf("FusionPredicateWithCode"))
|
||
|
OS << Predicate->getValueAsString("Predicate");
|
||
|
else if (Predicate->isSubClassOf("BothFusionPredicateWithMCInstPredicate")) {
|
||
|
emitFirstPredicate(Predicate, PE, OS);
|
||
|
emitSecondPredicate(Predicate, PE, OS);
|
||
|
} else if (Predicate->isSubClassOf("TieReg")) {
|
||
|
int FirstOpIdx = Predicate->getValueAsInt("FirstOpIdx");
|
||
|
int SecondOpIdx = Predicate->getValueAsInt("SecondOpIdx");
|
||
|
OS.indent(2) << "if (!(FirstMI->getOperand(" << FirstOpIdx
|
||
|
<< ").isReg() &&\n";
|
||
|
OS.indent(2) << " SecondMI.getOperand(" << SecondOpIdx
|
||
|
<< ").isReg() &&\n";
|
||
|
OS.indent(2) << " FirstMI->getOperand(" << FirstOpIdx
|
||
|
<< ").getReg() == SecondMI.getOperand(" << SecondOpIdx
|
||
|
<< ").getReg()))\n";
|
||
|
OS.indent(2) << " return false;\n";
|
||
|
} else
|
||
|
PrintFatalError(Predicate->getLoc(),
|
||
|
"Unsupported predicate for both instruction: " +
|
||
|
Predicate->getType()->getAsString());
|
||
|
}
|
||
|
|
||
|
void MacroFusionPredicatorEmitter::run(raw_ostream &OS) {
|
||
|
// Emit file header.
|
||
|
emitSourceFileHeader("Macro Fusion Predicators", OS);
|
||
|
|
||
|
PredicateExpander PE(Target.getName());
|
||
|
PE.setByRef(false);
|
||
|
PE.setExpandForMC(false);
|
||
|
|
||
|
std::vector<Record *> Fusions = Records.getAllDerivedDefinitions("Fusion");
|
||
|
// Sort macro fusions by name.
|
||
|
sort(Fusions, LessRecord());
|
||
|
emitMacroFusionDecl(Fusions, PE, OS);
|
||
|
OS << "\n";
|
||
|
emitMacroFusionImpl(Fusions, PE, OS);
|
||
|
}
|
||
|
|
||
|
static TableGen::Emitter::OptClass<MacroFusionPredicatorEmitter>
|
||
|
X("gen-macro-fusion-pred", "Generate macro fusion predicators.");
|