AArch64AddressTypePromotion.cpp [plain text]
#include "AArch64.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/Dominators.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Operator.h"
#include "llvm/Pass.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
using namespace llvm;
#define DEBUG_TYPE "aarch64-type-promotion"
static cl::opt<bool>
EnableAddressTypePromotion("aarch64-type-promotion", cl::Hidden,
cl::desc("Enable the type promotion pass"),
cl::init(true));
static cl::opt<bool>
EnableMerge("aarch64-type-promotion-merge", cl::Hidden,
cl::desc("Enable merging of redundant sexts when one is dominating"
" the other."),
cl::init(true));
namespace llvm {
void initializeAArch64AddressTypePromotionPass(PassRegistry &);
}
namespace {
class AArch64AddressTypePromotion : public FunctionPass {
public:
static char ID;
AArch64AddressTypePromotion()
: FunctionPass(ID), Func(nullptr), ConsideredSExtType(nullptr) {
initializeAArch64AddressTypePromotionPass(*PassRegistry::getPassRegistry());
}
const char *getPassName() const override {
return "AArch64 Address Type Promotion";
}
bool runOnFunction(Function &F) override;
private:
Function *Func;
Type *ConsideredSExtType;
void getAnalysisUsage(AnalysisUsage &AU) const override {
AU.setPreservesCFG();
AU.addRequired<DominatorTreeWrapperPass>();
AU.addPreserved<DominatorTreeWrapperPass>();
FunctionPass::getAnalysisUsage(AU);
}
typedef SmallPtrSet<Instruction *, 32> SetOfInstructions;
typedef SmallVector<Instruction *, 16> Instructions;
typedef DenseMap<Value *, Instructions> ValueToInsts;
bool shouldGetThrough(const Instruction *Inst);
bool canGetThrough(const Instruction *Inst);
bool propagateSignExtension(Instructions &SExtInsts);
bool shouldConsiderSExt(const Instruction *SExt) const;
void analyzeSExtension(Instructions &SExtInsts);
void mergeSExts(ValueToInsts &ValToSExtendedUses,
SetOfInstructions &ToRemove);
};
}
char AArch64AddressTypePromotion::ID = 0;
INITIALIZE_PASS_BEGIN(AArch64AddressTypePromotion, "aarch64-type-promotion",
"AArch64 Type Promotion Pass", false, false)
INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
INITIALIZE_PASS_END(AArch64AddressTypePromotion, "aarch64-type-promotion",
"AArch64 Type Promotion Pass", false, false)
FunctionPass *llvm::createAArch64AddressTypePromotionPass() {
return new AArch64AddressTypePromotion();
}
bool AArch64AddressTypePromotion::canGetThrough(const Instruction *Inst) {
if (isa<SExtInst>(Inst))
return true;
const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Inst);
if (BinOp && isa<OverflowingBinaryOperator>(BinOp) &&
(BinOp->hasNoUnsignedWrap() || BinOp->hasNoSignedWrap()))
return true;
if (isa<TruncInst>(Inst) && isa<SExtInst>(Inst->getOperand(0))) {
const Instruction *Opnd = cast<Instruction>(Inst->getOperand(0));
if (Inst->getType()->getIntegerBitWidth() >=
Opnd->getOperand(0)->getType()->getIntegerBitWidth() &&
Inst->getOperand(0)->getType()->getIntegerBitWidth() <=
ConsideredSExtType->getIntegerBitWidth())
return true;
}
return false;
}
bool AArch64AddressTypePromotion::shouldGetThrough(const Instruction *Inst) {
if (isa<SExtInst>(Inst) &&
(Inst->getType() == ConsideredSExtType || Inst->hasOneUse()))
return true;
if (!Inst->hasOneUse())
return false;
if (isa<TruncInst>(Inst))
return true;
if (isa<BinaryOperator>(Inst) && isa<ConstantInt>(Inst->getOperand(1)))
return true;
return false;
}
static bool shouldSExtOperand(const Instruction *Inst, int OpIdx) {
if (isa<SelectInst>(Inst) && OpIdx == 0)
return false;
return true;
}
bool
AArch64AddressTypePromotion::shouldConsiderSExt(const Instruction *SExt) const {
if (SExt->getType() != ConsideredSExtType)
return false;
for (const User *U : SExt->users()) {
if (isa<GetElementPtrInst>(U))
return true;
}
return false;
}
bool
AArch64AddressTypePromotion::propagateSignExtension(Instructions &SExtInsts) {
DEBUG(dbgs() << "*** Propagate Sign Extension ***\n");
bool LocalChange = false;
SetOfInstructions ToRemove;
ValueToInsts ValToSExtendedUses;
while (!SExtInsts.empty()) {
Instruction *SExt = SExtInsts.pop_back_val();
DEBUG(dbgs() << "Consider:\n" << *SExt << '\n');
if (SExt->use_empty() && ToRemove.count(SExt)) {
DEBUG(dbgs() << "No uses => marked as delete\n");
continue;
}
while (auto *Inst = dyn_cast<Instruction>(SExt->getOperand(0))) {
DEBUG(dbgs() << "Try to get through:\n" << *Inst << '\n');
if (!canGetThrough(Inst) || !shouldGetThrough(Inst)) {
DEBUG(dbgs() << "Cannot get through\n");
break;
}
LocalChange = true;
if (isa<SExtInst>(Inst) || isa<TruncInst>(Inst)) {
DEBUG(dbgs() << "SExt or trunc, mark it as to remove\n");
while (!Inst->use_empty()) {
Use &U = *Inst->use_begin();
Instruction *User = dyn_cast<Instruction>(U.getUser());
assert(User && "User of sext is not an Instruction!");
User->setOperand(U.getOperandNo(), SExt);
}
ToRemove.insert(Inst);
SExt->setOperand(0, Inst->getOperand(0));
SExt->moveBefore(Inst);
continue;
}
Inst->mutateType(SExt->getType());
SExt->replaceAllUsesWith(Inst);
Instruction *SExtForOpnd = SExt;
DEBUG(dbgs() << "Propagate SExt to operands\n");
for (int OpIdx = 0, EndOpIdx = Inst->getNumOperands(); OpIdx != EndOpIdx;
++OpIdx) {
DEBUG(dbgs() << "Operand:\n" << *(Inst->getOperand(OpIdx)) << '\n');
if (Inst->getOperand(OpIdx)->getType() == SExt->getType() ||
!shouldSExtOperand(Inst, OpIdx)) {
DEBUG(dbgs() << "No need to propagate\n");
continue;
}
Value *Opnd = Inst->getOperand(OpIdx);
if (const ConstantInt *Cst = dyn_cast<ConstantInt>(Opnd)) {
DEBUG(dbgs() << "Statically sign extend\n");
Inst->setOperand(OpIdx, ConstantInt::getSigned(SExt->getType(),
Cst->getSExtValue()));
continue;
}
if (isa<UndefValue>(Opnd)) {
DEBUG(dbgs() << "Statically sign extend\n");
Inst->setOperand(OpIdx, UndefValue::get(SExt->getType()));
continue;
}
assert(SExtForOpnd &&
"Only one operand should have been sign extended");
SExtForOpnd->setOperand(0, Opnd);
DEBUG(dbgs() << "Move before:\n" << *Inst << "\nSign extend\n");
SExtForOpnd->moveBefore(Inst);
Inst->setOperand(OpIdx, SExtForOpnd);
SExtForOpnd = nullptr;
}
if (SExtForOpnd == SExt) {
DEBUG(dbgs() << "Sign extension is useless now\n");
ToRemove.insert(SExt);
break;
}
}
if (!ToRemove.count(SExt) &&
SExt->getType() == SExt->getOperand(0)->getType()) {
DEBUG(dbgs() << "Sign extension is useless, attach its use to "
"its argument\n");
SExt->replaceAllUsesWith(SExt->getOperand(0));
ToRemove.insert(SExt);
} else
ValToSExtendedUses[SExt->getOperand(0)].push_back(SExt);
}
if (EnableMerge)
mergeSExts(ValToSExtendedUses, ToRemove);
for (Instruction *I: ToRemove)
I->eraseFromParent();
return LocalChange;
}
void AArch64AddressTypePromotion::mergeSExts(ValueToInsts &ValToSExtendedUses,
SetOfInstructions &ToRemove) {
DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
for (auto &Entry : ValToSExtendedUses) {
Instructions &Insts = Entry.second;
Instructions CurPts;
for (Instruction *Inst : Insts) {
if (ToRemove.count(Inst))
continue;
bool inserted = false;
for (auto &Pt : CurPts) {
if (DT.dominates(Inst, Pt)) {
DEBUG(dbgs() << "Replace all uses of:\n" << *Pt << "\nwith:\n"
<< *Inst << '\n');
Pt->replaceAllUsesWith(Inst);
ToRemove.insert(Pt);
Pt = Inst;
inserted = true;
break;
}
if (!DT.dominates(Pt, Inst))
continue;
DEBUG(dbgs() << "Replace all uses of:\n" << *Inst << "\nwith:\n"
<< *Pt << '\n');
Inst->replaceAllUsesWith(Pt);
ToRemove.insert(Inst);
inserted = true;
break;
}
if (!inserted)
CurPts.push_back(Inst);
}
}
}
void AArch64AddressTypePromotion::analyzeSExtension(Instructions &SExtInsts) {
DEBUG(dbgs() << "*** Analyze Sign Extensions ***\n");
DenseMap<Value *, Instruction *> SeenChains;
for (auto &BB : *Func) {
for (auto &II : BB) {
Instruction *SExt = &II;
if (!isa<SExtInst>(SExt) || !shouldConsiderSExt(SExt))
continue;
DEBUG(dbgs() << "Found:\n" << (*SExt) << '\n');
bool insert = false;
for (const User *U : SExt->users()) {
const Instruction *Inst = dyn_cast<GetElementPtrInst>(U);
if (Inst && Inst->getNumOperands() > 2) {
DEBUG(dbgs() << "Interesting use in GetElementPtrInst\n" << *Inst
<< '\n');
insert = true;
break;
}
}
Instruction *Inst = SExt;
Value *Last;
do {
int OpdIdx = 0;
const BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Inst);
if (BinOp && isa<ConstantInt>(BinOp->getOperand(0)))
OpdIdx = 1;
Last = Inst->getOperand(OpdIdx);
Inst = dyn_cast<Instruction>(Last);
} while (Inst && canGetThrough(Inst) && shouldGetThrough(Inst));
DEBUG(dbgs() << "Head of the chain:\n" << *Last << '\n');
DenseMap<Value *, Instruction *>::iterator AlreadySeen =
SeenChains.find(Last);
if (insert || AlreadySeen != SeenChains.end()) {
DEBUG(dbgs() << "Insert\n");
SExtInsts.push_back(SExt);
if (AlreadySeen != SeenChains.end() && AlreadySeen->second != nullptr) {
DEBUG(dbgs() << "Insert chain member\n");
SExtInsts.push_back(AlreadySeen->second);
SeenChains[Last] = nullptr;
}
} else {
DEBUG(dbgs() << "Record its chain membership\n");
SeenChains[Last] = SExt;
}
}
}
}
bool AArch64AddressTypePromotion::runOnFunction(Function &F) {
if (!EnableAddressTypePromotion || F.isDeclaration())
return false;
Func = &F;
ConsideredSExtType = Type::getInt64Ty(Func->getContext());
DEBUG(dbgs() << "*** " << getPassName() << ": " << Func->getName() << '\n');
Instructions SExtInsts;
analyzeSExtension(SExtInsts);
return propagateSignExtension(SExtInsts);
}