1//===-- ARMTargetMachine.h - Define TargetMachine for ARM -------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file declares the ARM specific subclass of TargetMachine.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_LIB_TARGET_ARM_ARMTARGETMACHINE_H
14#define LLVM_LIB_TARGET_ARM_ARMTARGETMACHINE_H
15
16#include "ARMSubtarget.h"
17#include "llvm/ADT/StringMap.h"
18#include "llvm/ADT/StringRef.h"
19#include "llvm/Analysis/TargetTransformInfo.h"
20#include "llvm/CodeGen/CodeGenTargetMachineImpl.h"
21#include "llvm/Support/CodeGen.h"
22#include "llvm/Target/TargetMachine.h"
23#include "llvm/TargetParser/ARMTargetParser.h"
24#include <memory>
25#include <optional>
26
27namespace llvm {
28
29class ARMBaseTargetMachine : public CodeGenTargetMachineImpl {
30public:
31 ARM::ARMABI TargetABI;
32
33protected:
34 std::unique_ptr<TargetLoweringObjectFile> TLOF;
35 bool isLittle;
36 mutable StringMap<std::unique_ptr<ARMSubtarget>> SubtargetMap;
37
38 /// Reset internal state.
39 void reset() override;
40
41public:
42 ARMBaseTargetMachine(const Target &T, const Triple &TT, StringRef CPU,
43 StringRef FS, const TargetOptions &Options,
44 std::optional<Reloc::Model> RM,
45 std::optional<CodeModel::Model> CM, CodeGenOptLevel OL);
46 ~ARMBaseTargetMachine() override;
47
48 const ARMSubtarget *getSubtargetImpl(const Function &F) const override;
49 // DO NOT IMPLEMENT: There is no such thing as a valid default subtarget,
50 // subtargets are per-function entities based on the target-specific
51 // attributes of each function.
52 const ARMSubtarget *getSubtargetImpl() const = delete;
53 bool isLittleEndian() const { return isLittle; }
54
55 /// Returns the floating-point ABI in effect for \p M: the "float-abi" module
56 /// flag if present, otherwise the ABI implied by the target triple. An
57 /// explicit -target-abi=aapcs16 forces the hard-float ABI.
58 FloatABI::ABIType getFloatABI(const Module &M) const;
59
60 /// Returns the ABI in effect for \p M: the "target-abi" module flag if
61 /// present, otherwise the legacy -target-abi option; falling back to the
62 /// TargetMachine-level ABI computed at construction.
63 ARM::ARMABI getEffectiveABI(const Module &M) const;
64
65 TargetTransformInfo getTargetTransformInfo(const Function &F) const override;
66
67 // Pass Pipeline Configuration
68 TargetPassConfig *createPassConfig(PassManagerBase &PM) override;
69
70 void registerPassBuilderCallbacks(PassBuilder &PB) override;
71
72 TargetLoweringObjectFile *getObjFileLowering() const override {
73 return TLOF.get();
74 }
75
76 bool isAPCS_ABI() const {
77 assert(TargetABI != ARM::ARM_ABI_UNKNOWN);
78 return TargetABI == ARM::ARM_ABI_APCS;
79 }
80
81 bool isAAPCS_ABI() const {
82 assert(TargetABI != ARM::ARM_ABI_UNKNOWN);
83 return TargetABI == ARM::ARM_ABI_AAPCS || TargetABI == ARM::ARM_ABI_AAPCS16;
84 }
85
86 bool isAAPCS16_ABI() const {
87 assert(TargetABI != ARM::ARM_ABI_UNKNOWN);
88 return TargetABI == ARM::ARM_ABI_AAPCS16;
89 }
90
91 bool targetSchedulesPostRAScheduling() const override { return true; };
92
93 MachineFunctionInfo *
94 createMachineFunctionInfo(BumpPtrAllocator &Allocator, const Function &F,
95 const TargetSubtargetInfo *STI) const override;
96
97 /// Returns true if a cast between SrcAS and DestAS is a noop.
98 bool isNoopAddrSpaceCast(unsigned SrcAS, unsigned DestAS) const override {
99 // Addrspacecasts are always noops.
100 return true;
101 }
102
103 bool isGVIndirectSymbol(const GlobalValue *GV) const {
104 if (!shouldAssumeDSOLocal(GV))
105 return true;
106
107 // 32 bit macho has no relocation for a-b if a is undefined, even if b is in
108 // the section that is being relocated. This means we have to use o load
109 // even for GVs that are known to be local to the dso.
110 if (getTargetTriple().isOSBinFormatMachO() && isPositionIndependent() &&
111 (GV->isDeclarationForLinker() || GV->hasCommonLinkage()))
112 return true;
113
114 return false;
115 }
116
117 yaml::MachineFunctionInfo *createDefaultFuncInfoYAML() const override;
118 yaml::MachineFunctionInfo *
119 convertFuncInfoToYAML(const MachineFunction &MF) const override;
120 bool parseMachineFunctionInfo(const yaml::MachineFunctionInfo &,
121 PerFunctionMIParsingState &PFS,
122 SMDiagnostic &Error,
123 SMRange &SourceRange) const override;
124 ScheduleDAGInstrs *
125 createMachineScheduler(MachineSchedContext *C) const override;
126 ScheduleDAGInstrs *
127 createPostMachineScheduler(MachineSchedContext *C) const override;
128};
129
130/// ARM/Thumb little endian target machine.
131///
132class ARMLETargetMachine : public ARMBaseTargetMachine {
133public:
134 ARMLETargetMachine(const Target &T, const Triple &TT, StringRef CPU,
135 StringRef FS, const TargetOptions &Options,
136 std::optional<Reloc::Model> RM,
137 std::optional<CodeModel::Model> CM, CodeGenOptLevel OL,
138 bool JIT);
139};
140
141/// ARM/Thumb big endian target machine.
142///
143class ARMBETargetMachine : public ARMBaseTargetMachine {
144public:
145 ARMBETargetMachine(const Target &T, const Triple &TT, StringRef CPU,
146 StringRef FS, const TargetOptions &Options,
147 std::optional<Reloc::Model> RM,
148 std::optional<CodeModel::Model> CM, CodeGenOptLevel OL,
149 bool JIT);
150};
151
152} // end namespace llvm
153
154#endif // LLVM_LIB_TARGET_ARM_ARMTARGETMACHINE_H
155