blob: 06076d06852bdec95d29c188a6efe0c97a56910f [file] [log] [blame]
Chris Lattnerf2836d12007-03-31 04:06:36 +00001//===- CodeGenPrepare.cpp - Prepare a function for code generation --------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerf2836d12007-03-31 04:06:36 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This pass munges the code in the input function to better prepare it for
Gordon Henriksen829046b2008-05-08 17:46:35 +000011// SelectionDAG-based code generation. This works around limitations in it's
12// basic-block-at-a-time approach. It should eventually be removed.
Chris Lattnerf2836d12007-03-31 04:06:36 +000013//
14//===----------------------------------------------------------------------===//
15
Chandler Carruthed0881b2012-12-03 16:50:05 +000016#include "llvm/ADT/DenseMap.h"
Michael Kuperstein13bf8a22017-02-28 00:11:34 +000017#include "llvm/ADT/SetVector.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000018#include "llvm/ADT/SmallSet.h"
19#include "llvm/ADT/Statistic.h"
Jun Bum Lim90b6b502016-12-16 20:38:39 +000020#include "llvm/Analysis/BlockFrequencyInfo.h"
21#include "llvm/Analysis/BranchProbabilityInfo.h"
Michael Kuperstein13bf8a22017-02-28 00:11:34 +000022#include "llvm/Analysis/CFG.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000023#include "llvm/Analysis/InstructionSimplify.h"
Chuang-Yu Chengd3fb38c2016-04-05 14:06:20 +000024#include "llvm/Analysis/LoopInfo.h"
Zaara Syeda3a7578c2017-05-31 17:12:38 +000025#include "llvm/Analysis/MemoryBuiltins.h"
Dehao Chen302b69c2016-10-18 20:42:47 +000026#include "llvm/Analysis/ProfileSummaryInfo.h"
Chandler Carruth62d42152015-01-15 02:16:27 +000027#include "llvm/Analysis/TargetLibraryInfo.h"
Quentin Colombetc32615d2014-10-31 17:52:53 +000028#include "llvm/Analysis/TargetTransformInfo.h"
Sanjay Patel69a50a12015-10-19 21:59:12 +000029#include "llvm/Analysis/ValueTracking.h"
Michael Kupersteinf79af6f2016-09-08 00:48:37 +000030#include "llvm/CodeGen/Analysis.h"
Zaara Syeda3a7578c2017-05-31 17:12:38 +000031#include "llvm/CodeGen/Passes.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000032#include "llvm/CodeGen/TargetPassConfig.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000033#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000034#include "llvm/IR/Constants.h"
35#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000037#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000038#include "llvm/IR/Function.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000039#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000040#include "llvm/IR/IRBuilder.h"
41#include "llvm/IR/InlineAsm.h"
42#include "llvm/IR/Instructions.h"
43#include "llvm/IR/IntrinsicInst.h"
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +000044#include "llvm/IR/MDBuilder.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000045#include "llvm/IR/PatternMatch.h"
Ramkumar Ramachandradba73292015-01-14 23:27:07 +000046#include "llvm/IR/Statepoint.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000047#include "llvm/IR/ValueHandle.h"
Chandler Carrutha4ea2692014-03-04 11:26:31 +000048#include "llvm/IR/ValueMap.h"
Chris Lattnerf2836d12007-03-31 04:06:36 +000049#include "llvm/Pass.h"
Sanjay Pateld66607b2016-04-26 17:11:17 +000050#include "llvm/Support/BranchProbability.h"
Evan Cheng8b637b12010-08-17 01:34:49 +000051#include "llvm/Support/CommandLine.h"
Evan Chengd3d80172007-12-05 23:58:20 +000052#include "llvm/Support/Debug.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000053#include "llvm/Support/raw_ostream.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000054#include "llvm/Target/TargetLowering.h"
Hal Finkelc3998302014-04-12 00:59:48 +000055#include "llvm/Target/TargetSubtargetInfo.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000056#include "llvm/Transforms/Utils/BasicBlockUtils.h"
57#include "llvm/Transforms/Utils/BuildLibCalls.h"
Preston Gurdcdf540d2012-09-04 18:22:17 +000058#include "llvm/Transforms/Utils/BypassSlowDivision.h"
Michael Kuperstein13bf8a22017-02-28 00:11:34 +000059#include "llvm/Transforms/Utils/Cloning.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000060#include "llvm/Transforms/Utils/Local.h"
Ahmed Bougachae03bef72015-01-12 17:22:43 +000061#include "llvm/Transforms/Utils/SimplifyLibCalls.h"
Michael Kuperstein13bf8a22017-02-28 00:11:34 +000062#include "llvm/Transforms/Utils/ValueMapper.h"
Zaara Syeda3a7578c2017-05-31 17:12:38 +000063
Chris Lattnerf2836d12007-03-31 04:06:36 +000064using namespace llvm;
Chris Lattnerd616ef52008-11-25 04:42:10 +000065using namespace llvm::PatternMatch;
Chris Lattnerf2836d12007-03-31 04:06:36 +000066
Chandler Carruth1b9dde02014-04-22 02:02:50 +000067#define DEBUG_TYPE "codegenprepare"
68
Cameron Zwarichced753f2011-01-05 17:27:27 +000069STATISTIC(NumBlocksElim, "Number of blocks eliminated");
Evan Cheng0663f232011-03-21 01:19:09 +000070STATISTIC(NumPHIsElim, "Number of trivial PHIs eliminated");
71STATISTIC(NumGEPsElim, "Number of GEPs converted to casts");
Cameron Zwarichced753f2011-01-05 17:27:27 +000072STATISTIC(NumCmpUses, "Number of uses of Cmp expressions replaced with uses of "
73 "sunken Cmps");
74STATISTIC(NumCastUses, "Number of uses of Cast expressions replaced with uses "
75 "of sunken Casts");
76STATISTIC(NumMemoryInsts, "Number of memory instructions whose address "
77 "computations were sunk");
Evan Cheng0663f232011-03-21 01:19:09 +000078STATISTIC(NumExtsMoved, "Number of [s|z]ext instructions combined with loads");
79STATISTIC(NumExtUses, "Number of uses of [s|z]ext instructions optimized");
Geoff Berry5256fca2015-11-20 22:34:39 +000080STATISTIC(NumAndsAdded,
81 "Number of and mask instructions added to form ext loads");
82STATISTIC(NumAndUses, "Number of uses of and mask instructions optimized");
Evan Cheng0663f232011-03-21 01:19:09 +000083STATISTIC(NumRetsDup, "Number of return instructions duplicated");
Devang Patel53771ba2011-08-18 00:50:51 +000084STATISTIC(NumDbgValueMoved, "Number of debug value instructions moved");
Benjamin Kramer047d7ca2012-05-05 12:49:22 +000085STATISTIC(NumSelectsExpanded, "Number of selects turned into branches");
Quentin Colombetc32615d2014-10-31 17:52:53 +000086STATISTIC(NumStoreExtractExposed, "Number of store(extractelement) exposed");
Jakob Stoklund Oleseneb12f492010-09-30 20:51:52 +000087
Zaara Syeda3a7578c2017-05-31 17:12:38 +000088STATISTIC(NumMemCmpCalls, "Number of memcmp calls");
89STATISTIC(NumMemCmpNotConstant, "Number of memcmp calls without constant size");
90STATISTIC(NumMemCmpGreaterThanMax,
91 "Number of memcmp calls with size greater than max size");
92STATISTIC(NumMemCmpInlined, "Number of inlined memcmp calls");
93
Cameron Zwarich338d3622011-03-11 21:52:04 +000094static cl::opt<bool> DisableBranchOpts(
95 "disable-cgp-branch-opts", cl::Hidden, cl::init(false),
96 cl::desc("Disable branch optimizations in CodeGenPrepare"));
97
Ramkumar Ramachandradba73292015-01-14 23:27:07 +000098static cl::opt<bool>
99 DisableGCOpts("disable-cgp-gc-opts", cl::Hidden, cl::init(false),
100 cl::desc("Disable GC optimizations in CodeGenPrepare"));
101
Benjamin Kramer3d38c172012-05-06 14:25:16 +0000102static cl::opt<bool> DisableSelectToBranch(
103 "disable-cgp-select2branch", cl::Hidden, cl::init(false),
104 cl::desc("Disable select to branch conversion."));
Benjamin Kramer047d7ca2012-05-05 12:49:22 +0000105
Hal Finkelc3998302014-04-12 00:59:48 +0000106static cl::opt<bool> AddrSinkUsingGEPs(
Eli Friedman5fba1e52017-04-06 22:42:18 +0000107 "addr-sink-using-gep", cl::Hidden, cl::init(true),
Hal Finkelc3998302014-04-12 00:59:48 +0000108 cl::desc("Address sinking in CGP using GEPs."));
109
Tim Northovercea0abb2014-03-29 08:22:29 +0000110static cl::opt<bool> EnableAndCmpSinking(
111 "enable-andcmp-sinking", cl::Hidden, cl::init(true),
112 cl::desc("Enable sinkinig and/cmp into branches."));
113
Quentin Colombetc32615d2014-10-31 17:52:53 +0000114static cl::opt<bool> DisableStoreExtract(
115 "disable-cgp-store-extract", cl::Hidden, cl::init(false),
116 cl::desc("Disable store(extract) optimizations in CodeGenPrepare"));
117
118static cl::opt<bool> StressStoreExtract(
119 "stress-cgp-store-extract", cl::Hidden, cl::init(false),
120 cl::desc("Stress test store(extract) optimizations in CodeGenPrepare"));
121
Quentin Colombetfc2201e2014-12-17 01:36:17 +0000122static cl::opt<bool> DisableExtLdPromotion(
123 "disable-cgp-ext-ld-promotion", cl::Hidden, cl::init(false),
124 cl::desc("Disable ext(promotable(ld)) -> promoted(ext(ld)) optimization in "
125 "CodeGenPrepare"));
126
127static cl::opt<bool> StressExtLdPromotion(
128 "stress-cgp-ext-ld-promotion", cl::Hidden, cl::init(false),
129 cl::desc("Stress test ext(promotable(ld)) -> promoted(ext(ld)) "
130 "optimization in CodeGenPrepare"));
131
Chuang-Yu Chengd3fb38c2016-04-05 14:06:20 +0000132static cl::opt<bool> DisablePreheaderProtect(
133 "disable-preheader-prot", cl::Hidden, cl::init(false),
134 cl::desc("Disable protection against removing loop preheaders"));
135
Dehao Chen302b69c2016-10-18 20:42:47 +0000136static cl::opt<bool> ProfileGuidedSectionPrefix(
David Callahan5960d9b12017-06-14 20:35:33 +0000137 "profile-guided-section-prefix", cl::Hidden, cl::init(true), cl::ZeroOrMore,
Dehao Chen302b69c2016-10-18 20:42:47 +0000138 cl::desc("Use profile info to add section prefix for hot/cold functions"));
139
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000140static cl::opt<unsigned> FreqRatioToSkipMerge(
141 "cgp-freq-ratio-to-skip-merge", cl::Hidden, cl::init(2),
142 cl::desc("Skip merging empty blocks if (frequency of empty block) / "
143 "(frequency of destination block) is greater than this ratio"));
144
Wei Mia2f0b592016-12-22 19:44:45 +0000145static cl::opt<bool> ForceSplitStore(
146 "force-split-store", cl::Hidden, cl::init(false),
147 cl::desc("Force store splitting no matter what the target query says."));
148
Jun Bum Limdee55652017-04-03 19:20:07 +0000149static cl::opt<bool>
150EnableTypePromotionMerge("cgp-type-promotion-merge", cl::Hidden,
151 cl::desc("Enable merging of redundant sexts when one is dominating"
152 " the other."), cl::init(true));
153
Zaara Syeda3a7578c2017-05-31 17:12:38 +0000154static cl::opt<unsigned> MemCmpNumLoadsPerBlock(
155 "memcmp-num-loads-per-block", cl::Hidden, cl::init(1),
156 cl::desc("The number of loads per basic block for inline expansion of "
157 "memcmp that is only being compared against zero."));
158
Eric Christopherc1ea1492008-09-24 05:32:41 +0000159namespace {
Quentin Colombet3a4bf042014-02-06 21:44:56 +0000160typedef SmallPtrSet<Instruction *, 16> SetOfInstrs;
Benjamin Kramer4cd5faa2015-07-31 17:00:39 +0000161typedef PointerIntPair<Type *, 1, bool> TypeIsSExt;
Quentin Colombetf5485bb2014-11-13 01:44:51 +0000162typedef DenseMap<Instruction *, TypeIsSExt> InstrToOrigTy;
Jun Bum Limdee55652017-04-03 19:20:07 +0000163typedef SmallVector<Instruction *, 16> SExts;
164typedef DenseMap<Value *, SExts> ValueToSExts;
Quentin Colombetfc2201e2014-12-17 01:36:17 +0000165class TypePromotionTransaction;
Quentin Colombet3a4bf042014-02-06 21:44:56 +0000166
Chris Lattner2dd09db2009-09-02 06:11:42 +0000167 class CodeGenPrepare : public FunctionPass {
Bill Wendling7a639ea2013-06-19 21:07:11 +0000168 const TargetMachine *TM;
Igor Laevsky3be81ba2017-02-07 13:27:20 +0000169 const TargetSubtargetInfo *SubtargetInfo;
Chris Lattnerf2836d12007-03-31 04:06:36 +0000170 const TargetLowering *TLI;
Igor Laevsky3be81ba2017-02-07 13:27:20 +0000171 const TargetRegisterInfo *TRI;
Quentin Colombetc32615d2014-10-31 17:52:53 +0000172 const TargetTransformInfo *TTI;
Chad Rosierc24b86f2011-12-01 03:08:23 +0000173 const TargetLibraryInfo *TLInfo;
Chuang-Yu Chengd3fb38c2016-04-05 14:06:20 +0000174 const LoopInfo *LI;
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000175 std::unique_ptr<BlockFrequencyInfo> BFI;
176 std::unique_ptr<BranchProbabilityInfo> BPI;
Nadav Rotem465834c2012-07-24 10:51:42 +0000177
Sanjay Patel4ac6b112015-09-21 22:47:23 +0000178 /// As we scan instructions optimizing them, this is the next instruction
179 /// to optimize. Transforms that can invalidate this should update it.
Chris Lattner7a277142011-01-15 07:14:54 +0000180 BasicBlock::iterator CurInstIterator;
Evan Cheng3b3de7c2008-12-19 18:03:11 +0000181
Evan Cheng0663f232011-03-21 01:19:09 +0000182 /// Keeps track of non-local addresses that have been sunk into a block.
183 /// This allows us to avoid inserting duplicate code for blocks with
184 /// multiple load/stores of the same address.
Nick Lewycky5fb19632013-05-08 09:00:10 +0000185 ValueMap<Value*, Value*> SunkAddrs;
Cameron Zwarichce3b9302011-01-06 00:42:50 +0000186
Ahmed Bougachaf3299142015-06-17 20:44:32 +0000187 /// Keeps track of all instructions inserted for the current function.
188 SetOfInstrs InsertedInsts;
Quentin Colombet3a4bf042014-02-06 21:44:56 +0000189 /// Keeps track of the type of the related instruction before their
190 /// promotion for the current function.
191 InstrToOrigTy PromotedInsts;
192
Jun Bum Limdee55652017-04-03 19:20:07 +0000193 /// Keep track of instructions removed during promotion.
194 SetOfInstrs RemovedInsts;
195
196 /// Keep track of sext chains based on their initial value.
197 DenseMap<Value *, Instruction *> SeenChainsForSExt;
198
199 /// Keep track of SExt promoted.
200 ValueToSExts ValToSExtendedUses;
201
Sanjay Patel4ac6b112015-09-21 22:47:23 +0000202 /// True if CFG is modified in any way.
Devang Patel8f606d72011-03-24 15:35:25 +0000203 bool ModifiedDT;
Evan Cheng0663f232011-03-21 01:19:09 +0000204
Sanjay Patel4ac6b112015-09-21 22:47:23 +0000205 /// True if optimizing for size.
Benjamin Kramer047d7ca2012-05-05 12:49:22 +0000206 bool OptSize;
207
Mehdi Amini4fe37982015-07-07 18:45:17 +0000208 /// DataLayout for the Function being processed.
209 const DataLayout *DL;
210
Chris Lattnerf2836d12007-03-31 04:06:36 +0000211 public:
Nick Lewyckye7da2d62007-05-06 13:37:16 +0000212 static char ID; // Pass identification, replacement for typeid
Francis Visoiu Mistrih8b617642017-05-18 17:21:13 +0000213 CodeGenPrepare()
214 : FunctionPass(ID), TM(nullptr), TLI(nullptr), TTI(nullptr),
215 DL(nullptr) {
216 initializeCodeGenPreparePass(*PassRegistry::getPassRegistry());
217 }
Craig Topper4584cd52014-03-07 09:26:03 +0000218 bool runOnFunction(Function &F) override;
Eric Christopherc1ea1492008-09-24 05:32:41 +0000219
Mehdi Amini117296c2016-10-01 02:56:57 +0000220 StringRef getPassName() const override { return "CodeGen Prepare"; }
Evan Cheng99cafb12012-12-21 01:48:14 +0000221
Craig Topper4584cd52014-03-07 09:26:03 +0000222 void getAnalysisUsage(AnalysisUsage &AU) const override {
George Burgess IVd4febd12016-03-22 21:25:08 +0000223 // FIXME: When we can selectively preserve passes, preserve the domtree.
Dehao Chen302b69c2016-10-18 20:42:47 +0000224 AU.addRequired<ProfileSummaryInfoWrapperPass>();
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000225 AU.addRequired<TargetLibraryInfoWrapperPass>();
Chandler Carruth705b1852015-01-31 03:43:40 +0000226 AU.addRequired<TargetTransformInfoWrapperPass>();
Chuang-Yu Chengd3fb38c2016-04-05 14:06:20 +0000227 AU.addRequired<LoopInfoWrapperPass>();
Andreas Neustifterf8cb7582009-09-16 09:26:52 +0000228 }
229
Chris Lattnerf2836d12007-03-31 04:06:36 +0000230 private:
Sanjay Patelfc580a62015-09-21 23:03:16 +0000231 bool eliminateFallThrough(Function &F);
232 bool eliminateMostlyEmptyBlocks(Function &F);
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000233 BasicBlock *findDestBlockOfMergeableEmptyBlock(BasicBlock *BB);
Sanjay Patelfc580a62015-09-21 23:03:16 +0000234 bool canMergeBlocks(const BasicBlock *BB, const BasicBlock *DestBB) const;
235 void eliminateMostlyEmptyBlock(BasicBlock *BB);
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000236 bool isMergingEmptyBlockProfitable(BasicBlock *BB, BasicBlock *DestBB,
237 bool isPreheader);
Sanjay Patel3b8974b2017-06-08 20:00:09 +0000238 bool optimizeBlock(BasicBlock &BB, bool &ModifiedDT);
239 bool optimizeInst(Instruction *I, bool &ModifiedDT);
Sanjay Patelfc580a62015-09-21 23:03:16 +0000240 bool optimizeMemoryInst(Instruction *I, Value *Addr,
Matt Arsenaultf72b49b2015-06-04 16:17:38 +0000241 Type *AccessTy, unsigned AS);
Sanjay Patelfc580a62015-09-21 23:03:16 +0000242 bool optimizeInlineAsmInst(CallInst *CS);
Sanjay Patel3b8974b2017-06-08 20:00:09 +0000243 bool optimizeCallInst(CallInst *CI, bool &ModifiedDT);
Jun Bum Limdee55652017-04-03 19:20:07 +0000244 bool optimizeExt(Instruction *&I);
Sanjay Patelfc580a62015-09-21 23:03:16 +0000245 bool optimizeExtUses(Instruction *I);
Geoff Berry5256fca2015-11-20 22:34:39 +0000246 bool optimizeLoadExt(LoadInst *I);
Sanjay Patelfc580a62015-09-21 23:03:16 +0000247 bool optimizeSelectInst(SelectInst *SI);
248 bool optimizeShuffleVectorInst(ShuffleVectorInst *SI);
Sanjay Patel0ed9aea2015-11-02 23:22:49 +0000249 bool optimizeSwitchInst(SwitchInst *CI);
Sanjay Patelfc580a62015-09-21 23:03:16 +0000250 bool optimizeExtractElementInst(Instruction *Inst);
251 bool dupRetToEnableTailCallOpts(BasicBlock *BB);
252 bool placeDbgValues(Function &F);
Jun Bum Lim42301012017-03-17 19:05:21 +0000253 bool canFormExtLd(const SmallVectorImpl<Instruction *> &MovedExts,
254 LoadInst *&LI, Instruction *&Inst, bool HasPromoted);
255 bool tryToPromoteExts(TypePromotionTransaction &TPT,
256 const SmallVectorImpl<Instruction *> &Exts,
257 SmallVectorImpl<Instruction *> &ProfitablyMovedExts,
258 unsigned CreatedInstsCost = 0);
Jun Bum Limdee55652017-04-03 19:20:07 +0000259 bool mergeSExts(Function &F);
260 bool performAddressTypePromotion(
261 Instruction *&Inst,
262 bool AllowPromotionWithoutCommonHeader,
263 bool HasPromoted, TypePromotionTransaction &TPT,
264 SmallVectorImpl<Instruction *> &SpeculativelyMovedExts);
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +0000265 bool splitBranchCondition(Function &F);
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000266 bool simplifyOffsetableRelocate(Instruction &I);
Michael Kuperstein13bf8a22017-02-28 00:11:34 +0000267 bool splitIndirectCriticalEdges(Function &F);
Chris Lattnerf2836d12007-03-31 04:06:36 +0000268 };
Alexander Kornienkof00654e2015-06-23 09:49:53 +0000269}
Devang Patel09f162c2007-05-01 21:15:47 +0000270
Devang Patel8c78a0b2007-05-03 01:11:54 +0000271char CodeGenPrepare::ID = 0;
Matthias Braun1527baa2017-05-25 21:26:32 +0000272INITIALIZE_PASS_BEGIN(CodeGenPrepare, DEBUG_TYPE,
Francis Visoiu Mistrih8b617642017-05-18 17:21:13 +0000273 "Optimize for code generation", false, false)
Dehao Chen302b69c2016-10-18 20:42:47 +0000274INITIALIZE_PASS_DEPENDENCY(ProfileSummaryInfoWrapperPass)
Matthias Braun1527baa2017-05-25 21:26:32 +0000275INITIALIZE_PASS_END(CodeGenPrepare, DEBUG_TYPE,
Francis Visoiu Mistrih8b617642017-05-18 17:21:13 +0000276 "Optimize for code generation", false, false)
Chris Lattnerf2836d12007-03-31 04:06:36 +0000277
Francis Visoiu Mistrih8b617642017-05-18 17:21:13 +0000278FunctionPass *llvm::createCodeGenPreparePass() { return new CodeGenPrepare(); }
Chris Lattnerf2836d12007-03-31 04:06:36 +0000279
Chris Lattnerf2836d12007-03-31 04:06:36 +0000280bool CodeGenPrepare::runOnFunction(Function &F) {
Andrew Kayloraa641a52016-04-22 22:06:11 +0000281 if (skipFunction(F))
Paul Robinson7c99ec52014-03-31 17:43:35 +0000282 return false;
283
Mehdi Amini4fe37982015-07-07 18:45:17 +0000284 DL = &F.getParent()->getDataLayout();
285
Chris Lattnerf2836d12007-03-31 04:06:36 +0000286 bool EverMadeChange = false;
Quentin Colombet3a4bf042014-02-06 21:44:56 +0000287 // Clear per function information.
Ahmed Bougachaf3299142015-06-17 20:44:32 +0000288 InsertedInsts.clear();
Quentin Colombet3a4bf042014-02-06 21:44:56 +0000289 PromotedInsts.clear();
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000290 BFI.reset();
291 BPI.reset();
Eric Christopherc1ea1492008-09-24 05:32:41 +0000292
Devang Patel8f606d72011-03-24 15:35:25 +0000293 ModifiedDT = false;
Francis Visoiu Mistrih8b617642017-05-18 17:21:13 +0000294 if (auto *TPC = getAnalysisIfAvailable<TargetPassConfig>()) {
295 TM = &TPC->getTM<TargetMachine>();
Igor Laevsky3be81ba2017-02-07 13:27:20 +0000296 SubtargetInfo = TM->getSubtargetImpl(F);
297 TLI = SubtargetInfo->getTargetLowering();
298 TRI = SubtargetInfo->getRegisterInfo();
299 }
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000300 TLInfo = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
Chandler Carruthfdb9c572015-02-01 12:01:35 +0000301 TTI = &getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F);
Chuang-Yu Chengd3fb38c2016-04-05 14:06:20 +0000302 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
Sanjay Patel82d91dd2015-08-11 19:39:36 +0000303 OptSize = F.optForSize();
Evan Cheng0663f232011-03-21 01:19:09 +0000304
Dehao Chen302b69c2016-10-18 20:42:47 +0000305 if (ProfileGuidedSectionPrefix) {
306 ProfileSummaryInfo *PSI =
307 getAnalysis<ProfileSummaryInfoWrapperPass>().getPSI();
Dehao Chen775341a2017-03-23 23:14:11 +0000308 if (PSI->isFunctionHotInCallGraph(&F))
Dehao Chen302b69c2016-10-18 20:42:47 +0000309 F.setSectionPrefix(".hot");
Dehao Chen775341a2017-03-23 23:14:11 +0000310 else if (PSI->isFunctionColdInCallGraph(&F))
Teresa Johnson720d9b42017-05-09 01:43:24 +0000311 F.setSectionPrefix(".unlikely");
Dehao Chen302b69c2016-10-18 20:42:47 +0000312 }
313
Preston Gurdcdf540d2012-09-04 18:22:17 +0000314 /// This optimization identifies DIV instructions that can be
315 /// profitably bypassed and carried out with a shorter, faster divide.
Preston Gurd485296d2013-03-04 18:13:57 +0000316 if (!OptSize && TLI && TLI->isSlowDivBypassed()) {
Preston Gurd0d67f512012-10-04 21:33:40 +0000317 const DenseMap<unsigned int, unsigned int> &BypassWidths =
318 TLI->getBypassSlowDivWidths();
Eric Christopher49a7d6c2016-01-04 23:18:58 +0000319 BasicBlock* BB = &*F.begin();
320 while (BB != nullptr) {
321 // bypassSlowDivision may create new BBs, but we don't want to reapply the
322 // optimization to those blocks.
323 BasicBlock* Next = BB->getNextNode();
324 EverMadeChange |= bypassSlowDivision(BB, BypassWidths);
325 BB = Next;
326 }
Preston Gurdcdf540d2012-09-04 18:22:17 +0000327 }
328
329 // Eliminate blocks that contain only PHI nodes and an
Chris Lattnerc3748562007-04-02 01:35:34 +0000330 // unconditional branch.
Sanjay Patelfc580a62015-09-21 23:03:16 +0000331 EverMadeChange |= eliminateMostlyEmptyBlocks(F);
Eric Christopherc1ea1492008-09-24 05:32:41 +0000332
Devang Patel53771ba2011-08-18 00:50:51 +0000333 // llvm.dbg.value is far away from the value then iSel may not be able
Nadav Rotem465834c2012-07-24 10:51:42 +0000334 // handle it properly. iSel will drop llvm.dbg.value if it can not
Devang Patel53771ba2011-08-18 00:50:51 +0000335 // find a node corresponding to the value.
Sanjay Patelfc580a62015-09-21 23:03:16 +0000336 EverMadeChange |= placeDbgValues(F);
Devang Patel53771ba2011-08-18 00:50:51 +0000337
Geoff Berry5d534b62017-02-21 18:53:14 +0000338 if (!DisableBranchOpts)
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +0000339 EverMadeChange |= splitBranchCondition(F);
Tim Northovercea0abb2014-03-29 08:22:29 +0000340
Michael Kuperstein13bf8a22017-02-28 00:11:34 +0000341 // Split some critical edges where one of the sources is an indirect branch,
342 // to help generate sane code for PHIs involving such edges.
343 EverMadeChange |= splitIndirectCriticalEdges(F);
344
Chris Lattnerc3748562007-04-02 01:35:34 +0000345 bool MadeChange = true;
Chris Lattnerf2836d12007-03-31 04:06:36 +0000346 while (MadeChange) {
347 MadeChange = false;
Jun Bum Limdee55652017-04-03 19:20:07 +0000348 SeenChainsForSExt.clear();
349 ValToSExtendedUses.clear();
350 RemovedInsts.clear();
Hans Wennborg02fbc712012-09-19 07:48:16 +0000351 for (Function::iterator I = F.begin(); I != F.end(); ) {
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +0000352 BasicBlock *BB = &*I++;
Elena Demikhovsky87700a72014-12-28 08:54:45 +0000353 bool ModifiedDTOnIteration = false;
Sanjay Patelfc580a62015-09-21 23:03:16 +0000354 MadeChange |= optimizeBlock(*BB, ModifiedDTOnIteration);
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000355
Elena Demikhovsky87700a72014-12-28 08:54:45 +0000356 // Restart BB iteration if the dominator tree of the Function was changed
Elena Demikhovsky87700a72014-12-28 08:54:45 +0000357 if (ModifiedDTOnIteration)
358 break;
Evan Cheng0663f232011-03-21 01:19:09 +0000359 }
Jun Bum Limdee55652017-04-03 19:20:07 +0000360 if (EnableTypePromotionMerge && !ValToSExtendedUses.empty())
361 MadeChange |= mergeSExts(F);
362
363 // Really free removed instructions during promotion.
364 for (Instruction *I : RemovedInsts)
Reid Kleckner96ab8722017-05-18 17:24:10 +0000365 I->deleteValue();
Jun Bum Limdee55652017-04-03 19:20:07 +0000366
Chris Lattnerf2836d12007-03-31 04:06:36 +0000367 EverMadeChange |= MadeChange;
368 }
Cameron Zwarichce3b9302011-01-06 00:42:50 +0000369
370 SunkAddrs.clear();
371
Cameron Zwarich338d3622011-03-11 21:52:04 +0000372 if (!DisableBranchOpts) {
373 MadeChange = false;
Bill Wendling97b93592012-03-04 10:46:01 +0000374 SmallPtrSet<BasicBlock*, 8> WorkList;
Duncan P. N. Exon Smith5914a972015-01-08 20:44:33 +0000375 for (BasicBlock &BB : F) {
376 SmallVector<BasicBlock *, 2> Successors(succ_begin(&BB), succ_end(&BB));
377 MadeChange |= ConstantFoldTerminator(&BB, true);
Bill Wendling97b93592012-03-04 10:46:01 +0000378 if (!MadeChange) continue;
379
380 for (SmallVectorImpl<BasicBlock*>::iterator
381 II = Successors.begin(), IE = Successors.end(); II != IE; ++II)
382 if (pred_begin(*II) == pred_end(*II))
383 WorkList.insert(*II);
384 }
385
Bill Wendlingf3614fd2012-11-28 23:23:48 +0000386 // Delete the dead blocks and any of their dead successors.
Bill Wendlingab417b62012-12-06 00:30:20 +0000387 MadeChange |= !WorkList.empty();
Bill Wendlingf3614fd2012-11-28 23:23:48 +0000388 while (!WorkList.empty()) {
389 BasicBlock *BB = *WorkList.begin();
390 WorkList.erase(BB);
391 SmallVector<BasicBlock*, 2> Successors(succ_begin(BB), succ_end(BB));
392
393 DeleteDeadBlock(BB);
Stephen Lin837bba12013-07-15 17:55:02 +0000394
Bill Wendlingf3614fd2012-11-28 23:23:48 +0000395 for (SmallVectorImpl<BasicBlock*>::iterator
396 II = Successors.begin(), IE = Successors.end(); II != IE; ++II)
397 if (pred_begin(*II) == pred_end(*II))
398 WorkList.insert(*II);
399 }
Cameron Zwarich338d3622011-03-11 21:52:04 +0000400
Nadav Rotem70409992012-08-14 05:19:07 +0000401 // Merge pairs of basic blocks with unconditional branches, connected by
402 // a single edge.
403 if (EverMadeChange || MadeChange)
Sanjay Patelfc580a62015-09-21 23:03:16 +0000404 MadeChange |= eliminateFallThrough(F);
Nadav Rotem70409992012-08-14 05:19:07 +0000405
Cameron Zwarich338d3622011-03-11 21:52:04 +0000406 EverMadeChange |= MadeChange;
407 }
408
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000409 if (!DisableGCOpts) {
410 SmallVector<Instruction *, 2> Statepoints;
411 for (BasicBlock &BB : F)
412 for (Instruction &I : BB)
413 if (isStatepoint(I))
414 Statepoints.push_back(&I);
415 for (auto &I : Statepoints)
416 EverMadeChange |= simplifyOffsetableRelocate(*I);
417 }
418
Chris Lattnerf2836d12007-03-31 04:06:36 +0000419 return EverMadeChange;
420}
421
Sanjay Patel4ac6b112015-09-21 22:47:23 +0000422/// Merge basic blocks which are connected by a single edge, where one of the
423/// basic blocks has a single successor pointing to the other basic block,
424/// which has a single predecessor.
Sanjay Patelfc580a62015-09-21 23:03:16 +0000425bool CodeGenPrepare::eliminateFallThrough(Function &F) {
Nadav Rotem70409992012-08-14 05:19:07 +0000426 bool Changed = false;
427 // Scan all of the blocks in the function, except for the entry block.
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000428 for (Function::iterator I = std::next(F.begin()), E = F.end(); I != E;) {
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +0000429 BasicBlock *BB = &*I++;
Nadav Rotem70409992012-08-14 05:19:07 +0000430 // If the destination block has a single pred, then this is a trivial
431 // edge, just collapse it.
432 BasicBlock *SinglePred = BB->getSinglePredecessor();
433
Evan Cheng64a223a2012-09-28 23:58:57 +0000434 // Don't merge if BB's address is taken.
435 if (!SinglePred || SinglePred == BB || BB->hasAddressTaken()) continue;
Nadav Rotem70409992012-08-14 05:19:07 +0000436
437 BranchInst *Term = dyn_cast<BranchInst>(SinglePred->getTerminator());
438 if (Term && !Term->isConditional()) {
439 Changed = true;
Michael Liao6e12d122012-08-21 05:55:22 +0000440 DEBUG(dbgs() << "To merge:\n"<< *SinglePred << "\n\n\n");
Nadav Rotem70409992012-08-14 05:19:07 +0000441 // Remember if SinglePred was the entry block of the function.
442 // If so, we will need to move BB back to the entry position.
443 bool isEntry = SinglePred == &SinglePred->getParent()->getEntryBlock();
Quentin Colombet7bdd50d2015-03-18 23:17:28 +0000444 MergeBasicBlockIntoOnlyPred(BB, nullptr);
Nadav Rotem70409992012-08-14 05:19:07 +0000445
446 if (isEntry && BB != &BB->getParent()->getEntryBlock())
447 BB->moveBefore(&BB->getParent()->getEntryBlock());
448
449 // We have erased a block. Update the iterator.
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +0000450 I = BB->getIterator();
Nadav Rotem70409992012-08-14 05:19:07 +0000451 }
452 }
453 return Changed;
454}
455
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000456/// Find a destination block from BB if BB is mergeable empty block.
457BasicBlock *CodeGenPrepare::findDestBlockOfMergeableEmptyBlock(BasicBlock *BB) {
458 // If this block doesn't end with an uncond branch, ignore it.
459 BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator());
460 if (!BI || !BI->isUnconditional())
461 return nullptr;
462
463 // If the instruction before the branch (skipping debug info) isn't a phi
464 // node, then other stuff is happening here.
465 BasicBlock::iterator BBI = BI->getIterator();
466 if (BBI != BB->begin()) {
467 --BBI;
468 while (isa<DbgInfoIntrinsic>(BBI)) {
469 if (BBI == BB->begin())
470 break;
471 --BBI;
472 }
473 if (!isa<DbgInfoIntrinsic>(BBI) && !isa<PHINode>(BBI))
474 return nullptr;
475 }
476
477 // Do not break infinite loops.
478 BasicBlock *DestBB = BI->getSuccessor(0);
479 if (DestBB == BB)
480 return nullptr;
481
482 if (!canMergeBlocks(BB, DestBB))
483 DestBB = nullptr;
484
485 return DestBB;
486}
487
Michael Kuperstein13bf8a22017-02-28 00:11:34 +0000488// Return the unique indirectbr predecessor of a block. This may return null
489// even if such a predecessor exists, if it's not useful for splitting.
490// If a predecessor is found, OtherPreds will contain all other (non-indirectbr)
491// predecessors of BB.
492static BasicBlock *
493findIBRPredecessor(BasicBlock *BB, SmallVectorImpl<BasicBlock *> &OtherPreds) {
494 // If the block doesn't have any PHIs, we don't care about it, since there's
495 // no point in splitting it.
496 PHINode *PN = dyn_cast<PHINode>(BB->begin());
497 if (!PN)
498 return nullptr;
499
500 // Verify we have exactly one IBR predecessor.
501 // Conservatively bail out if one of the other predecessors is not a "regular"
502 // terminator (that is, not a switch or a br).
503 BasicBlock *IBB = nullptr;
504 for (unsigned Pred = 0, E = PN->getNumIncomingValues(); Pred != E; ++Pred) {
505 BasicBlock *PredBB = PN->getIncomingBlock(Pred);
506 TerminatorInst *PredTerm = PredBB->getTerminator();
507 switch (PredTerm->getOpcode()) {
508 case Instruction::IndirectBr:
509 if (IBB)
510 return nullptr;
511 IBB = PredBB;
512 break;
513 case Instruction::Br:
514 case Instruction::Switch:
515 OtherPreds.push_back(PredBB);
516 continue;
517 default:
518 return nullptr;
519 }
520 }
521
522 return IBB;
523}
524
525// Split critical edges where the source of the edge is an indirectbr
526// instruction. This isn't always possible, but we can handle some easy cases.
527// This is useful because MI is unable to split such critical edges,
528// which means it will not be able to sink instructions along those edges.
529// This is especially painful for indirect branches with many successors, where
530// we end up having to prepare all outgoing values in the origin block.
531//
532// Our normal algorithm for splitting critical edges requires us to update
533// the outgoing edges of the edge origin block, but for an indirectbr this
534// is hard, since it would require finding and updating the block addresses
535// the indirect branch uses. But if a block only has a single indirectbr
536// predecessor, with the others being regular branches, we can do it in a
537// different way.
538// Say we have A -> D, B -> D, I -> D where only I -> D is an indirectbr.
539// We can split D into D0 and D1, where D0 contains only the PHIs from D,
540// and D1 is the D block body. We can then duplicate D0 as D0A and D0B, and
541// create the following structure:
542// A -> D0A, B -> D0A, I -> D0B, D0A -> D1, D0B -> D1
543bool CodeGenPrepare::splitIndirectCriticalEdges(Function &F) {
544 // Check whether the function has any indirectbrs, and collect which blocks
545 // they may jump to. Since most functions don't have indirect branches,
546 // this lowers the common case's overhead to O(Blocks) instead of O(Edges).
547 SmallSetVector<BasicBlock *, 16> Targets;
548 for (auto &BB : F) {
549 auto *IBI = dyn_cast<IndirectBrInst>(BB.getTerminator());
550 if (!IBI)
551 continue;
552
553 for (unsigned Succ = 0, E = IBI->getNumSuccessors(); Succ != E; ++Succ)
554 Targets.insert(IBI->getSuccessor(Succ));
555 }
556
557 if (Targets.empty())
558 return false;
559
560 bool Changed = false;
561 for (BasicBlock *Target : Targets) {
562 SmallVector<BasicBlock *, 16> OtherPreds;
563 BasicBlock *IBRPred = findIBRPredecessor(Target, OtherPreds);
564 // If we did not found an indirectbr, or the indirectbr is the only
565 // incoming edge, this isn't the kind of edge we're looking for.
566 if (!IBRPred || OtherPreds.empty())
567 continue;
568
569 // Don't even think about ehpads/landingpads.
570 Instruction *FirstNonPHI = Target->getFirstNonPHI();
571 if (FirstNonPHI->isEHPad() || Target->isLandingPad())
572 continue;
573
574 BasicBlock *BodyBlock = Target->splitBasicBlock(FirstNonPHI, ".split");
575 // It's possible Target was its own successor through an indirectbr.
576 // In this case, the indirectbr now comes from BodyBlock.
577 if (IBRPred == Target)
578 IBRPred = BodyBlock;
579
580 // At this point Target only has PHIs, and BodyBlock has the rest of the
581 // block's body. Create a copy of Target that will be used by the "direct"
582 // preds.
583 ValueToValueMapTy VMap;
584 BasicBlock *DirectSucc = CloneBasicBlock(Target, VMap, ".clone", &F);
585
Brendon Cahoon7769a082017-04-17 19:11:04 +0000586 for (BasicBlock *Pred : OtherPreds) {
587 // If the target is a loop to itself, then the terminator of the split
588 // block needs to be updated.
589 if (Pred == Target)
590 BodyBlock->getTerminator()->replaceUsesOfWith(Target, DirectSucc);
591 else
592 Pred->getTerminator()->replaceUsesOfWith(Target, DirectSucc);
593 }
Michael Kuperstein13bf8a22017-02-28 00:11:34 +0000594
595 // Ok, now fix up the PHIs. We know the two blocks only have PHIs, and that
596 // they are clones, so the number of PHIs are the same.
597 // (a) Remove the edge coming from IBRPred from the "Direct" PHI
598 // (b) Leave that as the only edge in the "Indirect" PHI.
599 // (c) Merge the two in the body block.
600 BasicBlock::iterator Indirect = Target->begin(),
601 End = Target->getFirstNonPHI()->getIterator();
602 BasicBlock::iterator Direct = DirectSucc->begin();
603 BasicBlock::iterator MergeInsert = BodyBlock->getFirstInsertionPt();
604
605 assert(&*End == Target->getTerminator() &&
606 "Block was expected to only contain PHIs");
607
608 while (Indirect != End) {
609 PHINode *DirPHI = cast<PHINode>(Direct);
610 PHINode *IndPHI = cast<PHINode>(Indirect);
611
612 // Now, clean up - the direct block shouldn't get the indirect value,
613 // and vice versa.
614 DirPHI->removeIncomingValue(IBRPred);
615 Direct++;
616
617 // Advance the pointer here, to avoid invalidation issues when the old
618 // PHI is erased.
619 Indirect++;
620
621 PHINode *NewIndPHI = PHINode::Create(IndPHI->getType(), 1, "ind", IndPHI);
622 NewIndPHI->addIncoming(IndPHI->getIncomingValueForBlock(IBRPred),
623 IBRPred);
624
625 // Create a PHI in the body block, to merge the direct and indirect
626 // predecessors.
627 PHINode *MergePHI =
628 PHINode::Create(IndPHI->getType(), 2, "merge", &*MergeInsert);
629 MergePHI->addIncoming(NewIndPHI, Target);
630 MergePHI->addIncoming(DirPHI, DirectSucc);
631
632 IndPHI->replaceAllUsesWith(MergePHI);
633 IndPHI->eraseFromParent();
634 }
635
636 Changed = true;
637 }
638
639 return Changed;
640}
641
Sanjay Patel4ac6b112015-09-21 22:47:23 +0000642/// Eliminate blocks that contain only PHI nodes, debug info directives, and an
643/// unconditional branch. Passes before isel (e.g. LSR/loopsimplify) often split
644/// edges in ways that are non-optimal for isel. Start by eliminating these
645/// blocks so we can split them the way we want them.
Sanjay Patelfc580a62015-09-21 23:03:16 +0000646bool CodeGenPrepare::eliminateMostlyEmptyBlocks(Function &F) {
Chuang-Yu Chengd3fb38c2016-04-05 14:06:20 +0000647 SmallPtrSet<BasicBlock *, 16> Preheaders;
648 SmallVector<Loop *, 16> LoopList(LI->begin(), LI->end());
649 while (!LoopList.empty()) {
650 Loop *L = LoopList.pop_back_val();
651 LoopList.insert(LoopList.end(), L->begin(), L->end());
652 if (BasicBlock *Preheader = L->getLoopPreheader())
653 Preheaders.insert(Preheader);
654 }
655
Chris Lattnerc3748562007-04-02 01:35:34 +0000656 bool MadeChange = false;
657 // Note that this intentionally skips the entry block.
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +0000658 for (Function::iterator I = std::next(F.begin()), E = F.end(); I != E;) {
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +0000659 BasicBlock *BB = &*I++;
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000660 BasicBlock *DestBB = findDestBlockOfMergeableEmptyBlock(BB);
661 if (!DestBB ||
662 !isMergingEmptyBlockProfitable(BB, DestBB, Preheaders.count(BB)))
Chris Lattnerc3748562007-04-02 01:35:34 +0000663 continue;
Eric Christopherc1ea1492008-09-24 05:32:41 +0000664
Sanjay Patelfc580a62015-09-21 23:03:16 +0000665 eliminateMostlyEmptyBlock(BB);
Chris Lattnerc3748562007-04-02 01:35:34 +0000666 MadeChange = true;
667 }
668 return MadeChange;
669}
670
Jun Bum Lim90b6b502016-12-16 20:38:39 +0000671bool CodeGenPrepare::isMergingEmptyBlockProfitable(BasicBlock *BB,
672 BasicBlock *DestBB,
673 bool isPreheader) {
674 // Do not delete loop preheaders if doing so would create a critical edge.
675 // Loop preheaders can be good locations to spill registers. If the
676 // preheader is deleted and we create a critical edge, registers may be
677 // spilled in the loop body instead.
678 if (!DisablePreheaderProtect && isPreheader &&
679 !(BB->getSinglePredecessor() &&
680 BB->getSinglePredecessor()->getSingleSuccessor()))
681 return false;
682
683 // Try to skip merging if the unique predecessor of BB is terminated by a
684 // switch or indirect branch instruction, and BB is used as an incoming block
685 // of PHIs in DestBB. In such case, merging BB and DestBB would cause ISel to
686 // add COPY instructions in the predecessor of BB instead of BB (if it is not
687 // merged). Note that the critical edge created by merging such blocks wont be
688 // split in MachineSink because the jump table is not analyzable. By keeping
689 // such empty block (BB), ISel will place COPY instructions in BB, not in the
690 // predecessor of BB.
691 BasicBlock *Pred = BB->getUniquePredecessor();
692 if (!Pred ||
693 !(isa<SwitchInst>(Pred->getTerminator()) ||
694 isa<IndirectBrInst>(Pred->getTerminator())))
695 return true;
696
697 if (BB->getTerminator() != BB->getFirstNonPHI())
698 return true;
699
700 // We use a simple cost heuristic which determine skipping merging is
701 // profitable if the cost of skipping merging is less than the cost of
702 // merging : Cost(skipping merging) < Cost(merging BB), where the
703 // Cost(skipping merging) is Freq(BB) * (Cost(Copy) + Cost(Branch)), and
704 // the Cost(merging BB) is Freq(Pred) * Cost(Copy).
705 // Assuming Cost(Copy) == Cost(Branch), we could simplify it to :
706 // Freq(Pred) / Freq(BB) > 2.
707 // Note that if there are multiple empty blocks sharing the same incoming
708 // value for the PHIs in the DestBB, we consider them together. In such
709 // case, Cost(merging BB) will be the sum of their frequencies.
710
711 if (!isa<PHINode>(DestBB->begin()))
712 return true;
713
714 SmallPtrSet<BasicBlock *, 16> SameIncomingValueBBs;
715
716 // Find all other incoming blocks from which incoming values of all PHIs in
717 // DestBB are the same as the ones from BB.
718 for (pred_iterator PI = pred_begin(DestBB), E = pred_end(DestBB); PI != E;
719 ++PI) {
720 BasicBlock *DestBBPred = *PI;
721 if (DestBBPred == BB)
722 continue;
723
724 bool HasAllSameValue = true;
725 BasicBlock::const_iterator DestBBI = DestBB->begin();
726 while (const PHINode *DestPN = dyn_cast<PHINode>(DestBBI++)) {
727 if (DestPN->getIncomingValueForBlock(BB) !=
728 DestPN->getIncomingValueForBlock(DestBBPred)) {
729 HasAllSameValue = false;
730 break;
731 }
732 }
733 if (HasAllSameValue)
734 SameIncomingValueBBs.insert(DestBBPred);
735 }
736
737 // See if all BB's incoming values are same as the value from Pred. In this
738 // case, no reason to skip merging because COPYs are expected to be place in
739 // Pred already.
740 if (SameIncomingValueBBs.count(Pred))
741 return true;
742
743 if (!BFI) {
744 Function &F = *BB->getParent();
745 LoopInfo LI{DominatorTree(F)};
746 BPI.reset(new BranchProbabilityInfo(F, LI));
747 BFI.reset(new BlockFrequencyInfo(F, *BPI, LI));
748 }
749
750 BlockFrequency PredFreq = BFI->getBlockFreq(Pred);
751 BlockFrequency BBFreq = BFI->getBlockFreq(BB);
752
753 for (auto SameValueBB : SameIncomingValueBBs)
754 if (SameValueBB->getUniquePredecessor() == Pred &&
755 DestBB == findDestBlockOfMergeableEmptyBlock(SameValueBB))
756 BBFreq += BFI->getBlockFreq(SameValueBB);
757
758 return PredFreq.getFrequency() <=
759 BBFreq.getFrequency() * FreqRatioToSkipMerge;
760}
761
Sanjay Patel4ac6b112015-09-21 22:47:23 +0000762/// Return true if we can merge BB into DestBB if there is a single
763/// unconditional branch between them, and BB contains no other non-phi
Chris Lattnerc3748562007-04-02 01:35:34 +0000764/// instructions.
Sanjay Patelfc580a62015-09-21 23:03:16 +0000765bool CodeGenPrepare::canMergeBlocks(const BasicBlock *BB,
Chris Lattnerc3748562007-04-02 01:35:34 +0000766 const BasicBlock *DestBB) const {
767 // We only want to eliminate blocks whose phi nodes are used by phi nodes in
768 // the successor. If there are more complex condition (e.g. preheaders),
769 // don't mess around with them.
770 BasicBlock::const_iterator BBI = BB->begin();
771 while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000772 for (const User *U : PN->users()) {
773 const Instruction *UI = cast<Instruction>(U);
774 if (UI->getParent() != DestBB || !isa<PHINode>(UI))
Chris Lattnerc3748562007-04-02 01:35:34 +0000775 return false;
Eric Christopherc1ea1492008-09-24 05:32:41 +0000776 // If User is inside DestBB block and it is a PHINode then check
777 // incoming value. If incoming value is not from BB then this is
Devang Pateld3208522007-04-25 00:37:04 +0000778 // a complex condition (e.g. preheaders) we want to avoid here.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000779 if (UI->getParent() == DestBB) {
780 if (const PHINode *UPN = dyn_cast<PHINode>(UI))
Devang Pateld3208522007-04-25 00:37:04 +0000781 for (unsigned I = 0, E = UPN->getNumIncomingValues(); I != E; ++I) {
782 Instruction *Insn = dyn_cast<Instruction>(UPN->getIncomingValue(I));
783 if (Insn && Insn->getParent() == BB &&
784 Insn->getParent() != UPN->getIncomingBlock(I))
785 return false;
786 }
787 }
Chris Lattnerc3748562007-04-02 01:35:34 +0000788 }
789 }
Eric Christopherc1ea1492008-09-24 05:32:41 +0000790
Chris Lattnerc3748562007-04-02 01:35:34 +0000791 // If BB and DestBB contain any common predecessors, then the phi nodes in BB
792 // and DestBB may have conflicting incoming values for the block. If so, we
793 // can't merge the block.
794 const PHINode *DestBBPN = dyn_cast<PHINode>(DestBB->begin());
795 if (!DestBBPN) return true; // no conflict.
Eric Christopherc1ea1492008-09-24 05:32:41 +0000796
Chris Lattnerc3748562007-04-02 01:35:34 +0000797 // Collect the preds of BB.
Chris Lattner8201a9b2007-11-06 22:07:40 +0000798 SmallPtrSet<const BasicBlock*, 16> BBPreds;
Chris Lattnerc3748562007-04-02 01:35:34 +0000799 if (const PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
800 // It is faster to get preds from a PHI than with pred_iterator.
801 for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
802 BBPreds.insert(BBPN->getIncomingBlock(i));
803 } else {
804 BBPreds.insert(pred_begin(BB), pred_end(BB));
805 }
Eric Christopherc1ea1492008-09-24 05:32:41 +0000806
Chris Lattnerc3748562007-04-02 01:35:34 +0000807 // Walk the preds of DestBB.
808 for (unsigned i = 0, e = DestBBPN->getNumIncomingValues(); i != e; ++i) {
809 BasicBlock *Pred = DestBBPN->getIncomingBlock(i);
810 if (BBPreds.count(Pred)) { // Common predecessor?
811 BBI = DestBB->begin();
812 while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
813 const Value *V1 = PN->getIncomingValueForBlock(Pred);
814 const Value *V2 = PN->getIncomingValueForBlock(BB);
Eric Christopherc1ea1492008-09-24 05:32:41 +0000815
Chris Lattnerc3748562007-04-02 01:35:34 +0000816 // If V2 is a phi node in BB, look up what the mapped value will be.
817 if (const PHINode *V2PN = dyn_cast<PHINode>(V2))
818 if (V2PN->getParent() == BB)
819 V2 = V2PN->getIncomingValueForBlock(Pred);
Eric Christopherc1ea1492008-09-24 05:32:41 +0000820
Chris Lattnerc3748562007-04-02 01:35:34 +0000821 // If there is a conflict, bail out.
822 if (V1 != V2) return false;
823 }
824 }
825 }
826
827 return true;
828}
829
830
Sanjay Patel4ac6b112015-09-21 22:47:23 +0000831/// Eliminate a basic block that has only phi's and an unconditional branch in
832/// it.
Sanjay Patelfc580a62015-09-21 23:03:16 +0000833void CodeGenPrepare::eliminateMostlyEmptyBlock(BasicBlock *BB) {
Chris Lattnerc3748562007-04-02 01:35:34 +0000834 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
835 BasicBlock *DestBB = BI->getSuccessor(0);
Eric Christopherc1ea1492008-09-24 05:32:41 +0000836
David Greene74e2d492010-01-05 01:27:11 +0000837 DEBUG(dbgs() << "MERGING MOSTLY EMPTY BLOCKS - BEFORE:\n" << *BB << *DestBB);
Eric Christopherc1ea1492008-09-24 05:32:41 +0000838
Chris Lattnerc3748562007-04-02 01:35:34 +0000839 // If the destination block has a single pred, then this is a trivial edge,
840 // just collapse it.
Chris Lattner4059f432008-11-27 19:29:14 +0000841 if (BasicBlock *SinglePred = DestBB->getSinglePredecessor()) {
Chris Lattner8a172da2008-11-28 19:54:49 +0000842 if (SinglePred != DestBB) {
843 // Remember if SinglePred was the entry block of the function. If so, we
844 // will need to move BB back to the entry position.
845 bool isEntry = SinglePred == &SinglePred->getParent()->getEntryBlock();
Quentin Colombet7bdd50d2015-03-18 23:17:28 +0000846 MergeBasicBlockIntoOnlyPred(DestBB, nullptr);
Chris Lattner4059f432008-11-27 19:29:14 +0000847
Chris Lattner8a172da2008-11-28 19:54:49 +0000848 if (isEntry && BB != &BB->getParent()->getEntryBlock())
849 BB->moveBefore(&BB->getParent()->getEntryBlock());
Nadav Rotem465834c2012-07-24 10:51:42 +0000850
David Greene74e2d492010-01-05 01:27:11 +0000851 DEBUG(dbgs() << "AFTER:\n" << *DestBB << "\n\n\n");
Chris Lattner8a172da2008-11-28 19:54:49 +0000852 return;
853 }
Chris Lattnerc3748562007-04-02 01:35:34 +0000854 }
Eric Christopherc1ea1492008-09-24 05:32:41 +0000855
Chris Lattnerc3748562007-04-02 01:35:34 +0000856 // Otherwise, we have multiple predecessors of BB. Update the PHIs in DestBB
857 // to handle the new incoming edges it is about to have.
858 PHINode *PN;
859 for (BasicBlock::iterator BBI = DestBB->begin();
860 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
861 // Remove the incoming value for BB, and remember it.
862 Value *InVal = PN->removeIncomingValue(BB, false);
Eric Christopherc1ea1492008-09-24 05:32:41 +0000863
Chris Lattnerc3748562007-04-02 01:35:34 +0000864 // Two options: either the InVal is a phi node defined in BB or it is some
865 // value that dominates BB.
866 PHINode *InValPhi = dyn_cast<PHINode>(InVal);
867 if (InValPhi && InValPhi->getParent() == BB) {
868 // Add all of the input values of the input PHI as inputs of this phi.
869 for (unsigned i = 0, e = InValPhi->getNumIncomingValues(); i != e; ++i)
870 PN->addIncoming(InValPhi->getIncomingValue(i),
871 InValPhi->getIncomingBlock(i));
872 } else {
873 // Otherwise, add one instance of the dominating value for each edge that
874 // we will be adding.
875 if (PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
876 for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
877 PN->addIncoming(InVal, BBPN->getIncomingBlock(i));
878 } else {
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +0000879 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
880 PN->addIncoming(InVal, *PI);
Chris Lattnerc3748562007-04-02 01:35:34 +0000881 }
882 }
883 }
Eric Christopherc1ea1492008-09-24 05:32:41 +0000884
Chris Lattnerc3748562007-04-02 01:35:34 +0000885 // The PHIs are now updated, change everything that refers to BB to use
886 // DestBB and remove BB.
887 BB->replaceAllUsesWith(DestBB);
888 BB->eraseFromParent();
Cameron Zwarichced753f2011-01-05 17:27:27 +0000889 ++NumBlocksElim;
Eric Christopherc1ea1492008-09-24 05:32:41 +0000890
David Greene74e2d492010-01-05 01:27:11 +0000891 DEBUG(dbgs() << "AFTER:\n" << *DestBB << "\n\n\n");
Chris Lattnerc3748562007-04-02 01:35:34 +0000892}
893
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000894// Computes a map of base pointer relocation instructions to corresponding
895// derived pointer relocation instructions given a vector of all relocate calls
896static void computeBaseDerivedRelocateMap(
Manuel Jacob83eefa62016-01-05 04:03:00 +0000897 const SmallVectorImpl<GCRelocateInst *> &AllRelocateCalls,
898 DenseMap<GCRelocateInst *, SmallVector<GCRelocateInst *, 2>>
899 &RelocateInstMap) {
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000900 // Collect information in two maps: one primarily for locating the base object
901 // while filling the second map; the second map is the final structure holding
902 // a mapping between Base and corresponding Derived relocate calls
Manuel Jacob83eefa62016-01-05 04:03:00 +0000903 DenseMap<std::pair<unsigned, unsigned>, GCRelocateInst *> RelocateIdxMap;
904 for (auto *ThisRelocate : AllRelocateCalls) {
905 auto K = std::make_pair(ThisRelocate->getBasePtrIndex(),
906 ThisRelocate->getDerivedPtrIndex());
907 RelocateIdxMap.insert(std::make_pair(K, ThisRelocate));
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000908 }
909 for (auto &Item : RelocateIdxMap) {
910 std::pair<unsigned, unsigned> Key = Item.first;
911 if (Key.first == Key.second)
912 // Base relocation: nothing to insert
913 continue;
914
Manuel Jacob83eefa62016-01-05 04:03:00 +0000915 GCRelocateInst *I = Item.second;
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000916 auto BaseKey = std::make_pair(Key.first, Key.first);
Sanjoy Dasb8186762015-02-27 02:24:16 +0000917
918 // We're iterating over RelocateIdxMap so we cannot modify it.
919 auto MaybeBase = RelocateIdxMap.find(BaseKey);
920 if (MaybeBase == RelocateIdxMap.end())
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000921 // TODO: We might want to insert a new base object relocate and gep off
922 // that, if there are enough derived object relocates.
923 continue;
Sanjoy Dasb8186762015-02-27 02:24:16 +0000924
925 RelocateInstMap[MaybeBase->second].push_back(I);
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000926 }
927}
928
929// Accepts a GEP and extracts the operands into a vector provided they're all
930// small integer constants
931static bool getGEPSmallConstantIntOffsetV(GetElementPtrInst *GEP,
932 SmallVectorImpl<Value *> &OffsetV) {
933 for (unsigned i = 1; i < GEP->getNumOperands(); i++) {
934 // Only accept small constant integer operands
935 auto Op = dyn_cast<ConstantInt>(GEP->getOperand(i));
936 if (!Op || Op->getZExtValue() > 20)
937 return false;
938 }
939
940 for (unsigned i = 1; i < GEP->getNumOperands(); i++)
941 OffsetV.push_back(GEP->getOperand(i));
942 return true;
943}
944
945// Takes a RelocatedBase (base pointer relocation instruction) and Targets to
946// replace, computes a replacement, and affects it.
947static bool
Manuel Jacob83eefa62016-01-05 04:03:00 +0000948simplifyRelocatesOffABase(GCRelocateInst *RelocatedBase,
949 const SmallVectorImpl<GCRelocateInst *> &Targets) {
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000950 bool MadeChange = false;
Manuel Jacob83eefa62016-01-05 04:03:00 +0000951 for (GCRelocateInst *ToReplace : Targets) {
952 assert(ToReplace->getBasePtrIndex() == RelocatedBase->getBasePtrIndex() &&
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000953 "Not relocating a derived object of the original base object");
Manuel Jacob83eefa62016-01-05 04:03:00 +0000954 if (ToReplace->getBasePtrIndex() == ToReplace->getDerivedPtrIndex()) {
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000955 // A duplicate relocate call. TODO: coalesce duplicates.
956 continue;
957 }
958
Igor Laevskyf637b4a2015-11-03 18:37:40 +0000959 if (RelocatedBase->getParent() != ToReplace->getParent()) {
960 // Base and derived relocates are in different basic blocks.
961 // In this case transform is only valid when base dominates derived
962 // relocate. However it would be too expensive to check dominance
963 // for each such relocate, so we skip the whole transformation.
964 continue;
965 }
966
Manuel Jacob83eefa62016-01-05 04:03:00 +0000967 Value *Base = ToReplace->getBasePtr();
968 auto Derived = dyn_cast<GetElementPtrInst>(ToReplace->getDerivedPtr());
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000969 if (!Derived || Derived->getPointerOperand() != Base)
970 continue;
971
972 SmallVector<Value *, 2> OffsetV;
973 if (!getGEPSmallConstantIntOffsetV(Derived, OffsetV))
974 continue;
975
976 // Create a Builder and replace the target callsite with a gep
Sanjay Patel545a4562016-01-20 18:59:16 +0000977 assert(RelocatedBase->getNextNode() &&
978 "Should always have one since it's not a terminator");
Sanjoy Das3d705e32015-05-11 23:47:30 +0000979
980 // Insert after RelocatedBase
981 IRBuilder<> Builder(RelocatedBase->getNextNode());
Ramkumar Ramachandradba73292015-01-14 23:27:07 +0000982 Builder.SetCurrentDebugLocation(ToReplace->getDebugLoc());
Sanjoy Das89c54912015-05-11 18:49:34 +0000983
984 // If gc_relocate does not match the actual type, cast it to the right type.
985 // In theory, there must be a bitcast after gc_relocate if the type does not
986 // match, and we should reuse it to get the derived pointer. But it could be
987 // cases like this:
988 // bb1:
989 // ...
990 // %g1 = call coldcc i8 addrspace(1)* @llvm.experimental.gc.relocate.p1i8(...)
991 // br label %merge
992 //
993 // bb2:
994 // ...
995 // %g2 = call coldcc i8 addrspace(1)* @llvm.experimental.gc.relocate.p1i8(...)
996 // br label %merge
997 //
998 // merge:
999 // %p1 = phi i8 addrspace(1)* [ %g1, %bb1 ], [ %g2, %bb2 ]
1000 // %cast = bitcast i8 addrspace(1)* %p1 in to i32 addrspace(1)*
1001 //
1002 // In this case, we can not find the bitcast any more. So we insert a new bitcast
1003 // no matter there is already one or not. In this way, we can handle all cases, and
1004 // the extra bitcast should be optimized away in later passes.
Manuel Jacob5b90b142015-12-19 18:38:42 +00001005 Value *ActualRelocatedBase = RelocatedBase;
Sanjoy Das89c54912015-05-11 18:49:34 +00001006 if (RelocatedBase->getType() != Base->getType()) {
1007 ActualRelocatedBase =
Manuel Jacob5b90b142015-12-19 18:38:42 +00001008 Builder.CreateBitCast(RelocatedBase, Base->getType());
Sanjoy Das89c54912015-05-11 18:49:34 +00001009 }
David Blaikie68d535c2015-03-24 22:38:16 +00001010 Value *Replacement = Builder.CreateGEP(
Sanjoy Das89c54912015-05-11 18:49:34 +00001011 Derived->getSourceElementType(), ActualRelocatedBase, makeArrayRef(OffsetV));
Ramkumar Ramachandradba73292015-01-14 23:27:07 +00001012 Replacement->takeName(ToReplace);
Sanjoy Das89c54912015-05-11 18:49:34 +00001013 // If the newly generated derived pointer's type does not match the original derived
1014 // pointer's type, cast the new derived pointer to match it. Same reasoning as above.
Manuel Jacob5b90b142015-12-19 18:38:42 +00001015 Value *ActualReplacement = Replacement;
1016 if (Replacement->getType() != ToReplace->getType()) {
Sanjoy Das89c54912015-05-11 18:49:34 +00001017 ActualReplacement =
Manuel Jacob5b90b142015-12-19 18:38:42 +00001018 Builder.CreateBitCast(Replacement, ToReplace->getType());
Sanjoy Das89c54912015-05-11 18:49:34 +00001019 }
1020 ToReplace->replaceAllUsesWith(ActualReplacement);
Ramkumar Ramachandradba73292015-01-14 23:27:07 +00001021 ToReplace->eraseFromParent();
1022
1023 MadeChange = true;
1024 }
1025 return MadeChange;
1026}
1027
1028// Turns this:
1029//
1030// %base = ...
1031// %ptr = gep %base + 15
1032// %tok = statepoint (%fun, i32 0, i32 0, i32 0, %base, %ptr)
1033// %base' = relocate(%tok, i32 4, i32 4)
1034// %ptr' = relocate(%tok, i32 4, i32 5)
1035// %val = load %ptr'
1036//
1037// into this:
1038//
1039// %base = ...
1040// %ptr = gep %base + 15
1041// %tok = statepoint (%fun, i32 0, i32 0, i32 0, %base, %ptr)
1042// %base' = gc.relocate(%tok, i32 4, i32 4)
1043// %ptr' = gep %base' + 15
1044// %val = load %ptr'
1045bool CodeGenPrepare::simplifyOffsetableRelocate(Instruction &I) {
1046 bool MadeChange = false;
Manuel Jacob83eefa62016-01-05 04:03:00 +00001047 SmallVector<GCRelocateInst *, 2> AllRelocateCalls;
Ramkumar Ramachandradba73292015-01-14 23:27:07 +00001048
1049 for (auto *U : I.users())
Manuel Jacob83eefa62016-01-05 04:03:00 +00001050 if (GCRelocateInst *Relocate = dyn_cast<GCRelocateInst>(U))
Ramkumar Ramachandradba73292015-01-14 23:27:07 +00001051 // Collect all the relocate calls associated with a statepoint
Manuel Jacob83eefa62016-01-05 04:03:00 +00001052 AllRelocateCalls.push_back(Relocate);
Ramkumar Ramachandradba73292015-01-14 23:27:07 +00001053
1054 // We need atleast one base pointer relocation + one derived pointer
1055 // relocation to mangle
1056 if (AllRelocateCalls.size() < 2)
1057 return false;
1058
1059 // RelocateInstMap is a mapping from the base relocate instruction to the
1060 // corresponding derived relocate instructions
Manuel Jacob83eefa62016-01-05 04:03:00 +00001061 DenseMap<GCRelocateInst *, SmallVector<GCRelocateInst *, 2>> RelocateInstMap;
Ramkumar Ramachandradba73292015-01-14 23:27:07 +00001062 computeBaseDerivedRelocateMap(AllRelocateCalls, RelocateInstMap);
1063 if (RelocateInstMap.empty())
1064 return false;
1065
1066 for (auto &Item : RelocateInstMap)
1067 // Item.first is the RelocatedBase to offset against
1068 // Item.second is the vector of Targets to replace
1069 MadeChange = simplifyRelocatesOffABase(Item.first, Item.second);
1070 return MadeChange;
1071}
1072
Manuel Jacoba7c48f92014-03-13 13:36:25 +00001073/// SinkCast - Sink the specified cast instruction into its user blocks
1074static bool SinkCast(CastInst *CI) {
Chris Lattnerf2836d12007-03-31 04:06:36 +00001075 BasicBlock *DefBB = CI->getParent();
Eric Christopherc1ea1492008-09-24 05:32:41 +00001076
Chris Lattnerf2836d12007-03-31 04:06:36 +00001077 /// InsertedCasts - Only insert a cast in each block once.
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001078 DenseMap<BasicBlock*, CastInst*> InsertedCasts;
Eric Christopherc1ea1492008-09-24 05:32:41 +00001079
Chris Lattnerf2836d12007-03-31 04:06:36 +00001080 bool MadeChange = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001081 for (Value::user_iterator UI = CI->user_begin(), E = CI->user_end();
Chris Lattnerf2836d12007-03-31 04:06:36 +00001082 UI != E; ) {
1083 Use &TheUse = UI.getUse();
1084 Instruction *User = cast<Instruction>(*UI);
Eric Christopherc1ea1492008-09-24 05:32:41 +00001085
Chris Lattnerf2836d12007-03-31 04:06:36 +00001086 // Figure out which BB this cast is used in. For PHI's this is the
1087 // appropriate predecessor block.
1088 BasicBlock *UserBB = User->getParent();
1089 if (PHINode *PN = dyn_cast<PHINode>(User)) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001090 UserBB = PN->getIncomingBlock(TheUse);
Chris Lattnerf2836d12007-03-31 04:06:36 +00001091 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00001092
Chris Lattnerf2836d12007-03-31 04:06:36 +00001093 // Preincrement use iterator so we don't invalidate it.
1094 ++UI;
Eric Christopherc1ea1492008-09-24 05:32:41 +00001095
David Majnemer0c80e2e2016-04-27 19:36:38 +00001096 // The first insertion point of a block containing an EH pad is after the
1097 // pad. If the pad is the user, we cannot sink the cast past the pad.
1098 if (User->isEHPad())
1099 continue;
1100
Andrew Kaylord0430e82015-11-23 19:16:15 +00001101 // If the block selected to receive the cast is an EH pad that does not
1102 // allow non-PHI instructions before the terminator, we can't sink the
1103 // cast.
1104 if (UserBB->getTerminator()->isEHPad())
1105 continue;
1106
Chris Lattnerf2836d12007-03-31 04:06:36 +00001107 // If this user is in the same block as the cast, don't change the cast.
1108 if (UserBB == DefBB) continue;
Eric Christopherc1ea1492008-09-24 05:32:41 +00001109
Chris Lattnerf2836d12007-03-31 04:06:36 +00001110 // If we have already inserted a cast into this block, use it.
1111 CastInst *&InsertedCast = InsertedCasts[UserBB];
1112
1113 if (!InsertedCast) {
Bill Wendling8ddfc092011-08-16 20:45:24 +00001114 BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001115 assert(InsertPt != UserBB->end());
1116 InsertedCast = CastInst::Create(CI->getOpcode(), CI->getOperand(0),
1117 CI->getType(), "", &*InsertPt);
Chris Lattnerf2836d12007-03-31 04:06:36 +00001118 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00001119
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001120 // Replace a use of the cast with a use of the new cast.
Chris Lattnerf2836d12007-03-31 04:06:36 +00001121 TheUse = InsertedCast;
Benjamin Kramerb4bf14c2015-04-10 22:25:36 +00001122 MadeChange = true;
Cameron Zwarichced753f2011-01-05 17:27:27 +00001123 ++NumCastUses;
Chris Lattnerf2836d12007-03-31 04:06:36 +00001124 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00001125
Chris Lattnerf2836d12007-03-31 04:06:36 +00001126 // If we removed all uses, nuke the cast.
Duncan Sandsafa84da42008-01-20 16:51:46 +00001127 if (CI->use_empty()) {
Chris Lattnerf2836d12007-03-31 04:06:36 +00001128 CI->eraseFromParent();
Duncan Sandsafa84da42008-01-20 16:51:46 +00001129 MadeChange = true;
1130 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00001131
Chris Lattnerf2836d12007-03-31 04:06:36 +00001132 return MadeChange;
1133}
1134
Sanjay Patel4ac6b112015-09-21 22:47:23 +00001135/// If the specified cast instruction is a noop copy (e.g. it's casting from
1136/// one pointer type to another, i32->i8 on PPC), sink it into user blocks to
1137/// reduce the number of virtual registers that must be created and coalesced.
Manuel Jacoba7c48f92014-03-13 13:36:25 +00001138///
1139/// Return true if any changes are made.
1140///
Mehdi Amini44ede332015-07-09 02:09:04 +00001141static bool OptimizeNoopCopyExpression(CastInst *CI, const TargetLowering &TLI,
1142 const DataLayout &DL) {
Justin Lebar3e50a5b2016-11-21 22:49:15 +00001143 // Sink only "cheap" (or nop) address-space casts. This is a weaker condition
1144 // than sinking only nop casts, but is helpful on some platforms.
1145 if (auto *ASC = dyn_cast<AddrSpaceCastInst>(CI)) {
1146 if (!TLI.isCheapAddrSpaceCast(ASC->getSrcAddressSpace(),
1147 ASC->getDestAddressSpace()))
1148 return false;
1149 }
1150
Manuel Jacoba7c48f92014-03-13 13:36:25 +00001151 // If this is a noop copy,
Mehdi Amini44ede332015-07-09 02:09:04 +00001152 EVT SrcVT = TLI.getValueType(DL, CI->getOperand(0)->getType());
1153 EVT DstVT = TLI.getValueType(DL, CI->getType());
Manuel Jacoba7c48f92014-03-13 13:36:25 +00001154
1155 // This is an fp<->int conversion?
1156 if (SrcVT.isInteger() != DstVT.isInteger())
1157 return false;
1158
1159 // If this is an extension, it will be a zero or sign extension, which
1160 // isn't a noop.
1161 if (SrcVT.bitsLT(DstVT)) return false;
1162
1163 // If these values will be promoted, find out what they will be promoted
1164 // to. This helps us consider truncates on PPC as noop copies when they
1165 // are.
1166 if (TLI.getTypeAction(CI->getContext(), SrcVT) ==
1167 TargetLowering::TypePromoteInteger)
1168 SrcVT = TLI.getTypeToTransformTo(CI->getContext(), SrcVT);
1169 if (TLI.getTypeAction(CI->getContext(), DstVT) ==
1170 TargetLowering::TypePromoteInteger)
1171 DstVT = TLI.getTypeToTransformTo(CI->getContext(), DstVT);
1172
1173 // If, after promotion, these are the same types, this is a noop copy.
1174 if (SrcVT != DstVT)
1175 return false;
1176
1177 return SinkCast(CI);
1178}
1179
Sanjay Patel4ac6b112015-09-21 22:47:23 +00001180/// Try to combine CI into a call to the llvm.uadd.with.overflow intrinsic if
1181/// possible.
Sanjoy Dasb6c59142015-04-10 21:07:09 +00001182///
1183/// Return true if any changes were made.
1184static bool CombineUAddWithOverflow(CmpInst *CI) {
1185 Value *A, *B;
1186 Instruction *AddI;
1187 if (!match(CI,
1188 m_UAddWithOverflow(m_Value(A), m_Value(B), m_Instruction(AddI))))
1189 return false;
1190
1191 Type *Ty = AddI->getType();
1192 if (!isa<IntegerType>(Ty))
1193 return false;
1194
1195 // We don't want to move around uses of condition values this late, so we we
1196 // check if it is legal to create the call to the intrinsic in the basic
1197 // block containing the icmp:
1198
1199 if (AddI->getParent() != CI->getParent() && !AddI->hasOneUse())
1200 return false;
1201
1202#ifndef NDEBUG
1203 // Someday m_UAddWithOverflow may get smarter, but this is a safe assumption
1204 // for now:
1205 if (AddI->hasOneUse())
1206 assert(*AddI->user_begin() == CI && "expected!");
1207#endif
1208
Sanjay Patelaf674fb2015-12-14 17:24:23 +00001209 Module *M = CI->getModule();
Sanjoy Dasb6c59142015-04-10 21:07:09 +00001210 Value *F = Intrinsic::getDeclaration(M, Intrinsic::uadd_with_overflow, Ty);
1211
1212 auto *InsertPt = AddI->hasOneUse() ? CI : AddI;
1213
1214 auto *UAddWithOverflow =
1215 CallInst::Create(F, {A, B}, "uadd.overflow", InsertPt);
1216 auto *UAdd = ExtractValueInst::Create(UAddWithOverflow, 0, "uadd", InsertPt);
1217 auto *Overflow =
1218 ExtractValueInst::Create(UAddWithOverflow, 1, "overflow", InsertPt);
1219
1220 CI->replaceAllUsesWith(Overflow);
1221 AddI->replaceAllUsesWith(UAdd);
1222 CI->eraseFromParent();
1223 AddI->eraseFromParent();
1224 return true;
1225}
1226
Sanjay Patel4ac6b112015-09-21 22:47:23 +00001227/// Sink the given CmpInst into user blocks to reduce the number of virtual
1228/// registers that must be created and coalesced. This is a clear win except on
1229/// targets with multiple condition code registers (PowerPC), where it might
1230/// lose; some adjustment may be wanted there.
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001231///
1232/// Return true if any changes are made.
Peter Zotov8efe38a2016-04-03 19:32:13 +00001233static bool SinkCmpExpression(CmpInst *CI, const TargetLowering *TLI) {
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001234 BasicBlock *DefBB = CI->getParent();
Eric Christopherc1ea1492008-09-24 05:32:41 +00001235
Peter Zotov0b6d7bc2016-04-03 16:36:17 +00001236 // Avoid sinking soft-FP comparisons, since this can move them into a loop.
Peter Zotov8efe38a2016-04-03 19:32:13 +00001237 if (TLI && TLI->useSoftFloat() && isa<FCmpInst>(CI))
Peter Zotov0b6d7bc2016-04-03 16:36:17 +00001238 return false;
1239
1240 // Only insert a cmp in each block once.
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001241 DenseMap<BasicBlock*, CmpInst*> InsertedCmps;
Eric Christopherc1ea1492008-09-24 05:32:41 +00001242
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001243 bool MadeChange = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +00001244 for (Value::user_iterator UI = CI->user_begin(), E = CI->user_end();
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001245 UI != E; ) {
1246 Use &TheUse = UI.getUse();
1247 Instruction *User = cast<Instruction>(*UI);
Eric Christopherc1ea1492008-09-24 05:32:41 +00001248
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001249 // Preincrement use iterator so we don't invalidate it.
1250 ++UI;
Eric Christopherc1ea1492008-09-24 05:32:41 +00001251
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001252 // Don't bother for PHI nodes.
1253 if (isa<PHINode>(User))
1254 continue;
1255
1256 // Figure out which BB this cmp is used in.
1257 BasicBlock *UserBB = User->getParent();
Eric Christopherc1ea1492008-09-24 05:32:41 +00001258
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001259 // If this user is in the same block as the cmp, don't change the cmp.
1260 if (UserBB == DefBB) continue;
Eric Christopherc1ea1492008-09-24 05:32:41 +00001261
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001262 // If we have already inserted a cmp into this block, use it.
1263 CmpInst *&InsertedCmp = InsertedCmps[UserBB];
1264
1265 if (!InsertedCmp) {
Bill Wendling8ddfc092011-08-16 20:45:24 +00001266 BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001267 assert(InsertPt != UserBB->end());
Eric Christopherc1ea1492008-09-24 05:32:41 +00001268 InsertedCmp =
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001269 CmpInst::Create(CI->getOpcode(), CI->getPredicate(),
1270 CI->getOperand(0), CI->getOperand(1), "", &*InsertPt);
Wolfgang Piebe51bede2016-10-06 21:43:45 +00001271 // Propagate the debug info.
1272 InsertedCmp->setDebugLoc(CI->getDebugLoc());
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001273 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00001274
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001275 // Replace a use of the cmp with a use of the new cmp.
1276 TheUse = InsertedCmp;
Benjamin Kramerb4bf14c2015-04-10 22:25:36 +00001277 MadeChange = true;
Cameron Zwarichced753f2011-01-05 17:27:27 +00001278 ++NumCmpUses;
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001279 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00001280
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001281 // If we removed all uses, nuke the cmp.
Benjamin Kramerb4bf14c2015-04-10 22:25:36 +00001282 if (CI->use_empty()) {
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001283 CI->eraseFromParent();
Benjamin Kramerb4bf14c2015-04-10 22:25:36 +00001284 MadeChange = true;
1285 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00001286
Dale Johannesenedfec0b2007-06-12 16:50:17 +00001287 return MadeChange;
1288}
1289
Peter Zotovf87e5502016-04-03 17:11:53 +00001290static bool OptimizeCmpExpression(CmpInst *CI, const TargetLowering *TLI) {
Peter Zotov8efe38a2016-04-03 19:32:13 +00001291 if (SinkCmpExpression(CI, TLI))
Sanjoy Dasb6c59142015-04-10 21:07:09 +00001292 return true;
1293
1294 if (CombineUAddWithOverflow(CI))
1295 return true;
1296
1297 return false;
1298}
1299
Geoff Berry5d534b62017-02-21 18:53:14 +00001300/// Duplicate and sink the given 'and' instruction into user blocks where it is
1301/// used in a compare to allow isel to generate better code for targets where
1302/// this operation can be combined.
1303///
1304/// Return true if any changes are made.
1305static bool sinkAndCmp0Expression(Instruction *AndI,
1306 const TargetLowering &TLI,
1307 SetOfInstrs &InsertedInsts) {
1308 // Double-check that we're not trying to optimize an instruction that was
1309 // already optimized by some other part of this pass.
1310 assert(!InsertedInsts.count(AndI) &&
1311 "Attempting to optimize already optimized and instruction");
1312 (void) InsertedInsts;
1313
1314 // Nothing to do for single use in same basic block.
1315 if (AndI->hasOneUse() &&
1316 AndI->getParent() == cast<Instruction>(*AndI->user_begin())->getParent())
1317 return false;
1318
1319 // Try to avoid cases where sinking/duplicating is likely to increase register
1320 // pressure.
1321 if (!isa<ConstantInt>(AndI->getOperand(0)) &&
1322 !isa<ConstantInt>(AndI->getOperand(1)) &&
1323 AndI->getOperand(0)->hasOneUse() && AndI->getOperand(1)->hasOneUse())
1324 return false;
1325
1326 for (auto *U : AndI->users()) {
1327 Instruction *User = cast<Instruction>(U);
1328
1329 // Only sink for and mask feeding icmp with 0.
1330 if (!isa<ICmpInst>(User))
1331 return false;
1332
1333 auto *CmpC = dyn_cast<ConstantInt>(User->getOperand(1));
1334 if (!CmpC || !CmpC->isZero())
1335 return false;
1336 }
1337
1338 if (!TLI.isMaskAndCmp0FoldingBeneficial(*AndI))
1339 return false;
1340
1341 DEBUG(dbgs() << "found 'and' feeding only icmp 0;\n");
1342 DEBUG(AndI->getParent()->dump());
1343
1344 // Push the 'and' into the same block as the icmp 0. There should only be
1345 // one (icmp (and, 0)) in each block, since CSE/GVN should have removed any
1346 // others, so we don't need to keep track of which BBs we insert into.
1347 for (Value::user_iterator UI = AndI->user_begin(), E = AndI->user_end();
1348 UI != E; ) {
1349 Use &TheUse = UI.getUse();
1350 Instruction *User = cast<Instruction>(*UI);
1351
1352 // Preincrement use iterator so we don't invalidate it.
1353 ++UI;
1354
1355 DEBUG(dbgs() << "sinking 'and' use: " << *User << "\n");
1356
1357 // Keep the 'and' in the same place if the use is already in the same block.
1358 Instruction *InsertPt =
1359 User->getParent() == AndI->getParent() ? AndI : User;
1360 Instruction *InsertedAnd =
1361 BinaryOperator::Create(Instruction::And, AndI->getOperand(0),
1362 AndI->getOperand(1), "", InsertPt);
1363 // Propagate the debug info.
1364 InsertedAnd->setDebugLoc(AndI->getDebugLoc());
1365
1366 // Replace a use of the 'and' with a use of the new 'and'.
1367 TheUse = InsertedAnd;
1368 ++NumAndUses;
1369 DEBUG(User->getParent()->dump());
1370 }
1371
1372 // We removed all uses, nuke the and.
1373 AndI->eraseFromParent();
1374 return true;
1375}
1376
Sanjay Patel4ac6b112015-09-21 22:47:23 +00001377/// Check if the candidates could be combined with a shift instruction, which
1378/// includes:
Yi Jiangd069f632014-04-21 19:34:27 +00001379/// 1. Truncate instruction
1380/// 2. And instruction and the imm is a mask of the low bits:
1381/// imm & (imm+1) == 0
Benjamin Kramer322053c2014-04-27 14:54:59 +00001382static bool isExtractBitsCandidateUse(Instruction *User) {
Yi Jiangd069f632014-04-21 19:34:27 +00001383 if (!isa<TruncInst>(User)) {
1384 if (User->getOpcode() != Instruction::And ||
1385 !isa<ConstantInt>(User->getOperand(1)))
1386 return false;
1387
Quentin Colombetd4f44692014-04-22 01:20:34 +00001388 const APInt &Cimm = cast<ConstantInt>(User->getOperand(1))->getValue();
Yi Jiangd069f632014-04-21 19:34:27 +00001389
Quentin Colombetd4f44692014-04-22 01:20:34 +00001390 if ((Cimm & (Cimm + 1)).getBoolValue())
Yi Jiangd069f632014-04-21 19:34:27 +00001391 return false;
1392 }
1393 return true;
1394}
1395
Sanjay Patel4ac6b112015-09-21 22:47:23 +00001396/// Sink both shift and truncate instruction to the use of truncate's BB.
Benjamin Kramer322053c2014-04-27 14:54:59 +00001397static bool
Yi Jiangd069f632014-04-21 19:34:27 +00001398SinkShiftAndTruncate(BinaryOperator *ShiftI, Instruction *User, ConstantInt *CI,
1399 DenseMap<BasicBlock *, BinaryOperator *> &InsertedShifts,
Mehdi Amini44ede332015-07-09 02:09:04 +00001400 const TargetLowering &TLI, const DataLayout &DL) {
Yi Jiangd069f632014-04-21 19:34:27 +00001401 BasicBlock *UserBB = User->getParent();
1402 DenseMap<BasicBlock *, CastInst *> InsertedTruncs;
1403 TruncInst *TruncI = dyn_cast<TruncInst>(User);
1404 bool MadeChange = false;
1405
1406 for (Value::user_iterator TruncUI = TruncI->user_begin(),
1407 TruncE = TruncI->user_end();
1408 TruncUI != TruncE;) {
1409
1410 Use &TruncTheUse = TruncUI.getUse();
1411 Instruction *TruncUser = cast<Instruction>(*TruncUI);
1412 // Preincrement use iterator so we don't invalidate it.
1413
1414 ++TruncUI;
1415
1416 int ISDOpcode = TLI.InstructionOpcodeToISD(TruncUser->getOpcode());
1417 if (!ISDOpcode)
1418 continue;
1419
Tim Northovere2239ff2014-07-29 10:20:22 +00001420 // If the use is actually a legal node, there will not be an
1421 // implicit truncate.
1422 // FIXME: always querying the result type is just an
1423 // approximation; some nodes' legality is determined by the
1424 // operand or other means. There's no good way to find out though.
Ahmed Bougacha0788d492014-11-12 22:16:55 +00001425 if (TLI.isOperationLegalOrCustom(
Mehdi Amini44ede332015-07-09 02:09:04 +00001426 ISDOpcode, TLI.getValueType(DL, TruncUser->getType(), true)))
Yi Jiangd069f632014-04-21 19:34:27 +00001427 continue;
1428
1429 // Don't bother for PHI nodes.
1430 if (isa<PHINode>(TruncUser))
1431 continue;
1432
1433 BasicBlock *TruncUserBB = TruncUser->getParent();
1434
1435 if (UserBB == TruncUserBB)
1436 continue;
1437
1438 BinaryOperator *&InsertedShift = InsertedShifts[TruncUserBB];
1439 CastInst *&InsertedTrunc = InsertedTruncs[TruncUserBB];
1440
1441 if (!InsertedShift && !InsertedTrunc) {
1442 BasicBlock::iterator InsertPt = TruncUserBB->getFirstInsertionPt();
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001443 assert(InsertPt != TruncUserBB->end());
Yi Jiangd069f632014-04-21 19:34:27 +00001444 // Sink the shift
1445 if (ShiftI->getOpcode() == Instruction::AShr)
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001446 InsertedShift = BinaryOperator::CreateAShr(ShiftI->getOperand(0), CI,
1447 "", &*InsertPt);
Yi Jiangd069f632014-04-21 19:34:27 +00001448 else
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001449 InsertedShift = BinaryOperator::CreateLShr(ShiftI->getOperand(0), CI,
1450 "", &*InsertPt);
Yi Jiangd069f632014-04-21 19:34:27 +00001451
1452 // Sink the trunc
1453 BasicBlock::iterator TruncInsertPt = TruncUserBB->getFirstInsertionPt();
1454 TruncInsertPt++;
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001455 assert(TruncInsertPt != TruncUserBB->end());
Yi Jiangd069f632014-04-21 19:34:27 +00001456
1457 InsertedTrunc = CastInst::Create(TruncI->getOpcode(), InsertedShift,
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001458 TruncI->getType(), "", &*TruncInsertPt);
Yi Jiangd069f632014-04-21 19:34:27 +00001459
1460 MadeChange = true;
1461
1462 TruncTheUse = InsertedTrunc;
1463 }
1464 }
1465 return MadeChange;
1466}
1467
Sanjay Patel4ac6b112015-09-21 22:47:23 +00001468/// Sink the shift *right* instruction into user blocks if the uses could
1469/// potentially be combined with this shift instruction and generate BitExtract
1470/// instruction. It will only be applied if the architecture supports BitExtract
1471/// instruction. Here is an example:
Yi Jiangd069f632014-04-21 19:34:27 +00001472/// BB1:
1473/// %x.extract.shift = lshr i64 %arg1, 32
1474/// BB2:
1475/// %x.extract.trunc = trunc i64 %x.extract.shift to i16
1476/// ==>
1477///
1478/// BB2:
1479/// %x.extract.shift.1 = lshr i64 %arg1, 32
1480/// %x.extract.trunc = trunc i64 %x.extract.shift.1 to i16
1481///
1482/// CodeGen will recoginze the pattern in BB2 and generate BitExtract
1483/// instruction.
1484/// Return true if any changes are made.
1485static bool OptimizeExtractBits(BinaryOperator *ShiftI, ConstantInt *CI,
Mehdi Amini44ede332015-07-09 02:09:04 +00001486 const TargetLowering &TLI,
1487 const DataLayout &DL) {
Yi Jiangd069f632014-04-21 19:34:27 +00001488 BasicBlock *DefBB = ShiftI->getParent();
1489
1490 /// Only insert instructions in each block once.
1491 DenseMap<BasicBlock *, BinaryOperator *> InsertedShifts;
1492
Mehdi Amini44ede332015-07-09 02:09:04 +00001493 bool shiftIsLegal = TLI.isTypeLegal(TLI.getValueType(DL, ShiftI->getType()));
Yi Jiangd069f632014-04-21 19:34:27 +00001494
1495 bool MadeChange = false;
1496 for (Value::user_iterator UI = ShiftI->user_begin(), E = ShiftI->user_end();
1497 UI != E;) {
1498 Use &TheUse = UI.getUse();
1499 Instruction *User = cast<Instruction>(*UI);
1500 // Preincrement use iterator so we don't invalidate it.
1501 ++UI;
1502
1503 // Don't bother for PHI nodes.
1504 if (isa<PHINode>(User))
1505 continue;
1506
1507 if (!isExtractBitsCandidateUse(User))
1508 continue;
1509
1510 BasicBlock *UserBB = User->getParent();
1511
1512 if (UserBB == DefBB) {
1513 // If the shift and truncate instruction are in the same BB. The use of
1514 // the truncate(TruncUse) may still introduce another truncate if not
1515 // legal. In this case, we would like to sink both shift and truncate
1516 // instruction to the BB of TruncUse.
1517 // for example:
1518 // BB1:
1519 // i64 shift.result = lshr i64 opnd, imm
1520 // trunc.result = trunc shift.result to i16
1521 //
1522 // BB2:
1523 // ----> We will have an implicit truncate here if the architecture does
1524 // not have i16 compare.
1525 // cmp i16 trunc.result, opnd2
1526 //
1527 if (isa<TruncInst>(User) && shiftIsLegal
1528 // If the type of the truncate is legal, no trucate will be
1529 // introduced in other basic blocks.
Mehdi Amini44ede332015-07-09 02:09:04 +00001530 &&
1531 (!TLI.isTypeLegal(TLI.getValueType(DL, User->getType()))))
Yi Jiangd069f632014-04-21 19:34:27 +00001532 MadeChange =
Mehdi Amini44ede332015-07-09 02:09:04 +00001533 SinkShiftAndTruncate(ShiftI, User, CI, InsertedShifts, TLI, DL);
Yi Jiangd069f632014-04-21 19:34:27 +00001534
1535 continue;
1536 }
1537 // If we have already inserted a shift into this block, use it.
1538 BinaryOperator *&InsertedShift = InsertedShifts[UserBB];
1539
1540 if (!InsertedShift) {
1541 BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001542 assert(InsertPt != UserBB->end());
Yi Jiangd069f632014-04-21 19:34:27 +00001543
1544 if (ShiftI->getOpcode() == Instruction::AShr)
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001545 InsertedShift = BinaryOperator::CreateAShr(ShiftI->getOperand(0), CI,
1546 "", &*InsertPt);
Yi Jiangd069f632014-04-21 19:34:27 +00001547 else
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00001548 InsertedShift = BinaryOperator::CreateLShr(ShiftI->getOperand(0), CI,
1549 "", &*InsertPt);
Yi Jiangd069f632014-04-21 19:34:27 +00001550
1551 MadeChange = true;
1552 }
1553
1554 // Replace a use of the shift with a use of the new shift.
1555 TheUse = InsertedShift;
1556 }
1557
1558 // If we removed all uses, nuke the shift.
1559 if (ShiftI->use_empty())
1560 ShiftI->eraseFromParent();
1561
1562 return MadeChange;
1563}
1564
Sanjay Patel4699b8a2015-11-19 16:37:10 +00001565/// If counting leading or trailing zeros is an expensive operation and a zero
1566/// input is defined, add a check for zero to avoid calling the intrinsic.
1567///
1568/// We want to transform:
1569/// %z = call i64 @llvm.cttz.i64(i64 %A, i1 false)
1570///
1571/// into:
1572/// entry:
1573/// %cmpz = icmp eq i64 %A, 0
1574/// br i1 %cmpz, label %cond.end, label %cond.false
1575/// cond.false:
1576/// %z = call i64 @llvm.cttz.i64(i64 %A, i1 true)
1577/// br label %cond.end
1578/// cond.end:
1579/// %ctz = phi i64 [ 64, %entry ], [ %z, %cond.false ]
1580///
1581/// If the transform is performed, return true and set ModifiedDT to true.
1582static bool despeculateCountZeros(IntrinsicInst *CountZeros,
1583 const TargetLowering *TLI,
1584 const DataLayout *DL,
1585 bool &ModifiedDT) {
1586 if (!TLI || !DL)
1587 return false;
1588
1589 // If a zero input is undefined, it doesn't make sense to despeculate that.
1590 if (match(CountZeros->getOperand(1), m_One()))
1591 return false;
1592
1593 // If it's cheap to speculate, there's nothing to do.
1594 auto IntrinsicID = CountZeros->getIntrinsicID();
1595 if ((IntrinsicID == Intrinsic::cttz && TLI->isCheapToSpeculateCttz()) ||
1596 (IntrinsicID == Intrinsic::ctlz && TLI->isCheapToSpeculateCtlz()))
1597 return false;
1598
1599 // Only handle legal scalar cases. Anything else requires too much work.
1600 Type *Ty = CountZeros->getType();
1601 unsigned SizeInBits = Ty->getPrimitiveSizeInBits();
Jun Bum Limbe11bdc2016-05-13 18:38:35 +00001602 if (Ty->isVectorTy() || SizeInBits > DL->getLargestLegalIntTypeSizeInBits())
Sanjay Patel4699b8a2015-11-19 16:37:10 +00001603 return false;
1604
1605 // The intrinsic will be sunk behind a compare against zero and branch.
1606 BasicBlock *StartBlock = CountZeros->getParent();
1607 BasicBlock *CallBlock = StartBlock->splitBasicBlock(CountZeros, "cond.false");
1608
1609 // Create another block after the count zero intrinsic. A PHI will be added
1610 // in this block to select the result of the intrinsic or the bit-width
1611 // constant if the input to the intrinsic is zero.
1612 BasicBlock::iterator SplitPt = ++(BasicBlock::iterator(CountZeros));
1613 BasicBlock *EndBlock = CallBlock->splitBasicBlock(SplitPt, "cond.end");
1614
1615 // Set up a builder to create a compare, conditional branch, and PHI.
1616 IRBuilder<> Builder(CountZeros->getContext());
1617 Builder.SetInsertPoint(StartBlock->getTerminator());
1618 Builder.SetCurrentDebugLocation(CountZeros->getDebugLoc());
1619
1620 // Replace the unconditional branch that was created by the first split with
1621 // a compare against zero and a conditional branch.
1622 Value *Zero = Constant::getNullValue(Ty);
1623 Value *Cmp = Builder.CreateICmpEQ(CountZeros->getOperand(0), Zero, "cmpz");
1624 Builder.CreateCondBr(Cmp, EndBlock, CallBlock);
1625 StartBlock->getTerminator()->eraseFromParent();
1626
1627 // Create a PHI in the end block to select either the output of the intrinsic
1628 // or the bit width of the operand.
1629 Builder.SetInsertPoint(&EndBlock->front());
1630 PHINode *PN = Builder.CreatePHI(Ty, 2, "ctz");
1631 CountZeros->replaceAllUsesWith(PN);
1632 Value *BitWidth = Builder.getInt(APInt(SizeInBits, SizeInBits));
1633 PN->addIncoming(BitWidth, StartBlock);
1634 PN->addIncoming(CountZeros, CallBlock);
1635
1636 // We are explicitly handling the zero case, so we can set the intrinsic's
1637 // undefined zero argument to 'true'. This will also prevent reprocessing the
1638 // intrinsic; we only despeculate when a zero input is defined.
1639 CountZeros->setArgOperand(1, Builder.getTrue());
1640 ModifiedDT = true;
1641 return true;
1642}
1643
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001644// This class provides helper functions to expand a memcmp library call into an
1645// inline expansion.
1646class MemCmpExpansion {
1647 struct ResultBlock {
1648 BasicBlock *BB;
1649 PHINode *PhiSrc1;
1650 PHINode *PhiSrc2;
1651 ResultBlock();
1652 };
1653
1654 CallInst *CI;
1655 ResultBlock ResBlock;
1656 unsigned MaxLoadSize;
1657 unsigned NumBlocks;
1658 unsigned NumBlocksNonOneByte;
1659 unsigned NumLoadsPerBlock;
1660 std::vector<BasicBlock *> LoadCmpBlocks;
1661 BasicBlock *EndBlock;
1662 PHINode *PhiRes;
1663 bool IsUsedForZeroCmp;
Sanjay Patel2843cad2017-06-09 23:01:05 +00001664 const DataLayout &DL;
1665
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001666 int calculateNumBlocks(unsigned Size);
1667 void createLoadCmpBlocks();
1668 void createResultBlock();
1669 void setupResultBlockPHINodes();
1670 void setupEndBlockPHINodes();
Sanjay Patel2843cad2017-06-09 23:01:05 +00001671 void emitLoadCompareBlock(unsigned Index, int LoadSize, int GEPIndex);
Sanjay Patel60070002017-06-07 13:33:00 +00001672 Value *getCompareLoadPairs(unsigned Index, unsigned Size,
1673 unsigned &NumBytesProcessed, IRBuilder<> &Builder);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001674 void emitLoadCompareBlockMultipleLoads(unsigned Index, unsigned Size,
1675 unsigned &NumBytesProcessed);
1676 void emitLoadCompareByteBlock(unsigned Index, int GEPIndex);
Sanjay Patel2843cad2017-06-09 23:01:05 +00001677 void emitMemCmpResultBlock();
1678 Value *getMemCmpExpansionZeroCase(unsigned Size);
Sanjay Patele7c50412017-06-08 16:53:18 +00001679 Value *getMemCmpEqZeroOneBlock(unsigned Size);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001680 unsigned getLoadSize(unsigned Size);
1681 unsigned getNumLoads(unsigned Size);
1682
1683public:
Sanjay Patelcf531ca2017-06-07 15:05:13 +00001684 MemCmpExpansion(CallInst *CI, uint64_t Size, unsigned MaxLoadSize,
Sanjay Patel2843cad2017-06-09 23:01:05 +00001685 unsigned NumLoadsPerBlock, const DataLayout &DL);
1686 Value *getMemCmpExpansion(uint64_t Size);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001687};
1688
1689MemCmpExpansion::ResultBlock::ResultBlock()
1690 : BB(nullptr), PhiSrc1(nullptr), PhiSrc2(nullptr) {}
1691
1692// Initialize the basic block structure required for expansion of memcmp call
1693// with given maximum load size and memcmp size parameter.
1694// This structure includes:
1695// 1. A list of load compare blocks - LoadCmpBlocks.
1696// 2. An EndBlock, split from original instruction point, which is the block to
1697// return from.
1698// 3. ResultBlock, block to branch to for early exit when a
1699// LoadCmpBlock finds a difference.
Sanjay Patelcf531ca2017-06-07 15:05:13 +00001700MemCmpExpansion::MemCmpExpansion(CallInst *CI, uint64_t Size,
Sanjay Patel2843cad2017-06-09 23:01:05 +00001701 unsigned MaxLoadSize, unsigned LoadsPerBlock,
1702 const DataLayout &TheDataLayout)
1703 : CI(CI), MaxLoadSize(MaxLoadSize), NumLoadsPerBlock(LoadsPerBlock),
1704 DL(TheDataLayout) {
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001705
Sanjay Patele7c50412017-06-08 16:53:18 +00001706 // A memcmp with zero-comparison with only one block of load and compare does
1707 // not need to set up any extra blocks. This case could be handled in the DAG,
1708 // but since we have all of the machinery to flexibly expand any memcpy here,
1709 // we choose to handle this case too to avoid fragmented lowering.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001710 IsUsedForZeroCmp = isOnlyUsedInZeroEqualityComparison(CI);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001711 NumBlocks = calculateNumBlocks(Size);
Sanjay Patele7c50412017-06-08 16:53:18 +00001712 if (!IsUsedForZeroCmp || NumBlocks != 1) {
1713 BasicBlock *StartBlock = CI->getParent();
1714 EndBlock = StartBlock->splitBasicBlock(CI, "endblock");
1715 setupEndBlockPHINodes();
1716 createResultBlock();
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001717
Sanjay Patele7c50412017-06-08 16:53:18 +00001718 // If return value of memcmp is not used in a zero equality, we need to
1719 // calculate which source was larger. The calculation requires the
1720 // two loaded source values of each load compare block.
1721 // These will be saved in the phi nodes created by setupResultBlockPHINodes.
1722 if (!IsUsedForZeroCmp)
1723 setupResultBlockPHINodes();
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001724
Sanjay Patele7c50412017-06-08 16:53:18 +00001725 // Create the number of required load compare basic blocks.
1726 createLoadCmpBlocks();
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001727
Sanjay Patele7c50412017-06-08 16:53:18 +00001728 // Update the terminator added by splitBasicBlock to branch to the first
1729 // LoadCmpBlock.
1730 StartBlock->getTerminator()->setSuccessor(0, LoadCmpBlocks[0]);
1731 }
1732
1733 IRBuilder<> Builder(CI->getContext());
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001734 Builder.SetCurrentDebugLocation(CI->getDebugLoc());
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001735}
1736
1737void MemCmpExpansion::createLoadCmpBlocks() {
1738 for (unsigned i = 0; i < NumBlocks; i++) {
1739 BasicBlock *BB = BasicBlock::Create(CI->getContext(), "loadbb",
1740 EndBlock->getParent(), EndBlock);
1741 LoadCmpBlocks.push_back(BB);
1742 }
1743}
1744
1745void MemCmpExpansion::createResultBlock() {
1746 ResBlock.BB = BasicBlock::Create(CI->getContext(), "res_block",
1747 EndBlock->getParent(), EndBlock);
1748}
1749
1750// This function creates the IR instructions for loading and comparing 1 byte.
Sanjay Patelab0ecc02017-06-07 12:44:36 +00001751// It loads 1 byte from each source of the memcmp parameters with the given
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001752// GEPIndex. It then subtracts the two loaded values and adds this result to the
1753// final phi node for selecting the memcmp result.
1754void MemCmpExpansion::emitLoadCompareByteBlock(unsigned Index, int GEPIndex) {
1755 IRBuilder<> Builder(CI->getContext());
1756
1757 Value *Source1 = CI->getArgOperand(0);
1758 Value *Source2 = CI->getArgOperand(1);
1759
1760 Builder.SetInsertPoint(LoadCmpBlocks[Index]);
1761 Type *LoadSizeType = Type::getInt8Ty(CI->getContext());
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001762 // Cast source to LoadSizeType*.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001763 if (Source1->getType() != LoadSizeType)
1764 Source1 = Builder.CreateBitCast(Source1, LoadSizeType->getPointerTo());
1765 if (Source2->getType() != LoadSizeType)
1766 Source2 = Builder.CreateBitCast(Source2, LoadSizeType->getPointerTo());
1767
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001768 // Get the base address using the GEPIndex.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001769 if (GEPIndex != 0) {
1770 Source1 = Builder.CreateGEP(LoadSizeType, Source1,
1771 ConstantInt::get(LoadSizeType, GEPIndex));
1772 Source2 = Builder.CreateGEP(LoadSizeType, Source2,
1773 ConstantInt::get(LoadSizeType, GEPIndex));
1774 }
1775
1776 Value *LoadSrc1 = Builder.CreateLoad(LoadSizeType, Source1);
1777 Value *LoadSrc2 = Builder.CreateLoad(LoadSizeType, Source2);
1778
1779 LoadSrc1 = Builder.CreateZExt(LoadSrc1, Type::getInt32Ty(CI->getContext()));
1780 LoadSrc2 = Builder.CreateZExt(LoadSrc2, Type::getInt32Ty(CI->getContext()));
1781 Value *Diff = Builder.CreateSub(LoadSrc1, LoadSrc2);
1782
1783 PhiRes->addIncoming(Diff, LoadCmpBlocks[Index]);
1784
1785 if (Index < (LoadCmpBlocks.size() - 1)) {
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001786 // Early exit branch if difference found to EndBlock. Otherwise, continue to
1787 // next LoadCmpBlock,
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001788 Value *Cmp = Builder.CreateICmp(ICmpInst::ICMP_NE, Diff,
1789 ConstantInt::get(Diff->getType(), 0));
1790 BranchInst *CmpBr =
1791 BranchInst::Create(EndBlock, LoadCmpBlocks[Index + 1], Cmp);
1792 Builder.Insert(CmpBr);
1793 } else {
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001794 // The last block has an unconditional branch to EndBlock.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001795 BranchInst *CmpBr = BranchInst::Create(EndBlock);
1796 Builder.Insert(CmpBr);
1797 }
1798}
1799
1800unsigned MemCmpExpansion::getNumLoads(unsigned Size) {
1801 return (Size / MaxLoadSize) + countPopulation(Size % MaxLoadSize);
1802}
1803
1804unsigned MemCmpExpansion::getLoadSize(unsigned Size) {
1805 return MinAlign(PowerOf2Floor(Size), MaxLoadSize);
1806}
1807
Sanjay Patel60070002017-06-07 13:33:00 +00001808/// Generate an equality comparison for one or more pairs of loaded values.
1809/// This is used in the case where the memcmp() call is compared equal or not
1810/// equal to zero.
1811Value *MemCmpExpansion::getCompareLoadPairs(unsigned Index, unsigned Size,
1812 unsigned &NumBytesProcessed,
1813 IRBuilder<> &Builder) {
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001814 std::vector<Value *> XorList, OrList;
1815 Value *Diff;
1816
1817 unsigned RemainingBytes = Size - NumBytesProcessed;
1818 unsigned NumLoadsRemaining = getNumLoads(RemainingBytes);
1819 unsigned NumLoads = std::min(NumLoadsRemaining, NumLoadsPerBlock);
1820
Sanjay Patele7c50412017-06-08 16:53:18 +00001821 // For a single-block expansion, start inserting before the memcmp call.
1822 if (LoadCmpBlocks.empty())
1823 Builder.SetInsertPoint(CI);
1824 else
1825 Builder.SetInsertPoint(LoadCmpBlocks[Index]);
1826
Sanjay Patelf57015d2017-06-07 00:17:08 +00001827 Value *Cmp = nullptr;
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001828 for (unsigned i = 0; i < NumLoads; ++i) {
1829 unsigned LoadSize = getLoadSize(RemainingBytes);
1830 unsigned GEPIndex = NumBytesProcessed / LoadSize;
1831 NumBytesProcessed += LoadSize;
1832 RemainingBytes -= LoadSize;
1833
1834 Type *LoadSizeType = IntegerType::get(CI->getContext(), LoadSize * 8);
1835 Type *MaxLoadType = IntegerType::get(CI->getContext(), MaxLoadSize * 8);
1836
1837 Value *Source1 = CI->getArgOperand(0);
1838 Value *Source2 = CI->getArgOperand(1);
1839
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001840 // Cast source to LoadSizeType*.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001841 if (Source1->getType() != LoadSizeType)
1842 Source1 = Builder.CreateBitCast(Source1, LoadSizeType->getPointerTo());
1843 if (Source2->getType() != LoadSizeType)
1844 Source2 = Builder.CreateBitCast(Source2, LoadSizeType->getPointerTo());
1845
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001846 // Get the base address using the GEPIndex.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001847 if (GEPIndex != 0) {
1848 Source1 = Builder.CreateGEP(LoadSizeType, Source1,
1849 ConstantInt::get(LoadSizeType, GEPIndex));
1850 Source2 = Builder.CreateGEP(LoadSizeType, Source2,
1851 ConstantInt::get(LoadSizeType, GEPIndex));
1852 }
1853
Sanjay Patela351a612017-06-19 19:48:35 +00001854 // Get a constant or load a value for each source address.
1855 Value *LoadSrc1 = nullptr;
1856 if (auto *Source1C = dyn_cast<Constant>(Source1))
1857 LoadSrc1 = ConstantFoldLoadFromConstPtr(Source1C, LoadSizeType, DL);
1858 if (!LoadSrc1)
1859 LoadSrc1 = Builder.CreateLoad(LoadSizeType, Source1);
1860
1861 Value *LoadSrc2 = nullptr;
1862 if (auto *Source2C = dyn_cast<Constant>(Source2))
1863 LoadSrc2 = ConstantFoldLoadFromConstPtr(Source2C, LoadSizeType, DL);
1864 if (!LoadSrc2)
1865 LoadSrc2 = Builder.CreateLoad(LoadSizeType, Source2);
1866
Sanjay Patelf57015d2017-06-07 00:17:08 +00001867 if (NumLoads != 1) {
Sanjay Patel8ce1e3b2017-06-07 16:16:45 +00001868 if (LoadSizeType != MaxLoadType) {
1869 LoadSrc1 = Builder.CreateZExtOrTrunc(LoadSrc1, MaxLoadType);
1870 LoadSrc2 = Builder.CreateZExtOrTrunc(LoadSrc2, MaxLoadType);
1871 }
Sanjay Patelf57015d2017-06-07 00:17:08 +00001872 // If we have multiple loads per block, we need to generate a composite
1873 // comparison using xor+or.
1874 Diff = Builder.CreateXor(LoadSrc1, LoadSrc2);
1875 Diff = Builder.CreateZExtOrTrunc(Diff, MaxLoadType);
1876 XorList.push_back(Diff);
1877 } else {
1878 // If there's only one load per block, we just compare the loaded values.
1879 Cmp = Builder.CreateICmpNE(LoadSrc1, LoadSrc2);
1880 }
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001881 }
1882
1883 auto pairWiseOr = [&](std::vector<Value *> &InList) -> std::vector<Value *> {
1884 std::vector<Value *> OutList;
1885 for (unsigned i = 0; i < InList.size() - 1; i = i + 2) {
1886 Value *Or = Builder.CreateOr(InList[i], InList[i + 1]);
1887 OutList.push_back(Or);
1888 }
1889 if (InList.size() % 2 != 0)
1890 OutList.push_back(InList.back());
1891 return OutList;
1892 };
1893
Sanjay Patelf57015d2017-06-07 00:17:08 +00001894 if (!Cmp) {
1895 // Pairwise OR the XOR results.
1896 OrList = pairWiseOr(XorList);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001897
Sanjay Patelf57015d2017-06-07 00:17:08 +00001898 // Pairwise OR the OR results until one result left.
1899 while (OrList.size() != 1) {
1900 OrList = pairWiseOr(OrList);
1901 }
1902 Cmp = Builder.CreateICmpNE(OrList[0], ConstantInt::get(Diff->getType(), 0));
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001903 }
1904
Sanjay Patel60070002017-06-07 13:33:00 +00001905 return Cmp;
1906}
1907
1908void MemCmpExpansion::emitLoadCompareBlockMultipleLoads(
1909 unsigned Index, unsigned Size, unsigned &NumBytesProcessed) {
1910 IRBuilder<> Builder(CI->getContext());
1911 Value *Cmp = getCompareLoadPairs(Index, Size, NumBytesProcessed, Builder);
1912
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001913 BasicBlock *NextBB = (Index == (LoadCmpBlocks.size() - 1))
1914 ? EndBlock
1915 : LoadCmpBlocks[Index + 1];
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001916 // Early exit branch if difference found to ResultBlock. Otherwise,
1917 // continue to next LoadCmpBlock or EndBlock.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001918 BranchInst *CmpBr = BranchInst::Create(ResBlock.BB, NextBB, Cmp);
1919 Builder.Insert(CmpBr);
1920
1921 // Add a phi edge for the last LoadCmpBlock to Endblock with a value of 0
1922 // since early exit to ResultBlock was not taken (no difference was found in
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001923 // any of the bytes).
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001924 if (Index == LoadCmpBlocks.size() - 1) {
1925 Value *Zero = ConstantInt::get(Type::getInt32Ty(CI->getContext()), 0);
1926 PhiRes->addIncoming(Zero, LoadCmpBlocks[Index]);
1927 }
1928}
1929
1930// This function creates the IR intructions for loading and comparing using the
1931// given LoadSize. It loads the number of bytes specified by LoadSize from each
1932// source of the memcmp parameters. It then does a subtract to see if there was
1933// a difference in the loaded values. If a difference is found, it branches
1934// with an early exit to the ResultBlock for calculating which source was
1935// larger. Otherwise, it falls through to the either the next LoadCmpBlock or
1936// the EndBlock if this is the last LoadCmpBlock. Loading 1 byte is handled with
1937// a special case through emitLoadCompareByteBlock. The special handling can
1938// simply subtract the loaded values and add it to the result phi node.
1939void MemCmpExpansion::emitLoadCompareBlock(unsigned Index, int LoadSize,
Sanjay Patel2843cad2017-06-09 23:01:05 +00001940 int GEPIndex) {
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001941 if (LoadSize == 1) {
1942 MemCmpExpansion::emitLoadCompareByteBlock(Index, GEPIndex);
1943 return;
1944 }
1945
1946 IRBuilder<> Builder(CI->getContext());
1947
1948 Type *LoadSizeType = IntegerType::get(CI->getContext(), LoadSize * 8);
1949 Type *MaxLoadType = IntegerType::get(CI->getContext(), MaxLoadSize * 8);
1950
1951 Value *Source1 = CI->getArgOperand(0);
1952 Value *Source2 = CI->getArgOperand(1);
1953
1954 Builder.SetInsertPoint(LoadCmpBlocks[Index]);
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001955 // Cast source to LoadSizeType*.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001956 if (Source1->getType() != LoadSizeType)
1957 Source1 = Builder.CreateBitCast(Source1, LoadSizeType->getPointerTo());
1958 if (Source2->getType() != LoadSizeType)
1959 Source2 = Builder.CreateBitCast(Source2, LoadSizeType->getPointerTo());
1960
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001961 // Get the base address using the GEPIndex.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001962 if (GEPIndex != 0) {
1963 Source1 = Builder.CreateGEP(LoadSizeType, Source1,
1964 ConstantInt::get(LoadSizeType, GEPIndex));
1965 Source2 = Builder.CreateGEP(LoadSizeType, Source2,
1966 ConstantInt::get(LoadSizeType, GEPIndex));
1967 }
1968
Sanjay Patelb4b7df92017-06-06 20:30:47 +00001969 // Load LoadSizeType from the base address.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001970 Value *LoadSrc1 = Builder.CreateLoad(LoadSizeType, Source1);
1971 Value *LoadSrc2 = Builder.CreateLoad(LoadSizeType, Source2);
1972
Sanjay Patel2843cad2017-06-09 23:01:05 +00001973 if (DL.isLittleEndian()) {
Zaara Syeda3a7578c2017-05-31 17:12:38 +00001974 Function *F = LoadCmpBlocks[Index]->getParent();
1975
1976 Function *Bswap = Intrinsic::getDeclaration(F->getParent(),
1977 Intrinsic::bswap, LoadSizeType);
1978 LoadSrc1 = Builder.CreateCall(Bswap, LoadSrc1);
1979 LoadSrc2 = Builder.CreateCall(Bswap, LoadSrc2);
1980 }
1981
1982 if (LoadSizeType != MaxLoadType) {
1983 LoadSrc1 = Builder.CreateZExtOrTrunc(LoadSrc1, MaxLoadType);
1984 LoadSrc2 = Builder.CreateZExtOrTrunc(LoadSrc2, MaxLoadType);
1985 }
1986
1987 // Add the loaded values to the phi nodes for calculating memcmp result only
1988 // if result is not used in a zero equality.
1989 if (!IsUsedForZeroCmp) {
1990 ResBlock.PhiSrc1->addIncoming(LoadSrc1, LoadCmpBlocks[Index]);
1991 ResBlock.PhiSrc2->addIncoming(LoadSrc2, LoadCmpBlocks[Index]);
1992 }
1993
1994 Value *Diff = Builder.CreateSub(LoadSrc1, LoadSrc2);
1995
1996 Value *Cmp = Builder.CreateICmp(ICmpInst::ICMP_NE, Diff,
1997 ConstantInt::get(Diff->getType(), 0));
1998 BasicBlock *NextBB = (Index == (LoadCmpBlocks.size() - 1))
1999 ? EndBlock
2000 : LoadCmpBlocks[Index + 1];
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002001 // Early exit branch if difference found to ResultBlock. Otherwise, continue
2002 // to next LoadCmpBlock or EndBlock.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002003 BranchInst *CmpBr = BranchInst::Create(ResBlock.BB, NextBB, Cmp);
2004 Builder.Insert(CmpBr);
2005
2006 // Add a phi edge for the last LoadCmpBlock to Endblock with a value of 0
2007 // since early exit to ResultBlock was not taken (no difference was found in
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002008 // any of the bytes).
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002009 if (Index == LoadCmpBlocks.size() - 1) {
2010 Value *Zero = ConstantInt::get(Type::getInt32Ty(CI->getContext()), 0);
2011 PhiRes->addIncoming(Zero, LoadCmpBlocks[Index]);
2012 }
2013}
2014
2015// This function populates the ResultBlock with a sequence to calculate the
2016// memcmp result. It compares the two loaded source values and returns -1 if
2017// src1 < src2 and 1 if src1 > src2.
Sanjay Patel2843cad2017-06-09 23:01:05 +00002018void MemCmpExpansion::emitMemCmpResultBlock() {
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002019 IRBuilder<> Builder(CI->getContext());
2020
2021 // Special case: if memcmp result is used in a zero equality, result does not
2022 // need to be calculated and can simply return 1.
2023 if (IsUsedForZeroCmp) {
2024 BasicBlock::iterator InsertPt = ResBlock.BB->getFirstInsertionPt();
2025 Builder.SetInsertPoint(ResBlock.BB, InsertPt);
2026 Value *Res = ConstantInt::get(Type::getInt32Ty(CI->getContext()), 1);
2027 PhiRes->addIncoming(Res, ResBlock.BB);
2028 BranchInst *NewBr = BranchInst::Create(EndBlock);
2029 Builder.Insert(NewBr);
2030 return;
2031 }
2032 BasicBlock::iterator InsertPt = ResBlock.BB->getFirstInsertionPt();
2033 Builder.SetInsertPoint(ResBlock.BB, InsertPt);
2034
2035 Value *Cmp = Builder.CreateICmp(ICmpInst::ICMP_ULT, ResBlock.PhiSrc1,
2036 ResBlock.PhiSrc2);
2037
2038 Value *Res =
2039 Builder.CreateSelect(Cmp, ConstantInt::get(Builder.getInt32Ty(), -1),
2040 ConstantInt::get(Builder.getInt32Ty(), 1));
2041
2042 BranchInst *NewBr = BranchInst::Create(EndBlock);
2043 Builder.Insert(NewBr);
2044 PhiRes->addIncoming(Res, ResBlock.BB);
2045}
2046
2047int MemCmpExpansion::calculateNumBlocks(unsigned Size) {
2048 int NumBlocks = 0;
Sanjay Patelab0ecc02017-06-07 12:44:36 +00002049 bool HaveOneByteLoad = false;
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002050 unsigned RemainingSize = Size;
2051 unsigned LoadSize = MaxLoadSize;
2052 while (RemainingSize) {
2053 if (LoadSize == 1)
Sanjay Patelab0ecc02017-06-07 12:44:36 +00002054 HaveOneByteLoad = true;
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002055 NumBlocks += RemainingSize / LoadSize;
2056 RemainingSize = RemainingSize % LoadSize;
2057 LoadSize = LoadSize / 2;
2058 }
Sanjay Patelab0ecc02017-06-07 12:44:36 +00002059 NumBlocksNonOneByte = HaveOneByteLoad ? (NumBlocks - 1) : NumBlocks;
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002060
2061 if (IsUsedForZeroCmp)
2062 NumBlocks = NumBlocks / NumLoadsPerBlock +
2063 (NumBlocks % NumLoadsPerBlock != 0 ? 1 : 0);
2064
2065 return NumBlocks;
2066}
2067
2068void MemCmpExpansion::setupResultBlockPHINodes() {
2069 IRBuilder<> Builder(CI->getContext());
2070 Type *MaxLoadType = IntegerType::get(CI->getContext(), MaxLoadSize * 8);
2071 Builder.SetInsertPoint(ResBlock.BB);
2072 ResBlock.PhiSrc1 =
2073 Builder.CreatePHI(MaxLoadType, NumBlocksNonOneByte, "phi.src1");
2074 ResBlock.PhiSrc2 =
2075 Builder.CreatePHI(MaxLoadType, NumBlocksNonOneByte, "phi.src2");
2076}
2077
2078void MemCmpExpansion::setupEndBlockPHINodes() {
2079 IRBuilder<> Builder(CI->getContext());
2080
2081 Builder.SetInsertPoint(&EndBlock->front());
2082 PhiRes = Builder.CreatePHI(Type::getInt32Ty(CI->getContext()), 2, "phi.res");
2083}
2084
Sanjay Patel2843cad2017-06-09 23:01:05 +00002085Value *MemCmpExpansion::getMemCmpExpansionZeroCase(unsigned Size) {
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002086 unsigned NumBytesProcessed = 0;
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002087 // This loop populates each of the LoadCmpBlocks with the IR sequence to
2088 // handle multiple loads per block.
Sanjay Patelab0ecc02017-06-07 12:44:36 +00002089 for (unsigned i = 0; i < NumBlocks; ++i)
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002090 emitLoadCompareBlockMultipleLoads(i, Size, NumBytesProcessed);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002091
Sanjay Patel2843cad2017-06-09 23:01:05 +00002092 emitMemCmpResultBlock();
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002093 return PhiRes;
2094}
2095
Sanjay Patele7c50412017-06-08 16:53:18 +00002096/// A memcmp expansion that compares equality with 0 and only has one block of
2097/// load and compare can bypass the compare, branch, and phi IR that is required
2098/// in the general case.
2099Value *MemCmpExpansion::getMemCmpEqZeroOneBlock(unsigned Size) {
2100 unsigned NumBytesProcessed = 0;
2101 IRBuilder<> Builder(CI->getContext());
2102 Value *Cmp = getCompareLoadPairs(0, Size, NumBytesProcessed, Builder);
2103 return Builder.CreateZExt(Cmp, Type::getInt32Ty(CI->getContext()));
2104}
2105
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002106// This function expands the memcmp call into an inline expansion and returns
2107// the memcmp result.
Sanjay Patel2843cad2017-06-09 23:01:05 +00002108Value *MemCmpExpansion::getMemCmpExpansion(uint64_t Size) {
Sanjay Patelab0ecc02017-06-07 12:44:36 +00002109 if (IsUsedForZeroCmp)
Sanjay Patele7c50412017-06-08 16:53:18 +00002110 return NumBlocks == 1 ? getMemCmpEqZeroOneBlock(Size) :
Sanjay Patel2843cad2017-06-09 23:01:05 +00002111 getMemCmpExpansionZeroCase(Size);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002112
Sanjay Patelaf515d92017-06-07 14:45:49 +00002113 // This loop calls emitLoadCompareBlock for comparing Size bytes of the two
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002114 // memcmp sources. It starts with loading using the maximum load size set by
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002115 // the target. It processes any remaining bytes using a load size which is the
2116 // next smallest power of 2.
Sanjay Patelaf515d92017-06-07 14:45:49 +00002117 int LoadSize = MaxLoadSize;
2118 int NumBytesToBeProcessed = Size;
2119 unsigned Index = 0;
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002120 while (NumBytesToBeProcessed) {
Sanjay Patelaf515d92017-06-07 14:45:49 +00002121 // Calculate how many blocks we can create with the current load size.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002122 int NumBlocks = NumBytesToBeProcessed / LoadSize;
2123 int GEPIndex = (Size - NumBytesToBeProcessed) / LoadSize;
2124 NumBytesToBeProcessed = NumBytesToBeProcessed % LoadSize;
2125
2126 // For each NumBlocks, populate the instruction sequence for loading and
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002127 // comparing LoadSize bytes.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002128 while (NumBlocks--) {
Sanjay Patel2843cad2017-06-09 23:01:05 +00002129 emitLoadCompareBlock(Index, LoadSize, GEPIndex);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002130 Index++;
2131 GEPIndex++;
2132 }
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002133 // Get the next LoadSize to use.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002134 LoadSize = LoadSize / 2;
2135 }
2136
Sanjay Patel2843cad2017-06-09 23:01:05 +00002137 emitMemCmpResultBlock();
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002138 return PhiRes;
2139}
2140
2141// This function checks to see if an expansion of memcmp can be generated.
2142// It checks for constant compare size that is less than the max inline size.
2143// If an expansion cannot occur, returns false to leave as a library call.
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002144// Otherwise, the library call is replaced with a new IR instruction sequence.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002145/// We want to transform:
2146/// %call = call signext i32 @memcmp(i8* %0, i8* %1, i64 15)
2147/// To:
2148/// loadbb:
2149/// %0 = bitcast i32* %buffer2 to i8*
2150/// %1 = bitcast i32* %buffer1 to i8*
2151/// %2 = bitcast i8* %1 to i64*
2152/// %3 = bitcast i8* %0 to i64*
2153/// %4 = load i64, i64* %2
2154/// %5 = load i64, i64* %3
2155/// %6 = call i64 @llvm.bswap.i64(i64 %4)
2156/// %7 = call i64 @llvm.bswap.i64(i64 %5)
2157/// %8 = sub i64 %6, %7
2158/// %9 = icmp ne i64 %8, 0
2159/// br i1 %9, label %res_block, label %loadbb1
2160/// res_block: ; preds = %loadbb2,
2161/// %loadbb1, %loadbb
2162/// %phi.src1 = phi i64 [ %6, %loadbb ], [ %22, %loadbb1 ], [ %36, %loadbb2 ]
2163/// %phi.src2 = phi i64 [ %7, %loadbb ], [ %23, %loadbb1 ], [ %37, %loadbb2 ]
2164/// %10 = icmp ult i64 %phi.src1, %phi.src2
2165/// %11 = select i1 %10, i32 -1, i32 1
2166/// br label %endblock
2167/// loadbb1: ; preds = %loadbb
2168/// %12 = bitcast i32* %buffer2 to i8*
2169/// %13 = bitcast i32* %buffer1 to i8*
2170/// %14 = bitcast i8* %13 to i32*
2171/// %15 = bitcast i8* %12 to i32*
2172/// %16 = getelementptr i32, i32* %14, i32 2
2173/// %17 = getelementptr i32, i32* %15, i32 2
2174/// %18 = load i32, i32* %16
2175/// %19 = load i32, i32* %17
2176/// %20 = call i32 @llvm.bswap.i32(i32 %18)
2177/// %21 = call i32 @llvm.bswap.i32(i32 %19)
2178/// %22 = zext i32 %20 to i64
2179/// %23 = zext i32 %21 to i64
2180/// %24 = sub i64 %22, %23
2181/// %25 = icmp ne i64 %24, 0
2182/// br i1 %25, label %res_block, label %loadbb2
2183/// loadbb2: ; preds = %loadbb1
2184/// %26 = bitcast i32* %buffer2 to i8*
2185/// %27 = bitcast i32* %buffer1 to i8*
2186/// %28 = bitcast i8* %27 to i16*
2187/// %29 = bitcast i8* %26 to i16*
2188/// %30 = getelementptr i16, i16* %28, i16 6
2189/// %31 = getelementptr i16, i16* %29, i16 6
2190/// %32 = load i16, i16* %30
2191/// %33 = load i16, i16* %31
2192/// %34 = call i16 @llvm.bswap.i16(i16 %32)
2193/// %35 = call i16 @llvm.bswap.i16(i16 %33)
2194/// %36 = zext i16 %34 to i64
2195/// %37 = zext i16 %35 to i64
2196/// %38 = sub i64 %36, %37
2197/// %39 = icmp ne i64 %38, 0
2198/// br i1 %39, label %res_block, label %loadbb3
2199/// loadbb3: ; preds = %loadbb2
2200/// %40 = bitcast i32* %buffer2 to i8*
2201/// %41 = bitcast i32* %buffer1 to i8*
2202/// %42 = getelementptr i8, i8* %41, i8 14
2203/// %43 = getelementptr i8, i8* %40, i8 14
2204/// %44 = load i8, i8* %42
2205/// %45 = load i8, i8* %43
2206/// %46 = zext i8 %44 to i32
2207/// %47 = zext i8 %45 to i32
2208/// %48 = sub i32 %46, %47
2209/// br label %endblock
2210/// endblock: ; preds = %res_block,
2211/// %loadbb3
2212/// %phi.res = phi i32 [ %48, %loadbb3 ], [ %11, %res_block ]
2213/// ret i32 %phi.res
2214static bool expandMemCmp(CallInst *CI, const TargetTransformInfo *TTI,
2215 const TargetLowering *TLI, const DataLayout *DL) {
2216 NumMemCmpCalls++;
2217 IRBuilder<> Builder(CI->getContext());
2218
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002219 // TTI call to check if target would like to expand memcmp. Also, get the
2220 // MaxLoadSize.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002221 unsigned MaxLoadSize;
2222 if (!TTI->expandMemCmp(CI, MaxLoadSize))
2223 return false;
2224
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002225 // Early exit from expansion if -Oz.
Sanjay Patel4137d512017-06-07 14:29:52 +00002226 if (CI->getFunction()->optForMinSize())
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002227 return false;
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002228
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002229 // Early exit from expansion if size is not a constant.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002230 ConstantInt *SizeCast = dyn_cast<ConstantInt>(CI->getArgOperand(2));
2231 if (!SizeCast) {
2232 NumMemCmpNotConstant++;
2233 return false;
2234 }
2235
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002236 // Early exit from expansion if size greater than max bytes to load.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002237 uint64_t SizeVal = SizeCast->getZExtValue();
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002238 unsigned NumLoads = 0;
2239 unsigned RemainingSize = SizeVal;
2240 unsigned LoadSize = MaxLoadSize;
2241 while (RemainingSize) {
2242 NumLoads += RemainingSize / LoadSize;
2243 RemainingSize = RemainingSize % LoadSize;
2244 LoadSize = LoadSize / 2;
2245 }
2246
Sanjay Patel4137d512017-06-07 14:29:52 +00002247 if (NumLoads > TLI->getMaxExpandSizeMemcmp(CI->getFunction()->optForSize())) {
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002248 NumMemCmpGreaterThanMax++;
2249 return false;
2250 }
2251
2252 NumMemCmpInlined++;
2253
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002254 // MemCmpHelper object creates and sets up basic blocks required for
2255 // expanding memcmp with size SizeVal.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002256 unsigned NumLoadsPerBlock = MemCmpNumLoadsPerBlock;
Sanjay Patel2843cad2017-06-09 23:01:05 +00002257 MemCmpExpansion MemCmpHelper(CI, SizeVal, MaxLoadSize, NumLoadsPerBlock, *DL);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002258
Sanjay Patel2843cad2017-06-09 23:01:05 +00002259 Value *Res = MemCmpHelper.getMemCmpExpansion(SizeVal);
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002260
Sanjay Patelb4b7df92017-06-06 20:30:47 +00002261 // Replace call with result of expansion and erase call.
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002262 CI->replaceAllUsesWith(Res);
2263 CI->eraseFromParent();
2264
2265 return true;
2266}
2267
Sanjay Patel3b8974b2017-06-08 20:00:09 +00002268bool CodeGenPrepare::optimizeCallInst(CallInst *CI, bool &ModifiedDT) {
Chris Lattner7a277142011-01-15 07:14:54 +00002269 BasicBlock *BB = CI->getParent();
Nadav Rotem465834c2012-07-24 10:51:42 +00002270
Chris Lattner7a277142011-01-15 07:14:54 +00002271 // Lower inline assembly if we can.
2272 // If we found an inline asm expession, and if the target knows how to
2273 // lower it to normal LLVM code, do so now.
2274 if (TLI && isa<InlineAsm>(CI->getCalledValue())) {
2275 if (TLI->ExpandInlineAsm(CI)) {
2276 // Avoid invalidating the iterator.
2277 CurInstIterator = BB->begin();
2278 // Avoid processing instructions out of order, which could cause
2279 // reuse before a value is defined.
2280 SunkAddrs.clear();
2281 return true;
2282 }
2283 // Sink address computing for memory operands into the block.
Sanjay Patelfc580a62015-09-21 23:03:16 +00002284 if (optimizeInlineAsmInst(CI))
Chris Lattner7a277142011-01-15 07:14:54 +00002285 return true;
2286 }
Nadav Rotem465834c2012-07-24 10:51:42 +00002287
John Brawn0dbcd652015-03-18 12:01:59 +00002288 // Align the pointer arguments to this call if the target thinks it's a good
2289 // idea
2290 unsigned MinSize, PrefAlign;
Mehdi Amini4fe37982015-07-07 18:45:17 +00002291 if (TLI && TLI->shouldAlignPointerArgs(CI, MinSize, PrefAlign)) {
John Brawn0dbcd652015-03-18 12:01:59 +00002292 for (auto &Arg : CI->arg_operands()) {
2293 // We want to align both objects whose address is used directly and
2294 // objects whose address is used in casts and GEPs, though it only makes
2295 // sense for GEPs if the offset is a multiple of the desired alignment and
2296 // if size - offset meets the size threshold.
2297 if (!Arg->getType()->isPointerTy())
2298 continue;
Mehdi Amini4fe37982015-07-07 18:45:17 +00002299 APInt Offset(DL->getPointerSizeInBits(
2300 cast<PointerType>(Arg->getType())->getAddressSpace()),
2301 0);
2302 Value *Val = Arg->stripAndAccumulateInBoundsConstantOffsets(*DL, Offset);
John Brawn0dbcd652015-03-18 12:01:59 +00002303 uint64_t Offset2 = Offset.getLimitedValue();
John Brawne8fd6c82015-04-13 10:47:39 +00002304 if ((Offset2 & (PrefAlign-1)) != 0)
2305 continue;
John Brawn0dbcd652015-03-18 12:01:59 +00002306 AllocaInst *AI;
Mehdi Amini4fe37982015-07-07 18:45:17 +00002307 if ((AI = dyn_cast<AllocaInst>(Val)) && AI->getAlignment() < PrefAlign &&
2308 DL->getTypeAllocSize(AI->getAllocatedType()) >= MinSize + Offset2)
John Brawn0dbcd652015-03-18 12:01:59 +00002309 AI->setAlignment(PrefAlign);
John Brawne8fd6c82015-04-13 10:47:39 +00002310 // Global variables can only be aligned if they are defined in this
2311 // object (i.e. they are uniquely initialized in this object), and
2312 // over-aligning global variables that have an explicit section is
2313 // forbidden.
2314 GlobalVariable *GV;
James Y Knightac03dca2016-01-15 16:33:06 +00002315 if ((GV = dyn_cast<GlobalVariable>(Val)) && GV->canIncreaseAlignment() &&
Tim Northover918f0502016-07-18 18:28:52 +00002316 GV->getPointerAlignment(*DL) < PrefAlign &&
Manuel Jacob5f6eaac2016-01-16 20:30:46 +00002317 DL->getTypeAllocSize(GV->getValueType()) >=
Mehdi Amini4fe37982015-07-07 18:45:17 +00002318 MinSize + Offset2)
John Brawne8fd6c82015-04-13 10:47:39 +00002319 GV->setAlignment(PrefAlign);
John Brawn0dbcd652015-03-18 12:01:59 +00002320 }
2321 // If this is a memcpy (or similar) then we may be able to improve the
2322 // alignment
2323 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(CI)) {
Mehdi Amini4fe37982015-07-07 18:45:17 +00002324 unsigned Align = getKnownAlignment(MI->getDest(), *DL);
John Brawn0dbcd652015-03-18 12:01:59 +00002325 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(MI))
Mehdi Amini4fe37982015-07-07 18:45:17 +00002326 Align = std::min(Align, getKnownAlignment(MTI->getSource(), *DL));
Pete Cooper67cf9a72015-11-19 05:56:52 +00002327 if (Align > MI->getAlignment())
2328 MI->setAlignment(ConstantInt::get(MI->getAlignmentType(), Align));
John Brawn0dbcd652015-03-18 12:01:59 +00002329 }
2330 }
2331
Philip Reamesac115ed2016-03-09 23:13:12 +00002332 // If we have a cold call site, try to sink addressing computation into the
2333 // cold block. This interacts with our handling for loads and stores to
2334 // ensure that we can fold all uses of a potential addressing computation
2335 // into their uses. TODO: generalize this to work over profiling data
2336 if (!OptSize && CI->hasFnAttr(Attribute::Cold))
2337 for (auto &Arg : CI->arg_operands()) {
2338 if (!Arg->getType()->isPointerTy())
2339 continue;
2340 unsigned AS = Arg->getType()->getPointerAddressSpace();
2341 return optimizeMemoryInst(CI, Arg, Arg->getType(), AS);
2342 }
Junmo Park6098cbb2016-03-11 07:05:32 +00002343
Eric Christopher4b7948e2010-03-11 02:41:03 +00002344 IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI);
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002345 if (II) {
2346 switch (II->getIntrinsicID()) {
2347 default: break;
2348 case Intrinsic::objectsize: {
2349 // Lower all uses of llvm.objectsize.*
George Burgess IV3f089142016-12-20 23:46:36 +00002350 ConstantInt *RetVal =
2351 lowerObjectSizeCall(II, *DL, TLInfo, /*MustSucceed=*/true);
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002352 // Substituting this can cause recursive simplifications, which can
Sanjoy Dase6bca0e2017-05-01 17:07:49 +00002353 // invalidate our iterator. Use a WeakTrackingVH to hold onto it in case
2354 // this
Sanjoy Das2cbeb002017-04-26 16:37:05 +00002355 // happens.
Duncan P. N. Exon Smith7b269642016-02-21 19:37:45 +00002356 Value *CurValue = &*CurInstIterator;
Sanjoy Dase6bca0e2017-05-01 17:07:49 +00002357 WeakTrackingVH IterHandle(CurValue);
Nadav Rotem465834c2012-07-24 10:51:42 +00002358
Sanjay Patel545a4562016-01-20 18:59:16 +00002359 replaceAndRecursivelySimplify(CI, RetVal, TLInfo, nullptr);
Chris Lattner1b93be52011-01-15 07:25:29 +00002360
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002361 // If the iterator instruction was recursively deleted, start over at the
2362 // start of the block.
Duncan P. N. Exon Smith7b269642016-02-21 19:37:45 +00002363 if (IterHandle != CurValue) {
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002364 CurInstIterator = BB->begin();
2365 SunkAddrs.clear();
2366 }
2367 return true;
Chris Lattner86d56c62011-01-18 20:53:04 +00002368 }
Ahmed Bougacha236f9042015-05-22 21:37:17 +00002369 case Intrinsic::aarch64_stlxr:
2370 case Intrinsic::aarch64_stxr: {
2371 ZExtInst *ExtVal = dyn_cast<ZExtInst>(CI->getArgOperand(0));
2372 if (!ExtVal || !ExtVal->hasOneUse() ||
2373 ExtVal->getParent() == CI->getParent())
2374 return false;
2375 // Sink a zext feeding stlxr/stxr before it, so it can be folded into it.
2376 ExtVal->moveBefore(CI);
Ahmed Bougachaf3299142015-06-17 20:44:32 +00002377 // Mark this instruction as "inserted by CGP", so that other
2378 // optimizations don't touch it.
2379 InsertedInsts.insert(ExtVal);
Ahmed Bougacha236f9042015-05-22 21:37:17 +00002380 return true;
2381 }
Piotr Padlewski6c15ec42015-09-15 18:32:14 +00002382 case Intrinsic::invariant_group_barrier:
2383 II->replaceAllUsesWith(II->getArgOperand(0));
2384 II->eraseFromParent();
2385 return true;
Sanjay Patel4699b8a2015-11-19 16:37:10 +00002386
2387 case Intrinsic::cttz:
2388 case Intrinsic::ctlz:
2389 // If counting zeros is expensive, try to avoid it.
2390 return despeculateCountZeros(II, TLI, DL, ModifiedDT);
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002391 }
Eric Christopher4b7948e2010-03-11 02:41:03 +00002392
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002393 if (TLI) {
2394 SmallVector<Value*, 2> PtrOps;
2395 Type *AccessTy;
Matt Arsenault1672b1b2017-02-08 07:09:03 +00002396 if (TLI->getAddrModeArguments(II, PtrOps, AccessTy))
2397 while (!PtrOps.empty()) {
2398 Value *PtrVal = PtrOps.pop_back_val();
2399 unsigned AS = PtrVal->getType()->getPointerAddressSpace();
2400 if (optimizeMemoryInst(II, PtrVal, AccessTy, AS))
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002401 return true;
Matt Arsenault1672b1b2017-02-08 07:09:03 +00002402 }
Elena Demikhovsky87700a72014-12-28 08:54:45 +00002403 }
Pete Cooper615fd892012-03-13 20:59:56 +00002404 }
2405
Eric Christopher4b7948e2010-03-11 02:41:03 +00002406 // From here on out we're working with named functions.
Craig Topperc0196b12014-04-14 00:51:57 +00002407 if (!CI->getCalledFunction()) return false;
Devang Patel0da52502011-05-26 21:51:06 +00002408
Benjamin Kramer7b88a492010-03-12 09:27:41 +00002409 // Lower all default uses of _chk calls. This is very similar
2410 // to what InstCombineCalls does, but here we are only lowering calls
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002411 // to fortified library functions (e.g. __memcpy_chk) that have the default
2412 // "don't know" as the objectsize. Anything else should be left alone.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002413 FortifiedLibCallSimplifier Simplifier(TLInfo, true);
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002414 if (Value *V = Simplifier.optimizeCall(CI)) {
2415 CI->replaceAllUsesWith(V);
2416 CI->eraseFromParent();
2417 return true;
2418 }
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002419
2420 LibFunc Func;
Sanjay Patel5e370852017-06-08 19:47:25 +00002421 if (TLInfo->getLibFunc(ImmutableCallSite(CI), Func) &&
2422 Func == LibFunc_memcmp && expandMemCmp(CI, TTI, TLI, DL)) {
2423 ModifiedDT = true;
2424 return true;
Zaara Syeda3a7578c2017-05-31 17:12:38 +00002425 }
Ahmed Bougachae03bef72015-01-12 17:22:43 +00002426 return false;
Eric Christopher4b7948e2010-03-11 02:41:03 +00002427}
Chris Lattner1b93be52011-01-15 07:25:29 +00002428
Sanjay Patel4ac6b112015-09-21 22:47:23 +00002429/// Look for opportunities to duplicate return instructions to the predecessor
2430/// to enable tail call optimizations. The case it is currently looking for is:
Dmitri Gribenko2bc1d482012-09-13 12:34:29 +00002431/// @code
Evan Cheng0663f232011-03-21 01:19:09 +00002432/// bb0:
2433/// %tmp0 = tail call i32 @f0()
2434/// br label %return
2435/// bb1:
2436/// %tmp1 = tail call i32 @f1()
2437/// br label %return
2438/// bb2:
2439/// %tmp2 = tail call i32 @f2()
2440/// br label %return
2441/// return:
2442/// %retval = phi i32 [ %tmp0, %bb0 ], [ %tmp1, %bb1 ], [ %tmp2, %bb2 ]
2443/// ret i32 %retval
Dmitri Gribenko2bc1d482012-09-13 12:34:29 +00002444/// @endcode
Evan Cheng0663f232011-03-21 01:19:09 +00002445///
2446/// =>
2447///
Dmitri Gribenko2bc1d482012-09-13 12:34:29 +00002448/// @code
Evan Cheng0663f232011-03-21 01:19:09 +00002449/// bb0:
2450/// %tmp0 = tail call i32 @f0()
2451/// ret i32 %tmp0
2452/// bb1:
2453/// %tmp1 = tail call i32 @f1()
2454/// ret i32 %tmp1
2455/// bb2:
2456/// %tmp2 = tail call i32 @f2()
2457/// ret i32 %tmp2
Dmitri Gribenko2bc1d482012-09-13 12:34:29 +00002458/// @endcode
Sanjay Patelfc580a62015-09-21 23:03:16 +00002459bool CodeGenPrepare::dupRetToEnableTailCallOpts(BasicBlock *BB) {
Cameron Zwarich47e71752011-03-24 04:51:51 +00002460 if (!TLI)
2461 return false;
2462
Michael Kuperstein71321562016-09-07 20:29:49 +00002463 ReturnInst *RetI = dyn_cast<ReturnInst>(BB->getTerminator());
2464 if (!RetI)
Benjamin Kramer455fa352012-11-23 19:17:06 +00002465 return false;
2466
Craig Topperc0196b12014-04-14 00:51:57 +00002467 PHINode *PN = nullptr;
2468 BitCastInst *BCI = nullptr;
Michael Kuperstein71321562016-09-07 20:29:49 +00002469 Value *V = RetI->getReturnValue();
Evan Cheng249716e2012-07-27 21:21:26 +00002470 if (V) {
2471 BCI = dyn_cast<BitCastInst>(V);
2472 if (BCI)
2473 V = BCI->getOperand(0);
2474
2475 PN = dyn_cast<PHINode>(V);
2476 if (!PN)
2477 return false;
2478 }
Evan Cheng0663f232011-03-21 01:19:09 +00002479
Cameron Zwarich4649f172011-03-24 04:52:10 +00002480 if (PN && PN->getParent() != BB)
Cameron Zwarich0e331c02011-03-24 04:52:07 +00002481 return false;
Evan Cheng0663f232011-03-21 01:19:09 +00002482
Cameron Zwarich4649f172011-03-24 04:52:10 +00002483 // Make sure there are no instructions between the PHI and return, or that the
2484 // return is the first instruction in the block.
2485 if (PN) {
2486 BasicBlock::iterator BI = BB->begin();
2487 do { ++BI; } while (isa<DbgInfoIntrinsic>(BI));
Evan Cheng249716e2012-07-27 21:21:26 +00002488 if (&*BI == BCI)
2489 // Also skip over the bitcast.
2490 ++BI;
Michael Kuperstein71321562016-09-07 20:29:49 +00002491 if (&*BI != RetI)
Cameron Zwarich4649f172011-03-24 04:52:10 +00002492 return false;
2493 } else {
Cameron Zwarich74157ab2011-03-24 16:34:59 +00002494 BasicBlock::iterator BI = BB->begin();
2495 while (isa<DbgInfoIntrinsic>(BI)) ++BI;
Michael Kuperstein71321562016-09-07 20:29:49 +00002496 if (&*BI != RetI)
Cameron Zwarich4649f172011-03-24 04:52:10 +00002497 return false;
2498 }
Evan Cheng0663f232011-03-21 01:19:09 +00002499
Cameron Zwarich0e331c02011-03-24 04:52:07 +00002500 /// Only dup the ReturnInst if the CallInst is likely to be emitted as a tail
2501 /// call.
Michael Kupersteinf79af6f2016-09-08 00:48:37 +00002502 const Function *F = BB->getParent();
Cameron Zwarich0e331c02011-03-24 04:52:07 +00002503 SmallVector<CallInst*, 4> TailCalls;
Cameron Zwarich4649f172011-03-24 04:52:10 +00002504 if (PN) {
2505 for (unsigned I = 0, E = PN->getNumIncomingValues(); I != E; ++I) {
2506 CallInst *CI = dyn_cast<CallInst>(PN->getIncomingValue(I));
2507 // Make sure the phi value is indeed produced by the tail call.
2508 if (CI && CI->hasOneUse() && CI->getParent() == PN->getIncomingBlock(I) &&
Michael Kupersteinf79af6f2016-09-08 00:48:37 +00002509 TLI->mayBeEmittedAsTailCall(CI) &&
2510 attributesPermitTailCall(F, CI, RetI, *TLI))
Cameron Zwarich4649f172011-03-24 04:52:10 +00002511 TailCalls.push_back(CI);
2512 }
2513 } else {
2514 SmallPtrSet<BasicBlock*, 4> VisitedBBs;
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00002515 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
David Blaikie70573dc2014-11-19 07:49:26 +00002516 if (!VisitedBBs.insert(*PI).second)
Cameron Zwarich4649f172011-03-24 04:52:10 +00002517 continue;
2518
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00002519 BasicBlock::InstListType &InstList = (*PI)->getInstList();
Cameron Zwarich4649f172011-03-24 04:52:10 +00002520 BasicBlock::InstListType::reverse_iterator RI = InstList.rbegin();
2521 BasicBlock::InstListType::reverse_iterator RE = InstList.rend();
Cameron Zwarich74157ab2011-03-24 16:34:59 +00002522 do { ++RI; } while (RI != RE && isa<DbgInfoIntrinsic>(&*RI));
2523 if (RI == RE)
Cameron Zwarich4649f172011-03-24 04:52:10 +00002524 continue;
Cameron Zwarich74157ab2011-03-24 16:34:59 +00002525
Cameron Zwarich4649f172011-03-24 04:52:10 +00002526 CallInst *CI = dyn_cast<CallInst>(&*RI);
Michael Kupersteinf79af6f2016-09-08 00:48:37 +00002527 if (CI && CI->use_empty() && TLI->mayBeEmittedAsTailCall(CI) &&
2528 attributesPermitTailCall(F, CI, RetI, *TLI))
Cameron Zwarich4649f172011-03-24 04:52:10 +00002529 TailCalls.push_back(CI);
2530 }
Evan Cheng0663f232011-03-21 01:19:09 +00002531 }
2532
Cameron Zwarich0e331c02011-03-24 04:52:07 +00002533 bool Changed = false;
2534 for (unsigned i = 0, e = TailCalls.size(); i != e; ++i) {
2535 CallInst *CI = TailCalls[i];
2536 CallSite CS(CI);
2537
2538 // Conservatively require the attributes of the call to match those of the
2539 // return. Ignore noalias because it doesn't affect the call sequence.
Reid Klecknerb5180542017-03-21 16:57:19 +00002540 AttributeList CalleeAttrs = CS.getAttributes();
2541 if (AttrBuilder(CalleeAttrs, AttributeList::ReturnIndex)
2542 .removeAttribute(Attribute::NoAlias) !=
2543 AttrBuilder(CalleeAttrs, AttributeList::ReturnIndex)
2544 .removeAttribute(Attribute::NoAlias))
Cameron Zwarich0e331c02011-03-24 04:52:07 +00002545 continue;
2546
2547 // Make sure the call instruction is followed by an unconditional branch to
2548 // the return block.
2549 BasicBlock *CallBB = CI->getParent();
2550 BranchInst *BI = dyn_cast<BranchInst>(CallBB->getTerminator());
2551 if (!BI || !BI->isUnconditional() || BI->getSuccessor(0) != BB)
2552 continue;
2553
2554 // Duplicate the return into CallBB.
Michael Kuperstein71321562016-09-07 20:29:49 +00002555 (void)FoldReturnIntoUncondBranch(RetI, BB, CallBB);
Devang Patel8f606d72011-03-24 15:35:25 +00002556 ModifiedDT = Changed = true;
Cameron Zwarich0e331c02011-03-24 04:52:07 +00002557 ++NumRetsDup;
2558 }
2559
2560 // If we eliminated all predecessors of the block, delete the block now.
Evan Cheng64a223a2012-09-28 23:58:57 +00002561 if (Changed && !BB->hasAddressTaken() && pred_begin(BB) == pred_end(BB))
Cameron Zwarich0e331c02011-03-24 04:52:07 +00002562 BB->eraseFromParent();
2563
2564 return Changed;
Evan Cheng0663f232011-03-21 01:19:09 +00002565}
2566
Chris Lattner728f9022008-11-25 07:09:13 +00002567//===----------------------------------------------------------------------===//
Chris Lattner728f9022008-11-25 07:09:13 +00002568// Memory Optimization
2569//===----------------------------------------------------------------------===//
2570
Chandler Carruthc8925912013-01-05 02:09:22 +00002571namespace {
2572
Sanjay Patel4ac6b112015-09-21 22:47:23 +00002573/// This is an extended version of TargetLowering::AddrMode
Chandler Carruthc8925912013-01-05 02:09:22 +00002574/// which holds actual Value*'s for register values.
Chandler Carruth95f83e02013-01-07 15:14:13 +00002575struct ExtAddrMode : public TargetLowering::AddrMode {
Chandler Carruthc8925912013-01-05 02:09:22 +00002576 Value *BaseReg;
2577 Value *ScaledReg;
Craig Topperc0196b12014-04-14 00:51:57 +00002578 ExtAddrMode() : BaseReg(nullptr), ScaledReg(nullptr) {}
Chandler Carruthc8925912013-01-05 02:09:22 +00002579 void print(raw_ostream &OS) const;
2580 void dump() const;
Stephen Lin837bba12013-07-15 17:55:02 +00002581
Chandler Carruthc8925912013-01-05 02:09:22 +00002582 bool operator==(const ExtAddrMode& O) const {
2583 return (BaseReg == O.BaseReg) && (ScaledReg == O.ScaledReg) &&
2584 (BaseGV == O.BaseGV) && (BaseOffs == O.BaseOffs) &&
2585 (HasBaseReg == O.HasBaseReg) && (Scale == O.Scale);
2586 }
2587};
2588
Eli Friedmanc1f1f852013-09-10 23:09:24 +00002589#ifndef NDEBUG
2590static inline raw_ostream &operator<<(raw_ostream &OS, const ExtAddrMode &AM) {
2591 AM.print(OS);
2592 return OS;
2593}
2594#endif
2595
Chandler Carruthc8925912013-01-05 02:09:22 +00002596void ExtAddrMode::print(raw_ostream &OS) const {
2597 bool NeedPlus = false;
2598 OS << "[";
2599 if (BaseGV) {
2600 OS << (NeedPlus ? " + " : "")
2601 << "GV:";
Chandler Carruthd48cdbf2014-01-09 02:29:41 +00002602 BaseGV->printAsOperand(OS, /*PrintType=*/false);
Chandler Carruthc8925912013-01-05 02:09:22 +00002603 NeedPlus = true;
2604 }
2605
Richard Trieuc0f91212014-05-30 03:15:17 +00002606 if (BaseOffs) {
2607 OS << (NeedPlus ? " + " : "")
2608 << BaseOffs;
2609 NeedPlus = true;
2610 }
Chandler Carruthc8925912013-01-05 02:09:22 +00002611
2612 if (BaseReg) {
2613 OS << (NeedPlus ? " + " : "")
2614 << "Base:";
Chandler Carruthd48cdbf2014-01-09 02:29:41 +00002615 BaseReg->printAsOperand(OS, /*PrintType=*/false);
Chandler Carruthc8925912013-01-05 02:09:22 +00002616 NeedPlus = true;
2617 }
2618 if (Scale) {
2619 OS << (NeedPlus ? " + " : "")
2620 << Scale << "*";
Chandler Carruthd48cdbf2014-01-09 02:29:41 +00002621 ScaledReg->printAsOperand(OS, /*PrintType=*/false);
Chandler Carruthc8925912013-01-05 02:09:22 +00002622 }
2623
2624 OS << ']';
2625}
2626
2627#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Yaron Kereneb2a2542016-01-29 20:50:44 +00002628LLVM_DUMP_METHOD void ExtAddrMode::dump() const {
Chandler Carruthc8925912013-01-05 02:09:22 +00002629 print(dbgs());
2630 dbgs() << '\n';
2631}
2632#endif
2633
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002634/// \brief This class provides transaction based operation on the IR.
2635/// Every change made through this class is recorded in the internal state and
2636/// can be undone (rollback) until commit is called.
2637class TypePromotionTransaction {
2638
2639 /// \brief This represents the common interface of the individual transaction.
2640 /// Each class implements the logic for doing one specific modification on
2641 /// the IR via the TypePromotionTransaction.
2642 class TypePromotionAction {
2643 protected:
2644 /// The Instruction modified.
2645 Instruction *Inst;
2646
2647 public:
2648 /// \brief Constructor of the action.
2649 /// The constructor performs the related action on the IR.
2650 TypePromotionAction(Instruction *Inst) : Inst(Inst) {}
2651
2652 virtual ~TypePromotionAction() {}
2653
2654 /// \brief Undo the modification done by this action.
2655 /// When this method is called, the IR must be in the same state as it was
2656 /// before this action was applied.
2657 /// \pre Undoing the action works if and only if the IR is in the exact same
2658 /// state as it was directly after this action was applied.
2659 virtual void undo() = 0;
2660
2661 /// \brief Advocate every change made by this action.
2662 /// When the results on the IR of the action are to be kept, it is important
2663 /// to call this function, otherwise hidden information may be kept forever.
2664 virtual void commit() {
2665 // Nothing to be done, this action is not doing anything.
2666 }
2667 };
2668
2669 /// \brief Utility to remember the position of an instruction.
2670 class InsertionHandler {
2671 /// Position of an instruction.
2672 /// Either an instruction:
2673 /// - Is the first in a basic block: BB is used.
2674 /// - Has a previous instructon: PrevInst is used.
2675 union {
2676 Instruction *PrevInst;
2677 BasicBlock *BB;
2678 } Point;
2679 /// Remember whether or not the instruction had a previous instruction.
2680 bool HasPrevInstruction;
2681
2682 public:
2683 /// \brief Record the position of \p Inst.
2684 InsertionHandler(Instruction *Inst) {
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00002685 BasicBlock::iterator It = Inst->getIterator();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002686 HasPrevInstruction = (It != (Inst->getParent()->begin()));
2687 if (HasPrevInstruction)
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00002688 Point.PrevInst = &*--It;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002689 else
2690 Point.BB = Inst->getParent();
2691 }
2692
2693 /// \brief Insert \p Inst at the recorded position.
2694 void insert(Instruction *Inst) {
2695 if (HasPrevInstruction) {
2696 if (Inst->getParent())
2697 Inst->removeFromParent();
2698 Inst->insertAfter(Point.PrevInst);
2699 } else {
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00002700 Instruction *Position = &*Point.BB->getFirstInsertionPt();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002701 if (Inst->getParent())
2702 Inst->moveBefore(Position);
2703 else
2704 Inst->insertBefore(Position);
2705 }
2706 }
2707 };
2708
2709 /// \brief Move an instruction before another.
2710 class InstructionMoveBefore : public TypePromotionAction {
2711 /// Original position of the instruction.
2712 InsertionHandler Position;
2713
2714 public:
2715 /// \brief Move \p Inst before \p Before.
2716 InstructionMoveBefore(Instruction *Inst, Instruction *Before)
2717 : TypePromotionAction(Inst), Position(Inst) {
2718 DEBUG(dbgs() << "Do: move: " << *Inst << "\nbefore: " << *Before << "\n");
2719 Inst->moveBefore(Before);
2720 }
2721
2722 /// \brief Move the instruction back to its original position.
Craig Topper4584cd52014-03-07 09:26:03 +00002723 void undo() override {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002724 DEBUG(dbgs() << "Undo: moveBefore: " << *Inst << "\n");
2725 Position.insert(Inst);
2726 }
2727 };
2728
2729 /// \brief Set the operand of an instruction with a new value.
2730 class OperandSetter : public TypePromotionAction {
2731 /// Original operand of the instruction.
2732 Value *Origin;
2733 /// Index of the modified instruction.
2734 unsigned Idx;
2735
2736 public:
2737 /// \brief Set \p Idx operand of \p Inst with \p NewVal.
2738 OperandSetter(Instruction *Inst, unsigned Idx, Value *NewVal)
2739 : TypePromotionAction(Inst), Idx(Idx) {
2740 DEBUG(dbgs() << "Do: setOperand: " << Idx << "\n"
2741 << "for:" << *Inst << "\n"
2742 << "with:" << *NewVal << "\n");
2743 Origin = Inst->getOperand(Idx);
2744 Inst->setOperand(Idx, NewVal);
2745 }
2746
2747 /// \brief Restore the original value of the instruction.
Craig Topper4584cd52014-03-07 09:26:03 +00002748 void undo() override {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002749 DEBUG(dbgs() << "Undo: setOperand:" << Idx << "\n"
2750 << "for: " << *Inst << "\n"
2751 << "with: " << *Origin << "\n");
2752 Inst->setOperand(Idx, Origin);
2753 }
2754 };
2755
2756 /// \brief Hide the operands of an instruction.
2757 /// Do as if this instruction was not using any of its operands.
2758 class OperandsHider : public TypePromotionAction {
2759 /// The list of original operands.
2760 SmallVector<Value *, 4> OriginalValues;
2761
2762 public:
2763 /// \brief Remove \p Inst from the uses of the operands of \p Inst.
2764 OperandsHider(Instruction *Inst) : TypePromotionAction(Inst) {
2765 DEBUG(dbgs() << "Do: OperandsHider: " << *Inst << "\n");
2766 unsigned NumOpnds = Inst->getNumOperands();
2767 OriginalValues.reserve(NumOpnds);
2768 for (unsigned It = 0; It < NumOpnds; ++It) {
2769 // Save the current operand.
2770 Value *Val = Inst->getOperand(It);
2771 OriginalValues.push_back(Val);
2772 // Set a dummy one.
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00002773 // We could use OperandSetter here, but that would imply an overhead
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002774 // that we are not willing to pay.
2775 Inst->setOperand(It, UndefValue::get(Val->getType()));
2776 }
2777 }
2778
2779 /// \brief Restore the original list of uses.
Craig Topper4584cd52014-03-07 09:26:03 +00002780 void undo() override {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002781 DEBUG(dbgs() << "Undo: OperandsHider: " << *Inst << "\n");
2782 for (unsigned It = 0, EndIt = OriginalValues.size(); It != EndIt; ++It)
2783 Inst->setOperand(It, OriginalValues[It]);
2784 }
2785 };
2786
2787 /// \brief Build a truncate instruction.
2788 class TruncBuilder : public TypePromotionAction {
Quentin Colombetac55b152014-09-16 22:36:07 +00002789 Value *Val;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002790 public:
2791 /// \brief Build a truncate instruction of \p Opnd producing a \p Ty
2792 /// result.
2793 /// trunc Opnd to Ty.
2794 TruncBuilder(Instruction *Opnd, Type *Ty) : TypePromotionAction(Opnd) {
2795 IRBuilder<> Builder(Opnd);
Quentin Colombetac55b152014-09-16 22:36:07 +00002796 Val = Builder.CreateTrunc(Opnd, Ty, "promoted");
2797 DEBUG(dbgs() << "Do: TruncBuilder: " << *Val << "\n");
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002798 }
2799
Quentin Colombetac55b152014-09-16 22:36:07 +00002800 /// \brief Get the built value.
2801 Value *getBuiltValue() { return Val; }
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002802
2803 /// \brief Remove the built instruction.
Craig Topper4584cd52014-03-07 09:26:03 +00002804 void undo() override {
Quentin Colombetac55b152014-09-16 22:36:07 +00002805 DEBUG(dbgs() << "Undo: TruncBuilder: " << *Val << "\n");
2806 if (Instruction *IVal = dyn_cast<Instruction>(Val))
2807 IVal->eraseFromParent();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002808 }
2809 };
2810
2811 /// \brief Build a sign extension instruction.
2812 class SExtBuilder : public TypePromotionAction {
Quentin Colombetac55b152014-09-16 22:36:07 +00002813 Value *Val;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002814 public:
2815 /// \brief Build a sign extension instruction of \p Opnd producing a \p Ty
2816 /// result.
2817 /// sext Opnd to Ty.
2818 SExtBuilder(Instruction *InsertPt, Value *Opnd, Type *Ty)
Quentin Colombetac55b152014-09-16 22:36:07 +00002819 : TypePromotionAction(InsertPt) {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002820 IRBuilder<> Builder(InsertPt);
Quentin Colombetac55b152014-09-16 22:36:07 +00002821 Val = Builder.CreateSExt(Opnd, Ty, "promoted");
2822 DEBUG(dbgs() << "Do: SExtBuilder: " << *Val << "\n");
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002823 }
2824
Quentin Colombetac55b152014-09-16 22:36:07 +00002825 /// \brief Get the built value.
2826 Value *getBuiltValue() { return Val; }
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002827
2828 /// \brief Remove the built instruction.
Craig Topper4584cd52014-03-07 09:26:03 +00002829 void undo() override {
Quentin Colombetac55b152014-09-16 22:36:07 +00002830 DEBUG(dbgs() << "Undo: SExtBuilder: " << *Val << "\n");
2831 if (Instruction *IVal = dyn_cast<Instruction>(Val))
2832 IVal->eraseFromParent();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002833 }
2834 };
2835
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00002836 /// \brief Build a zero extension instruction.
2837 class ZExtBuilder : public TypePromotionAction {
Quentin Colombetac55b152014-09-16 22:36:07 +00002838 Value *Val;
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00002839 public:
2840 /// \brief Build a zero extension instruction of \p Opnd producing a \p Ty
2841 /// result.
2842 /// zext Opnd to Ty.
2843 ZExtBuilder(Instruction *InsertPt, Value *Opnd, Type *Ty)
Quentin Colombetac55b152014-09-16 22:36:07 +00002844 : TypePromotionAction(InsertPt) {
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00002845 IRBuilder<> Builder(InsertPt);
Quentin Colombetac55b152014-09-16 22:36:07 +00002846 Val = Builder.CreateZExt(Opnd, Ty, "promoted");
2847 DEBUG(dbgs() << "Do: ZExtBuilder: " << *Val << "\n");
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00002848 }
2849
Quentin Colombetac55b152014-09-16 22:36:07 +00002850 /// \brief Get the built value.
2851 Value *getBuiltValue() { return Val; }
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00002852
2853 /// \brief Remove the built instruction.
2854 void undo() override {
Quentin Colombetac55b152014-09-16 22:36:07 +00002855 DEBUG(dbgs() << "Undo: ZExtBuilder: " << *Val << "\n");
2856 if (Instruction *IVal = dyn_cast<Instruction>(Val))
2857 IVal->eraseFromParent();
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00002858 }
2859 };
2860
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002861 /// \brief Mutate an instruction to another type.
2862 class TypeMutator : public TypePromotionAction {
2863 /// Record the original type.
2864 Type *OrigTy;
2865
2866 public:
2867 /// \brief Mutate the type of \p Inst into \p NewTy.
2868 TypeMutator(Instruction *Inst, Type *NewTy)
2869 : TypePromotionAction(Inst), OrigTy(Inst->getType()) {
2870 DEBUG(dbgs() << "Do: MutateType: " << *Inst << " with " << *NewTy
2871 << "\n");
2872 Inst->mutateType(NewTy);
2873 }
2874
2875 /// \brief Mutate the instruction back to its original type.
Craig Topper4584cd52014-03-07 09:26:03 +00002876 void undo() override {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002877 DEBUG(dbgs() << "Undo: MutateType: " << *Inst << " with " << *OrigTy
2878 << "\n");
2879 Inst->mutateType(OrigTy);
2880 }
2881 };
2882
2883 /// \brief Replace the uses of an instruction by another instruction.
2884 class UsesReplacer : public TypePromotionAction {
2885 /// Helper structure to keep track of the replaced uses.
2886 struct InstructionAndIdx {
2887 /// The instruction using the instruction.
2888 Instruction *Inst;
2889 /// The index where this instruction is used for Inst.
2890 unsigned Idx;
2891 InstructionAndIdx(Instruction *Inst, unsigned Idx)
2892 : Inst(Inst), Idx(Idx) {}
2893 };
2894
2895 /// Keep track of the original uses (pair Instruction, Index).
2896 SmallVector<InstructionAndIdx, 4> OriginalUses;
2897 typedef SmallVectorImpl<InstructionAndIdx>::iterator use_iterator;
2898
2899 public:
2900 /// \brief Replace all the use of \p Inst by \p New.
2901 UsesReplacer(Instruction *Inst, Value *New) : TypePromotionAction(Inst) {
2902 DEBUG(dbgs() << "Do: UsersReplacer: " << *Inst << " with " << *New
2903 << "\n");
2904 // Record the original uses.
Chandler Carruthcdf47882014-03-09 03:16:01 +00002905 for (Use &U : Inst->uses()) {
2906 Instruction *UserI = cast<Instruction>(U.getUser());
2907 OriginalUses.push_back(InstructionAndIdx(UserI, U.getOperandNo()));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002908 }
2909 // Now, we can replace the uses.
2910 Inst->replaceAllUsesWith(New);
2911 }
2912
2913 /// \brief Reassign the original uses of Inst to Inst.
Craig Topper4584cd52014-03-07 09:26:03 +00002914 void undo() override {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002915 DEBUG(dbgs() << "Undo: UsersReplacer: " << *Inst << "\n");
2916 for (use_iterator UseIt = OriginalUses.begin(),
2917 EndIt = OriginalUses.end();
2918 UseIt != EndIt; ++UseIt) {
2919 UseIt->Inst->setOperand(UseIt->Idx, Inst);
2920 }
2921 }
2922 };
2923
2924 /// \brief Remove an instruction from the IR.
2925 class InstructionRemover : public TypePromotionAction {
2926 /// Original position of the instruction.
2927 InsertionHandler Inserter;
2928 /// Helper structure to hide all the link to the instruction. In other
2929 /// words, this helps to do as if the instruction was removed.
2930 OperandsHider Hider;
2931 /// Keep track of the uses replaced, if any.
2932 UsesReplacer *Replacer;
Jun Bum Limdee55652017-04-03 19:20:07 +00002933 /// Keep track of instructions removed.
2934 SetOfInstrs &RemovedInsts;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002935
2936 public:
2937 /// \brief Remove all reference of \p Inst and optinally replace all its
2938 /// uses with New.
Jun Bum Limdee55652017-04-03 19:20:07 +00002939 /// \p RemovedInsts Keep track of the instructions removed by this Action.
Craig Topperc0196b12014-04-14 00:51:57 +00002940 /// \pre If !Inst->use_empty(), then New != nullptr
Jun Bum Limdee55652017-04-03 19:20:07 +00002941 InstructionRemover(Instruction *Inst, SetOfInstrs &RemovedInsts,
2942 Value *New = nullptr)
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002943 : TypePromotionAction(Inst), Inserter(Inst), Hider(Inst),
Jun Bum Limdee55652017-04-03 19:20:07 +00002944 Replacer(nullptr), RemovedInsts(RemovedInsts) {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002945 if (New)
2946 Replacer = new UsesReplacer(Inst, New);
2947 DEBUG(dbgs() << "Do: InstructionRemover: " << *Inst << "\n");
Jun Bum Limdee55652017-04-03 19:20:07 +00002948 RemovedInsts.insert(Inst);
2949 /// The instructions removed here will be freed after completing
2950 /// optimizeBlock() for all blocks as we need to keep track of the
2951 /// removed instructions during promotion.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002952 Inst->removeFromParent();
2953 }
2954
Alexander Kornienkof817c1c2015-04-11 02:11:45 +00002955 ~InstructionRemover() override { delete Replacer; }
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002956
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002957 /// \brief Resurrect the instruction and reassign it to the proper uses if
2958 /// new value was provided when build this action.
Craig Topper4584cd52014-03-07 09:26:03 +00002959 void undo() override {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002960 DEBUG(dbgs() << "Undo: InstructionRemover: " << *Inst << "\n");
2961 Inserter.insert(Inst);
2962 if (Replacer)
2963 Replacer->undo();
2964 Hider.undo();
Jun Bum Limdee55652017-04-03 19:20:07 +00002965 RemovedInsts.erase(Inst);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002966 }
2967 };
2968
2969public:
2970 /// Restoration point.
2971 /// The restoration point is a pointer to an action instead of an iterator
2972 /// because the iterator may be invalidated but not the pointer.
2973 typedef const TypePromotionAction *ConstRestorationPt;
Jun Bum Limdee55652017-04-03 19:20:07 +00002974
2975 TypePromotionTransaction(SetOfInstrs &RemovedInsts)
2976 : RemovedInsts(RemovedInsts) {}
2977
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002978 /// Advocate every changes made in that transaction.
2979 void commit();
2980 /// Undo all the changes made after the given point.
2981 void rollback(ConstRestorationPt Point);
2982 /// Get the current restoration point.
2983 ConstRestorationPt getRestorationPoint() const;
2984
2985 /// \name API for IR modification with state keeping to support rollback.
2986 /// @{
2987 /// Same as Instruction::setOperand.
2988 void setOperand(Instruction *Inst, unsigned Idx, Value *NewVal);
2989 /// Same as Instruction::eraseFromParent.
Craig Topperc0196b12014-04-14 00:51:57 +00002990 void eraseInstruction(Instruction *Inst, Value *NewVal = nullptr);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002991 /// Same as Value::replaceAllUsesWith.
2992 void replaceAllUsesWith(Instruction *Inst, Value *New);
2993 /// Same as Value::mutateType.
2994 void mutateType(Instruction *Inst, Type *NewTy);
2995 /// Same as IRBuilder::createTrunc.
Quentin Colombetac55b152014-09-16 22:36:07 +00002996 Value *createTrunc(Instruction *Opnd, Type *Ty);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00002997 /// Same as IRBuilder::createSExt.
Quentin Colombetac55b152014-09-16 22:36:07 +00002998 Value *createSExt(Instruction *Inst, Value *Opnd, Type *Ty);
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00002999 /// Same as IRBuilder::createZExt.
Quentin Colombetac55b152014-09-16 22:36:07 +00003000 Value *createZExt(Instruction *Inst, Value *Opnd, Type *Ty);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003001 /// Same as Instruction::moveBefore.
3002 void moveBefore(Instruction *Inst, Instruction *Before);
3003 /// @}
3004
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003005private:
3006 /// The ordered list of actions made so far.
David Blaikie7620b312014-04-15 06:17:44 +00003007 SmallVector<std::unique_ptr<TypePromotionAction>, 16> Actions;
3008 typedef SmallVectorImpl<std::unique_ptr<TypePromotionAction>>::iterator CommitPt;
Jun Bum Limdee55652017-04-03 19:20:07 +00003009 SetOfInstrs &RemovedInsts;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003010};
3011
3012void TypePromotionTransaction::setOperand(Instruction *Inst, unsigned Idx,
3013 Value *NewVal) {
3014 Actions.push_back(
David Blaikie7620b312014-04-15 06:17:44 +00003015 make_unique<TypePromotionTransaction::OperandSetter>(Inst, Idx, NewVal));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003016}
3017
3018void TypePromotionTransaction::eraseInstruction(Instruction *Inst,
3019 Value *NewVal) {
3020 Actions.push_back(
Jun Bum Limdee55652017-04-03 19:20:07 +00003021 make_unique<TypePromotionTransaction::InstructionRemover>(Inst,
3022 RemovedInsts, NewVal));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003023}
3024
3025void TypePromotionTransaction::replaceAllUsesWith(Instruction *Inst,
3026 Value *New) {
David Blaikie7620b312014-04-15 06:17:44 +00003027 Actions.push_back(make_unique<TypePromotionTransaction::UsesReplacer>(Inst, New));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003028}
3029
3030void TypePromotionTransaction::mutateType(Instruction *Inst, Type *NewTy) {
David Blaikie7620b312014-04-15 06:17:44 +00003031 Actions.push_back(make_unique<TypePromotionTransaction::TypeMutator>(Inst, NewTy));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003032}
3033
Quentin Colombetac55b152014-09-16 22:36:07 +00003034Value *TypePromotionTransaction::createTrunc(Instruction *Opnd,
3035 Type *Ty) {
David Blaikie7620b312014-04-15 06:17:44 +00003036 std::unique_ptr<TruncBuilder> Ptr(new TruncBuilder(Opnd, Ty));
Quentin Colombetac55b152014-09-16 22:36:07 +00003037 Value *Val = Ptr->getBuiltValue();
David Blaikie7620b312014-04-15 06:17:44 +00003038 Actions.push_back(std::move(Ptr));
Quentin Colombetac55b152014-09-16 22:36:07 +00003039 return Val;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003040}
3041
Quentin Colombetac55b152014-09-16 22:36:07 +00003042Value *TypePromotionTransaction::createSExt(Instruction *Inst,
3043 Value *Opnd, Type *Ty) {
David Blaikie7620b312014-04-15 06:17:44 +00003044 std::unique_ptr<SExtBuilder> Ptr(new SExtBuilder(Inst, Opnd, Ty));
Quentin Colombetac55b152014-09-16 22:36:07 +00003045 Value *Val = Ptr->getBuiltValue();
David Blaikie7620b312014-04-15 06:17:44 +00003046 Actions.push_back(std::move(Ptr));
Quentin Colombetac55b152014-09-16 22:36:07 +00003047 return Val;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003048}
3049
Quentin Colombetac55b152014-09-16 22:36:07 +00003050Value *TypePromotionTransaction::createZExt(Instruction *Inst,
3051 Value *Opnd, Type *Ty) {
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003052 std::unique_ptr<ZExtBuilder> Ptr(new ZExtBuilder(Inst, Opnd, Ty));
Quentin Colombetac55b152014-09-16 22:36:07 +00003053 Value *Val = Ptr->getBuiltValue();
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003054 Actions.push_back(std::move(Ptr));
Quentin Colombetac55b152014-09-16 22:36:07 +00003055 return Val;
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003056}
3057
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003058void TypePromotionTransaction::moveBefore(Instruction *Inst,
3059 Instruction *Before) {
3060 Actions.push_back(
David Blaikie7620b312014-04-15 06:17:44 +00003061 make_unique<TypePromotionTransaction::InstructionMoveBefore>(Inst, Before));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003062}
3063
3064TypePromotionTransaction::ConstRestorationPt
3065TypePromotionTransaction::getRestorationPoint() const {
David Blaikie7620b312014-04-15 06:17:44 +00003066 return !Actions.empty() ? Actions.back().get() : nullptr;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003067}
3068
3069void TypePromotionTransaction::commit() {
3070 for (CommitPt It = Actions.begin(), EndIt = Actions.end(); It != EndIt;
David Blaikie7620b312014-04-15 06:17:44 +00003071 ++It)
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003072 (*It)->commit();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003073 Actions.clear();
3074}
3075
3076void TypePromotionTransaction::rollback(
3077 TypePromotionTransaction::ConstRestorationPt Point) {
David Blaikie7620b312014-04-15 06:17:44 +00003078 while (!Actions.empty() && Point != Actions.back().get()) {
3079 std::unique_ptr<TypePromotionAction> Curr = Actions.pop_back_val();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003080 Curr->undo();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003081 }
3082}
3083
Chandler Carruthc8925912013-01-05 02:09:22 +00003084/// \brief A helper class for matching addressing modes.
3085///
3086/// This encapsulates the logic for matching the target-legal addressing modes.
3087class AddressingModeMatcher {
3088 SmallVectorImpl<Instruction*> &AddrModeInsts;
3089 const TargetLowering &TLI;
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003090 const TargetRegisterInfo &TRI;
Mehdi Amini4fe37982015-07-07 18:45:17 +00003091 const DataLayout &DL;
Chandler Carruthc8925912013-01-05 02:09:22 +00003092
3093 /// AccessTy/MemoryInst - This is the type for the access (e.g. double) and
3094 /// the memory instruction that we're computing this address for.
3095 Type *AccessTy;
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00003096 unsigned AddrSpace;
Chandler Carruthc8925912013-01-05 02:09:22 +00003097 Instruction *MemoryInst;
Stephen Lin837bba12013-07-15 17:55:02 +00003098
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003099 /// This is the addressing mode that we're building up. This is
Chandler Carruthc8925912013-01-05 02:09:22 +00003100 /// part of the return value of this addressing mode matching stuff.
3101 ExtAddrMode &AddrMode;
Stephen Lin837bba12013-07-15 17:55:02 +00003102
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003103 /// The instructions inserted by other CodeGenPrepare optimizations.
3104 const SetOfInstrs &InsertedInsts;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003105 /// A map from the instructions to their type before promotion.
3106 InstrToOrigTy &PromotedInsts;
3107 /// The ongoing transaction where every action should be registered.
3108 TypePromotionTransaction &TPT;
3109
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003110 /// This is set to true when we should not do profitability checks.
3111 /// When true, IsProfitableToFoldIntoAddressingMode always returns true.
Chandler Carruthc8925912013-01-05 02:09:22 +00003112 bool IgnoreProfitability;
Stephen Lin837bba12013-07-15 17:55:02 +00003113
Eric Christopherd75c00c2015-02-26 22:38:34 +00003114 AddressingModeMatcher(SmallVectorImpl<Instruction *> &AMI,
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003115 const TargetLowering &TLI,
3116 const TargetRegisterInfo &TRI,
3117 Type *AT, unsigned AS,
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00003118 Instruction *MI, ExtAddrMode &AM,
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003119 const SetOfInstrs &InsertedInsts,
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003120 InstrToOrigTy &PromotedInsts,
3121 TypePromotionTransaction &TPT)
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003122 : AddrModeInsts(AMI), TLI(TLI), TRI(TRI),
Mehdi Amini4fe37982015-07-07 18:45:17 +00003123 DL(MI->getModule()->getDataLayout()), AccessTy(AT), AddrSpace(AS),
3124 MemoryInst(MI), AddrMode(AM), InsertedInsts(InsertedInsts),
3125 PromotedInsts(PromotedInsts), TPT(TPT) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003126 IgnoreProfitability = false;
3127 }
3128public:
Stephen Lin837bba12013-07-15 17:55:02 +00003129
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003130 /// Find the maximal addressing mode that a load/store of V can fold,
Chandler Carruthc8925912013-01-05 02:09:22 +00003131 /// give an access type of AccessTy. This returns a list of involved
3132 /// instructions in AddrModeInsts.
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003133 /// \p InsertedInsts The instructions inserted by other CodeGenPrepare
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003134 /// optimizations.
3135 /// \p PromotedInsts maps the instructions to their type before promotion.
3136 /// \p The ongoing transaction where every action should be registered.
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00003137 static ExtAddrMode Match(Value *V, Type *AccessTy, unsigned AS,
Chandler Carruthc8925912013-01-05 02:09:22 +00003138 Instruction *MemoryInst,
3139 SmallVectorImpl<Instruction*> &AddrModeInsts,
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003140 const TargetLowering &TLI,
3141 const TargetRegisterInfo &TRI,
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003142 const SetOfInstrs &InsertedInsts,
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003143 InstrToOrigTy &PromotedInsts,
3144 TypePromotionTransaction &TPT) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003145 ExtAddrMode Result;
3146
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003147 bool Success = AddressingModeMatcher(AddrModeInsts, TLI, TRI,
3148 AccessTy, AS,
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003149 MemoryInst, Result, InsertedInsts,
Sanjay Patelfc580a62015-09-21 23:03:16 +00003150 PromotedInsts, TPT).matchAddr(V, 0);
Chandler Carruthc8925912013-01-05 02:09:22 +00003151 (void)Success; assert(Success && "Couldn't select *anything*?");
3152 return Result;
3153 }
3154private:
Sanjay Patelfc580a62015-09-21 23:03:16 +00003155 bool matchScaledValue(Value *ScaleReg, int64_t Scale, unsigned Depth);
3156 bool matchAddr(Value *V, unsigned Depth);
3157 bool matchOperationAddr(User *Operation, unsigned Opcode, unsigned Depth,
Craig Topperc0196b12014-04-14 00:51:57 +00003158 bool *MovedAway = nullptr);
Sanjay Patelfc580a62015-09-21 23:03:16 +00003159 bool isProfitableToFoldIntoAddressingMode(Instruction *I,
Chandler Carruthc8925912013-01-05 02:09:22 +00003160 ExtAddrMode &AMBefore,
3161 ExtAddrMode &AMAfter);
Sanjay Patelfc580a62015-09-21 23:03:16 +00003162 bool valueAlreadyLiveAtInst(Value *Val, Value *KnownLive1, Value *KnownLive2);
3163 bool isPromotionProfitable(unsigned NewCost, unsigned OldCost,
Quentin Colombet867c5502014-02-14 22:23:22 +00003164 Value *PromotedOperand) const;
Chandler Carruthc8925912013-01-05 02:09:22 +00003165};
3166
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003167/// Try adding ScaleReg*Scale to the current addressing mode.
Chandler Carruthc8925912013-01-05 02:09:22 +00003168/// Return true and update AddrMode if this addr mode is legal for the target,
3169/// false if not.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003170bool AddressingModeMatcher::matchScaledValue(Value *ScaleReg, int64_t Scale,
Chandler Carruthc8925912013-01-05 02:09:22 +00003171 unsigned Depth) {
3172 // If Scale is 1, then this is the same as adding ScaleReg to the addressing
3173 // mode. Just process that directly.
3174 if (Scale == 1)
Sanjay Patelfc580a62015-09-21 23:03:16 +00003175 return matchAddr(ScaleReg, Depth);
Stephen Lin837bba12013-07-15 17:55:02 +00003176
Chandler Carruthc8925912013-01-05 02:09:22 +00003177 // If the scale is 0, it takes nothing to add this.
3178 if (Scale == 0)
3179 return true;
Stephen Lin837bba12013-07-15 17:55:02 +00003180
Chandler Carruthc8925912013-01-05 02:09:22 +00003181 // If we already have a scale of this value, we can add to it, otherwise, we
3182 // need an available scale field.
3183 if (AddrMode.Scale != 0 && AddrMode.ScaledReg != ScaleReg)
3184 return false;
3185
3186 ExtAddrMode TestAddrMode = AddrMode;
3187
3188 // Add scale to turn X*4+X*3 -> X*7. This could also do things like
3189 // [A+B + A*7] -> [B+A*8].
3190 TestAddrMode.Scale += Scale;
3191 TestAddrMode.ScaledReg = ScaleReg;
3192
3193 // If the new address isn't legal, bail out.
Mehdi Amini0cdec1e2015-07-09 02:09:40 +00003194 if (!TLI.isLegalAddressingMode(DL, TestAddrMode, AccessTy, AddrSpace))
Chandler Carruthc8925912013-01-05 02:09:22 +00003195 return false;
3196
3197 // It was legal, so commit it.
3198 AddrMode = TestAddrMode;
Stephen Lin837bba12013-07-15 17:55:02 +00003199
Chandler Carruthc8925912013-01-05 02:09:22 +00003200 // Okay, we decided that we can add ScaleReg+Scale to AddrMode. Check now
3201 // to see if ScaleReg is actually X+C. If so, we can turn this into adding
3202 // X*Scale + C*Scale to addr mode.
Craig Topperc0196b12014-04-14 00:51:57 +00003203 ConstantInt *CI = nullptr; Value *AddLHS = nullptr;
Chandler Carruthc8925912013-01-05 02:09:22 +00003204 if (isa<Instruction>(ScaleReg) && // not a constant expr.
3205 match(ScaleReg, m_Add(m_Value(AddLHS), m_ConstantInt(CI)))) {
3206 TestAddrMode.ScaledReg = AddLHS;
3207 TestAddrMode.BaseOffs += CI->getSExtValue()*TestAddrMode.Scale;
Stephen Lin837bba12013-07-15 17:55:02 +00003208
Chandler Carruthc8925912013-01-05 02:09:22 +00003209 // If this addressing mode is legal, commit it and remember that we folded
3210 // this instruction.
Mehdi Amini0cdec1e2015-07-09 02:09:40 +00003211 if (TLI.isLegalAddressingMode(DL, TestAddrMode, AccessTy, AddrSpace)) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003212 AddrModeInsts.push_back(cast<Instruction>(ScaleReg));
3213 AddrMode = TestAddrMode;
3214 return true;
3215 }
3216 }
3217
3218 // Otherwise, not (x+c)*scale, just return what we have.
3219 return true;
3220}
3221
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003222/// This is a little filter, which returns true if an addressing computation
3223/// involving I might be folded into a load/store accessing it.
3224/// This doesn't need to be perfect, but needs to accept at least
Chandler Carruthc8925912013-01-05 02:09:22 +00003225/// the set of instructions that MatchOperationAddr can.
3226static bool MightBeFoldableInst(Instruction *I) {
3227 switch (I->getOpcode()) {
3228 case Instruction::BitCast:
Eli Benderskyf13a0562014-05-22 00:02:52 +00003229 case Instruction::AddrSpaceCast:
Chandler Carruthc8925912013-01-05 02:09:22 +00003230 // Don't touch identity bitcasts.
3231 if (I->getType() == I->getOperand(0)->getType())
3232 return false;
3233 return I->getType()->isPointerTy() || I->getType()->isIntegerTy();
3234 case Instruction::PtrToInt:
3235 // PtrToInt is always a noop, as we know that the int type is pointer sized.
3236 return true;
3237 case Instruction::IntToPtr:
3238 // We know the input is intptr_t, so this is foldable.
3239 return true;
3240 case Instruction::Add:
3241 return true;
3242 case Instruction::Mul:
3243 case Instruction::Shl:
3244 // Can only handle X*C and X << C.
3245 return isa<ConstantInt>(I->getOperand(1));
3246 case Instruction::GetElementPtr:
3247 return true;
3248 default:
3249 return false;
3250 }
3251}
3252
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003253/// \brief Check whether or not \p Val is a legal instruction for \p TLI.
3254/// \note \p Val is assumed to be the product of some type promotion.
3255/// Therefore if \p Val has an undefined state in \p TLI, this is assumed
3256/// to be legal, as the non-promoted value would have had the same state.
Mehdi Amini44ede332015-07-09 02:09:04 +00003257static bool isPromotedInstructionLegal(const TargetLowering &TLI,
3258 const DataLayout &DL, Value *Val) {
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003259 Instruction *PromotedInst = dyn_cast<Instruction>(Val);
3260 if (!PromotedInst)
3261 return false;
3262 int ISDOpcode = TLI.InstructionOpcodeToISD(PromotedInst->getOpcode());
3263 // If the ISDOpcode is undefined, it was undefined before the promotion.
3264 if (!ISDOpcode)
3265 return true;
3266 // Otherwise, check if the promoted instruction is legal or not.
3267 return TLI.isOperationLegalOrCustom(
Mehdi Amini44ede332015-07-09 02:09:04 +00003268 ISDOpcode, TLI.getValueType(DL, PromotedInst->getType()));
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003269}
3270
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003271/// \brief Hepler class to perform type promotion.
3272class TypePromotionHelper {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003273 /// \brief Utility function to check whether or not a sign or zero extension
3274 /// of \p Inst with \p ConsideredExtType can be moved through \p Inst by
3275 /// either using the operands of \p Inst or promoting \p Inst.
3276 /// The type of the extension is defined by \p IsSExt.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003277 /// In other words, check if:
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003278 /// ext (Ty Inst opnd1 opnd2 ... opndN) to ConsideredExtType.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003279 /// #1 Promotion applies:
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003280 /// ConsideredExtType Inst (ext opnd1 to ConsideredExtType, ...).
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003281 /// #2 Operand reuses:
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003282 /// ext opnd1 to ConsideredExtType.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003283 /// \p PromotedInsts maps the instructions to their type before promotion.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003284 static bool canGetThrough(const Instruction *Inst, Type *ConsideredExtType,
3285 const InstrToOrigTy &PromotedInsts, bool IsSExt);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003286
3287 /// \brief Utility function to determine if \p OpIdx should be promoted when
3288 /// promoting \p Inst.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003289 static bool shouldExtOperand(const Instruction *Inst, int OpIdx) {
Rafael Espindola84921b92015-10-24 23:11:13 +00003290 return !(isa<SelectInst>(Inst) && OpIdx == 0);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003291 }
3292
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003293 /// \brief Utility function to promote the operand of \p Ext when this
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003294 /// operand is a promotable trunc or sext or zext.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003295 /// \p PromotedInsts maps the instructions to their type before promotion.
Quentin Colombet1b274f92015-03-10 21:48:15 +00003296 /// \p CreatedInstsCost[out] contains the cost of all instructions
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003297 /// created to promote the operand of Ext.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003298 /// Newly added extensions are inserted in \p Exts.
3299 /// Newly added truncates are inserted in \p Truncs.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003300 /// Should never be called directly.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003301 /// \return The promoted value which is used instead of Ext.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003302 static Value *promoteOperandForTruncAndAnyExt(
3303 Instruction *Ext, TypePromotionTransaction &TPT,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003304 InstrToOrigTy &PromotedInsts, unsigned &CreatedInstsCost,
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003305 SmallVectorImpl<Instruction *> *Exts,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003306 SmallVectorImpl<Instruction *> *Truncs, const TargetLowering &TLI);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003307
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003308 /// \brief Utility function to promote the operand of \p Ext when this
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003309 /// operand is promotable and is not a supported trunc or sext.
3310 /// \p PromotedInsts maps the instructions to their type before promotion.
Quentin Colombet1b274f92015-03-10 21:48:15 +00003311 /// \p CreatedInstsCost[out] contains the cost of all the instructions
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003312 /// created to promote the operand of Ext.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003313 /// Newly added extensions are inserted in \p Exts.
3314 /// Newly added truncates are inserted in \p Truncs.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003315 /// Should never be called directly.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003316 /// \return The promoted value which is used instead of Ext.
Quentin Colombet1b274f92015-03-10 21:48:15 +00003317 static Value *promoteOperandForOther(Instruction *Ext,
3318 TypePromotionTransaction &TPT,
3319 InstrToOrigTy &PromotedInsts,
3320 unsigned &CreatedInstsCost,
3321 SmallVectorImpl<Instruction *> *Exts,
3322 SmallVectorImpl<Instruction *> *Truncs,
3323 const TargetLowering &TLI, bool IsSExt);
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003324
3325 /// \see promoteOperandForOther.
Quentin Colombet1b274f92015-03-10 21:48:15 +00003326 static Value *signExtendOperandForOther(
3327 Instruction *Ext, TypePromotionTransaction &TPT,
3328 InstrToOrigTy &PromotedInsts, unsigned &CreatedInstsCost,
3329 SmallVectorImpl<Instruction *> *Exts,
3330 SmallVectorImpl<Instruction *> *Truncs, const TargetLowering &TLI) {
3331 return promoteOperandForOther(Ext, TPT, PromotedInsts, CreatedInstsCost,
3332 Exts, Truncs, TLI, true);
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003333 }
3334
3335 /// \see promoteOperandForOther.
Quentin Colombet1b274f92015-03-10 21:48:15 +00003336 static Value *zeroExtendOperandForOther(
3337 Instruction *Ext, TypePromotionTransaction &TPT,
3338 InstrToOrigTy &PromotedInsts, unsigned &CreatedInstsCost,
3339 SmallVectorImpl<Instruction *> *Exts,
3340 SmallVectorImpl<Instruction *> *Truncs, const TargetLowering &TLI) {
3341 return promoteOperandForOther(Ext, TPT, PromotedInsts, CreatedInstsCost,
3342 Exts, Truncs, TLI, false);
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003343 }
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003344
3345public:
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003346 /// Type for the utility function that promotes the operand of Ext.
3347 typedef Value *(*Action)(Instruction *Ext, TypePromotionTransaction &TPT,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003348 InstrToOrigTy &PromotedInsts,
3349 unsigned &CreatedInstsCost,
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003350 SmallVectorImpl<Instruction *> *Exts,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003351 SmallVectorImpl<Instruction *> *Truncs,
3352 const TargetLowering &TLI);
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003353 /// \brief Given a sign/zero extend instruction \p Ext, return the approriate
3354 /// action to promote the operand of \p Ext instead of using Ext.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003355 /// \return NULL if no promotable action is possible with the current
3356 /// sign extension.
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003357 /// \p InsertedInsts keeps track of all the instructions inserted by the
3358 /// other CodeGenPrepare optimizations. This information is important
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003359 /// because we do not want to promote these instructions as CodeGenPrepare
3360 /// will reinsert them later. Thus creating an infinite loop: create/remove.
3361 /// \p PromotedInsts maps the instructions to their type before promotion.
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003362 static Action getAction(Instruction *Ext, const SetOfInstrs &InsertedInsts,
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003363 const TargetLowering &TLI,
3364 const InstrToOrigTy &PromotedInsts);
3365};
3366
3367bool TypePromotionHelper::canGetThrough(const Instruction *Inst,
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003368 Type *ConsideredExtType,
3369 const InstrToOrigTy &PromotedInsts,
3370 bool IsSExt) {
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003371 // The promotion helper does not know how to deal with vector types yet.
3372 // To be able to fix that, we would need to fix the places where we
3373 // statically extend, e.g., constants and such.
3374 if (Inst->getType()->isVectorTy())
3375 return false;
3376
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003377 // We can always get through zext.
3378 if (isa<ZExtInst>(Inst))
3379 return true;
3380
3381 // sext(sext) is ok too.
3382 if (IsSExt && isa<SExtInst>(Inst))
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003383 return true;
3384
3385 // We can get through binary operator, if it is legal. In other words, the
3386 // binary operator must have a nuw or nsw flag.
3387 const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Inst);
3388 if (BinOp && isa<OverflowingBinaryOperator>(BinOp) &&
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003389 ((!IsSExt && BinOp->hasNoUnsignedWrap()) ||
3390 (IsSExt && BinOp->hasNoSignedWrap())))
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003391 return true;
3392
3393 // Check if we can do the following simplification.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003394 // ext(trunc(opnd)) --> ext(opnd)
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003395 if (!isa<TruncInst>(Inst))
3396 return false;
3397
3398 Value *OpndVal = Inst->getOperand(0);
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003399 // Check if we can use this operand in the extension.
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00003400 // If the type is larger than the result type of the extension, we cannot.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003401 if (!OpndVal->getType()->isIntegerTy() ||
3402 OpndVal->getType()->getIntegerBitWidth() >
3403 ConsideredExtType->getIntegerBitWidth())
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003404 return false;
3405
3406 // If the operand of the truncate is not an instruction, we will not have
3407 // any information on the dropped bits.
3408 // (Actually we could for constant but it is not worth the extra logic).
3409 Instruction *Opnd = dyn_cast<Instruction>(OpndVal);
3410 if (!Opnd)
3411 return false;
3412
3413 // Check if the source of the type is narrow enough.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003414 // I.e., check that trunc just drops extended bits of the same kind of
3415 // the extension.
3416 // #1 get the type of the operand and check the kind of the extended bits.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003417 const Type *OpndType;
3418 InstrToOrigTy::const_iterator It = PromotedInsts.find(Opnd);
Benjamin Kramer4cd5faa2015-07-31 17:00:39 +00003419 if (It != PromotedInsts.end() && It->second.getInt() == IsSExt)
3420 OpndType = It->second.getPointer();
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003421 else if ((IsSExt && isa<SExtInst>(Opnd)) || (!IsSExt && isa<ZExtInst>(Opnd)))
3422 OpndType = Opnd->getOperand(0)->getType();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003423 else
3424 return false;
3425
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00003426 // #2 check that the truncate just drops extended bits.
Rafael Espindola84921b92015-10-24 23:11:13 +00003427 return Inst->getType()->getIntegerBitWidth() >=
3428 OpndType->getIntegerBitWidth();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003429}
3430
3431TypePromotionHelper::Action TypePromotionHelper::getAction(
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003432 Instruction *Ext, const SetOfInstrs &InsertedInsts,
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003433 const TargetLowering &TLI, const InstrToOrigTy &PromotedInsts) {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003434 assert((isa<SExtInst>(Ext) || isa<ZExtInst>(Ext)) &&
3435 "Unexpected instruction type");
3436 Instruction *ExtOpnd = dyn_cast<Instruction>(Ext->getOperand(0));
3437 Type *ExtTy = Ext->getType();
3438 bool IsSExt = isa<SExtInst>(Ext);
3439 // If the operand of the extension is not an instruction, we cannot
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003440 // get through.
3441 // If it, check we can get through.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003442 if (!ExtOpnd || !canGetThrough(ExtOpnd, ExtTy, PromotedInsts, IsSExt))
Craig Topperc0196b12014-04-14 00:51:57 +00003443 return nullptr;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003444
3445 // Do not promote if the operand has been added by codegenprepare.
3446 // Otherwise, it means we are undoing an optimization that is likely to be
3447 // redone, thus causing potential infinite loop.
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003448 if (isa<TruncInst>(ExtOpnd) && InsertedInsts.count(ExtOpnd))
Craig Topperc0196b12014-04-14 00:51:57 +00003449 return nullptr;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003450
3451 // SExt or Trunc instructions.
3452 // Return the related handler.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003453 if (isa<SExtInst>(ExtOpnd) || isa<TruncInst>(ExtOpnd) ||
3454 isa<ZExtInst>(ExtOpnd))
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003455 return promoteOperandForTruncAndAnyExt;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003456
3457 // Regular instruction.
3458 // Abort early if we will have to insert non-free instructions.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003459 if (!ExtOpnd->hasOneUse() && !TLI.isTruncateFree(ExtTy, ExtOpnd->getType()))
Craig Topperc0196b12014-04-14 00:51:57 +00003460 return nullptr;
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003461 return IsSExt ? signExtendOperandForOther : zeroExtendOperandForOther;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003462}
3463
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003464Value *TypePromotionHelper::promoteOperandForTruncAndAnyExt(
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003465 llvm::Instruction *SExt, TypePromotionTransaction &TPT,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003466 InstrToOrigTy &PromotedInsts, unsigned &CreatedInstsCost,
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003467 SmallVectorImpl<Instruction *> *Exts,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003468 SmallVectorImpl<Instruction *> *Truncs, const TargetLowering &TLI) {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003469 // By construction, the operand of SExt is an instruction. Otherwise we cannot
3470 // get through it and this method should not be called.
3471 Instruction *SExtOpnd = cast<Instruction>(SExt->getOperand(0));
Quentin Colombetac55b152014-09-16 22:36:07 +00003472 Value *ExtVal = SExt;
Quentin Colombet1b274f92015-03-10 21:48:15 +00003473 bool HasMergedNonFreeExt = false;
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003474 if (isa<ZExtInst>(SExtOpnd)) {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003475 // Replace s|zext(zext(opnd))
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003476 // => zext(opnd).
Quentin Colombet1b274f92015-03-10 21:48:15 +00003477 HasMergedNonFreeExt = !TLI.isExtFree(SExtOpnd);
Quentin Colombetac55b152014-09-16 22:36:07 +00003478 Value *ZExt =
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003479 TPT.createZExt(SExt, SExtOpnd->getOperand(0), SExt->getType());
3480 TPT.replaceAllUsesWith(SExt, ZExt);
3481 TPT.eraseInstruction(SExt);
Quentin Colombetac55b152014-09-16 22:36:07 +00003482 ExtVal = ZExt;
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003483 } else {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003484 // Replace z|sext(trunc(opnd)) or sext(sext(opnd))
3485 // => z|sext(opnd).
Quentin Colombetb2c5c6d2014-09-11 21:22:14 +00003486 TPT.setOperand(SExt, 0, SExtOpnd->getOperand(0));
3487 }
Quentin Colombet1b274f92015-03-10 21:48:15 +00003488 CreatedInstsCost = 0;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003489
3490 // Remove dead code.
3491 if (SExtOpnd->use_empty())
3492 TPT.eraseInstruction(SExtOpnd);
3493
Quentin Colombet9dcb7242014-09-15 18:26:58 +00003494 // Check if the extension is still needed.
Quentin Colombetac55b152014-09-16 22:36:07 +00003495 Instruction *ExtInst = dyn_cast<Instruction>(ExtVal);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003496 if (!ExtInst || ExtInst->getType() != ExtInst->getOperand(0)->getType()) {
Quentin Colombet1b274f92015-03-10 21:48:15 +00003497 if (ExtInst) {
3498 if (Exts)
3499 Exts->push_back(ExtInst);
3500 CreatedInstsCost = !TLI.isExtFree(ExtInst) && !HasMergedNonFreeExt;
3501 }
Quentin Colombetac55b152014-09-16 22:36:07 +00003502 return ExtVal;
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003503 }
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003504
Quentin Colombet9dcb7242014-09-15 18:26:58 +00003505 // At this point we have: ext ty opnd to ty.
3506 // Reassign the uses of ExtInst to the opnd and remove ExtInst.
3507 Value *NextVal = ExtInst->getOperand(0);
3508 TPT.eraseInstruction(ExtInst, NextVal);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003509 return NextVal;
3510}
3511
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003512Value *TypePromotionHelper::promoteOperandForOther(
3513 Instruction *Ext, TypePromotionTransaction &TPT,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003514 InstrToOrigTy &PromotedInsts, unsigned &CreatedInstsCost,
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003515 SmallVectorImpl<Instruction *> *Exts,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003516 SmallVectorImpl<Instruction *> *Truncs, const TargetLowering &TLI,
3517 bool IsSExt) {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003518 // By construction, the operand of Ext is an instruction. Otherwise we cannot
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003519 // get through it and this method should not be called.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003520 Instruction *ExtOpnd = cast<Instruction>(Ext->getOperand(0));
Quentin Colombet1b274f92015-03-10 21:48:15 +00003521 CreatedInstsCost = 0;
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003522 if (!ExtOpnd->hasOneUse()) {
3523 // ExtOpnd will be promoted.
3524 // All its uses, but Ext, will need to use a truncated value of the
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003525 // promoted version.
3526 // Create the truncate now.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003527 Value *Trunc = TPT.createTrunc(Ext, ExtOpnd->getType());
Quentin Colombetac55b152014-09-16 22:36:07 +00003528 if (Instruction *ITrunc = dyn_cast<Instruction>(Trunc)) {
3529 ITrunc->removeFromParent();
3530 // Insert it just after the definition.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003531 ITrunc->insertAfter(ExtOpnd);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003532 if (Truncs)
3533 Truncs->push_back(ITrunc);
Quentin Colombetac55b152014-09-16 22:36:07 +00003534 }
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003535
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003536 TPT.replaceAllUsesWith(ExtOpnd, Trunc);
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00003537 // Restore the operand of Ext (which has been replaced by the previous call
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003538 // to replaceAllUsesWith) to avoid creating a cycle trunc <-> sext.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003539 TPT.setOperand(Ext, 0, ExtOpnd);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003540 }
3541
3542 // Get through the Instruction:
3543 // 1. Update its type.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003544 // 2. Replace the uses of Ext by Inst.
3545 // 3. Extend each operand that needs to be extended.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003546
3547 // Remember the original type of the instruction before promotion.
3548 // This is useful to know that the high bits are sign extended bits.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003549 PromotedInsts.insert(std::pair<Instruction *, TypeIsSExt>(
3550 ExtOpnd, TypeIsSExt(ExtOpnd->getType(), IsSExt)));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003551 // Step #1.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003552 TPT.mutateType(ExtOpnd, Ext->getType());
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003553 // Step #2.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003554 TPT.replaceAllUsesWith(Ext, ExtOpnd);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003555 // Step #3.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003556 Instruction *ExtForOpnd = Ext;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003557
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003558 DEBUG(dbgs() << "Propagate Ext to operands\n");
3559 for (int OpIdx = 0, EndOpIdx = ExtOpnd->getNumOperands(); OpIdx != EndOpIdx;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003560 ++OpIdx) {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003561 DEBUG(dbgs() << "Operand:\n" << *(ExtOpnd->getOperand(OpIdx)) << '\n');
3562 if (ExtOpnd->getOperand(OpIdx)->getType() == Ext->getType() ||
3563 !shouldExtOperand(ExtOpnd, OpIdx)) {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003564 DEBUG(dbgs() << "No need to propagate\n");
3565 continue;
3566 }
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003567 // Check if we can statically extend the operand.
3568 Value *Opnd = ExtOpnd->getOperand(OpIdx);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003569 if (const ConstantInt *Cst = dyn_cast<ConstantInt>(Opnd)) {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003570 DEBUG(dbgs() << "Statically extend\n");
3571 unsigned BitWidth = Ext->getType()->getIntegerBitWidth();
3572 APInt CstVal = IsSExt ? Cst->getValue().sext(BitWidth)
3573 : Cst->getValue().zext(BitWidth);
3574 TPT.setOperand(ExtOpnd, OpIdx, ConstantInt::get(Ext->getType(), CstVal));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003575 continue;
3576 }
3577 // UndefValue are typed, so we have to statically sign extend them.
3578 if (isa<UndefValue>(Opnd)) {
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003579 DEBUG(dbgs() << "Statically extend\n");
3580 TPT.setOperand(ExtOpnd, OpIdx, UndefValue::get(Ext->getType()));
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003581 continue;
3582 }
3583
3584 // Otherwise we have to explicity sign extend the operand.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003585 // Check if Ext was reused to extend an operand.
3586 if (!ExtForOpnd) {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003587 // If yes, create a new one.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003588 DEBUG(dbgs() << "More operands to ext\n");
Quentin Colombet84f89cc2014-12-22 18:11:52 +00003589 Value *ValForExtOpnd = IsSExt ? TPT.createSExt(Ext, Opnd, Ext->getType())
3590 : TPT.createZExt(Ext, Opnd, Ext->getType());
3591 if (!isa<Instruction>(ValForExtOpnd)) {
3592 TPT.setOperand(ExtOpnd, OpIdx, ValForExtOpnd);
3593 continue;
3594 }
3595 ExtForOpnd = cast<Instruction>(ValForExtOpnd);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003596 }
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003597 if (Exts)
3598 Exts->push_back(ExtForOpnd);
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003599 TPT.setOperand(ExtForOpnd, 0, Opnd);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003600
3601 // Move the sign extension before the insertion point.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003602 TPT.moveBefore(ExtForOpnd, ExtOpnd);
3603 TPT.setOperand(ExtOpnd, OpIdx, ExtForOpnd);
Quentin Colombet1b274f92015-03-10 21:48:15 +00003604 CreatedInstsCost += !TLI.isExtFree(ExtForOpnd);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003605 // If more sext are required, new instructions will have to be created.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003606 ExtForOpnd = nullptr;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003607 }
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003608 if (ExtForOpnd == Ext) {
3609 DEBUG(dbgs() << "Extension is useless now\n");
3610 TPT.eraseInstruction(Ext);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003611 }
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003612 return ExtOpnd;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003613}
3614
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003615/// Check whether or not promoting an instruction to a wider type is profitable.
Quentin Colombet1b274f92015-03-10 21:48:15 +00003616/// \p NewCost gives the cost of extension instructions created by the
3617/// promotion.
3618/// \p OldCost gives the cost of extension instructions before the promotion
3619/// plus the number of instructions that have been
3620/// matched in the addressing mode the promotion.
Quentin Colombet867c5502014-02-14 22:23:22 +00003621/// \p PromotedOperand is the value that has been promoted.
3622/// \return True if the promotion is profitable, false otherwise.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003623bool AddressingModeMatcher::isPromotionProfitable(
Quentin Colombet1b274f92015-03-10 21:48:15 +00003624 unsigned NewCost, unsigned OldCost, Value *PromotedOperand) const {
3625 DEBUG(dbgs() << "OldCost: " << OldCost << "\tNewCost: " << NewCost << '\n');
3626 // The cost of the new extensions is greater than the cost of the
3627 // old extension plus what we folded.
Quentin Colombet867c5502014-02-14 22:23:22 +00003628 // This is not profitable.
Quentin Colombet1b274f92015-03-10 21:48:15 +00003629 if (NewCost > OldCost)
Quentin Colombet867c5502014-02-14 22:23:22 +00003630 return false;
Quentin Colombet1b274f92015-03-10 21:48:15 +00003631 if (NewCost < OldCost)
Quentin Colombet867c5502014-02-14 22:23:22 +00003632 return true;
3633 // The promotion is neutral but it may help folding the sign extension in
3634 // loads for instance.
3635 // Check that we did not create an illegal instruction.
Mehdi Amini44ede332015-07-09 02:09:04 +00003636 return isPromotedInstructionLegal(TLI, DL, PromotedOperand);
Quentin Colombet867c5502014-02-14 22:23:22 +00003637}
3638
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003639/// Given an instruction or constant expr, see if we can fold the operation
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00003640/// into the addressing mode. If so, update the addressing mode and return
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003641/// true, otherwise return false without modifying AddrMode.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003642/// If \p MovedAway is not NULL, it contains the information of whether or
3643/// not AddrInst has to be folded into the addressing mode on success.
3644/// If \p MovedAway == true, \p AddrInst will not be part of the addressing
3645/// because it has been moved away.
3646/// Thus AddrInst must not be added in the matched instructions.
3647/// This state can happen when AddrInst is a sext, since it may be moved away.
3648/// Therefore, AddrInst may not be valid when MovedAway is true and it must
3649/// not be referenced anymore.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003650bool AddressingModeMatcher::matchOperationAddr(User *AddrInst, unsigned Opcode,
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003651 unsigned Depth,
3652 bool *MovedAway) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003653 // Avoid exponential behavior on extremely deep expression trees.
3654 if (Depth >= 5) return false;
Stephen Lin837bba12013-07-15 17:55:02 +00003655
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003656 // By default, all matched instructions stay in place.
3657 if (MovedAway)
3658 *MovedAway = false;
3659
Chandler Carruthc8925912013-01-05 02:09:22 +00003660 switch (Opcode) {
3661 case Instruction::PtrToInt:
3662 // PtrToInt is always a noop, as we know that the int type is pointer sized.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003663 return matchAddr(AddrInst->getOperand(0), Depth);
Mehdi Amini44ede332015-07-09 02:09:04 +00003664 case Instruction::IntToPtr: {
3665 auto AS = AddrInst->getType()->getPointerAddressSpace();
3666 auto PtrTy = MVT::getIntegerVT(DL.getPointerSizeInBits(AS));
Chandler Carruthc8925912013-01-05 02:09:22 +00003667 // This inttoptr is a no-op if the integer type is pointer sized.
Mehdi Amini44ede332015-07-09 02:09:04 +00003668 if (TLI.getValueType(DL, AddrInst->getOperand(0)->getType()) == PtrTy)
Sanjay Patelfc580a62015-09-21 23:03:16 +00003669 return matchAddr(AddrInst->getOperand(0), Depth);
Chandler Carruthc8925912013-01-05 02:09:22 +00003670 return false;
Mehdi Amini44ede332015-07-09 02:09:04 +00003671 }
Chandler Carruthc8925912013-01-05 02:09:22 +00003672 case Instruction::BitCast:
3673 // BitCast is always a noop, and we can handle it as long as it is
3674 // int->int or pointer->pointer (we don't want int<->fp or something).
3675 if ((AddrInst->getOperand(0)->getType()->isPointerTy() ||
3676 AddrInst->getOperand(0)->getType()->isIntegerTy()) &&
3677 // Don't touch identity bitcasts. These were probably put here by LSR,
3678 // and we don't want to mess around with them. Assume it knows what it
3679 // is doing.
3680 AddrInst->getOperand(0)->getType() != AddrInst->getType())
Sanjay Patelfc580a62015-09-21 23:03:16 +00003681 return matchAddr(AddrInst->getOperand(0), Depth);
Chandler Carruthc8925912013-01-05 02:09:22 +00003682 return false;
Matt Arsenaultf05b0232015-05-26 16:59:43 +00003683 case Instruction::AddrSpaceCast: {
3684 unsigned SrcAS
3685 = AddrInst->getOperand(0)->getType()->getPointerAddressSpace();
3686 unsigned DestAS = AddrInst->getType()->getPointerAddressSpace();
3687 if (TLI.isNoopAddrSpaceCast(SrcAS, DestAS))
Sanjay Patelfc580a62015-09-21 23:03:16 +00003688 return matchAddr(AddrInst->getOperand(0), Depth);
Matt Arsenaultf05b0232015-05-26 16:59:43 +00003689 return false;
3690 }
Chandler Carruthc8925912013-01-05 02:09:22 +00003691 case Instruction::Add: {
3692 // Check to see if we can merge in the RHS then the LHS. If so, we win.
3693 ExtAddrMode BackupAddrMode = AddrMode;
3694 unsigned OldSize = AddrModeInsts.size();
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003695 // Start a transaction at this point.
3696 // The LHS may match but not the RHS.
3697 // Therefore, we need a higher level restoration point to undo partially
3698 // matched operation.
3699 TypePromotionTransaction::ConstRestorationPt LastKnownGood =
3700 TPT.getRestorationPoint();
3701
Sanjay Patelfc580a62015-09-21 23:03:16 +00003702 if (matchAddr(AddrInst->getOperand(1), Depth+1) &&
3703 matchAddr(AddrInst->getOperand(0), Depth+1))
Chandler Carruthc8925912013-01-05 02:09:22 +00003704 return true;
Stephen Lin837bba12013-07-15 17:55:02 +00003705
Chandler Carruthc8925912013-01-05 02:09:22 +00003706 // Restore the old addr mode info.
3707 AddrMode = BackupAddrMode;
3708 AddrModeInsts.resize(OldSize);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003709 TPT.rollback(LastKnownGood);
Stephen Lin837bba12013-07-15 17:55:02 +00003710
Chandler Carruthc8925912013-01-05 02:09:22 +00003711 // Otherwise this was over-aggressive. Try merging in the LHS then the RHS.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003712 if (matchAddr(AddrInst->getOperand(0), Depth+1) &&
3713 matchAddr(AddrInst->getOperand(1), Depth+1))
Chandler Carruthc8925912013-01-05 02:09:22 +00003714 return true;
Stephen Lin837bba12013-07-15 17:55:02 +00003715
Chandler Carruthc8925912013-01-05 02:09:22 +00003716 // Otherwise we definitely can't merge the ADD in.
3717 AddrMode = BackupAddrMode;
3718 AddrModeInsts.resize(OldSize);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003719 TPT.rollback(LastKnownGood);
Chandler Carruthc8925912013-01-05 02:09:22 +00003720 break;
3721 }
3722 //case Instruction::Or:
3723 // TODO: We can handle "Or Val, Imm" iff this OR is equivalent to an ADD.
3724 //break;
3725 case Instruction::Mul:
3726 case Instruction::Shl: {
3727 // Can only handle X*C and X << C.
3728 ConstantInt *RHS = dyn_cast<ConstantInt>(AddrInst->getOperand(1));
Sanjay Pateld3bbfa12014-07-16 22:40:28 +00003729 if (!RHS)
3730 return false;
Chandler Carruthc8925912013-01-05 02:09:22 +00003731 int64_t Scale = RHS->getSExtValue();
3732 if (Opcode == Instruction::Shl)
3733 Scale = 1LL << Scale;
Stephen Lin837bba12013-07-15 17:55:02 +00003734
Sanjay Patelfc580a62015-09-21 23:03:16 +00003735 return matchScaledValue(AddrInst->getOperand(0), Scale, Depth);
Chandler Carruthc8925912013-01-05 02:09:22 +00003736 }
3737 case Instruction::GetElementPtr: {
3738 // Scan the GEP. We check it if it contains constant offsets and at most
3739 // one variable offset.
3740 int VariableOperand = -1;
3741 unsigned VariableScale = 0;
Stephen Lin837bba12013-07-15 17:55:02 +00003742
Chandler Carruthc8925912013-01-05 02:09:22 +00003743 int64_t ConstantOffset = 0;
Chandler Carruthc8925912013-01-05 02:09:22 +00003744 gep_type_iterator GTI = gep_type_begin(AddrInst);
3745 for (unsigned i = 1, e = AddrInst->getNumOperands(); i != e; ++i, ++GTI) {
Peter Collingbourneab85225b2016-12-02 02:24:42 +00003746 if (StructType *STy = GTI.getStructTypeOrNull()) {
Mehdi Amini4fe37982015-07-07 18:45:17 +00003747 const StructLayout *SL = DL.getStructLayout(STy);
Chandler Carruthc8925912013-01-05 02:09:22 +00003748 unsigned Idx =
3749 cast<ConstantInt>(AddrInst->getOperand(i))->getZExtValue();
3750 ConstantOffset += SL->getElementOffset(Idx);
3751 } else {
Mehdi Amini4fe37982015-07-07 18:45:17 +00003752 uint64_t TypeSize = DL.getTypeAllocSize(GTI.getIndexedType());
Chandler Carruthc8925912013-01-05 02:09:22 +00003753 if (ConstantInt *CI = dyn_cast<ConstantInt>(AddrInst->getOperand(i))) {
3754 ConstantOffset += CI->getSExtValue()*TypeSize;
3755 } else if (TypeSize) { // Scales of zero don't do anything.
3756 // We only allow one variable index at the moment.
3757 if (VariableOperand != -1)
3758 return false;
Stephen Lin837bba12013-07-15 17:55:02 +00003759
Chandler Carruthc8925912013-01-05 02:09:22 +00003760 // Remember the variable index.
3761 VariableOperand = i;
3762 VariableScale = TypeSize;
3763 }
3764 }
3765 }
Stephen Lin837bba12013-07-15 17:55:02 +00003766
Chandler Carruthc8925912013-01-05 02:09:22 +00003767 // A common case is for the GEP to only do a constant offset. In this case,
3768 // just add it to the disp field and check validity.
3769 if (VariableOperand == -1) {
3770 AddrMode.BaseOffs += ConstantOffset;
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00003771 if (ConstantOffset == 0 ||
Mehdi Amini0cdec1e2015-07-09 02:09:40 +00003772 TLI.isLegalAddressingMode(DL, AddrMode, AccessTy, AddrSpace)) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003773 // Check to see if we can fold the base pointer in too.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003774 if (matchAddr(AddrInst->getOperand(0), Depth+1))
Chandler Carruthc8925912013-01-05 02:09:22 +00003775 return true;
3776 }
3777 AddrMode.BaseOffs -= ConstantOffset;
3778 return false;
3779 }
3780
3781 // Save the valid addressing mode in case we can't match.
3782 ExtAddrMode BackupAddrMode = AddrMode;
3783 unsigned OldSize = AddrModeInsts.size();
3784
3785 // See if the scale and offset amount is valid for this target.
3786 AddrMode.BaseOffs += ConstantOffset;
3787
3788 // Match the base operand of the GEP.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003789 if (!matchAddr(AddrInst->getOperand(0), Depth+1)) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003790 // If it couldn't be matched, just stuff the value in a register.
3791 if (AddrMode.HasBaseReg) {
3792 AddrMode = BackupAddrMode;
3793 AddrModeInsts.resize(OldSize);
3794 return false;
3795 }
3796 AddrMode.HasBaseReg = true;
3797 AddrMode.BaseReg = AddrInst->getOperand(0);
3798 }
3799
3800 // Match the remaining variable portion of the GEP.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003801 if (!matchScaledValue(AddrInst->getOperand(VariableOperand), VariableScale,
Chandler Carruthc8925912013-01-05 02:09:22 +00003802 Depth)) {
3803 // If it couldn't be matched, try stuffing the base into a register
3804 // instead of matching it, and retrying the match of the scale.
3805 AddrMode = BackupAddrMode;
3806 AddrModeInsts.resize(OldSize);
3807 if (AddrMode.HasBaseReg)
3808 return false;
3809 AddrMode.HasBaseReg = true;
3810 AddrMode.BaseReg = AddrInst->getOperand(0);
3811 AddrMode.BaseOffs += ConstantOffset;
Sanjay Patelfc580a62015-09-21 23:03:16 +00003812 if (!matchScaledValue(AddrInst->getOperand(VariableOperand),
Chandler Carruthc8925912013-01-05 02:09:22 +00003813 VariableScale, Depth)) {
3814 // If even that didn't work, bail.
3815 AddrMode = BackupAddrMode;
3816 AddrModeInsts.resize(OldSize);
3817 return false;
3818 }
3819 }
3820
3821 return true;
3822 }
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003823 case Instruction::SExt:
3824 case Instruction::ZExt: {
3825 Instruction *Ext = dyn_cast<Instruction>(AddrInst);
3826 if (!Ext)
Sanjay Pateld3bbfa12014-07-16 22:40:28 +00003827 return false;
Sanjay Patelab60d042014-07-16 21:08:10 +00003828
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003829 // Try to move this ext out of the way of the addressing mode.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003830 // Ask for a method for doing so.
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003831 TypePromotionHelper::Action TPH =
Ahmed Bougachaf3299142015-06-17 20:44:32 +00003832 TypePromotionHelper::getAction(Ext, InsertedInsts, TLI, PromotedInsts);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003833 if (!TPH)
3834 return false;
3835
3836 TypePromotionTransaction::ConstRestorationPt LastKnownGood =
3837 TPT.getRestorationPoint();
Quentin Colombet1b274f92015-03-10 21:48:15 +00003838 unsigned CreatedInstsCost = 0;
3839 unsigned ExtCost = !TLI.isExtFree(Ext);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00003840 Value *PromotedOperand =
Quentin Colombet1b274f92015-03-10 21:48:15 +00003841 TPH(Ext, TPT, PromotedInsts, CreatedInstsCost, nullptr, nullptr, TLI);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003842 // SExt has been moved away.
3843 // Thus either it will be rematched later in the recursive calls or it is
3844 // gone. Anyway, we must not fold it into the addressing mode at this point.
3845 // E.g.,
3846 // op = add opnd, 1
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003847 // idx = ext op
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003848 // addr = gep base, idx
3849 // is now:
Quentin Colombetf5485bb2014-11-13 01:44:51 +00003850 // promotedOpnd = ext opnd <- no match here
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003851 // op = promoted_add promotedOpnd, 1 <- match (later in recursive calls)
3852 // addr = gep base, op <- match
3853 if (MovedAway)
3854 *MovedAway = true;
3855
3856 assert(PromotedOperand &&
3857 "TypePromotionHelper should have filtered out those cases");
3858
3859 ExtAddrMode BackupAddrMode = AddrMode;
3860 unsigned OldSize = AddrModeInsts.size();
3861
Sanjay Patelfc580a62015-09-21 23:03:16 +00003862 if (!matchAddr(PromotedOperand, Depth) ||
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00003863 // The total of the new cost is equal to the cost of the created
Quentin Colombet1b274f92015-03-10 21:48:15 +00003864 // instructions.
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00003865 // The total of the old cost is equal to the cost of the extension plus
Quentin Colombet1b274f92015-03-10 21:48:15 +00003866 // what we have saved in the addressing mode.
Sanjay Patelfc580a62015-09-21 23:03:16 +00003867 !isPromotionProfitable(CreatedInstsCost,
Quentin Colombet1b274f92015-03-10 21:48:15 +00003868 ExtCost + (AddrModeInsts.size() - OldSize),
Quentin Colombet867c5502014-02-14 22:23:22 +00003869 PromotedOperand)) {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003870 AddrMode = BackupAddrMode;
3871 AddrModeInsts.resize(OldSize);
3872 DEBUG(dbgs() << "Sign extension does not pay off: rollback\n");
3873 TPT.rollback(LastKnownGood);
3874 return false;
3875 }
3876 return true;
3877 }
Chandler Carruthc8925912013-01-05 02:09:22 +00003878 }
3879 return false;
3880}
3881
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003882/// If we can, try to add the value of 'Addr' into the current addressing mode.
3883/// If Addr can't be added to AddrMode this returns false and leaves AddrMode
3884/// unmodified. This assumes that Addr is either a pointer type or intptr_t
3885/// for the target.
Chandler Carruthc8925912013-01-05 02:09:22 +00003886///
Sanjay Patelfc580a62015-09-21 23:03:16 +00003887bool AddressingModeMatcher::matchAddr(Value *Addr, unsigned Depth) {
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003888 // Start a transaction at this point that we will rollback if the matching
3889 // fails.
3890 TypePromotionTransaction::ConstRestorationPt LastKnownGood =
3891 TPT.getRestorationPoint();
Chandler Carruthc8925912013-01-05 02:09:22 +00003892 if (ConstantInt *CI = dyn_cast<ConstantInt>(Addr)) {
3893 // Fold in immediates if legal for the target.
3894 AddrMode.BaseOffs += CI->getSExtValue();
Mehdi Amini0cdec1e2015-07-09 02:09:40 +00003895 if (TLI.isLegalAddressingMode(DL, AddrMode, AccessTy, AddrSpace))
Chandler Carruthc8925912013-01-05 02:09:22 +00003896 return true;
3897 AddrMode.BaseOffs -= CI->getSExtValue();
3898 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(Addr)) {
3899 // If this is a global variable, try to fold it into the addressing mode.
Craig Topperc0196b12014-04-14 00:51:57 +00003900 if (!AddrMode.BaseGV) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003901 AddrMode.BaseGV = GV;
Mehdi Amini0cdec1e2015-07-09 02:09:40 +00003902 if (TLI.isLegalAddressingMode(DL, AddrMode, AccessTy, AddrSpace))
Chandler Carruthc8925912013-01-05 02:09:22 +00003903 return true;
Craig Topperc0196b12014-04-14 00:51:57 +00003904 AddrMode.BaseGV = nullptr;
Chandler Carruthc8925912013-01-05 02:09:22 +00003905 }
3906 } else if (Instruction *I = dyn_cast<Instruction>(Addr)) {
3907 ExtAddrMode BackupAddrMode = AddrMode;
3908 unsigned OldSize = AddrModeInsts.size();
3909
3910 // Check to see if it is possible to fold this operation.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003911 bool MovedAway = false;
Sanjay Patelfc580a62015-09-21 23:03:16 +00003912 if (matchOperationAddr(I, I->getOpcode(), Depth, &MovedAway)) {
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00003913 // This instruction may have been moved away. If so, there is nothing
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003914 // to check here.
3915 if (MovedAway)
3916 return true;
Chandler Carruthc8925912013-01-05 02:09:22 +00003917 // Okay, it's possible to fold this. Check to see if it is actually
3918 // *profitable* to do so. We use a simple cost model to avoid increasing
3919 // register pressure too much.
3920 if (I->hasOneUse() ||
Sanjay Patelfc580a62015-09-21 23:03:16 +00003921 isProfitableToFoldIntoAddressingMode(I, BackupAddrMode, AddrMode)) {
Chandler Carruthc8925912013-01-05 02:09:22 +00003922 AddrModeInsts.push_back(I);
3923 return true;
3924 }
Stephen Lin837bba12013-07-15 17:55:02 +00003925
Chandler Carruthc8925912013-01-05 02:09:22 +00003926 // It isn't profitable to do this, roll back.
3927 //cerr << "NOT FOLDING: " << *I;
3928 AddrMode = BackupAddrMode;
3929 AddrModeInsts.resize(OldSize);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003930 TPT.rollback(LastKnownGood);
Chandler Carruthc8925912013-01-05 02:09:22 +00003931 }
3932 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Addr)) {
Sanjay Patelfc580a62015-09-21 23:03:16 +00003933 if (matchOperationAddr(CE, CE->getOpcode(), Depth))
Chandler Carruthc8925912013-01-05 02:09:22 +00003934 return true;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003935 TPT.rollback(LastKnownGood);
Chandler Carruthc8925912013-01-05 02:09:22 +00003936 } else if (isa<ConstantPointerNull>(Addr)) {
3937 // Null pointer gets folded without affecting the addressing mode.
3938 return true;
3939 }
3940
3941 // Worse case, the target should support [reg] addressing modes. :)
3942 if (!AddrMode.HasBaseReg) {
3943 AddrMode.HasBaseReg = true;
3944 AddrMode.BaseReg = Addr;
3945 // Still check for legality in case the target supports [imm] but not [i+r].
Mehdi Amini0cdec1e2015-07-09 02:09:40 +00003946 if (TLI.isLegalAddressingMode(DL, AddrMode, AccessTy, AddrSpace))
Chandler Carruthc8925912013-01-05 02:09:22 +00003947 return true;
3948 AddrMode.HasBaseReg = false;
Craig Topperc0196b12014-04-14 00:51:57 +00003949 AddrMode.BaseReg = nullptr;
Chandler Carruthc8925912013-01-05 02:09:22 +00003950 }
3951
3952 // If the base register is already taken, see if we can do [r+r].
3953 if (AddrMode.Scale == 0) {
3954 AddrMode.Scale = 1;
3955 AddrMode.ScaledReg = Addr;
Mehdi Amini0cdec1e2015-07-09 02:09:40 +00003956 if (TLI.isLegalAddressingMode(DL, AddrMode, AccessTy, AddrSpace))
Chandler Carruthc8925912013-01-05 02:09:22 +00003957 return true;
3958 AddrMode.Scale = 0;
Craig Topperc0196b12014-04-14 00:51:57 +00003959 AddrMode.ScaledReg = nullptr;
Chandler Carruthc8925912013-01-05 02:09:22 +00003960 }
3961 // Couldn't match.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00003962 TPT.rollback(LastKnownGood);
Chandler Carruthc8925912013-01-05 02:09:22 +00003963 return false;
3964}
3965
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003966/// Check to see if all uses of OpVal by the specified inline asm call are due
3967/// to memory operands. If so, return true, otherwise return false.
Chandler Carruthc8925912013-01-05 02:09:22 +00003968static bool IsOperandAMemoryOperand(CallInst *CI, InlineAsm *IA, Value *OpVal,
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003969 const TargetLowering &TLI,
3970 const TargetRegisterInfo &TRI) {
Sanjay Patel4137d512017-06-07 14:29:52 +00003971 const Function *F = CI->getFunction();
Eric Christopherd75c00c2015-02-26 22:38:34 +00003972 TargetLowering::AsmOperandInfoVector TargetConstraints =
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003973 TLI.ParseConstraints(F->getParent()->getDataLayout(), &TRI,
Mehdi Amini8ac7a9d2015-07-07 19:07:19 +00003974 ImmutableCallSite(CI));
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003975
Chandler Carruthc8925912013-01-05 02:09:22 +00003976 for (unsigned i = 0, e = TargetConstraints.size(); i != e; ++i) {
3977 TargetLowering::AsmOperandInfo &OpInfo = TargetConstraints[i];
Stephen Lin837bba12013-07-15 17:55:02 +00003978
Chandler Carruthc8925912013-01-05 02:09:22 +00003979 // Compute the constraint code and ConstraintType to use.
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003980 TLI.ComputeConstraintToUse(OpInfo, SDValue());
Chandler Carruthc8925912013-01-05 02:09:22 +00003981
3982 // If this asm operand is our Value*, and if it isn't an indirect memory
3983 // operand, we can't fold it!
3984 if (OpInfo.CallOperandVal == OpVal &&
3985 (OpInfo.ConstraintType != TargetLowering::C_Memory ||
3986 !OpInfo.isIndirect))
3987 return false;
3988 }
3989
3990 return true;
3991}
3992
Sanjay Patel4ac6b112015-09-21 22:47:23 +00003993/// Recursively walk all the uses of I until we find a memory use.
3994/// If we find an obviously non-foldable instruction, return true.
Chandler Carruthc8925912013-01-05 02:09:22 +00003995/// Add the ultimately found memory instructions to MemoryUses.
Eric Christopher11e4df72015-02-26 22:38:43 +00003996static bool FindAllMemoryUses(
3997 Instruction *I,
3998 SmallVectorImpl<std::pair<Instruction *, unsigned>> &MemoryUses,
Igor Laevsky3be81ba2017-02-07 13:27:20 +00003999 SmallPtrSetImpl<Instruction *> &ConsideredInsts,
4000 const TargetLowering &TLI, const TargetRegisterInfo &TRI) {
Chandler Carruthc8925912013-01-05 02:09:22 +00004001 // If we already considered this instruction, we're done.
David Blaikie70573dc2014-11-19 07:49:26 +00004002 if (!ConsideredInsts.insert(I).second)
Chandler Carruthc8925912013-01-05 02:09:22 +00004003 return false;
Stephen Lin837bba12013-07-15 17:55:02 +00004004
Chandler Carruthc8925912013-01-05 02:09:22 +00004005 // If this is an obviously unfoldable instruction, bail out.
4006 if (!MightBeFoldableInst(I))
4007 return true;
4008
Philip Reamesac115ed2016-03-09 23:13:12 +00004009 const bool OptSize = I->getFunction()->optForSize();
4010
Chandler Carruthc8925912013-01-05 02:09:22 +00004011 // Loop over all the uses, recursively processing them.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004012 for (Use &U : I->uses()) {
4013 Instruction *UserI = cast<Instruction>(U.getUser());
Chandler Carruthc8925912013-01-05 02:09:22 +00004014
Chandler Carruthcdf47882014-03-09 03:16:01 +00004015 if (LoadInst *LI = dyn_cast<LoadInst>(UserI)) {
4016 MemoryUses.push_back(std::make_pair(LI, U.getOperandNo()));
Chandler Carruthc8925912013-01-05 02:09:22 +00004017 continue;
4018 }
Stephen Lin837bba12013-07-15 17:55:02 +00004019
Chandler Carruthcdf47882014-03-09 03:16:01 +00004020 if (StoreInst *SI = dyn_cast<StoreInst>(UserI)) {
4021 unsigned opNo = U.getOperandNo();
Matt Arsenault02d915b2017-03-15 22:35:20 +00004022 if (opNo != StoreInst::getPointerOperandIndex())
4023 return true; // Storing addr, not into addr.
Chandler Carruthc8925912013-01-05 02:09:22 +00004024 MemoryUses.push_back(std::make_pair(SI, opNo));
4025 continue;
4026 }
Stephen Lin837bba12013-07-15 17:55:02 +00004027
Matt Arsenault02d915b2017-03-15 22:35:20 +00004028 if (AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(UserI)) {
4029 unsigned opNo = U.getOperandNo();
4030 if (opNo != AtomicRMWInst::getPointerOperandIndex())
4031 return true; // Storing addr, not into addr.
4032 MemoryUses.push_back(std::make_pair(RMW, opNo));
4033 continue;
4034 }
4035
4036 if (AtomicCmpXchgInst *CmpX = dyn_cast<AtomicCmpXchgInst>(UserI)) {
4037 unsigned opNo = U.getOperandNo();
4038 if (opNo != AtomicCmpXchgInst::getPointerOperandIndex())
4039 return true; // Storing addr, not into addr.
4040 MemoryUses.push_back(std::make_pair(CmpX, opNo));
4041 continue;
4042 }
4043
Chandler Carruthcdf47882014-03-09 03:16:01 +00004044 if (CallInst *CI = dyn_cast<CallInst>(UserI)) {
Philip Reamesac115ed2016-03-09 23:13:12 +00004045 // If this is a cold call, we can sink the addressing calculation into
4046 // the cold path. See optimizeCallInst
4047 if (!OptSize && CI->hasFnAttr(Attribute::Cold))
4048 continue;
Junmo Park6098cbb2016-03-11 07:05:32 +00004049
Chandler Carruthc8925912013-01-05 02:09:22 +00004050 InlineAsm *IA = dyn_cast<InlineAsm>(CI->getCalledValue());
4051 if (!IA) return true;
Stephen Lin837bba12013-07-15 17:55:02 +00004052
Chandler Carruthc8925912013-01-05 02:09:22 +00004053 // If this is a memory operand, we're cool, otherwise bail out.
Igor Laevsky3be81ba2017-02-07 13:27:20 +00004054 if (!IsOperandAMemoryOperand(CI, IA, I, TLI, TRI))
Chandler Carruthc8925912013-01-05 02:09:22 +00004055 return true;
4056 continue;
4057 }
Stephen Lin837bba12013-07-15 17:55:02 +00004058
Igor Laevsky3be81ba2017-02-07 13:27:20 +00004059 if (FindAllMemoryUses(UserI, MemoryUses, ConsideredInsts, TLI, TRI))
Chandler Carruthc8925912013-01-05 02:09:22 +00004060 return true;
4061 }
4062
4063 return false;
4064}
4065
Sanjay Patel9fbe22b2015-10-09 18:01:03 +00004066/// Return true if Val is already known to be live at the use site that we're
4067/// folding it into. If so, there is no cost to include it in the addressing
4068/// mode. KnownLive1 and KnownLive2 are two values that we know are live at the
4069/// instruction already.
Sanjay Patelfc580a62015-09-21 23:03:16 +00004070bool AddressingModeMatcher::valueAlreadyLiveAtInst(Value *Val,Value *KnownLive1,
Chandler Carruthc8925912013-01-05 02:09:22 +00004071 Value *KnownLive2) {
4072 // If Val is either of the known-live values, we know it is live!
Craig Topperc0196b12014-04-14 00:51:57 +00004073 if (Val == nullptr || Val == KnownLive1 || Val == KnownLive2)
Chandler Carruthc8925912013-01-05 02:09:22 +00004074 return true;
Stephen Lin837bba12013-07-15 17:55:02 +00004075
Chandler Carruthc8925912013-01-05 02:09:22 +00004076 // All values other than instructions and arguments (e.g. constants) are live.
4077 if (!isa<Instruction>(Val) && !isa<Argument>(Val)) return true;
Stephen Lin837bba12013-07-15 17:55:02 +00004078
Chandler Carruthc8925912013-01-05 02:09:22 +00004079 // If Val is a constant sized alloca in the entry block, it is live, this is
4080 // true because it is just a reference to the stack/frame pointer, which is
4081 // live for the whole function.
4082 if (AllocaInst *AI = dyn_cast<AllocaInst>(Val))
4083 if (AI->isStaticAlloca())
4084 return true;
Stephen Lin837bba12013-07-15 17:55:02 +00004085
Chandler Carruthc8925912013-01-05 02:09:22 +00004086 // Check to see if this value is already used in the memory instruction's
4087 // block. If so, it's already live into the block at the very least, so we
4088 // can reasonably fold it.
4089 return Val->isUsedInBasicBlock(MemoryInst->getParent());
4090}
4091
Sanjay Patel4ac6b112015-09-21 22:47:23 +00004092/// It is possible for the addressing mode of the machine to fold the specified
4093/// instruction into a load or store that ultimately uses it.
4094/// However, the specified instruction has multiple uses.
4095/// Given this, it may actually increase register pressure to fold it
4096/// into the load. For example, consider this code:
Chandler Carruthc8925912013-01-05 02:09:22 +00004097///
4098/// X = ...
4099/// Y = X+1
4100/// use(Y) -> nonload/store
4101/// Z = Y+1
4102/// load Z
4103///
4104/// In this case, Y has multiple uses, and can be folded into the load of Z
4105/// (yielding load [X+2]). However, doing this will cause both "X" and "X+1" to
4106/// be live at the use(Y) line. If we don't fold Y into load Z, we use one
4107/// fewer register. Since Y can't be folded into "use(Y)" we don't increase the
4108/// number of computations either.
4109///
4110/// Note that this (like most of CodeGenPrepare) is just a rough heuristic. If
4111/// X was live across 'load Z' for other reasons, we actually *would* want to
4112/// fold the addressing mode in the Z case. This would make Y die earlier.
4113bool AddressingModeMatcher::
Sanjay Patelfc580a62015-09-21 23:03:16 +00004114isProfitableToFoldIntoAddressingMode(Instruction *I, ExtAddrMode &AMBefore,
Chandler Carruthc8925912013-01-05 02:09:22 +00004115 ExtAddrMode &AMAfter) {
4116 if (IgnoreProfitability) return true;
Stephen Lin837bba12013-07-15 17:55:02 +00004117
Chandler Carruthc8925912013-01-05 02:09:22 +00004118 // AMBefore is the addressing mode before this instruction was folded into it,
4119 // and AMAfter is the addressing mode after the instruction was folded. Get
4120 // the set of registers referenced by AMAfter and subtract out those
4121 // referenced by AMBefore: this is the set of values which folding in this
4122 // address extends the lifetime of.
4123 //
4124 // Note that there are only two potential values being referenced here,
4125 // BaseReg and ScaleReg (global addresses are always available, as are any
4126 // folded immediates).
4127 Value *BaseReg = AMAfter.BaseReg, *ScaledReg = AMAfter.ScaledReg;
Stephen Lin837bba12013-07-15 17:55:02 +00004128
Chandler Carruthc8925912013-01-05 02:09:22 +00004129 // If the BaseReg or ScaledReg was referenced by the previous addrmode, their
4130 // lifetime wasn't extended by adding this instruction.
Sanjay Patelfc580a62015-09-21 23:03:16 +00004131 if (valueAlreadyLiveAtInst(BaseReg, AMBefore.BaseReg, AMBefore.ScaledReg))
Craig Topperc0196b12014-04-14 00:51:57 +00004132 BaseReg = nullptr;
Sanjay Patelfc580a62015-09-21 23:03:16 +00004133 if (valueAlreadyLiveAtInst(ScaledReg, AMBefore.BaseReg, AMBefore.ScaledReg))
Craig Topperc0196b12014-04-14 00:51:57 +00004134 ScaledReg = nullptr;
Chandler Carruthc8925912013-01-05 02:09:22 +00004135
4136 // If folding this instruction (and it's subexprs) didn't extend any live
4137 // ranges, we're ok with it.
Craig Topperc0196b12014-04-14 00:51:57 +00004138 if (!BaseReg && !ScaledReg)
Chandler Carruthc8925912013-01-05 02:09:22 +00004139 return true;
4140
Philip Reamesac115ed2016-03-09 23:13:12 +00004141 // If all uses of this instruction can have the address mode sunk into them,
4142 // we can remove the addressing mode and effectively trade one live register
4143 // for another (at worst.) In this context, folding an addressing mode into
Junmo Park6098cbb2016-03-11 07:05:32 +00004144 // the use is just a particularly nice way of sinking it.
Chandler Carruthc8925912013-01-05 02:09:22 +00004145 SmallVector<std::pair<Instruction*,unsigned>, 16> MemoryUses;
4146 SmallPtrSet<Instruction*, 16> ConsideredInsts;
Igor Laevsky3be81ba2017-02-07 13:27:20 +00004147 if (FindAllMemoryUses(I, MemoryUses, ConsideredInsts, TLI, TRI))
Chandler Carruthc8925912013-01-05 02:09:22 +00004148 return false; // Has a non-memory, non-foldable use!
Stephen Lin837bba12013-07-15 17:55:02 +00004149
Chandler Carruthc8925912013-01-05 02:09:22 +00004150 // Now that we know that all uses of this instruction are part of a chain of
4151 // computation involving only operations that could theoretically be folded
Philip Reamesac115ed2016-03-09 23:13:12 +00004152 // into a memory use, loop over each of these memory operation uses and see
4153 // if they could *actually* fold the instruction. The assumption is that
4154 // addressing modes are cheap and that duplicating the computation involved
4155 // many times is worthwhile, even on a fastpath. For sinking candidates
4156 // (i.e. cold call sites), this serves as a way to prevent excessive code
4157 // growth since most architectures have some reasonable small and fast way to
4158 // compute an effective address. (i.e LEA on x86)
Chandler Carruthc8925912013-01-05 02:09:22 +00004159 SmallVector<Instruction*, 32> MatchedAddrModeInsts;
4160 for (unsigned i = 0, e = MemoryUses.size(); i != e; ++i) {
4161 Instruction *User = MemoryUses[i].first;
4162 unsigned OpNo = MemoryUses[i].second;
Stephen Lin837bba12013-07-15 17:55:02 +00004163
Chandler Carruthc8925912013-01-05 02:09:22 +00004164 // Get the access type of this use. If the use isn't a pointer, we don't
4165 // know what it accesses.
4166 Value *Address = User->getOperand(OpNo);
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00004167 PointerType *AddrTy = dyn_cast<PointerType>(Address->getType());
4168 if (!AddrTy)
Chandler Carruthc8925912013-01-05 02:09:22 +00004169 return false;
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00004170 Type *AddressAccessTy = AddrTy->getElementType();
4171 unsigned AS = AddrTy->getAddressSpace();
Stephen Lin837bba12013-07-15 17:55:02 +00004172
Chandler Carruthc8925912013-01-05 02:09:22 +00004173 // Do a match against the root of this address, ignoring profitability. This
4174 // will tell us if the addressing mode for the memory operation will
4175 // *actually* cover the shared instruction.
4176 ExtAddrMode Result;
Quentin Colombet5a69dda2014-02-11 01:59:02 +00004177 TypePromotionTransaction::ConstRestorationPt LastKnownGood =
4178 TPT.getRestorationPoint();
Igor Laevsky3be81ba2017-02-07 13:27:20 +00004179 AddressingModeMatcher Matcher(MatchedAddrModeInsts, TLI, TRI,
4180 AddressAccessTy, AS,
Ahmed Bougachaf3299142015-06-17 20:44:32 +00004181 MemoryInst, Result, InsertedInsts,
Quentin Colombet3a4bf042014-02-06 21:44:56 +00004182 PromotedInsts, TPT);
Chandler Carruthc8925912013-01-05 02:09:22 +00004183 Matcher.IgnoreProfitability = true;
Sanjay Patelfc580a62015-09-21 23:03:16 +00004184 bool Success = Matcher.matchAddr(Address, 0);
Chandler Carruthc8925912013-01-05 02:09:22 +00004185 (void)Success; assert(Success && "Couldn't select *anything*?");
4186
Quentin Colombet5a69dda2014-02-11 01:59:02 +00004187 // The match was to check the profitability, the changes made are not
4188 // part of the original matcher. Therefore, they should be dropped
4189 // otherwise the original matcher will not present the right state.
4190 TPT.rollback(LastKnownGood);
4191
Chandler Carruthc8925912013-01-05 02:09:22 +00004192 // If the match didn't cover I, then it won't be shared by it.
David Majnemer0d955d02016-08-11 22:21:41 +00004193 if (!is_contained(MatchedAddrModeInsts, I))
Chandler Carruthc8925912013-01-05 02:09:22 +00004194 return false;
Stephen Lin837bba12013-07-15 17:55:02 +00004195
Chandler Carruthc8925912013-01-05 02:09:22 +00004196 MatchedAddrModeInsts.clear();
4197 }
Stephen Lin837bba12013-07-15 17:55:02 +00004198
Chandler Carruthc8925912013-01-05 02:09:22 +00004199 return true;
4200}
4201
4202} // end anonymous namespace
4203
Sanjay Patel4ac6b112015-09-21 22:47:23 +00004204/// Return true if the specified values are defined in a
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004205/// different basic block than BB.
4206static bool IsNonLocalValue(Value *V, BasicBlock *BB) {
4207 if (Instruction *I = dyn_cast<Instruction>(V))
4208 return I->getParent() != BB;
4209 return false;
4210}
4211
Philip Reamesac115ed2016-03-09 23:13:12 +00004212/// Sink addressing mode computation immediate before MemoryInst if doing so
4213/// can be done without increasing register pressure. The need for the
4214/// register pressure constraint means this can end up being an all or nothing
4215/// decision for all uses of the same addressing computation.
4216///
Sanjay Patel4ac6b112015-09-21 22:47:23 +00004217/// Load and Store Instructions often have addressing modes that can do
4218/// significant amounts of computation. As such, instruction selection will try
4219/// to get the load or store to do as much computation as possible for the
4220/// program. The problem is that isel can only see within a single block. As
4221/// such, we sink as much legal addressing mode work into the block as possible.
Chris Lattner728f9022008-11-25 07:09:13 +00004222///
4223/// This method is used to optimize both load/store and inline asms with memory
Philip Reamesac115ed2016-03-09 23:13:12 +00004224/// operands. It's also used to sink addressing computations feeding into cold
4225/// call sites into their (cold) basic block.
4226///
4227/// The motivation for handling sinking into cold blocks is that doing so can
4228/// both enable other address mode sinking (by satisfying the register pressure
4229/// constraint above), and reduce register pressure globally (by removing the
4230/// addressing mode computation from the fast path entirely.).
Sanjay Patelfc580a62015-09-21 23:03:16 +00004231bool CodeGenPrepare::optimizeMemoryInst(Instruction *MemoryInst, Value *Addr,
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00004232 Type *AccessTy, unsigned AddrSpace) {
Owen Anderson8ba5f392010-11-27 08:15:55 +00004233 Value *Repl = Addr;
Nadav Rotem465834c2012-07-24 10:51:42 +00004234
4235 // Try to collapse single-value PHI nodes. This is necessary to undo
Owen Andersondfb8c3b2010-11-19 22:15:03 +00004236 // unprofitable PRE transformations.
Cameron Zwarich43cecb12011-01-03 06:33:01 +00004237 SmallVector<Value*, 8> worklist;
4238 SmallPtrSet<Value*, 16> Visited;
Owen Anderson8ba5f392010-11-27 08:15:55 +00004239 worklist.push_back(Addr);
Nadav Rotem465834c2012-07-24 10:51:42 +00004240
Owen Anderson8ba5f392010-11-27 08:15:55 +00004241 // Use a worklist to iteratively look through PHI nodes, and ensure that
4242 // the addressing mode obtained from the non-PHI roots of the graph
4243 // are equivalent.
Craig Topperc0196b12014-04-14 00:51:57 +00004244 Value *Consensus = nullptr;
Cameron Zwarichb7f8eaa2011-03-01 21:13:53 +00004245 unsigned NumUsesConsensus = 0;
Cameron Zwarich13c885d2011-03-05 08:12:26 +00004246 bool IsNumUsesConsensusValid = false;
Owen Anderson8ba5f392010-11-27 08:15:55 +00004247 SmallVector<Instruction*, 16> AddrModeInsts;
4248 ExtAddrMode AddrMode;
Jun Bum Limdee55652017-04-03 19:20:07 +00004249 TypePromotionTransaction TPT(RemovedInsts);
Quentin Colombet3a4bf042014-02-06 21:44:56 +00004250 TypePromotionTransaction::ConstRestorationPt LastKnownGood =
4251 TPT.getRestorationPoint();
Owen Anderson8ba5f392010-11-27 08:15:55 +00004252 while (!worklist.empty()) {
4253 Value *V = worklist.back();
4254 worklist.pop_back();
Nadav Rotem465834c2012-07-24 10:51:42 +00004255
Owen Anderson8ba5f392010-11-27 08:15:55 +00004256 // Break use-def graph loops.
David Blaikie70573dc2014-11-19 07:49:26 +00004257 if (!Visited.insert(V).second) {
Craig Topperc0196b12014-04-14 00:51:57 +00004258 Consensus = nullptr;
Owen Anderson8ba5f392010-11-27 08:15:55 +00004259 break;
Owen Andersondfb8c3b2010-11-19 22:15:03 +00004260 }
Nadav Rotem465834c2012-07-24 10:51:42 +00004261
Owen Anderson8ba5f392010-11-27 08:15:55 +00004262 // For a PHI node, push all of its incoming values.
4263 if (PHINode *P = dyn_cast<PHINode>(V)) {
Pete Cooper833f34d2015-05-12 20:05:31 +00004264 for (Value *IncValue : P->incoming_values())
4265 worklist.push_back(IncValue);
Owen Anderson8ba5f392010-11-27 08:15:55 +00004266 continue;
4267 }
Nadav Rotem465834c2012-07-24 10:51:42 +00004268
Philip Reamesac115ed2016-03-09 23:13:12 +00004269 // For non-PHIs, determine the addressing mode being computed. Note that
4270 // the result may differ depending on what other uses our candidate
4271 // addressing instructions might have.
Owen Anderson8ba5f392010-11-27 08:15:55 +00004272 SmallVector<Instruction*, 16> NewAddrModeInsts;
Quentin Colombet3a4bf042014-02-06 21:44:56 +00004273 ExtAddrMode NewAddrMode = AddressingModeMatcher::Match(
Igor Laevsky3be81ba2017-02-07 13:27:20 +00004274 V, AccessTy, AddrSpace, MemoryInst, NewAddrModeInsts, *TLI, *TRI,
Ahmed Bougachaf3299142015-06-17 20:44:32 +00004275 InsertedInsts, PromotedInsts, TPT);
Cameron Zwarich13c885d2011-03-05 08:12:26 +00004276
4277 // This check is broken into two cases with very similar code to avoid using
4278 // getNumUses() as much as possible. Some values have a lot of uses, so
4279 // calling getNumUses() unconditionally caused a significant compile-time
4280 // regression.
4281 if (!Consensus) {
4282 Consensus = V;
4283 AddrMode = NewAddrMode;
4284 AddrModeInsts = NewAddrModeInsts;
4285 continue;
4286 } else if (NewAddrMode == AddrMode) {
4287 if (!IsNumUsesConsensusValid) {
4288 NumUsesConsensus = Consensus->getNumUses();
4289 IsNumUsesConsensusValid = true;
4290 }
4291
4292 // Ensure that the obtained addressing mode is equivalent to that obtained
4293 // for all other roots of the PHI traversal. Also, when choosing one
4294 // such root as representative, select the one with the most uses in order
4295 // to keep the cost modeling heuristics in AddressingModeMatcher
4296 // applicable.
Cameron Zwarichb7f8eaa2011-03-01 21:13:53 +00004297 unsigned NumUses = V->getNumUses();
4298 if (NumUses > NumUsesConsensus) {
Owen Anderson8ba5f392010-11-27 08:15:55 +00004299 Consensus = V;
Cameron Zwarichb7f8eaa2011-03-01 21:13:53 +00004300 NumUsesConsensus = NumUses;
Owen Anderson8ba5f392010-11-27 08:15:55 +00004301 AddrModeInsts = NewAddrModeInsts;
4302 }
4303 continue;
4304 }
Nadav Rotem465834c2012-07-24 10:51:42 +00004305
Craig Topperc0196b12014-04-14 00:51:57 +00004306 Consensus = nullptr;
Owen Anderson8ba5f392010-11-27 08:15:55 +00004307 break;
Owen Andersondfb8c3b2010-11-19 22:15:03 +00004308 }
Nadav Rotem465834c2012-07-24 10:51:42 +00004309
Owen Anderson8ba5f392010-11-27 08:15:55 +00004310 // If the addressing mode couldn't be determined, or if multiple different
4311 // ones were determined, bail out now.
Quentin Colombet3a4bf042014-02-06 21:44:56 +00004312 if (!Consensus) {
4313 TPT.rollback(LastKnownGood);
4314 return false;
4315 }
4316 TPT.commit();
Nadav Rotem465834c2012-07-24 10:51:42 +00004317
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004318 // If all the instructions matched are already in this BB, don't do anything.
Justin Lebar838c7f52016-11-21 22:49:11 +00004319 if (none_of(AddrModeInsts, [&](Value *V) {
4320 return IsNonLocalValue(V, MemoryInst->getParent());
4321 })) {
David Greene74e2d492010-01-05 01:27:11 +00004322 DEBUG(dbgs() << "CGP: Found local addrmode: " << AddrMode << "\n");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004323 return false;
4324 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00004325
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004326 // Insert this computation right after this user. Since our caller is
4327 // scanning from the top of the BB to the bottom, reuse of the expr are
4328 // guaranteed to happen later.
Devang Patelc10e52a2011-09-06 18:49:53 +00004329 IRBuilder<> Builder(MemoryInst);
Eric Christopherc1ea1492008-09-24 05:32:41 +00004330
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004331 // Now that we determined the addressing expression we want to use and know
4332 // that we have to sink it into this block. Check to see if we have already
4333 // done this for some other load/store instr in this block. If so, reuse the
4334 // computation.
4335 Value *&SunkAddr = SunkAddrs[Addr];
4336 if (SunkAddr) {
David Greene74e2d492010-01-05 01:27:11 +00004337 DEBUG(dbgs() << "CGP: Reusing nonlocal addrmode: " << AddrMode << " for "
Louis Gerbarg1b91aa22014-05-13 21:54:22 +00004338 << *MemoryInst << "\n");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004339 if (SunkAddr->getType() != Addr->getType())
Eli Friedmanc12a5a72017-02-24 20:51:36 +00004340 SunkAddr = Builder.CreatePointerCast(SunkAddr, Addr->getType());
Eric Christopherfccff372015-01-27 01:01:38 +00004341 } else if (AddrSinkUsingGEPs ||
4342 (!AddrSinkUsingGEPs.getNumOccurrences() && TM &&
Igor Laevsky3be81ba2017-02-07 13:27:20 +00004343 SubtargetInfo->useAA())) {
Hal Finkelc3998302014-04-12 00:59:48 +00004344 // By default, we use the GEP-based method when AA is used later. This
4345 // prevents new inttoptr/ptrtoint pairs from degrading AA capabilities.
4346 DEBUG(dbgs() << "CGP: SINKING nonlocal addrmode: " << AddrMode << " for "
Louis Gerbarg1b91aa22014-05-13 21:54:22 +00004347 << *MemoryInst << "\n");
Mehdi Amini4fe37982015-07-07 18:45:17 +00004348 Type *IntPtrTy = DL->getIntPtrType(Addr->getType());
Craig Topperc0196b12014-04-14 00:51:57 +00004349 Value *ResultPtr = nullptr, *ResultIndex = nullptr;
Hal Finkelc3998302014-04-12 00:59:48 +00004350
4351 // First, find the pointer.
4352 if (AddrMode.BaseReg && AddrMode.BaseReg->getType()->isPointerTy()) {
4353 ResultPtr = AddrMode.BaseReg;
Craig Topperc0196b12014-04-14 00:51:57 +00004354 AddrMode.BaseReg = nullptr;
Hal Finkelc3998302014-04-12 00:59:48 +00004355 }
4356
4357 if (AddrMode.Scale && AddrMode.ScaledReg->getType()->isPointerTy()) {
4358 // We can't add more than one pointer together, nor can we scale a
4359 // pointer (both of which seem meaningless).
4360 if (ResultPtr || AddrMode.Scale != 1)
4361 return false;
4362
4363 ResultPtr = AddrMode.ScaledReg;
4364 AddrMode.Scale = 0;
4365 }
4366
4367 if (AddrMode.BaseGV) {
4368 if (ResultPtr)
4369 return false;
4370
4371 ResultPtr = AddrMode.BaseGV;
4372 }
4373
4374 // If the real base value actually came from an inttoptr, then the matcher
4375 // will look through it and provide only the integer value. In that case,
4376 // use it here.
4377 if (!ResultPtr && AddrMode.BaseReg) {
4378 ResultPtr =
4379 Builder.CreateIntToPtr(AddrMode.BaseReg, Addr->getType(), "sunkaddr");
Craig Topperc0196b12014-04-14 00:51:57 +00004380 AddrMode.BaseReg = nullptr;
Hal Finkelc3998302014-04-12 00:59:48 +00004381 } else if (!ResultPtr && AddrMode.Scale == 1) {
4382 ResultPtr =
4383 Builder.CreateIntToPtr(AddrMode.ScaledReg, Addr->getType(), "sunkaddr");
4384 AddrMode.Scale = 0;
4385 }
4386
4387 if (!ResultPtr &&
4388 !AddrMode.BaseReg && !AddrMode.Scale && !AddrMode.BaseOffs) {
4389 SunkAddr = Constant::getNullValue(Addr->getType());
4390 } else if (!ResultPtr) {
4391 return false;
4392 } else {
4393 Type *I8PtrTy =
David Blaikie3909da72015-03-30 20:42:56 +00004394 Builder.getInt8PtrTy(Addr->getType()->getPointerAddressSpace());
4395 Type *I8Ty = Builder.getInt8Ty();
Hal Finkelc3998302014-04-12 00:59:48 +00004396
4397 // Start with the base register. Do this first so that subsequent address
4398 // matching finds it last, which will prevent it from trying to match it
4399 // as the scaled value in case it happens to be a mul. That would be
4400 // problematic if we've sunk a different mul for the scale, because then
4401 // we'd end up sinking both muls.
4402 if (AddrMode.BaseReg) {
4403 Value *V = AddrMode.BaseReg;
4404 if (V->getType() != IntPtrTy)
4405 V = Builder.CreateIntCast(V, IntPtrTy, /*isSigned=*/true, "sunkaddr");
4406
4407 ResultIndex = V;
4408 }
4409
4410 // Add the scale value.
4411 if (AddrMode.Scale) {
4412 Value *V = AddrMode.ScaledReg;
4413 if (V->getType() == IntPtrTy) {
4414 // done.
4415 } else if (cast<IntegerType>(IntPtrTy)->getBitWidth() <
4416 cast<IntegerType>(V->getType())->getBitWidth()) {
4417 V = Builder.CreateTrunc(V, IntPtrTy, "sunkaddr");
4418 } else {
4419 // It is only safe to sign extend the BaseReg if we know that the math
4420 // required to create it did not overflow before we extend it. Since
4421 // the original IR value was tossed in favor of a constant back when
4422 // the AddrMode was created we need to bail out gracefully if widths
4423 // do not match instead of extending it.
4424 Instruction *I = dyn_cast_or_null<Instruction>(ResultIndex);
4425 if (I && (ResultIndex != AddrMode.BaseReg))
4426 I->eraseFromParent();
4427 return false;
4428 }
4429
4430 if (AddrMode.Scale != 1)
4431 V = Builder.CreateMul(V, ConstantInt::get(IntPtrTy, AddrMode.Scale),
4432 "sunkaddr");
4433 if (ResultIndex)
4434 ResultIndex = Builder.CreateAdd(ResultIndex, V, "sunkaddr");
4435 else
4436 ResultIndex = V;
4437 }
4438
4439 // Add in the Base Offset if present.
4440 if (AddrMode.BaseOffs) {
4441 Value *V = ConstantInt::get(IntPtrTy, AddrMode.BaseOffs);
4442 if (ResultIndex) {
NAKAMURA Takumif51a34e2014-10-29 15:23:11 +00004443 // We need to add this separately from the scale above to help with
4444 // SDAG consecutive load/store merging.
Hal Finkelc3998302014-04-12 00:59:48 +00004445 if (ResultPtr->getType() != I8PtrTy)
Eli Friedmanc12a5a72017-02-24 20:51:36 +00004446 ResultPtr = Builder.CreatePointerCast(ResultPtr, I8PtrTy);
David Blaikie3909da72015-03-30 20:42:56 +00004447 ResultPtr = Builder.CreateGEP(I8Ty, ResultPtr, ResultIndex, "sunkaddr");
Hal Finkelc3998302014-04-12 00:59:48 +00004448 }
4449
4450 ResultIndex = V;
4451 }
4452
4453 if (!ResultIndex) {
4454 SunkAddr = ResultPtr;
4455 } else {
4456 if (ResultPtr->getType() != I8PtrTy)
Eli Friedmanc12a5a72017-02-24 20:51:36 +00004457 ResultPtr = Builder.CreatePointerCast(ResultPtr, I8PtrTy);
David Blaikie3909da72015-03-30 20:42:56 +00004458 SunkAddr = Builder.CreateGEP(I8Ty, ResultPtr, ResultIndex, "sunkaddr");
Hal Finkelc3998302014-04-12 00:59:48 +00004459 }
4460
4461 if (SunkAddr->getType() != Addr->getType())
Eli Friedmanc12a5a72017-02-24 20:51:36 +00004462 SunkAddr = Builder.CreatePointerCast(SunkAddr, Addr->getType());
Hal Finkelc3998302014-04-12 00:59:48 +00004463 }
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004464 } else {
David Greene74e2d492010-01-05 01:27:11 +00004465 DEBUG(dbgs() << "CGP: SINKING nonlocal addrmode: " << AddrMode << " for "
Louis Gerbarg1b91aa22014-05-13 21:54:22 +00004466 << *MemoryInst << "\n");
Mehdi Amini4fe37982015-07-07 18:45:17 +00004467 Type *IntPtrTy = DL->getIntPtrType(Addr->getType());
Craig Topperc0196b12014-04-14 00:51:57 +00004468 Value *Result = nullptr;
Dan Gohmanca194452010-01-19 22:45:06 +00004469
4470 // Start with the base register. Do this first so that subsequent address
4471 // matching finds it last, which will prevent it from trying to match it
4472 // as the scaled value in case it happens to be a mul. That would be
4473 // problematic if we've sunk a different mul for the scale, because then
4474 // we'd end up sinking both muls.
4475 if (AddrMode.BaseReg) {
4476 Value *V = AddrMode.BaseReg;
Duncan Sands19d0b472010-02-16 11:11:14 +00004477 if (V->getType()->isPointerTy())
Devang Patelc10e52a2011-09-06 18:49:53 +00004478 V = Builder.CreatePtrToInt(V, IntPtrTy, "sunkaddr");
Dan Gohmanca194452010-01-19 22:45:06 +00004479 if (V->getType() != IntPtrTy)
Devang Patelc10e52a2011-09-06 18:49:53 +00004480 V = Builder.CreateIntCast(V, IntPtrTy, /*isSigned=*/true, "sunkaddr");
Dan Gohmanca194452010-01-19 22:45:06 +00004481 Result = V;
4482 }
4483
4484 // Add the scale value.
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004485 if (AddrMode.Scale) {
4486 Value *V = AddrMode.ScaledReg;
4487 if (V->getType() == IntPtrTy) {
4488 // done.
Duncan Sands19d0b472010-02-16 11:11:14 +00004489 } else if (V->getType()->isPointerTy()) {
Devang Patelc10e52a2011-09-06 18:49:53 +00004490 V = Builder.CreatePtrToInt(V, IntPtrTy, "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004491 } else if (cast<IntegerType>(IntPtrTy)->getBitWidth() <
4492 cast<IntegerType>(V->getType())->getBitWidth()) {
Devang Patelc10e52a2011-09-06 18:49:53 +00004493 V = Builder.CreateTrunc(V, IntPtrTy, "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004494 } else {
Jim Grosbached2cd392014-03-26 17:27:01 +00004495 // It is only safe to sign extend the BaseReg if we know that the math
4496 // required to create it did not overflow before we extend it. Since
4497 // the original IR value was tossed in favor of a constant back when
4498 // the AddrMode was created we need to bail out gracefully if widths
4499 // do not match instead of extending it.
Joey Gouly12a8bf02014-05-13 15:42:45 +00004500 Instruction *I = dyn_cast_or_null<Instruction>(Result);
Jim Grosbach83b44e12014-04-10 00:27:45 +00004501 if (I && (Result != AddrMode.BaseReg))
4502 I->eraseFromParent();
Jim Grosbached2cd392014-03-26 17:27:01 +00004503 return false;
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004504 }
4505 if (AddrMode.Scale != 1)
Devang Patelc10e52a2011-09-06 18:49:53 +00004506 V = Builder.CreateMul(V, ConstantInt::get(IntPtrTy, AddrMode.Scale),
4507 "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004508 if (Result)
Devang Patelc10e52a2011-09-06 18:49:53 +00004509 Result = Builder.CreateAdd(Result, V, "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004510 else
4511 Result = V;
4512 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00004513
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004514 // Add in the BaseGV if present.
4515 if (AddrMode.BaseGV) {
Devang Patelc10e52a2011-09-06 18:49:53 +00004516 Value *V = Builder.CreatePtrToInt(AddrMode.BaseGV, IntPtrTy, "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004517 if (Result)
Devang Patelc10e52a2011-09-06 18:49:53 +00004518 Result = Builder.CreateAdd(Result, V, "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004519 else
4520 Result = V;
4521 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00004522
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004523 // Add in the Base Offset if present.
4524 if (AddrMode.BaseOffs) {
Owen Andersonedb4a702009-07-24 23:12:02 +00004525 Value *V = ConstantInt::get(IntPtrTy, AddrMode.BaseOffs);
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004526 if (Result)
Devang Patelc10e52a2011-09-06 18:49:53 +00004527 Result = Builder.CreateAdd(Result, V, "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004528 else
4529 Result = V;
4530 }
4531
Craig Topperc0196b12014-04-14 00:51:57 +00004532 if (!Result)
Owen Anderson5a1acd92009-07-31 20:28:14 +00004533 SunkAddr = Constant::getNullValue(Addr->getType());
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004534 else
Devang Patelc10e52a2011-09-06 18:49:53 +00004535 SunkAddr = Builder.CreateIntToPtr(Result, Addr->getType(), "sunkaddr");
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004536 }
Eric Christopherc1ea1492008-09-24 05:32:41 +00004537
Owen Andersondfb8c3b2010-11-19 22:15:03 +00004538 MemoryInst->replaceUsesOfWith(Repl, SunkAddr);
Eric Christopherc1ea1492008-09-24 05:32:41 +00004539
Chris Lattneraf1bcce2011-04-09 07:05:44 +00004540 // If we have no uses, recursively delete the value and all dead instructions
4541 // using it.
Owen Andersondfb8c3b2010-11-19 22:15:03 +00004542 if (Repl->use_empty()) {
Chris Lattneraf1bcce2011-04-09 07:05:44 +00004543 // This can cause recursive deletion, which can invalidate our iterator.
Sanjoy Dase6bca0e2017-05-01 17:07:49 +00004544 // Use a WeakTrackingVH to hold onto it in case this happens.
Duncan P. N. Exon Smith7b269642016-02-21 19:37:45 +00004545 Value *CurValue = &*CurInstIterator;
Sanjoy Dase6bca0e2017-05-01 17:07:49 +00004546 WeakTrackingVH IterHandle(CurValue);
Chris Lattneraf1bcce2011-04-09 07:05:44 +00004547 BasicBlock *BB = CurInstIterator->getParent();
Nadav Rotem465834c2012-07-24 10:51:42 +00004548
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00004549 RecursivelyDeleteTriviallyDeadInstructions(Repl, TLInfo);
Chris Lattneraf1bcce2011-04-09 07:05:44 +00004550
Duncan P. N. Exon Smith7b269642016-02-21 19:37:45 +00004551 if (IterHandle != CurValue) {
Chris Lattneraf1bcce2011-04-09 07:05:44 +00004552 // If the iterator instruction was recursively deleted, start over at the
4553 // start of the block.
4554 CurInstIterator = BB->begin();
4555 SunkAddrs.clear();
Nadav Rotem465834c2012-07-24 10:51:42 +00004556 }
Dale Johannesenb67a6e662010-03-31 20:37:15 +00004557 }
Cameron Zwarichced753f2011-01-05 17:27:27 +00004558 ++NumMemoryInsts;
Chris Lattnerfeee64e2007-04-13 20:30:56 +00004559 return true;
4560}
4561
Sanjay Patel4ac6b112015-09-21 22:47:23 +00004562/// If there are any memory operands, use OptimizeMemoryInst to sink their
4563/// address computing into the block when possible / profitable.
Sanjay Patelfc580a62015-09-21 23:03:16 +00004564bool CodeGenPrepare::optimizeInlineAsmInst(CallInst *CS) {
Evan Cheng1da25002008-02-26 02:42:37 +00004565 bool MadeChange = false;
Evan Cheng1da25002008-02-26 02:42:37 +00004566
Eric Christopher11e4df72015-02-26 22:38:43 +00004567 const TargetRegisterInfo *TRI =
Sanjay Patel4137d512017-06-07 14:29:52 +00004568 TM->getSubtargetImpl(*CS->getFunction())->getRegisterInfo();
Mehdi Amini8ac7a9d2015-07-07 19:07:19 +00004569 TargetLowering::AsmOperandInfoVector TargetConstraints =
4570 TLI->ParseConstraints(*DL, TRI, CS);
Dale Johannesenf95f59a2010-09-16 18:30:55 +00004571 unsigned ArgNo = 0;
John Thompson1094c802010-09-13 18:15:37 +00004572 for (unsigned i = 0, e = TargetConstraints.size(); i != e; ++i) {
4573 TargetLowering::AsmOperandInfo &OpInfo = TargetConstraints[i];
Nadav Rotem465834c2012-07-24 10:51:42 +00004574
Evan Cheng1da25002008-02-26 02:42:37 +00004575 // Compute the constraint code and ConstraintType to use.
Dale Johannesence97d552010-06-25 21:55:36 +00004576 TLI->ComputeConstraintToUse(OpInfo, SDValue());
Evan Cheng1da25002008-02-26 02:42:37 +00004577
Eli Friedman666bbe32008-02-26 18:37:49 +00004578 if (OpInfo.ConstraintType == TargetLowering::C_Memory &&
4579 OpInfo.isIndirect) {
Chris Lattner7a277142011-01-15 07:14:54 +00004580 Value *OpVal = CS->getArgOperand(ArgNo++);
Sanjay Patelfc580a62015-09-21 23:03:16 +00004581 MadeChange |= optimizeMemoryInst(CS, OpVal, OpVal->getType(), ~0u);
Dale Johannesenf95f59a2010-09-16 18:30:55 +00004582 } else if (OpInfo.Type == InlineAsm::isInput)
4583 ArgNo++;
Evan Cheng1da25002008-02-26 02:42:37 +00004584 }
4585
4586 return MadeChange;
4587}
4588
Jun Bum Lim42301012017-03-17 19:05:21 +00004589/// \brief Check if all the uses of \p Val are equivalent (or free) zero or
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004590/// sign extensions.
Jun Bum Lim42301012017-03-17 19:05:21 +00004591static bool hasSameExtUse(Value *Val, const TargetLowering &TLI) {
4592 assert(!Val->use_empty() && "Input must have at least one use");
4593 const Instruction *FirstUser = cast<Instruction>(*Val->user_begin());
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004594 bool IsSExt = isa<SExtInst>(FirstUser);
4595 Type *ExtTy = FirstUser->getType();
Jun Bum Lim42301012017-03-17 19:05:21 +00004596 for (const User *U : Val->users()) {
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004597 const Instruction *UI = cast<Instruction>(U);
4598 if ((IsSExt && !isa<SExtInst>(UI)) || (!IsSExt && !isa<ZExtInst>(UI)))
4599 return false;
4600 Type *CurTy = UI->getType();
4601 // Same input and output types: Same instruction after CSE.
4602 if (CurTy == ExtTy)
4603 continue;
4604
4605 // If IsSExt is true, we are in this situation:
Jun Bum Lim42301012017-03-17 19:05:21 +00004606 // a = Val
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004607 // b = sext ty1 a to ty2
4608 // c = sext ty1 a to ty3
4609 // Assuming ty2 is shorter than ty3, this could be turned into:
Jun Bum Lim42301012017-03-17 19:05:21 +00004610 // a = Val
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004611 // b = sext ty1 a to ty2
4612 // c = sext ty2 b to ty3
4613 // However, the last sext is not free.
4614 if (IsSExt)
4615 return false;
4616
4617 // This is a ZExt, maybe this is free to extend from one type to another.
4618 // In that case, we would not account for a different use.
4619 Type *NarrowTy;
4620 Type *LargeTy;
4621 if (ExtTy->getScalarType()->getIntegerBitWidth() >
4622 CurTy->getScalarType()->getIntegerBitWidth()) {
4623 NarrowTy = CurTy;
4624 LargeTy = ExtTy;
4625 } else {
4626 NarrowTy = ExtTy;
4627 LargeTy = CurTy;
4628 }
4629
4630 if (!TLI.isZExtFree(NarrowTy, LargeTy))
4631 return false;
4632 }
4633 // All uses are the same or can be derived from one another for free.
4634 return true;
4635}
4636
Jun Bum Lim42301012017-03-17 19:05:21 +00004637/// \brief Try to speculatively promote extensions in \p Exts and continue
4638/// promoting through newly promoted operands recursively as far as doing so is
4639/// profitable. Save extensions profitably moved up, in \p ProfitablyMovedExts.
4640/// When some promotion happened, \p TPT contains the proper state to revert
4641/// them.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004642///
Jun Bum Lim42301012017-03-17 19:05:21 +00004643/// \return true if some promotion happened, false otherwise.
Jun Bum Lim42301012017-03-17 19:05:21 +00004644bool CodeGenPrepare::tryToPromoteExts(
4645 TypePromotionTransaction &TPT, const SmallVectorImpl<Instruction *> &Exts,
4646 SmallVectorImpl<Instruction *> &ProfitablyMovedExts,
4647 unsigned CreatedInstsCost) {
4648 bool Promoted = false;
4649
4650 // Iterate over all the extensions to try to promote them.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004651 for (auto I : Exts) {
Jun Bum Lim42301012017-03-17 19:05:21 +00004652 // Early check if we directly have ext(load).
4653 if (isa<LoadInst>(I->getOperand(0))) {
4654 ProfitablyMovedExts.push_back(I);
4655 continue;
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004656 }
Jun Bum Lim42301012017-03-17 19:05:21 +00004657
4658 // Check whether or not we want to do any promotion. The reason we have
4659 // this check inside the for loop is to catch the case where an extension
4660 // is directly fed by a load because in such case the extension can be moved
4661 // up without any promotion on its operands.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004662 if (!TLI || !TLI->enableExtLdPromotion() || DisableExtLdPromotion)
Jun Bum Lim42301012017-03-17 19:05:21 +00004663 return false;
4664
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004665 // Get the action to perform the promotion.
Jun Bum Lim42301012017-03-17 19:05:21 +00004666 TypePromotionHelper::Action TPH =
4667 TypePromotionHelper::getAction(I, InsertedInsts, *TLI, PromotedInsts);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004668 // Check if we can promote.
Jun Bum Lim42301012017-03-17 19:05:21 +00004669 if (!TPH) {
4670 // Save the current extension as we cannot move up through its operand.
4671 ProfitablyMovedExts.push_back(I);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004672 continue;
Jun Bum Lim42301012017-03-17 19:05:21 +00004673 }
4674
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004675 // Save the current state.
4676 TypePromotionTransaction::ConstRestorationPt LastKnownGood =
4677 TPT.getRestorationPoint();
4678 SmallVector<Instruction *, 4> NewExts;
Quentin Colombet1b274f92015-03-10 21:48:15 +00004679 unsigned NewCreatedInstsCost = 0;
4680 unsigned ExtCost = !TLI->isExtFree(I);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004681 // Promote.
Quentin Colombet1b274f92015-03-10 21:48:15 +00004682 Value *PromotedVal = TPH(I, TPT, PromotedInsts, NewCreatedInstsCost,
4683 &NewExts, nullptr, *TLI);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004684 assert(PromotedVal &&
4685 "TypePromotionHelper should have filtered out those cases");
4686
4687 // We would be able to merge only one extension in a load.
4688 // Therefore, if we have more than 1 new extension we heuristically
4689 // cut this search path, because it means we degrade the code quality.
4690 // With exactly 2, the transformation is neutral, because we will merge
4691 // one extension but leave one. However, we optimistically keep going,
4692 // because the new extension may be removed too.
Quentin Colombet1b274f92015-03-10 21:48:15 +00004693 long long TotalCreatedInstsCost = CreatedInstsCost + NewCreatedInstsCost;
Jun Bum Limb99a06b2017-01-27 17:16:37 +00004694 // FIXME: It would be possible to propagate a negative value instead of
Jun Bum Lim42301012017-03-17 19:05:21 +00004695 // conservatively ceiling it to 0.
Jun Bum Limb99a06b2017-01-27 17:16:37 +00004696 TotalCreatedInstsCost =
4697 std::max((long long)0, (TotalCreatedInstsCost - ExtCost));
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004698 if (!StressExtLdPromotion &&
Quentin Colombet1b274f92015-03-10 21:48:15 +00004699 (TotalCreatedInstsCost > 1 ||
Mehdi Amini44ede332015-07-09 02:09:04 +00004700 !isPromotedInstructionLegal(*TLI, *DL, PromotedVal))) {
Jun Bum Lim42301012017-03-17 19:05:21 +00004701 // This promotion is not profitable, rollback to the previous state, and
4702 // save the current extension in ProfitablyMovedExts as the latest
4703 // speculative promotion turned out to be unprofitable.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004704 TPT.rollback(LastKnownGood);
Jun Bum Lim42301012017-03-17 19:05:21 +00004705 ProfitablyMovedExts.push_back(I);
4706 continue;
4707 }
4708 // Continue promoting NewExts as far as doing so is profitable.
4709 SmallVector<Instruction *, 2> NewlyMovedExts;
4710 (void)tryToPromoteExts(TPT, NewExts, NewlyMovedExts, TotalCreatedInstsCost);
4711 bool NewPromoted = false;
4712 for (auto ExtInst : NewlyMovedExts) {
4713 Instruction *MovedExt = cast<Instruction>(ExtInst);
4714 Value *ExtOperand = MovedExt->getOperand(0);
4715 // If we have reached to a load, we need this extra profitability check
4716 // as it could potentially be merged into an ext(load).
4717 if (isa<LoadInst>(ExtOperand) &&
4718 !(StressExtLdPromotion || NewCreatedInstsCost <= ExtCost ||
4719 (ExtOperand->hasOneUse() || hasSameExtUse(ExtOperand, *TLI))))
4720 continue;
4721
4722 ProfitablyMovedExts.push_back(MovedExt);
4723 NewPromoted = true;
4724 }
4725
4726 // If none of speculative promotions for NewExts is profitable, rollback
4727 // and save the current extension (I) as the last profitable extension.
4728 if (!NewPromoted) {
4729 TPT.rollback(LastKnownGood);
4730 ProfitablyMovedExts.push_back(I);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004731 continue;
4732 }
4733 // The promotion is profitable.
Jun Bum Lim42301012017-03-17 19:05:21 +00004734 Promoted = true;
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004735 }
Jun Bum Lim42301012017-03-17 19:05:21 +00004736 return Promoted;
4737}
4738
Jun Bum Limdee55652017-04-03 19:20:07 +00004739/// Merging redundant sexts when one is dominating the other.
4740bool CodeGenPrepare::mergeSExts(Function &F) {
4741 DominatorTree DT(F);
4742 bool Changed = false;
4743 for (auto &Entry : ValToSExtendedUses) {
4744 SExts &Insts = Entry.second;
4745 SExts CurPts;
4746 for (Instruction *Inst : Insts) {
4747 if (RemovedInsts.count(Inst) || !isa<SExtInst>(Inst) ||
4748 Inst->getOperand(0) != Entry.first)
4749 continue;
4750 bool inserted = false;
4751 for (auto &Pt : CurPts) {
4752 if (DT.dominates(Inst, Pt)) {
4753 Pt->replaceAllUsesWith(Inst);
4754 RemovedInsts.insert(Pt);
4755 Pt->removeFromParent();
4756 Pt = Inst;
4757 inserted = true;
4758 Changed = true;
4759 break;
4760 }
4761 if (!DT.dominates(Pt, Inst))
4762 // Give up if we need to merge in a common dominator as the
4763 // expermients show it is not profitable.
4764 continue;
4765 Inst->replaceAllUsesWith(Pt);
4766 RemovedInsts.insert(Inst);
4767 Inst->removeFromParent();
4768 inserted = true;
4769 Changed = true;
4770 break;
4771 }
4772 if (!inserted)
4773 CurPts.push_back(Inst);
4774 }
4775 }
4776 return Changed;
4777}
4778
Jun Bum Lim42301012017-03-17 19:05:21 +00004779/// Return true, if an ext(load) can be formed from an extension in
4780/// \p MovedExts.
4781bool CodeGenPrepare::canFormExtLd(
4782 const SmallVectorImpl<Instruction *> &MovedExts, LoadInst *&LI,
4783 Instruction *&Inst, bool HasPromoted) {
4784 for (auto *MovedExtInst : MovedExts) {
4785 if (isa<LoadInst>(MovedExtInst->getOperand(0))) {
4786 LI = cast<LoadInst>(MovedExtInst->getOperand(0));
4787 Inst = MovedExtInst;
4788 break;
4789 }
4790 }
4791 if (!LI)
4792 return false;
4793
4794 // If they're already in the same block, there's nothing to do.
4795 // Make the cheap checks first if we did not promote.
4796 // If we promoted, we need to check if it is indeed profitable.
4797 if (!HasPromoted && LI->getParent() == Inst->getParent())
4798 return false;
4799
4800 EVT VT = TLI->getValueType(*DL, Inst->getType());
4801 EVT LoadVT = TLI->getValueType(*DL, LI->getType());
4802
4803 // If the load has other users and the truncate is not free, this probably
4804 // isn't worthwhile.
4805 if (!LI->hasOneUse() && (TLI->isTypeLegal(LoadVT) || !TLI->isTypeLegal(VT)) &&
4806 !TLI->isTruncateFree(Inst->getType(), LI->getType()))
4807 return false;
4808
4809 // Check whether the target supports casts folded into loads.
4810 unsigned LType;
4811 if (isa<ZExtInst>(Inst))
4812 LType = ISD::ZEXTLOAD;
4813 else {
4814 assert(isa<SExtInst>(Inst) && "Unexpected ext type!");
4815 LType = ISD::SEXTLOAD;
4816 }
4817
4818 return TLI->isLoadExtLegal(LType, VT, LoadVT);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004819}
4820
Sanjay Patel4ac6b112015-09-21 22:47:23 +00004821/// Move a zext or sext fed by a load into the same basic block as the load,
4822/// unless conditions are unfavorable. This allows SelectionDAG to fold the
4823/// extend into the load.
Dan Gohman99429a02009-10-16 20:59:35 +00004824///
Jun Bum Limdee55652017-04-03 19:20:07 +00004825/// E.g.,
4826/// \code
4827/// %ld = load i32* %addr
4828/// %add = add nuw i32 %ld, 4
4829/// %zext = zext i32 %add to i64
4830// \endcode
4831/// =>
4832/// \code
4833/// %ld = load i32* %addr
4834/// %zext = zext i32 %ld to i64
4835/// %add = add nuw i64 %zext, 4
4836/// \encode
4837/// Note that the promotion in %add to i64 is done in tryToPromoteExts(), which
4838/// allow us to match zext(load i32*) to i64.
4839///
4840/// Also, try to promote the computations used to obtain a sign extended
4841/// value used into memory accesses.
4842/// E.g.,
4843/// \code
4844/// a = add nsw i32 b, 3
4845/// d = sext i32 a to i64
4846/// e = getelementptr ..., i64 d
4847/// \endcode
4848/// =>
4849/// \code
4850/// f = sext i32 b to i64
4851/// a = add nsw i64 f, 3
4852/// e = getelementptr ..., i64 a
4853/// \endcode
4854///
4855/// \p Inst[in/out] the extension may be modified during the process if some
4856/// promotions apply.
4857bool CodeGenPrepare::optimizeExt(Instruction *&Inst) {
4858 // ExtLoad formation and address type promotion infrastructure requires TLI to
4859 // be effective.
Chandler Carruth0f139b42016-11-04 06:54:00 +00004860 if (!TLI)
4861 return false;
4862
Jun Bum Limdee55652017-04-03 19:20:07 +00004863 bool AllowPromotionWithoutCommonHeader = false;
4864 /// See if it is an interesting sext operations for the address type
4865 /// promotion before trying to promote it, e.g., the ones with the right
4866 /// type and used in memory accesses.
4867 bool ATPConsiderable = TTI->shouldConsiderAddressTypePromotion(
4868 *Inst, AllowPromotionWithoutCommonHeader);
4869 TypePromotionTransaction TPT(RemovedInsts);
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004870 TypePromotionTransaction::ConstRestorationPt LastKnownGood =
Jun Bum Lim42301012017-03-17 19:05:21 +00004871 TPT.getRestorationPoint();
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004872 SmallVector<Instruction *, 1> Exts;
Jun Bum Limdee55652017-04-03 19:20:07 +00004873 SmallVector<Instruction *, 2> SpeculativelyMovedExts;
4874 Exts.push_back(Inst);
Jun Bum Lim42301012017-03-17 19:05:21 +00004875
Jun Bum Limdee55652017-04-03 19:20:07 +00004876 bool HasPromoted = tryToPromoteExts(TPT, Exts, SpeculativelyMovedExts);
Jun Bum Lim42301012017-03-17 19:05:21 +00004877
Dan Gohman99429a02009-10-16 20:59:35 +00004878 // Look for a load being extended.
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004879 LoadInst *LI = nullptr;
Jun Bum Limdee55652017-04-03 19:20:07 +00004880 Instruction *ExtFedByLoad;
4881
4882 // Try to promote a chain of computation if it allows to form an extended
4883 // load.
4884 if (canFormExtLd(SpeculativelyMovedExts, LI, ExtFedByLoad, HasPromoted)) {
4885 assert(LI && ExtFedByLoad && "Expect a valid load and extension");
4886 TPT.commit();
4887 // Move the extend into the same block as the load
4888 ExtFedByLoad->removeFromParent();
4889 ExtFedByLoad->insertAfter(LI);
4890 // CGP does not check if the zext would be speculatively executed when moved
4891 // to the same basic block as the load. Preserving its original location
4892 // would pessimize the debugging experience, as well as negatively impact
4893 // the quality of sample pgo. We don't want to use "line 0" as that has a
4894 // size cost in the line-table section and logically the zext can be seen as
4895 // part of the load. Therefore we conservatively reuse the same debug
4896 // location for the load and the zext.
4897 ExtFedByLoad->setDebugLoc(LI->getDebugLoc());
4898 ++NumExtsMoved;
4899 Inst = ExtFedByLoad;
4900 return true;
4901 }
4902
4903 // Continue promoting SExts if known as considerable depending on targets.
4904 if (ATPConsiderable &&
4905 performAddressTypePromotion(Inst, AllowPromotionWithoutCommonHeader,
4906 HasPromoted, TPT, SpeculativelyMovedExts))
4907 return true;
4908
4909 TPT.rollback(LastKnownGood);
4910 return false;
4911}
4912
4913// Perform address type promotion if doing so is profitable.
4914// If AllowPromotionWithoutCommonHeader == false, we should find other sext
4915// instructions that sign extended the same initial value. However, if
4916// AllowPromotionWithoutCommonHeader == true, we expect promoting the
4917// extension is just profitable.
4918bool CodeGenPrepare::performAddressTypePromotion(
4919 Instruction *&Inst, bool AllowPromotionWithoutCommonHeader,
4920 bool HasPromoted, TypePromotionTransaction &TPT,
4921 SmallVectorImpl<Instruction *> &SpeculativelyMovedExts) {
4922 bool Promoted = false;
4923 SmallPtrSet<Instruction *, 1> UnhandledExts;
4924 bool AllSeenFirst = true;
4925 for (auto I : SpeculativelyMovedExts) {
4926 Value *HeadOfChain = I->getOperand(0);
4927 DenseMap<Value *, Instruction *>::iterator AlreadySeen =
4928 SeenChainsForSExt.find(HeadOfChain);
4929 // If there is an unhandled SExt which has the same header, try to promote
4930 // it as well.
4931 if (AlreadySeen != SeenChainsForSExt.end()) {
4932 if (AlreadySeen->second != nullptr)
4933 UnhandledExts.insert(AlreadySeen->second);
4934 AllSeenFirst = false;
4935 }
4936 }
4937
4938 if (!AllSeenFirst || (AllowPromotionWithoutCommonHeader &&
4939 SpeculativelyMovedExts.size() == 1)) {
4940 TPT.commit();
4941 if (HasPromoted)
4942 Promoted = true;
4943 for (auto I : SpeculativelyMovedExts) {
4944 Value *HeadOfChain = I->getOperand(0);
4945 SeenChainsForSExt[HeadOfChain] = nullptr;
4946 ValToSExtendedUses[HeadOfChain].push_back(I);
4947 }
4948 // Update Inst as promotion happen.
4949 Inst = SpeculativelyMovedExts.pop_back_val();
4950 } else {
4951 // This is the first chain visited from the header, keep the current chain
4952 // as unhandled. Defer to promote this until we encounter another SExt
4953 // chain derived from the same header.
4954 for (auto I : SpeculativelyMovedExts) {
4955 Value *HeadOfChain = I->getOperand(0);
4956 SeenChainsForSExt[HeadOfChain] = Inst;
4957 }
Dan Gohman99429a02009-10-16 20:59:35 +00004958 return false;
Quentin Colombetfc2201e2014-12-17 01:36:17 +00004959 }
Dan Gohman99429a02009-10-16 20:59:35 +00004960
Jun Bum Limdee55652017-04-03 19:20:07 +00004961 if (!AllSeenFirst && !UnhandledExts.empty())
4962 for (auto VisitedSExt : UnhandledExts) {
4963 if (RemovedInsts.count(VisitedSExt))
4964 continue;
4965 TypePromotionTransaction TPT(RemovedInsts);
4966 SmallVector<Instruction *, 1> Exts;
4967 SmallVector<Instruction *, 2> Chains;
4968 Exts.push_back(VisitedSExt);
4969 bool HasPromoted = tryToPromoteExts(TPT, Exts, Chains);
4970 TPT.commit();
4971 if (HasPromoted)
4972 Promoted = true;
4973 for (auto I : Chains) {
4974 Value *HeadOfChain = I->getOperand(0);
4975 // Mark this as handled.
4976 SeenChainsForSExt[HeadOfChain] = nullptr;
4977 ValToSExtendedUses[HeadOfChain].push_back(I);
4978 }
4979 }
4980 return Promoted;
Dan Gohman99429a02009-10-16 20:59:35 +00004981}
4982
Sanjay Patelfc580a62015-09-21 23:03:16 +00004983bool CodeGenPrepare::optimizeExtUses(Instruction *I) {
Evan Chengd3d80172007-12-05 23:58:20 +00004984 BasicBlock *DefBB = I->getParent();
4985
Bob Wilsonff714f92010-09-21 21:44:14 +00004986 // If the result of a {s|z}ext and its source are both live out, rewrite all
Evan Chengd3d80172007-12-05 23:58:20 +00004987 // other uses of the source with result of extension.
4988 Value *Src = I->getOperand(0);
4989 if (Src->hasOneUse())
4990 return false;
4991
Evan Cheng2011df42007-12-13 07:50:36 +00004992 // Only do this xform if truncating is free.
Gabor Greifaa261722008-02-26 19:13:21 +00004993 if (TLI && !TLI->isTruncateFree(I->getType(), Src->getType()))
Evan Cheng37c36ed2007-12-13 03:32:53 +00004994 return false;
4995
Evan Cheng7bc89422007-12-12 00:51:06 +00004996 // Only safe to perform the optimization if the source is also defined in
Evan Cheng63d33cf2007-12-12 02:53:41 +00004997 // this block.
4998 if (!isa<Instruction>(Src) || DefBB != cast<Instruction>(Src)->getParent())
Evan Cheng7bc89422007-12-12 00:51:06 +00004999 return false;
5000
Evan Chengd3d80172007-12-05 23:58:20 +00005001 bool DefIsLiveOut = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +00005002 for (User *U : I->users()) {
5003 Instruction *UI = cast<Instruction>(U);
Evan Chengd3d80172007-12-05 23:58:20 +00005004
5005 // Figure out which BB this ext is used in.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005006 BasicBlock *UserBB = UI->getParent();
Evan Chengd3d80172007-12-05 23:58:20 +00005007 if (UserBB == DefBB) continue;
5008 DefIsLiveOut = true;
5009 break;
5010 }
5011 if (!DefIsLiveOut)
5012 return false;
5013
Jim Grosbach0f38c1e2013-04-15 17:40:48 +00005014 // Make sure none of the uses are PHI nodes.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005015 for (User *U : Src->users()) {
5016 Instruction *UI = cast<Instruction>(U);
5017 BasicBlock *UserBB = UI->getParent();
Evan Cheng37c36ed2007-12-13 03:32:53 +00005018 if (UserBB == DefBB) continue;
5019 // Be conservative. We don't want this xform to end up introducing
5020 // reloads just before load / store instructions.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005021 if (isa<PHINode>(UI) || isa<LoadInst>(UI) || isa<StoreInst>(UI))
Evan Cheng63d33cf2007-12-12 02:53:41 +00005022 return false;
5023 }
5024
Evan Chengd3d80172007-12-05 23:58:20 +00005025 // InsertedTruncs - Only insert one trunc in each block once.
5026 DenseMap<BasicBlock*, Instruction*> InsertedTruncs;
5027
5028 bool MadeChange = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +00005029 for (Use &U : Src->uses()) {
5030 Instruction *User = cast<Instruction>(U.getUser());
Evan Chengd3d80172007-12-05 23:58:20 +00005031
5032 // Figure out which BB this ext is used in.
5033 BasicBlock *UserBB = User->getParent();
5034 if (UserBB == DefBB) continue;
5035
5036 // Both src and def are live in this block. Rewrite the use.
5037 Instruction *&InsertedTrunc = InsertedTruncs[UserBB];
5038
5039 if (!InsertedTrunc) {
Bill Wendling8ddfc092011-08-16 20:45:24 +00005040 BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00005041 assert(InsertPt != UserBB->end());
5042 InsertedTrunc = new TruncInst(I, Src->getType(), "", &*InsertPt);
Ahmed Bougachaf3299142015-06-17 20:44:32 +00005043 InsertedInsts.insert(InsertedTrunc);
Evan Chengd3d80172007-12-05 23:58:20 +00005044 }
5045
5046 // Replace a use of the {s|z}ext source with a use of the result.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005047 U = InsertedTrunc;
Cameron Zwarichced753f2011-01-05 17:27:27 +00005048 ++NumExtUses;
Evan Chengd3d80172007-12-05 23:58:20 +00005049 MadeChange = true;
5050 }
5051
5052 return MadeChange;
5053}
5054
Geoff Berry5256fca2015-11-20 22:34:39 +00005055// Find loads whose uses only use some of the loaded value's bits. Add an "and"
5056// just after the load if the target can fold this into one extload instruction,
5057// with the hope of eliminating some of the other later "and" instructions using
5058// the loaded value. "and"s that are made trivially redundant by the insertion
5059// of the new "and" are removed by this function, while others (e.g. those whose
5060// path from the load goes through a phi) are left for isel to potentially
5061// remove.
5062//
5063// For example:
5064//
5065// b0:
5066// x = load i32
5067// ...
5068// b1:
5069// y = and x, 0xff
5070// z = use y
5071//
5072// becomes:
5073//
5074// b0:
5075// x = load i32
5076// x' = and x, 0xff
5077// ...
5078// b1:
5079// z = use x'
5080//
5081// whereas:
5082//
5083// b0:
5084// x1 = load i32
5085// ...
5086// b1:
5087// x2 = load i32
5088// ...
5089// b2:
5090// x = phi x1, x2
5091// y = and x, 0xff
5092//
5093// becomes (after a call to optimizeLoadExt for each load):
5094//
5095// b0:
5096// x1 = load i32
5097// x1' = and x1, 0xff
5098// ...
5099// b1:
5100// x2 = load i32
5101// x2' = and x2, 0xff
5102// ...
5103// b2:
5104// x = phi x1', x2'
5105// y = and x, 0xff
5106//
5107
5108bool CodeGenPrepare::optimizeLoadExt(LoadInst *Load) {
5109
5110 if (!Load->isSimple() ||
5111 !(Load->getType()->isIntegerTy() || Load->getType()->isPointerTy()))
5112 return false;
5113
Geoff Berry5d534b62017-02-21 18:53:14 +00005114 // Skip loads we've already transformed.
5115 if (Load->hasOneUse() &&
5116 InsertedInsts.count(cast<Instruction>(*Load->user_begin())))
5117 return false;
Geoff Berry5256fca2015-11-20 22:34:39 +00005118
5119 // Look at all uses of Load, looking through phis, to determine how many bits
5120 // of the loaded value are needed.
5121 SmallVector<Instruction *, 8> WorkList;
5122 SmallPtrSet<Instruction *, 16> Visited;
5123 SmallVector<Instruction *, 8> AndsToMaybeRemove;
5124 for (auto *U : Load->users())
5125 WorkList.push_back(cast<Instruction>(U));
5126
5127 EVT LoadResultVT = TLI->getValueType(*DL, Load->getType());
5128 unsigned BitWidth = LoadResultVT.getSizeInBits();
5129 APInt DemandBits(BitWidth, 0);
5130 APInt WidestAndBits(BitWidth, 0);
5131
5132 while (!WorkList.empty()) {
5133 Instruction *I = WorkList.back();
5134 WorkList.pop_back();
5135
5136 // Break use-def graph loops.
5137 if (!Visited.insert(I).second)
5138 continue;
5139
5140 // For a PHI node, push all of its users.
5141 if (auto *Phi = dyn_cast<PHINode>(I)) {
5142 for (auto *U : Phi->users())
5143 WorkList.push_back(cast<Instruction>(U));
5144 continue;
5145 }
5146
5147 switch (I->getOpcode()) {
5148 case llvm::Instruction::And: {
5149 auto *AndC = dyn_cast<ConstantInt>(I->getOperand(1));
5150 if (!AndC)
5151 return false;
5152 APInt AndBits = AndC->getValue();
5153 DemandBits |= AndBits;
5154 // Keep track of the widest and mask we see.
5155 if (AndBits.ugt(WidestAndBits))
5156 WidestAndBits = AndBits;
5157 if (AndBits == WidestAndBits && I->getOperand(0) == Load)
5158 AndsToMaybeRemove.push_back(I);
5159 break;
5160 }
5161
5162 case llvm::Instruction::Shl: {
5163 auto *ShlC = dyn_cast<ConstantInt>(I->getOperand(1));
5164 if (!ShlC)
5165 return false;
5166 uint64_t ShiftAmt = ShlC->getLimitedValue(BitWidth - 1);
Craig Topperfc947bc2017-04-18 17:14:21 +00005167 DemandBits.setLowBits(BitWidth - ShiftAmt);
Geoff Berry5256fca2015-11-20 22:34:39 +00005168 break;
5169 }
5170
5171 case llvm::Instruction::Trunc: {
5172 EVT TruncVT = TLI->getValueType(*DL, I->getType());
5173 unsigned TruncBitWidth = TruncVT.getSizeInBits();
Craig Topperfc947bc2017-04-18 17:14:21 +00005174 DemandBits.setLowBits(TruncBitWidth);
Geoff Berry5256fca2015-11-20 22:34:39 +00005175 break;
5176 }
5177
5178 default:
5179 return false;
5180 }
5181 }
5182
5183 uint32_t ActiveBits = DemandBits.getActiveBits();
5184 // Avoid hoisting (and (load x) 1) since it is unlikely to be folded by the
5185 // target even if isLoadExtLegal says an i1 EXTLOAD is valid. For example,
5186 // for the AArch64 target isLoadExtLegal(ZEXTLOAD, i32, i1) returns true, but
5187 // (and (load x) 1) is not matched as a single instruction, rather as a LDR
5188 // followed by an AND.
5189 // TODO: Look into removing this restriction by fixing backends to either
5190 // return false for isLoadExtLegal for i1 or have them select this pattern to
5191 // a single instruction.
5192 //
5193 // Also avoid hoisting if we didn't see any ands with the exact DemandBits
5194 // mask, since these are the only ands that will be removed by isel.
Craig Topperd33ee1b2017-04-03 16:34:59 +00005195 if (ActiveBits <= 1 || !DemandBits.isMask(ActiveBits) ||
Geoff Berry5256fca2015-11-20 22:34:39 +00005196 WidestAndBits != DemandBits)
5197 return false;
5198
5199 LLVMContext &Ctx = Load->getType()->getContext();
5200 Type *TruncTy = Type::getIntNTy(Ctx, ActiveBits);
5201 EVT TruncVT = TLI->getValueType(*DL, TruncTy);
5202
5203 // Reject cases that won't be matched as extloads.
5204 if (!LoadResultVT.bitsGT(TruncVT) || !TruncVT.isRound() ||
5205 !TLI->isLoadExtLegal(ISD::ZEXTLOAD, LoadResultVT, TruncVT))
5206 return false;
5207
5208 IRBuilder<> Builder(Load->getNextNode());
5209 auto *NewAnd = dyn_cast<Instruction>(
5210 Builder.CreateAnd(Load, ConstantInt::get(Ctx, DemandBits)));
Geoff Berry5d534b62017-02-21 18:53:14 +00005211 // Mark this instruction as "inserted by CGP", so that other
5212 // optimizations don't touch it.
5213 InsertedInsts.insert(NewAnd);
Geoff Berry5256fca2015-11-20 22:34:39 +00005214
5215 // Replace all uses of load with new and (except for the use of load in the
5216 // new and itself).
5217 Load->replaceAllUsesWith(NewAnd);
5218 NewAnd->setOperand(0, Load);
5219
5220 // Remove any and instructions that are now redundant.
5221 for (auto *And : AndsToMaybeRemove)
5222 // Check that the and mask is the same as the one we decided to put on the
5223 // new and.
5224 if (cast<ConstantInt>(And->getOperand(1))->getValue() == DemandBits) {
5225 And->replaceAllUsesWith(NewAnd);
5226 if (&*CurInstIterator == And)
5227 CurInstIterator = std::next(And->getIterator());
5228 And->eraseFromParent();
5229 ++NumAndUses;
5230 }
5231
5232 ++NumAndsAdded;
5233 return true;
5234}
5235
Sanjay Patel69a50a12015-10-19 21:59:12 +00005236/// Check if V (an operand of a select instruction) is an expensive instruction
5237/// that is only used once.
5238static bool sinkSelectOperand(const TargetTransformInfo *TTI, Value *V) {
5239 auto *I = dyn_cast<Instruction>(V);
5240 // If it's safe to speculatively execute, then it should not have side
5241 // effects; therefore, it's safe to sink and possibly *not* execute.
Rafael Espindola84921b92015-10-24 23:11:13 +00005242 return I && I->hasOneUse() && isSafeToSpeculativelyExecute(I) &&
5243 TTI->getUserCost(I) >= TargetTransformInfo::TCC_Expensive;
Sanjay Patel69a50a12015-10-19 21:59:12 +00005244}
5245
Sanjay Patel4ac6b112015-09-21 22:47:23 +00005246/// Returns true if a SelectInst should be turned into an explicit branch.
Sanjay Patel69a50a12015-10-19 21:59:12 +00005247static bool isFormingBranchFromSelectProfitable(const TargetTransformInfo *TTI,
Sanjay Pateld66607b2016-04-26 17:11:17 +00005248 const TargetLowering *TLI,
Sanjay Patel69a50a12015-10-19 21:59:12 +00005249 SelectInst *SI) {
Sanjay Pateld66607b2016-04-26 17:11:17 +00005250 // If even a predictable select is cheap, then a branch can't be cheaper.
5251 if (!TLI->isPredictableSelectExpensive())
5252 return false;
5253
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005254 // FIXME: This should use the same heuristics as IfConversion to determine
Sanjay Pateld66607b2016-04-26 17:11:17 +00005255 // whether a select is better represented as a branch.
5256
5257 // If metadata tells us that the select condition is obviously predictable,
5258 // then we want to replace the select with a branch.
5259 uint64_t TrueWeight, FalseWeight;
5260 if (SI->extractProfMetadata(TrueWeight, FalseWeight)) {
5261 uint64_t Max = std::max(TrueWeight, FalseWeight);
5262 uint64_t Sum = TrueWeight + FalseWeight;
Sanjay Patelc7b91e62016-05-09 17:31:55 +00005263 if (Sum != 0) {
5264 auto Probability = BranchProbability::getBranchProbability(Max, Sum);
5265 if (Probability > TLI->getPredictableBranchThreshold())
5266 return true;
5267 }
Sanjay Pateld66607b2016-04-26 17:11:17 +00005268 }
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005269
5270 CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
5271
Sanjay Patel4e652762015-09-28 22:14:51 +00005272 // If a branch is predictable, an out-of-order CPU can avoid blocking on its
5273 // comparison condition. If the compare has more than one use, there's
5274 // probably another cmov or setcc around, so it's not worth emitting a branch.
Sanjay Patel5e5f0e92015-09-28 21:44:46 +00005275 if (!Cmp || !Cmp->hasOneUse())
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005276 return false;
5277
Sanjay Patel69a50a12015-10-19 21:59:12 +00005278 // If either operand of the select is expensive and only needed on one side
5279 // of the select, we should form a branch.
5280 if (sinkSelectOperand(TTI, SI->getTrueValue()) ||
5281 sinkSelectOperand(TTI, SI->getFalseValue()))
5282 return true;
5283
5284 return false;
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005285}
5286
Dehao Chen9bbb9412016-09-12 20:23:28 +00005287/// If \p isTrue is true, return the true value of \p SI, otherwise return
5288/// false value of \p SI. If the true/false value of \p SI is defined by any
5289/// select instructions in \p Selects, look through the defining select
5290/// instruction until the true/false value is not defined in \p Selects.
5291static Value *getTrueOrFalseValue(
5292 SelectInst *SI, bool isTrue,
5293 const SmallPtrSet<const Instruction *, 2> &Selects) {
5294 Value *V;
5295
5296 for (SelectInst *DefSI = SI; DefSI != nullptr && Selects.count(DefSI);
5297 DefSI = dyn_cast<SelectInst>(V)) {
Dehao Chenc32d7122016-09-12 20:29:54 +00005298 assert(DefSI->getCondition() == SI->getCondition() &&
Dehao Chen9bbb9412016-09-12 20:23:28 +00005299 "The condition of DefSI does not match with SI");
5300 V = (isTrue ? DefSI->getTrueValue() : DefSI->getFalseValue());
5301 }
5302 return V;
5303}
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005304
Nadav Rotem9d832022012-09-02 12:10:19 +00005305/// If we have a SelectInst that will likely profit from branch prediction,
5306/// turn it into a branch.
Sanjay Patelfc580a62015-09-21 23:03:16 +00005307bool CodeGenPrepare::optimizeSelectInst(SelectInst *SI) {
Dehao Chen9bbb9412016-09-12 20:23:28 +00005308 // Find all consecutive select instructions that share the same condition.
5309 SmallVector<SelectInst *, 2> ASI;
5310 ASI.push_back(SI);
5311 for (BasicBlock::iterator It = ++BasicBlock::iterator(SI);
5312 It != SI->getParent()->end(); ++It) {
5313 SelectInst *I = dyn_cast<SelectInst>(&*It);
5314 if (I && SI->getCondition() == I->getCondition()) {
5315 ASI.push_back(I);
5316 } else {
5317 break;
5318 }
5319 }
5320
5321 SelectInst *LastSI = ASI.back();
5322 // Increment the current iterator to skip all the rest of select instructions
5323 // because they will be either "not lowered" or "all lowered" to branch.
5324 CurInstIterator = std::next(LastSI->getIterator());
5325
Nadav Rotem9d832022012-09-02 12:10:19 +00005326 bool VectorCond = !SI->getCondition()->getType()->isIntegerTy(1);
5327
5328 // Can we convert the 'select' to CF ?
Sanjay Patela31b0c02016-04-26 00:47:39 +00005329 if (DisableSelectToBranch || OptSize || !TLI || VectorCond ||
5330 SI->getMetadata(LLVMContext::MD_unpredictable))
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005331 return false;
5332
Nadav Rotem9d832022012-09-02 12:10:19 +00005333 TargetLowering::SelectSupportKind SelectKind;
5334 if (VectorCond)
5335 SelectKind = TargetLowering::VectorMaskSelect;
5336 else if (SI->getType()->isVectorTy())
5337 SelectKind = TargetLowering::ScalarCondVectorVal;
5338 else
5339 SelectKind = TargetLowering::ScalarValSelect;
5340
Sanjay Pateld66607b2016-04-26 17:11:17 +00005341 if (TLI->isSelectSupported(SelectKind) &&
5342 !isFormingBranchFromSelectProfitable(TTI, TLI, SI))
5343 return false;
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005344
5345 ModifiedDT = true;
5346
Sanjay Patel69a50a12015-10-19 21:59:12 +00005347 // Transform a sequence like this:
5348 // start:
5349 // %cmp = cmp uge i32 %a, %b
5350 // %sel = select i1 %cmp, i32 %c, i32 %d
5351 //
5352 // Into:
5353 // start:
5354 // %cmp = cmp uge i32 %a, %b
5355 // br i1 %cmp, label %select.true, label %select.false
5356 // select.true:
5357 // br label %select.end
5358 // select.false:
5359 // br label %select.end
5360 // select.end:
5361 // %sel = phi i32 [ %c, %select.true ], [ %d, %select.false ]
5362 //
5363 // In addition, we may sink instructions that produce %c or %d from
5364 // the entry block into the destination(s) of the new branch.
5365 // If the true or false blocks do not contain a sunken instruction, that
5366 // block and its branch may be optimized away. In that case, one side of the
5367 // first branch will point directly to select.end, and the corresponding PHI
5368 // predecessor block will be the start block.
5369
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005370 // First, we split the block containing the select into 2 blocks.
5371 BasicBlock *StartBlock = SI->getParent();
Dehao Chen9bbb9412016-09-12 20:23:28 +00005372 BasicBlock::iterator SplitPt = ++(BasicBlock::iterator(LastSI));
Sanjay Patel69a50a12015-10-19 21:59:12 +00005373 BasicBlock *EndBlock = StartBlock->splitBasicBlock(SplitPt, "select.end");
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005374
Sanjay Patel69a50a12015-10-19 21:59:12 +00005375 // Delete the unconditional branch that was just created by the split.
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005376 StartBlock->getTerminator()->eraseFromParent();
Sanjay Patel69a50a12015-10-19 21:59:12 +00005377
5378 // These are the new basic blocks for the conditional branch.
5379 // At least one will become an actual new basic block.
5380 BasicBlock *TrueBlock = nullptr;
5381 BasicBlock *FalseBlock = nullptr;
Dehao Chen9bbb9412016-09-12 20:23:28 +00005382 BranchInst *TrueBranch = nullptr;
5383 BranchInst *FalseBranch = nullptr;
Sanjay Patel69a50a12015-10-19 21:59:12 +00005384
5385 // Sink expensive instructions into the conditional blocks to avoid executing
5386 // them speculatively.
Dehao Chen9bbb9412016-09-12 20:23:28 +00005387 for (SelectInst *SI : ASI) {
5388 if (sinkSelectOperand(TTI, SI->getTrueValue())) {
5389 if (TrueBlock == nullptr) {
5390 TrueBlock = BasicBlock::Create(SI->getContext(), "select.true.sink",
5391 EndBlock->getParent(), EndBlock);
5392 TrueBranch = BranchInst::Create(EndBlock, TrueBlock);
5393 }
5394 auto *TrueInst = cast<Instruction>(SI->getTrueValue());
5395 TrueInst->moveBefore(TrueBranch);
5396 }
5397 if (sinkSelectOperand(TTI, SI->getFalseValue())) {
5398 if (FalseBlock == nullptr) {
5399 FalseBlock = BasicBlock::Create(SI->getContext(), "select.false.sink",
5400 EndBlock->getParent(), EndBlock);
5401 FalseBranch = BranchInst::Create(EndBlock, FalseBlock);
5402 }
5403 auto *FalseInst = cast<Instruction>(SI->getFalseValue());
5404 FalseInst->moveBefore(FalseBranch);
5405 }
Sanjay Patel69a50a12015-10-19 21:59:12 +00005406 }
5407
5408 // If there was nothing to sink, then arbitrarily choose the 'false' side
5409 // for a new input value to the PHI.
5410 if (TrueBlock == FalseBlock) {
5411 assert(TrueBlock == nullptr &&
5412 "Unexpected basic block transform while optimizing select");
5413
5414 FalseBlock = BasicBlock::Create(SI->getContext(), "select.false",
5415 EndBlock->getParent(), EndBlock);
5416 BranchInst::Create(EndBlock, FalseBlock);
5417 }
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005418
5419 // Insert the real conditional branch based on the original condition.
Sanjay Patel69a50a12015-10-19 21:59:12 +00005420 // If we did not create a new block for one of the 'true' or 'false' paths
5421 // of the condition, it means that side of the branch goes to the end block
5422 // directly and the path originates from the start block from the point of
5423 // view of the new PHI.
Xinliang David Li241e6c72016-09-03 21:26:36 +00005424 BasicBlock *TT, *FT;
Sanjay Patel69a50a12015-10-19 21:59:12 +00005425 if (TrueBlock == nullptr) {
Xinliang David Li241e6c72016-09-03 21:26:36 +00005426 TT = EndBlock;
5427 FT = FalseBlock;
Sanjay Patel69a50a12015-10-19 21:59:12 +00005428 TrueBlock = StartBlock;
5429 } else if (FalseBlock == nullptr) {
Xinliang David Li241e6c72016-09-03 21:26:36 +00005430 TT = TrueBlock;
5431 FT = EndBlock;
Sanjay Patel69a50a12015-10-19 21:59:12 +00005432 FalseBlock = StartBlock;
5433 } else {
Xinliang David Li241e6c72016-09-03 21:26:36 +00005434 TT = TrueBlock;
5435 FT = FalseBlock;
Sanjay Patel69a50a12015-10-19 21:59:12 +00005436 }
Xinliang David Li241e6c72016-09-03 21:26:36 +00005437 IRBuilder<>(SI).CreateCondBr(SI->getCondition(), TT, FT, SI);
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005438
Dehao Chen9bbb9412016-09-12 20:23:28 +00005439 SmallPtrSet<const Instruction *, 2> INS;
5440 INS.insert(ASI.begin(), ASI.end());
5441 // Use reverse iterator because later select may use the value of the
5442 // earlier select, and we need to propagate value through earlier select
5443 // to get the PHI operand.
5444 for (auto It = ASI.rbegin(); It != ASI.rend(); ++It) {
5445 SelectInst *SI = *It;
5446 // The select itself is replaced with a PHI Node.
5447 PHINode *PN = PHINode::Create(SI->getType(), 2, "", &EndBlock->front());
5448 PN->takeName(SI);
5449 PN->addIncoming(getTrueOrFalseValue(SI, true, INS), TrueBlock);
5450 PN->addIncoming(getTrueOrFalseValue(SI, false, INS), FalseBlock);
Sanjay Patel69a50a12015-10-19 21:59:12 +00005451
Dehao Chen9bbb9412016-09-12 20:23:28 +00005452 SI->replaceAllUsesWith(PN);
5453 SI->eraseFromParent();
5454 INS.erase(SI);
5455 ++NumSelectsExpanded;
5456 }
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005457
5458 // Instruct OptimizeBlock to skip to the next block.
5459 CurInstIterator = StartBlock->end();
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00005460 return true;
5461}
5462
Benjamin Kramer573ff362014-03-01 17:24:40 +00005463static bool isBroadcastShuffle(ShuffleVectorInst *SVI) {
Tim Northoveraeb8e062014-02-19 10:02:43 +00005464 SmallVector<int, 16> Mask(SVI->getShuffleMask());
5465 int SplatElem = -1;
5466 for (unsigned i = 0; i < Mask.size(); ++i) {
5467 if (SplatElem != -1 && Mask[i] != -1 && Mask[i] != SplatElem)
5468 return false;
5469 SplatElem = Mask[i];
5470 }
5471
5472 return true;
5473}
5474
5475/// Some targets have expensive vector shifts if the lanes aren't all the same
5476/// (e.g. x86 only introduced "vpsllvd" and friends with AVX2). In these cases
5477/// it's often worth sinking a shufflevector splat down to its use so that
5478/// codegen can spot all lanes are identical.
Sanjay Patelfc580a62015-09-21 23:03:16 +00005479bool CodeGenPrepare::optimizeShuffleVectorInst(ShuffleVectorInst *SVI) {
Tim Northoveraeb8e062014-02-19 10:02:43 +00005480 BasicBlock *DefBB = SVI->getParent();
5481
5482 // Only do this xform if variable vector shifts are particularly expensive.
5483 if (!TLI || !TLI->isVectorShiftByScalarCheap(SVI->getType()))
5484 return false;
5485
5486 // We only expect better codegen by sinking a shuffle if we can recognise a
5487 // constant splat.
5488 if (!isBroadcastShuffle(SVI))
5489 return false;
5490
5491 // InsertedShuffles - Only insert a shuffle in each block once.
5492 DenseMap<BasicBlock*, Instruction*> InsertedShuffles;
5493
5494 bool MadeChange = false;
Chandler Carruthcdf47882014-03-09 03:16:01 +00005495 for (User *U : SVI->users()) {
5496 Instruction *UI = cast<Instruction>(U);
Tim Northoveraeb8e062014-02-19 10:02:43 +00005497
5498 // Figure out which BB this ext is used in.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005499 BasicBlock *UserBB = UI->getParent();
Tim Northoveraeb8e062014-02-19 10:02:43 +00005500 if (UserBB == DefBB) continue;
5501
5502 // For now only apply this when the splat is used by a shift instruction.
Chandler Carruthcdf47882014-03-09 03:16:01 +00005503 if (!UI->isShift()) continue;
Tim Northoveraeb8e062014-02-19 10:02:43 +00005504
5505 // Everything checks out, sink the shuffle if the user's block doesn't
5506 // already have a copy.
5507 Instruction *&InsertedShuffle = InsertedShuffles[UserBB];
5508
5509 if (!InsertedShuffle) {
5510 BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00005511 assert(InsertPt != UserBB->end());
5512 InsertedShuffle =
5513 new ShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
5514 SVI->getOperand(2), "", &*InsertPt);
Tim Northoveraeb8e062014-02-19 10:02:43 +00005515 }
5516
Chandler Carruthcdf47882014-03-09 03:16:01 +00005517 UI->replaceUsesOfWith(SVI, InsertedShuffle);
Tim Northoveraeb8e062014-02-19 10:02:43 +00005518 MadeChange = true;
5519 }
5520
5521 // If we removed all uses, nuke the shuffle.
5522 if (SVI->use_empty()) {
5523 SVI->eraseFromParent();
5524 MadeChange = true;
5525 }
5526
5527 return MadeChange;
5528}
5529
Sanjay Patel0ed9aea2015-11-02 23:22:49 +00005530bool CodeGenPrepare::optimizeSwitchInst(SwitchInst *SI) {
5531 if (!TLI || !DL)
5532 return false;
5533
5534 Value *Cond = SI->getCondition();
5535 Type *OldType = Cond->getType();
5536 LLVMContext &Context = Cond->getContext();
5537 MVT RegType = TLI->getRegisterType(Context, TLI->getValueType(*DL, OldType));
5538 unsigned RegWidth = RegType.getSizeInBits();
5539
5540 if (RegWidth <= cast<IntegerType>(OldType)->getBitWidth())
5541 return false;
5542
5543 // If the register width is greater than the type width, expand the condition
5544 // of the switch instruction and each case constant to the width of the
5545 // register. By widening the type of the switch condition, subsequent
5546 // comparisons (for case comparisons) will not need to be extended to the
5547 // preferred register width, so we will potentially eliminate N-1 extends,
5548 // where N is the number of cases in the switch.
5549 auto *NewType = Type::getIntNTy(Context, RegWidth);
5550
5551 // Zero-extend the switch condition and case constants unless the switch
5552 // condition is a function argument that is already being sign-extended.
5553 // In that case, we can avoid an unnecessary mask/extension by sign-extending
5554 // everything instead.
5555 Instruction::CastOps ExtType = Instruction::ZExt;
5556 if (auto *Arg = dyn_cast<Argument>(Cond))
5557 if (Arg->hasSExtAttr())
5558 ExtType = Instruction::SExt;
5559
5560 auto *ExtInst = CastInst::Create(ExtType, Cond, NewType);
5561 ExtInst->insertBefore(SI);
5562 SI->setCondition(ExtInst);
Chandler Carruth927d8e62017-04-12 07:27:28 +00005563 for (auto Case : SI->cases()) {
Sanjay Patel0ed9aea2015-11-02 23:22:49 +00005564 APInt NarrowConst = Case.getCaseValue()->getValue();
5565 APInt WideConst = (ExtType == Instruction::ZExt) ?
5566 NarrowConst.zext(RegWidth) : NarrowConst.sext(RegWidth);
5567 Case.setValue(ConstantInt::get(Context, WideConst));
5568 }
5569
5570 return true;
5571}
5572
Zaara Syeda3a7578c2017-05-31 17:12:38 +00005573
Quentin Colombetc32615d2014-10-31 17:52:53 +00005574namespace {
5575/// \brief Helper class to promote a scalar operation to a vector one.
5576/// This class is used to move downward extractelement transition.
5577/// E.g.,
5578/// a = vector_op <2 x i32>
5579/// b = extractelement <2 x i32> a, i32 0
5580/// c = scalar_op b
5581/// store c
5582///
5583/// =>
5584/// a = vector_op <2 x i32>
5585/// c = vector_op a (equivalent to scalar_op on the related lane)
5586/// * d = extractelement <2 x i32> c, i32 0
5587/// * store d
5588/// Assuming both extractelement and store can be combine, we get rid of the
5589/// transition.
5590class VectorPromoteHelper {
Mehdi Amini44ede332015-07-09 02:09:04 +00005591 /// DataLayout associated with the current module.
5592 const DataLayout &DL;
5593
Quentin Colombetc32615d2014-10-31 17:52:53 +00005594 /// Used to perform some checks on the legality of vector operations.
5595 const TargetLowering &TLI;
5596
5597 /// Used to estimated the cost of the promoted chain.
5598 const TargetTransformInfo &TTI;
5599
5600 /// The transition being moved downwards.
5601 Instruction *Transition;
5602 /// The sequence of instructions to be promoted.
5603 SmallVector<Instruction *, 4> InstsToBePromoted;
5604 /// Cost of combining a store and an extract.
5605 unsigned StoreExtractCombineCost;
5606 /// Instruction that will be combined with the transition.
5607 Instruction *CombineInst;
5608
5609 /// \brief The instruction that represents the current end of the transition.
5610 /// Since we are faking the promotion until we reach the end of the chain
5611 /// of computation, we need a way to get the current end of the transition.
5612 Instruction *getEndOfTransition() const {
5613 if (InstsToBePromoted.empty())
5614 return Transition;
5615 return InstsToBePromoted.back();
5616 }
5617
5618 /// \brief Return the index of the original value in the transition.
5619 /// E.g., for "extractelement <2 x i32> c, i32 1" the original value,
5620 /// c, is at index 0.
5621 unsigned getTransitionOriginalValueIdx() const {
5622 assert(isa<ExtractElementInst>(Transition) &&
5623 "Other kind of transitions are not supported yet");
5624 return 0;
5625 }
5626
5627 /// \brief Return the index of the index in the transition.
5628 /// E.g., for "extractelement <2 x i32> c, i32 0" the index
5629 /// is at index 1.
5630 unsigned getTransitionIdx() const {
5631 assert(isa<ExtractElementInst>(Transition) &&
5632 "Other kind of transitions are not supported yet");
5633 return 1;
5634 }
5635
5636 /// \brief Get the type of the transition.
5637 /// This is the type of the original value.
5638 /// E.g., for "extractelement <2 x i32> c, i32 1" the type of the
5639 /// transition is <2 x i32>.
5640 Type *getTransitionType() const {
5641 return Transition->getOperand(getTransitionOriginalValueIdx())->getType();
5642 }
5643
5644 /// \brief Promote \p ToBePromoted by moving \p Def downward through.
5645 /// I.e., we have the following sequence:
5646 /// Def = Transition <ty1> a to <ty2>
5647 /// b = ToBePromoted <ty2> Def, ...
5648 /// =>
5649 /// b = ToBePromoted <ty1> a, ...
5650 /// Def = Transition <ty1> ToBePromoted to <ty2>
5651 void promoteImpl(Instruction *ToBePromoted);
5652
5653 /// \brief Check whether or not it is profitable to promote all the
5654 /// instructions enqueued to be promoted.
5655 bool isProfitableToPromote() {
5656 Value *ValIdx = Transition->getOperand(getTransitionOriginalValueIdx());
5657 unsigned Index = isa<ConstantInt>(ValIdx)
5658 ? cast<ConstantInt>(ValIdx)->getZExtValue()
5659 : -1;
5660 Type *PromotedType = getTransitionType();
5661
5662 StoreInst *ST = cast<StoreInst>(CombineInst);
5663 unsigned AS = ST->getPointerAddressSpace();
5664 unsigned Align = ST->getAlignment();
5665 // Check if this store is supported.
5666 if (!TLI.allowsMisalignedMemoryAccesses(
Mehdi Amini44ede332015-07-09 02:09:04 +00005667 TLI.getValueType(DL, ST->getValueOperand()->getType()), AS,
5668 Align)) {
Quentin Colombetc32615d2014-10-31 17:52:53 +00005669 // If this is not supported, there is no way we can combine
5670 // the extract with the store.
5671 return false;
5672 }
5673
5674 // The scalar chain of computation has to pay for the transition
5675 // scalar to vector.
5676 // The vector chain has to account for the combining cost.
5677 uint64_t ScalarCost =
5678 TTI.getVectorInstrCost(Transition->getOpcode(), PromotedType, Index);
5679 uint64_t VectorCost = StoreExtractCombineCost;
5680 for (const auto &Inst : InstsToBePromoted) {
5681 // Compute the cost.
5682 // By construction, all instructions being promoted are arithmetic ones.
5683 // Moreover, one argument is a constant that can be viewed as a splat
5684 // constant.
5685 Value *Arg0 = Inst->getOperand(0);
5686 bool IsArg0Constant = isa<UndefValue>(Arg0) || isa<ConstantInt>(Arg0) ||
5687 isa<ConstantFP>(Arg0);
5688 TargetTransformInfo::OperandValueKind Arg0OVK =
5689 IsArg0Constant ? TargetTransformInfo::OK_UniformConstantValue
5690 : TargetTransformInfo::OK_AnyValue;
5691 TargetTransformInfo::OperandValueKind Arg1OVK =
5692 !IsArg0Constant ? TargetTransformInfo::OK_UniformConstantValue
5693 : TargetTransformInfo::OK_AnyValue;
5694 ScalarCost += TTI.getArithmeticInstrCost(
5695 Inst->getOpcode(), Inst->getType(), Arg0OVK, Arg1OVK);
5696 VectorCost += TTI.getArithmeticInstrCost(Inst->getOpcode(), PromotedType,
5697 Arg0OVK, Arg1OVK);
5698 }
5699 DEBUG(dbgs() << "Estimated cost of computation to be promoted:\nScalar: "
5700 << ScalarCost << "\nVector: " << VectorCost << '\n');
5701 return ScalarCost > VectorCost;
5702 }
5703
5704 /// \brief Generate a constant vector with \p Val with the same
5705 /// number of elements as the transition.
5706 /// \p UseSplat defines whether or not \p Val should be replicated
Benjamin Kramerdf005cb2015-08-08 18:27:36 +00005707 /// across the whole vector.
Quentin Colombetc32615d2014-10-31 17:52:53 +00005708 /// In other words, if UseSplat == true, we generate <Val, Val, ..., Val>,
5709 /// otherwise we generate a vector with as many undef as possible:
5710 /// <undef, ..., undef, Val, undef, ..., undef> where \p Val is only
5711 /// used at the index of the extract.
5712 Value *getConstantVector(Constant *Val, bool UseSplat) const {
5713 unsigned ExtractIdx = UINT_MAX;
5714 if (!UseSplat) {
5715 // If we cannot determine where the constant must be, we have to
5716 // use a splat constant.
5717 Value *ValExtractIdx = Transition->getOperand(getTransitionIdx());
5718 if (ConstantInt *CstVal = dyn_cast<ConstantInt>(ValExtractIdx))
5719 ExtractIdx = CstVal->getSExtValue();
5720 else
5721 UseSplat = true;
5722 }
5723
5724 unsigned End = getTransitionType()->getVectorNumElements();
5725 if (UseSplat)
5726 return ConstantVector::getSplat(End, Val);
5727
5728 SmallVector<Constant *, 4> ConstVec;
5729 UndefValue *UndefVal = UndefValue::get(Val->getType());
5730 for (unsigned Idx = 0; Idx != End; ++Idx) {
5731 if (Idx == ExtractIdx)
5732 ConstVec.push_back(Val);
5733 else
5734 ConstVec.push_back(UndefVal);
5735 }
5736 return ConstantVector::get(ConstVec);
5737 }
5738
5739 /// \brief Check if promoting to a vector type an operand at \p OperandIdx
5740 /// in \p Use can trigger undefined behavior.
5741 static bool canCauseUndefinedBehavior(const Instruction *Use,
5742 unsigned OperandIdx) {
5743 // This is not safe to introduce undef when the operand is on
5744 // the right hand side of a division-like instruction.
5745 if (OperandIdx != 1)
5746 return false;
5747 switch (Use->getOpcode()) {
5748 default:
5749 return false;
5750 case Instruction::SDiv:
5751 case Instruction::UDiv:
5752 case Instruction::SRem:
5753 case Instruction::URem:
5754 return true;
5755 case Instruction::FDiv:
5756 case Instruction::FRem:
5757 return !Use->hasNoNaNs();
5758 }
5759 llvm_unreachable(nullptr);
5760 }
5761
5762public:
Mehdi Amini44ede332015-07-09 02:09:04 +00005763 VectorPromoteHelper(const DataLayout &DL, const TargetLowering &TLI,
5764 const TargetTransformInfo &TTI, Instruction *Transition,
5765 unsigned CombineCost)
5766 : DL(DL), TLI(TLI), TTI(TTI), Transition(Transition),
Quentin Colombetc32615d2014-10-31 17:52:53 +00005767 StoreExtractCombineCost(CombineCost), CombineInst(nullptr) {
5768 assert(Transition && "Do not know how to promote null");
5769 }
5770
5771 /// \brief Check if we can promote \p ToBePromoted to \p Type.
5772 bool canPromote(const Instruction *ToBePromoted) const {
5773 // We could support CastInst too.
5774 return isa<BinaryOperator>(ToBePromoted);
5775 }
5776
5777 /// \brief Check if it is profitable to promote \p ToBePromoted
5778 /// by moving downward the transition through.
5779 bool shouldPromote(const Instruction *ToBePromoted) const {
5780 // Promote only if all the operands can be statically expanded.
5781 // Indeed, we do not want to introduce any new kind of transitions.
5782 for (const Use &U : ToBePromoted->operands()) {
5783 const Value *Val = U.get();
5784 if (Val == getEndOfTransition()) {
5785 // If the use is a division and the transition is on the rhs,
5786 // we cannot promote the operation, otherwise we may create a
5787 // division by zero.
5788 if (canCauseUndefinedBehavior(ToBePromoted, U.getOperandNo()))
5789 return false;
5790 continue;
5791 }
5792 if (!isa<ConstantInt>(Val) && !isa<UndefValue>(Val) &&
5793 !isa<ConstantFP>(Val))
5794 return false;
5795 }
5796 // Check that the resulting operation is legal.
5797 int ISDOpcode = TLI.InstructionOpcodeToISD(ToBePromoted->getOpcode());
5798 if (!ISDOpcode)
5799 return false;
5800 return StressStoreExtract ||
Ahmed Bougacha026600d2014-11-12 23:05:03 +00005801 TLI.isOperationLegalOrCustom(
Mehdi Amini44ede332015-07-09 02:09:04 +00005802 ISDOpcode, TLI.getValueType(DL, getTransitionType(), true));
Quentin Colombetc32615d2014-10-31 17:52:53 +00005803 }
5804
5805 /// \brief Check whether or not \p Use can be combined
5806 /// with the transition.
5807 /// I.e., is it possible to do Use(Transition) => AnotherUse?
5808 bool canCombine(const Instruction *Use) { return isa<StoreInst>(Use); }
5809
5810 /// \brief Record \p ToBePromoted as part of the chain to be promoted.
5811 void enqueueForPromotion(Instruction *ToBePromoted) {
5812 InstsToBePromoted.push_back(ToBePromoted);
5813 }
5814
5815 /// \brief Set the instruction that will be combined with the transition.
5816 void recordCombineInstruction(Instruction *ToBeCombined) {
5817 assert(canCombine(ToBeCombined) && "Unsupported instruction to combine");
5818 CombineInst = ToBeCombined;
5819 }
5820
5821 /// \brief Promote all the instructions enqueued for promotion if it is
5822 /// is profitable.
5823 /// \return True if the promotion happened, false otherwise.
5824 bool promote() {
5825 // Check if there is something to promote.
5826 // Right now, if we do not have anything to combine with,
5827 // we assume the promotion is not profitable.
5828 if (InstsToBePromoted.empty() || !CombineInst)
5829 return false;
5830
5831 // Check cost.
5832 if (!StressStoreExtract && !isProfitableToPromote())
5833 return false;
5834
5835 // Promote.
5836 for (auto &ToBePromoted : InstsToBePromoted)
5837 promoteImpl(ToBePromoted);
5838 InstsToBePromoted.clear();
5839 return true;
5840 }
5841};
5842} // End of anonymous namespace.
5843
5844void VectorPromoteHelper::promoteImpl(Instruction *ToBePromoted) {
5845 // At this point, we know that all the operands of ToBePromoted but Def
5846 // can be statically promoted.
5847 // For Def, we need to use its parameter in ToBePromoted:
5848 // b = ToBePromoted ty1 a
5849 // Def = Transition ty1 b to ty2
5850 // Move the transition down.
5851 // 1. Replace all uses of the promoted operation by the transition.
5852 // = ... b => = ... Def.
5853 assert(ToBePromoted->getType() == Transition->getType() &&
5854 "The type of the result of the transition does not match "
5855 "the final type");
5856 ToBePromoted->replaceAllUsesWith(Transition);
5857 // 2. Update the type of the uses.
5858 // b = ToBePromoted ty2 Def => b = ToBePromoted ty1 Def.
5859 Type *TransitionTy = getTransitionType();
5860 ToBePromoted->mutateType(TransitionTy);
5861 // 3. Update all the operands of the promoted operation with promoted
5862 // operands.
5863 // b = ToBePromoted ty1 Def => b = ToBePromoted ty1 a.
5864 for (Use &U : ToBePromoted->operands()) {
5865 Value *Val = U.get();
5866 Value *NewVal = nullptr;
5867 if (Val == Transition)
5868 NewVal = Transition->getOperand(getTransitionOriginalValueIdx());
5869 else if (isa<UndefValue>(Val) || isa<ConstantInt>(Val) ||
5870 isa<ConstantFP>(Val)) {
5871 // Use a splat constant if it is not safe to use undef.
5872 NewVal = getConstantVector(
5873 cast<Constant>(Val),
5874 isa<UndefValue>(Val) ||
5875 canCauseUndefinedBehavior(ToBePromoted, U.getOperandNo()));
5876 } else
Craig Topperd3c02f12015-01-05 10:15:49 +00005877 llvm_unreachable("Did you modified shouldPromote and forgot to update "
5878 "this?");
Quentin Colombetc32615d2014-10-31 17:52:53 +00005879 ToBePromoted->setOperand(U.getOperandNo(), NewVal);
5880 }
5881 Transition->removeFromParent();
5882 Transition->insertAfter(ToBePromoted);
5883 Transition->setOperand(getTransitionOriginalValueIdx(), ToBePromoted);
5884}
5885
5886/// Some targets can do store(extractelement) with one instruction.
5887/// Try to push the extractelement towards the stores when the target
5888/// has this feature and this is profitable.
Sanjay Patelfc580a62015-09-21 23:03:16 +00005889bool CodeGenPrepare::optimizeExtractElementInst(Instruction *Inst) {
Quentin Colombetc32615d2014-10-31 17:52:53 +00005890 unsigned CombineCost = UINT_MAX;
5891 if (DisableStoreExtract || !TLI ||
5892 (!StressStoreExtract &&
5893 !TLI->canCombineStoreAndExtract(Inst->getOperand(0)->getType(),
5894 Inst->getOperand(1), CombineCost)))
5895 return false;
5896
5897 // At this point we know that Inst is a vector to scalar transition.
5898 // Try to move it down the def-use chain, until:
5899 // - We can combine the transition with its single use
5900 // => we got rid of the transition.
5901 // - We escape the current basic block
5902 // => we would need to check that we are moving it at a cheaper place and
5903 // we do not do that for now.
5904 BasicBlock *Parent = Inst->getParent();
5905 DEBUG(dbgs() << "Found an interesting transition: " << *Inst << '\n');
Mehdi Amini44ede332015-07-09 02:09:04 +00005906 VectorPromoteHelper VPH(*DL, *TLI, *TTI, Inst, CombineCost);
Quentin Colombetc32615d2014-10-31 17:52:53 +00005907 // If the transition has more than one use, assume this is not going to be
5908 // beneficial.
5909 while (Inst->hasOneUse()) {
5910 Instruction *ToBePromoted = cast<Instruction>(*Inst->user_begin());
5911 DEBUG(dbgs() << "Use: " << *ToBePromoted << '\n');
5912
5913 if (ToBePromoted->getParent() != Parent) {
5914 DEBUG(dbgs() << "Instruction to promote is in a different block ("
5915 << ToBePromoted->getParent()->getName()
5916 << ") than the transition (" << Parent->getName() << ").\n");
5917 return false;
5918 }
5919
5920 if (VPH.canCombine(ToBePromoted)) {
5921 DEBUG(dbgs() << "Assume " << *Inst << '\n'
5922 << "will be combined with: " << *ToBePromoted << '\n');
5923 VPH.recordCombineInstruction(ToBePromoted);
5924 bool Changed = VPH.promote();
5925 NumStoreExtractExposed += Changed;
5926 return Changed;
5927 }
5928
5929 DEBUG(dbgs() << "Try promoting.\n");
5930 if (!VPH.canPromote(ToBePromoted) || !VPH.shouldPromote(ToBePromoted))
5931 return false;
5932
5933 DEBUG(dbgs() << "Promoting is possible... Enqueue for promotion!\n");
5934
5935 VPH.enqueueForPromotion(ToBePromoted);
5936 Inst = ToBePromoted;
5937 }
5938 return false;
5939}
5940
Wei Mia2f0b592016-12-22 19:44:45 +00005941/// For the instruction sequence of store below, F and I values
5942/// are bundled together as an i64 value before being stored into memory.
5943/// Sometimes it is more efficent to generate separate stores for F and I,
5944/// which can remove the bitwise instructions or sink them to colder places.
5945///
5946/// (store (or (zext (bitcast F to i32) to i64),
5947/// (shl (zext I to i64), 32)), addr) -->
5948/// (store F, addr) and (store I, addr+4)
5949///
5950/// Similarly, splitting for other merged store can also be beneficial, like:
5951/// For pair of {i32, i32}, i64 store --> two i32 stores.
5952/// For pair of {i32, i16}, i64 store --> two i32 stores.
5953/// For pair of {i16, i16}, i32 store --> two i16 stores.
5954/// For pair of {i16, i8}, i32 store --> two i16 stores.
5955/// For pair of {i8, i8}, i16 store --> two i8 stores.
5956///
5957/// We allow each target to determine specifically which kind of splitting is
5958/// supported.
5959///
5960/// The store patterns are commonly seen from the simple code snippet below
5961/// if only std::make_pair(...) is sroa transformed before inlined into hoo.
5962/// void goo(const std::pair<int, float> &);
5963/// hoo() {
5964/// ...
5965/// goo(std::make_pair(tmp, ftmp));
5966/// ...
5967/// }
5968///
5969/// Although we already have similar splitting in DAG Combine, we duplicate
5970/// it in CodeGenPrepare to catch the case in which pattern is across
5971/// multiple BBs. The logic in DAG Combine is kept to catch case generated
5972/// during code expansion.
5973static bool splitMergedValStore(StoreInst &SI, const DataLayout &DL,
5974 const TargetLowering &TLI) {
5975 // Handle simple but common cases only.
5976 Type *StoreType = SI.getValueOperand()->getType();
5977 if (DL.getTypeStoreSizeInBits(StoreType) != DL.getTypeSizeInBits(StoreType) ||
5978 DL.getTypeSizeInBits(StoreType) == 0)
5979 return false;
5980
5981 unsigned HalfValBitSize = DL.getTypeSizeInBits(StoreType) / 2;
5982 Type *SplitStoreType = Type::getIntNTy(SI.getContext(), HalfValBitSize);
5983 if (DL.getTypeStoreSizeInBits(SplitStoreType) !=
5984 DL.getTypeSizeInBits(SplitStoreType))
5985 return false;
5986
5987 // Match the following patterns:
5988 // (store (or (zext LValue to i64),
5989 // (shl (zext HValue to i64), 32)), HalfValBitSize)
5990 // or
5991 // (store (or (shl (zext HValue to i64), 32)), HalfValBitSize)
5992 // (zext LValue to i64),
5993 // Expect both operands of OR and the first operand of SHL have only
5994 // one use.
5995 Value *LValue, *HValue;
5996 if (!match(SI.getValueOperand(),
5997 m_c_Or(m_OneUse(m_ZExt(m_Value(LValue))),
5998 m_OneUse(m_Shl(m_OneUse(m_ZExt(m_Value(HValue))),
5999 m_SpecificInt(HalfValBitSize))))))
6000 return false;
6001
6002 // Check LValue and HValue are int with size less or equal than 32.
6003 if (!LValue->getType()->isIntegerTy() ||
6004 DL.getTypeSizeInBits(LValue->getType()) > HalfValBitSize ||
6005 !HValue->getType()->isIntegerTy() ||
6006 DL.getTypeSizeInBits(HValue->getType()) > HalfValBitSize)
6007 return false;
6008
6009 // If LValue/HValue is a bitcast instruction, use the EVT before bitcast
6010 // as the input of target query.
6011 auto *LBC = dyn_cast<BitCastInst>(LValue);
6012 auto *HBC = dyn_cast<BitCastInst>(HValue);
6013 EVT LowTy = LBC ? EVT::getEVT(LBC->getOperand(0)->getType())
6014 : EVT::getEVT(LValue->getType());
6015 EVT HighTy = HBC ? EVT::getEVT(HBC->getOperand(0)->getType())
6016 : EVT::getEVT(HValue->getType());
6017 if (!ForceSplitStore && !TLI.isMultiStoresCheaperThanBitsMerge(LowTy, HighTy))
6018 return false;
6019
6020 // Start to split store.
6021 IRBuilder<> Builder(SI.getContext());
6022 Builder.SetInsertPoint(&SI);
6023
6024 // If LValue/HValue is a bitcast in another BB, create a new one in current
6025 // BB so it may be merged with the splitted stores by dag combiner.
6026 if (LBC && LBC->getParent() != SI.getParent())
6027 LValue = Builder.CreateBitCast(LBC->getOperand(0), LBC->getType());
6028 if (HBC && HBC->getParent() != SI.getParent())
6029 HValue = Builder.CreateBitCast(HBC->getOperand(0), HBC->getType());
6030
6031 auto CreateSplitStore = [&](Value *V, bool Upper) {
6032 V = Builder.CreateZExtOrBitCast(V, SplitStoreType);
6033 Value *Addr = Builder.CreateBitCast(
6034 SI.getOperand(1),
6035 SplitStoreType->getPointerTo(SI.getPointerAddressSpace()));
6036 if (Upper)
6037 Addr = Builder.CreateGEP(
6038 SplitStoreType, Addr,
6039 ConstantInt::get(Type::getInt32Ty(SI.getContext()), 1));
6040 Builder.CreateAlignedStore(
6041 V, Addr, Upper ? SI.getAlignment() / 2 : SI.getAlignment());
6042 };
6043
6044 CreateSplitStore(LValue, false);
6045 CreateSplitStore(HValue, true);
6046
6047 // Delete the old store.
6048 SI.eraseFromParent();
6049 return true;
6050}
6051
Sanjay Patel3b8974b2017-06-08 20:00:09 +00006052bool CodeGenPrepare::optimizeInst(Instruction *I, bool &ModifiedDT) {
Ahmed Bougachaf3299142015-06-17 20:44:32 +00006053 // Bail out if we inserted the instruction to prevent optimizations from
6054 // stepping on each other's toes.
6055 if (InsertedInsts.count(I))
6056 return false;
6057
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006058 if (PHINode *P = dyn_cast<PHINode>(I)) {
6059 // It is possible for very late stage optimizations (such as SimplifyCFG)
6060 // to introduce PHI nodes too late to be cleaned up. If we detect such a
6061 // trivial PHI, go ahead and zap it here.
Daniel Berlin4d0fe642017-04-28 19:55:38 +00006062 if (Value *V = SimplifyInstruction(P, {*DL, TLInfo})) {
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006063 P->replaceAllUsesWith(V);
6064 P->eraseFromParent();
6065 ++NumPHIsElim;
Chris Lattneree588de2011-01-15 07:29:01 +00006066 return true;
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006067 }
Chris Lattneree588de2011-01-15 07:29:01 +00006068 return false;
6069 }
Nadav Rotem465834c2012-07-24 10:51:42 +00006070
Chris Lattneree588de2011-01-15 07:29:01 +00006071 if (CastInst *CI = dyn_cast<CastInst>(I)) {
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006072 // If the source of the cast is a constant, then this should have
6073 // already been constant folded. The only reason NOT to constant fold
6074 // it is if something (e.g. LSR) was careful to place the constant
6075 // evaluation in a block other than then one that uses it (e.g. to hoist
6076 // the address of globals out of a loop). If this is the case, we don't
6077 // want to forward-subst the cast.
6078 if (isa<Constant>(CI->getOperand(0)))
6079 return false;
6080
Mehdi Amini44ede332015-07-09 02:09:04 +00006081 if (TLI && OptimizeNoopCopyExpression(CI, *TLI, *DL))
Chris Lattneree588de2011-01-15 07:29:01 +00006082 return true;
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006083
Chris Lattneree588de2011-01-15 07:29:01 +00006084 if (isa<ZExtInst>(I) || isa<SExtInst>(I)) {
Manuel Jacoba7c48f92014-03-13 13:36:25 +00006085 /// Sink a zext or sext into its user blocks if the target type doesn't
6086 /// fit in one register
Mehdi Amini44ede332015-07-09 02:09:04 +00006087 if (TLI &&
6088 TLI->getTypeAction(CI->getContext(),
6089 TLI->getValueType(*DL, CI->getType())) ==
6090 TargetLowering::TypeExpandInteger) {
Manuel Jacoba7c48f92014-03-13 13:36:25 +00006091 return SinkCast(CI);
6092 } else {
Jun Bum Limdee55652017-04-03 19:20:07 +00006093 bool MadeChange = optimizeExt(I);
Sanjay Patelfc580a62015-09-21 23:03:16 +00006094 return MadeChange | optimizeExtUses(I);
Manuel Jacoba7c48f92014-03-13 13:36:25 +00006095 }
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006096 }
Chris Lattneree588de2011-01-15 07:29:01 +00006097 return false;
6098 }
Nadav Rotem465834c2012-07-24 10:51:42 +00006099
Chris Lattneree588de2011-01-15 07:29:01 +00006100 if (CmpInst *CI = dyn_cast<CmpInst>(I))
Hal Finkeldecb0242014-01-02 21:13:43 +00006101 if (!TLI || !TLI->hasMultipleConditionRegisters())
Peter Zotovf87e5502016-04-03 17:11:53 +00006102 return OptimizeCmpExpression(CI, TLI);
Nadav Rotem465834c2012-07-24 10:51:42 +00006103
Chris Lattneree588de2011-01-15 07:29:01 +00006104 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
Sanjoy Das00757272016-12-16 20:29:39 +00006105 LI->setMetadata(LLVMContext::MD_invariant_group, nullptr);
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00006106 if (TLI) {
Geoff Berry5256fca2015-11-20 22:34:39 +00006107 bool Modified = optimizeLoadExt(LI);
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00006108 unsigned AS = LI->getPointerAddressSpace();
Geoff Berry5256fca2015-11-20 22:34:39 +00006109 Modified |= optimizeMemoryInst(I, I->getOperand(0), LI->getType(), AS);
6110 return Modified;
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00006111 }
Hans Wennborgf3254832012-10-30 11:23:25 +00006112 return false;
Chris Lattneree588de2011-01-15 07:29:01 +00006113 }
Nadav Rotem465834c2012-07-24 10:51:42 +00006114
Chris Lattneree588de2011-01-15 07:29:01 +00006115 if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
Wei Mia2f0b592016-12-22 19:44:45 +00006116 if (TLI && splitMergedValStore(*SI, *DL, *TLI))
6117 return true;
Sanjoy Das00757272016-12-16 20:29:39 +00006118 SI->setMetadata(LLVMContext::MD_invariant_group, nullptr);
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00006119 if (TLI) {
6120 unsigned AS = SI->getPointerAddressSpace();
Sanjay Patelfc580a62015-09-21 23:03:16 +00006121 return optimizeMemoryInst(I, SI->getOperand(1),
Matt Arsenaultf72b49b2015-06-04 16:17:38 +00006122 SI->getOperand(0)->getType(), AS);
6123 }
Chris Lattneree588de2011-01-15 07:29:01 +00006124 return false;
6125 }
Nadav Rotem465834c2012-07-24 10:51:42 +00006126
Matt Arsenault02d915b2017-03-15 22:35:20 +00006127 if (AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(I)) {
6128 unsigned AS = RMW->getPointerAddressSpace();
6129 return optimizeMemoryInst(I, RMW->getPointerOperand(),
6130 RMW->getType(), AS);
6131 }
6132
6133 if (AtomicCmpXchgInst *CmpX = dyn_cast<AtomicCmpXchgInst>(I)) {
6134 unsigned AS = CmpX->getPointerAddressSpace();
6135 return optimizeMemoryInst(I, CmpX->getPointerOperand(),
6136 CmpX->getCompareOperand()->getType(), AS);
6137 }
6138
Yi Jiangd069f632014-04-21 19:34:27 +00006139 BinaryOperator *BinOp = dyn_cast<BinaryOperator>(I);
6140
Geoff Berry5d534b62017-02-21 18:53:14 +00006141 if (BinOp && (BinOp->getOpcode() == Instruction::And) &&
6142 EnableAndCmpSinking && TLI)
6143 return sinkAndCmp0Expression(BinOp, *TLI, InsertedInsts);
6144
Yi Jiangd069f632014-04-21 19:34:27 +00006145 if (BinOp && (BinOp->getOpcode() == Instruction::AShr ||
6146 BinOp->getOpcode() == Instruction::LShr)) {
6147 ConstantInt *CI = dyn_cast<ConstantInt>(BinOp->getOperand(1));
6148 if (TLI && CI && TLI->hasExtractBitsInsn())
Mehdi Amini44ede332015-07-09 02:09:04 +00006149 return OptimizeExtractBits(BinOp, CI, *TLI, *DL);
Yi Jiangd069f632014-04-21 19:34:27 +00006150
6151 return false;
6152 }
6153
Chris Lattneree588de2011-01-15 07:29:01 +00006154 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
Cameron Zwarichd28c78e2011-01-06 02:44:52 +00006155 if (GEPI->hasAllZeroIndices()) {
6156 /// The GEP operand must be a pointer, so must its result -> BitCast
6157 Instruction *NC = new BitCastInst(GEPI->getOperand(0), GEPI->getType(),
6158 GEPI->getName(), GEPI);
6159 GEPI->replaceAllUsesWith(NC);
6160 GEPI->eraseFromParent();
6161 ++NumGEPsElim;
Sanjay Patelfc580a62015-09-21 23:03:16 +00006162 optimizeInst(NC, ModifiedDT);
Chris Lattneree588de2011-01-15 07:29:01 +00006163 return true;
Cameron Zwarichd28c78e2011-01-06 02:44:52 +00006164 }
Chris Lattneree588de2011-01-15 07:29:01 +00006165 return false;
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006166 }
Nadav Rotem465834c2012-07-24 10:51:42 +00006167
Chris Lattneree588de2011-01-15 07:29:01 +00006168 if (CallInst *CI = dyn_cast<CallInst>(I))
Sanjay Patelfc580a62015-09-21 23:03:16 +00006169 return optimizeCallInst(CI, ModifiedDT);
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006170
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00006171 if (SelectInst *SI = dyn_cast<SelectInst>(I))
Sanjay Patelfc580a62015-09-21 23:03:16 +00006172 return optimizeSelectInst(SI);
Benjamin Kramer047d7ca2012-05-05 12:49:22 +00006173
Tim Northoveraeb8e062014-02-19 10:02:43 +00006174 if (ShuffleVectorInst *SVI = dyn_cast<ShuffleVectorInst>(I))
Sanjay Patelfc580a62015-09-21 23:03:16 +00006175 return optimizeShuffleVectorInst(SVI);
Tim Northoveraeb8e062014-02-19 10:02:43 +00006176
Sanjay Patel0ed9aea2015-11-02 23:22:49 +00006177 if (auto *Switch = dyn_cast<SwitchInst>(I))
6178 return optimizeSwitchInst(Switch);
6179
Quentin Colombetc32615d2014-10-31 17:52:53 +00006180 if (isa<ExtractElementInst>(I))
Sanjay Patelfc580a62015-09-21 23:03:16 +00006181 return optimizeExtractElementInst(I);
Quentin Colombetc32615d2014-10-31 17:52:53 +00006182
Chris Lattneree588de2011-01-15 07:29:01 +00006183 return false;
Cameron Zwarich14ac8652011-01-06 02:37:26 +00006184}
6185
James Molloyf01488e2016-01-15 09:20:19 +00006186/// Given an OR instruction, check to see if this is a bitreverse
6187/// idiom. If so, insert the new intrinsic and return true.
6188static bool makeBitReverse(Instruction &I, const DataLayout &DL,
6189 const TargetLowering &TLI) {
6190 if (!I.getType()->isIntegerTy() ||
6191 !TLI.isOperationLegalOrCustom(ISD::BITREVERSE,
6192 TLI.getValueType(DL, I.getType(), true)))
6193 return false;
6194
6195 SmallVector<Instruction*, 4> Insts;
Chad Rosiera00df492016-05-25 16:22:14 +00006196 if (!recognizeBSwapOrBitReverseIdiom(&I, false, true, Insts))
James Molloyf01488e2016-01-15 09:20:19 +00006197 return false;
6198 Instruction *LastInst = Insts.back();
6199 I.replaceAllUsesWith(LastInst);
6200 RecursivelyDeleteTriviallyDeadInstructions(&I);
6201 return true;
6202}
6203
Chris Lattnerf2836d12007-03-31 04:06:36 +00006204// In this pass we look for GEP and cast instructions that are used
6205// across basic blocks and rewrite them to improve basic-block-at-a-time
6206// selection.
Sanjay Patel3b8974b2017-06-08 20:00:09 +00006207bool CodeGenPrepare::optimizeBlock(BasicBlock &BB, bool &ModifiedDT) {
Cameron Zwarichce3b9302011-01-06 00:42:50 +00006208 SunkAddrs.clear();
Cameron Zwarich5dd2aa22011-03-02 03:31:46 +00006209 bool MadeChange = false;
Eric Christopherc1ea1492008-09-24 05:32:41 +00006210
Chris Lattner7a277142011-01-15 07:14:54 +00006211 CurInstIterator = BB.begin();
Elena Demikhovsky87700a72014-12-28 08:54:45 +00006212 while (CurInstIterator != BB.end()) {
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00006213 MadeChange |= optimizeInst(&*CurInstIterator++, ModifiedDT);
Elena Demikhovsky87700a72014-12-28 08:54:45 +00006214 if (ModifiedDT)
6215 return true;
6216 }
Benjamin Kramer455fa352012-11-23 19:17:06 +00006217
James Molloyf01488e2016-01-15 09:20:19 +00006218 bool MadeBitReverse = true;
6219 while (TLI && MadeBitReverse) {
6220 MadeBitReverse = false;
6221 for (auto &I : reverse(BB)) {
6222 if (makeBitReverse(I, *DL, *TLI)) {
6223 MadeBitReverse = MadeChange = true;
George Burgess IVd4febd12016-03-22 21:25:08 +00006224 ModifiedDT = true;
James Molloyf01488e2016-01-15 09:20:19 +00006225 break;
6226 }
6227 }
6228 }
James Molloy3ef84c42016-01-15 10:36:01 +00006229 MadeChange |= dupRetToEnableTailCallOpts(&BB);
Junmo Park7d6c5f12016-01-28 09:42:39 +00006230
Chris Lattnerf2836d12007-03-31 04:06:36 +00006231 return MadeChange;
6232}
Devang Patel53771ba2011-08-18 00:50:51 +00006233
6234// llvm.dbg.value is far away from the value then iSel may not be able
Nadav Rotem465834c2012-07-24 10:51:42 +00006235// handle it properly. iSel will drop llvm.dbg.value if it can not
Devang Patel53771ba2011-08-18 00:50:51 +00006236// find a node corresponding to the value.
Sanjay Patelfc580a62015-09-21 23:03:16 +00006237bool CodeGenPrepare::placeDbgValues(Function &F) {
Devang Patel53771ba2011-08-18 00:50:51 +00006238 bool MadeChange = false;
Duncan P. N. Exon Smith5914a972015-01-08 20:44:33 +00006239 for (BasicBlock &BB : F) {
Craig Topperc0196b12014-04-14 00:51:57 +00006240 Instruction *PrevNonDbgInst = nullptr;
Duncan P. N. Exon Smith5914a972015-01-08 20:44:33 +00006241 for (BasicBlock::iterator BI = BB.begin(), BE = BB.end(); BI != BE;) {
Duncan P. N. Exon Smithd83547a2015-10-09 18:44:40 +00006242 Instruction *Insn = &*BI++;
Devang Patel53771ba2011-08-18 00:50:51 +00006243 DbgValueInst *DVI = dyn_cast<DbgValueInst>(Insn);
Adrian Prantl32da8892014-04-25 20:49:25 +00006244 // Leave dbg.values that refer to an alloca alone. These
6245 // instrinsics describe the address of a variable (= the alloca)
6246 // being taken. They should not be moved next to the alloca
6247 // (and to the beginning of the scope), but rather stay close to
6248 // where said address is used.
6249 if (!DVI || (DVI->getValue() && isa<AllocaInst>(DVI->getValue()))) {
Devang Patel53771ba2011-08-18 00:50:51 +00006250 PrevNonDbgInst = Insn;
6251 continue;
6252 }
6253
6254 Instruction *VI = dyn_cast_or_null<Instruction>(DVI->getValue());
6255 if (VI && VI != PrevNonDbgInst && !VI->isTerminator()) {
Reid Kleckner8de1fe22015-12-08 23:00:03 +00006256 // If VI is a phi in a block with an EHPad terminator, we can't insert
6257 // after it.
6258 if (isa<PHINode>(VI) && VI->getParent()->getTerminator()->isEHPad())
6259 continue;
Devang Patel53771ba2011-08-18 00:50:51 +00006260 DEBUG(dbgs() << "Moving Debug Value before :\n" << *DVI << ' ' << *VI);
6261 DVI->removeFromParent();
Reid Klecknere18f92b2015-12-08 22:33:23 +00006262 if (isa<PHINode>(VI))
6263 DVI->insertBefore(&*VI->getParent()->getFirstInsertionPt());
6264 else
6265 DVI->insertAfter(VI);
Devang Patel53771ba2011-08-18 00:50:51 +00006266 MadeChange = true;
6267 ++NumDbgValueMoved;
6268 }
6269 }
6270 }
6271 return MadeChange;
6272}
Tim Northovercea0abb2014-03-29 08:22:29 +00006273
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006274/// \brief Scale down both weights to fit into uint32_t.
6275static void scaleWeights(uint64_t &NewTrue, uint64_t &NewFalse) {
6276 uint64_t NewMax = (NewTrue > NewFalse) ? NewTrue : NewFalse;
6277 uint32_t Scale = (NewMax / UINT32_MAX) + 1;
6278 NewTrue = NewTrue / Scale;
6279 NewFalse = NewFalse / Scale;
6280}
6281
6282/// \brief Some targets prefer to split a conditional branch like:
6283/// \code
6284/// %0 = icmp ne i32 %a, 0
6285/// %1 = icmp ne i32 %b, 0
6286/// %or.cond = or i1 %0, %1
6287/// br i1 %or.cond, label %TrueBB, label %FalseBB
6288/// \endcode
6289/// into multiple branch instructions like:
6290/// \code
6291/// bb1:
6292/// %0 = icmp ne i32 %a, 0
6293/// br i1 %0, label %TrueBB, label %bb2
6294/// bb2:
6295/// %1 = icmp ne i32 %b, 0
6296/// br i1 %1, label %TrueBB, label %FalseBB
6297/// \endcode
6298/// This usually allows instruction selection to do even further optimizations
6299/// and combine the compare with the branch instruction. Currently this is
6300/// applied for targets which have "cheap" jump instructions.
6301///
6302/// FIXME: Remove the (equivalent?) implementation in SelectionDAG.
6303///
6304bool CodeGenPrepare::splitBranchCondition(Function &F) {
David Blaikiedc3f01e2015-03-09 01:57:13 +00006305 if (!TM || !TM->Options.EnableFastISel || !TLI || TLI->isJumpExpensive())
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006306 return false;
6307
6308 bool MadeChange = false;
6309 for (auto &BB : F) {
6310 // Does this BB end with the following?
6311 // %cond1 = icmp|fcmp|binary instruction ...
6312 // %cond2 = icmp|fcmp|binary instruction ...
6313 // %cond.or = or|and i1 %cond1, cond2
6314 // br i1 %cond.or label %dest1, label %dest2"
6315 BinaryOperator *LogicOp;
6316 BasicBlock *TBB, *FBB;
6317 if (!match(BB.getTerminator(), m_Br(m_OneUse(m_BinOp(LogicOp)), TBB, FBB)))
6318 continue;
6319
Sanjay Patel42574202015-09-02 19:23:23 +00006320 auto *Br1 = cast<BranchInst>(BB.getTerminator());
6321 if (Br1->getMetadata(LLVMContext::MD_unpredictable))
6322 continue;
6323
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006324 unsigned Opc;
Juergen Ributzka8bda7382014-12-09 17:50:10 +00006325 Value *Cond1, *Cond2;
6326 if (match(LogicOp, m_And(m_OneUse(m_Value(Cond1)),
6327 m_OneUse(m_Value(Cond2)))))
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006328 Opc = Instruction::And;
Juergen Ributzka8bda7382014-12-09 17:50:10 +00006329 else if (match(LogicOp, m_Or(m_OneUse(m_Value(Cond1)),
6330 m_OneUse(m_Value(Cond2)))))
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006331 Opc = Instruction::Or;
6332 else
6333 continue;
6334
6335 if (!match(Cond1, m_CombineOr(m_Cmp(), m_BinOp())) ||
6336 !match(Cond2, m_CombineOr(m_Cmp(), m_BinOp())) )
6337 continue;
6338
6339 DEBUG(dbgs() << "Before branch condition splitting\n"; BB.dump());
6340
6341 // Create a new BB.
Duncan P. N. Exon Smitha848c472016-02-21 19:52:15 +00006342 auto TmpBB =
6343 BasicBlock::Create(BB.getContext(), BB.getName() + ".cond.split",
6344 BB.getParent(), BB.getNextNode());
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006345
6346 // Update original basic block by using the first condition directly by the
6347 // branch instruction and removing the no longer needed and/or instruction.
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006348 Br1->setCondition(Cond1);
6349 LogicOp->eraseFromParent();
Juergen Ributzka8bda7382014-12-09 17:50:10 +00006350
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006351 // Depending on the conditon we have to either replace the true or the false
6352 // successor of the original branch instruction.
6353 if (Opc == Instruction::And)
6354 Br1->setSuccessor(0, TmpBB);
6355 else
6356 Br1->setSuccessor(1, TmpBB);
6357
6358 // Fill in the new basic block.
6359 auto *Br2 = IRBuilder<>(TmpBB).CreateCondBr(Cond2, TBB, FBB);
Juergen Ributzka8bda7382014-12-09 17:50:10 +00006360 if (auto *I = dyn_cast<Instruction>(Cond2)) {
6361 I->removeFromParent();
6362 I->insertBefore(Br2);
6363 }
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006364
6365 // Update PHI nodes in both successors. The original BB needs to be
6366 // replaced in one succesor's PHI nodes, because the branch comes now from
6367 // the newly generated BB (NewBB). In the other successor we need to add one
6368 // incoming edge to the PHI nodes, because both branch instructions target
6369 // now the same successor. Depending on the original branch condition
6370 // (and/or) we have to swap the successors (TrueDest, FalseDest), so that
Simon Pilgrimf2fbf432016-11-20 13:47:59 +00006371 // we perform the correct update for the PHI nodes.
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006372 // This doesn't change the successor order of the just created branch
6373 // instruction (or any other instruction).
6374 if (Opc == Instruction::Or)
6375 std::swap(TBB, FBB);
6376
6377 // Replace the old BB with the new BB.
6378 for (auto &I : *TBB) {
6379 PHINode *PN = dyn_cast<PHINode>(&I);
6380 if (!PN)
6381 break;
6382 int i;
6383 while ((i = PN->getBasicBlockIndex(&BB)) >= 0)
6384 PN->setIncomingBlock(i, TmpBB);
6385 }
6386
6387 // Add another incoming edge form the new BB.
6388 for (auto &I : *FBB) {
6389 PHINode *PN = dyn_cast<PHINode>(&I);
6390 if (!PN)
6391 break;
6392 auto *Val = PN->getIncomingValueForBlock(&BB);
6393 PN->addIncoming(Val, TmpBB);
6394 }
6395
6396 // Update the branch weights (from SelectionDAGBuilder::
6397 // FindMergedConditions).
6398 if (Opc == Instruction::Or) {
6399 // Codegen X | Y as:
6400 // BB1:
6401 // jmp_if_X TBB
6402 // jmp TmpBB
6403 // TmpBB:
6404 // jmp_if_Y TBB
6405 // jmp FBB
6406 //
6407
6408 // We have flexibility in setting Prob for BB1 and Prob for NewBB.
6409 // The requirement is that
6410 // TrueProb for BB1 + (FalseProb for BB1 * TrueProb for TmpBB)
6411 // = TrueProb for orignal BB.
6412 // Assuming the orignal weights are A and B, one choice is to set BB1's
6413 // weights to A and A+2B, and set TmpBB's weights to A and 2B. This choice
6414 // assumes that
6415 // TrueProb for BB1 == FalseProb for BB1 * TrueProb for TmpBB.
6416 // Another choice is to assume TrueProb for BB1 equals to TrueProb for
6417 // TmpBB, but the math is more complicated.
6418 uint64_t TrueWeight, FalseWeight;
Sanjay Pateldc88bd62016-04-23 20:01:22 +00006419 if (Br1->extractProfMetadata(TrueWeight, FalseWeight)) {
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006420 uint64_t NewTrueWeight = TrueWeight;
6421 uint64_t NewFalseWeight = TrueWeight + 2 * FalseWeight;
6422 scaleWeights(NewTrueWeight, NewFalseWeight);
6423 Br1->setMetadata(LLVMContext::MD_prof, MDBuilder(Br1->getContext())
6424 .createBranchWeights(TrueWeight, FalseWeight));
6425
6426 NewTrueWeight = TrueWeight;
6427 NewFalseWeight = 2 * FalseWeight;
6428 scaleWeights(NewTrueWeight, NewFalseWeight);
6429 Br2->setMetadata(LLVMContext::MD_prof, MDBuilder(Br2->getContext())
6430 .createBranchWeights(TrueWeight, FalseWeight));
6431 }
6432 } else {
6433 // Codegen X & Y as:
6434 // BB1:
6435 // jmp_if_X TmpBB
6436 // jmp FBB
6437 // TmpBB:
6438 // jmp_if_Y TBB
6439 // jmp FBB
6440 //
6441 // This requires creation of TmpBB after CurBB.
6442
6443 // We have flexibility in setting Prob for BB1 and Prob for TmpBB.
6444 // The requirement is that
6445 // FalseProb for BB1 + (TrueProb for BB1 * FalseProb for TmpBB)
6446 // = FalseProb for orignal BB.
6447 // Assuming the orignal weights are A and B, one choice is to set BB1's
6448 // weights to 2A+B and B, and set TmpBB's weights to 2A and B. This choice
6449 // assumes that
6450 // FalseProb for BB1 == TrueProb for BB1 * FalseProb for TmpBB.
6451 uint64_t TrueWeight, FalseWeight;
Sanjay Pateldc88bd62016-04-23 20:01:22 +00006452 if (Br1->extractProfMetadata(TrueWeight, FalseWeight)) {
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006453 uint64_t NewTrueWeight = 2 * TrueWeight + FalseWeight;
6454 uint64_t NewFalseWeight = FalseWeight;
6455 scaleWeights(NewTrueWeight, NewFalseWeight);
6456 Br1->setMetadata(LLVMContext::MD_prof, MDBuilder(Br1->getContext())
6457 .createBranchWeights(TrueWeight, FalseWeight));
6458
6459 NewTrueWeight = 2 * TrueWeight;
6460 NewFalseWeight = FalseWeight;
6461 scaleWeights(NewTrueWeight, NewFalseWeight);
6462 Br2->setMetadata(LLVMContext::MD_prof, MDBuilder(Br2->getContext())
6463 .createBranchWeights(TrueWeight, FalseWeight));
6464 }
6465 }
6466
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006467 // Note: No point in getting fancy here, since the DT info is never
Quentin Colombet7bdd50d2015-03-18 23:17:28 +00006468 // available to CodeGenPrepare.
Juergen Ributzkac1bbcbb2014-12-09 16:36:13 +00006469 ModifiedDT = true;
6470
6471 MadeChange = true;
6472
6473 DEBUG(dbgs() << "After branch condition splitting\n"; BB.dump();
6474 TmpBB->dump());
6475 }
6476 return MadeChange;
6477}