1 //===--- CGDeclCXX.cpp - Emit LLVM Code for C++ declarations --------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This contains code dealing with code generation of C++ declarations
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CodeGenFunction.h"
15 #include "CGCXXABI.h"
16 #include "CGObjCRuntime.h"
17 #include "CGOpenMPRuntime.h"
18 #include "clang/Frontend/CodeGenOptions.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/IR/Intrinsics.h"
21 #include "llvm/IR/MDBuilder.h"
22 #include "llvm/Support/Path.h"
23 
24 using namespace clang;
25 using namespace CodeGen;
26 
27 static void EmitDeclInit(CodeGenFunction &CGF, const VarDecl &D,
28                          ConstantAddress DeclPtr) {
29   assert(D.hasGlobalStorage() && "VarDecl must have global storage!");
30   assert(!D.getType()->isReferenceType() &&
31          "Should not call EmitDeclInit on a reference!");
32 
33   QualType type = D.getType();
34   LValue lv = CGF.MakeAddrLValue(DeclPtr, type);
35 
36   const Expr *Init = D.getInit();
37   switch (CGF.getEvaluationKind(type)) {
38   case TEK_Scalar: {
39     CodeGenModule &CGM = CGF.CGM;
40     if (lv.isObjCStrong())
41       CGM.getObjCRuntime().EmitObjCGlobalAssign(CGF, CGF.EmitScalarExpr(Init),
42                                                 DeclPtr, D.getTLSKind());
43     else if (lv.isObjCWeak())
44       CGM.getObjCRuntime().EmitObjCWeakAssign(CGF, CGF.EmitScalarExpr(Init),
45                                               DeclPtr);
46     else
47       CGF.EmitScalarInit(Init, &D, lv, false);
48     return;
49   }
50   case TEK_Complex:
51     CGF.EmitComplexExprIntoLValue(Init, lv, /*isInit*/ true);
52     return;
53   case TEK_Aggregate:
54     CGF.EmitAggExpr(Init, AggValueSlot::forLValue(lv,AggValueSlot::IsDestructed,
55                                           AggValueSlot::DoesNotNeedGCBarriers,
56                                                   AggValueSlot::IsNotAliased));
57     return;
58   }
59   llvm_unreachable("bad evaluation kind");
60 }
61 
62 /// Emit code to cause the destruction of the given variable with
63 /// static storage duration.
64 static void EmitDeclDestroy(CodeGenFunction &CGF, const VarDecl &D,
65                             ConstantAddress addr) {
66   CodeGenModule &CGM = CGF.CGM;
67 
68   // FIXME:  __attribute__((cleanup)) ?
69 
70   QualType type = D.getType();
71   QualType::DestructionKind dtorKind = type.isDestructedType();
72 
73   switch (dtorKind) {
74   case QualType::DK_none:
75     return;
76 
77   case QualType::DK_cxx_destructor:
78     break;
79 
80   case QualType::DK_objc_strong_lifetime:
81   case QualType::DK_objc_weak_lifetime:
82     // We don't care about releasing objects during process teardown.
83     assert(!D.getTLSKind() && "should have rejected this");
84     return;
85   }
86 
87   llvm::Constant *function;
88   llvm::Constant *argument;
89 
90   // Special-case non-array C++ destructors, if they have the right signature.
91   // Under some ABIs, destructors return this instead of void, and cannot be
92   // passed directly to __cxa_atexit if the target does not allow this mismatch.
93   const CXXRecordDecl *Record = type->getAsCXXRecordDecl();
94   bool CanRegisterDestructor =
95       Record && (!CGM.getCXXABI().HasThisReturn(
96                      GlobalDecl(Record->getDestructor(), Dtor_Complete)) ||
97                  CGM.getCXXABI().canCallMismatchedFunctionType());
98   // If __cxa_atexit is disabled via a flag, a different helper function is
99   // generated elsewhere which uses atexit instead, and it takes the destructor
100   // directly.
101   bool UsingExternalHelper = !CGM.getCodeGenOpts().CXAAtExit;
102   if (Record && (CanRegisterDestructor || UsingExternalHelper)) {
103     assert(!Record->hasTrivialDestructor());
104     CXXDestructorDecl *dtor = Record->getDestructor();
105 
106     function = CGM.getAddrOfCXXStructor(dtor, StructorType::Complete);
107     argument = llvm::ConstantExpr::getBitCast(
108         addr.getPointer(), CGF.getTypes().ConvertType(type)->getPointerTo());
109 
110   // Otherwise, the standard logic requires a helper function.
111   } else {
112     function = CodeGenFunction(CGM)
113         .generateDestroyHelper(addr, type, CGF.getDestroyer(dtorKind),
114                                CGF.needsEHCleanup(dtorKind), &D);
115     argument = llvm::Constant::getNullValue(CGF.Int8PtrTy);
116   }
117 
118   CGM.getCXXABI().registerGlobalDtor(CGF, D, function, argument);
119 }
120 
121 /// Emit code to cause the variable at the given address to be considered as
122 /// constant from this point onwards.
123 static void EmitDeclInvariant(CodeGenFunction &CGF, const VarDecl &D,
124                               llvm::Constant *Addr) {
125   // Do not emit the intrinsic if we're not optimizing.
126   if (!CGF.CGM.getCodeGenOpts().OptimizationLevel)
127     return;
128 
129   // Grab the llvm.invariant.start intrinsic.
130   llvm::Intrinsic::ID InvStartID = llvm::Intrinsic::invariant_start;
131   // Overloaded address space type.
132   llvm::Type *ObjectPtr[1] = {CGF.Int8PtrTy};
133   llvm::Constant *InvariantStart = CGF.CGM.getIntrinsic(InvStartID, ObjectPtr);
134 
135   // Emit a call with the size in bytes of the object.
136   CharUnits WidthChars = CGF.getContext().getTypeSizeInChars(D.getType());
137   uint64_t Width = WidthChars.getQuantity();
138   llvm::Value *Args[2] = { llvm::ConstantInt::getSigned(CGF.Int64Ty, Width),
139                            llvm::ConstantExpr::getBitCast(Addr, CGF.Int8PtrTy)};
140   CGF.Builder.CreateCall(InvariantStart, Args);
141 }
142 
143 void CodeGenFunction::EmitCXXGlobalVarDeclInit(const VarDecl &D,
144                                                llvm::Constant *DeclPtr,
145                                                bool PerformInit) {
146 
147   const Expr *Init = D.getInit();
148   QualType T = D.getType();
149 
150   // The address space of a static local variable (DeclPtr) may be different
151   // from the address space of the "this" argument of the constructor. In that
152   // case, we need an addrspacecast before calling the constructor.
153   //
154   // struct StructWithCtor {
155   //   __device__ StructWithCtor() {...}
156   // };
157   // __device__ void foo() {
158   //   __shared__ StructWithCtor s;
159   //   ...
160   // }
161   //
162   // For example, in the above CUDA code, the static local variable s has a
163   // "shared" address space qualifier, but the constructor of StructWithCtor
164   // expects "this" in the "generic" address space.
165   unsigned ExpectedAddrSpace = getContext().getTargetAddressSpace(T);
166   unsigned ActualAddrSpace = DeclPtr->getType()->getPointerAddressSpace();
167   if (ActualAddrSpace != ExpectedAddrSpace) {
168     llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(T);
169     llvm::PointerType *PTy = llvm::PointerType::get(LTy, ExpectedAddrSpace);
170     DeclPtr = llvm::ConstantExpr::getAddrSpaceCast(DeclPtr, PTy);
171   }
172 
173   ConstantAddress DeclAddr(DeclPtr, getContext().getDeclAlign(&D));
174 
175   if (!T->isReferenceType()) {
176     if (getLangOpts().OpenMP && D.hasAttr<OMPThreadPrivateDeclAttr>())
177       (void)CGM.getOpenMPRuntime().emitThreadPrivateVarDefinition(
178           &D, DeclAddr, D.getAttr<OMPThreadPrivateDeclAttr>()->getLocation(),
179           PerformInit, this);
180     if (PerformInit)
181       EmitDeclInit(*this, D, DeclAddr);
182     if (CGM.isTypeConstant(D.getType(), true))
183       EmitDeclInvariant(*this, D, DeclPtr);
184     else
185       EmitDeclDestroy(*this, D, DeclAddr);
186     return;
187   }
188 
189   assert(PerformInit && "cannot have constant initializer which needs "
190          "destruction for reference");
191   RValue RV = EmitReferenceBindingToExpr(Init);
192   EmitStoreOfScalar(RV.getScalarVal(), DeclAddr, false, T);
193 }
194 
195 /// Create a stub function, suitable for being passed to atexit,
196 /// which passes the given address to the given destructor function.
197 llvm::Constant *CodeGenFunction::createAtExitStub(const VarDecl &VD,
198                                                   llvm::Constant *dtor,
199                                                   llvm::Constant *addr) {
200   // Get the destructor function type, void(*)(void).
201   llvm::FunctionType *ty = llvm::FunctionType::get(CGM.VoidTy, false);
202   SmallString<256> FnName;
203   {
204     llvm::raw_svector_ostream Out(FnName);
205     CGM.getCXXABI().getMangleContext().mangleDynamicAtExitDestructor(&VD, Out);
206   }
207 
208   const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
209   llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(ty, FnName.str(),
210                                                               FI,
211                                                               VD.getLocation());
212 
213   CodeGenFunction CGF(CGM);
214 
215   CGF.StartFunction(&VD, CGM.getContext().VoidTy, fn, FI, FunctionArgList());
216 
217   llvm::CallInst *call = CGF.Builder.CreateCall(dtor, addr);
218 
219  // Make sure the call and the callee agree on calling convention.
220   if (llvm::Function *dtorFn =
221         dyn_cast<llvm::Function>(dtor->stripPointerCasts()))
222     call->setCallingConv(dtorFn->getCallingConv());
223 
224   CGF.FinishFunction();
225 
226   return fn;
227 }
228 
229 /// Register a global destructor using the C atexit runtime function.
230 void CodeGenFunction::registerGlobalDtorWithAtExit(const VarDecl &VD,
231                                                    llvm::Constant *dtor,
232                                                    llvm::Constant *addr) {
233   // Create a function which calls the destructor.
234   llvm::Constant *dtorStub = createAtExitStub(VD, dtor, addr);
235 
236   // extern "C" int atexit(void (*f)(void));
237   llvm::FunctionType *atexitTy =
238     llvm::FunctionType::get(IntTy, dtorStub->getType(), false);
239 
240   llvm::Constant *atexit =
241       CGM.CreateRuntimeFunction(atexitTy, "atexit", llvm::AttributeList(),
242                                 /*Local=*/true);
243   if (llvm::Function *atexitFn = dyn_cast<llvm::Function>(atexit))
244     atexitFn->setDoesNotThrow();
245 
246   EmitNounwindRuntimeCall(atexit, dtorStub);
247 }
248 
249 void CodeGenFunction::EmitCXXGuardedInit(const VarDecl &D,
250                                          llvm::GlobalVariable *DeclPtr,
251                                          bool PerformInit) {
252   // If we've been asked to forbid guard variables, emit an error now.
253   // This diagnostic is hard-coded for Darwin's use case;  we can find
254   // better phrasing if someone else needs it.
255   if (CGM.getCodeGenOpts().ForbidGuardVariables)
256     CGM.Error(D.getLocation(),
257               "this initialization requires a guard variable, which "
258               "the kernel does not support");
259 
260   CGM.getCXXABI().EmitGuardedInit(*this, D, DeclPtr, PerformInit);
261 }
262 
263 void CodeGenFunction::EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
264                                                llvm::BasicBlock *InitBlock,
265                                                llvm::BasicBlock *NoInitBlock,
266                                                GuardKind Kind,
267                                                const VarDecl *D) {
268   assert((Kind == GuardKind::TlsGuard || D) && "no guarded variable");
269 
270   // A guess at how many times we will enter the initialization of a
271   // variable, depending on the kind of variable.
272   static const uint64_t InitsPerTLSVar = 1024;
273   static const uint64_t InitsPerLocalVar = 1024 * 1024;
274 
275   llvm::MDNode *Weights;
276   if (Kind == GuardKind::VariableGuard && !D->isLocalVarDecl()) {
277     // For non-local variables, don't apply any weighting for now. Due to our
278     // use of COMDATs, we expect there to be at most one initialization of the
279     // variable per DSO, but we have no way to know how many DSOs will try to
280     // initialize the variable.
281     Weights = nullptr;
282   } else {
283     uint64_t NumInits;
284     // FIXME: For the TLS case, collect and use profiling information to
285     // determine a more accurate brach weight.
286     if (Kind == GuardKind::TlsGuard || D->getTLSKind())
287       NumInits = InitsPerTLSVar;
288     else
289       NumInits = InitsPerLocalVar;
290 
291     // The probability of us entering the initializer is
292     //   1 / (total number of times we attempt to initialize the variable).
293     llvm::MDBuilder MDHelper(CGM.getLLVMContext());
294     Weights = MDHelper.createBranchWeights(1, NumInits - 1);
295   }
296 
297   Builder.CreateCondBr(NeedsInit, InitBlock, NoInitBlock, Weights);
298 }
299 
300 llvm::Function *CodeGenModule::CreateGlobalInitOrDestructFunction(
301     llvm::FunctionType *FTy, const Twine &Name, const CGFunctionInfo &FI,
302     SourceLocation Loc, bool TLS) {
303   llvm::Function *Fn =
304     llvm::Function::Create(FTy, llvm::GlobalValue::InternalLinkage,
305                            Name, &getModule());
306   if (!getLangOpts().AppleKext && !TLS) {
307     // Set the section if needed.
308     if (const char *Section = getTarget().getStaticInitSectionSpecifier())
309       Fn->setSection(Section);
310   }
311 
312   SetInternalFunctionAttributes(nullptr, Fn, FI);
313 
314   Fn->setCallingConv(getRuntimeCC());
315 
316   if (!getLangOpts().Exceptions)
317     Fn->setDoesNotThrow();
318 
319   if (!isInSanitizerBlacklist(Fn, Loc)) {
320     if (getLangOpts().Sanitize.hasOneOf(SanitizerKind::Address |
321                                         SanitizerKind::KernelAddress))
322       Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
323     if (getLangOpts().Sanitize.has(SanitizerKind::Thread))
324       Fn->addFnAttr(llvm::Attribute::SanitizeThread);
325     if (getLangOpts().Sanitize.has(SanitizerKind::Memory))
326       Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
327     if (getLangOpts().Sanitize.has(SanitizerKind::SafeStack))
328       Fn->addFnAttr(llvm::Attribute::SafeStack);
329   }
330 
331   return Fn;
332 }
333 
334 /// Create a global pointer to a function that will initialize a global
335 /// variable.  The user has requested that this pointer be emitted in a specific
336 /// section.
337 void CodeGenModule::EmitPointerToInitFunc(const VarDecl *D,
338                                           llvm::GlobalVariable *GV,
339                                           llvm::Function *InitFunc,
340                                           InitSegAttr *ISA) {
341   llvm::GlobalVariable *PtrArray = new llvm::GlobalVariable(
342       TheModule, InitFunc->getType(), /*isConstant=*/true,
343       llvm::GlobalValue::PrivateLinkage, InitFunc, "__cxx_init_fn_ptr");
344   PtrArray->setSection(ISA->getSection());
345   addUsedGlobal(PtrArray);
346 
347   // If the GV is already in a comdat group, then we have to join it.
348   if (llvm::Comdat *C = GV->getComdat())
349     PtrArray->setComdat(C);
350 }
351 
352 void
353 CodeGenModule::EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
354                                             llvm::GlobalVariable *Addr,
355                                             bool PerformInit) {
356 
357   // According to E.2.3.1 in CUDA-7.5 Programming guide: __device__,
358   // __constant__ and __shared__ variables defined in namespace scope,
359   // that are of class type, cannot have a non-empty constructor. All
360   // the checks have been done in Sema by now. Whatever initializers
361   // are allowed are empty and we just need to ignore them here.
362   if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
363       (D->hasAttr<CUDADeviceAttr>() || D->hasAttr<CUDAConstantAttr>() ||
364        D->hasAttr<CUDASharedAttr>()))
365     return;
366 
367   // Check if we've already initialized this decl.
368   auto I = DelayedCXXInitPosition.find(D);
369   if (I != DelayedCXXInitPosition.end() && I->second == ~0U)
370     return;
371 
372   llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
373   SmallString<256> FnName;
374   {
375     llvm::raw_svector_ostream Out(FnName);
376     getCXXABI().getMangleContext().mangleDynamicInitializer(D, Out);
377   }
378 
379   // Create a variable initialization function.
380   llvm::Function *Fn =
381       CreateGlobalInitOrDestructFunction(FTy, FnName.str(),
382                                          getTypes().arrangeNullaryFunction(),
383                                          D->getLocation());
384 
385   auto *ISA = D->getAttr<InitSegAttr>();
386   CodeGenFunction(*this).GenerateCXXGlobalVarDeclInitFunc(Fn, D, Addr,
387                                                           PerformInit);
388 
389   llvm::GlobalVariable *COMDATKey =
390       supportsCOMDAT() && D->isExternallyVisible() ? Addr : nullptr;
391 
392   if (D->getTLSKind()) {
393     // FIXME: Should we support init_priority for thread_local?
394     // FIXME: We only need to register one __cxa_thread_atexit function for the
395     // entire TU.
396     CXXThreadLocalInits.push_back(Fn);
397     CXXThreadLocalInitVars.push_back(D);
398   } else if (PerformInit && ISA) {
399     EmitPointerToInitFunc(D, Addr, Fn, ISA);
400   } else if (auto *IPA = D->getAttr<InitPriorityAttr>()) {
401     OrderGlobalInits Key(IPA->getPriority(), PrioritizedCXXGlobalInits.size());
402     PrioritizedCXXGlobalInits.push_back(std::make_pair(Key, Fn));
403   } else if (isTemplateInstantiation(D->getTemplateSpecializationKind())) {
404     // C++ [basic.start.init]p2:
405     //   Definitions of explicitly specialized class template static data
406     //   members have ordered initialization. Other class template static data
407     //   members (i.e., implicitly or explicitly instantiated specializations)
408     //   have unordered initialization.
409     //
410     // As a consequence, we can put them into their own llvm.global_ctors entry.
411     //
412     // If the global is externally visible, put the initializer into a COMDAT
413     // group with the global being initialized.  On most platforms, this is a
414     // minor startup time optimization.  In the MS C++ ABI, there are no guard
415     // variables, so this COMDAT key is required for correctness.
416     AddGlobalCtor(Fn, 65535, COMDATKey);
417   } else if (D->hasAttr<SelectAnyAttr>()) {
418     // SelectAny globals will be comdat-folded. Put the initializer into a
419     // COMDAT group associated with the global, so the initializers get folded
420     // too.
421     AddGlobalCtor(Fn, 65535, COMDATKey);
422   } else {
423     I = DelayedCXXInitPosition.find(D); // Re-do lookup in case of re-hash.
424     if (I == DelayedCXXInitPosition.end()) {
425       CXXGlobalInits.push_back(Fn);
426     } else if (I->second != ~0U) {
427       assert(I->second < CXXGlobalInits.size() &&
428              CXXGlobalInits[I->second] == nullptr);
429       CXXGlobalInits[I->second] = Fn;
430     }
431   }
432 
433   // Remember that we already emitted the initializer for this global.
434   DelayedCXXInitPosition[D] = ~0U;
435 }
436 
437 void CodeGenModule::EmitCXXThreadLocalInitFunc() {
438   getCXXABI().EmitThreadLocalInitFuncs(
439       *this, CXXThreadLocals, CXXThreadLocalInits, CXXThreadLocalInitVars);
440 
441   CXXThreadLocalInits.clear();
442   CXXThreadLocalInitVars.clear();
443   CXXThreadLocals.clear();
444 }
445 
446 void
447 CodeGenModule::EmitCXXGlobalInitFunc() {
448   while (!CXXGlobalInits.empty() && !CXXGlobalInits.back())
449     CXXGlobalInits.pop_back();
450 
451   if (CXXGlobalInits.empty() && PrioritizedCXXGlobalInits.empty())
452     return;
453 
454   llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
455   const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
456 
457   // Create our global initialization function.
458   if (!PrioritizedCXXGlobalInits.empty()) {
459     SmallVector<llvm::Function *, 8> LocalCXXGlobalInits;
460     llvm::array_pod_sort(PrioritizedCXXGlobalInits.begin(),
461                          PrioritizedCXXGlobalInits.end());
462     // Iterate over "chunks" of ctors with same priority and emit each chunk
463     // into separate function. Note - everything is sorted first by priority,
464     // second - by lex order, so we emit ctor functions in proper order.
465     for (SmallVectorImpl<GlobalInitData >::iterator
466            I = PrioritizedCXXGlobalInits.begin(),
467            E = PrioritizedCXXGlobalInits.end(); I != E; ) {
468       SmallVectorImpl<GlobalInitData >::iterator
469         PrioE = std::upper_bound(I + 1, E, *I, GlobalInitPriorityCmp());
470 
471       LocalCXXGlobalInits.clear();
472       unsigned Priority = I->first.priority;
473       // Compute the function suffix from priority. Prepend with zeroes to make
474       // sure the function names are also ordered as priorities.
475       std::string PrioritySuffix = llvm::utostr(Priority);
476       // Priority is always <= 65535 (enforced by sema).
477       PrioritySuffix = std::string(6-PrioritySuffix.size(), '0')+PrioritySuffix;
478       llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
479           FTy, "_GLOBAL__I_" + PrioritySuffix, FI);
480 
481       for (; I < PrioE; ++I)
482         LocalCXXGlobalInits.push_back(I->second);
483 
484       CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, LocalCXXGlobalInits);
485       AddGlobalCtor(Fn, Priority);
486     }
487     PrioritizedCXXGlobalInits.clear();
488   }
489 
490   // Include the filename in the symbol name. Including "sub_" matches gcc and
491   // makes sure these symbols appear lexicographically behind the symbols with
492   // priority emitted above.
493   SmallString<128> FileName = llvm::sys::path::filename(getModule().getName());
494   if (FileName.empty())
495     FileName = "<null>";
496 
497   for (size_t i = 0; i < FileName.size(); ++i) {
498     // Replace everything that's not [a-zA-Z0-9._] with a _. This set happens
499     // to be the set of C preprocessing numbers.
500     if (!isPreprocessingNumberBody(FileName[i]))
501       FileName[i] = '_';
502   }
503 
504   llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
505       FTy, llvm::Twine("_GLOBAL__sub_I_", FileName), FI);
506 
507   CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, CXXGlobalInits);
508   AddGlobalCtor(Fn);
509 
510   CXXGlobalInits.clear();
511 }
512 
513 void CodeGenModule::EmitCXXGlobalDtorFunc() {
514   if (CXXGlobalDtors.empty())
515     return;
516 
517   llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
518 
519   // Create our global destructor function.
520   const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
521   llvm::Function *Fn =
522       CreateGlobalInitOrDestructFunction(FTy, "_GLOBAL__D_a", FI);
523 
524   CodeGenFunction(*this).GenerateCXXGlobalDtorsFunc(Fn, CXXGlobalDtors);
525   AddGlobalDtor(Fn);
526 }
527 
528 /// Emit the code necessary to initialize the given global variable.
529 void CodeGenFunction::GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
530                                                        const VarDecl *D,
531                                                  llvm::GlobalVariable *Addr,
532                                                        bool PerformInit) {
533   // Check if we need to emit debug info for variable initializer.
534   if (D->hasAttr<NoDebugAttr>())
535     DebugInfo = nullptr; // disable debug info indefinitely for this function
536 
537   CurEHLocation = D->getLocStart();
538 
539   StartFunction(GlobalDecl(D), getContext().VoidTy, Fn,
540                 getTypes().arrangeNullaryFunction(),
541                 FunctionArgList(), D->getLocation(),
542                 D->getInit()->getExprLoc());
543 
544   // Use guarded initialization if the global variable is weak. This
545   // occurs for, e.g., instantiated static data members and
546   // definitions explicitly marked weak.
547   if (Addr->hasWeakLinkage() || Addr->hasLinkOnceLinkage()) {
548     EmitCXXGuardedInit(*D, Addr, PerformInit);
549   } else {
550     EmitCXXGlobalVarDeclInit(*D, Addr, PerformInit);
551   }
552 
553   FinishFunction();
554 }
555 
556 void
557 CodeGenFunction::GenerateCXXGlobalInitFunc(llvm::Function *Fn,
558                                            ArrayRef<llvm::Function *> Decls,
559                                            Address Guard) {
560   {
561     auto NL = ApplyDebugLocation::CreateEmpty(*this);
562     StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
563                   getTypes().arrangeNullaryFunction(), FunctionArgList());
564     // Emit an artificial location for this function.
565     auto AL = ApplyDebugLocation::CreateArtificial(*this);
566 
567     llvm::BasicBlock *ExitBlock = nullptr;
568     if (Guard.isValid()) {
569       // If we have a guard variable, check whether we've already performed
570       // these initializations. This happens for TLS initialization functions.
571       llvm::Value *GuardVal = Builder.CreateLoad(Guard);
572       llvm::Value *Uninit = Builder.CreateIsNull(GuardVal,
573                                                  "guard.uninitialized");
574       llvm::BasicBlock *InitBlock = createBasicBlock("init");
575       ExitBlock = createBasicBlock("exit");
576       EmitCXXGuardedInitBranch(Uninit, InitBlock, ExitBlock,
577                                GuardKind::TlsGuard, nullptr);
578       EmitBlock(InitBlock);
579       // Mark as initialized before initializing anything else. If the
580       // initializers use previously-initialized thread_local vars, that's
581       // probably supposed to be OK, but the standard doesn't say.
582       Builder.CreateStore(llvm::ConstantInt::get(GuardVal->getType(),1), Guard);
583     }
584 
585     RunCleanupsScope Scope(*this);
586 
587     // When building in Objective-C++ ARC mode, create an autorelease pool
588     // around the global initializers.
589     if (getLangOpts().ObjCAutoRefCount && getLangOpts().CPlusPlus) {
590       llvm::Value *token = EmitObjCAutoreleasePoolPush();
591       EmitObjCAutoreleasePoolCleanup(token);
592     }
593 
594     for (unsigned i = 0, e = Decls.size(); i != e; ++i)
595       if (Decls[i])
596         EmitRuntimeCall(Decls[i]);
597 
598     Scope.ForceCleanup();
599 
600     if (ExitBlock) {
601       Builder.CreateBr(ExitBlock);
602       EmitBlock(ExitBlock);
603     }
604   }
605 
606   FinishFunction();
607 }
608 
609 void CodeGenFunction::GenerateCXXGlobalDtorsFunc(
610     llvm::Function *Fn,
611     const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
612         &DtorsAndObjects) {
613   {
614     auto NL = ApplyDebugLocation::CreateEmpty(*this);
615     StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
616                   getTypes().arrangeNullaryFunction(), FunctionArgList());
617     // Emit an artificial location for this function.
618     auto AL = ApplyDebugLocation::CreateArtificial(*this);
619 
620     // Emit the dtors, in reverse order from construction.
621     for (unsigned i = 0, e = DtorsAndObjects.size(); i != e; ++i) {
622       llvm::Value *Callee = DtorsAndObjects[e - i - 1].first;
623       llvm::CallInst *CI = Builder.CreateCall(Callee,
624                                           DtorsAndObjects[e - i - 1].second);
625       // Make sure the call and the callee agree on calling convention.
626       if (llvm::Function *F = dyn_cast<llvm::Function>(Callee))
627         CI->setCallingConv(F->getCallingConv());
628     }
629   }
630 
631   FinishFunction();
632 }
633 
634 /// generateDestroyHelper - Generates a helper function which, when
635 /// invoked, destroys the given object.  The address of the object
636 /// should be in global memory.
637 llvm::Function *CodeGenFunction::generateDestroyHelper(
638     Address addr, QualType type, Destroyer *destroyer,
639     bool useEHCleanupForArray, const VarDecl *VD) {
640   FunctionArgList args;
641   ImplicitParamDecl Dst(getContext(), getContext().VoidPtrTy,
642                         ImplicitParamDecl::Other);
643   args.push_back(&Dst);
644 
645   const CGFunctionInfo &FI =
646     CGM.getTypes().arrangeBuiltinFunctionDeclaration(getContext().VoidTy, args);
647   llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
648   llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(
649       FTy, "__cxx_global_array_dtor", FI, VD->getLocation());
650 
651   CurEHLocation = VD->getLocStart();
652 
653   StartFunction(VD, getContext().VoidTy, fn, FI, args);
654 
655   emitDestroy(addr, type, destroyer, useEHCleanupForArray);
656 
657   FinishFunction();
658 
659   return fn;
660 }
661