1 //=== lib/CodeGen/GlobalISel/MipsPostLegalizerCombiner.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 pass does combining of machine instructions at the generic MI level,
10 // after the legalizer.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "MCTargetDesc/MipsMCTargetDesc.h"
15 #include "Mips.h"
16 #include "MipsLegalizerInfo.h"
17 #include "MipsSubtarget.h"
18 #include "llvm/CodeGen/GlobalISel/Combiner.h"
19 #include "llvm/CodeGen/GlobalISel/CombinerHelper.h"
20 #include "llvm/CodeGen/GlobalISel/CombinerInfo.h"
21 #include "llvm/CodeGen/GlobalISel/GIMatchTableExecutorImpl.h"
22 #include "llvm/CodeGen/GlobalISel/GISelKnownBits.h"
23 #include "llvm/CodeGen/GlobalISel/MIPatternMatch.h"
24 #include "llvm/CodeGen/MachineDominators.h"
25 #include "llvm/CodeGen/TargetPassConfig.h"
26 #include "llvm/Target/TargetMachine.h"
27 
28 #define GET_GICOMBINER_DEPS
29 #include "MipsGenPostLegalizeGICombiner.inc"
30 #undef GET_GICOMBINER_DEPS
31 
32 #define DEBUG_TYPE "mips-postlegalizer-combiner"
33 
34 using namespace llvm;
35 using namespace MIPatternMatch;
36 
37 namespace {
38 #define GET_GICOMBINER_TYPES
39 #include "MipsGenPostLegalizeGICombiner.inc"
40 #undef GET_GICOMBINER_TYPES
41 
42 class MipsPostLegalizerCombinerImpl : public Combiner {
43 protected:
44   const MipsPostLegalizerCombinerImplRuleConfig &RuleConfig;
45   const MipsSubtarget &STI;
46   // TODO: Make CombinerHelper methods const.
47   mutable CombinerHelper Helper;
48 
49 public:
50   MipsPostLegalizerCombinerImpl(
51       MachineFunction &MF, CombinerInfo &CInfo, const TargetPassConfig *TPC,
52       GISelKnownBits &KB, GISelCSEInfo *CSEInfo,
53       const MipsPostLegalizerCombinerImplRuleConfig &RuleConfig,
54       const MipsSubtarget &STI, MachineDominatorTree *MDT,
55       const LegalizerInfo *LI);
56 
getName()57   static const char *getName() { return "MipsPostLegalizerCombiner"; }
58 
59   bool tryCombineAll(MachineInstr &I) const override;
60 
61 private:
62 #define GET_GICOMBINER_CLASS_MEMBERS
63 #include "MipsGenPostLegalizeGICombiner.inc"
64 #undef GET_GICOMBINER_CLASS_MEMBERS
65 };
66 
67 #define GET_GICOMBINER_IMPL
68 #include "MipsGenPostLegalizeGICombiner.inc"
69 #undef GET_GICOMBINER_IMPL
70 
MipsPostLegalizerCombinerImpl(MachineFunction & MF,CombinerInfo & CInfo,const TargetPassConfig * TPC,GISelKnownBits & KB,GISelCSEInfo * CSEInfo,const MipsPostLegalizerCombinerImplRuleConfig & RuleConfig,const MipsSubtarget & STI,MachineDominatorTree * MDT,const LegalizerInfo * LI)71 MipsPostLegalizerCombinerImpl::MipsPostLegalizerCombinerImpl(
72     MachineFunction &MF, CombinerInfo &CInfo, const TargetPassConfig *TPC,
73     GISelKnownBits &KB, GISelCSEInfo *CSEInfo,
74     const MipsPostLegalizerCombinerImplRuleConfig &RuleConfig,
75     const MipsSubtarget &STI, MachineDominatorTree *MDT,
76     const LegalizerInfo *LI)
77     : Combiner(MF, CInfo, TPC, &KB, CSEInfo), RuleConfig(RuleConfig), STI(STI),
78       Helper(Observer, B, /*IsPreLegalize*/ false, &KB, MDT, LI),
79 #define GET_GICOMBINER_CONSTRUCTOR_INITS
80 #include "MipsGenPostLegalizeGICombiner.inc"
81 #undef GET_GICOMBINER_CONSTRUCTOR_INITS
82 {
83 }
84 
85 // Pass boilerplate
86 // ================
87 
88 class MipsPostLegalizerCombiner : public MachineFunctionPass {
89 public:
90   static char ID;
91 
92   MipsPostLegalizerCombiner(bool IsOptNone = false);
93 
getPassName() const94   StringRef getPassName() const override { return "MipsPostLegalizerCombiner"; }
95 
96   bool runOnMachineFunction(MachineFunction &MF) override;
97 
98   void getAnalysisUsage(AnalysisUsage &AU) const override;
99 
100 private:
101   bool IsOptNone;
102   MipsPostLegalizerCombinerImplRuleConfig RuleConfig;
103 };
104 } // end anonymous namespace
105 
getAnalysisUsage(AnalysisUsage & AU) const106 void MipsPostLegalizerCombiner::getAnalysisUsage(AnalysisUsage &AU) const {
107   AU.addRequired<TargetPassConfig>();
108   AU.setPreservesCFG();
109   getSelectionDAGFallbackAnalysisUsage(AU);
110   AU.addRequired<GISelKnownBitsAnalysis>();
111   AU.addPreserved<GISelKnownBitsAnalysis>();
112   if (!IsOptNone) {
113     AU.addRequired<MachineDominatorTree>();
114     AU.addPreserved<MachineDominatorTree>();
115   }
116   MachineFunctionPass::getAnalysisUsage(AU);
117 }
118 
MipsPostLegalizerCombiner(bool IsOptNone)119 MipsPostLegalizerCombiner::MipsPostLegalizerCombiner(bool IsOptNone)
120     : MachineFunctionPass(ID), IsOptNone(IsOptNone) {
121   initializeMipsPostLegalizerCombinerPass(*PassRegistry::getPassRegistry());
122 
123   if (!RuleConfig.parseCommandLineOption())
124     report_fatal_error("Invalid rule identifier");
125 }
126 
runOnMachineFunction(MachineFunction & MF)127 bool MipsPostLegalizerCombiner::runOnMachineFunction(MachineFunction &MF) {
128   if (MF.getProperties().hasProperty(
129           MachineFunctionProperties::Property::FailedISel))
130     return false;
131   auto *TPC = &getAnalysis<TargetPassConfig>();
132   const Function &F = MF.getFunction();
133   bool EnableOpt =
134       MF.getTarget().getOptLevel() != CodeGenOptLevel::None && !skipFunction(F);
135 
136   const MipsSubtarget &ST = MF.getSubtarget<MipsSubtarget>();
137   const MipsLegalizerInfo *LI =
138       static_cast<const MipsLegalizerInfo *>(ST.getLegalizerInfo());
139 
140   GISelKnownBits *KB = &getAnalysis<GISelKnownBitsAnalysis>().get(MF);
141   MachineDominatorTree *MDT =
142       IsOptNone ? nullptr : &getAnalysis<MachineDominatorTree>();
143   CombinerInfo CInfo(/*AllowIllegalOps*/ false, /*ShouldLegalizeIllegal*/ true,
144                      LI, EnableOpt, F.hasOptSize(), F.hasMinSize());
145   MipsPostLegalizerCombinerImpl Impl(MF, CInfo, TPC, *KB, /*CSEInfo*/ nullptr,
146                                      RuleConfig, ST, MDT, LI);
147   return Impl.combineMachineInstrs();
148 }
149 
150 char MipsPostLegalizerCombiner::ID = 0;
151 INITIALIZE_PASS_BEGIN(MipsPostLegalizerCombiner, DEBUG_TYPE,
152                       "Combine Mips machine instrs after legalization", false,
153                       false)
154 INITIALIZE_PASS_DEPENDENCY(TargetPassConfig)
155 INITIALIZE_PASS_DEPENDENCY(GISelKnownBitsAnalysis)
156 INITIALIZE_PASS_END(MipsPostLegalizerCombiner, DEBUG_TYPE,
157                     "Combine Mips machine instrs after legalization", false,
158                     false)
159 
160 namespace llvm {
createMipsPostLegalizeCombiner(bool IsOptNone)161 FunctionPass *createMipsPostLegalizeCombiner(bool IsOptNone) {
162   return new MipsPostLegalizerCombiner(IsOptNone);
163 }
164 } // end namespace llvm
165