1//===------------ RISCVLandingPadSetup.cpp ---------------------------------==//
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 is a RISC-V pass to setup landing pad labels for indirect jumps.
10// Currently this pass only supports fixed labels.
11//
12//===----------------------------------------------------------------------===//
13
14#include "RISCV.h"
15#include "RISCVInstrInfo.h"
16#include "RISCVMachineFunctionInfo.h"
17#include "RISCVSubtarget.h"
18#include "llvm/CodeGen/MachineFunctionAnalysisManager.h"
19#include "llvm/CodeGen/MachineFunctionPass.h"
20#include "llvm/CodeGen/MachineInstrBuilder.h"
21#include "llvm/CodeGen/MachinePassManager.h"
22#include "llvm/IR/Analysis.h"
23
24using namespace llvm;
25
26#define DEBUG_TYPE "riscv-lpad-setup"
27#define PASS_NAME "RISC-V Landing Pad Setup"
28
29namespace {
30
31class RISCVLandingPadSetupLegacy : public MachineFunctionPass {
32public:
33 static char ID;
34
35 RISCVLandingPadSetupLegacy() : MachineFunctionPass(ID) {}
36
37 bool runOnMachineFunction(MachineFunction &F) override;
38
39 StringRef getPassName() const override { return PASS_NAME; }
40
41 void getAnalysisUsage(AnalysisUsage &AU) const override {
42 AU.setPreservesCFG();
43 MachineFunctionPass::getAnalysisUsage(AU);
44 }
45};
46
47} // end anonymous namespace
48
49static bool runLandingPadSetup(MachineFunction &MF) {
50 const auto &STI = MF.getSubtarget<RISCVSubtarget>();
51 const RISCVInstrInfo &TII = *STI.getInstrInfo();
52
53 if (!MF.getInfo<RISCVMachineFunctionInfo>()->hasCFProtectionBranch())
54 return false;
55
56 uint32_t Label = 0;
57 if (std::optional<uint32_t> Preferred = STI.getCLOpts().landing_pad_label) {
58 if (!isUInt<20>(x: *Preferred))
59 report_fatal_error(reason: "riscv-landing-pad-label=<val>, <val> needs to fit in "
60 "unsigned 20-bits");
61 Label = *Preferred;
62 }
63
64 // Zicfilp does not check X7 if landing pad label is zero.
65 if (Label == 0)
66 return false;
67
68 bool Changed = false;
69 for (MachineBasicBlock &MBB : MF)
70 for (MachineInstr &MI : llvm::make_early_inc_range(Range&: MBB)) {
71 if (MI.getOpcode() != RISCV::PseudoBRIND &&
72 MI.getOpcode() != RISCV::PseudoCALLIndirect &&
73 MI.getOpcode() != RISCV::PseudoTAILIndirect)
74 continue;
75 BuildMI(BB&: MBB, I&: MI, MIMD: MI.getDebugLoc(), MCID: TII.get(Opcode: RISCV::LUI), DestReg: RISCV::X7)
76 .addImm(Val: Label);
77 MachineInstrBuilder(MF, &MI).addUse(RegNo: RISCV::X7, Flags: RegState::ImplicitKill);
78 Changed = true;
79 }
80
81 return Changed;
82}
83
84INITIALIZE_PASS(RISCVLandingPadSetupLegacy, DEBUG_TYPE, PASS_NAME, false, false)
85
86char RISCVLandingPadSetupLegacy::ID = 0;
87
88FunctionPass *llvm::createRISCVLandingPadSetupLegacyPass() {
89 return new RISCVLandingPadSetupLegacy();
90}
91
92bool RISCVLandingPadSetupLegacy::runOnMachineFunction(MachineFunction &MF) {
93 return runLandingPadSetup(MF);
94}
95
96PreservedAnalyses
97RISCVLandingPadSetupPass::run(MachineFunction &MF,
98 MachineFunctionAnalysisManager &MFAM) {
99 return runLandingPadSetup(MF) ? getMachineFunctionPassPreservedAnalyses()
100 .preserveSet<CFGAnalyses>()
101 : PreservedAnalyses::all();
102}
103