xref: /freebsd/contrib/llvm-project/llvm/lib/Target/ARM/ARMTargetMachine.cpp (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
10b57cec5SDimitry Andric //===-- ARMTargetMachine.cpp - Define TargetMachine for ARM ---------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric //
100b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
110b57cec5SDimitry Andric 
120b57cec5SDimitry Andric #include "ARMTargetMachine.h"
130b57cec5SDimitry Andric #include "ARM.h"
14*bdd1243dSDimitry Andric #include "ARMMachineFunctionInfo.h"
150b57cec5SDimitry Andric #include "ARMMacroFusion.h"
160b57cec5SDimitry Andric #include "ARMSubtarget.h"
170b57cec5SDimitry Andric #include "ARMTargetObjectFile.h"
180b57cec5SDimitry Andric #include "ARMTargetTransformInfo.h"
190b57cec5SDimitry Andric #include "MCTargetDesc/ARMMCTargetDesc.h"
200b57cec5SDimitry Andric #include "TargetInfo/ARMTargetInfo.h"
210b57cec5SDimitry Andric #include "llvm/ADT/STLExtras.h"
220b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
230b57cec5SDimitry Andric #include "llvm/ADT/Triple.h"
240b57cec5SDimitry Andric #include "llvm/Analysis/TargetTransformInfo.h"
250b57cec5SDimitry Andric #include "llvm/CodeGen/ExecutionDomainFix.h"
2681ad6265SDimitry Andric #include "llvm/CodeGen/GlobalISel/CSEInfo.h"
270b57cec5SDimitry Andric #include "llvm/CodeGen/GlobalISel/CallLowering.h"
280b57cec5SDimitry Andric #include "llvm/CodeGen/GlobalISel/IRTranslator.h"
290b57cec5SDimitry Andric #include "llvm/CodeGen/GlobalISel/InstructionSelect.h"
300b57cec5SDimitry Andric #include "llvm/CodeGen/GlobalISel/InstructionSelector.h"
310b57cec5SDimitry Andric #include "llvm/CodeGen/GlobalISel/Legalizer.h"
320b57cec5SDimitry Andric #include "llvm/CodeGen/GlobalISel/LegalizerInfo.h"
330b57cec5SDimitry Andric #include "llvm/CodeGen/GlobalISel/RegBankSelect.h"
340b57cec5SDimitry Andric #include "llvm/CodeGen/MachineFunction.h"
350b57cec5SDimitry Andric #include "llvm/CodeGen/MachineScheduler.h"
360b57cec5SDimitry Andric #include "llvm/CodeGen/Passes.h"
3781ad6265SDimitry Andric #include "llvm/CodeGen/RegisterBankInfo.h"
380b57cec5SDimitry Andric #include "llvm/CodeGen/TargetPassConfig.h"
390b57cec5SDimitry Andric #include "llvm/IR/Attributes.h"
400b57cec5SDimitry Andric #include "llvm/IR/DataLayout.h"
410b57cec5SDimitry Andric #include "llvm/IR/Function.h"
42349cc55cSDimitry Andric #include "llvm/MC/TargetRegistry.h"
430b57cec5SDimitry Andric #include "llvm/Pass.h"
4481ad6265SDimitry Andric #include "llvm/Support/ARMTargetParser.h"
450b57cec5SDimitry Andric #include "llvm/Support/CodeGen.h"
460b57cec5SDimitry Andric #include "llvm/Support/CommandLine.h"
470b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h"
480b57cec5SDimitry Andric #include "llvm/Support/TargetParser.h"
490b57cec5SDimitry Andric #include "llvm/Target/TargetLoweringObjectFile.h"
500b57cec5SDimitry Andric #include "llvm/Target/TargetOptions.h"
51480093f4SDimitry Andric #include "llvm/Transforms/CFGuard.h"
52fe6060f1SDimitry Andric #include "llvm/Transforms/IPO.h"
530b57cec5SDimitry Andric #include "llvm/Transforms/Scalar.h"
540b57cec5SDimitry Andric #include <cassert>
550b57cec5SDimitry Andric #include <memory>
56*bdd1243dSDimitry Andric #include <optional>
570b57cec5SDimitry Andric #include <string>
580b57cec5SDimitry Andric 
590b57cec5SDimitry Andric using namespace llvm;
600b57cec5SDimitry Andric 
610b57cec5SDimitry Andric static cl::opt<bool>
620b57cec5SDimitry Andric DisableA15SDOptimization("disable-a15-sd-optimization", cl::Hidden,
630b57cec5SDimitry Andric                    cl::desc("Inhibit optimization of S->D register accesses on A15"),
640b57cec5SDimitry Andric                    cl::init(false));
650b57cec5SDimitry Andric 
660b57cec5SDimitry Andric static cl::opt<bool>
670b57cec5SDimitry Andric EnableAtomicTidy("arm-atomic-cfg-tidy", cl::Hidden,
680b57cec5SDimitry Andric                  cl::desc("Run SimplifyCFG after expanding atomic operations"
690b57cec5SDimitry Andric                           " to make use of cmpxchg flow-based information"),
700b57cec5SDimitry Andric                  cl::init(true));
710b57cec5SDimitry Andric 
720b57cec5SDimitry Andric static cl::opt<bool>
730b57cec5SDimitry Andric EnableARMLoadStoreOpt("arm-load-store-opt", cl::Hidden,
740b57cec5SDimitry Andric                       cl::desc("Enable ARM load/store optimization pass"),
750b57cec5SDimitry Andric                       cl::init(true));
760b57cec5SDimitry Andric 
770b57cec5SDimitry Andric // FIXME: Unify control over GlobalMerge.
780b57cec5SDimitry Andric static cl::opt<cl::boolOrDefault>
790b57cec5SDimitry Andric EnableGlobalMerge("arm-global-merge", cl::Hidden,
800b57cec5SDimitry Andric                   cl::desc("Enable the global merge pass"));
810b57cec5SDimitry Andric 
820b57cec5SDimitry Andric namespace llvm {
830b57cec5SDimitry Andric   void initializeARMExecutionDomainFixPass(PassRegistry&);
840b57cec5SDimitry Andric }
850b57cec5SDimitry Andric 
86480093f4SDimitry Andric extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeARMTarget() {
870b57cec5SDimitry Andric   // Register the target.
880b57cec5SDimitry Andric   RegisterTargetMachine<ARMLETargetMachine> X(getTheARMLETarget());
890b57cec5SDimitry Andric   RegisterTargetMachine<ARMLETargetMachine> A(getTheThumbLETarget());
900b57cec5SDimitry Andric   RegisterTargetMachine<ARMBETargetMachine> Y(getTheARMBETarget());
910b57cec5SDimitry Andric   RegisterTargetMachine<ARMBETargetMachine> B(getTheThumbBETarget());
920b57cec5SDimitry Andric 
930b57cec5SDimitry Andric   PassRegistry &Registry = *PassRegistry::getPassRegistry();
940b57cec5SDimitry Andric   initializeGlobalISel(Registry);
950b57cec5SDimitry Andric   initializeARMLoadStoreOptPass(Registry);
960b57cec5SDimitry Andric   initializeARMPreAllocLoadStoreOptPass(Registry);
970b57cec5SDimitry Andric   initializeARMParallelDSPPass(Registry);
984824e7fdSDimitry Andric   initializeARMBranchTargetsPass(Registry);
990b57cec5SDimitry Andric   initializeARMConstantIslandsPass(Registry);
1000b57cec5SDimitry Andric   initializeARMExecutionDomainFixPass(Registry);
1010b57cec5SDimitry Andric   initializeARMExpandPseudoPass(Registry);
1020b57cec5SDimitry Andric   initializeThumb2SizeReducePass(Registry);
1030b57cec5SDimitry Andric   initializeMVEVPTBlockPass(Registry);
104fe6060f1SDimitry Andric   initializeMVETPAndVPTOptimisationsPass(Registry);
1058bcb0991SDimitry Andric   initializeMVETailPredicationPass(Registry);
1060b57cec5SDimitry Andric   initializeARMLowOverheadLoopsPass(Registry);
107e8d8bef9SDimitry Andric   initializeARMBlockPlacementPass(Registry);
108480093f4SDimitry Andric   initializeMVEGatherScatterLoweringPass(Registry);
109e8d8bef9SDimitry Andric   initializeARMSLSHardeningPass(Registry);
110fe6060f1SDimitry Andric   initializeMVELaneInterleavingPass(Registry);
11181ad6265SDimitry Andric   initializeARMFixCortexA57AES1742098Pass(Registry);
112*bdd1243dSDimitry Andric   initializeARMDAGToDAGISelPass(Registry);
1130b57cec5SDimitry Andric }
1140b57cec5SDimitry Andric 
1150b57cec5SDimitry Andric static std::unique_ptr<TargetLoweringObjectFile> createTLOF(const Triple &TT) {
1160b57cec5SDimitry Andric   if (TT.isOSBinFormatMachO())
1178bcb0991SDimitry Andric     return std::make_unique<TargetLoweringObjectFileMachO>();
1180b57cec5SDimitry Andric   if (TT.isOSWindows())
1198bcb0991SDimitry Andric     return std::make_unique<TargetLoweringObjectFileCOFF>();
1208bcb0991SDimitry Andric   return std::make_unique<ARMElfTargetObjectFile>();
1210b57cec5SDimitry Andric }
1220b57cec5SDimitry Andric 
1230b57cec5SDimitry Andric static ARMBaseTargetMachine::ARMABI
1240b57cec5SDimitry Andric computeTargetABI(const Triple &TT, StringRef CPU,
1250b57cec5SDimitry Andric                  const TargetOptions &Options) {
1260b57cec5SDimitry Andric   StringRef ABIName = Options.MCOptions.getABIName();
1270b57cec5SDimitry Andric 
1280b57cec5SDimitry Andric   if (ABIName.empty())
1290b57cec5SDimitry Andric     ABIName = ARM::computeDefaultTargetABI(TT, CPU);
1300b57cec5SDimitry Andric 
1310b57cec5SDimitry Andric   if (ABIName == "aapcs16")
1320b57cec5SDimitry Andric     return ARMBaseTargetMachine::ARM_ABI_AAPCS16;
1330b57cec5SDimitry Andric   else if (ABIName.startswith("aapcs"))
1340b57cec5SDimitry Andric     return ARMBaseTargetMachine::ARM_ABI_AAPCS;
1350b57cec5SDimitry Andric   else if (ABIName.startswith("apcs"))
1360b57cec5SDimitry Andric     return ARMBaseTargetMachine::ARM_ABI_APCS;
1370b57cec5SDimitry Andric 
1380b57cec5SDimitry Andric   llvm_unreachable("Unhandled/unknown ABI Name!");
1390b57cec5SDimitry Andric   return ARMBaseTargetMachine::ARM_ABI_UNKNOWN;
1400b57cec5SDimitry Andric }
1410b57cec5SDimitry Andric 
1420b57cec5SDimitry Andric static std::string computeDataLayout(const Triple &TT, StringRef CPU,
1430b57cec5SDimitry Andric                                      const TargetOptions &Options,
1440b57cec5SDimitry Andric                                      bool isLittle) {
1450b57cec5SDimitry Andric   auto ABI = computeTargetABI(TT, CPU, Options);
1460b57cec5SDimitry Andric   std::string Ret;
1470b57cec5SDimitry Andric 
1480b57cec5SDimitry Andric   if (isLittle)
1490b57cec5SDimitry Andric     // Little endian.
1500b57cec5SDimitry Andric     Ret += "e";
1510b57cec5SDimitry Andric   else
1520b57cec5SDimitry Andric     // Big endian.
1530b57cec5SDimitry Andric     Ret += "E";
1540b57cec5SDimitry Andric 
1550b57cec5SDimitry Andric   Ret += DataLayout::getManglingComponent(TT);
1560b57cec5SDimitry Andric 
1570b57cec5SDimitry Andric   // Pointers are 32 bits and aligned to 32 bits.
1580b57cec5SDimitry Andric   Ret += "-p:32:32";
1590b57cec5SDimitry Andric 
1600b57cec5SDimitry Andric   // Function pointers are aligned to 8 bits (because the LSB stores the
1610b57cec5SDimitry Andric   // ARM/Thumb state).
1620b57cec5SDimitry Andric   Ret += "-Fi8";
1630b57cec5SDimitry Andric 
1640b57cec5SDimitry Andric   // ABIs other than APCS have 64 bit integers with natural alignment.
1650b57cec5SDimitry Andric   if (ABI != ARMBaseTargetMachine::ARM_ABI_APCS)
1660b57cec5SDimitry Andric     Ret += "-i64:64";
1670b57cec5SDimitry Andric 
1680b57cec5SDimitry Andric   // We have 64 bits floats. The APCS ABI requires them to be aligned to 32
1690b57cec5SDimitry Andric   // bits, others to 64 bits. We always try to align to 64 bits.
1700b57cec5SDimitry Andric   if (ABI == ARMBaseTargetMachine::ARM_ABI_APCS)
1710b57cec5SDimitry Andric     Ret += "-f64:32:64";
1720b57cec5SDimitry Andric 
1730b57cec5SDimitry Andric   // We have 128 and 64 bit vectors. The APCS ABI aligns them to 32 bits, others
1740b57cec5SDimitry Andric   // to 64. We always ty to give them natural alignment.
1750b57cec5SDimitry Andric   if (ABI == ARMBaseTargetMachine::ARM_ABI_APCS)
1760b57cec5SDimitry Andric     Ret += "-v64:32:64-v128:32:128";
1770b57cec5SDimitry Andric   else if (ABI != ARMBaseTargetMachine::ARM_ABI_AAPCS16)
1780b57cec5SDimitry Andric     Ret += "-v128:64:128";
1790b57cec5SDimitry Andric 
1800b57cec5SDimitry Andric   // Try to align aggregates to 32 bits (the default is 64 bits, which has no
1810b57cec5SDimitry Andric   // particular hardware support on 32-bit ARM).
1820b57cec5SDimitry Andric   Ret += "-a:0:32";
1830b57cec5SDimitry Andric 
1840b57cec5SDimitry Andric   // Integer registers are 32 bits.
1850b57cec5SDimitry Andric   Ret += "-n32";
1860b57cec5SDimitry Andric 
1870b57cec5SDimitry Andric   // The stack is 128 bit aligned on NaCl, 64 bit aligned on AAPCS and 32 bit
1880b57cec5SDimitry Andric   // aligned everywhere else.
1890b57cec5SDimitry Andric   if (TT.isOSNaCl() || ABI == ARMBaseTargetMachine::ARM_ABI_AAPCS16)
1900b57cec5SDimitry Andric     Ret += "-S128";
1910b57cec5SDimitry Andric   else if (ABI == ARMBaseTargetMachine::ARM_ABI_AAPCS)
1920b57cec5SDimitry Andric     Ret += "-S64";
1930b57cec5SDimitry Andric   else
1940b57cec5SDimitry Andric     Ret += "-S32";
1950b57cec5SDimitry Andric 
1960b57cec5SDimitry Andric   return Ret;
1970b57cec5SDimitry Andric }
1980b57cec5SDimitry Andric 
1990b57cec5SDimitry Andric static Reloc::Model getEffectiveRelocModel(const Triple &TT,
200*bdd1243dSDimitry Andric                                            std::optional<Reloc::Model> RM) {
20181ad6265SDimitry Andric   if (!RM)
2020b57cec5SDimitry Andric     // Default relocation model on Darwin is PIC.
2030b57cec5SDimitry Andric     return TT.isOSBinFormatMachO() ? Reloc::PIC_ : Reloc::Static;
2040b57cec5SDimitry Andric 
2050b57cec5SDimitry Andric   if (*RM == Reloc::ROPI || *RM == Reloc::RWPI || *RM == Reloc::ROPI_RWPI)
2060b57cec5SDimitry Andric     assert(TT.isOSBinFormatELF() &&
2070b57cec5SDimitry Andric            "ROPI/RWPI currently only supported for ELF");
2080b57cec5SDimitry Andric 
2090b57cec5SDimitry Andric   // DynamicNoPIC is only used on darwin.
2100b57cec5SDimitry Andric   if (*RM == Reloc::DynamicNoPIC && !TT.isOSDarwin())
2110b57cec5SDimitry Andric     return Reloc::Static;
2120b57cec5SDimitry Andric 
2130b57cec5SDimitry Andric   return *RM;
2140b57cec5SDimitry Andric }
2150b57cec5SDimitry Andric 
2160b57cec5SDimitry Andric /// Create an ARM architecture model.
2170b57cec5SDimitry Andric ///
2180b57cec5SDimitry Andric ARMBaseTargetMachine::ARMBaseTargetMachine(const Target &T, const Triple &TT,
2190b57cec5SDimitry Andric                                            StringRef CPU, StringRef FS,
2200b57cec5SDimitry Andric                                            const TargetOptions &Options,
221*bdd1243dSDimitry Andric                                            std::optional<Reloc::Model> RM,
222*bdd1243dSDimitry Andric                                            std::optional<CodeModel::Model> CM,
2230b57cec5SDimitry Andric                                            CodeGenOpt::Level OL, bool isLittle)
2240b57cec5SDimitry Andric     : LLVMTargetMachine(T, computeDataLayout(TT, CPU, Options, isLittle), TT,
2250b57cec5SDimitry Andric                         CPU, FS, Options, getEffectiveRelocModel(TT, RM),
2260b57cec5SDimitry Andric                         getEffectiveCodeModel(CM, CodeModel::Small), OL),
2270b57cec5SDimitry Andric       TargetABI(computeTargetABI(TT, CPU, Options)),
2280b57cec5SDimitry Andric       TLOF(createTLOF(getTargetTriple())), isLittle(isLittle) {
2290b57cec5SDimitry Andric 
2300b57cec5SDimitry Andric   // Default to triple-appropriate float ABI
2310b57cec5SDimitry Andric   if (Options.FloatABIType == FloatABI::Default) {
2320b57cec5SDimitry Andric     if (isTargetHardFloat())
2330b57cec5SDimitry Andric       this->Options.FloatABIType = FloatABI::Hard;
2340b57cec5SDimitry Andric     else
2350b57cec5SDimitry Andric       this->Options.FloatABIType = FloatABI::Soft;
2360b57cec5SDimitry Andric   }
2370b57cec5SDimitry Andric 
2380b57cec5SDimitry Andric   // Default to triple-appropriate EABI
2390b57cec5SDimitry Andric   if (Options.EABIVersion == EABI::Default ||
2400b57cec5SDimitry Andric       Options.EABIVersion == EABI::Unknown) {
2410b57cec5SDimitry Andric     // musl is compatible with glibc with regard to EABI version
2420b57cec5SDimitry Andric     if ((TargetTriple.getEnvironment() == Triple::GNUEABI ||
2430b57cec5SDimitry Andric          TargetTriple.getEnvironment() == Triple::GNUEABIHF ||
2440b57cec5SDimitry Andric          TargetTriple.getEnvironment() == Triple::MuslEABI ||
2450b57cec5SDimitry Andric          TargetTriple.getEnvironment() == Triple::MuslEABIHF) &&
2460b57cec5SDimitry Andric         !(TargetTriple.isOSWindows() || TargetTriple.isOSDarwin()))
2470b57cec5SDimitry Andric       this->Options.EABIVersion = EABI::GNU;
2480b57cec5SDimitry Andric     else
2490b57cec5SDimitry Andric       this->Options.EABIVersion = EABI::EABI5;
2500b57cec5SDimitry Andric   }
2510b57cec5SDimitry Andric 
2520b57cec5SDimitry Andric   if (TT.isOSBinFormatMachO()) {
2530b57cec5SDimitry Andric     this->Options.TrapUnreachable = true;
2540b57cec5SDimitry Andric     this->Options.NoTrapAfterNoreturn = true;
2550b57cec5SDimitry Andric   }
2560b57cec5SDimitry Andric 
2575ffd83dbSDimitry Andric   // ARM supports the debug entry values.
2585ffd83dbSDimitry Andric   setSupportsDebugEntryValues(true);
2595ffd83dbSDimitry Andric 
2600b57cec5SDimitry Andric   initAsmInfo();
2615ffd83dbSDimitry Andric 
2625ffd83dbSDimitry Andric   // ARM supports the MachineOutliner.
2635ffd83dbSDimitry Andric   setMachineOutliner(true);
264e8d8bef9SDimitry Andric   setSupportsDefaultOutlining(true);
2650b57cec5SDimitry Andric }
2660b57cec5SDimitry Andric 
2670b57cec5SDimitry Andric ARMBaseTargetMachine::~ARMBaseTargetMachine() = default;
2680b57cec5SDimitry Andric 
269*bdd1243dSDimitry Andric MachineFunctionInfo *ARMBaseTargetMachine::createMachineFunctionInfo(
270*bdd1243dSDimitry Andric     BumpPtrAllocator &Allocator, const Function &F,
271*bdd1243dSDimitry Andric     const TargetSubtargetInfo *STI) const {
272*bdd1243dSDimitry Andric   return ARMFunctionInfo::create<ARMFunctionInfo>(
273*bdd1243dSDimitry Andric       Allocator, F, static_cast<const ARMSubtarget *>(STI));
274*bdd1243dSDimitry Andric }
275*bdd1243dSDimitry Andric 
2760b57cec5SDimitry Andric const ARMSubtarget *
2770b57cec5SDimitry Andric ARMBaseTargetMachine::getSubtargetImpl(const Function &F) const {
2780b57cec5SDimitry Andric   Attribute CPUAttr = F.getFnAttribute("target-cpu");
2790b57cec5SDimitry Andric   Attribute FSAttr = F.getFnAttribute("target-features");
2800b57cec5SDimitry Andric 
281e8d8bef9SDimitry Andric   std::string CPU =
282e8d8bef9SDimitry Andric       CPUAttr.isValid() ? CPUAttr.getValueAsString().str() : TargetCPU;
283e8d8bef9SDimitry Andric   std::string FS =
284e8d8bef9SDimitry Andric       FSAttr.isValid() ? FSAttr.getValueAsString().str() : TargetFS;
2850b57cec5SDimitry Andric 
2860b57cec5SDimitry Andric   // FIXME: This is related to the code below to reset the target options,
2870b57cec5SDimitry Andric   // we need to know whether or not the soft float flag is set on the
2880b57cec5SDimitry Andric   // function before we can generate a subtarget. We also need to use
2890b57cec5SDimitry Andric   // it as a key for the subtarget since that can be the only difference
2900b57cec5SDimitry Andric   // between two functions.
291fe6060f1SDimitry Andric   bool SoftFloat = F.getFnAttribute("use-soft-float").getValueAsBool();
2920b57cec5SDimitry Andric   // If the soft float attribute is set on the function turn on the soft float
2930b57cec5SDimitry Andric   // subtarget feature.
2940b57cec5SDimitry Andric   if (SoftFloat)
2950b57cec5SDimitry Andric     FS += FS.empty() ? "+soft-float" : ",+soft-float";
2960b57cec5SDimitry Andric 
2970b57cec5SDimitry Andric   // Use the optminsize to identify the subtarget, but don't use it in the
2980b57cec5SDimitry Andric   // feature string.
2990b57cec5SDimitry Andric   std::string Key = CPU + FS;
3000b57cec5SDimitry Andric   if (F.hasMinSize())
3010b57cec5SDimitry Andric     Key += "+minsize";
3020b57cec5SDimitry Andric 
3030b57cec5SDimitry Andric   auto &I = SubtargetMap[Key];
3040b57cec5SDimitry Andric   if (!I) {
3050b57cec5SDimitry Andric     // This needs to be done before we create a new subtarget since any
3060b57cec5SDimitry Andric     // creation will depend on the TM and the code generation flags on the
3070b57cec5SDimitry Andric     // function that reside in TargetOptions.
3080b57cec5SDimitry Andric     resetTargetOptions(F);
3098bcb0991SDimitry Andric     I = std::make_unique<ARMSubtarget>(TargetTriple, CPU, FS, *this, isLittle,
3100b57cec5SDimitry Andric                                         F.hasMinSize());
3110b57cec5SDimitry Andric 
3120b57cec5SDimitry Andric     if (!I->isThumb() && !I->hasARMOps())
3130b57cec5SDimitry Andric       F.getContext().emitError("Function '" + F.getName() + "' uses ARM "
3140b57cec5SDimitry Andric           "instructions, but the target does not support ARM mode execution.");
3150b57cec5SDimitry Andric   }
3160b57cec5SDimitry Andric 
3170b57cec5SDimitry Andric   return I.get();
3180b57cec5SDimitry Andric }
3190b57cec5SDimitry Andric 
3200b57cec5SDimitry Andric TargetTransformInfo
32181ad6265SDimitry Andric ARMBaseTargetMachine::getTargetTransformInfo(const Function &F) const {
3220b57cec5SDimitry Andric   return TargetTransformInfo(ARMTTIImpl(this, F));
3230b57cec5SDimitry Andric }
3240b57cec5SDimitry Andric 
3250b57cec5SDimitry Andric ARMLETargetMachine::ARMLETargetMachine(const Target &T, const Triple &TT,
3260b57cec5SDimitry Andric                                        StringRef CPU, StringRef FS,
3270b57cec5SDimitry Andric                                        const TargetOptions &Options,
328*bdd1243dSDimitry Andric                                        std::optional<Reloc::Model> RM,
329*bdd1243dSDimitry Andric                                        std::optional<CodeModel::Model> CM,
3300b57cec5SDimitry Andric                                        CodeGenOpt::Level OL, bool JIT)
3310b57cec5SDimitry Andric     : ARMBaseTargetMachine(T, TT, CPU, FS, Options, RM, CM, OL, true) {}
3320b57cec5SDimitry Andric 
3330b57cec5SDimitry Andric ARMBETargetMachine::ARMBETargetMachine(const Target &T, const Triple &TT,
3340b57cec5SDimitry Andric                                        StringRef CPU, StringRef FS,
3350b57cec5SDimitry Andric                                        const TargetOptions &Options,
336*bdd1243dSDimitry Andric                                        std::optional<Reloc::Model> RM,
337*bdd1243dSDimitry Andric                                        std::optional<CodeModel::Model> CM,
3380b57cec5SDimitry Andric                                        CodeGenOpt::Level OL, bool JIT)
3390b57cec5SDimitry Andric     : ARMBaseTargetMachine(T, TT, CPU, FS, Options, RM, CM, OL, false) {}
3400b57cec5SDimitry Andric 
3410b57cec5SDimitry Andric namespace {
3420b57cec5SDimitry Andric 
3430b57cec5SDimitry Andric /// ARM Code Generator Pass Configuration Options.
3440b57cec5SDimitry Andric class ARMPassConfig : public TargetPassConfig {
3450b57cec5SDimitry Andric public:
3460b57cec5SDimitry Andric   ARMPassConfig(ARMBaseTargetMachine &TM, PassManagerBase &PM)
347480093f4SDimitry Andric       : TargetPassConfig(TM, PM) {}
3480b57cec5SDimitry Andric 
3490b57cec5SDimitry Andric   ARMBaseTargetMachine &getARMTargetMachine() const {
3500b57cec5SDimitry Andric     return getTM<ARMBaseTargetMachine>();
3510b57cec5SDimitry Andric   }
3520b57cec5SDimitry Andric 
3530b57cec5SDimitry Andric   ScheduleDAGInstrs *
3540b57cec5SDimitry Andric   createMachineScheduler(MachineSchedContext *C) const override {
3550b57cec5SDimitry Andric     ScheduleDAGMILive *DAG = createGenericSchedLive(C);
3560b57cec5SDimitry Andric     // add DAG Mutations here.
3570b57cec5SDimitry Andric     const ARMSubtarget &ST = C->MF->getSubtarget<ARMSubtarget>();
3580b57cec5SDimitry Andric     if (ST.hasFusion())
3590b57cec5SDimitry Andric       DAG->addMutation(createARMMacroFusionDAGMutation());
3600b57cec5SDimitry Andric     return DAG;
3610b57cec5SDimitry Andric   }
3620b57cec5SDimitry Andric 
3630b57cec5SDimitry Andric   ScheduleDAGInstrs *
3640b57cec5SDimitry Andric   createPostMachineScheduler(MachineSchedContext *C) const override {
3650b57cec5SDimitry Andric     ScheduleDAGMI *DAG = createGenericSchedPostRA(C);
3660b57cec5SDimitry Andric     // add DAG Mutations here.
3670b57cec5SDimitry Andric     const ARMSubtarget &ST = C->MF->getSubtarget<ARMSubtarget>();
3680b57cec5SDimitry Andric     if (ST.hasFusion())
3690b57cec5SDimitry Andric       DAG->addMutation(createARMMacroFusionDAGMutation());
3700b57cec5SDimitry Andric     return DAG;
3710b57cec5SDimitry Andric   }
3720b57cec5SDimitry Andric 
3730b57cec5SDimitry Andric   void addIRPasses() override;
3740b57cec5SDimitry Andric   void addCodeGenPrepare() override;
3750b57cec5SDimitry Andric   bool addPreISel() override;
3760b57cec5SDimitry Andric   bool addInstSelector() override;
3770b57cec5SDimitry Andric   bool addIRTranslator() override;
3780b57cec5SDimitry Andric   bool addLegalizeMachineIR() override;
3790b57cec5SDimitry Andric   bool addRegBankSelect() override;
3800b57cec5SDimitry Andric   bool addGlobalInstructionSelect() override;
3810b57cec5SDimitry Andric   void addPreRegAlloc() override;
3820b57cec5SDimitry Andric   void addPreSched2() override;
3830b57cec5SDimitry Andric   void addPreEmitPass() override;
3845ffd83dbSDimitry Andric   void addPreEmitPass2() override;
3850b57cec5SDimitry Andric 
3860b57cec5SDimitry Andric   std::unique_ptr<CSEConfigBase> getCSEConfig() const override;
3870b57cec5SDimitry Andric };
3880b57cec5SDimitry Andric 
3890b57cec5SDimitry Andric class ARMExecutionDomainFix : public ExecutionDomainFix {
3900b57cec5SDimitry Andric public:
3910b57cec5SDimitry Andric   static char ID;
3920b57cec5SDimitry Andric   ARMExecutionDomainFix() : ExecutionDomainFix(ID, ARM::DPRRegClass) {}
3930b57cec5SDimitry Andric   StringRef getPassName() const override {
3940b57cec5SDimitry Andric     return "ARM Execution Domain Fix";
3950b57cec5SDimitry Andric   }
3960b57cec5SDimitry Andric };
3970b57cec5SDimitry Andric char ARMExecutionDomainFix::ID;
3980b57cec5SDimitry Andric 
3990b57cec5SDimitry Andric } // end anonymous namespace
4000b57cec5SDimitry Andric 
4010b57cec5SDimitry Andric INITIALIZE_PASS_BEGIN(ARMExecutionDomainFix, "arm-execution-domain-fix",
4020b57cec5SDimitry Andric   "ARM Execution Domain Fix", false, false)
4030b57cec5SDimitry Andric INITIALIZE_PASS_DEPENDENCY(ReachingDefAnalysis)
4040b57cec5SDimitry Andric INITIALIZE_PASS_END(ARMExecutionDomainFix, "arm-execution-domain-fix",
4050b57cec5SDimitry Andric   "ARM Execution Domain Fix", false, false)
4060b57cec5SDimitry Andric 
4070b57cec5SDimitry Andric TargetPassConfig *ARMBaseTargetMachine::createPassConfig(PassManagerBase &PM) {
4080b57cec5SDimitry Andric   return new ARMPassConfig(*this, PM);
4090b57cec5SDimitry Andric }
4100b57cec5SDimitry Andric 
4110b57cec5SDimitry Andric std::unique_ptr<CSEConfigBase> ARMPassConfig::getCSEConfig() const {
4120b57cec5SDimitry Andric   return getStandardCSEConfigForOpt(TM->getOptLevel());
4130b57cec5SDimitry Andric }
4140b57cec5SDimitry Andric 
4150b57cec5SDimitry Andric void ARMPassConfig::addIRPasses() {
4160b57cec5SDimitry Andric   if (TM->Options.ThreadModel == ThreadModel::Single)
4170b57cec5SDimitry Andric     addPass(createLowerAtomicPass());
4180b57cec5SDimitry Andric   else
4190b57cec5SDimitry Andric     addPass(createAtomicExpandPass());
4200b57cec5SDimitry Andric 
4210b57cec5SDimitry Andric   // Cmpxchg instructions are often used with a subsequent comparison to
4220b57cec5SDimitry Andric   // determine whether it succeeded. We can exploit existing control-flow in
4230b57cec5SDimitry Andric   // ldrex/strex loops to simplify this, but it needs tidying up.
4240b57cec5SDimitry Andric   if (TM->getOptLevel() != CodeGenOpt::None && EnableAtomicTidy)
4250b57cec5SDimitry Andric     addPass(createCFGSimplificationPass(
426e8d8bef9SDimitry Andric         SimplifyCFGOptions().hoistCommonInsts(true).sinkCommonInsts(true),
427e8d8bef9SDimitry Andric         [this](const Function &F) {
4280b57cec5SDimitry Andric           const auto &ST = this->TM->getSubtarget<ARMSubtarget>(F);
4290b57cec5SDimitry Andric           return ST.hasAnyDataBarrier() && !ST.isThumb1Only();
4300b57cec5SDimitry Andric         }));
4310b57cec5SDimitry Andric 
432480093f4SDimitry Andric   addPass(createMVEGatherScatterLoweringPass());
433fe6060f1SDimitry Andric   addPass(createMVELaneInterleavingPass());
434480093f4SDimitry Andric 
4350b57cec5SDimitry Andric   TargetPassConfig::addIRPasses();
4360b57cec5SDimitry Andric 
4370b57cec5SDimitry Andric   // Run the parallel DSP pass.
4380b57cec5SDimitry Andric   if (getOptLevel() == CodeGenOpt::Aggressive)
4390b57cec5SDimitry Andric     addPass(createARMParallelDSPPass());
4400b57cec5SDimitry Andric 
441*bdd1243dSDimitry Andric   // Match complex arithmetic patterns
442*bdd1243dSDimitry Andric   if (TM->getOptLevel() >= CodeGenOpt::Default)
443*bdd1243dSDimitry Andric     addPass(createComplexDeinterleavingPass(TM));
444*bdd1243dSDimitry Andric 
4450b57cec5SDimitry Andric   // Match interleaved memory accesses to ldN/stN intrinsics.
4460b57cec5SDimitry Andric   if (TM->getOptLevel() != CodeGenOpt::None)
4470b57cec5SDimitry Andric     addPass(createInterleavedAccessPass());
448480093f4SDimitry Andric 
449480093f4SDimitry Andric   // Add Control Flow Guard checks.
450480093f4SDimitry Andric   if (TM->getTargetTriple().isOSWindows())
451480093f4SDimitry Andric     addPass(createCFGuardCheckPass());
45281ad6265SDimitry Andric 
45381ad6265SDimitry Andric   if (TM->Options.JMCInstrument)
45481ad6265SDimitry Andric     addPass(createJMCInstrumenterPass());
4550b57cec5SDimitry Andric }
4560b57cec5SDimitry Andric 
4570b57cec5SDimitry Andric void ARMPassConfig::addCodeGenPrepare() {
4580b57cec5SDimitry Andric   if (getOptLevel() != CodeGenOpt::None)
459*bdd1243dSDimitry Andric     addPass(createTypePromotionLegacyPass());
4600b57cec5SDimitry Andric   TargetPassConfig::addCodeGenPrepare();
4610b57cec5SDimitry Andric }
4620b57cec5SDimitry Andric 
4630b57cec5SDimitry Andric bool ARMPassConfig::addPreISel() {
4640b57cec5SDimitry Andric   if ((TM->getOptLevel() != CodeGenOpt::None &&
4650b57cec5SDimitry Andric        EnableGlobalMerge == cl::BOU_UNSET) ||
4660b57cec5SDimitry Andric       EnableGlobalMerge == cl::BOU_TRUE) {
4670b57cec5SDimitry Andric     // FIXME: This is using the thumb1 only constant value for
4680b57cec5SDimitry Andric     // maximal global offset for merging globals. We may want
4690b57cec5SDimitry Andric     // to look into using the old value for non-thumb1 code of
4700b57cec5SDimitry Andric     // 4095 based on the TargetMachine, but this starts to become
4710b57cec5SDimitry Andric     // tricky when doing code gen per function.
4720b57cec5SDimitry Andric     bool OnlyOptimizeForSize = (TM->getOptLevel() < CodeGenOpt::Aggressive) &&
4730b57cec5SDimitry Andric                                (EnableGlobalMerge == cl::BOU_UNSET);
4740b57cec5SDimitry Andric     // Merging of extern globals is enabled by default on non-Mach-O as we
4750b57cec5SDimitry Andric     // expect it to be generally either beneficial or harmless. On Mach-O it
4760b57cec5SDimitry Andric     // is disabled as we emit the .subsections_via_symbols directive which
4770b57cec5SDimitry Andric     // means that merging extern globals is not safe.
4780b57cec5SDimitry Andric     bool MergeExternalByDefault = !TM->getTargetTriple().isOSBinFormatMachO();
4790b57cec5SDimitry Andric     addPass(createGlobalMergePass(TM, 127, OnlyOptimizeForSize,
4800b57cec5SDimitry Andric                                   MergeExternalByDefault));
4810b57cec5SDimitry Andric   }
4820b57cec5SDimitry Andric 
4838bcb0991SDimitry Andric   if (TM->getOptLevel() != CodeGenOpt::None) {
4840b57cec5SDimitry Andric     addPass(createHardwareLoopsPass());
4858bcb0991SDimitry Andric     addPass(createMVETailPredicationPass());
486fe6060f1SDimitry Andric     // FIXME: IR passes can delete address-taken basic blocks, deleting
487fe6060f1SDimitry Andric     // corresponding blockaddresses. ARMConstantPoolConstant holds references to
488fe6060f1SDimitry Andric     // address-taken basic blocks which can be invalidated if the function
489fe6060f1SDimitry Andric     // containing the blockaddress has already been codegen'd and the basic
490fe6060f1SDimitry Andric     // block is removed. Work around this by forcing all IR passes to run before
491fe6060f1SDimitry Andric     // any ISel takes place. We should have a more principled way of handling
492fe6060f1SDimitry Andric     // this. See D99707 for more details.
493fe6060f1SDimitry Andric     addPass(createBarrierNoopPass());
4948bcb0991SDimitry Andric   }
4950b57cec5SDimitry Andric 
4960b57cec5SDimitry Andric   return false;
4970b57cec5SDimitry Andric }
4980b57cec5SDimitry Andric 
4990b57cec5SDimitry Andric bool ARMPassConfig::addInstSelector() {
5000b57cec5SDimitry Andric   addPass(createARMISelDag(getARMTargetMachine(), getOptLevel()));
5010b57cec5SDimitry Andric   return false;
5020b57cec5SDimitry Andric }
5030b57cec5SDimitry Andric 
5040b57cec5SDimitry Andric bool ARMPassConfig::addIRTranslator() {
505e8d8bef9SDimitry Andric   addPass(new IRTranslator(getOptLevel()));
5060b57cec5SDimitry Andric   return false;
5070b57cec5SDimitry Andric }
5080b57cec5SDimitry Andric 
5090b57cec5SDimitry Andric bool ARMPassConfig::addLegalizeMachineIR() {
5100b57cec5SDimitry Andric   addPass(new Legalizer());
5110b57cec5SDimitry Andric   return false;
5120b57cec5SDimitry Andric }
5130b57cec5SDimitry Andric 
5140b57cec5SDimitry Andric bool ARMPassConfig::addRegBankSelect() {
5150b57cec5SDimitry Andric   addPass(new RegBankSelect());
5160b57cec5SDimitry Andric   return false;
5170b57cec5SDimitry Andric }
5180b57cec5SDimitry Andric 
5190b57cec5SDimitry Andric bool ARMPassConfig::addGlobalInstructionSelect() {
520fe6060f1SDimitry Andric   addPass(new InstructionSelect(getOptLevel()));
5210b57cec5SDimitry Andric   return false;
5220b57cec5SDimitry Andric }
5230b57cec5SDimitry Andric 
5240b57cec5SDimitry Andric void ARMPassConfig::addPreRegAlloc() {
5250b57cec5SDimitry Andric   if (getOptLevel() != CodeGenOpt::None) {
52681ad6265SDimitry Andric     if (getOptLevel() == CodeGenOpt::Aggressive)
52781ad6265SDimitry Andric       addPass(&MachinePipelinerID);
52881ad6265SDimitry Andric 
529fe6060f1SDimitry Andric     addPass(createMVETPAndVPTOptimisationsPass());
5305ffd83dbSDimitry Andric 
5310b57cec5SDimitry Andric     addPass(createMLxExpansionPass());
5320b57cec5SDimitry Andric 
5330b57cec5SDimitry Andric     if (EnableARMLoadStoreOpt)
5340b57cec5SDimitry Andric       addPass(createARMLoadStoreOptimizationPass(/* pre-register alloc */ true));
5350b57cec5SDimitry Andric 
5360b57cec5SDimitry Andric     if (!DisableA15SDOptimization)
5370b57cec5SDimitry Andric       addPass(createA15SDOptimizerPass());
5380b57cec5SDimitry Andric   }
5390b57cec5SDimitry Andric }
5400b57cec5SDimitry Andric 
5410b57cec5SDimitry Andric void ARMPassConfig::addPreSched2() {
5420b57cec5SDimitry Andric   if (getOptLevel() != CodeGenOpt::None) {
5430b57cec5SDimitry Andric     if (EnableARMLoadStoreOpt)
5440b57cec5SDimitry Andric       addPass(createARMLoadStoreOptimizationPass());
5450b57cec5SDimitry Andric 
5460b57cec5SDimitry Andric     addPass(new ARMExecutionDomainFix());
5470b57cec5SDimitry Andric     addPass(createBreakFalseDeps());
5480b57cec5SDimitry Andric   }
5490b57cec5SDimitry Andric 
5500b57cec5SDimitry Andric   // Expand some pseudo instructions into multiple instructions to allow
5510b57cec5SDimitry Andric   // proper scheduling.
5520b57cec5SDimitry Andric   addPass(createARMExpandPseudoPass());
5530b57cec5SDimitry Andric 
5540b57cec5SDimitry Andric   if (getOptLevel() != CodeGenOpt::None) {
5555ffd83dbSDimitry Andric     // When optimising for size, always run the Thumb2SizeReduction pass before
5565ffd83dbSDimitry Andric     // IfConversion. Otherwise, check whether IT blocks are restricted
5575ffd83dbSDimitry Andric     // (e.g. in v8, IfConversion depends on Thumb instruction widths)
5580b57cec5SDimitry Andric     addPass(createThumb2SizeReductionPass([this](const Function &F) {
5595ffd83dbSDimitry Andric       return this->TM->getSubtarget<ARMSubtarget>(F).hasMinSize() ||
5605ffd83dbSDimitry Andric              this->TM->getSubtarget<ARMSubtarget>(F).restrictIT();
5610b57cec5SDimitry Andric     }));
5620b57cec5SDimitry Andric 
5630b57cec5SDimitry Andric     addPass(createIfConverter([](const MachineFunction &MF) {
5640b57cec5SDimitry Andric       return !MF.getSubtarget<ARMSubtarget>().isThumb1Only();
5650b57cec5SDimitry Andric     }));
5660b57cec5SDimitry Andric   }
5670b57cec5SDimitry Andric   addPass(createThumb2ITBlockPass());
568480093f4SDimitry Andric 
569480093f4SDimitry Andric   // Add both scheduling passes to give the subtarget an opportunity to pick
570480093f4SDimitry Andric   // between them.
571480093f4SDimitry Andric   if (getOptLevel() != CodeGenOpt::None) {
572480093f4SDimitry Andric     addPass(&PostMachineSchedulerID);
573480093f4SDimitry Andric     addPass(&PostRASchedulerID);
574480093f4SDimitry Andric   }
575e8d8bef9SDimitry Andric 
576349cc55cSDimitry Andric   addPass(createMVEVPTBlockPass());
577e8d8bef9SDimitry Andric   addPass(createARMIndirectThunks());
578e8d8bef9SDimitry Andric   addPass(createARMSLSHardeningPass());
5790b57cec5SDimitry Andric }
5800b57cec5SDimitry Andric 
5810b57cec5SDimitry Andric void ARMPassConfig::addPreEmitPass() {
5820b57cec5SDimitry Andric   addPass(createThumb2SizeReductionPass());
5830b57cec5SDimitry Andric 
5840b57cec5SDimitry Andric   // Constant island pass work on unbundled instructions.
5850b57cec5SDimitry Andric   addPass(createUnpackMachineBundles([](const MachineFunction &MF) {
5860b57cec5SDimitry Andric     return MF.getSubtarget<ARMSubtarget>().isThumb2();
5870b57cec5SDimitry Andric   }));
5880b57cec5SDimitry Andric 
589e8d8bef9SDimitry Andric   // Don't optimize barriers or block placement at -O0.
590e8d8bef9SDimitry Andric   if (getOptLevel() != CodeGenOpt::None) {
591e8d8bef9SDimitry Andric     addPass(createARMBlockPlacementPass());
5920b57cec5SDimitry Andric     addPass(createARMOptimizeBarriersPass());
5935ffd83dbSDimitry Andric   }
594e8d8bef9SDimitry Andric }
5950b57cec5SDimitry Andric 
5965ffd83dbSDimitry Andric void ARMPassConfig::addPreEmitPass2() {
59781ad6265SDimitry Andric   // Inserts fixup instructions before unsafe AES operations. Instructions may
59881ad6265SDimitry Andric   // be inserted at the start of blocks and at within blocks so this pass has to
59981ad6265SDimitry Andric   // come before those below.
60081ad6265SDimitry Andric   addPass(createARMFixCortexA57AES1742098Pass());
60181ad6265SDimitry Andric   // Inserts BTIs at the start of functions and indirectly-called basic blocks,
60281ad6265SDimitry Andric   // so passes cannot add to the start of basic blocks once this has run.
6034824e7fdSDimitry Andric   addPass(createARMBranchTargetsPass());
60481ad6265SDimitry Andric   // Inserts Constant Islands. Block sizes cannot be increased after this point,
60581ad6265SDimitry Andric   // as this may push the branch ranges and load offsets of accessing constant
60681ad6265SDimitry Andric   // pools out of range..
6070b57cec5SDimitry Andric   addPass(createARMConstantIslandPass());
60881ad6265SDimitry Andric   // Finalises Low-Overhead Loops. This replaces pseudo instructions with real
60981ad6265SDimitry Andric   // instructions, but the pseudos all have conservative sizes so that block
61081ad6265SDimitry Andric   // sizes will only be decreased by this pass.
6110b57cec5SDimitry Andric   addPass(createARMLowOverheadLoopsPass());
612480093f4SDimitry Andric 
613fe6060f1SDimitry Andric   if (TM->getTargetTriple().isOSWindows()) {
614480093f4SDimitry Andric     // Identify valid longjmp targets for Windows Control Flow Guard.
615480093f4SDimitry Andric     addPass(createCFGuardLongjmpPass());
616fe6060f1SDimitry Andric     // Identify valid eh continuation targets for Windows EHCont Guard.
617fe6060f1SDimitry Andric     addPass(createEHContGuardCatchretPass());
618fe6060f1SDimitry Andric   }
6190b57cec5SDimitry Andric }
620