1 //===- CodeGenPrepare.cpp - Prepare a function for code generation --------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass munges the code in the input function to better prepare it for
11 // SelectionDAG-based code generation. This works around limitations in it's
12 // basic-block-at-a-time approach. It should eventually be removed.
14 //===----------------------------------------------------------------------===//
16 #define DEBUG_TYPE "codegenprepare"
17 #include "llvm/Transforms/Scalar.h"
18 #include "llvm/Constants.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Function.h"
21 #include "llvm/InlineAsm.h"
22 #include "llvm/Instructions.h"
23 #include "llvm/Pass.h"
24 #include "llvm/Target/TargetAsmInfo.h"
25 #include "llvm/Target/TargetData.h"
26 #include "llvm/Target/TargetLowering.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
29 #include "llvm/Transforms/Utils/Local.h"
30 #include "llvm/ADT/DenseMap.h"
31 #include "llvm/ADT/SmallSet.h"
32 #include "llvm/Support/CallSite.h"
33 #include "llvm/Support/Compiler.h"
34 #include "llvm/Support/Debug.h"
35 #include "llvm/Support/GetElementPtrTypeIterator.h"
39 class VISIBILITY_HIDDEN CodeGenPrepare : public FunctionPass {
40 /// TLI - Keep a pointer of a TargetLowering to consult for determining
41 /// transformation profitability.
42 const TargetLowering *TLI;
44 static char ID; // Pass identification, replacement for typeid
45 explicit CodeGenPrepare(const TargetLowering *tli = 0)
46 : FunctionPass((intptr_t)&ID), TLI(tli) {}
47 bool runOnFunction(Function &F);
50 bool EliminateMostlyEmptyBlocks(Function &F);
51 bool CanMergeBlocks(const BasicBlock *BB, const BasicBlock *DestBB) const;
52 void EliminateMostlyEmptyBlock(BasicBlock *BB);
53 bool OptimizeBlock(BasicBlock &BB);
54 bool OptimizeLoadStoreInst(Instruction *I, Value *Addr,
56 DenseMap<Value*,Value*> &SunkAddrs);
57 bool OptimizeInlineAsmInst(Instruction *I, CallSite CS,
58 DenseMap<Value*,Value*> &SunkAddrs);
59 bool OptimizeExtUses(Instruction *I);
63 char CodeGenPrepare::ID = 0;
64 static RegisterPass<CodeGenPrepare> X("codegenprepare",
65 "Optimize for code generation");
67 FunctionPass *llvm::createCodeGenPreparePass(const TargetLowering *TLI) {
68 return new CodeGenPrepare(TLI);
72 bool CodeGenPrepare::runOnFunction(Function &F) {
73 bool EverMadeChange = false;
75 // First pass, eliminate blocks that contain only PHI nodes and an
76 // unconditional branch.
77 EverMadeChange |= EliminateMostlyEmptyBlocks(F);
79 bool MadeChange = true;
82 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
83 MadeChange |= OptimizeBlock(*BB);
84 EverMadeChange |= MadeChange;
86 return EverMadeChange;
89 /// EliminateMostlyEmptyBlocks - eliminate blocks that contain only PHI nodes
90 /// and an unconditional branch. Passes before isel (e.g. LSR/loopsimplify)
91 /// often split edges in ways that are non-optimal for isel. Start by
92 /// eliminating these blocks so we can split them the way we want them.
93 bool CodeGenPrepare::EliminateMostlyEmptyBlocks(Function &F) {
94 bool MadeChange = false;
95 // Note that this intentionally skips the entry block.
96 for (Function::iterator I = ++F.begin(), E = F.end(); I != E; ) {
99 // If this block doesn't end with an uncond branch, ignore it.
100 BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator());
101 if (!BI || !BI->isUnconditional())
104 // If the instruction before the branch isn't a phi node, then other stuff
105 // is happening here.
106 BasicBlock::iterator BBI = BI;
107 if (BBI != BB->begin()) {
109 if (!isa<PHINode>(BBI)) continue;
112 // Do not break infinite loops.
113 BasicBlock *DestBB = BI->getSuccessor(0);
117 if (!CanMergeBlocks(BB, DestBB))
120 EliminateMostlyEmptyBlock(BB);
126 /// CanMergeBlocks - Return true if we can merge BB into DestBB if there is a
127 /// single uncond branch between them, and BB contains no other non-phi
129 bool CodeGenPrepare::CanMergeBlocks(const BasicBlock *BB,
130 const BasicBlock *DestBB) const {
131 // We only want to eliminate blocks whose phi nodes are used by phi nodes in
132 // the successor. If there are more complex condition (e.g. preheaders),
133 // don't mess around with them.
134 BasicBlock::const_iterator BBI = BB->begin();
135 while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
136 for (Value::use_const_iterator UI = PN->use_begin(), E = PN->use_end();
138 const Instruction *User = cast<Instruction>(*UI);
139 if (User->getParent() != DestBB || !isa<PHINode>(User))
141 // If User is inside DestBB block and it is a PHINode then check
142 // incoming value. If incoming value is not from BB then this is
143 // a complex condition (e.g. preheaders) we want to avoid here.
144 if (User->getParent() == DestBB) {
145 if (const PHINode *UPN = dyn_cast<PHINode>(User))
146 for (unsigned I = 0, E = UPN->getNumIncomingValues(); I != E; ++I) {
147 Instruction *Insn = dyn_cast<Instruction>(UPN->getIncomingValue(I));
148 if (Insn && Insn->getParent() == BB &&
149 Insn->getParent() != UPN->getIncomingBlock(I))
156 // If BB and DestBB contain any common predecessors, then the phi nodes in BB
157 // and DestBB may have conflicting incoming values for the block. If so, we
158 // can't merge the block.
159 const PHINode *DestBBPN = dyn_cast<PHINode>(DestBB->begin());
160 if (!DestBBPN) return true; // no conflict.
162 // Collect the preds of BB.
163 SmallPtrSet<const BasicBlock*, 16> BBPreds;
164 if (const PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
165 // It is faster to get preds from a PHI than with pred_iterator.
166 for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
167 BBPreds.insert(BBPN->getIncomingBlock(i));
169 BBPreds.insert(pred_begin(BB), pred_end(BB));
172 // Walk the preds of DestBB.
173 for (unsigned i = 0, e = DestBBPN->getNumIncomingValues(); i != e; ++i) {
174 BasicBlock *Pred = DestBBPN->getIncomingBlock(i);
175 if (BBPreds.count(Pred)) { // Common predecessor?
176 BBI = DestBB->begin();
177 while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
178 const Value *V1 = PN->getIncomingValueForBlock(Pred);
179 const Value *V2 = PN->getIncomingValueForBlock(BB);
181 // If V2 is a phi node in BB, look up what the mapped value will be.
182 if (const PHINode *V2PN = dyn_cast<PHINode>(V2))
183 if (V2PN->getParent() == BB)
184 V2 = V2PN->getIncomingValueForBlock(Pred);
186 // If there is a conflict, bail out.
187 if (V1 != V2) return false;
196 /// EliminateMostlyEmptyBlock - Eliminate a basic block that have only phi's and
197 /// an unconditional branch in it.
198 void CodeGenPrepare::EliminateMostlyEmptyBlock(BasicBlock *BB) {
199 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
200 BasicBlock *DestBB = BI->getSuccessor(0);
202 DOUT << "MERGING MOSTLY EMPTY BLOCKS - BEFORE:\n" << *BB << *DestBB;
204 // If the destination block has a single pred, then this is a trivial edge,
206 if (DestBB->getSinglePredecessor()) {
207 // If DestBB has single-entry PHI nodes, fold them.
208 while (PHINode *PN = dyn_cast<PHINode>(DestBB->begin())) {
209 PN->replaceAllUsesWith(PN->getIncomingValue(0));
210 PN->eraseFromParent();
213 // Splice all the PHI nodes from BB over to DestBB.
214 DestBB->getInstList().splice(DestBB->begin(), BB->getInstList(),
217 // Anything that branched to BB now branches to DestBB.
218 BB->replaceAllUsesWith(DestBB);
221 BB->eraseFromParent();
223 DOUT << "AFTER:\n" << *DestBB << "\n\n\n";
227 // Otherwise, we have multiple predecessors of BB. Update the PHIs in DestBB
228 // to handle the new incoming edges it is about to have.
230 for (BasicBlock::iterator BBI = DestBB->begin();
231 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
232 // Remove the incoming value for BB, and remember it.
233 Value *InVal = PN->removeIncomingValue(BB, false);
235 // Two options: either the InVal is a phi node defined in BB or it is some
236 // value that dominates BB.
237 PHINode *InValPhi = dyn_cast<PHINode>(InVal);
238 if (InValPhi && InValPhi->getParent() == BB) {
239 // Add all of the input values of the input PHI as inputs of this phi.
240 for (unsigned i = 0, e = InValPhi->getNumIncomingValues(); i != e; ++i)
241 PN->addIncoming(InValPhi->getIncomingValue(i),
242 InValPhi->getIncomingBlock(i));
244 // Otherwise, add one instance of the dominating value for each edge that
245 // we will be adding.
246 if (PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
247 for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
248 PN->addIncoming(InVal, BBPN->getIncomingBlock(i));
250 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
251 PN->addIncoming(InVal, *PI);
256 // The PHIs are now updated, change everything that refers to BB to use
257 // DestBB and remove BB.
258 BB->replaceAllUsesWith(DestBB);
259 BB->eraseFromParent();
261 DOUT << "AFTER:\n" << *DestBB << "\n\n\n";
265 /// SplitEdgeNicely - Split the critical edge from TI to its specified
266 /// successor if it will improve codegen. We only do this if the successor has
267 /// phi nodes (otherwise critical edges are ok). If there is already another
268 /// predecessor of the succ that is empty (and thus has no phi nodes), use it
269 /// instead of introducing a new block.
270 static void SplitEdgeNicely(TerminatorInst *TI, unsigned SuccNum, Pass *P) {
271 BasicBlock *TIBB = TI->getParent();
272 BasicBlock *Dest = TI->getSuccessor(SuccNum);
273 assert(isa<PHINode>(Dest->begin()) &&
274 "This should only be called if Dest has a PHI!");
276 // As a hack, never split backedges of loops. Even though the copy for any
277 // PHIs inserted on the backedge would be dead for exits from the loop, we
278 // assume that the cost of *splitting* the backedge would be too high.
282 /// TIPHIValues - This array is lazily computed to determine the values of
283 /// PHIs in Dest that TI would provide.
284 SmallVector<Value*, 32> TIPHIValues;
286 // Check to see if Dest has any blocks that can be used as a split edge for
288 for (pred_iterator PI = pred_begin(Dest), E = pred_end(Dest); PI != E; ++PI) {
289 BasicBlock *Pred = *PI;
290 // To be usable, the pred has to end with an uncond branch to the dest.
291 BranchInst *PredBr = dyn_cast<BranchInst>(Pred->getTerminator());
292 if (!PredBr || !PredBr->isUnconditional() ||
293 // Must be empty other than the branch.
294 &Pred->front() != PredBr ||
295 // Cannot be the entry block; its label does not get emitted.
296 Pred == &(Dest->getParent()->getEntryBlock()))
299 // Finally, since we know that Dest has phi nodes in it, we have to make
300 // sure that jumping to Pred will have the same affect as going to Dest in
301 // terms of PHI values.
304 bool FoundMatch = true;
305 for (BasicBlock::iterator I = Dest->begin();
306 (PN = dyn_cast<PHINode>(I)); ++I, ++PHINo) {
307 if (PHINo == TIPHIValues.size())
308 TIPHIValues.push_back(PN->getIncomingValueForBlock(TIBB));
310 // If the PHI entry doesn't work, we can't use this pred.
311 if (TIPHIValues[PHINo] != PN->getIncomingValueForBlock(Pred)) {
317 // If we found a workable predecessor, change TI to branch to Succ.
319 Dest->removePredecessor(TIBB);
320 TI->setSuccessor(SuccNum, Pred);
325 SplitCriticalEdge(TI, SuccNum, P, true);
328 /// OptimizeNoopCopyExpression - If the specified cast instruction is a noop
329 /// copy (e.g. it's casting from one pointer type to another, int->uint, or
330 /// int->sbyte on PPC), sink it into user blocks to reduce the number of virtual
331 /// registers that must be created and coalesced.
333 /// Return true if any changes are made.
334 static bool OptimizeNoopCopyExpression(CastInst *CI, const TargetLowering &TLI){
335 // If this is a noop copy,
336 MVT::ValueType SrcVT = TLI.getValueType(CI->getOperand(0)->getType());
337 MVT::ValueType DstVT = TLI.getValueType(CI->getType());
339 // This is an fp<->int conversion?
340 if (MVT::isInteger(SrcVT) != MVT::isInteger(DstVT))
343 // If this is an extension, it will be a zero or sign extension, which
345 if (SrcVT < DstVT) return false;
347 // If these values will be promoted, find out what they will be promoted
348 // to. This helps us consider truncates on PPC as noop copies when they
350 if (TLI.getTypeAction(SrcVT) == TargetLowering::Promote)
351 SrcVT = TLI.getTypeToTransformTo(SrcVT);
352 if (TLI.getTypeAction(DstVT) == TargetLowering::Promote)
353 DstVT = TLI.getTypeToTransformTo(DstVT);
355 // If, after promotion, these are the same types, this is a noop copy.
359 BasicBlock *DefBB = CI->getParent();
361 /// InsertedCasts - Only insert a cast in each block once.
362 DenseMap<BasicBlock*, CastInst*> InsertedCasts;
364 bool MadeChange = false;
365 for (Value::use_iterator UI = CI->use_begin(), E = CI->use_end();
367 Use &TheUse = UI.getUse();
368 Instruction *User = cast<Instruction>(*UI);
370 // Figure out which BB this cast is used in. For PHI's this is the
371 // appropriate predecessor block.
372 BasicBlock *UserBB = User->getParent();
373 if (PHINode *PN = dyn_cast<PHINode>(User)) {
374 unsigned OpVal = UI.getOperandNo()/2;
375 UserBB = PN->getIncomingBlock(OpVal);
378 // Preincrement use iterator so we don't invalidate it.
381 // If this user is in the same block as the cast, don't change the cast.
382 if (UserBB == DefBB) continue;
384 // If we have already inserted a cast into this block, use it.
385 CastInst *&InsertedCast = InsertedCasts[UserBB];
388 BasicBlock::iterator InsertPt = UserBB->begin();
389 while (isa<PHINode>(InsertPt)) ++InsertPt;
392 CastInst::create(CI->getOpcode(), CI->getOperand(0), CI->getType(), "",
397 // Replace a use of the cast with a use of the new cast.
398 TheUse = InsertedCast;
401 // If we removed all uses, nuke the cast.
402 if (CI->use_empty()) {
403 CI->eraseFromParent();
410 /// OptimizeCmpExpression - sink the given CmpInst into user blocks to reduce
411 /// the number of virtual registers that must be created and coalesced. This is
412 /// a clear win except on targets with multiple condition code registers
413 /// (PowerPC), where it might lose; some adjustment may be wanted there.
415 /// Return true if any changes are made.
416 static bool OptimizeCmpExpression(CmpInst *CI){
418 BasicBlock *DefBB = CI->getParent();
420 /// InsertedCmp - Only insert a cmp in each block once.
421 DenseMap<BasicBlock*, CmpInst*> InsertedCmps;
423 bool MadeChange = false;
424 for (Value::use_iterator UI = CI->use_begin(), E = CI->use_end();
426 Use &TheUse = UI.getUse();
427 Instruction *User = cast<Instruction>(*UI);
429 // Preincrement use iterator so we don't invalidate it.
432 // Don't bother for PHI nodes.
433 if (isa<PHINode>(User))
436 // Figure out which BB this cmp is used in.
437 BasicBlock *UserBB = User->getParent();
439 // If this user is in the same block as the cmp, don't change the cmp.
440 if (UserBB == DefBB) continue;
442 // If we have already inserted a cmp into this block, use it.
443 CmpInst *&InsertedCmp = InsertedCmps[UserBB];
446 BasicBlock::iterator InsertPt = UserBB->begin();
447 while (isa<PHINode>(InsertPt)) ++InsertPt;
450 CmpInst::create(CI->getOpcode(), CI->getPredicate(), CI->getOperand(0),
451 CI->getOperand(1), "", InsertPt);
455 // Replace a use of the cmp with a use of the new cmp.
456 TheUse = InsertedCmp;
459 // If we removed all uses, nuke the cmp.
461 CI->eraseFromParent();
466 /// EraseDeadInstructions - Erase any dead instructions
467 static void EraseDeadInstructions(Value *V) {
468 Instruction *I = dyn_cast<Instruction>(V);
469 if (!I || !I->use_empty()) return;
471 SmallPtrSet<Instruction*, 16> Insts;
474 while (!Insts.empty()) {
477 if (isInstructionTriviallyDead(I)) {
478 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
479 if (Instruction *U = dyn_cast<Instruction>(I->getOperand(i)))
481 I->eraseFromParent();
487 /// ExtAddrMode - This is an extended version of TargetLowering::AddrMode which
488 /// holds actual Value*'s for register values.
489 struct ExtAddrMode : public TargetLowering::AddrMode {
492 ExtAddrMode() : BaseReg(0), ScaledReg(0) {}
496 static std::ostream &operator<<(std::ostream &OS, const ExtAddrMode &AM) {
497 bool NeedPlus = false;
500 OS << (NeedPlus ? " + " : "")
501 << "GV:%" << AM.BaseGV->getName(), NeedPlus = true;
504 OS << (NeedPlus ? " + " : "") << AM.BaseOffs, NeedPlus = true;
507 OS << (NeedPlus ? " + " : "")
508 << "Base:%" << AM.BaseReg->getName(), NeedPlus = true;
510 OS << (NeedPlus ? " + " : "")
511 << AM.Scale << "*%" << AM.ScaledReg->getName(), NeedPlus = true;
516 void ExtAddrMode::dump() const {
517 cerr << *this << "\n";
520 static bool TryMatchingScaledValue(Value *ScaleReg, int64_t Scale,
521 const Type *AccessTy, ExtAddrMode &AddrMode,
522 SmallVector<Instruction*, 16> &AddrModeInsts,
523 const TargetLowering &TLI, unsigned Depth);
525 /// FindMaximalLegalAddressingMode - If we can, try to merge the computation of
526 /// Addr into the specified addressing mode. If Addr can't be added to AddrMode
527 /// this returns false. This assumes that Addr is either a pointer type or
528 /// intptr_t for the target.
529 static bool FindMaximalLegalAddressingMode(Value *Addr, const Type *AccessTy,
530 ExtAddrMode &AddrMode,
531 SmallVector<Instruction*, 16> &AddrModeInsts,
532 const TargetLowering &TLI,
535 // If this is a global variable, fold it into the addressing mode if possible.
536 if (GlobalValue *GV = dyn_cast<GlobalValue>(Addr)) {
537 if (AddrMode.BaseGV == 0) {
538 AddrMode.BaseGV = GV;
539 if (TLI.isLegalAddressingMode(AddrMode, AccessTy))
543 } else if (ConstantInt *CI = dyn_cast<ConstantInt>(Addr)) {
544 AddrMode.BaseOffs += CI->getSExtValue();
545 if (TLI.isLegalAddressingMode(AddrMode, AccessTy))
547 AddrMode.BaseOffs -= CI->getSExtValue();
548 } else if (isa<ConstantPointerNull>(Addr)) {
552 // Look through constant exprs and instructions.
553 unsigned Opcode = ~0U;
555 if (Instruction *I = dyn_cast<Instruction>(Addr)) {
556 Opcode = I->getOpcode();
558 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Addr)) {
559 Opcode = CE->getOpcode();
563 // Limit recursion to avoid exponential behavior.
564 if (Depth == 5) { AddrInst = 0; Opcode = ~0U; }
566 // If this is really an instruction, add it to our list of related
568 if (Instruction *I = dyn_cast_or_null<Instruction>(AddrInst))
569 AddrModeInsts.push_back(I);
572 case Instruction::PtrToInt:
573 // PtrToInt is always a noop, as we know that the int type is pointer sized.
574 if (FindMaximalLegalAddressingMode(AddrInst->getOperand(0), AccessTy,
575 AddrMode, AddrModeInsts, TLI, Depth))
578 case Instruction::IntToPtr:
579 // This inttoptr is a no-op if the integer type is pointer sized.
580 if (TLI.getValueType(AddrInst->getOperand(0)->getType()) ==
581 TLI.getPointerTy()) {
582 if (FindMaximalLegalAddressingMode(AddrInst->getOperand(0), AccessTy,
583 AddrMode, AddrModeInsts, TLI, Depth))
587 case Instruction::Add: {
588 // Check to see if we can merge in the RHS then the LHS. If so, we win.
589 ExtAddrMode BackupAddrMode = AddrMode;
590 unsigned OldSize = AddrModeInsts.size();
591 if (FindMaximalLegalAddressingMode(AddrInst->getOperand(1), AccessTy,
592 AddrMode, AddrModeInsts, TLI, Depth+1) &&
593 FindMaximalLegalAddressingMode(AddrInst->getOperand(0), AccessTy,
594 AddrMode, AddrModeInsts, TLI, Depth+1))
597 // Restore the old addr mode info.
598 AddrMode = BackupAddrMode;
599 AddrModeInsts.resize(OldSize);
601 // Otherwise this was over-aggressive. Try merging in the LHS then the RHS.
602 if (FindMaximalLegalAddressingMode(AddrInst->getOperand(0), AccessTy,
603 AddrMode, AddrModeInsts, TLI, Depth+1) &&
604 FindMaximalLegalAddressingMode(AddrInst->getOperand(1), AccessTy,
605 AddrMode, AddrModeInsts, TLI, Depth+1))
608 // Otherwise we definitely can't merge the ADD in.
609 AddrMode = BackupAddrMode;
610 AddrModeInsts.resize(OldSize);
613 case Instruction::Or: {
614 ConstantInt *RHS = dyn_cast<ConstantInt>(AddrInst->getOperand(1));
616 // TODO: We can handle "Or Val, Imm" iff this OR is equivalent to an ADD.
619 case Instruction::Mul:
620 case Instruction::Shl: {
621 // Can only handle X*C and X << C, and can only handle this when the scale
622 // field is available.
623 ConstantInt *RHS = dyn_cast<ConstantInt>(AddrInst->getOperand(1));
625 int64_t Scale = RHS->getSExtValue();
626 if (Opcode == Instruction::Shl)
629 if (TryMatchingScaledValue(AddrInst->getOperand(0), Scale, AccessTy,
630 AddrMode, AddrModeInsts, TLI, Depth))
634 case Instruction::GetElementPtr: {
635 // Scan the GEP. We check it if it contains constant offsets and at most
636 // one variable offset.
637 int VariableOperand = -1;
638 unsigned VariableScale = 0;
640 int64_t ConstantOffset = 0;
641 const TargetData *TD = TLI.getTargetData();
642 gep_type_iterator GTI = gep_type_begin(AddrInst);
643 for (unsigned i = 1, e = AddrInst->getNumOperands(); i != e; ++i, ++GTI) {
644 if (const StructType *STy = dyn_cast<StructType>(*GTI)) {
645 const StructLayout *SL = TD->getStructLayout(STy);
647 cast<ConstantInt>(AddrInst->getOperand(i))->getZExtValue();
648 ConstantOffset += SL->getElementOffset(Idx);
650 uint64_t TypeSize = TD->getABITypeSize(GTI.getIndexedType());
651 if (ConstantInt *CI = dyn_cast<ConstantInt>(AddrInst->getOperand(i))) {
652 ConstantOffset += CI->getSExtValue()*TypeSize;
653 } else if (TypeSize) { // Scales of zero don't do anything.
654 // We only allow one variable index at the moment.
655 if (VariableOperand != -1) {
656 VariableOperand = -2;
660 // Remember the variable index.
662 VariableScale = TypeSize;
667 // If the GEP had multiple variable indices, punt.
668 if (VariableOperand == -2)
671 // A common case is for the GEP to only do a constant offset. In this case,
672 // just add it to the disp field and check validity.
673 if (VariableOperand == -1) {
674 AddrMode.BaseOffs += ConstantOffset;
675 if (ConstantOffset == 0 || TLI.isLegalAddressingMode(AddrMode, AccessTy)){
676 // Check to see if we can fold the base pointer in too.
677 if (FindMaximalLegalAddressingMode(AddrInst->getOperand(0), AccessTy,
678 AddrMode, AddrModeInsts, TLI,
682 AddrMode.BaseOffs -= ConstantOffset;
684 // Check that this has no base reg yet. If so, we won't have a place to
685 // put the base of the GEP (assuming it is not a null ptr).
686 bool SetBaseReg = false;
687 if (AddrMode.HasBaseReg) {
688 if (!isa<ConstantPointerNull>(AddrInst->getOperand(0)))
691 AddrMode.HasBaseReg = true;
692 AddrMode.BaseReg = AddrInst->getOperand(0);
696 // See if the scale amount is valid for this target.
697 AddrMode.BaseOffs += ConstantOffset;
698 if (TryMatchingScaledValue(AddrInst->getOperand(VariableOperand),
699 VariableScale, AccessTy, AddrMode,
700 AddrModeInsts, TLI, Depth)) {
701 if (!SetBaseReg) return true;
703 // If this match succeeded, we know that we can form an address with the
704 // GepBase as the basereg. See if we can match *more*.
705 AddrMode.HasBaseReg = false;
706 AddrMode.BaseReg = 0;
707 if (FindMaximalLegalAddressingMode(AddrInst->getOperand(0), AccessTy,
708 AddrMode, AddrModeInsts, TLI,
711 // Strange, shouldn't happen. Restore the base reg and succeed the easy
713 AddrMode.HasBaseReg = true;
714 AddrMode.BaseReg = AddrInst->getOperand(0);
718 AddrMode.BaseOffs -= ConstantOffset;
720 AddrMode.HasBaseReg = false;
721 AddrMode.BaseReg = 0;
728 if (Instruction *I = dyn_cast_or_null<Instruction>(AddrInst)) {
729 assert(AddrModeInsts.back() == I && "Stack imbalance");
730 AddrModeInsts.pop_back();
733 // Worse case, the target should support [reg] addressing modes. :)
734 if (!AddrMode.HasBaseReg) {
735 AddrMode.HasBaseReg = true;
736 // Still check for legality in case the target supports [imm] but not [i+r].
737 if (TLI.isLegalAddressingMode(AddrMode, AccessTy)) {
738 AddrMode.BaseReg = Addr;
741 AddrMode.HasBaseReg = false;
744 // If the base register is already taken, see if we can do [r+r].
745 if (AddrMode.Scale == 0) {
747 if (TLI.isLegalAddressingMode(AddrMode, AccessTy)) {
748 AddrMode.ScaledReg = Addr;
757 /// TryMatchingScaledValue - Try adding ScaleReg*Scale to the specified
758 /// addressing mode. Return true if this addr mode is legal for the target,
760 static bool TryMatchingScaledValue(Value *ScaleReg, int64_t Scale,
761 const Type *AccessTy, ExtAddrMode &AddrMode,
762 SmallVector<Instruction*, 16> &AddrModeInsts,
763 const TargetLowering &TLI, unsigned Depth) {
764 // If we already have a scale of this value, we can add to it, otherwise, we
765 // need an available scale field.
766 if (AddrMode.Scale != 0 && AddrMode.ScaledReg != ScaleReg)
769 ExtAddrMode InputAddrMode = AddrMode;
771 // Add scale to turn X*4+X*3 -> X*7. This could also do things like
772 // [A+B + A*7] -> [B+A*8].
773 AddrMode.Scale += Scale;
774 AddrMode.ScaledReg = ScaleReg;
776 if (TLI.isLegalAddressingMode(AddrMode, AccessTy)) {
777 // Okay, we decided that we can add ScaleReg+Scale to AddrMode. Check now
778 // to see if ScaleReg is actually X+C. If so, we can turn this into adding
779 // X*Scale + C*Scale to addr mode.
780 BinaryOperator *BinOp = dyn_cast<BinaryOperator>(ScaleReg);
781 if (BinOp && BinOp->getOpcode() == Instruction::Add &&
782 isa<ConstantInt>(BinOp->getOperand(1)) && InputAddrMode.ScaledReg ==0) {
784 InputAddrMode.Scale = Scale;
785 InputAddrMode.ScaledReg = BinOp->getOperand(0);
786 InputAddrMode.BaseOffs +=
787 cast<ConstantInt>(BinOp->getOperand(1))->getSExtValue()*Scale;
788 if (TLI.isLegalAddressingMode(InputAddrMode, AccessTy)) {
789 AddrModeInsts.push_back(BinOp);
790 AddrMode = InputAddrMode;
795 // Otherwise, not (x+c)*scale, just return what we have.
799 // Otherwise, back this attempt out.
800 AddrMode.Scale -= Scale;
801 if (AddrMode.Scale == 0) AddrMode.ScaledReg = 0;
807 /// IsNonLocalValue - Return true if the specified values are defined in a
808 /// different basic block than BB.
809 static bool IsNonLocalValue(Value *V, BasicBlock *BB) {
810 if (Instruction *I = dyn_cast<Instruction>(V))
811 return I->getParent() != BB;
815 /// OptimizeLoadStoreInst - Load and Store Instructions have often have
816 /// addressing modes that can do significant amounts of computation. As such,
817 /// instruction selection will try to get the load or store to do as much
818 /// computation as possible for the program. The problem is that isel can only
819 /// see within a single block. As such, we sink as much legal addressing mode
820 /// stuff into the block as possible.
821 bool CodeGenPrepare::OptimizeLoadStoreInst(Instruction *LdStInst, Value *Addr,
822 const Type *AccessTy,
823 DenseMap<Value*,Value*> &SunkAddrs) {
824 // Figure out what addressing mode will be built up for this operation.
825 SmallVector<Instruction*, 16> AddrModeInsts;
826 ExtAddrMode AddrMode;
827 bool Success = FindMaximalLegalAddressingMode(Addr, AccessTy, AddrMode,
828 AddrModeInsts, *TLI, 0);
829 Success = Success; assert(Success && "Couldn't select *anything*?");
831 // Check to see if any of the instructions supersumed by this addr mode are
832 // non-local to I's BB.
833 bool AnyNonLocal = false;
834 for (unsigned i = 0, e = AddrModeInsts.size(); i != e; ++i) {
835 if (IsNonLocalValue(AddrModeInsts[i], LdStInst->getParent())) {
841 // If all the instructions matched are already in this BB, don't do anything.
843 DEBUG(cerr << "CGP: Found local addrmode: " << AddrMode << "\n");
847 // Insert this computation right after this user. Since our caller is
848 // scanning from the top of the BB to the bottom, reuse of the expr are
849 // guaranteed to happen later.
850 BasicBlock::iterator InsertPt = LdStInst;
852 // Now that we determined the addressing expression we want to use and know
853 // that we have to sink it into this block. Check to see if we have already
854 // done this for some other load/store instr in this block. If so, reuse the
856 Value *&SunkAddr = SunkAddrs[Addr];
858 DEBUG(cerr << "CGP: Reusing nonlocal addrmode: " << AddrMode << "\n");
859 if (SunkAddr->getType() != Addr->getType())
860 SunkAddr = new BitCastInst(SunkAddr, Addr->getType(), "tmp", InsertPt);
862 DEBUG(cerr << "CGP: SINKING nonlocal addrmode: " << AddrMode << "\n");
863 const Type *IntPtrTy = TLI->getTargetData()->getIntPtrType();
866 // Start with the scale value.
867 if (AddrMode.Scale) {
868 Value *V = AddrMode.ScaledReg;
869 if (V->getType() == IntPtrTy) {
871 } else if (isa<PointerType>(V->getType())) {
872 V = new PtrToIntInst(V, IntPtrTy, "sunkaddr", InsertPt);
873 } else if (cast<IntegerType>(IntPtrTy)->getBitWidth() <
874 cast<IntegerType>(V->getType())->getBitWidth()) {
875 V = new TruncInst(V, IntPtrTy, "sunkaddr", InsertPt);
877 V = new SExtInst(V, IntPtrTy, "sunkaddr", InsertPt);
879 if (AddrMode.Scale != 1)
880 V = BinaryOperator::createMul(V, ConstantInt::get(IntPtrTy,
882 "sunkaddr", InsertPt);
886 // Add in the base register.
887 if (AddrMode.BaseReg) {
888 Value *V = AddrMode.BaseReg;
889 if (V->getType() != IntPtrTy)
890 V = new PtrToIntInst(V, IntPtrTy, "sunkaddr", InsertPt);
892 Result = BinaryOperator::createAdd(Result, V, "sunkaddr", InsertPt);
897 // Add in the BaseGV if present.
898 if (AddrMode.BaseGV) {
899 Value *V = new PtrToIntInst(AddrMode.BaseGV, IntPtrTy, "sunkaddr",
902 Result = BinaryOperator::createAdd(Result, V, "sunkaddr", InsertPt);
907 // Add in the Base Offset if present.
908 if (AddrMode.BaseOffs) {
909 Value *V = ConstantInt::get(IntPtrTy, AddrMode.BaseOffs);
911 Result = BinaryOperator::createAdd(Result, V, "sunkaddr", InsertPt);
917 SunkAddr = Constant::getNullValue(Addr->getType());
919 SunkAddr = new IntToPtrInst(Result, Addr->getType(), "sunkaddr",InsertPt);
922 LdStInst->replaceUsesOfWith(Addr, SunkAddr);
924 if (Addr->use_empty())
925 EraseDeadInstructions(Addr);
929 /// OptimizeInlineAsmInst - If there are any memory operands, use
930 /// OptimizeLoadStoreInt to sink their address computing into the block when
931 /// possible / profitable.
932 bool CodeGenPrepare::OptimizeInlineAsmInst(Instruction *I, CallSite CS,
933 DenseMap<Value*,Value*> &SunkAddrs) {
934 bool MadeChange = false;
935 InlineAsm *IA = cast<InlineAsm>(CS.getCalledValue());
937 // Do a prepass over the constraints, canonicalizing them, and building up the
938 // ConstraintOperands list.
939 std::vector<InlineAsm::ConstraintInfo>
940 ConstraintInfos = IA->ParseConstraints();
942 /// ConstraintOperands - Information about all of the constraints.
943 std::vector<TargetLowering::AsmOperandInfo> ConstraintOperands;
944 unsigned ArgNo = 0; // ArgNo - The argument of the CallInst.
945 for (unsigned i = 0, e = ConstraintInfos.size(); i != e; ++i) {
947 push_back(TargetLowering::AsmOperandInfo(ConstraintInfos[i]));
948 TargetLowering::AsmOperandInfo &OpInfo = ConstraintOperands.back();
950 // Compute the value type for each operand.
951 switch (OpInfo.Type) {
952 case InlineAsm::isOutput:
953 if (OpInfo.isIndirect)
954 OpInfo.CallOperandVal = CS.getArgument(ArgNo++);
956 case InlineAsm::isInput:
957 OpInfo.CallOperandVal = CS.getArgument(ArgNo++);
959 case InlineAsm::isClobber:
964 // Compute the constraint code and ConstraintType to use.
965 OpInfo.ComputeConstraintToUse(*TLI);
967 if (OpInfo.ConstraintType == TargetLowering::C_Memory &&
969 Value *OpVal = OpInfo.CallOperandVal;
970 MadeChange |= OptimizeLoadStoreInst(I, OpVal, OpVal->getType(),
978 bool CodeGenPrepare::OptimizeExtUses(Instruction *I) {
979 BasicBlock *DefBB = I->getParent();
981 // If both result of the {s|z}xt and its source are live out, rewrite all
982 // other uses of the source with result of extension.
983 Value *Src = I->getOperand(0);
984 if (Src->hasOneUse())
987 // Only do this xform if truncating is free.
988 if (TLI && !TLI->isTruncateFree(I->getType(), Src->getType()))
991 // Only safe to perform the optimization if the source is also defined in
993 if (!isa<Instruction>(Src) || DefBB != cast<Instruction>(Src)->getParent())
996 bool DefIsLiveOut = false;
997 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
999 Instruction *User = cast<Instruction>(*UI);
1001 // Figure out which BB this ext is used in.
1002 BasicBlock *UserBB = User->getParent();
1003 if (UserBB == DefBB) continue;
1004 DefIsLiveOut = true;
1010 // Make sure non of the uses are PHI nodes.
1011 for (Value::use_iterator UI = Src->use_begin(), E = Src->use_end();
1013 Instruction *User = cast<Instruction>(*UI);
1014 BasicBlock *UserBB = User->getParent();
1015 if (UserBB == DefBB) continue;
1016 // Be conservative. We don't want this xform to end up introducing
1017 // reloads just before load / store instructions.
1018 if (isa<PHINode>(User) || isa<LoadInst>(User) || isa<StoreInst>(User))
1022 // InsertedTruncs - Only insert one trunc in each block once.
1023 DenseMap<BasicBlock*, Instruction*> InsertedTruncs;
1025 bool MadeChange = false;
1026 for (Value::use_iterator UI = Src->use_begin(), E = Src->use_end();
1028 Use &TheUse = UI.getUse();
1029 Instruction *User = cast<Instruction>(*UI);
1031 // Figure out which BB this ext is used in.
1032 BasicBlock *UserBB = User->getParent();
1033 if (UserBB == DefBB) continue;
1035 // Both src and def are live in this block. Rewrite the use.
1036 Instruction *&InsertedTrunc = InsertedTruncs[UserBB];
1038 if (!InsertedTrunc) {
1039 BasicBlock::iterator InsertPt = UserBB->begin();
1040 while (isa<PHINode>(InsertPt)) ++InsertPt;
1042 InsertedTrunc = new TruncInst(I, Src->getType(), "", InsertPt);
1045 // Replace a use of the {s|z}ext source with a use of the result.
1046 TheUse = InsertedTrunc;
1054 // In this pass we look for GEP and cast instructions that are used
1055 // across basic blocks and rewrite them to improve basic-block-at-a-time
1057 bool CodeGenPrepare::OptimizeBlock(BasicBlock &BB) {
1058 bool MadeChange = false;
1060 // Split all critical edges where the dest block has a PHI and where the phi
1061 // has shared immediate operands.
1062 TerminatorInst *BBTI = BB.getTerminator();
1063 if (BBTI->getNumSuccessors() > 1) {
1064 for (unsigned i = 0, e = BBTI->getNumSuccessors(); i != e; ++i)
1065 if (isa<PHINode>(BBTI->getSuccessor(i)->begin()) &&
1066 isCriticalEdge(BBTI, i, true))
1067 SplitEdgeNicely(BBTI, i, this);
1071 // Keep track of non-local addresses that have been sunk into this block.
1072 // This allows us to avoid inserting duplicate code for blocks with multiple
1073 // load/stores of the same address.
1074 DenseMap<Value*, Value*> SunkAddrs;
1076 for (BasicBlock::iterator BBI = BB.begin(), E = BB.end(); BBI != E; ) {
1077 Instruction *I = BBI++;
1079 if (CastInst *CI = dyn_cast<CastInst>(I)) {
1080 // If the source of the cast is a constant, then this should have
1081 // already been constant folded. The only reason NOT to constant fold
1082 // it is if something (e.g. LSR) was careful to place the constant
1083 // evaluation in a block other than then one that uses it (e.g. to hoist
1084 // the address of globals out of a loop). If this is the case, we don't
1085 // want to forward-subst the cast.
1086 if (isa<Constant>(CI->getOperand(0)))
1089 bool Change = false;
1091 Change = OptimizeNoopCopyExpression(CI, *TLI);
1092 MadeChange |= Change;
1095 if (!Change && (isa<ZExtInst>(I) || isa<SExtInst>(I)))
1096 MadeChange |= OptimizeExtUses(I);
1097 } else if (CmpInst *CI = dyn_cast<CmpInst>(I)) {
1098 MadeChange |= OptimizeCmpExpression(CI);
1099 } else if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
1101 MadeChange |= OptimizeLoadStoreInst(I, I->getOperand(0), LI->getType(),
1103 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
1105 MadeChange |= OptimizeLoadStoreInst(I, SI->getOperand(1),
1106 SI->getOperand(0)->getType(),
1108 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
1109 if (GEPI->hasAllZeroIndices()) {
1110 /// The GEP operand must be a pointer, so must its result -> BitCast
1111 Instruction *NC = new BitCastInst(GEPI->getOperand(0), GEPI->getType(),
1112 GEPI->getName(), GEPI);
1113 GEPI->replaceAllUsesWith(NC);
1114 GEPI->eraseFromParent();
1118 } else if (CallInst *CI = dyn_cast<CallInst>(I)) {
1119 // If we found an inline asm expession, and if the target knows how to
1120 // lower it to normal LLVM code, do so now.
1121 if (TLI && isa<InlineAsm>(CI->getCalledValue()))
1122 if (const TargetAsmInfo *TAI =
1123 TLI->getTargetMachine().getTargetAsmInfo()) {
1124 if (TAI->ExpandInlineAsm(CI))
1127 // Sink address computing for memory operands into the block.
1128 MadeChange |= OptimizeInlineAsmInst(I, &(*CI), SunkAddrs);
1130 } else if (GetResultInst *GRI = dyn_cast<GetResultInst>(I)) {
1131 // Ensure that all getresult instructions live in the same basic block
1132 // as their associated struct-value instructions. Codegen requires
1133 // this, as lowering only works on one basic block at a time.
1134 if (Instruction *Agg = dyn_cast<Instruction>(GRI->getAggregateValue())) {
1135 BasicBlock *AggBB = Agg->getParent();
1136 if (AggBB != GRI->getParent())
1137 GRI->moveBefore(AggBB->getTerminator());