2014-04-18 02:22:47 +08:00
|
|
|
//===-- AtomicExpandLoadLinkedPass.cpp - Expand atomic instructions -------===//
|
2014-04-03 19:44:58 +08:00
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file contains a pass (at IR level) to replace atomic instructions with
|
|
|
|
// appropriate (intrinsic-based) ldrex/strex loops.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "llvm/CodeGen/Passes.h"
|
|
|
|
#include "llvm/IR/Function.h"
|
|
|
|
#include "llvm/IR/IRBuilder.h"
|
|
|
|
#include "llvm/IR/Instructions.h"
|
|
|
|
#include "llvm/IR/Intrinsics.h"
|
|
|
|
#include "llvm/IR/Module.h"
|
|
|
|
#include "llvm/Support/Debug.h"
|
|
|
|
#include "llvm/Target/TargetLowering.h"
|
|
|
|
#include "llvm/Target/TargetMachine.h"
|
|
|
|
using namespace llvm;
|
|
|
|
|
2014-04-22 10:02:50 +08:00
|
|
|
#define DEBUG_TYPE "arm-atomic-expand"
|
|
|
|
|
2014-04-03 19:44:58 +08:00
|
|
|
namespace {
|
2014-04-18 02:22:47 +08:00
|
|
|
class AtomicExpandLoadLinked : public FunctionPass {
|
2014-04-03 19:44:58 +08:00
|
|
|
const TargetLowering *TLI;
|
|
|
|
public:
|
|
|
|
static char ID; // Pass identification, replacement for typeid
|
2014-04-24 14:44:33 +08:00
|
|
|
explicit AtomicExpandLoadLinked(const TargetMachine *TM = nullptr)
|
|
|
|
: FunctionPass(ID), TLI(TM ? TM->getTargetLowering() : nullptr) {
|
2014-04-18 02:22:47 +08:00
|
|
|
initializeAtomicExpandLoadLinkedPass(*PassRegistry::getPassRegistry());
|
|
|
|
}
|
2014-04-03 19:44:58 +08:00
|
|
|
|
|
|
|
bool runOnFunction(Function &F) override;
|
|
|
|
bool expandAtomicInsts(Function &F);
|
|
|
|
|
|
|
|
bool expandAtomicLoad(LoadInst *LI);
|
|
|
|
bool expandAtomicStore(StoreInst *LI);
|
|
|
|
bool expandAtomicRMW(AtomicRMWInst *AI);
|
|
|
|
bool expandAtomicCmpXchg(AtomicCmpXchgInst *CI);
|
|
|
|
|
|
|
|
AtomicOrdering insertLeadingFence(IRBuilder<> &Builder, AtomicOrdering Ord);
|
|
|
|
void insertTrailingFence(IRBuilder<> &Builder, AtomicOrdering Ord);
|
2014-04-18 02:22:47 +08:00
|
|
|
};
|
|
|
|
}
|
2014-04-03 19:44:58 +08:00
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
char AtomicExpandLoadLinked::ID = 0;
|
|
|
|
char &llvm::AtomicExpandLoadLinkedID = AtomicExpandLoadLinked::ID;
|
|
|
|
|
|
|
|
static void *initializeAtomicExpandLoadLinkedPassOnce(PassRegistry &Registry) {
|
|
|
|
PassInfo *PI = new PassInfo(
|
|
|
|
"Expand Atomic calls in terms of load-linked & store-conditional",
|
|
|
|
"atomic-ll-sc", &AtomicExpandLoadLinked::ID,
|
|
|
|
PassInfo::NormalCtor_t(callDefaultCtor<AtomicExpandLoadLinked>), false,
|
|
|
|
false, PassInfo::TargetMachineCtor_t(
|
|
|
|
callTargetMachineCtor<AtomicExpandLoadLinked>));
|
|
|
|
Registry.registerPass(*PI, true);
|
|
|
|
return PI;
|
|
|
|
}
|
2014-04-03 19:44:58 +08:00
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
void llvm::initializeAtomicExpandLoadLinkedPass(PassRegistry &Registry) {
|
|
|
|
CALL_ONCE_INITIALIZATION(initializeAtomicExpandLoadLinkedPassOnce)
|
2014-04-03 19:44:58 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
FunctionPass *llvm::createAtomicExpandLoadLinkedPass(const TargetMachine *TM) {
|
|
|
|
return new AtomicExpandLoadLinked(TM);
|
2014-04-03 19:44:58 +08:00
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
bool AtomicExpandLoadLinked::runOnFunction(Function &F) {
|
|
|
|
if (!TLI)
|
|
|
|
return false;
|
|
|
|
|
2014-04-03 19:44:58 +08:00
|
|
|
SmallVector<Instruction *, 1> AtomicInsts;
|
|
|
|
|
|
|
|
// Changing control-flow while iterating through it is a bad idea, so gather a
|
|
|
|
// list of all atomic instructions before we start.
|
|
|
|
for (BasicBlock &BB : F)
|
|
|
|
for (Instruction &Inst : BB) {
|
|
|
|
if (isa<AtomicRMWInst>(&Inst) || isa<AtomicCmpXchgInst>(&Inst) ||
|
|
|
|
(isa<LoadInst>(&Inst) && cast<LoadInst>(&Inst)->isAtomic()) ||
|
|
|
|
(isa<StoreInst>(&Inst) && cast<StoreInst>(&Inst)->isAtomic()))
|
|
|
|
AtomicInsts.push_back(&Inst);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool MadeChange = false;
|
|
|
|
for (Instruction *Inst : AtomicInsts) {
|
2014-04-18 02:22:47 +08:00
|
|
|
if (!TLI->shouldExpandAtomicInIR(Inst))
|
2014-04-03 19:44:58 +08:00
|
|
|
continue;
|
|
|
|
|
|
|
|
if (AtomicRMWInst *AI = dyn_cast<AtomicRMWInst>(Inst))
|
|
|
|
MadeChange |= expandAtomicRMW(AI);
|
|
|
|
else if (AtomicCmpXchgInst *CI = dyn_cast<AtomicCmpXchgInst>(Inst))
|
|
|
|
MadeChange |= expandAtomicCmpXchg(CI);
|
|
|
|
else if (LoadInst *LI = dyn_cast<LoadInst>(Inst))
|
|
|
|
MadeChange |= expandAtomicLoad(LI);
|
|
|
|
else if (StoreInst *SI = dyn_cast<StoreInst>(Inst))
|
|
|
|
MadeChange |= expandAtomicStore(SI);
|
|
|
|
else
|
|
|
|
llvm_unreachable("Unknown atomic instruction");
|
|
|
|
}
|
|
|
|
|
|
|
|
return MadeChange;
|
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
bool AtomicExpandLoadLinked::expandAtomicLoad(LoadInst *LI) {
|
2014-04-03 19:44:58 +08:00
|
|
|
// Load instructions don't actually need a leading fence, even in the
|
|
|
|
// SequentiallyConsistent case.
|
|
|
|
AtomicOrdering MemOpOrder =
|
|
|
|
TLI->getInsertFencesForAtomic() ? Monotonic : LI->getOrdering();
|
|
|
|
|
|
|
|
// The only 64-bit load guaranteed to be single-copy atomic by the ARM ARM is
|
|
|
|
// an ldrexd (A3.5.3).
|
|
|
|
IRBuilder<> Builder(LI);
|
2014-04-18 02:22:47 +08:00
|
|
|
Value *Val =
|
|
|
|
TLI->emitLoadLinked(Builder, LI->getPointerOperand(), MemOpOrder);
|
2014-04-03 19:44:58 +08:00
|
|
|
|
|
|
|
insertTrailingFence(Builder, LI->getOrdering());
|
|
|
|
|
|
|
|
LI->replaceAllUsesWith(Val);
|
|
|
|
LI->eraseFromParent();
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
bool AtomicExpandLoadLinked::expandAtomicStore(StoreInst *SI) {
|
2014-04-03 19:44:58 +08:00
|
|
|
// The only atomic 64-bit store on ARM is an strexd that succeeds, which means
|
|
|
|
// we need a loop and the entire instruction is essentially an "atomicrmw
|
|
|
|
// xchg" that ignores the value loaded.
|
|
|
|
IRBuilder<> Builder(SI);
|
|
|
|
AtomicRMWInst *AI =
|
|
|
|
Builder.CreateAtomicRMW(AtomicRMWInst::Xchg, SI->getPointerOperand(),
|
|
|
|
SI->getValueOperand(), SI->getOrdering());
|
|
|
|
SI->eraseFromParent();
|
|
|
|
|
|
|
|
// Now we have an appropriate swap instruction, lower it as usual.
|
|
|
|
return expandAtomicRMW(AI);
|
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
bool AtomicExpandLoadLinked::expandAtomicRMW(AtomicRMWInst *AI) {
|
2014-04-03 19:44:58 +08:00
|
|
|
AtomicOrdering Order = AI->getOrdering();
|
|
|
|
Value *Addr = AI->getPointerOperand();
|
|
|
|
BasicBlock *BB = AI->getParent();
|
|
|
|
Function *F = BB->getParent();
|
|
|
|
LLVMContext &Ctx = F->getContext();
|
|
|
|
|
|
|
|
// Given: atomicrmw some_op iN* %addr, iN %incr ordering
|
|
|
|
//
|
|
|
|
// The standard expansion we produce is:
|
|
|
|
// [...]
|
|
|
|
// fence?
|
|
|
|
// atomicrmw.start:
|
|
|
|
// %loaded = @load.linked(%addr)
|
|
|
|
// %new = some_op iN %loaded, %incr
|
|
|
|
// %stored = @store_conditional(%new, %addr)
|
|
|
|
// %try_again = icmp i32 ne %stored, 0
|
|
|
|
// br i1 %try_again, label %loop, label %atomicrmw.end
|
|
|
|
// atomicrmw.end:
|
|
|
|
// fence?
|
|
|
|
// [...]
|
|
|
|
BasicBlock *ExitBB = BB->splitBasicBlock(AI, "atomicrmw.end");
|
|
|
|
BasicBlock *LoopBB = BasicBlock::Create(Ctx, "atomicrmw.start", F, ExitBB);
|
|
|
|
|
|
|
|
// This grabs the DebugLoc from AI.
|
|
|
|
IRBuilder<> Builder(AI);
|
|
|
|
|
|
|
|
// The split call above "helpfully" added a branch at the end of BB (to the
|
|
|
|
// wrong place), but we might want a fence too. It's easiest to just remove
|
|
|
|
// the branch entirely.
|
|
|
|
std::prev(BB->end())->eraseFromParent();
|
|
|
|
Builder.SetInsertPoint(BB);
|
|
|
|
AtomicOrdering MemOpOrder = insertLeadingFence(Builder, Order);
|
|
|
|
Builder.CreateBr(LoopBB);
|
|
|
|
|
|
|
|
// Start the main loop block now that we've taken care of the preliminaries.
|
|
|
|
Builder.SetInsertPoint(LoopBB);
|
2014-04-18 02:22:47 +08:00
|
|
|
Value *Loaded = TLI->emitLoadLinked(Builder, Addr, MemOpOrder);
|
2014-04-03 19:44:58 +08:00
|
|
|
|
|
|
|
Value *NewVal;
|
|
|
|
switch (AI->getOperation()) {
|
|
|
|
case AtomicRMWInst::Xchg:
|
|
|
|
NewVal = AI->getValOperand();
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::Add:
|
|
|
|
NewVal = Builder.CreateAdd(Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::Sub:
|
|
|
|
NewVal = Builder.CreateSub(Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::And:
|
|
|
|
NewVal = Builder.CreateAnd(Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::Nand:
|
|
|
|
NewVal = Builder.CreateAnd(Loaded, Builder.CreateNot(AI->getValOperand()),
|
|
|
|
"new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::Or:
|
|
|
|
NewVal = Builder.CreateOr(Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::Xor:
|
|
|
|
NewVal = Builder.CreateXor(Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::Max:
|
|
|
|
NewVal = Builder.CreateICmpSGT(Loaded, AI->getValOperand());
|
|
|
|
NewVal = Builder.CreateSelect(NewVal, Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::Min:
|
|
|
|
NewVal = Builder.CreateICmpSLE(Loaded, AI->getValOperand());
|
|
|
|
NewVal = Builder.CreateSelect(NewVal, Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::UMax:
|
|
|
|
NewVal = Builder.CreateICmpUGT(Loaded, AI->getValOperand());
|
|
|
|
NewVal = Builder.CreateSelect(NewVal, Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
case AtomicRMWInst::UMin:
|
|
|
|
NewVal = Builder.CreateICmpULE(Loaded, AI->getValOperand());
|
|
|
|
NewVal = Builder.CreateSelect(NewVal, Loaded, AI->getValOperand(), "new");
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
llvm_unreachable("Unknown atomic op");
|
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
Value *StoreSuccess =
|
|
|
|
TLI->emitStoreConditional(Builder, NewVal, Addr, MemOpOrder);
|
2014-04-03 19:44:58 +08:00
|
|
|
Value *TryAgain = Builder.CreateICmpNE(
|
|
|
|
StoreSuccess, ConstantInt::get(IntegerType::get(Ctx, 32), 0), "tryagain");
|
|
|
|
Builder.CreateCondBr(TryAgain, LoopBB, ExitBB);
|
|
|
|
|
|
|
|
Builder.SetInsertPoint(ExitBB, ExitBB->begin());
|
|
|
|
insertTrailingFence(Builder, Order);
|
|
|
|
|
|
|
|
AI->replaceAllUsesWith(Loaded);
|
|
|
|
AI->eraseFromParent();
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
bool AtomicExpandLoadLinked::expandAtomicCmpXchg(AtomicCmpXchgInst *CI) {
|
2014-04-03 21:06:54 +08:00
|
|
|
AtomicOrdering SuccessOrder = CI->getSuccessOrdering();
|
|
|
|
AtomicOrdering FailureOrder = CI->getFailureOrdering();
|
2014-04-03 19:44:58 +08:00
|
|
|
Value *Addr = CI->getPointerOperand();
|
|
|
|
BasicBlock *BB = CI->getParent();
|
|
|
|
Function *F = BB->getParent();
|
|
|
|
LLVMContext &Ctx = F->getContext();
|
|
|
|
|
|
|
|
// Given: cmpxchg some_op iN* %addr, iN %desired, iN %new success_ord fail_ord
|
|
|
|
//
|
2014-04-03 21:06:54 +08:00
|
|
|
// The full expansion we produce is:
|
2014-04-03 19:44:58 +08:00
|
|
|
// [...]
|
|
|
|
// fence?
|
|
|
|
// cmpxchg.start:
|
|
|
|
// %loaded = @load.linked(%addr)
|
|
|
|
// %should_store = icmp eq %loaded, %desired
|
2014-04-03 21:06:54 +08:00
|
|
|
// br i1 %should_store, label %cmpxchg.trystore,
|
|
|
|
// label %cmpxchg.end/%cmpxchg.barrier
|
2014-04-03 19:44:58 +08:00
|
|
|
// cmpxchg.trystore:
|
|
|
|
// %stored = @store_conditional(%new, %addr)
|
|
|
|
// %try_again = icmp i32 ne %stored, 0
|
|
|
|
// br i1 %try_again, label %loop, label %cmpxchg.end
|
2014-04-03 21:06:54 +08:00
|
|
|
// cmpxchg.barrier:
|
2014-04-03 19:44:58 +08:00
|
|
|
// fence?
|
2014-04-03 21:06:54 +08:00
|
|
|
// br label %cmpxchg.end
|
|
|
|
// cmpxchg.end:
|
2014-04-03 19:44:58 +08:00
|
|
|
// [...]
|
|
|
|
BasicBlock *ExitBB = BB->splitBasicBlock(CI, "cmpxchg.end");
|
2014-04-18 02:22:47 +08:00
|
|
|
auto BarrierBB = BasicBlock::Create(Ctx, "cmpxchg.barrier", F, ExitBB);
|
|
|
|
auto TryStoreBB = BasicBlock::Create(Ctx, "cmpxchg.trystore", F, BarrierBB);
|
2014-04-03 21:06:54 +08:00
|
|
|
auto LoopBB = BasicBlock::Create(Ctx, "cmpxchg.start", F, TryStoreBB);
|
2014-04-03 19:44:58 +08:00
|
|
|
|
|
|
|
// This grabs the DebugLoc from CI
|
|
|
|
IRBuilder<> Builder(CI);
|
|
|
|
|
|
|
|
// The split call above "helpfully" added a branch at the end of BB (to the
|
|
|
|
// wrong place), but we might want a fence too. It's easiest to just remove
|
|
|
|
// the branch entirely.
|
|
|
|
std::prev(BB->end())->eraseFromParent();
|
|
|
|
Builder.SetInsertPoint(BB);
|
2014-04-03 21:06:54 +08:00
|
|
|
AtomicOrdering MemOpOrder = insertLeadingFence(Builder, SuccessOrder);
|
2014-04-03 19:44:58 +08:00
|
|
|
Builder.CreateBr(LoopBB);
|
|
|
|
|
|
|
|
// Start the main loop block now that we've taken care of the preliminaries.
|
|
|
|
Builder.SetInsertPoint(LoopBB);
|
2014-04-18 02:22:47 +08:00
|
|
|
Value *Loaded = TLI->emitLoadLinked(Builder, Addr, MemOpOrder);
|
2014-04-03 19:44:58 +08:00
|
|
|
Value *ShouldStore =
|
|
|
|
Builder.CreateICmpEQ(Loaded, CI->getCompareOperand(), "should_store");
|
2014-04-03 21:06:54 +08:00
|
|
|
|
|
|
|
// If the the cmpxchg doesn't actually need any ordering when it fails, we can
|
|
|
|
// jump straight past that fence instruction (if it exists).
|
|
|
|
BasicBlock *FailureBB = FailureOrder == Monotonic ? ExitBB : BarrierBB;
|
|
|
|
Builder.CreateCondBr(ShouldStore, TryStoreBB, FailureBB);
|
2014-04-03 19:44:58 +08:00
|
|
|
|
|
|
|
Builder.SetInsertPoint(TryStoreBB);
|
2014-04-18 02:22:47 +08:00
|
|
|
Value *StoreSuccess = TLI->emitStoreConditional(
|
|
|
|
Builder, CI->getNewValOperand(), Addr, MemOpOrder);
|
2014-04-03 19:44:58 +08:00
|
|
|
Value *TryAgain = Builder.CreateICmpNE(
|
|
|
|
StoreSuccess, ConstantInt::get(Type::getInt32Ty(Ctx), 0), "success");
|
2014-04-03 21:06:54 +08:00
|
|
|
Builder.CreateCondBr(TryAgain, LoopBB, BarrierBB);
|
2014-04-03 19:44:58 +08:00
|
|
|
|
|
|
|
// Finally, make sure later instructions don't get reordered with a fence if
|
|
|
|
// necessary.
|
2014-04-03 21:06:54 +08:00
|
|
|
Builder.SetInsertPoint(BarrierBB);
|
|
|
|
insertTrailingFence(Builder, SuccessOrder);
|
|
|
|
Builder.CreateBr(ExitBB);
|
2014-04-03 19:44:58 +08:00
|
|
|
|
|
|
|
CI->replaceAllUsesWith(Loaded);
|
|
|
|
CI->eraseFromParent();
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
AtomicOrdering AtomicExpandLoadLinked::insertLeadingFence(IRBuilder<> &Builder,
|
2014-04-03 19:44:58 +08:00
|
|
|
AtomicOrdering Ord) {
|
|
|
|
if (!TLI->getInsertFencesForAtomic())
|
|
|
|
return Ord;
|
|
|
|
|
|
|
|
if (Ord == Release || Ord == AcquireRelease || Ord == SequentiallyConsistent)
|
|
|
|
Builder.CreateFence(Release);
|
|
|
|
|
|
|
|
// The exclusive operations don't need any barrier if we're adding separate
|
|
|
|
// fences.
|
|
|
|
return Monotonic;
|
|
|
|
}
|
|
|
|
|
2014-04-18 02:22:47 +08:00
|
|
|
void AtomicExpandLoadLinked::insertTrailingFence(IRBuilder<> &Builder,
|
2014-04-03 19:44:58 +08:00
|
|
|
AtomicOrdering Ord) {
|
|
|
|
if (!TLI->getInsertFencesForAtomic())
|
|
|
|
return;
|
|
|
|
|
|
|
|
if (Ord == Acquire || Ord == AcquireRelease)
|
|
|
|
Builder.CreateFence(Acquire);
|
|
|
|
else if (Ord == SequentiallyConsistent)
|
|
|
|
Builder.CreateFence(SequentiallyConsistent);
|
|
|
|
}
|