2002-05-07 18:07:59 +00:00
|
|
|
//===-- Local.cpp - Functions to perform local transformations ------------===//
|
2005-04-21 23:48:37 +00:00
|
|
|
//
|
2003-10-20 19:43:21 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 20:36:04 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 23:48:37 +00:00
|
|
|
//
|
2003-10-20 19:43:21 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-05-07 18:07:59 +00:00
|
|
|
//
|
|
|
|
// This family of functions perform various local transformations to the
|
|
|
|
// program.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "llvm/Transforms/Utils/Local.h"
|
2004-01-12 18:35:03 +00:00
|
|
|
#include "llvm/Constants.h"
|
2009-06-16 17:23:12 +00:00
|
|
|
#include "llvm/GlobalAlias.h"
|
2009-03-06 00:19:37 +00:00
|
|
|
#include "llvm/GlobalVariable.h"
|
2005-09-26 05:27:10 +00:00
|
|
|
#include "llvm/DerivedTypes.h"
|
2004-01-12 19:56:36 +00:00
|
|
|
#include "llvm/Instructions.h"
|
2004-06-11 06:16:23 +00:00
|
|
|
#include "llvm/Intrinsics.h"
|
2007-12-29 00:59:12 +00:00
|
|
|
#include "llvm/IntrinsicInst.h"
|
2009-07-05 22:41:43 +00:00
|
|
|
#include "llvm/LLVMContext.h"
|
2009-05-02 18:29:22 +00:00
|
|
|
#include "llvm/ADT/SmallPtrSet.h"
|
2005-10-27 16:34:00 +00:00
|
|
|
#include "llvm/Analysis/ConstantFolding.h"
|
2009-03-06 00:19:37 +00:00
|
|
|
#include "llvm/Analysis/DebugInfo.h"
|
2007-01-30 23:13:49 +00:00
|
|
|
#include "llvm/Target/TargetData.h"
|
2005-09-26 05:27:10 +00:00
|
|
|
#include "llvm/Support/GetElementPtrTypeIterator.h"
|
|
|
|
#include "llvm/Support/MathExtras.h"
|
2003-12-19 05:56:28 +00:00
|
|
|
using namespace llvm;
|
2003-11-11 22:41:34 +00:00
|
|
|
|
2009-06-16 17:23:12 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Local analysis.
|
|
|
|
//
|
|
|
|
|
|
|
|
/// isSafeToLoadUnconditionally - Return true if we know that executing a load
|
|
|
|
/// from this value cannot trap. If it is not obviously safe to load from the
|
|
|
|
/// specified pointer, we do a quick local scan of the basic block containing
|
|
|
|
/// ScanFrom, to determine if the address is already accessed.
|
|
|
|
bool llvm::isSafeToLoadUnconditionally(Value *V, Instruction *ScanFrom) {
|
|
|
|
// If it is an alloca it is always safe to load from.
|
|
|
|
if (isa<AllocaInst>(V)) return true;
|
|
|
|
|
|
|
|
// If it is a global variable it is mostly safe to load from.
|
|
|
|
if (const GlobalValue *GV = dyn_cast<GlobalVariable>(V))
|
|
|
|
// Don't try to evaluate aliases. External weak GV can be null.
|
|
|
|
return !isa<GlobalAlias>(GV) && !GV->hasExternalWeakLinkage();
|
|
|
|
|
|
|
|
// Otherwise, be a little bit agressive by scanning the local block where we
|
|
|
|
// want to check to see if the pointer is already being loaded or stored
|
|
|
|
// from/to. If so, the previous load or store would have already trapped,
|
|
|
|
// so there is no harm doing an extra load (also, CSE will later eliminate
|
|
|
|
// the load entirely).
|
|
|
|
BasicBlock::iterator BBI = ScanFrom, E = ScanFrom->getParent()->begin();
|
|
|
|
|
|
|
|
while (BBI != E) {
|
|
|
|
--BBI;
|
|
|
|
|
|
|
|
// If we see a free or a call which may write to memory (i.e. which might do
|
|
|
|
// a free) the pointer could be marked invalid.
|
|
|
|
if (isa<FreeInst>(BBI) ||
|
|
|
|
(isa<CallInst>(BBI) && BBI->mayWriteToMemory() &&
|
|
|
|
!isa<DbgInfoIntrinsic>(BBI)))
|
|
|
|
return false;
|
|
|
|
|
|
|
|
if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
|
|
|
|
if (LI->getOperand(0) == V) return true;
|
|
|
|
} else if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
|
|
|
|
if (SI->getOperand(1) == V) return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2002-05-07 18:07:59 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2008-11-27 22:57:53 +00:00
|
|
|
// Local constant propagation.
|
2002-05-07 18:07:59 +00:00
|
|
|
//
|
|
|
|
|
|
|
|
// ConstantFoldTerminator - If a terminator instruction is predicated on a
|
|
|
|
// constant value, convert it into an unconditional branch to the constant
|
|
|
|
// destination.
|
|
|
|
//
|
2003-12-19 05:56:28 +00:00
|
|
|
bool llvm::ConstantFoldTerminator(BasicBlock *BB) {
|
2002-05-21 20:04:50 +00:00
|
|
|
TerminatorInst *T = BB->getTerminator();
|
2005-04-21 23:48:37 +00:00
|
|
|
|
2002-05-07 18:07:59 +00:00
|
|
|
// Branch - See if we are conditional jumping on constant
|
|
|
|
if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
|
|
|
|
if (BI->isUnconditional()) return false; // Can't optimize uncond branch
|
2009-01-30 18:21:13 +00:00
|
|
|
BasicBlock *Dest1 = BI->getSuccessor(0);
|
|
|
|
BasicBlock *Dest2 = BI->getSuccessor(1);
|
2002-05-07 18:07:59 +00:00
|
|
|
|
2007-01-11 12:24:14 +00:00
|
|
|
if (ConstantInt *Cond = dyn_cast<ConstantInt>(BI->getCondition())) {
|
2002-05-07 18:07:59 +00:00
|
|
|
// Are we branching on constant?
|
|
|
|
// YES. Change to unconditional branch...
|
2007-01-12 04:24:46 +00:00
|
|
|
BasicBlock *Destination = Cond->getZExtValue() ? Dest1 : Dest2;
|
|
|
|
BasicBlock *OldDest = Cond->getZExtValue() ? Dest2 : Dest1;
|
2002-05-07 18:07:59 +00:00
|
|
|
|
2005-04-21 23:48:37 +00:00
|
|
|
//cerr << "Function: " << T->getParent()->getParent()
|
|
|
|
// << "\nRemoving branch from " << T->getParent()
|
2002-05-07 18:07:59 +00:00
|
|
|
// << "\n\nTo: " << OldDest << endl;
|
|
|
|
|
|
|
|
// Let the basic block know that we are letting go of it. Based on this,
|
|
|
|
// it will adjust it's PHI nodes.
|
|
|
|
assert(BI->getParent() && "Terminator not inserted in block!");
|
|
|
|
OldDest->removePredecessor(BI->getParent());
|
|
|
|
|
|
|
|
// Set the unconditional destination, and change the insn to be an
|
|
|
|
// unconditional branch.
|
|
|
|
BI->setUnconditionalDest(Destination);
|
|
|
|
return true;
|
2003-08-17 19:34:55 +00:00
|
|
|
} else if (Dest2 == Dest1) { // Conditional branch to same location?
|
2005-04-21 23:48:37 +00:00
|
|
|
// This branch matches something like this:
|
2002-05-07 18:07:59 +00:00
|
|
|
// br bool %cond, label %Dest, label %Dest
|
|
|
|
// and changes it into: br label %Dest
|
|
|
|
|
|
|
|
// Let the basic block know that we are letting go of one copy of it.
|
|
|
|
assert(BI->getParent() && "Terminator not inserted in block!");
|
|
|
|
Dest1->removePredecessor(BI->getParent());
|
|
|
|
|
|
|
|
// Change a conditional branch to unconditional.
|
|
|
|
BI->setUnconditionalDest(Dest1);
|
|
|
|
return true;
|
|
|
|
}
|
2003-08-17 20:21:14 +00:00
|
|
|
} else if (SwitchInst *SI = dyn_cast<SwitchInst>(T)) {
|
|
|
|
// If we are switching on a constant, we can convert the switch into a
|
|
|
|
// single branch instruction!
|
|
|
|
ConstantInt *CI = dyn_cast<ConstantInt>(SI->getCondition());
|
|
|
|
BasicBlock *TheOnlyDest = SI->getSuccessor(0); // The default dest
|
2003-08-23 23:18:19 +00:00
|
|
|
BasicBlock *DefaultDest = TheOnlyDest;
|
|
|
|
assert(TheOnlyDest == SI->getDefaultDest() &&
|
|
|
|
"Default destination is not successor #0?");
|
2003-08-17 20:21:14 +00:00
|
|
|
|
|
|
|
// Figure out which case it goes to...
|
|
|
|
for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
|
|
|
|
// Found case matching a constant operand?
|
|
|
|
if (SI->getSuccessorValue(i) == CI) {
|
|
|
|
TheOnlyDest = SI->getSuccessor(i);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2003-08-23 23:18:19 +00:00
|
|
|
// Check to see if this branch is going to the same place as the default
|
|
|
|
// dest. If so, eliminate it as an explicit compare.
|
|
|
|
if (SI->getSuccessor(i) == DefaultDest) {
|
|
|
|
// Remove this entry...
|
|
|
|
DefaultDest->removePredecessor(SI->getParent());
|
|
|
|
SI->removeCase(i);
|
|
|
|
--i; --e; // Don't skip an entry...
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2003-08-17 20:21:14 +00:00
|
|
|
// Otherwise, check to see if the switch only branches to one destination.
|
|
|
|
// We do this by reseting "TheOnlyDest" to null when we find two non-equal
|
|
|
|
// destinations.
|
|
|
|
if (SI->getSuccessor(i) != TheOnlyDest) TheOnlyDest = 0;
|
|
|
|
}
|
2003-08-17 19:41:53 +00:00
|
|
|
|
2003-08-17 20:21:14 +00:00
|
|
|
if (CI && !TheOnlyDest) {
|
|
|
|
// Branching on a constant, but not any of the cases, go to the default
|
|
|
|
// successor.
|
|
|
|
TheOnlyDest = SI->getDefaultDest();
|
2003-08-17 19:41:53 +00:00
|
|
|
}
|
|
|
|
|
2003-08-17 20:21:14 +00:00
|
|
|
// If we found a single destination that we can fold the switch into, do so
|
|
|
|
// now.
|
|
|
|
if (TheOnlyDest) {
|
|
|
|
// Insert the new branch..
|
2008-04-06 20:25:17 +00:00
|
|
|
BranchInst::Create(TheOnlyDest, SI);
|
2003-08-17 20:21:14 +00:00
|
|
|
BasicBlock *BB = SI->getParent();
|
|
|
|
|
|
|
|
// Remove entries from PHI nodes which we no longer branch to...
|
|
|
|
for (unsigned i = 0, e = SI->getNumSuccessors(); i != e; ++i) {
|
|
|
|
// Found case matching a constant operand?
|
|
|
|
BasicBlock *Succ = SI->getSuccessor(i);
|
|
|
|
if (Succ == TheOnlyDest)
|
|
|
|
TheOnlyDest = 0; // Don't modify the first branch to TheOnlyDest
|
|
|
|
else
|
|
|
|
Succ->removePredecessor(BB);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Delete the old switch...
|
|
|
|
BB->getInstList().erase(SI);
|
|
|
|
return true;
|
|
|
|
} else if (SI->getNumSuccessors() == 2) {
|
|
|
|
// Otherwise, we can fold this switch into a conditional branch
|
|
|
|
// instruction if it has only one non-default destination.
|
2006-12-23 06:05:41 +00:00
|
|
|
Value *Cond = new ICmpInst(ICmpInst::ICMP_EQ, SI->getCondition(),
|
|
|
|
SI->getSuccessorValue(1), "cond", SI);
|
2003-08-17 20:21:14 +00:00
|
|
|
// Insert the new branch...
|
2008-04-06 20:25:17 +00:00
|
|
|
BranchInst::Create(SI->getSuccessor(1), SI->getSuccessor(0), Cond, SI);
|
2003-08-17 20:21:14 +00:00
|
|
|
|
|
|
|
// Delete the old switch...
|
2008-06-21 22:08:46 +00:00
|
|
|
SI->eraseFromParent();
|
2003-08-17 20:21:14 +00:00
|
|
|
return true;
|
|
|
|
}
|
2002-05-07 18:07:59 +00:00
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Local dead code elimination...
|
|
|
|
//
|
|
|
|
|
2008-11-27 22:57:53 +00:00
|
|
|
/// isInstructionTriviallyDead - Return true if the result produced by the
|
|
|
|
/// instruction is not used, and the instruction has no side effects.
|
|
|
|
///
|
2003-12-19 05:56:28 +00:00
|
|
|
bool llvm::isInstructionTriviallyDead(Instruction *I) {
|
2005-05-06 05:27:34 +00:00
|
|
|
if (!I->use_empty() || isa<TerminatorInst>(I)) return false;
|
2005-07-27 06:12:32 +00:00
|
|
|
|
2009-03-03 23:30:00 +00:00
|
|
|
// We don't want debug info removed by anything this general.
|
|
|
|
if (isa<DbgInfoIntrinsic>(I)) return false;
|
2005-05-06 05:27:34 +00:00
|
|
|
|
2009-05-06 06:49:50 +00:00
|
|
|
if (!I->mayHaveSideEffects()) return true;
|
|
|
|
|
|
|
|
// Special case intrinsics that "may have side effects" but can be deleted
|
|
|
|
// when dead.
|
2007-12-29 00:59:12 +00:00
|
|
|
if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I))
|
|
|
|
// Safe to delete llvm.stacksave if dead.
|
|
|
|
if (II->getIntrinsicID() == Intrinsic::stacksave)
|
|
|
|
return true;
|
2005-05-06 05:27:34 +00:00
|
|
|
return false;
|
2002-05-07 18:07:59 +00:00
|
|
|
}
|
|
|
|
|
2008-11-27 22:57:53 +00:00
|
|
|
/// RecursivelyDeleteTriviallyDeadInstructions - If the specified value is a
|
|
|
|
/// trivially dead instruction, delete it. If that makes any of its operands
|
|
|
|
/// trivially dead, delete them too, recursively.
|
2009-05-04 22:30:44 +00:00
|
|
|
void llvm::RecursivelyDeleteTriviallyDeadInstructions(Value *V) {
|
2008-11-27 22:57:53 +00:00
|
|
|
Instruction *I = dyn_cast<Instruction>(V);
|
2008-11-28 01:20:46 +00:00
|
|
|
if (!I || !I->use_empty() || !isInstructionTriviallyDead(I))
|
|
|
|
return;
|
2008-11-27 22:57:53 +00:00
|
|
|
|
2008-11-28 01:20:46 +00:00
|
|
|
SmallVector<Instruction*, 16> DeadInsts;
|
|
|
|
DeadInsts.push_back(I);
|
2008-11-27 22:57:53 +00:00
|
|
|
|
2008-11-28 01:20:46 +00:00
|
|
|
while (!DeadInsts.empty()) {
|
2009-05-06 17:22:41 +00:00
|
|
|
I = DeadInsts.pop_back_val();
|
2008-11-28 00:58:15 +00:00
|
|
|
|
2008-11-28 01:20:46 +00:00
|
|
|
// Null out all of the instruction's operands to see if any operand becomes
|
|
|
|
// dead as we go.
|
|
|
|
for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
|
|
|
|
Value *OpV = I->getOperand(i);
|
|
|
|
I->setOperand(i, 0);
|
|
|
|
|
|
|
|
if (!OpV->use_empty()) continue;
|
|
|
|
|
|
|
|
// If the operand is an instruction that became dead as we nulled out the
|
|
|
|
// operand, and if it is 'trivially' dead, delete it in a future loop
|
|
|
|
// iteration.
|
|
|
|
if (Instruction *OpI = dyn_cast<Instruction>(OpV))
|
|
|
|
if (isInstructionTriviallyDead(OpI))
|
|
|
|
DeadInsts.push_back(OpI);
|
|
|
|
}
|
|
|
|
|
|
|
|
I->eraseFromParent();
|
2002-05-07 18:07:59 +00:00
|
|
|
}
|
|
|
|
}
|
2008-11-27 07:43:12 +00:00
|
|
|
|
2009-05-02 18:29:22 +00:00
|
|
|
/// RecursivelyDeleteDeadPHINode - If the specified value is an effectively
|
|
|
|
/// dead PHI node, due to being a def-use chain of single-use nodes that
|
|
|
|
/// either forms a cycle or is terminated by a trivially dead instruction,
|
|
|
|
/// delete it. If that makes any of its operands trivially dead, delete them
|
|
|
|
/// too, recursively.
|
|
|
|
void
|
2009-05-04 22:30:44 +00:00
|
|
|
llvm::RecursivelyDeleteDeadPHINode(PHINode *PN) {
|
2009-07-06 23:00:19 +00:00
|
|
|
LLVMContext *Context = PN->getParent()->getContext();
|
2009-07-05 22:41:43 +00:00
|
|
|
|
2009-05-02 18:29:22 +00:00
|
|
|
// We can remove a PHI if it is on a cycle in the def-use graph
|
|
|
|
// where each node in the cycle has degree one, i.e. only one use,
|
|
|
|
// and is an instruction with no side effects.
|
|
|
|
if (!PN->hasOneUse())
|
|
|
|
return;
|
|
|
|
|
|
|
|
SmallPtrSet<PHINode *, 4> PHIs;
|
|
|
|
PHIs.insert(PN);
|
|
|
|
for (Instruction *J = cast<Instruction>(*PN->use_begin());
|
2009-05-06 06:49:50 +00:00
|
|
|
J->hasOneUse() && !J->mayHaveSideEffects();
|
2009-05-02 18:29:22 +00:00
|
|
|
J = cast<Instruction>(*J->use_begin()))
|
|
|
|
// If we find a PHI more than once, we're on a cycle that
|
|
|
|
// won't prove fruitful.
|
|
|
|
if (PHINode *JP = dyn_cast<PHINode>(J))
|
|
|
|
if (!PHIs.insert(cast<PHINode>(JP))) {
|
|
|
|
// Break the cycle and delete the PHI and its operands.
|
2009-07-05 22:41:43 +00:00
|
|
|
JP->replaceAllUsesWith(Context->getUndef(JP->getType()));
|
2009-05-04 22:30:44 +00:00
|
|
|
RecursivelyDeleteTriviallyDeadInstructions(JP);
|
2009-05-02 18:29:22 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
2008-11-27 22:57:53 +00:00
|
|
|
|
2008-11-27 07:43:12 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Control Flow Graph Restructuring...
|
|
|
|
//
|
|
|
|
|
|
|
|
/// MergeBasicBlockIntoOnlyPred - DestBB is a block with one predecessor and its
|
|
|
|
/// predecessor is known to have one successor (DestBB!). Eliminate the edge
|
|
|
|
/// between them, moving the instructions in the predecessor into DestBB and
|
|
|
|
/// deleting the predecessor block.
|
|
|
|
///
|
|
|
|
void llvm::MergeBasicBlockIntoOnlyPred(BasicBlock *DestBB) {
|
|
|
|
// If BB has single-entry PHI nodes, fold them.
|
|
|
|
while (PHINode *PN = dyn_cast<PHINode>(DestBB->begin())) {
|
|
|
|
Value *NewVal = PN->getIncomingValue(0);
|
|
|
|
// Replace self referencing PHI with undef, it must be dead.
|
2009-07-05 22:41:43 +00:00
|
|
|
if (NewVal == PN) NewVal = DestBB->getContext()->getUndef(PN->getType());
|
2008-11-27 07:43:12 +00:00
|
|
|
PN->replaceAllUsesWith(NewVal);
|
|
|
|
PN->eraseFromParent();
|
|
|
|
}
|
|
|
|
|
|
|
|
BasicBlock *PredBB = DestBB->getSinglePredecessor();
|
|
|
|
assert(PredBB && "Block doesn't have a single predecessor!");
|
|
|
|
|
|
|
|
// Splice all the instructions from PredBB to DestBB.
|
|
|
|
PredBB->getTerminator()->eraseFromParent();
|
|
|
|
DestBB->getInstList().splice(DestBB->begin(), PredBB->getInstList());
|
|
|
|
|
|
|
|
// Anything that branched to PredBB now branches to DestBB.
|
|
|
|
PredBB->replaceAllUsesWith(DestBB);
|
|
|
|
|
|
|
|
// Nuke BB.
|
|
|
|
PredBB->eraseFromParent();
|
|
|
|
}
|
2009-02-10 07:00:59 +00:00
|
|
|
|
|
|
|
/// OnlyUsedByDbgIntrinsics - Return true if the instruction I is only used
|
|
|
|
/// by DbgIntrinsics. If DbgInUses is specified then the vector is filled
|
|
|
|
/// with the DbgInfoIntrinsic that use the instruction I.
|
|
|
|
bool llvm::OnlyUsedByDbgInfoIntrinsics(Instruction *I,
|
|
|
|
SmallVectorImpl<DbgInfoIntrinsic *> *DbgInUses) {
|
|
|
|
if (DbgInUses)
|
|
|
|
DbgInUses->clear();
|
|
|
|
|
|
|
|
for (Value::use_iterator UI = I->use_begin(), UE = I->use_end(); UI != UE;
|
|
|
|
++UI) {
|
|
|
|
if (DbgInfoIntrinsic *DI = dyn_cast<DbgInfoIntrinsic>(*UI)) {
|
|
|
|
if (DbgInUses)
|
|
|
|
DbgInUses->push_back(DI);
|
|
|
|
} else {
|
|
|
|
if (DbgInUses)
|
|
|
|
DbgInUses->clear();
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
2009-03-06 00:19:37 +00:00
|
|
|
|