lib/Target/ARM/ARMSubtarget.h

   1 //===-- ARMSubtarget.h - Define Subtarget for the ARM ----------*- C++ -*--===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the ARM specific subclass of TargetSubtargetInfo.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_LIB_TARGET_ARM_ARMSUBTARGET_H
  15 #define LLVM_LIB_TARGET_ARM_ARMSUBTARGET_H
  16
  17
  18 #include "ARMFrameLowering.h"
  19 #include "ARMISelLowering.h"
  20 #include "ARMInstrInfo.h"
  21 #include "ARMSelectionDAGInfo.h"
  22 #include "ARMSubtarget.h"
  23 #include "MCTargetDesc/ARMMCTargetDesc.h"
  24 #include "Thumb1FrameLowering.h"
  25 #include "Thumb1InstrInfo.h"
  26 #include "Thumb2InstrInfo.h"
  27 #include "llvm/ADT/Triple.h"
  28 #include "llvm/IR/DataLayout.h"
  29 #include "llvm/MC/MCInstrItineraries.h"
  30 #include "llvm/Target/TargetSubtargetInfo.h"
  31 #include <string>
  32
  33 #define GET_SUBTARGETINFO_HEADER
  34 #include "ARMGenSubtargetInfo.inc"
  35
  36 namespace llvm {
  37 class GlobalValue;
  38 class StringRef;
  39 class TargetOptions;
  40 class ARMBaseTargetMachine;
  41
  42 class ARMSubtarget : public ARMGenSubtargetInfo {
  43 protected:
  44   enum ARMProcFamilyEnum {
  45     Others, CortexA5, CortexA7, CortexA8, CortexA9, CortexA12, CortexA15,
  46     CortexA17, CortexR5, Swift, CortexA53, CortexA57, Krait,
  47   };
  48   enum ARMProcClassEnum {
  49     None, AClass, RClass, MClass
  50   };
  51
  52   /// ARMProcFamily - ARM processor family: Cortex-A8, Cortex-A9, and others.
  53   ARMProcFamilyEnum ARMProcFamily;
  54
  55   /// ARMProcClass - ARM processor class: None, AClass, RClass or MClass.
  56   ARMProcClassEnum ARMProcClass;
  57
  58   /// HasV4TOps, HasV5TOps, HasV5TEOps,
  59   /// HasV6Ops, HasV6MOps, HasV6T2Ops, HasV7Ops, HasV8Ops -
  60   /// Specify whether target support specific ARM ISA variants.
  61   bool HasV4TOps;
  62   bool HasV5TOps;
  63   bool HasV5TEOps;
  64   bool HasV6Ops;
  65   bool HasV6MOps;
  66   bool HasV6T2Ops;
  67   bool HasV7Ops;
  68   bool HasV8Ops;
  69
  70   /// HasVFPv2, HasVFPv3, HasVFPv4, HasFPARMv8, HasNEON - Specify what
  71   /// floating point ISAs are supported.
  72   bool HasVFPv2;
  73   bool HasVFPv3;
  74   bool HasVFPv4;
  75   bool HasFPARMv8;
  76   bool HasNEON;
  77
  78   /// UseNEONForSinglePrecisionFP - if the NEONFP attribute has been
  79   /// specified. Use the method useNEONForSinglePrecisionFP() to
  80   /// determine if NEON should actually be used.
  81   bool UseNEONForSinglePrecisionFP;
  82
  83   /// UseMulOps - True if non-microcoded fused integer multiply-add and
  84   /// multiply-subtract instructions should be used.
  85   bool UseMulOps;
  86
  87   /// SlowFPVMLx - If the VFP2 / NEON instructions are available, indicates
  88   /// whether the FP VML[AS] instructions are slow (if so, don't use them).
  89   bool SlowFPVMLx;
  90
  91   /// HasVMLxForwarding - If true, NEON has special multiplier accumulator
  92   /// forwarding to allow mul + mla being issued back to back.
  93   bool HasVMLxForwarding;
  94
  95   /// SlowFPBrcc - True if floating point compare + branch is slow.
  96   bool SlowFPBrcc;
  97
  98   /// InThumbMode - True if compiling for Thumb, false for ARM.
  99   bool InThumbMode;
 100
 101   /// HasThumb2 - True if Thumb2 instructions are supported.
 102   bool HasThumb2;
 103
 104   /// NoARM - True if subtarget does not support ARM mode execution.
 105   bool NoARM;
 106
 107   /// IsR9Reserved - True if R9 is a not available as general purpose register.
 108   bool IsR9Reserved;
 109
 110   /// UseMovt - True if MOVT / MOVW pairs are used for materialization of 32-bit
 111   /// imms (including global addresses).
 112   bool UseMovt;
 113
 114   /// SupportsTailCall - True if the OS supports tail call. The dynamic linker
 115   /// must be able to synthesize call stubs for interworking between ARM and
 116   /// Thumb.
 117   bool SupportsTailCall;
 118
 119   /// HasFP16 - True if subtarget supports half-precision FP (We support VFP+HF
 120   /// only so far)
 121   bool HasFP16;
 122
 123   /// HasD16 - True if subtarget is limited to 16 double precision
 124   /// FP registers for VFPv3.
 125   bool HasD16;
 126
 127   /// HasHardwareDivide - True if subtarget supports [su]div
 128   bool HasHardwareDivide;
 129
 130   /// HasHardwareDivideInARM - True if subtarget supports [su]div in ARM mode
 131   bool HasHardwareDivideInARM;
 132
 133   /// HasT2ExtractPack - True if subtarget supports thumb2 extract/pack
 134   /// instructions.
 135   bool HasT2ExtractPack;
 136
 137   /// HasDataBarrier - True if the subtarget supports DMB / DSB data barrier
 138   /// instructions.
 139   bool HasDataBarrier;
 140
 141   /// Pref32BitThumb - If true, codegen would prefer 32-bit Thumb instructions
 142   /// over 16-bit ones.
 143   bool Pref32BitThumb;
 144
 145   /// AvoidCPSRPartialUpdate - If true, codegen would avoid using instructions
 146   /// that partially update CPSR and add false dependency on the previous
 147   /// CPSR setting instruction.
 148   bool AvoidCPSRPartialUpdate;
 149
 150   /// AvoidMOVsShifterOperand - If true, codegen should avoid using flag setting
 151   /// movs with shifter operand (i.e. asr, lsl, lsr).
 152   bool AvoidMOVsShifterOperand;
 153
 154   /// HasRAS - Some processors perform return stack prediction. CodeGen should
 155   /// avoid issue "normal" call instructions to callees which do not return.
 156   bool HasRAS;
 157
 158   /// HasMPExtension - True if the subtarget supports Multiprocessing
 159   /// extension (ARMv7 only).
 160   bool HasMPExtension;
 161
 162   /// HasVirtualization - True if the subtarget supports the Virtualization
 163   /// extension.
 164   bool HasVirtualization;
 165
 166   /// FPOnlySP - If true, the floating point unit only supports single
 167   /// precision.
 168   bool FPOnlySP;
 169
 170   /// If true, the processor supports the Performance Monitor Extensions. These
 171   /// include a generic cycle-counter as well as more fine-grained (often
 172   /// implementation-specific) events.
 173   bool HasPerfMon;
 174
 175   /// HasTrustZone - if true, processor supports TrustZone security extensions
 176   bool HasTrustZone;
 177
 178   /// HasCrypto - if true, processor supports Cryptography extensions
 179   bool HasCrypto;
 180
 181   /// HasCRC - if true, processor supports CRC instructions
 182   bool HasCRC;
 183
 184   /// If true, the instructions "vmov.i32 d0, #0" and "vmov.i32 q0, #0" are
 185   /// particularly effective at zeroing a VFP register.
 186   bool HasZeroCycleZeroing;
 187
 188   /// AllowsUnalignedMem - If true, the subtarget allows unaligned memory
 189   /// accesses for some types.  For details, see
 190   /// ARMTargetLowering::allowsMisalignedMemoryAccesses().
 191   bool AllowsUnalignedMem;
 192
 193   /// RestrictIT - If true, the subtarget disallows generation of deprecated IT
 194   ///  blocks to conform to ARMv8 rule.
 195   bool RestrictIT;
 196
 197   /// Thumb2DSP - If true, the subtarget supports the v7 DSP (saturating arith
 198   /// and such) instructions in Thumb2 code.
 199   bool Thumb2DSP;
 200
 201   /// NaCl TRAP instruction is generated instead of the regular TRAP.
 202   bool UseNaClTrap;
 203
 204   /// Target machine allowed unsafe FP math (such as use of NEON fp)
 205   bool UnsafeFPMath;
 206
 207   /// stackAlignment - The minimum alignment known to hold of the stack frame on
 208   /// entry to the function and which must be maintained by every function.
 209   unsigned stackAlignment;
 210
 211   /// CPUString - String name of used CPU.
 212   std::string CPUString;
 213
 214   /// IsLittle - The target is Little Endian
 215   bool IsLittle;
 216
 217   /// TargetTriple - What processor and OS we're targeting.
 218   Triple TargetTriple;
 219
 220   /// SchedModel - Processor specific instruction costs.
 221   MCSchedModel SchedModel;
 222
 223   /// Selected instruction itineraries (one entry per itinerary class.)
 224   InstrItineraryData InstrItins;
 225
 226   /// Options passed via command line that could influence the target
 227   const TargetOptions &Options;
 228
 229   const ARMBaseTargetMachine &TM;
 230
 231 public:
 232   /// This constructor initializes the data members to match that
 233   /// of the specified triple.
 234   ///
 235   ARMSubtarget(const std::string &TT, const std::string &CPU,
 236                const std::string &FS, const ARMBaseTargetMachine &TM, bool IsLittle);
 237
 238   /// getMaxInlineSizeThreshold - Returns the maximum memset / memcpy size
 239   /// that still makes it profitable to inline the call.
 240   unsigned getMaxInlineSizeThreshold() const {
 241     return 64;
 242   }
 243   /// ParseSubtargetFeatures - Parses features string setting specified
 244   /// subtarget options.  Definition of function is auto generated by tblgen.
 245   void ParseSubtargetFeatures(StringRef CPU, StringRef FS);
 246
 247   /// initializeSubtargetDependencies - Initializes using a CPU and feature string
 248   /// so that we can use initializer lists for subtarget initialization.
 249   ARMSubtarget &initializeSubtargetDependencies(StringRef CPU, StringRef FS);
 250
 251   const ARMSelectionDAGInfo *getSelectionDAGInfo() const override {
 252     return &TSInfo;
 253   }
 254   const ARMBaseInstrInfo *getInstrInfo() const override {
 255     return InstrInfo.get();
 256   }
 257   const ARMTargetLowering *getTargetLowering() const override {
 258     return &TLInfo;
 259   }
 260   const ARMFrameLowering *getFrameLowering() const override {
 261     return FrameLowering.get();
 262   }
 263   const ARMBaseRegisterInfo *getRegisterInfo() const override {
 264     return &InstrInfo->getRegisterInfo();
 265   }
 266
 267 private:
 268   ARMSelectionDAGInfo TSInfo;
 269   // Either Thumb1FrameLowering or ARMFrameLowering.
 270   std::unique_ptr<ARMFrameLowering> FrameLowering;
 271   // Either Thumb1InstrInfo or Thumb2InstrInfo.
 272   std::unique_ptr<ARMBaseInstrInfo> InstrInfo;
 273   ARMTargetLowering   TLInfo;
 274
 275   void initializeEnvironment();
 276   void initSubtargetFeatures(StringRef CPU, StringRef FS);
 277   ARMFrameLowering *initializeFrameLowering(StringRef CPU, StringRef FS);
 278
 279 public:
 280   void computeIssueWidth();
 281
 282   bool hasV4TOps()  const { return HasV4TOps;  }
 283   bool hasV5TOps()  const { return HasV5TOps;  }
 284   bool hasV5TEOps() const { return HasV5TEOps; }
 285   bool hasV6Ops()   const { return HasV6Ops;   }
 286   bool hasV6MOps()  const { return HasV6MOps;  }
 287   bool hasV6T2Ops() const { return HasV6T2Ops; }
 288   bool hasV7Ops()   const { return HasV7Ops;  }
 289   bool hasV8Ops()   const { return HasV8Ops;  }
 290
 291   bool isCortexA5() const { return ARMProcFamily == CortexA5; }
 292   bool isCortexA7() const { return ARMProcFamily == CortexA7; }
 293   bool isCortexA8() const { return ARMProcFamily == CortexA8; }
 294   bool isCortexA9() const { return ARMProcFamily == CortexA9; }
 295   bool isCortexA15() const { return ARMProcFamily == CortexA15; }
 296   bool isSwift()    const { return ARMProcFamily == Swift; }
 297   bool isCortexM3() const { return CPUString == "cortex-m3"; }
 298   bool isLikeA9() const { return isCortexA9() || isCortexA15() || isKrait(); }
 299   bool isCortexR5() const { return ARMProcFamily == CortexR5; }
 300   bool isKrait() const { return ARMProcFamily == Krait; }
 301
 302   bool hasARMOps() const { return !NoARM; }
 303
 304   bool hasVFP2() const { return HasVFPv2; }
 305   bool hasVFP3() const { return HasVFPv3; }
 306   bool hasVFP4() const { return HasVFPv4; }
 307   bool hasFPARMv8() const { return HasFPARMv8; }
 308   bool hasNEON() const { return HasNEON;  }
 309   bool hasCrypto() const { return HasCrypto; }
 310   bool hasCRC() const { return HasCRC; }
 311   bool hasVirtualization() const { return HasVirtualization; }
 312   bool useNEONForSinglePrecisionFP() const {
 313     return hasNEON() && UseNEONForSinglePrecisionFP;
 314   }
 315
 316   bool hasDivide() const { return HasHardwareDivide; }
 317   bool hasDivideInARMMode() const { return HasHardwareDivideInARM; }
 318   bool hasT2ExtractPack() const { return HasT2ExtractPack; }
 319   bool hasDataBarrier() const { return HasDataBarrier; }
 320   bool hasAnyDataBarrier() const {
 321     return HasDataBarrier || (hasV6Ops() && !isThumb());
 322   }
 323   bool useMulOps() const { return UseMulOps; }
 324   bool useFPVMLx() const { return !SlowFPVMLx; }
 325   bool hasVMLxForwarding() const { return HasVMLxForwarding; }
 326   bool isFPBrccSlow() const { return SlowFPBrcc; }
 327   bool isFPOnlySP() const { return FPOnlySP; }
 328   bool hasPerfMon() const { return HasPerfMon; }
 329   bool hasTrustZone() const { return HasTrustZone; }
 330   bool hasZeroCycleZeroing() const { return HasZeroCycleZeroing; }
 331   bool prefers32BitThumb() const { return Pref32BitThumb; }
 332   bool avoidCPSRPartialUpdate() const { return AvoidCPSRPartialUpdate; }
 333   bool avoidMOVsShifterOperand() const { return AvoidMOVsShifterOperand; }
 334   bool hasRAS() const { return HasRAS; }
 335   bool hasMPExtension() const { return HasMPExtension; }
 336   bool hasThumb2DSP() const { return Thumb2DSP; }
 337   bool useNaClTrap() const { return UseNaClTrap; }
 338
 339   bool hasFP16() const { return HasFP16; }
 340   bool hasD16() const { return HasD16; }
 341
 342   const Triple &getTargetTriple() const { return TargetTriple; }
 343
 344   bool isTargetDarwin() const { return TargetTriple.isOSDarwin(); }
 345   bool isTargetIOS() const { return TargetTriple.isiOS(); }
 346   bool isTargetLinux() const { return TargetTriple.isOSLinux(); }
 347   bool isTargetNaCl() const { return TargetTriple.isOSNaCl(); }
 348   bool isTargetNetBSD() const { return TargetTriple.isOSNetBSD(); }
 349   bool isTargetWindows() const { return TargetTriple.isOSWindows(); }
 350
 351   bool isTargetCOFF() const { return TargetTriple.isOSBinFormatCOFF(); }
 352   bool isTargetELF() const { return TargetTriple.isOSBinFormatELF(); }
 353   bool isTargetMachO() const { return TargetTriple.isOSBinFormatMachO(); }
 354
 355   // ARM EABI is the bare-metal EABI described in ARM ABI documents and
 356   // can be accessed via -target arm-none-eabi. This is NOT GNUEABI.
 357   // FIXME: Add a flag for bare-metal for that target and set Triple::EABI
 358   // even for GNUEABI, so we can make a distinction here and still conform to
 359   // the EABI on GNU (and Android) mode. This requires change in Clang, too.
 360   // FIXME: The Darwin exception is temporary, while we move users to
 361   // "*-*-*-macho" triples as quickly as possible.
 362   bool isTargetAEABI() const {
 363     return (TargetTriple.getEnvironment() == Triple::EABI ||
 364             TargetTriple.getEnvironment() == Triple::EABIHF) &&
 365            !isTargetDarwin() && !isTargetWindows();
 366   }
 367
 368   // ARM Targets that support EHABI exception handling standard
 369   // Darwin uses SjLj. Other targets might need more checks.
 370   bool isTargetEHABICompatible() const {
 371     return (TargetTriple.getEnvironment() == Triple::EABI ||
 372             TargetTriple.getEnvironment() == Triple::GNUEABI ||
 373             TargetTriple.getEnvironment() == Triple::EABIHF ||
 374             TargetTriple.getEnvironment() == Triple::GNUEABIHF ||
 375             TargetTriple.getEnvironment() == Triple::Android) &&
 376            !isTargetDarwin() && !isTargetWindows();
 377   }
 378
 379   bool isTargetHardFloat() const {
 380     // FIXME: this is invalid for WindowsCE
 381     return TargetTriple.getEnvironment() == Triple::GNUEABIHF ||
 382            TargetTriple.getEnvironment() == Triple::EABIHF ||
 383            isTargetWindows();
 384   }
 385   bool isTargetAndroid() const {
 386     return TargetTriple.getEnvironment() == Triple::Android;
 387   }
 388
 389   bool isAPCS_ABI() const;
 390   bool isAAPCS_ABI() const;
 391
 392   bool isThumb() const { return InThumbMode; }
 393   bool isThumb1Only() const { return InThumbMode && !HasThumb2; }
 394   bool isThumb2() const { return InThumbMode && HasThumb2; }
 395   bool hasThumb2() const { return HasThumb2; }
 396   bool isMClass() const { return ARMProcClass == MClass; }
 397   bool isRClass() const { return ARMProcClass == RClass; }
 398   bool isAClass() const { return ARMProcClass == AClass; }
 399
 400   bool isV6M() const {
 401     return isThumb1Only() && isMClass();
 402   }
 403
 404   bool isR9Reserved() const { return IsR9Reserved; }
 405
 406   bool useMovt(const MachineFunction &MF) const;
 407
 408   bool supportsTailCall() const { return SupportsTailCall; }
 409
 410   bool allowsUnalignedMem() const { return AllowsUnalignedMem; }
 411
 412   bool restrictIT() const { return RestrictIT; }
 413
 414   const std::string & getCPUString() const { return CPUString; }
 415
 416   bool isLittle() const { return IsLittle; }
 417
 418   unsigned getMispredictionPenalty() const;
 419
 420   /// This function returns true if the target has sincos() routine in its
 421   /// compiler runtime or math libraries.
 422   bool hasSinCos() const;
 423
 424   /// True for some subtargets at > -O0.
 425   bool enablePostMachineScheduler() const override;
 426
 427   // enableAtomicExpand- True if we need to expand our atomics.
 428   bool enableAtomicExpand() const override;
 429
 430   /// getInstrItins - Return the instruction itineraries based on subtarget
 431   /// selection.
 432   const InstrItineraryData *getInstrItineraryData() const override {
 433     return &InstrItins;
 434   }
 435
 436   /// getStackAlignment - Returns the minimum alignment known to hold of the
 437   /// stack frame on entry to the function and which must be maintained by every
 438   /// function for this subtarget.
 439   unsigned getStackAlignment() const { return stackAlignment; }
 440
 441   /// GVIsIndirectSymbol - true if the GV will be accessed via an indirect
 442   /// symbol.
 443   bool GVIsIndirectSymbol(const GlobalValue *GV, Reloc::Model RelocM) const;
 444
 445 };
 446 } // End llvm namespace
 447
 448 #endif  // ARMSUBTARGET_H