1de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar//===-- TargetPassConfig.h - Code Generation pass options -------*- C++ -*-===// 2de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// 3de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// The LLVM Compiler Infrastructure 4de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// 5de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// This file is distributed under the University of Illinois Open Source 6de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// License. See LICENSE.TXT for details. 7de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// 8de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar//===----------------------------------------------------------------------===// 9de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// 10de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// Target-Independent Code Generator Pass Configuration Options pass. 11de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// 12de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar//===----------------------------------------------------------------------===// 13de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 14de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#ifndef LLVM_CODEGEN_TARGETPASSCONFIG_H 15de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#define LLVM_CODEGEN_TARGETPASSCONFIG_H 16de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 17de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/Pass.h" 18de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/Support/CodeGen.h" 19de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include <string> 20de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 21de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarnamespace llvm { 22de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 23de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass PassConfigImpl; 24de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass ScheduleDAGInstrs; 25de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass TargetMachine; 26de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarstruct MachineSchedContext; 27de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 28de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar// The old pass manager infrastructure is hidden in a legacy namespace now. 29de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarnamespace legacy { 30de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass PassManagerBase; 31de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar} 32de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarusing legacy::PassManagerBase; 33de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 34de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// Discriminated union of Pass ID types. 35de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// 36de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// The PassConfig API prefers dealing with IDs because they are safer and more 37de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// efficient. IDs decouple configuration from instantiation. This way, when a 38de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// pass is overriden, it isn't unnecessarily instantiated. It is also unsafe to 39de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// refer to a Pass pointer after adding it to a pass manager, which deletes 40de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// redundant pass instances. 41de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// 42de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// However, it is convient to directly instantiate target passes with 43de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// non-default ctors. These often don't have a registered PassInfo. Rather than 44de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// force all target passes to implement the pass registry boilerplate, allow 45de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// the PassConfig API to handle either type. 46de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// 47de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// AnalysisID is sadly char*, so PointerIntPair won't work. 48de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass IdentifyingPassPtr { 49de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar union { 50de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AnalysisID ID; 51de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar Pass *P; 52de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar }; 53de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool IsInstance; 54de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarpublic: 55de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar IdentifyingPassPtr() : P(nullptr), IsInstance(false) {} 56de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar IdentifyingPassPtr(AnalysisID IDPtr) : ID(IDPtr), IsInstance(false) {} 57de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar IdentifyingPassPtr(Pass *InstancePtr) : P(InstancePtr), IsInstance(true) {} 58de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 59de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool isValid() const { return P; } 60de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool isInstance() const { return IsInstance; } 61de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 62de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AnalysisID getID() const { 63de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar assert(!IsInstance && "Not a Pass ID"); 64de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return ID; 65de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 66de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar Pass *getInstance() const { 67de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar assert(IsInstance && "Not a Pass Instance"); 68de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return P; 69de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 70de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar}; 71de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 72de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainartemplate <> struct isPodLike<IdentifyingPassPtr> { 73de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar static const bool value = true; 74de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar}; 75de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 76de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// Target-Independent Code Generator Pass Configuration Options. 77de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// 78de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// This is an ImmutablePass solely for the purpose of exposing CodeGen options 79de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar/// to the internals of other CodeGen passes. 80de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarclass TargetPassConfig : public ImmutablePass { 81de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarpublic: 82de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Pseudo Pass IDs. These are defined within TargetPassConfig because they 83de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// are unregistered pass IDs. They are only useful for use with 84de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// TargetPassConfig APIs to identify multiple occurrences of the same pass. 85de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 86de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 87de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// EarlyTailDuplicate - A clone of the TailDuplicate pass that runs early 88de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// during codegen, on SSA form. 89de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar static char EarlyTailDuplicateID; 90de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 91de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// PostRAMachineLICM - A clone of the LICM pass that runs during late machine 92de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// optimization after regalloc. 93de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar static char PostRAMachineLICMID; 94de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 95de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarprivate: 96de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar PassManagerBase *PM; 97de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AnalysisID StartBefore, StartAfter; 98de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AnalysisID StopAfter; 99de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool Started; 100de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool Stopped; 101de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool AddingMachinePasses; 102de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 103de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarprotected: 104de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar TargetMachine *TM; 105de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar PassConfigImpl *Impl; // Internal data structures 106de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool Initialized; // Flagged after all passes are configured. 107de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 108de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Target Pass Options 109de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Targets provide a default setting, user flags override. 110de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // 111de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool DisableVerify; 112de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 113de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Default setting for -enable-tail-merge on this target. 114de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool EnableTailMerge; 115de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 116de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarpublic: 117de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar TargetPassConfig(TargetMachine *tm, PassManagerBase &pm); 118de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Dummy constructor. 119de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar TargetPassConfig(); 120de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 121de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar ~TargetPassConfig() override; 122de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 123de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar static char ID; 124de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 125de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Get the right type of TargetMachine for this target. 126de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar template<typename TMC> TMC &getTM() const { 127de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return *static_cast<TMC*>(TM); 128de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 129de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 130de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // 131de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void setInitialized() { Initialized = true; } 132de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 133de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar CodeGenOpt::Level getOptLevel() const; 134de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 135de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Set the StartAfter, StartBefore and StopAfter passes to allow running only 136de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// a portion of the normal code-gen pass sequence. 137de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 138de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// If the StartAfter and StartBefore pass ID is zero, then compilation will 139de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// begin at the normal point; otherwise, clear the Started flag to indicate 140de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// that passes should not be added until the starting pass is seen. If the 141de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Stop pass ID is zero, then compilation will continue to the end. 142de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 143de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This function expects that at least one of the StartAfter or the 144de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// StartBefore pass IDs is null. 145de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void setStartStopPasses(AnalysisID StartBefore, AnalysisID StartAfter, 146de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AnalysisID StopAfter) { 147de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (StartAfter) 148de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar assert(!StartBefore && "Start after and start before passes are given"); 149de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar this->StartBefore = StartBefore; 150de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar this->StartAfter = StartAfter; 151de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar this->StopAfter = StopAfter; 152de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar Started = (StartAfter == nullptr) && (StartBefore == nullptr); 153de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 154de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 155de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void setDisableVerify(bool Disable) { setOpt(DisableVerify, Disable); } 156de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 157de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool getEnableTailMerge() const { return EnableTailMerge; } 158de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void setEnableTailMerge(bool Enable) { setOpt(EnableTailMerge, Enable); } 159de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 160de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Allow the target to override a specific pass without overriding the pass 161de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// pipeline. When passes are added to the standard pipeline at the 162de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// point where StandardID is expected, add TargetID in its place. 163de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void substitutePass(AnalysisID StandardID, IdentifyingPassPtr TargetID); 164de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 165de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Insert InsertedPassID pass after TargetPassID pass. 166de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void insertPass(AnalysisID TargetPassID, IdentifyingPassPtr InsertedPassID, 167de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool VerifyAfter = true, bool PrintAfter = true); 168de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 169de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Allow the target to enable a specific standard pass by default. 170de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void enablePass(AnalysisID PassID) { substitutePass(PassID, PassID); } 171de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 172de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Allow the target to disable a specific standard pass by default. 173de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void disablePass(AnalysisID PassID) { 174de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar substitutePass(PassID, IdentifyingPassPtr()); 175de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 176de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 177de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Return the pass substituted for StandardID by the target. 178de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// If no substitution exists, return StandardID. 179de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar IdentifyingPassPtr getPassSubstitution(AnalysisID StandardID) const; 180de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 181de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Return true if the pass has been substituted by the target or 182de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// overridden on the command line. 183de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool isPassSubstitutedOrOverridden(AnalysisID ID) const; 184de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 185de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Return true if the optimized regalloc pipeline is enabled. 186de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool getOptimizeRegAlloc() const; 187de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 188de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Return true if shrink wrapping is enabled. 189de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool getEnableShrinkWrap() const; 190de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 191de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Return true if the default global register allocator is in use and 192de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// has not be overriden on the command line with '-regalloc=...' 193de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool usingDefaultRegAlloc() const; 194de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 195de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add common target configurable passes that perform LLVM IR to IR 196de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// transforms following machine independent optimization. 197de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addIRPasses(); 198de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 199de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add passes to lower exception handling for the code generator. 200de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void addPassesToHandleExceptions(); 201de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 202de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add pass to prepare the LLVM IR for code generation. This should be done 203de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// before exception handling preparation passes. 204de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addCodeGenPrepare(); 205de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 206de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add common passes that perform LLVM IR to IR transforms in preparation for 207de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// instruction selection. 208de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addISelPrepare(); 209de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 210de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addInstSelector - This method should install an instruction selector pass, 211de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// which converts from LLVM code to machine instructions. 212de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual bool addInstSelector() { 213de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return true; 214de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 215de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 216de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This method should install an IR translator pass, which converts from 217de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// LLVM code to machine instructions with possibly generic opcodes. 218de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual bool addIRTranslator() { return true; } 219de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 220de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This method may be implemented by targets that want to run passes 221de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// immediately before the register bank selection. 222de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addPreRegBankSelect() {} 223de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 224de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This method should install a register bank selector pass, which 225de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// assigns register banks to virtual registers without a register 226de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// class or register banks. 227de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual bool addRegBankSelect() { return true; } 228de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 229de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add the complete, standard set of LLVM CodeGen passes. 230de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Fully developed targets will not generally override this. 231de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addMachinePasses(); 232de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 233de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Create an instance of ScheduleDAGInstrs to be run within the standard 234de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// MachineScheduler pass for this function and target at the current 235de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// optimization level. 236de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 237de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This can also be used to plug a new MachineSchedStrategy into an instance 238de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// of the standard ScheduleDAGMI: 239de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// return new ScheduleDAGMI(C, make_unique<MyStrategy>(C), /*RemoveKillFlags=*/false) 240de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 241de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Return NULL to select the default (generic) machine scheduler. 242de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual ScheduleDAGInstrs * 243de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar createMachineScheduler(MachineSchedContext *C) const { 244de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return nullptr; 245de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 246de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 247de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Similar to createMachineScheduler but used when postRA machine scheduling 248de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// is enabled. 249de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual ScheduleDAGInstrs * 250de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar createPostMachineScheduler(MachineSchedContext *C) const { 251de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return nullptr; 252de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 253de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 254de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// printAndVerify - Add a pass to dump then verify the machine function, if 255de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// those steps are enabled. 256de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 257de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void printAndVerify(const std::string &Banner); 258de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 259de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add a pass to print the machine function if printing is enabled. 260de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void addPrintPass(const std::string &Banner); 261de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 262de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add a pass to perform basic verification of the machine function if 263de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// verification is enabled. 264de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void addVerifyPass(const std::string &Banner); 265de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 266de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainarprotected: 267de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Helper to verify the analysis is really immutable. 268de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void setOpt(bool &Opt, bool Val); 269de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 270de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Methods with trivial inline returns are convenient points in the common 271de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// codegen pass pipeline where targets may insert passes. Methods with 272de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// out-of-line standard implementations are major CodeGen stages called by 273de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addMachinePasses. Some targets may override major stages when inserting 274de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// passes is insufficient, but maintaining overriden stages is more work. 275de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 276de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 277de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addPreISelPasses - This method should add any "last minute" LLVM->LLVM 278de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// passes (which are run just before instruction selector). 279de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual bool addPreISel() { 280de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return true; 281de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 282de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 283de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addMachineSSAOptimization - Add standard passes that optimize machine 284de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// instructions in SSA form. 285de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addMachineSSAOptimization(); 286de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 287de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add passes that optimize instruction level parallelism for out-of-order 288de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// targets. These passes are run while the machine code is still in SSA 289de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// form, so they can use MachineTraceMetrics to control their heuristics. 290de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 291de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// All passes added here should preserve the MachineDominatorTree, 292de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// MachineLoopInfo, and MachineTraceMetrics analyses. 293de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual bool addILPOpts() { 294de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return false; 295de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 296de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 297de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This method may be implemented by targets that want to run passes 298de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// immediately before register allocation. 299de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addPreRegAlloc() { } 300de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 301de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// createTargetRegisterAllocator - Create the register allocator pass for 302de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// this target at the current optimization level. 303de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual FunctionPass *createTargetRegisterAllocator(bool Optimized); 304de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 305de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addFastRegAlloc - Add the minimum set of target-independent passes that 306de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// are required for fast register allocation. 307de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addFastRegAlloc(FunctionPass *RegAllocPass); 308de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 309de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addOptimizedRegAlloc - Add passes related to register allocation. 310de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// LLVMTargetMachine provides standard regalloc passes for most targets. 311de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addOptimizedRegAlloc(FunctionPass *RegAllocPass); 312de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 313de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addPreRewrite - Add passes to the optimized register allocation pipeline 314de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// after register allocation is complete, but before virtual registers are 315de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// rewritten to physical registers. 316de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 317de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// These passes must preserve VirtRegMap and LiveIntervals, and when running 318de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// after RABasic or RAGreedy, they should take advantage of LiveRegMatrix. 319de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// When these passes run, VirtRegMap contains legal physreg assignments for 320de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// all virtual registers. 321de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual bool addPreRewrite() { 322de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar return false; 323de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 324de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 325de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This method may be implemented by targets that want to run passes after 326de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// register allocation pass pipeline but before prolog-epilog insertion. 327de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addPostRegAlloc() { } 328de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 329de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add passes that optimize machine instructions after register allocation. 330de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addMachineLateOptimization(); 331de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 332de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This method may be implemented by targets that want to run passes after 333de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// prolog-epilog insertion and before the second instruction scheduling pass. 334de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addPreSched2() { } 335de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 336de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addGCPasses - Add late codegen passes that analyze code for garbage 337de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// collection. This should return true if GC info should be printed after 338de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// these passes. 339de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual bool addGCPasses(); 340de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 341de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add standard basic block placement passes. 342de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addBlockPlacement(); 343de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 344de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// This pass may be implemented by targets that want to run passes 345de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// immediately before machine code is emitted. 346de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar virtual void addPreEmitPass() { } 347de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 348de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Utilities for targets to add passes to the pass manager. 349de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// 350de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 351de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add a CodeGen pass at this point in the pipeline after checking overrides. 352de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Return the pass that was added, or zero if no pass was added. 353de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// @p printAfter if true and adding a machine function pass add an extra 354de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// machine printer pass afterwards 355de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// @p verifyAfter if true and adding a machine function pass add an extra 356de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// machine verification pass afterwards. 357de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar AnalysisID addPass(AnalysisID PassID, bool verifyAfter = true, 358de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar bool printAfter = true); 359de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 360de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Add a pass to the PassManager if that pass is supposed to be run, as 361de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// determined by the StartAfter and StopAfter options. Takes ownership of the 362de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// pass. 363de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// @p printAfter if true and adding a machine function pass add an extra 364de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// machine printer pass afterwards 365de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// @p verifyAfter if true and adding a machine function pass add an extra 366de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// machine verification pass afterwards. 367de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void addPass(Pass *P, bool verifyAfter = true, bool printAfter = true); 368de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 369de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// addMachinePasses helper to create the target-selected or overriden 370de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// regalloc pass. 371de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar FunctionPass *createRegAllocPass(bool Optimized); 372de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar}; 373de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 374de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar} // end namespace llvm 375de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 376de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#endif 377