1//===-- BPFTargetMachine.cpp - Define TargetMachine for BPF ---------------===//
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// Implements the info about BPF target spec.
10//
11//===----------------------------------------------------------------------===//
12
13#include "BPFTargetMachine.h"
14#include "BPF.h"
15#include "BPFTargetLoweringObjectFile.h"
16#include "BPFTargetTransformInfo.h"
17#include "MCTargetDesc/BPFMCAsmInfo.h"
18#include "TargetInfo/BPFTargetInfo.h"
19#include "llvm/CodeGen/GlobalISel/IRTranslator.h"
20#include "llvm/CodeGen/GlobalISel/InstructionSelect.h"
21#include "llvm/CodeGen/GlobalISel/Legalizer.h"
22#include "llvm/CodeGen/GlobalISel/RegBankSelect.h"
23#include "llvm/CodeGen/Passes.h"
24#include "llvm/CodeGen/TargetLoweringObjectFileImpl.h"
25#include "llvm/CodeGen/TargetPassConfig.h"
26#include "llvm/IR/PassManager.h"
27#include "llvm/InitializePasses.h"
28#include "llvm/MC/TargetRegistry.h"
29#include "llvm/Passes/PassBuilder.h"
30#include "llvm/Support/Compiler.h"
31#include "llvm/Target/TargetOptions.h"
32#include "llvm/Transforms/Scalar.h"
33#include <optional>
34using namespace llvm;
35
36cl::opt<bool> DisableMIPeephole("disable-bpf-peephole", cl::Hidden,
37 cl::desc("Disable machine peepholes for BPF"));
38
39static cl::opt<bool>
40 DisableCheckUnreachable("bpf-disable-trap-unreachable", cl::Hidden,
41 cl::desc("Disable Trap Unreachable for BPF"));
42
43extern "C" LLVM_ABI LLVM_EXTERNAL_VISIBILITY void LLVMInitializeBPFTarget() {
44 // Register the target.
45 RegisterTargetMachine<BPFTargetMachine> X(getTheBPFleTarget());
46 RegisterTargetMachine<BPFTargetMachine> Y(getTheBPFbeTarget());
47 RegisterTargetMachine<BPFTargetMachine> Z(getTheBPFTarget());
48
49 PassRegistry &PR = *PassRegistry::getPassRegistry();
50 initializeGlobalISel(PR);
51 initializeBPFAsmPrinterPass(PR);
52 initializeBPFCheckAndAdjustIRLegacyPass(PR);
53 initializeBPFFuncTableLegacyPass(PR);
54 initializeBPFMIPeepholeLegacyPass(PR);
55 initializeBPFMIExpandStackArgPseudosLegacyPass(PR);
56 initializeBPFMIPreEmitPeepholeLegacyPass(PR);
57 initializeBPFDAGToDAGISelLegacyPass(PR);
58 initializeBPFMISimplifyPatchableLegacyPass(PR);
59 initializeBPFMIPreEmitCheckingLegacyPass(PR);
60 initializeBPFUnwindPreparePass(PR);
61 initializeBPFUnwindLowerPass(PR);
62}
63
64static Reloc::Model getEffectiveRelocModel(std::optional<Reloc::Model> RM) {
65 return RM.value_or(u: Reloc::PIC_);
66}
67
68BPFTargetMachine::BPFTargetMachine(const Target &T, const Triple &TT,
69 StringRef CPU, StringRef FS,
70 const TargetOptions &Options,
71 std::optional<Reloc::Model> RM,
72 std::optional<CodeModel::Model> CM,
73 CodeGenOptLevel OL, bool JIT)
74 : CodeGenTargetMachineImpl(T, TT, CPU, FS, Options,
75 getEffectiveRelocModel(RM),
76 getEffectiveCodeModel(CM, Default: CodeModel::Small), OL),
77 TLOF(std::make_unique<BPFTargetLoweringObjectFileELF>()),
78 Subtarget(TT, std::string(CPU), std::string(FS), *this) {
79 if (!DisableCheckUnreachable) {
80 this->Options.TrapUnreachable = true;
81 this->Options.NoTrapAfterNoreturn = true;
82 }
83
84 initAsmInfo();
85
86 BPFMCAsmInfo *MAI =
87 static_cast<BPFMCAsmInfo *>(const_cast<MCAsmInfo *>(AsmInfo.get()));
88 MAI->setDwarfUsesRelocationsAcrossSections(!Subtarget.getUseDwarfRIS());
89}
90
91namespace {
92// BPF Code Generator Pass Configuration Options.
93class BPFPassConfig : public TargetPassConfig {
94public:
95 BPFPassConfig(BPFTargetMachine &TM, PassManagerBase &PM)
96 : TargetPassConfig(TM, PM) {}
97
98 BPFTargetMachine &getBPFTargetMachine() const {
99 return getTM<BPFTargetMachine>();
100 }
101
102 void addIRPasses() override;
103 bool addInstSelector() override;
104 void addMachineSSAOptimization() override;
105 void addPreEmitPass() override;
106
107 bool addIRTranslator() override;
108 bool addLegalizeMachineIR() override;
109 bool addRegBankSelect() override;
110 bool addGlobalInstructionSelect() override;
111};
112}
113
114TargetPassConfig *BPFTargetMachine::createPassConfig(PassManagerBase &PM) {
115 return new BPFPassConfig(*this, PM);
116}
117
118void BPFPassConfig::addIRPasses() {
119 const BPFSubtarget *Subtarget = getBPFTargetMachine().getSubtargetImpl();
120
121 addPass(P: createAtomicExpandLegacyPass());
122 addPass(P: createBPFCheckAndAdjustIRLegacyPass());
123 if (Subtarget->hasFuncTable())
124 addPass(P: createBPFFuncTablePass());
125
126 TargetPassConfig::addIRPasses();
127 addPass(P: createBPFUnwindPreparePass());
128}
129
130TargetTransformInfo
131BPFTargetMachine::getTargetTransformInfo(const Function &F) const {
132 return TargetTransformInfo(std::make_unique<BPFTTIImpl>(args: this, args: F));
133}
134
135// Install an instruction selector pass using
136// the ISelDag to gen BPF code.
137bool BPFPassConfig::addInstSelector() {
138 addPass(P: createBPFISelDag(TM&: getBPFTargetMachine()));
139
140 return false;
141}
142
143void BPFPassConfig::addMachineSSAOptimization() {
144 addPass(P: createBPFMISimplifyPatchableLegacyPass());
145
146 // The default implementation must be called first as we want eBPF
147 // Peephole ran at last.
148 TargetPassConfig::addMachineSSAOptimization();
149
150 const BPFSubtarget *Subtarget = getBPFTargetMachine().getSubtargetImpl();
151 if (!DisableMIPeephole) {
152 if (Subtarget->getHasAlu32())
153 addPass(P: createBPFMIPeepholeLegacyPass());
154 }
155}
156
157void BPFPassConfig::addPreEmitPass() {
158 addPass(P: createBPFUnwindLowerPass());
159 addPass(P: createBPFMIPreEmitCheckingLegacyPass());
160 if (!DisableMIPeephole) {
161 addPass(P: createBPFMIExpandStackArgPseudosLegacyPass());
162 addPass(P: createBPFMIPreEmitPeepholeLegacyPass());
163 }
164}
165
166bool BPFPassConfig::addIRTranslator() {
167 addPass(P: new IRTranslatorLegacy());
168 return false;
169}
170
171bool BPFPassConfig::addLegalizeMachineIR() {
172 addPass(P: new LegalizerLegacy());
173 return false;
174}
175
176bool BPFPassConfig::addRegBankSelect() {
177 addPass(P: new RegBankSelectLegacy());
178 return false;
179}
180
181bool BPFPassConfig::addGlobalInstructionSelect() {
182 addPass(P: new InstructionSelectLegacy(getOptLevel()));
183 return false;
184}
185