diff options
| -rw-r--r-- | llvm/include/llvm/CodeGen/Passes.h | 960 |
1 files changed, 480 insertions, 480 deletions
diff --git a/llvm/include/llvm/CodeGen/Passes.h b/llvm/include/llvm/CodeGen/Passes.h index d214ab9..428fc35 100644 --- a/llvm/include/llvm/CodeGen/Passes.h +++ b/llvm/include/llvm/CodeGen/Passes.h @@ -14,9 +14,9 @@ #ifndef LLVM_CODEGEN_PASSES_H #define LLVM_CODEGEN_PASSES_H +#include "llvm/CodeGen/RegAllocCommon.h" #include "llvm/Support/CodeGen.h" #include "llvm/Support/Discriminator.h" -#include "llvm/CodeGen/RegAllocCommon.h" #include <functional> #include <string> @@ -36,587 +36,587 @@ namespace vfs { class FileSystem; } // namespace vfs -} // End llvm namespace +} // namespace llvm // List of target independent CodeGen pass IDs. namespace llvm { - /// AtomicExpandPass - At IR level this pass replace atomic instructions with - /// __atomic_* library calls, or target specific instruction which implement the - /// same semantics in a way which better fits the target backend. - FunctionPass *createAtomicExpandLegacyPass(); - - /// createUnreachableBlockEliminationPass - The LLVM code generator does not - /// work well with unreachable basic blocks (what live ranges make sense for a - /// block that cannot be reached?). As such, a code generator should either - /// not instruction select unreachable blocks, or run this pass as its - /// last LLVM modifying pass to clean up blocks that are not reachable from - /// the entry block. - FunctionPass *createUnreachableBlockEliminationPass(); - - /// createGCEmptyBasicblocksPass - Empty basic blocks (basic blocks without - /// real code) appear as the result of optimization passes removing - /// instructions. These blocks confuscate profile analysis (e.g., basic block - /// sections) since they will share the address of their fallthrough blocks. - /// This pass garbage-collects such basic blocks. - MachineFunctionPass *createGCEmptyBasicBlocksPass(); - - /// createBasicBlockSections Pass - This pass assigns sections to machine - /// basic blocks and is enabled with -fbasic-block-sections. - MachineFunctionPass *createBasicBlockSectionsPass(); - - MachineFunctionPass *createBasicBlockPathCloningPass(); +/// AtomicExpandPass - At IR level this pass replace atomic instructions with +/// __atomic_* library calls, or target specific instruction which implement the +/// same semantics in a way which better fits the target backend. +FunctionPass *createAtomicExpandLegacyPass(); + +/// createUnreachableBlockEliminationPass - The LLVM code generator does not +/// work well with unreachable basic blocks (what live ranges make sense for a +/// block that cannot be reached?). As such, a code generator should either +/// not instruction select unreachable blocks, or run this pass as its +/// last LLVM modifying pass to clean up blocks that are not reachable from +/// the entry block. +FunctionPass *createUnreachableBlockEliminationPass(); + +/// createGCEmptyBasicblocksPass - Empty basic blocks (basic blocks without +/// real code) appear as the result of optimization passes removing +/// instructions. These blocks confuscate profile analysis (e.g., basic block +/// sections) since they will share the address of their fallthrough blocks. +/// This pass garbage-collects such basic blocks. +MachineFunctionPass *createGCEmptyBasicBlocksPass(); + +/// createBasicBlockSections Pass - This pass assigns sections to machine +/// basic blocks and is enabled with -fbasic-block-sections. +MachineFunctionPass *createBasicBlockSectionsPass(); + +MachineFunctionPass *createBasicBlockPathCloningPass(); - /// createMachineFunctionSplitterPass - This pass splits machine functions - /// using profile information. - MachineFunctionPass *createMachineFunctionSplitterPass(); +/// createMachineFunctionSplitterPass - This pass splits machine functions +/// using profile information. +MachineFunctionPass *createMachineFunctionSplitterPass(); - /// createStaticDataSplitterPass - This is a machine-function pass that - /// categorizes static data hotness using profile information. - MachineFunctionPass *createStaticDataSplitterPass(); +/// createStaticDataSplitterPass - This is a machine-function pass that +/// categorizes static data hotness using profile information. +MachineFunctionPass *createStaticDataSplitterPass(); - /// createStaticDataAnnotatorPASS - This is a module pass that reads from - /// StaticDataProfileInfoWrapperPass and annotates the section prefix of - /// global variables. - ModulePass *createStaticDataAnnotatorPass(); - - /// MachineFunctionPrinter pass - This pass prints out the machine function to - /// the given stream as a debugging tool. - MachineFunctionPass * - createMachineFunctionPrinterPass(raw_ostream &OS, - const std::string &Banner =""); +/// createStaticDataAnnotatorPASS - This is a module pass that reads from +/// StaticDataProfileInfoWrapperPass and annotates the section prefix of +/// global variables. +ModulePass *createStaticDataAnnotatorPass(); + +/// MachineFunctionPrinter pass - This pass prints out the machine function to +/// the given stream as a debugging tool. +MachineFunctionPass * +createMachineFunctionPrinterPass(raw_ostream &OS, + const std::string &Banner = ""); - /// StackFramePrinter pass - This pass prints out the machine function's - /// stack frame to the given stream as a debugging tool. - MachineFunctionPass *createStackFrameLayoutAnalysisPass(); +/// StackFramePrinter pass - This pass prints out the machine function's +/// stack frame to the given stream as a debugging tool. +MachineFunctionPass *createStackFrameLayoutAnalysisPass(); - /// MIRPrinting pass - this pass prints out the LLVM IR into the given stream - /// using the MIR serialization format. - MachineFunctionPass *createPrintMIRPass(raw_ostream &OS); +/// MIRPrinting pass - this pass prints out the LLVM IR into the given stream +/// using the MIR serialization format. +MachineFunctionPass *createPrintMIRPass(raw_ostream &OS); - /// This pass resets a MachineFunction when it has the FailedISel property - /// as if it was just created. - /// If EmitFallbackDiag is true, the pass will emit a - /// DiagnosticInfoISelFallback for every MachineFunction it resets. - /// If AbortOnFailedISel is true, abort compilation instead of resetting. - MachineFunctionPass *createResetMachineFunctionPass(bool EmitFallbackDiag, - bool AbortOnFailedISel); +/// This pass resets a MachineFunction when it has the FailedISel property +/// as if it was just created. +/// If EmitFallbackDiag is true, the pass will emit a +/// DiagnosticInfoISelFallback for every MachineFunction it resets. +/// If AbortOnFailedISel is true, abort compilation instead of resetting. +MachineFunctionPass *createResetMachineFunctionPass(bool EmitFallbackDiag, + bool AbortOnFailedISel); - /// createCodeGenPrepareLegacyPass - Transform the code to expose more pattern - /// matching during instruction selection. - FunctionPass *createCodeGenPrepareLegacyPass(); +/// createCodeGenPrepareLegacyPass - Transform the code to expose more pattern +/// matching during instruction selection. +FunctionPass *createCodeGenPrepareLegacyPass(); - /// This pass implements generation of target-specific intrinsics to support - /// handling of complex number arithmetic - FunctionPass *createComplexDeinterleavingPass(const TargetMachine *TM); +/// This pass implements generation of target-specific intrinsics to support +/// handling of complex number arithmetic +FunctionPass *createComplexDeinterleavingPass(const TargetMachine *TM); - /// AtomicExpandID -- Lowers atomic operations in terms of either cmpxchg - /// load-linked/store-conditional loops. - extern char &AtomicExpandID; +/// AtomicExpandID -- Lowers atomic operations in terms of either cmpxchg +/// load-linked/store-conditional loops. +extern char &AtomicExpandID; - /// MachineLoopInfo - This pass is a loop analysis pass. - extern char &MachineLoopInfoID; +/// MachineLoopInfo - This pass is a loop analysis pass. +extern char &MachineLoopInfoID; - /// MachineDominators - This pass is a machine dominators analysis pass. - extern char &MachineDominatorsID; - - /// MachineDominanaceFrontier - This pass is a machine dominators analysis. - extern char &MachineDominanceFrontierID; +/// MachineDominators - This pass is a machine dominators analysis pass. +extern char &MachineDominatorsID; + +/// MachineDominanaceFrontier - This pass is a machine dominators analysis. +extern char &MachineDominanceFrontierID; - /// MachineRegionInfo - This pass computes SESE regions for machine functions. - extern char &MachineRegionInfoPassID; - - /// EdgeBundles analysis - Bundle machine CFG edges. - extern char &EdgeBundlesWrapperLegacyID; - - /// LiveVariables pass - This pass computes the set of blocks in which each - /// variable is life and sets machine operand kill flags. - extern char &LiveVariablesID; - - /// PHIElimination - This pass eliminates machine instruction PHI nodes - /// by inserting copy instructions. This destroys SSA information, but is the - /// desired input for some register allocators. This pass is "required" by - /// these register allocator like this: AU.addRequiredID(PHIEliminationID); - extern char &PHIEliminationID; - - /// LiveIntervals - This analysis keeps track of the live ranges of virtual - /// and physical registers. - extern char &LiveIntervalsID; - - /// LiveStacks pass. An analysis keeping track of the liveness of stack slots. - extern char &LiveStacksID; - - /// TwoAddressInstruction - This pass reduces two-address instructions to - /// use two operands. This destroys SSA information but it is desired by - /// register allocators. - extern char &TwoAddressInstructionPassID; - - /// ProcessImpicitDefs pass - This pass removes IMPLICIT_DEFs. - extern char &ProcessImplicitDefsID; - - /// RegisterCoalescer - This pass merges live ranges to eliminate copies. - extern char &RegisterCoalescerID; - - /// MachineScheduler - This pass schedules machine instructions. - extern char &MachineSchedulerID; - - /// PostMachineScheduler - This pass schedules machine instructions postRA. - extern char &PostMachineSchedulerID; - - /// SpillPlacement analysis. Suggest optimal placement of spill code between - /// basic blocks. - extern char &SpillPlacementID; - - /// ShrinkWrap pass. Look for the best place to insert save and restore - // instruction and update the MachineFunctionInfo with that information. - extern char &ShrinkWrapID; - - /// LiveRangeShrink pass. Move instruction close to its definition to shrink - /// the definition's live range. - extern char &LiveRangeShrinkID; - - /// Greedy register allocator. - extern char &RAGreedyLegacyID; - - /// Basic register allocator. - extern char &RABasicID; - - /// VirtRegRewriter pass. Rewrite virtual registers to physical registers as - /// assigned in VirtRegMap. - extern char &VirtRegRewriterID; - FunctionPass *createVirtRegRewriter(bool ClearVirtRegs = true); +/// MachineRegionInfo - This pass computes SESE regions for machine functions. +extern char &MachineRegionInfoPassID; + +/// EdgeBundles analysis - Bundle machine CFG edges. +extern char &EdgeBundlesWrapperLegacyID; + +/// LiveVariables pass - This pass computes the set of blocks in which each +/// variable is life and sets machine operand kill flags. +extern char &LiveVariablesID; + +/// PHIElimination - This pass eliminates machine instruction PHI nodes +/// by inserting copy instructions. This destroys SSA information, but is the +/// desired input for some register allocators. This pass is "required" by +/// these register allocator like this: AU.addRequiredID(PHIEliminationID); +extern char &PHIEliminationID; + +/// LiveIntervals - This analysis keeps track of the live ranges of virtual +/// and physical registers. +extern char &LiveIntervalsID; + +/// LiveStacks pass. An analysis keeping track of the liveness of stack slots. +extern char &LiveStacksID; + +/// TwoAddressInstruction - This pass reduces two-address instructions to +/// use two operands. This destroys SSA information but it is desired by +/// register allocators. +extern char &TwoAddressInstructionPassID; + +/// ProcessImpicitDefs pass - This pass removes IMPLICIT_DEFs. +extern char &ProcessImplicitDefsID; + +/// RegisterCoalescer - This pass merges live ranges to eliminate copies. +extern char &RegisterCoalescerID; + +/// MachineScheduler - This pass schedules machine instructions. +extern char &MachineSchedulerID; + +/// PostMachineScheduler - This pass schedules machine instructions postRA. +extern char &PostMachineSchedulerID; + +/// SpillPlacement analysis. Suggest optimal placement of spill code between +/// basic blocks. +extern char &SpillPlacementID; + +/// ShrinkWrap pass. Look for the best place to insert save and restore +// instruction and update the MachineFunctionInfo with that information. +extern char &ShrinkWrapID; + +/// LiveRangeShrink pass. Move instruction close to its definition to shrink +/// the definition's live range. +extern char &LiveRangeShrinkID; + +/// Greedy register allocator. +extern char &RAGreedyLegacyID; + +/// Basic register allocator. +extern char &RABasicID; + +/// VirtRegRewriter pass. Rewrite virtual registers to physical registers as +/// assigned in VirtRegMap. +extern char &VirtRegRewriterID; +FunctionPass *createVirtRegRewriter(bool ClearVirtRegs = true); - /// UnreachableMachineBlockElimination - This pass removes unreachable - /// machine basic blocks. - extern char &UnreachableMachineBlockElimID; +/// UnreachableMachineBlockElimination - This pass removes unreachable +/// machine basic blocks. +extern char &UnreachableMachineBlockElimID; - /// DeadMachineInstructionElim - This pass removes dead machine instructions. - extern char &DeadMachineInstructionElimID; +/// DeadMachineInstructionElim - This pass removes dead machine instructions. +extern char &DeadMachineInstructionElimID; - /// This pass adds dead/undef flags after analyzing subregister lanes. - extern char &DetectDeadLanesID; +/// This pass adds dead/undef flags after analyzing subregister lanes. +extern char &DetectDeadLanesID; - /// This pass perform post-ra machine sink for COPY instructions. - extern char &PostRAMachineSinkingID; +/// This pass perform post-ra machine sink for COPY instructions. +extern char &PostRAMachineSinkingID; - /// This pass adds flow sensitive discriminators. - extern char &MIRAddFSDiscriminatorsID; +/// This pass adds flow sensitive discriminators. +extern char &MIRAddFSDiscriminatorsID; - /// This pass reads flow sensitive profile. - extern char &MIRProfileLoaderPassID; +/// This pass reads flow sensitive profile. +extern char &MIRProfileLoaderPassID; - // This pass gives undef values a Pseudo Instruction definition for - // Instructions to ensure early-clobber is followed when using the greedy - // register allocator. - extern char &InitUndefID; +// This pass gives undef values a Pseudo Instruction definition for +// Instructions to ensure early-clobber is followed when using the greedy +// register allocator. +extern char &InitUndefID; - /// FastRegisterAllocation Pass - This pass register allocates as fast as - /// possible. It is best suited for debug code where live ranges are short. - /// - FunctionPass *createFastRegisterAllocator(); - FunctionPass *createFastRegisterAllocator(RegAllocFilterFunc F, - bool ClearVirtRegs); +/// FastRegisterAllocation Pass - This pass register allocates as fast as +/// possible. It is best suited for debug code where live ranges are short. +/// +FunctionPass *createFastRegisterAllocator(); +FunctionPass *createFastRegisterAllocator(RegAllocFilterFunc F, + bool ClearVirtRegs); - /// BasicRegisterAllocation Pass - This pass implements a degenerate global - /// register allocator using the basic regalloc framework. - /// - FunctionPass *createBasicRegisterAllocator(); - FunctionPass *createBasicRegisterAllocator(RegAllocFilterFunc F); +/// BasicRegisterAllocation Pass - This pass implements a degenerate global +/// register allocator using the basic regalloc framework. +/// +FunctionPass *createBasicRegisterAllocator(); +FunctionPass *createBasicRegisterAllocator(RegAllocFilterFunc F); - /// Greedy register allocation pass - This pass implements a global register - /// allocator for optimized builds. - /// - FunctionPass *createGreedyRegisterAllocator(); - FunctionPass *createGreedyRegisterAllocator(RegAllocFilterFunc F); +/// Greedy register allocation pass - This pass implements a global register +/// allocator for optimized builds. +/// +FunctionPass *createGreedyRegisterAllocator(); +FunctionPass *createGreedyRegisterAllocator(RegAllocFilterFunc F); - /// PBQPRegisterAllocation Pass - This pass implements the Partitioned Boolean - /// Quadratic Prograaming (PBQP) based register allocator. - /// - FunctionPass *createDefaultPBQPRegisterAllocator(); - - /// PrologEpilogCodeInserter - This pass inserts prolog and epilog code, - /// and eliminates abstract frame references. - extern char &PrologEpilogCodeInserterID; - MachineFunctionPass *createPrologEpilogInserterPass(); +/// PBQPRegisterAllocation Pass - This pass implements the Partitioned Boolean +/// Quadratic Prograaming (PBQP) based register allocator. +/// +FunctionPass *createDefaultPBQPRegisterAllocator(); + +/// PrologEpilogCodeInserter - This pass inserts prolog and epilog code, +/// and eliminates abstract frame references. +extern char &PrologEpilogCodeInserterID; +MachineFunctionPass *createPrologEpilogInserterPass(); - /// ExpandPostRAPseudos - This pass expands pseudo instructions after - /// register allocation. - extern char &ExpandPostRAPseudosID; +/// ExpandPostRAPseudos - This pass expands pseudo instructions after +/// register allocation. +extern char &ExpandPostRAPseudosID; - /// PostRAHazardRecognizer - This pass runs the post-ra hazard - /// recognizer. - extern char &PostRAHazardRecognizerID; - - /// PostRAScheduler - This pass performs post register allocation - /// scheduling. - extern char &PostRASchedulerID; +/// PostRAHazardRecognizer - This pass runs the post-ra hazard +/// recognizer. +extern char &PostRAHazardRecognizerID; + +/// PostRAScheduler - This pass performs post register allocation +/// scheduling. +extern char &PostRASchedulerID; - /// BranchFolding - This pass performs machine code CFG based - /// optimizations to delete branches to branches, eliminate branches to - /// successor blocks (creating fall throughs), and eliminating branches over - /// branches. - extern char &BranchFolderPassID; +/// BranchFolding - This pass performs machine code CFG based +/// optimizations to delete branches to branches, eliminate branches to +/// successor blocks (creating fall throughs), and eliminating branches over +/// branches. +extern char &BranchFolderPassID; - /// BranchRelaxation - This pass replaces branches that need to jump further - /// than is supported by a branch instruction. - extern char &BranchRelaxationPassID; - - /// MachineFunctionPrinterPass - This pass prints out MachineInstr's. - extern char &MachineFunctionPrinterPassID; - - /// MIRPrintingPass - this pass prints out the LLVM IR using the MIR - /// serialization format. - extern char &MIRPrintingPassID; - - /// TailDuplicate - Duplicate blocks with unconditional branches - /// into tails of their predecessors. - extern char &TailDuplicateLegacyID; - - /// Duplicate blocks with unconditional branches into tails of their - /// predecessors. Variant that works before register allocation. - extern char &EarlyTailDuplicateLegacyID; - - /// MachineTraceMetrics - This pass computes critical path and CPU resource - /// usage in an ensemble of traces. - extern char &MachineTraceMetricsID; - - /// EarlyIfConverter - This pass performs if-conversion on SSA form by - /// inserting cmov instructions. - extern char &EarlyIfConverterLegacyID; +/// BranchRelaxation - This pass replaces branches that need to jump further +/// than is supported by a branch instruction. +extern char &BranchRelaxationPassID; + +/// MachineFunctionPrinterPass - This pass prints out MachineInstr's. +extern char &MachineFunctionPrinterPassID; + +/// MIRPrintingPass - this pass prints out the LLVM IR using the MIR +/// serialization format. +extern char &MIRPrintingPassID; + +/// TailDuplicate - Duplicate blocks with unconditional branches +/// into tails of their predecessors. +extern char &TailDuplicateLegacyID; + +/// Duplicate blocks with unconditional branches into tails of their +/// predecessors. Variant that works before register allocation. +extern char &EarlyTailDuplicateLegacyID; + +/// MachineTraceMetrics - This pass computes critical path and CPU resource +/// usage in an ensemble of traces. +extern char &MachineTraceMetricsID; + +/// EarlyIfConverter - This pass performs if-conversion on SSA form by +/// inserting cmov instructions. +extern char &EarlyIfConverterLegacyID; - /// EarlyIfPredicator - This pass performs if-conversion on SSA form by - /// predicating if/else block and insert select at the join point. - extern char &EarlyIfPredicatorID; +/// EarlyIfPredicator - This pass performs if-conversion on SSA form by +/// predicating if/else block and insert select at the join point. +extern char &EarlyIfPredicatorID; - /// This pass performs instruction combining using trace metrics to estimate - /// critical-path and resource depth. - extern char &MachineCombinerID; +/// This pass performs instruction combining using trace metrics to estimate +/// critical-path and resource depth. +extern char &MachineCombinerID; - /// StackSlotColoring - This pass performs stack coloring and merging. - /// It merges disjoint allocas to reduce the stack size. - extern char &StackColoringLegacyID; +/// StackSlotColoring - This pass performs stack coloring and merging. +/// It merges disjoint allocas to reduce the stack size. +extern char &StackColoringLegacyID; - /// StackFramePrinter - This pass prints the stack frame layout and variable - /// mappings. - extern char &StackFrameLayoutAnalysisPassID; - - /// IfConverter - This pass performs machine code if conversion. - extern char &IfConverterID; - - FunctionPass *createIfConverter( - std::function<bool(const MachineFunction &)> Ftor); - - /// MachineBlockPlacement - This pass places basic blocks based on branch - /// probabilities. - extern char &MachineBlockPlacementID; - - /// MachineBlockPlacementStats - This pass collects statistics about the - /// basic block placement using branch probabilities and block frequency - /// information. - extern char &MachineBlockPlacementStatsID; - - /// GCLowering Pass - Used by gc.root to perform its default lowering - /// operations. - FunctionPass *createGCLoweringPass(); - - /// GCLowering Pass - Used by gc.root to perform its default lowering - /// operations. - extern char &GCLoweringID; +/// StackFramePrinter - This pass prints the stack frame layout and variable +/// mappings. +extern char &StackFrameLayoutAnalysisPassID; + +/// IfConverter - This pass performs machine code if conversion. +extern char &IfConverterID; + +FunctionPass * +createIfConverter(std::function<bool(const MachineFunction &)> Ftor); + +/// MachineBlockPlacement - This pass places basic blocks based on branch +/// probabilities. +extern char &MachineBlockPlacementID; + +/// MachineBlockPlacementStats - This pass collects statistics about the +/// basic block placement using branch probabilities and block frequency +/// information. +extern char &MachineBlockPlacementStatsID; + +/// GCLowering Pass - Used by gc.root to perform its default lowering +/// operations. +FunctionPass *createGCLoweringPass(); + +/// GCLowering Pass - Used by gc.root to perform its default lowering +/// operations. +extern char &GCLoweringID; - /// ShadowStackGCLowering - Implements the custom lowering mechanism - /// used by the shadow stack GC. Only runs on functions which opt in to - /// the shadow stack collector. - FunctionPass *createShadowStackGCLoweringPass(); +/// ShadowStackGCLowering - Implements the custom lowering mechanism +/// used by the shadow stack GC. Only runs on functions which opt in to +/// the shadow stack collector. +FunctionPass *createShadowStackGCLoweringPass(); - /// ShadowStackGCLowering - Implements the custom lowering mechanism - /// used by the shadow stack GC. - extern char &ShadowStackGCLoweringID; +/// ShadowStackGCLowering - Implements the custom lowering mechanism +/// used by the shadow stack GC. +extern char &ShadowStackGCLoweringID; - /// GCMachineCodeAnalysis - Target-independent pass to mark safe points - /// in machine code. Must be added very late during code generation, just - /// prior to output, and importantly after all CFG transformations (such as - /// branch folding). - extern char &GCMachineCodeAnalysisID; +/// GCMachineCodeAnalysis - Target-independent pass to mark safe points +/// in machine code. Must be added very late during code generation, just +/// prior to output, and importantly after all CFG transformations (such as +/// branch folding). +extern char &GCMachineCodeAnalysisID; - /// MachineCSE - This pass performs global CSE on machine instructions. - extern char &MachineCSELegacyID; +/// MachineCSE - This pass performs global CSE on machine instructions. +extern char &MachineCSELegacyID; - /// MIRCanonicalizer - This pass canonicalizes MIR by renaming vregs - /// according to the semantics of the instruction as well as hoists - /// code. - extern char &MIRCanonicalizerID; +/// MIRCanonicalizer - This pass canonicalizes MIR by renaming vregs +/// according to the semantics of the instruction as well as hoists +/// code. +extern char &MIRCanonicalizerID; - /// ImplicitNullChecks - This pass folds null pointer checks into nearby - /// memory operations. - extern char &ImplicitNullChecksID; +/// ImplicitNullChecks - This pass folds null pointer checks into nearby +/// memory operations. +extern char &ImplicitNullChecksID; - /// This pass performs loop invariant code motion on machine instructions. - extern char &MachineLICMID; +/// This pass performs loop invariant code motion on machine instructions. +extern char &MachineLICMID; - /// This pass performs loop invariant code motion on machine instructions. - /// This variant works before register allocation. \see MachineLICMID. - extern char &EarlyMachineLICMID; +/// This pass performs loop invariant code motion on machine instructions. +/// This variant works before register allocation. \see MachineLICMID. +extern char &EarlyMachineLICMID; - /// MachineSinking - This pass performs sinking on machine instructions. - extern char &MachineSinkingLegacyID; +/// MachineSinking - This pass performs sinking on machine instructions. +extern char &MachineSinkingLegacyID; - /// MachineCopyPropagation - This pass performs copy propagation on - /// machine instructions. - extern char &MachineCopyPropagationID; +/// MachineCopyPropagation - This pass performs copy propagation on +/// machine instructions. +extern char &MachineCopyPropagationID; - MachineFunctionPass *createMachineCopyPropagationPass(bool UseCopyInstr); +MachineFunctionPass *createMachineCopyPropagationPass(bool UseCopyInstr); - /// MachineLateInstrsCleanup - This pass removes redundant identical - /// instructions after register allocation and rematerialization. - extern char &MachineLateInstrsCleanupID; +/// MachineLateInstrsCleanup - This pass removes redundant identical +/// instructions after register allocation and rematerialization. +extern char &MachineLateInstrsCleanupID; - /// PeepholeOptimizer - This pass performs peephole optimizations - - /// like extension and comparison eliminations. - extern char &PeepholeOptimizerLegacyID; +/// PeepholeOptimizer - This pass performs peephole optimizations - +/// like extension and comparison eliminations. +extern char &PeepholeOptimizerLegacyID; - /// OptimizePHIs - This pass optimizes machine instruction PHIs - /// to take advantage of opportunities created during DAG legalization. - extern char &OptimizePHIsLegacyID; +/// OptimizePHIs - This pass optimizes machine instruction PHIs +/// to take advantage of opportunities created during DAG legalization. +extern char &OptimizePHIsLegacyID; - /// StackSlotColoring - This pass performs stack slot coloring. - extern char &StackSlotColoringID; +/// StackSlotColoring - This pass performs stack slot coloring. +extern char &StackSlotColoringID; - /// This pass lays out funclets contiguously. - extern char &FuncletLayoutID; +/// This pass lays out funclets contiguously. +extern char &FuncletLayoutID; - /// This pass inserts the XRay instrumentation sleds if they are supported by - /// the target platform. - extern char &XRayInstrumentationID; +/// This pass inserts the XRay instrumentation sleds if they are supported by +/// the target platform. +extern char &XRayInstrumentationID; - /// This pass inserts FEntry calls - extern char &FEntryInserterID; - - /// This pass implements the "patchable-function" attribute. - extern char &PatchableFunctionID; - - /// createStackProtectorPass - This pass adds stack protectors to functions. - /// - FunctionPass *createStackProtectorPass(); - - /// createMachineVerifierPass - This pass verifies cenerated machine code - /// instructions for correctness. - /// - FunctionPass *createMachineVerifierPass(const std::string& Banner); - - /// createDwarfEHPass - This pass mulches exception handling code into a form - /// adapted to code generation. Required if using dwarf exception handling. - FunctionPass *createDwarfEHPass(CodeGenOptLevel OptLevel); - - /// createWinEHPass - Prepares personality functions used by MSVC on Windows, - /// in addition to the Itanium LSDA based personalities. - FunctionPass *createWinEHPass(bool DemoteCatchSwitchPHIOnly = false); - - /// createSjLjEHPreparePass - This pass adapts exception handling code to use - /// the GCC-style builtin setjmp/longjmp (sjlj) to handling EH control flow. - /// - FunctionPass *createSjLjEHPreparePass(const TargetMachine *TM); - - /// createWasmEHPass - This pass adapts exception handling code to use - /// WebAssembly's exception handling scheme. - FunctionPass *createWasmEHPass(); - - /// LocalStackSlotAllocation - This pass assigns local frame indices to stack - /// slots relative to one another and allocates base registers to access them - /// when it is estimated by the target to be out of range of normal frame - /// pointer or stack pointer index addressing. - extern char &LocalStackSlotAllocationID; +/// This pass inserts FEntry calls +extern char &FEntryInserterID; + +/// This pass implements the "patchable-function" attribute. +extern char &PatchableFunctionID; + +/// createStackProtectorPass - This pass adds stack protectors to functions. +/// +FunctionPass *createStackProtectorPass(); + +/// createMachineVerifierPass - This pass verifies cenerated machine code +/// instructions for correctness. +/// +FunctionPass *createMachineVerifierPass(const std::string &Banner); + +/// createDwarfEHPass - This pass mulches exception handling code into a form +/// adapted to code generation. Required if using dwarf exception handling. +FunctionPass *createDwarfEHPass(CodeGenOptLevel OptLevel); + +/// createWinEHPass - Prepares personality functions used by MSVC on Windows, +/// in addition to the Itanium LSDA based personalities. +FunctionPass *createWinEHPass(bool DemoteCatchSwitchPHIOnly = false); + +/// createSjLjEHPreparePass - This pass adapts exception handling code to use +/// the GCC-style builtin setjmp/longjmp (sjlj) to handling EH control flow. +/// +FunctionPass *createSjLjEHPreparePass(const TargetMachine *TM); + +/// createWasmEHPass - This pass adapts exception handling code to use +/// WebAssembly's exception handling scheme. +FunctionPass *createWasmEHPass(); + +/// LocalStackSlotAllocation - This pass assigns local frame indices to stack +/// slots relative to one another and allocates base registers to access them +/// when it is estimated by the target to be out of range of normal frame +/// pointer or stack pointer index addressing. +extern char &LocalStackSlotAllocationID; - /// This pass expands pseudo-instructions, reserves registers and adjusts - /// machine frame information. - extern char &FinalizeISelID; +/// This pass expands pseudo-instructions, reserves registers and adjusts +/// machine frame information. +extern char &FinalizeISelID; - /// UnpackMachineBundles - This pass unpack machine instruction bundles. - extern char &UnpackMachineBundlesID; +/// UnpackMachineBundles - This pass unpack machine instruction bundles. +extern char &UnpackMachineBundlesID; - FunctionPass * - createUnpackMachineBundles(std::function<bool(const MachineFunction &)> Ftor); +FunctionPass * +createUnpackMachineBundles(std::function<bool(const MachineFunction &)> Ftor); - /// FinalizeMachineBundles - This pass finalize machine instruction - /// bundles (created earlier, e.g. during pre-RA scheduling). - extern char &FinalizeMachineBundlesID; +/// FinalizeMachineBundles - This pass finalize machine instruction +/// bundles (created earlier, e.g. during pre-RA scheduling). +extern char &FinalizeMachineBundlesID; - /// StackMapLiveness - This pass analyses the register live-out set of - /// stackmap/patchpoint intrinsics and attaches the calculated information to - /// the intrinsic for later emission to the StackMap. - extern char &StackMapLivenessID; +/// StackMapLiveness - This pass analyses the register live-out set of +/// stackmap/patchpoint intrinsics and attaches the calculated information to +/// the intrinsic for later emission to the StackMap. +extern char &StackMapLivenessID; - // MachineSanitizerBinaryMetadata - appends/finalizes sanitizer binary - // metadata after llvm SanitizerBinaryMetadata pass. - extern char &MachineSanitizerBinaryMetadataID; +// MachineSanitizerBinaryMetadata - appends/finalizes sanitizer binary +// metadata after llvm SanitizerBinaryMetadata pass. +extern char &MachineSanitizerBinaryMetadataID; - /// RemoveLoadsIntoFakeUses pass. - extern char &RemoveLoadsIntoFakeUsesID; +/// RemoveLoadsIntoFakeUses pass. +extern char &RemoveLoadsIntoFakeUsesID; - /// RemoveRedundantDebugValues pass. - extern char &RemoveRedundantDebugValuesID; +/// RemoveRedundantDebugValues pass. +extern char &RemoveRedundantDebugValuesID; - /// MachineCFGPrinter pass. - extern char &MachineCFGPrinterID; +/// MachineCFGPrinter pass. +extern char &MachineCFGPrinterID; - /// LiveDebugValues pass - extern char &LiveDebugValuesID; +/// LiveDebugValues pass +extern char &LiveDebugValuesID; - /// InterleavedAccess Pass - This pass identifies and matches interleaved - /// memory accesses to target specific intrinsics. - /// - FunctionPass *createInterleavedAccessPass(); +/// InterleavedAccess Pass - This pass identifies and matches interleaved +/// memory accesses to target specific intrinsics. +/// +FunctionPass *createInterleavedAccessPass(); - /// InterleavedLoadCombines Pass - This pass identifies interleaved loads and - /// combines them into wide loads detectable by InterleavedAccessPass - /// - FunctionPass *createInterleavedLoadCombinePass(); +/// InterleavedLoadCombines Pass - This pass identifies interleaved loads and +/// combines them into wide loads detectable by InterleavedAccessPass +/// +FunctionPass *createInterleavedLoadCombinePass(); - /// LowerEmuTLS - This pass generates __emutls_[vt].xyz variables for all - /// TLS variables for the emulated TLS model. - /// - ModulePass *createLowerEmuTLSPass(); +/// LowerEmuTLS - This pass generates __emutls_[vt].xyz variables for all +/// TLS variables for the emulated TLS model. +/// +ModulePass *createLowerEmuTLSPass(); - /// This pass lowers the \@llvm.load.relative and \@llvm.objc.* intrinsics to - /// instructions. This is unsafe to do earlier because a pass may combine the - /// constant initializer into the load, which may result in an overflowing - /// evaluation. - ModulePass *createPreISelIntrinsicLoweringPass(); +/// This pass lowers the \@llvm.load.relative and \@llvm.objc.* intrinsics to +/// instructions. This is unsafe to do earlier because a pass may combine the +/// constant initializer into the load, which may result in an overflowing +/// evaluation. +ModulePass *createPreISelIntrinsicLoweringPass(); - /// GlobalMerge - This pass merges internal (by default) globals into structs - /// to enable reuse of a base pointer by indexed addressing modes. - /// It can also be configured to focus on size optimizations only. - /// - Pass *createGlobalMergePass(const TargetMachine *TM, unsigned MaximalOffset, - bool OnlyOptimizeForSize = false, - bool MergeExternalByDefault = false, - bool MergeConstantByDefault = false, - bool MergeConstAggressiveByDefault = false); +/// GlobalMerge - This pass merges internal (by default) globals into structs +/// to enable reuse of a base pointer by indexed addressing modes. +/// It can also be configured to focus on size optimizations only. +/// +Pass *createGlobalMergePass(const TargetMachine *TM, unsigned MaximalOffset, + bool OnlyOptimizeForSize = false, + bool MergeExternalByDefault = false, + bool MergeConstantByDefault = false, + bool MergeConstAggressiveByDefault = false); - /// This pass splits the stack into a safe stack and an unsafe stack to - /// protect against stack-based overflow vulnerabilities. - FunctionPass *createSafeStackPass(); +/// This pass splits the stack into a safe stack and an unsafe stack to +/// protect against stack-based overflow vulnerabilities. +FunctionPass *createSafeStackPass(); - /// This pass detects subregister lanes in a virtual register that are used - /// independently of other lanes and splits them into separate virtual - /// registers. - extern char &RenameIndependentSubregsID; +/// This pass detects subregister lanes in a virtual register that are used +/// independently of other lanes and splits them into separate virtual +/// registers. +extern char &RenameIndependentSubregsID; - /// This pass is executed POST-RA to collect which physical registers are - /// preserved by given machine function. - FunctionPass *createRegUsageInfoCollector(); +/// This pass is executed POST-RA to collect which physical registers are +/// preserved by given machine function. +FunctionPass *createRegUsageInfoCollector(); - /// Return a MachineFunction pass that identifies call sites - /// and propagates register usage information of callee to caller - /// if available with PysicalRegisterUsageInfo pass. - FunctionPass *createRegUsageInfoPropPass(); +/// Return a MachineFunction pass that identifies call sites +/// and propagates register usage information of callee to caller +/// if available with PysicalRegisterUsageInfo pass. +FunctionPass *createRegUsageInfoPropPass(); - /// This pass performs software pipelining on machine instructions. - extern char &MachinePipelinerID; +/// This pass performs software pipelining on machine instructions. +extern char &MachinePipelinerID; - /// This pass frees the memory occupied by the MachineFunction. - FunctionPass *createFreeMachineFunctionPass(); +/// This pass frees the memory occupied by the MachineFunction. +FunctionPass *createFreeMachineFunctionPass(); - /// This pass performs merging similar functions globally. - ModulePass *createGlobalMergeFuncPass(); +/// This pass performs merging similar functions globally. +ModulePass *createGlobalMergeFuncPass(); - /// This pass performs outlining on machine instructions directly before - /// printing assembly. - ModulePass *createMachineOutlinerPass(bool RunOnAllFunctions = true); +/// This pass performs outlining on machine instructions directly before +/// printing assembly. +ModulePass *createMachineOutlinerPass(bool RunOnAllFunctions = true); - /// This pass expands the reduction intrinsics into sequences of shuffles. - FunctionPass *createExpandReductionsPass(); +/// This pass expands the reduction intrinsics into sequences of shuffles. +FunctionPass *createExpandReductionsPass(); - // This pass replaces intrinsics operating on vector operands with calls to - // the corresponding function in a vector library (e.g., SVML, libmvec). - FunctionPass *createReplaceWithVeclibLegacyPass(); +// This pass replaces intrinsics operating on vector operands with calls to +// the corresponding function in a vector library (e.g., SVML, libmvec). +FunctionPass *createReplaceWithVeclibLegacyPass(); - // Expands large div/rem instructions. - FunctionPass *createExpandLargeDivRemPass(); +// Expands large div/rem instructions. +FunctionPass *createExpandLargeDivRemPass(); - // Expands large div/rem instructions. - FunctionPass *createExpandFpPass(); +// Expands large div/rem instructions. +FunctionPass *createExpandFpPass(); - // This pass expands memcmp() to load/stores. - FunctionPass *createExpandMemCmpLegacyPass(); +// This pass expands memcmp() to load/stores. +FunctionPass *createExpandMemCmpLegacyPass(); - /// Creates Break False Dependencies pass. \see BreakFalseDeps.cpp - FunctionPass *createBreakFalseDeps(); +/// Creates Break False Dependencies pass. \see BreakFalseDeps.cpp +FunctionPass *createBreakFalseDeps(); - // This pass expands indirectbr instructions. - FunctionPass *createIndirectBrExpandPass(); +// This pass expands indirectbr instructions. +FunctionPass *createIndirectBrExpandPass(); - /// Creates CFI Fixup pass. \see CFIFixup.cpp - FunctionPass *createCFIFixup(); +/// Creates CFI Fixup pass. \see CFIFixup.cpp +FunctionPass *createCFIFixup(); - /// Creates CFI Instruction Inserter pass. \see CFIInstrInserter.cpp - FunctionPass *createCFIInstrInserter(); +/// Creates CFI Instruction Inserter pass. \see CFIInstrInserter.cpp +FunctionPass *createCFIInstrInserter(); - /// Creates CFGuard longjmp target identification pass. - /// \see CFGuardLongjmp.cpp - FunctionPass *createCFGuardLongjmpPass(); +/// Creates CFGuard longjmp target identification pass. +/// \see CFGuardLongjmp.cpp +FunctionPass *createCFGuardLongjmpPass(); - /// Creates Windows EH Continuation Guard target identification pass. - /// \see EHContGuardTargets.cpp - FunctionPass *createEHContGuardTargetsPass(); +/// Creates Windows EH Continuation Guard target identification pass. +/// \see EHContGuardTargets.cpp +FunctionPass *createEHContGuardTargetsPass(); - /// Create Hardware Loop pass. \see HardwareLoops.cpp - FunctionPass *createHardwareLoopsLegacyPass(); +/// Create Hardware Loop pass. \see HardwareLoops.cpp +FunctionPass *createHardwareLoopsLegacyPass(); - /// This pass inserts pseudo probe annotation for callsite profiling. - FunctionPass *createPseudoProbeInserter(); +/// This pass inserts pseudo probe annotation for callsite profiling. +FunctionPass *createPseudoProbeInserter(); - /// Create IR Type Promotion pass. \see TypePromotion.cpp - FunctionPass *createTypePromotionLegacyPass(); +/// Create IR Type Promotion pass. \see TypePromotion.cpp +FunctionPass *createTypePromotionLegacyPass(); - /// Add Flow Sensitive Discriminators. PassNum specifies the - /// sequence number of this pass (starting from 1). - FunctionPass * - createMIRAddFSDiscriminatorsPass(sampleprof::FSDiscriminatorPass P); +/// Add Flow Sensitive Discriminators. PassNum specifies the +/// sequence number of this pass (starting from 1). +FunctionPass * +createMIRAddFSDiscriminatorsPass(sampleprof::FSDiscriminatorPass P); - /// Read Flow Sensitive Profile. - FunctionPass * - createMIRProfileLoaderPass(std::string File, std::string RemappingFile, - sampleprof::FSDiscriminatorPass P, - IntrusiveRefCntPtr<vfs::FileSystem> FS); +/// Read Flow Sensitive Profile. +FunctionPass * +createMIRProfileLoaderPass(std::string File, std::string RemappingFile, + sampleprof::FSDiscriminatorPass P, + IntrusiveRefCntPtr<vfs::FileSystem> FS); - /// Creates MIR Debugify pass. \see MachineDebugify.cpp - ModulePass *createDebugifyMachineModulePass(); +/// Creates MIR Debugify pass. \see MachineDebugify.cpp +ModulePass *createDebugifyMachineModulePass(); - /// Creates MIR Strip Debug pass. \see MachineStripDebug.cpp - /// If OnlyDebugified is true then it will only strip debug info if it was - /// added by a Debugify pass. The module will be left unchanged if the debug - /// info was generated by another source such as clang. - ModulePass *createStripDebugMachineModulePass(bool OnlyDebugified); +/// Creates MIR Strip Debug pass. \see MachineStripDebug.cpp +/// If OnlyDebugified is true then it will only strip debug info if it was +/// added by a Debugify pass. The module will be left unchanged if the debug +/// info was generated by another source such as clang. +ModulePass *createStripDebugMachineModulePass(bool OnlyDebugified); - /// Creates MIR Check Debug pass. \see MachineCheckDebugify.cpp - ModulePass *createCheckDebugMachineModulePass(); +/// Creates MIR Check Debug pass. \see MachineCheckDebugify.cpp +ModulePass *createCheckDebugMachineModulePass(); - /// The pass fixups statepoint machine instruction to replace usage of - /// caller saved registers with stack slots. - extern char &FixupStatepointCallerSavedID; +/// The pass fixups statepoint machine instruction to replace usage of +/// caller saved registers with stack slots. +extern char &FixupStatepointCallerSavedID; - /// The pass transforms load/store <256 x i32> to AMX load/store intrinsics - /// or split the data to two <128 x i32>. - FunctionPass *createX86LowerAMXTypePass(); +/// The pass transforms load/store <256 x i32> to AMX load/store intrinsics +/// or split the data to two <128 x i32>. +FunctionPass *createX86LowerAMXTypePass(); - /// The pass transforms amx intrinsics to scalar operation if the function has - /// optnone attribute or it is O0. - FunctionPass *createX86LowerAMXIntrinsicsPass(); +/// The pass transforms amx intrinsics to scalar operation if the function has +/// optnone attribute or it is O0. +FunctionPass *createX86LowerAMXIntrinsicsPass(); - /// When learning an eviction policy, extract score(reward) information, - /// otherwise this does nothing - FunctionPass *createRegAllocScoringPass(); +/// When learning an eviction policy, extract score(reward) information, +/// otherwise this does nothing +FunctionPass *createRegAllocScoringPass(); - /// JMC instrument pass. - ModulePass *createJMCInstrumenterPass(); +/// JMC instrument pass. +ModulePass *createJMCInstrumenterPass(); - /// This pass converts conditional moves to conditional jumps when profitable. - FunctionPass *createSelectOptimizePass(); +/// This pass converts conditional moves to conditional jumps when profitable. +FunctionPass *createSelectOptimizePass(); - FunctionPass *createCallBrPass(); +FunctionPass *createCallBrPass(); - /// Lowers KCFI operand bundles for indirect calls. - FunctionPass *createKCFIPass(); -} // End llvm namespace +/// Lowers KCFI operand bundles for indirect calls. +FunctionPass *createKCFIPass(); +} // namespace llvm #endif |