LLVM 19.0.0git
XCoreLowerThreadLocal.cpp
Go to the documentation of this file.
1//===-- XCoreLowerThreadLocal - Lower thread local variables --------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
10/// This file contains a pass that lowers thread local variables on the
11/// XCore.
12///
13//===----------------------------------------------------------------------===//
14
15#include "XCore.h"
16#include "llvm/IR/Constants.h"
19#include "llvm/IR/IRBuilder.h"
20#include "llvm/IR/Intrinsics.h"
21#include "llvm/IR/IntrinsicsXCore.h"
22#include "llvm/IR/Module.h"
23#include "llvm/IR/NoFolder.h"
24#include "llvm/IR/ValueHandle.h"
25#include "llvm/Pass.h"
28
29#define DEBUG_TYPE "xcore-lower-thread-local"
30
31using namespace llvm;
32
34 "xcore-max-threads", cl::Optional,
35 cl::desc("Maximum number of threads (for emulation thread-local storage)"),
36 cl::Hidden, cl::value_desc("number"), cl::init(8));
37
38namespace {
39 /// Lowers thread local variables on the XCore. Each thread local variable is
40 /// expanded to an array of n elements indexed by the thread ID where n is the
41 /// fixed number hardware threads supported by the device.
42 struct XCoreLowerThreadLocal : public ModulePass {
43 static char ID;
44
45 XCoreLowerThreadLocal() : ModulePass(ID) {
47 }
48
49 bool lowerGlobal(GlobalVariable *GV);
50
51 bool runOnModule(Module &M) override;
52 };
53}
54
55char XCoreLowerThreadLocal::ID = 0;
56
57INITIALIZE_PASS(XCoreLowerThreadLocal, "xcore-lower-thread-local",
58 "Lower thread local variables", false, false)
59
61 return new XCoreLowerThreadLocal();
62}
63
64static ArrayType *createLoweredType(Type *OriginalType) {
65 return ArrayType::get(OriginalType, MaxThreads);
66}
67
68static Constant *
69createLoweredInitializer(ArrayType *NewType, Constant *OriginalInitializer) {
71 for (unsigned i = 0; i != MaxThreads; ++i) {
72 Elements[i] = OriginalInitializer;
73 }
74 return ConstantArray::get(NewType, Elements);
75}
76
77
79 do {
80 SmallVector<WeakTrackingVH, 8> WUsers(CE->users());
81 llvm::sort(WUsers);
82 WUsers.erase(std::unique(WUsers.begin(), WUsers.end()), WUsers.end());
83 while (!WUsers.empty())
84 if (WeakTrackingVH WU = WUsers.pop_back_val()) {
85 if (PHINode *PN = dyn_cast<PHINode>(WU)) {
86 for (int I = 0, E = PN->getNumIncomingValues(); I < E; ++I)
87 if (PN->getIncomingValue(I) == CE) {
88 BasicBlock *PredBB = PN->getIncomingBlock(I);
89 if (PredBB->getTerminator()->getNumSuccessors() > 1)
90 PredBB = SplitEdge(PredBB, PN->getParent());
91 Instruction *InsertPos = PredBB->getTerminator();
92 Instruction *NewInst = CE->getAsInstruction(InsertPos);
93 PN->setOperand(I, NewInst);
94 }
95 } else if (Instruction *Instr = dyn_cast<Instruction>(WU)) {
96 Instruction *NewInst = CE->getAsInstruction(Instr);
97 Instr->replaceUsesOfWith(CE, NewInst);
98 } else {
99 ConstantExpr *CExpr = dyn_cast<ConstantExpr>(WU);
100 if (!CExpr || !replaceConstantExprOp(CExpr, P))
101 return false;
102 }
103 }
104 } while (CE->hasNUsesOrMore(1)); // We need to check because a recursive
105 // sibling may have used 'CE' when getAsInstruction was called.
106 CE->destroyConstant();
107 return true;
108}
109
112 for (User *U : GV->users())
113 if (!isa<Instruction>(U))
114 WUsers.push_back(WeakTrackingVH(U));
115 while (!WUsers.empty())
116 if (WeakTrackingVH WU = WUsers.pop_back_val()) {
117 ConstantExpr *CE = dyn_cast<ConstantExpr>(WU);
118 if (!CE || !replaceConstantExprOp(CE, P))
119 return false;
120 }
121 return true;
122}
123
124static bool isZeroLengthArray(Type *Ty) {
125 ArrayType *AT = dyn_cast<ArrayType>(Ty);
126 return AT && (AT->getNumElements() == 0);
127}
128
129bool XCoreLowerThreadLocal::lowerGlobal(GlobalVariable *GV) {
130 Module *M = GV->getParent();
131 if (!GV->isThreadLocal())
132 return false;
133
134 // Skip globals that we can't lower and leave it for the backend to error.
135 if (!rewriteNonInstructionUses(GV, this) ||
136 !GV->getType()->isSized() || isZeroLengthArray(GV->getType()))
137 return false;
138
139 // Create replacement global.
140 ArrayType *NewType = createLoweredType(GV->getValueType());
141 Constant *NewInitializer = nullptr;
142 if (GV->hasInitializer())
143 NewInitializer = createLoweredInitializer(NewType,
144 GV->getInitializer());
145 GlobalVariable *NewGV =
146 new GlobalVariable(*M, NewType, GV->isConstant(), GV->getLinkage(),
147 NewInitializer, "", nullptr,
148 GlobalVariable::NotThreadLocal,
149 GV->getType()->getAddressSpace(),
151
152 // Update uses.
154 for (unsigned I = 0, E = Users.size(); I != E; ++I) {
155 User *U = Users[I];
156 Instruction *Inst = cast<Instruction>(U);
157 IRBuilder<> Builder(Inst);
159 Intrinsic::xcore_getid);
160 Value *ThreadID = Builder.CreateCall(GetID, {});
161 Value *Addr = Builder.CreateInBoundsGEP(NewGV->getValueType(), NewGV,
162 {Builder.getInt64(0), ThreadID});
163 U->replaceUsesOfWith(GV, Addr);
164 }
165
166 // Remove old global.
167 NewGV->takeName(GV);
168 GV->eraseFromParent();
169 return true;
170}
171
172bool XCoreLowerThreadLocal::runOnModule(Module &M) {
173 // Find thread local globals.
174 bool MadeChange = false;
175 SmallVector<GlobalVariable *, 16> ThreadLocalGlobals;
176 for (GlobalVariable &GV : M.globals())
177 if (GV.isThreadLocal())
178 ThreadLocalGlobals.push_back(&GV);
179 for (unsigned I = 0, E = ThreadLocalGlobals.size(); I != E; ++I) {
180 MadeChange |= lowerGlobal(ThreadLocalGlobals[I]);
181 }
182 return MadeChange;
183}
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
uint64_t Addr
iv Induction Variable Users
Definition: IVUsers.cpp:48
#define I(x, y, z)
Definition: MD5.cpp:58
Module.h This file contains the declarations for the Module class.
#define P(N)
#define INITIALIZE_PASS(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:38
static bool replaceConstantExprOp(ConstantExpr *CE, Pass *P)
static bool isZeroLengthArray(Type *Ty)
static Constant * createLoweredInitializer(ArrayType *NewType, Constant *OriginalInitializer)
static cl::opt< unsigned > MaxThreads("xcore-max-threads", cl::Optional, cl::desc("Maximum number of threads (for emulation thread-local storage)"), cl::Hidden, cl::value_desc("number"), cl::init(8))
static bool rewriteNonInstructionUses(GlobalVariable *GV, Pass *P)
static ArrayType * createLoweredType(Type *OriginalType)
LLVM Basic Block Representation.
Definition: BasicBlock.h:60
const Function * getParent() const
Return the enclosing method, or null if none.
Definition: BasicBlock.h:213
const Instruction * getTerminator() const LLVM_READONLY
Returns the terminator instruction if the block is well formed or null if the block is not well forme...
Definition: BasicBlock.h:228
static Constant * get(ArrayType *T, ArrayRef< Constant * > V)
Definition: Constants.cpp:1235
A constant value that is initialized with an expression using other constant values.
Definition: Constants.h:1002
This is an important base class in LLVM.
Definition: Constant.h:41
bool isThreadLocal() const
If the value is "Thread Local", its value isn't shared by the threads.
Definition: GlobalValue.h:263
LinkageTypes getLinkage() const
Definition: GlobalValue.h:545
Module * getParent()
Get the module that this global value is contained inside of...
Definition: GlobalValue.h:655
PointerType * getType() const
Global values are always pointers.
Definition: GlobalValue.h:294
Type * getValueType() const
Definition: GlobalValue.h:296
const Constant * getInitializer() const
getInitializer - Return the initializer for this global variable.
bool isExternallyInitialized() const
bool hasInitializer() const
Definitions have initializers, declarations don't.
bool isConstant() const
If the value is a global constant, its value is immutable throughout the runtime execution of the pro...
void eraseFromParent()
eraseFromParent - This method unlinks 'this' from the containing module and deletes it.
Definition: Globals.cpp:455
This provides a uniform API for creating instructions and inserting them into a basic block: either a...
Definition: IRBuilder.h:2649
unsigned getNumSuccessors() const LLVM_READONLY
Return the number of successors that this instruction has.
ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...
Definition: Pass.h:251
virtual bool runOnModule(Module &M)=0
runOnModule - Virtual method overriden by subclasses to process the module being operated on.
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
static PassRegistry * getPassRegistry()
getPassRegistry - Access the global registry object, which is automatically initialized at applicatio...
Pass interface - Implemented by all 'passes'.
Definition: Pass.h:94
unsigned getAddressSpace() const
Return the address space of the Pointer type.
Definition: DerivedTypes.h:679
bool empty() const
Definition: SmallVector.h:94
size_t size() const
Definition: SmallVector.h:91
iterator erase(const_iterator CI)
Definition: SmallVector.h:750
void push_back(const T &Elt)
Definition: SmallVector.h:426
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
bool isSized(SmallPtrSetImpl< Type * > *Visited=nullptr) const
Return true if it makes sense to take the size of this type.
Definition: Type.h:302
LLVM Value Representation.
Definition: Value.h:74
iterator_range< user_iterator > users()
Definition: Value.h:421
void takeName(Value *V)
Transfer the name from V to this value.
Definition: Value.cpp:383
Value handle that is nullable, but tries to track the Value.
Definition: ValueHandle.h:204
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
Function * getDeclaration(Module *M, ID id, ArrayRef< Type * > Tys=std::nullopt)
Create or insert an LLVM Function declaration for an intrinsic, and return it.
Definition: Function.cpp:1445
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:450
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
void sort(IteratorTy Start, IteratorTy End)
Definition: STLExtras.h:1656
void initializeXCoreLowerThreadLocalPass(PassRegistry &p)
ModulePass * createXCoreLowerThreadLocalPass()
BasicBlock * SplitEdge(BasicBlock *From, BasicBlock *To, DominatorTree *DT=nullptr, LoopInfo *LI=nullptr, MemorySSAUpdater *MSSAU=nullptr, const Twine &BBName="")
Split the edge connecting the specified blocks, and return the newly created basic block between From...