1//===- RISCVDeadRegisterDefinitions.cpp - Replace dead defs w/ zero reg --===//
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 pass rewrites Rd to x0 for instrs whose return values are unused.
10//
11//===---------------------------------------------------------------------===//
12
13#include "RISCV.h"
14#include "RISCVSubtarget.h"
15#include "llvm/ADT/Statistic.h"
16#include "llvm/CodeGen/LiveDebugVariables.h"
17#include "llvm/CodeGen/LiveIntervals.h"
18#include "llvm/CodeGen/LiveStacks.h"
19#include "llvm/CodeGen/MachineFunctionAnalysisManager.h"
20#include "llvm/CodeGen/MachineFunctionPass.h"
21#include "llvm/CodeGen/MachinePassManager.h"
22#include "llvm/CodeGen/SlotIndexes.h"
23#include "llvm/IR/Analysis.h"
24
25using namespace llvm;
26#define DEBUG_TYPE "riscv-dead-defs"
27#define RISCV_DEAD_REG_DEF_NAME "RISC-V Dead register definitions"
28
29STATISTIC(NumDeadDefsReplaced, "Number of dead definitions replaced");
30
31namespace {
32class RISCVDeadRegisterDefinitionsLegacy : public MachineFunctionPass {
33public:
34 static char ID;
35
36 RISCVDeadRegisterDefinitionsLegacy() : MachineFunctionPass(ID) {}
37 bool runOnMachineFunction(MachineFunction &MF) override;
38 void getAnalysisUsage(AnalysisUsage &AU) const override {
39 AU.setPreservesCFG();
40 AU.addRequired<LiveIntervalsWrapperPass>();
41 AU.addPreserved<LiveIntervalsWrapperPass>();
42 AU.addPreserved<SlotIndexesWrapperPass>();
43 AU.addPreserved<LiveDebugVariablesWrapperLegacy>();
44 AU.addPreserved<LiveStacksWrapperLegacy>();
45 MachineFunctionPass::getAnalysisUsage(AU);
46 }
47
48 StringRef getPassName() const override { return RISCV_DEAD_REG_DEF_NAME; }
49};
50} // end anonymous namespace
51
52char RISCVDeadRegisterDefinitionsLegacy::ID = 0;
53INITIALIZE_PASS(RISCVDeadRegisterDefinitionsLegacy, DEBUG_TYPE,
54 RISCV_DEAD_REG_DEF_NAME, false, false)
55
56FunctionPass *llvm::createRISCVDeadRegisterDefinitionsLegacyPass() {
57 return new RISCVDeadRegisterDefinitionsLegacy();
58}
59
60static bool runDeadRegisterDefinitions(MachineFunction &MF,
61 function_ref<LiveIntervals &()> GetLIS) {
62 const TargetInstrInfo *TII = MF.getSubtarget().getInstrInfo();
63 LiveIntervals &LIS = GetLIS();
64 LLVM_DEBUG(dbgs() << "***** RISCVDeadRegisterDefinitions *****\n");
65
66 bool MadeChange = false;
67 for (MachineBasicBlock &MBB : MF) {
68 for (MachineInstr &MI : MBB) {
69 // We only handle non-computational instructions since some NOP encodings
70 // are reserved for HINT instructions.
71 const MCInstrDesc &Desc = MI.getDesc();
72 if (!Desc.mayLoad() && !Desc.mayStore() &&
73 !Desc.hasUnmodeledSideEffects() &&
74 MI.getOpcode() != RISCV::PseudoVSETVLI &&
75 MI.getOpcode() != RISCV::PseudoVSETIVLI)
76 continue;
77 for (int I = 0, E = Desc.getNumDefs(); I != E; ++I) {
78 MachineOperand &MO = MI.getOperand(i: I);
79 if (!MO.isReg() || !MO.isDef() || MO.isEarlyClobber())
80 continue;
81 // Be careful not to change the register if it's a tied operand.
82 if (MI.isRegTiedToUseOperand(DefOpIdx: I)) {
83 LLVM_DEBUG(dbgs() << " Ignoring, def is tied operand.\n");
84 continue;
85 }
86 Register Reg = MO.getReg();
87 if (!Reg.isVirtual() || !MO.isDead())
88 continue;
89 LLVM_DEBUG(dbgs() << " Dead def operand #" << I << " in:\n ";
90 MI.print(dbgs()));
91 Register X0Reg;
92 const TargetRegisterClass *RC = TII->getRegClass(MCID: Desc, OpNum: I);
93 if (RC && RC->contains(Reg: RISCV::X0)) {
94 X0Reg = RISCV::X0;
95 } else if (RC && RC->contains(Reg: RISCV::X0_W)) {
96 X0Reg = RISCV::X0_W;
97 } else if (RC && RC->contains(Reg: RISCV::X0_H)) {
98 X0Reg = RISCV::X0_H;
99 } else if (RC && RC->contains(Reg: RISCV::X0_Pair)) {
100 X0Reg = RISCV::X0_Pair;
101 } else {
102 LLVM_DEBUG(dbgs() << " Ignoring, register is not a GPR.\n");
103 continue;
104 }
105 assert(LIS.hasInterval(Reg));
106 LIS.removeInterval(Reg);
107 MO.setReg(X0Reg);
108 LLVM_DEBUG(dbgs() << " Replacing with zero register. New:\n ";
109 MI.print(dbgs()));
110 ++NumDeadDefsReplaced;
111 MadeChange = true;
112 }
113 }
114 }
115
116 return MadeChange;
117}
118
119bool RISCVDeadRegisterDefinitionsLegacy::runOnMachineFunction(
120 MachineFunction &MF) {
121 if (skipFunction(F: MF.getFunction()))
122 return false;
123 return runDeadRegisterDefinitions(MF, GetLIS: [&]() -> LiveIntervals & {
124 return getAnalysis<LiveIntervalsWrapperPass>().getLIS();
125 });
126}
127
128PreservedAnalyses
129RISCVDeadRegisterDefinitionsPass::run(MachineFunction &MF,
130 MachineFunctionAnalysisManager &MFAM) {
131 bool Changed = runDeadRegisterDefinitions(MF, GetLIS: [&]() -> LiveIntervals & {
132 return MFAM.getResult<LiveIntervalsAnalysis>(IR&: MF);
133 });
134 if (!Changed)
135 return PreservedAnalyses::all();
136 return getMachineFunctionPassPreservedAnalyses()
137 .preserveSet<CFGAnalyses>()
138 .preserve<LiveIntervalsAnalysis>()
139 .preserve<SlotIndexesAnalysis>()
140 .preserve<LiveDebugVariablesAnalysis>()
141 .preserve<LiveStacksAnalysis>();
142}
143