1597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne//===-- XCoreLowerThreadLocal - Lower thread local variables --------------===// 2597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne// 3597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne// The LLVM Compiler Infrastructure 4597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne// 5597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne// This file is distributed under the University of Illinois Open Source 6597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne// License. See LICENSE.TXT for details. 7597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne// 8597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne//===----------------------------------------------------------------------===// 9597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne/// 10597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne/// \file 11597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne/// \brief This file contains a pass that lowers thread local variables on the 12597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne/// XCore. 13597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne/// 14597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne//===----------------------------------------------------------------------===// 15597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 16597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "XCore.h" 17597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/IR/Constants.h" 18597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/IR/DerivedTypes.h" 19597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/IR/GlobalVariable.h" 20597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/IR/Intrinsics.h" 21597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/IR/IRBuilder.h" 22597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/IR/Module.h" 23597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/Pass.h" 24597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#include "llvm/Support/CommandLine.h" 25597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 26597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne#define DEBUG_TYPE "xcore-lower-thread-local" 27597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 28597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborneusing namespace llvm; 29597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 30597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornestatic cl::opt<unsigned> MaxThreads( 31597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne "xcore-max-threads", cl::Optional, 32597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne cl::desc("Maximum number of threads (for emulation thread-local storage)"), 33597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne cl::Hidden, cl::value_desc("number"), cl::init(8)); 34597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 35597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornenamespace { 36597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne /// Lowers thread local variables on the XCore. Each thread local variable is 37597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne /// expanded to an array of n elements indexed by the thread ID where n is the 38597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne /// fixed number hardware threads supported by the device. 39597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne struct XCoreLowerThreadLocal : public ModulePass { 40597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne static char ID; 41597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 42597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne XCoreLowerThreadLocal() : ModulePass(ID) { 43597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne initializeXCoreLowerThreadLocalPass(*PassRegistry::getPassRegistry()); 44597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne } 45597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 46597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne bool lowerGlobal(GlobalVariable *GV); 47597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 48597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne bool runOnModule(Module &M); 49597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne }; 50597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 51597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 52597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornechar XCoreLowerThreadLocal::ID = 0; 53597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 54597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard OsborneINITIALIZE_PASS(XCoreLowerThreadLocal, "xcore-lower-thread-local", 55597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne "Lower thread local variables", false, false) 56597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 57597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard OsborneModulePass *llvm::createXCoreLowerThreadLocalPass() { 58597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return new XCoreLowerThreadLocal(); 59597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 60597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 61597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornestatic ArrayType *createLoweredType(Type *OriginalType) { 62597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return ArrayType::get(OriginalType, MaxThreads); 63597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 64597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 65597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornestatic Constant * 66597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard OsbornecreateLoweredInitializer(ArrayType *NewType, Constant *OriginalInitializer) { 67597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne SmallVector<Constant *, 8> Elements(MaxThreads); 68597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne for (unsigned i = 0; i != MaxThreads; ++i) { 69597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Elements[i] = OriginalInitializer; 70597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne } 71597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return ConstantArray::get(NewType, Elements); 72597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 73597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 74597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornestatic bool hasNonInstructionUse(GlobalVariable *GV) { 75597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E; 76597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne ++UI) 77597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne if (!isa<Instruction>(*UI)) 78597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return true; 79597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 80597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return false; 81597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 82597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 83597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornestatic bool isZeroLengthArray(Type *Ty) { 84597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne ArrayType *AT = dyn_cast<ArrayType>(Ty); 85597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return AT && (AT->getNumElements() == 0); 86597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 87597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 88597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornebool XCoreLowerThreadLocal::lowerGlobal(GlobalVariable *GV) { 89597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Module *M = GV->getParent(); 90597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne LLVMContext &Ctx = M->getContext(); 91597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne if (!GV->isThreadLocal()) 92597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return false; 93597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 94597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne // Skip globals that we can't lower and leave it for the backend to error. 95597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne if (hasNonInstructionUse(GV) || 96597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne !GV->getType()->isSized() || isZeroLengthArray(GV->getType())) 97597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return false; 98597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 99597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne // Create replacement global. 100597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne ArrayType *NewType = createLoweredType(GV->getType()->getElementType()); 101597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Constant *NewInitializer = createLoweredInitializer(NewType, 102597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne GV->getInitializer()); 103597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne GlobalVariable *NewGV = 104597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne new GlobalVariable(*M, NewType, GV->isConstant(), GV->getLinkage(), 105597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne NewInitializer, "", 0, GlobalVariable::NotThreadLocal, 106597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne GV->getType()->getAddressSpace(), 107597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne GV->isExternallyInitialized()); 108597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 109597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne // Update uses. 110597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne SmallVector<User *, 16> Users(GV->use_begin(), GV->use_end()); 111597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne for (unsigned I = 0, E = Users.size(); I != E; ++I) { 112597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne User *U = Users[I]; 113597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Instruction *Inst = cast<Instruction>(U); 114597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne IRBuilder<> Builder(Inst); 115597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Function *GetID = Intrinsic::getDeclaration(GV->getParent(), 116597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Intrinsic::xcore_getid); 117597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Value *ThreadID = Builder.CreateCall(GetID); 118597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne SmallVector<Value *, 2> Indices; 119597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Indices.push_back(Constant::getNullValue(Type::getInt64Ty(Ctx))); 120597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Indices.push_back(ThreadID); 121597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne Value *Addr = Builder.CreateInBoundsGEP(NewGV, Indices); 122597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne U->replaceUsesOfWith(GV, Addr); 123597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne } 124597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 125597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne // Remove old global. 126597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne NewGV->takeName(GV); 127597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne GV->eraseFromParent(); 128597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return true; 129597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 130597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne 131597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osbornebool XCoreLowerThreadLocal::runOnModule(Module &M) { 132597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne // Find thread local globals. 133597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne bool MadeChange = false; 134597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne SmallVector<GlobalVariable *, 16> ThreadLocalGlobals; 135597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne for (Module::global_iterator GVI = M.global_begin(), E = M.global_end(); 136597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne GVI != E; ++GVI) { 137597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne GlobalVariable *GV = GVI; 138597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne if (GV->isThreadLocal()) 139597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne ThreadLocalGlobals.push_back(GV); 140597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne } 141597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne for (unsigned I = 0, E = ThreadLocalGlobals.size(); I != E; ++I) { 142597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne MadeChange |= lowerGlobal(ThreadLocalGlobals[I]); 143597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne } 144597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne return MadeChange; 145597432fbe53bda0069b0ad13e5ad57ae0ee7ee45Richard Osborne} 146