1//===-- SPIRVCtorDtorLowering.cpp - Handle global ctors and dtors --------===//
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// This pass creates a unified init and fini kernel with the required metadata
10// to call global constructors and destructors on SPIR-V targets.
11//
12//===----------------------------------------------------------------------===//
13
14#include "SPIRV.h"
15#include "SPIRVSubtarget.h"
16#include "llvm/ADT/STLFunctionalExtras.h"
17#include "llvm/ADT/StringExtras.h"
18#include "llvm/IR/CallingConv.h"
19#include "llvm/IR/Constants.h"
20#include "llvm/IR/Function.h"
21#include "llvm/IR/GlobalVariable.h"
22#include "llvm/IR/IRBuilder.h"
23#include "llvm/IR/Module.h"
24#include "llvm/IR/Value.h"
25#include "llvm/Pass.h"
26#include "llvm/Support/MD5.h"
27#include "llvm/Support/SPIRVAddrSpace.h"
28#include "llvm/Transforms/IPO/OpenMPOpt.h"
29#include "llvm/Transforms/Utils/ModuleUtils.h"
30
31using namespace llvm;
32
33#define DEBUG_TYPE "spirv-lower-ctor-dtor"
34
35namespace {
36std::string getHash(StringRef Str) {
37 llvm::MD5 Hasher;
38 llvm::MD5::MD5Result Hash;
39 Hasher.update(Str);
40 Hasher.final(Result&: Hash);
41 return llvm::utohexstr(X: Hash.low(), /*LowerCase=*/true);
42}
43
44void addKernelAttrs(Function *F) {
45 F->setCallingConv(CallingConv::SPIR_KERNEL);
46 F->addFnAttr(Kind: "uniform-work-group-size", Val: "true");
47}
48
49Function *createInitOrFiniKernelFunction(Module &M, bool IsCtor) {
50 StringRef InitOrFiniKernelName =
51 IsCtor ? "spirv$device$init" : "spirv$device$fini";
52 if (M.getFunction(Name: InitOrFiniKernelName))
53 return nullptr;
54
55 Function *InitOrFiniKernel = Function::createWithDefaultAttr(
56 Ty: FunctionType::get(Result: Type::getVoidTy(C&: M.getContext()), isVarArg: false),
57 Linkage: GlobalValue::WeakODRLinkage, AddrSpace: 0, N: InitOrFiniKernelName, M: &M);
58 addKernelAttrs(F: InitOrFiniKernel);
59
60 return InitOrFiniKernel;
61}
62
63// We create the IR required to call each callback in this section. This is
64// equivalent to the following code. Normally, the linker would provide us with
65// the definitions of the init and fini array sections. The 'spirv-link' linker
66// does not do this so initializing these values is done by the offload runtime.
67//
68// extern "C" void **__init_array_start = nullptr;
69// extern "C" void **__init_array_end = nullptr;
70// extern "C" void **__fini_array_start = nullptr;
71// extern "C" void **__fini_array_end = nullptr;
72//
73// using InitCallback = void();
74// using FiniCallback = void();
75//
76// void call_init_array_callbacks() {
77// for (auto start = __init_array_start; start != __init_array_end; ++start)
78// reinterpret_cast<InitCallback *>(*start)();
79// }
80//
81// void call_fini_array_callbacks() {
82// size_t fini_array_size = __fini_array_end - __fini_array_start;
83// for (size_t i = fini_array_size; i > 0; --i)
84// reinterpret_cast<FiniCallback *>(__fini_array_start[i - 1])();
85// }
86void createInitOrFiniCalls(Function &F, bool IsCtor) {
87 Module &M = *F.getParent();
88 LLVMContext &C = M.getContext();
89
90 IRBuilder<> IRB(BasicBlock::Create(Context&: C, Name: "entry", Parent: &F));
91 auto *LoopBB = BasicBlock::Create(Context&: C, Name: "while.entry", Parent: &F);
92 auto *ExitBB = BasicBlock::Create(Context&: C, Name: "while.end", Parent: &F);
93 Type *PtrTy = IRB.getPtrTy(AddrSpace: SPIRVAS::CrossWorkgroup);
94
95 auto CreateGlobal = [&](const char *Name) -> GlobalVariable * {
96 auto *GV = new GlobalVariable(
97 M, PointerType::getUnqual(C),
98 /*isConstant=*/false, GlobalValue::WeakAnyLinkage,
99 Constant::getNullValue(Ty: PointerType::getUnqual(C)), Name,
100 /*InsertBefore=*/nullptr, GlobalVariable::NotThreadLocal,
101 /*AddressSpace=*/SPIRVAS::CrossWorkgroup);
102 GV->setVisibility(GlobalVariable::ProtectedVisibility);
103 return GV;
104 };
105
106 auto *Begin = M.getOrInsertGlobal(
107 Name: IsCtor ? "__init_array_start" : "__fini_array_start",
108 Ty: PointerType::getUnqual(C), CreateGlobalCallback: function_ref<GlobalVariable *()>([&]() {
109 return CreateGlobal(IsCtor ? "__init_array_start"
110 : "__fini_array_start");
111 }));
112 auto *End = M.getOrInsertGlobal(
113 Name: IsCtor ? "__init_array_end" : "__fini_array_end",
114 Ty: PointerType::getUnqual(C), CreateGlobalCallback: function_ref<GlobalVariable *()>([&]() {
115 return CreateGlobal(IsCtor ? "__init_array_end" : "__fini_array_end");
116 }));
117 auto *CallBackTy = FunctionType::get(Result: IRB.getVoidTy(), isVarArg: {});
118
119 // The destructor array must be called in reverse order. Get an expression to
120 // the end of the array and iterate backwards in that case.
121 Value *BeginVal = IRB.CreateLoad(Ty: Begin->getType(), Ptr: Begin, Name: "begin");
122 Value *EndVal = IRB.CreateLoad(Ty: Begin->getType(), Ptr: End, Name: "stop");
123 if (!IsCtor) {
124 Value *OldBeginVal = BeginVal;
125 BeginVal =
126 IRB.CreateInBoundsGEP(Ty: PointerType::getUnqual(C), Ptr: EndVal,
127 IdxList: ArrayRef<Value *>(ConstantInt::getAllOnesValue(
128 Ty: IntegerType::getInt64Ty(C))),
129 Name: "start");
130 EndVal = OldBeginVal;
131 }
132 IRB.CreateCondBr(
133 Cond: IRB.CreateCmp(Pred: IsCtor ? ICmpInst::ICMP_NE : ICmpInst::ICMP_UGE, LHS: BeginVal,
134 RHS: EndVal),
135 True: LoopBB, False: ExitBB);
136 IRB.SetInsertPoint(LoopBB);
137 auto *CallBackPHI = IRB.CreatePHI(Ty: PtrTy, NumReservedValues: 2, Name: "ptr");
138 auto *CallBack = IRB.CreateLoad(Ty: IRB.getPtrTy(AddrSpace: F.getAddressSpace()),
139 Ptr: CallBackPHI, Name: "callback");
140 IRB.CreateCall(FTy: CallBackTy, Callee: CallBack);
141 auto *NewCallBack =
142 IRB.CreateConstGEP1_64(Ty: PtrTy, Ptr: CallBackPHI, Idx0: IsCtor ? 1 : -1, Name: "next");
143 auto *EndCmp = IRB.CreateCmp(Pred: IsCtor ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_ULT,
144 LHS: NewCallBack, RHS: EndVal, Name: "end");
145 CallBackPHI->addIncoming(V: BeginVal, BB: &F.getEntryBlock());
146 CallBackPHI->addIncoming(V: NewCallBack, BB: LoopBB);
147 IRB.CreateCondBr(Cond: EndCmp, True: ExitBB, False: LoopBB);
148 IRB.SetInsertPoint(ExitBB);
149 IRB.CreateRetVoid();
150}
151
152bool createInitOrFiniGlobals(const SPIRVOptions &CLOpts, Module &M,
153 GlobalVariable *GV, bool IsCtor) {
154 ConstantArray *GA = dyn_cast<ConstantArray>(Val: GV->getInitializer());
155 if (!GA || GA->getNumOperands() == 0)
156 return false;
157
158 // SPIR-V has no way to emit variables at specific sections or support for
159 // the traditional constructor sections. Instead, we emit mangled global
160 // names so the runtime can build the list manually.
161 for (Value *V : GA->operands()) {
162 auto *CS = cast<ConstantStruct>(Val: V);
163 auto *F = cast<Constant>(Val: CS->getOperand(i_nocapture: 1));
164 uint64_t Priority = cast<ConstantInt>(Val: CS->getOperand(i_nocapture: 0))->getSExtValue();
165 std::string PriorityStr = "." + std::to_string(val: Priority);
166 // We append a semi-unique hash and the priority to the global name.
167 std::string GlobalID = !CLOpts.lower_global_ctor_dtor_id.empty()
168 ? CLOpts.lower_global_ctor_dtor_id.str()
169 : getHash(Str: M.getSourceFileName());
170 std::string NameStr =
171 ((IsCtor ? "__init_array_object_" : "__fini_array_object_") +
172 F->getName() + "_" + GlobalID + "_" + std::to_string(val: Priority))
173 .str();
174 llvm::transform(Range&: NameStr, d_first: NameStr.begin(),
175 F: [](char c) { return c == '.' ? '_' : c; });
176
177 auto *GV = new GlobalVariable(M, F->getType(), /*IsConstant=*/true,
178 GlobalValue::ExternalLinkage, F, NameStr,
179 nullptr, GlobalValue::NotThreadLocal,
180 /*AddressSpace=*/SPIRVAS::CrossWorkgroup);
181 GV->setSection(IsCtor ? ".init_array" + PriorityStr
182 : ".fini_array" + PriorityStr);
183 GV->setVisibility(GlobalVariable::ProtectedVisibility);
184 }
185
186 return true;
187}
188
189bool createInitOrFiniKernel(const SPIRVOptions &CLOpts, Module &M,
190 StringRef GlobalName, bool IsCtor) {
191 GlobalVariable *GV = M.getGlobalVariable(Name: GlobalName);
192 if (!GV || !GV->hasInitializer())
193 return false;
194
195 if (!createInitOrFiniGlobals(CLOpts, M, GV, IsCtor))
196 return false;
197
198 if (!CLOpts.emit_init_fini_kernel)
199 return true;
200
201 Function *InitOrFiniKernel = createInitOrFiniKernelFunction(M, IsCtor);
202 if (!InitOrFiniKernel)
203 return false;
204
205 createInitOrFiniCalls(F&: *InitOrFiniKernel, IsCtor);
206
207 GV->eraseFromParent();
208 return true;
209}
210
211bool lowerCtorsAndDtors(Module &M) {
212 // Only run this pass for OpenMP offload compilation
213 if (!llvm::omp::isOpenMPDevice(M))
214 return false;
215
216 const SPIRVOptions &CLOpts =
217 M.getContext().getLibraryOptions().get<SPIRVOptions>();
218 bool Modified = false;
219 Modified |=
220 createInitOrFiniKernel(CLOpts, M, GlobalName: "llvm.global_ctors", /*IsCtor =*/true);
221 Modified |=
222 createInitOrFiniKernel(CLOpts, M, GlobalName: "llvm.global_dtors", /*IsCtor =*/false);
223 return Modified;
224}
225
226class SPIRVCtorDtorLoweringLegacy final : public ModulePass {
227public:
228 static char ID;
229 SPIRVCtorDtorLoweringLegacy() : ModulePass(ID) {}
230 bool runOnModule(Module &M) override { return lowerCtorsAndDtors(M); }
231};
232
233} // End anonymous namespace
234
235PreservedAnalyses SPIRVCtorDtorLoweringPass::run(Module &M,
236 ModuleAnalysisManager &AM) {
237 return lowerCtorsAndDtors(M) ? PreservedAnalyses::none()
238 : PreservedAnalyses::all();
239}
240
241char SPIRVCtorDtorLoweringLegacy::ID = 0;
242INITIALIZE_PASS(SPIRVCtorDtorLoweringLegacy, DEBUG_TYPE,
243 "SPIRV lower ctors and dtors", false, false)
244
245ModulePass *llvm::createSPIRVCtorDtorLoweringLegacyPass() {
246 return new SPIRVCtorDtorLoweringLegacy();
247}
248