14#ifndef LLVM_PASSES_CODEGENPASSBUILDER_H
15#define LLVM_PASSES_CODEGENPASSBUILDER_H
83#define DUMMY_FUNCTION_PASS(NAME, PASS_NAME) \
84 struct PASS_NAME : public PassInfoMixin<PASS_NAME> { \
85 template <typename... Ts> PASS_NAME(Ts &&...) {} \
86 PreservedAnalyses run(Function &, FunctionAnalysisManager &) { \
87 return PreservedAnalyses::all(); \
90#define DUMMY_MACHINE_MODULE_PASS(NAME, PASS_NAME) \
91 struct PASS_NAME : public PassInfoMixin<PASS_NAME> { \
92 template <typename... Ts> PASS_NAME(Ts &&...) {} \
93 PreservedAnalyses run(Module &, ModuleAnalysisManager &) { \
94 return PreservedAnalyses::all(); \
97#define DUMMY_MACHINE_FUNCTION_PASS(NAME, PASS_NAME) \
98 struct PASS_NAME : public PassInfoMixin<PASS_NAME> { \
99 template <typename... Ts> PASS_NAME(Ts &&...) {} \
100 PreservedAnalyses run(MachineFunction &, \
101 MachineFunctionAnalysisManager &) { \
102 return PreservedAnalyses::all(); \
105#include "llvm/Passes/MachinePassRegistry.def"
143 template <
typename PassT>
145 std::declval<Module &>(), std::declval<ModuleAnalysisManager &>()));
147 template <
typename PassT>
149 std::declval<Function &>(), std::declval<FunctionAnalysisManager &>()));
151 template <
typename PassT>
153 std::declval<MachineFunction &>(),
154 std::declval<MachineFunctionAnalysisManager &>()));
168 template <
typename PassT>
172 "Only module pass and function pass are supported.");
174 if (!PB.runBeforeAdding(
Name))
212 template <
typename PassT>
217 "Only module pass and function pass are supported.");
219 if (!Force && !PB.runBeforeAdding(
Name))
236 for (
auto &
C : PB.AfterCallbacks)
250 template <
typename TMC> TMC &
getTM()
const {
return static_cast<TMC &
>(
TM); }
270 return make_error<StringError>(
"addInstSelector is not overridden",
338 return make_error<StringError>(
"addIRTranslator is not overridden",
349 return make_error<StringError>(
"addLegalizeMachineIR is not overridden",
361 return make_error<StringError>(
"addRegBankSelect is not overridden",
374 return make_error<StringError>(
375 "addGlobalInstructionSelect is not overridden",
440 std::function<Expected<std::unique_ptr<MCStreamer>>(
MCContext &)>;
464 BeforeCallbacks.emplace_back(
470 template <
typename TargetPassT,
typename InsertedPassT>
472 AfterCallbacks.emplace_back(
474 if (
Name == TargetPassT::name())
480 DerivedT &derived() {
return static_cast<DerivedT &
>(*this); }
481 const DerivedT &derived()
const {
482 return static_cast<const DerivedT &
>(*this);
485 bool runBeforeAdding(StringRef
Name)
const {
486 bool ShouldAdd =
true;
487 for (
auto &
C : BeforeCallbacks)
488 ShouldAdd &=
C(
Name);
492 void setStartStopPasses(
const TargetPassConfig::StartStopInfo &
Info)
const;
494 Error verifyStartStop(
const TargetPassConfig::StartStopInfo &
Info)
const;
503 mutable bool Started =
true;
504 mutable bool Stopped =
true;
507template <
typename Derived,
typename TargetMachineT>
513 return StartStopInfo.takeError();
514 setStartStopPasses(*StartStopInfo);
524 addISelPasses(addIRPass);
532 if (
auto Err = addCoreISelPasses(addPass))
533 return std::move(Err);
535 if (
auto Err = derived().addMachinePasses(addPass))
536 return std::move(Err);
539 derived().addAsmPrinter(
540 addPass, [
this, &Out, DwoOut, FileType](
MCContext &Ctx) {
541 return this->TM.createMCStreamer(Out, DwoOut, FileType, Ctx);
548 return verifyStartStop(*StartStopInfo);
551template <
typename Derived,
typename TargetMachineT>
554 if (!
Info.StartPass.empty()) {
556 BeforeCallbacks.emplace_back([
this, &
Info, AfterFlag =
Info.StartAfter,
557 Count = 0u](
StringRef ClassName)
mutable {
558 if (Count == Info.StartInstanceNum) {
568 Started = !
Info.StartAfter;
574 if (!
Info.StopPass.empty()) {
576 BeforeCallbacks.emplace_back([
this, &
Info, AfterFlag =
Info.StopAfter,
577 Count = 0u](StringRef ClassName)
mutable {
578 if (Count == Info.StopInstanceNum) {
588 Stopped = !
Info.StopAfter;
594template <
typename Derived,
typename TargetMachineT>
595Error CodeGenPassBuilder<Derived, TargetMachineT>::verifyStartStop(
596 const TargetPassConfig::StartStopInfo &
Info)
const {
597 if (Started && Stopped)
598 return Error::success();
601 return make_error<StringError>(
602 "Can't find start pass \"" +
603 PIC->getPassNameForClassName(
Info.StartPass) +
"\".",
604 std::make_error_code(std::errc::invalid_argument));
606 return make_error<StringError>(
607 "Can't find stop pass \"" +
608 PIC->getPassNameForClassName(
Info.StopPass) +
"\".",
609 std::make_error_code(std::errc::invalid_argument));
610 return Error::success();
613template <
typename Derived,
typename TargetMachineT>
617 if (
TM.useEmulatedTLS())
622 derived().addIRPasses(addPass);
623 derived().addCodeGenPrepare(addPass);
624 addPassesToHandleExceptions(addPass);
625 derived().addISelPrepare(addPass);
630template <
typename Derived,
typename TargetMachineT>
639 if (getOptLevel() != CodeGenOptLevel::None && !Opt.
DisableLSR) {
647 if (getOptLevel() != CodeGenOptLevel::None) {
672 if (getOptLevel() != CodeGenOptLevel::None)
675 if (getOptLevel() != CodeGenOptLevel::None &&
697template <
typename Derived,
typename TargetMachineT>
701 assert(MCAI &&
"No MCAsmInfo");
703 case ExceptionHandling::SjLj:
712 case ExceptionHandling::DwarfCFI:
713 case ExceptionHandling::ARM:
714 case ExceptionHandling::AIX:
715 case ExceptionHandling::ZOS:
718 case ExceptionHandling::WinEH:
725 case ExceptionHandling::Wasm:
733 case ExceptionHandling::None:
744template <
typename Derived,
typename TargetMachineT>
747 if (getOptLevel() != CodeGenOptLevel::None && !Opt.
DisableCGP)
755template <
typename Derived,
typename TargetMachineT>
768 "\n\n*** Final LLVM Code input to ISel ***\n"));
776template <
typename Derived,
typename TargetMachineT>
784 SelectorType Selector;
787 Selector = SelectorType::FastISel;
790 (
TM.Options.EnableGlobalISel &&
793 Selector = SelectorType::GlobalISel;
794 else if (
TM.getOptLevel() == CodeGenOptLevel::None &&
TM.getO0WantsFastISel())
795 Selector = SelectorType::FastISel;
797 Selector = SelectorType::SelectionDAG;
800 if (Selector == SelectorType::FastISel) {
801 TM.setFastISel(
true);
802 TM.setGlobalISel(
false);
803 }
else if (Selector == SelectorType::GlobalISel) {
804 TM.setFastISel(
false);
805 TM.setGlobalISel(
true);
809 if (Selector == SelectorType::GlobalISel) {
810 if (
auto Err = derived().addIRTranslator(addPass))
811 return std::move(Err);
813 derived().addPreLegalizeMachineIR(addPass);
815 if (
auto Err = derived().addLegalizeMachineIR(addPass))
816 return std::move(Err);
820 derived().addPreRegBankSelect(addPass);
822 if (
auto Err = derived().addRegBankSelect(addPass))
823 return std::move(Err);
825 derived().addPreGlobalInstructionSelect(addPass);
827 if (
auto Err = derived().addGlobalInstructionSelect(addPass))
828 return std::move(Err);
831 addPass(ResetMachineFunctionPass(reportDiagnosticWhenGlobalISelFallback(),
832 isGlobalISelAbortEnabled()));
836 if (!isGlobalISelAbortEnabled())
837 if (
auto Err = derived().addInstSelector(addPass))
838 return std::move(Err);
840 }
else if (
auto Err = derived().addInstSelector(addPass))
841 return std::move(Err);
845 addPass(FinalizeISelPass());
850 return Error::success();
869template <
typename Derived,
typename TargetMachineT>
873 if (getOptLevel() != CodeGenOptLevel::None) {
878 addPass(LocalStackSlotPass());
881 if (
TM.Options.EnableIPRA)
882 addPass(RegUsageInfoPropagationPass());
885 derived().addPreRegAlloc(addPass);
890 derived().addOptimizedRegAlloc(addPass);
892 if (
auto Err = derived().addFastRegAlloc(addPass))
897 derived().addPostRegAlloc(addPass);
899 addPass(RemoveRedundantDebugValuesPass());
902 if (getOptLevel() != CodeGenOptLevel::None) {
903 addPass(PostRAMachineSinkingPass());
904 addPass(ShrinkWrapPass());
907 addPass(PrologEpilogInserterPass());
910 if (getOptLevel() != CodeGenOptLevel::None)
911 derived().addMachineLateOptimization(addPass);
914 addPass(ExpandPostRAPseudosPass());
917 derived().addPreSched2(addPass);
920 addPass(ImplicitNullChecksPass());
925 if (getOptLevel() != CodeGenOptLevel::None &&
926 !
TM.targetSchedulesPostRAScheduling()) {
928 addPass(PostMachineSchedulerPass());
930 addPass(PostRASchedulerPass());
934 derived().addGCPasses(addPass);
937 if (getOptLevel() != CodeGenOptLevel::None)
938 derived().addBlockPlacement(addPass);
941 addPass(FEntryInserterPass());
943 addPass(XRayInstrumentationPass());
944 addPass(PatchableFunctionPass());
946 derived().addPreEmitPass(addPass);
948 if (
TM.Options.EnableIPRA)
951 addPass(RegUsageInfoCollectorPass());
953 addPass(FuncletLayoutPass());
955 addPass(StackMapLivenessPass());
956 addPass(LiveDebugValuesPass());
957 addPass(MachineSanitizerBinaryMetadata());
959 if (
TM.Options.EnableMachineOutliner &&
960 getOptLevel() != CodeGenOptLevel::None &&
962 bool RunOnAllFunctions =
964 bool AddOutliner = RunOnAllFunctions ||
TM.Options.SupportsDefaultOutlining;
966 addPass(MachineOutlinerPass(RunOnAllFunctions));
970 derived().addPreEmitPass2(addPass);
972 return Error::success();
976template <
typename Derived,
typename TargetMachineT>
980 addPass(EarlyTailDuplicatePass());
984 addPass(OptimizePHIsPass());
988 addPass(StackColoringPass());
992 addPass(LocalStackSlotPass());
1003 derived().addILPOpts(addPass);
1005 addPass(EarlyMachineLICMPass());
1006 addPass(MachineCSEPass());
1008 addPass(MachineSinkingPass());
1010 addPass(PeepholeOptimizerPass());
1028template <
typename Derived,
typename TargetMachineT>
1032 addPass(RAGreedyPass());
1034 addPass(RAFastPass());
1040template <
typename Derived,
typename TargetMachineT>
1046template <
typename Derived,
typename TargetMachineT>
1050 addRegAllocPass(addPass,
false);
1051 return Error::success();
1054template <
typename Derived,
typename TargetMachineT>
1058 addRegAllocPass(addPass,
true);
1061 derived().addPreRewrite(addPass);
1064 addPass(VirtRegRewriterPass());
1069 addPass(StackSlotColoringPass());
1071 return Error::success();
1076template <
typename Derived,
typename TargetMachineT>
1079 addPass(PHIEliminationPass());
1080 addPass(TwoAddressInstructionPass());
1081 return derived().addRegAssignmentFast(addPass);
1087template <
typename Derived,
typename TargetMachineT>
1090 addPass(DetectDeadLanesPass());
1092 addPass(InitUndefPass());
1094 addPass(ProcessImplicitDefsPass());
1097 addPass(PHIEliminationPass());
1101 addPass(LiveIntervalsPass());
1103 addPass(TwoAddressInstructionPass());
1104 addPass(RegisterCoalescerPass());
1109 addPass(RenameIndependentSubregsPass());
1112 addPass(MachineSchedulerPass());
1114 if (derived().addRegAssignmentOptimized(addPass)) {
1117 derived().addPostRewrite(addPass);
1121 addPass(MachineCopyPropagationPass());
1126 addPass(MachineLICMPass());
1135template <
typename Derived,
typename TargetMachineT>
1139 addPass(BranchFolderPass());
1145 if (!
TM.requiresStructuredCFG())
1146 addPass(TailDuplicatePass());
1149 addPass(MachineLateInstrsCleanupPass());
1152 addPass(MachineCopyPropagationPass());
1156template <
typename Derived,
typename TargetMachineT>
1159 addPass(MachineBlockPlacementPass());
1162 addPass(MachineBlockPlacementStatsPass());
This is the interface for LLVM's primary stateless and local alias analysis.
Analysis containing CSE Info
Defines an IR pass for CodeGen Prepare.
This file defines passes to print out IR in various granularities.
This file contains the declaration of the InterleavedAccessPass class, its corresponding pass name is...
This header provides classes for managing a pipeline of passes over loops in LLVM IR.
The header file for the LowerConstantIntrinsics pass as used by the new pass manager.
const char LLVMTargetMachineRef TM
PassInstrumentationCallbacks PIC
PassBuilder PB(Machine, PassOpts->PTO, std::nullopt, &PIC)
This header defines various interfaces for pass management in LLVM.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This is the interface for a metadata-based scoped no-alias analysis.
This file contains the declaration of the SelectOptimizePass class, its corresponding pass name is se...
This file defines the SmallVector class.
Target-Independent Code Generator Pass Configuration Options pass.
This is the interface for a metadata-based TBAA.
static const char PassName[]
AddIRPass(ModulePassManager &MPM, const DerivedT &PB)
void operator()(PassT &&Pass, StringRef Name=PassT::name())
AddMachinePass(ModulePassManager &MPM, const DerivedT &PB)
void operator()(PassT &&Pass, bool Force=false, StringRef Name=PassT::name())
This class provides access to building LLVM's passes.
void addPreRewrite(AddMachinePass &) const
addPreRewrite - Add passes to the optimized register allocation pipeline after register allocation is...
void addPostRegAlloc(AddMachinePass &) const
This method may be implemented by targets that want to run passes after register allocation pass pipe...
void insertPass(InsertedPassT &&Pass)
Insert InsertedPass pass after TargetPass pass.
void addPreGlobalInstructionSelect(AddMachinePass &) const
This method may be implemented by targets that want to run passes immediately before the (global) ins...
Error addRegAssignmentFast(AddMachinePass &) const
Add core register alloator passes which do the actual register assignment and rewriting.
Error addFastRegAlloc(AddMachinePass &) const
addFastRegAlloc - Add the minimum set of target-independent passes that are required for fast registe...
Error addIRTranslator(AddMachinePass &) const
This method should install an IR translator pass, which converts from LLVM code to machine instructio...
void addILPOpts(AddMachinePass &) const
Add passes that optimize instruction level parallelism for out-of-order targets.
void addRegAllocPass(AddMachinePass &, bool Optimized) const
addMachinePasses helper to create the target-selected or overriden regalloc pass.
void addPreSched2(AddMachinePass &) const
This method may be implemented by targets that want to run passes after prolog-epilog insertion and b...
std::function< Expected< std::unique_ptr< MCStreamer > >(MCContext &)> CreateMCStreamer
Error addRegBankSelect(AddMachinePass &) const
This method should install a register bank selector pass, which assigns register banks to virtual reg...
bool isGlobalISelAbortEnabled() const
Check whether or not GlobalISel should abort on error.
void addPreRegAlloc(AddMachinePass &) const
This method may be implemented by targets that want to run passes immediately before register allocat...
void addGCPasses(AddMachinePass &) const
addGCPasses - Add late codegen passes that analyze code for garbage collection.
Error buildPipeline(ModulePassManager &MPM, raw_pwrite_stream &Out, raw_pwrite_stream *DwoOut, CodeGenFileType FileType) const
void addGlobalMergePass(AddIRPass &) const
Target can override this to add GlobalMergePass before all IR passes.
Error addLegalizeMachineIR(AddMachinePass &) const
This method should install a legalize pass, which converts the instruction sequence into one that can...
Error addCoreISelPasses(AddMachinePass &) const
Add the actual instruction selection passes.
void addOptimizedRegAlloc(AddMachinePass &) const
addOptimizedRegAlloc - Add passes related to register allocation.
void addISelPasses(AddIRPass &) const
High level function that adds all passes necessary to go from llvm IR representation to the MI repres...
PassInstrumentationCallbacks * PIC
void addMachineSSAOptimization(AddMachinePass &) const
Methods with trivial inline returns are convenient points in the common codegen pass pipeline where t...
decltype(std::declval< PassT & >().run(std::declval< Module & >(), std::declval< ModuleAnalysisManager & >())) is_module_pass_t
CodeGenPassBuilder(TargetMachineT &TM, const CGPassBuilderOption &Opts, PassInstrumentationCallbacks *PIC)
Error addRegAssignmentOptimized(AddMachinePass &) const
void addCodeGenPrepare(AddIRPass &) const
Add pass to prepare the LLVM IR for code generation.
Error addMachinePasses(AddMachinePass &) const
Add the complete, standard set of LLVM CodeGen passes.
void addISelPrepare(AddIRPass &) const
Add common passes that perform LLVM IR to IR transforms in preparation for instruction selection.
void disablePass()
Allow the target to disable a specific pass by default.
void addBlockPlacement(AddMachinePass &) const
Add standard basic block placement passes.
Error addInstSelector(AddMachinePass &) const
addInstSelector - This method should install an instruction selector pass, which converts from LLVM c...
void addTargetRegisterAllocator(AddMachinePass &, bool Optimized) const
Utilities for targets to add passes to the pass manager.
void addPreEmitPass2(AddMachinePass &) const
Targets may add passes immediately before machine code is emitted in this callback.
void addPostRewrite(AddMachinePass &) const
Add passes to be run immediately after virtual registers are rewritten to physical registers.
void addPreRegBankSelect(AddMachinePass &) const
This method may be implemented by targets that want to run passes immediately before the register ban...
void addPreEmitPass(AddMachinePass &) const
This pass may be implemented by targets that want to run passes immediately before machine code is em...
Error addGlobalInstructionSelect(AddMachinePass &) const
This method should install a (global) instruction selector pass, which converts possibly generic inst...
void addMachineLateOptimization(AddMachinePass &) const
Add passes that optimize machine instructions after register allocation.
void addIRPasses(AddIRPass &) const
Add common target configurable passes that perform LLVM IR to IR transforms following machine indepen...
decltype(std::declval< PassT & >().run(std::declval< Function & >(), std::declval< FunctionAnalysisManager & >())) is_function_pass_t
decltype(std::declval< PassT & >().run(std::declval< MachineFunction & >(), std::declval< MachineFunctionAnalysisManager & >())) is_machine_function_pass_t
void addPreLegalizeMachineIR(AddMachinePass &) const
This method may be implemented by targets that want to run passes immediately before legalization.
CodeGenOptLevel getOptLevel() const
void addPassesToHandleExceptions(AddIRPass &) const
Add passes to lower exception handling for the code generator.
PassInstrumentationCallbacks * getPassInstrumentationCallbacks() const
bool reportDiagnosticWhenGlobalISelFallback() const
Check whether or not a diagnostic should be emitted when GlobalISel uses the fallback path.
void addPreISel(AddIRPass &) const
{{@ For GlobalISel
void addAsmPrinter(AddMachinePass &, CreateMCStreamer) const
Lightweight error class with error context and mandatory checking.
This is a fast-path instruction selection class that generates poor code and doesn't support illegal ...
LowerIntrinsics - This pass rewrites calls to the llvm.gcread or llvm.gcwrite intrinsics,...
Performs Loop Strength Reduce Pass.
This class is intended to be used as a base class for asm properties and features specific to the tar...
ExceptionHandling getExceptionHandlingType() const
Context object for machine code objects.
This class manages callbacks registration, as well as provides a way for PassInstrumentation to pass ...
StringRef getPassNameForClassName(StringRef ClassName)
Get the pass name for a given pass class name.
LLVM_ATTRIBUTE_MINSIZE void addPass(PassT &&Pass)
bool isEmpty() const
Returns if the pass manager contains any passes.
Pass interface - Implemented by all 'passes'.
Pass (for the new pass manager) for printing a Function as LLVM's text IR assembly.
This is used to represent a portion of an LLVM function in a low-level Data Dependence DAG representa...
StringRef - Represent a constant reference to a string, i.e.
static Expected< StartStopInfo > getStartStopInfo(PassInstrumentationCallbacks &PIC)
Returns pass name in -stop-before or -stop-after NOTE: New pass manager migration only.
static bool willCompleteCodeGenPipeline()
Returns true if none of the -stop-before and -stop-after options is set.
An abstract base class for streams implementations that also support a pwrite operation.
unique_function is a type-erasing functor similar to std::function.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ C
The default llvm calling convention, compatible with C.
This is an optimization pass for GlobalISel generic memory operations.
PassManager< Function > FunctionPassManager
Convenience typedef for a pass manager over functions.
ModuleToFunctionPassAdaptor createModuleToFunctionPassAdaptor(FunctionPassT &&Pass, bool EagerlyInvalidate=false)
A function to deduce a function pass type and wrap it in the templated adaptor.
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
PassManager< MachineFunction > MachineFunctionPassManager
Convenience typedef for a pass manager over functions.
typename detail::detector< void, Op, Args... >::value_t is_detected
Detects if a given trait holds for some set of arguments 'Args'.
CodeGenFileType
These enums are meant to be passed into addPassesToEmitFile to indicate what type of file to emit,...
FunctionToMachineFunctionPassAdaptor createFunctionToMachineFunctionPassAdaptor(MachineFunctionPassT &&Pass)
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
CodeGenOptLevel
Code generation optimization level.
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
std::enable_if_t< is_detected< HasRunOnLoopT, LoopPassT >::value, FunctionToLoopPassAdaptor > createFunctionToLoopPassAdaptor(LoopPassT &&Pass, bool UseMemorySSA=false, bool UseBlockFrequencyInfo=false, bool UseBranchProbabilityInfo=false)
A function to deduce a loop pass type and wrap it in the templated adaptor.
bool DisablePartialLibcallInlining
std::optional< bool > EnableGlobalISelOption
std::optional< bool > EnableIPRA
bool DisableConstantHoisting
std::optional< bool > OptimizeRegAlloc
RunOutliner EnableMachineOutliner
std::optional< bool > EnableFastISelOption
std::optional< GlobalISelAbortMode > EnableGlobalISelAbort
bool EnableImplicitNullChecks
bool EnableBlockPlacementStats
bool DisableSelectOptimize
A no-op pass template which simply forces a specific analysis result to be invalidated.
A utility pass template to force an analysis result to be available.