blob: 89d142e44b49e5ba4d53f7a4efdd58f6213c9992 [file] [log] [blame]
Anders Carlsson5ec2e7c2009-12-10 00:16:00 +00001//===--- 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"
John McCall4c40d982010-08-31 07:33:07 +000015#include "CGCXXABI.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000016#include "CGObjCRuntime.h"
Stephen Hines176edba2014-12-01 14:53:08 -080017#include "CGOpenMPRuntime.h"
Chandler Carruth06057ce2010-06-15 23:19:56 +000018#include "clang/Frontend/CodeGenOptions.h"
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +000019#include "llvm/ADT/StringExtras.h"
Chandler Carruth3b844ba2013-01-02 11:45:17 +000020#include "llvm/IR/Intrinsics.h"
Stephen Hines6bcf27b2014-05-29 04:14:42 -070021#include "llvm/Support/Path.h"
Douglas Gregor86a3a032010-05-16 01:24:12 +000022
Anders Carlsson5ec2e7c2009-12-10 00:16:00 +000023using namespace clang;
24using namespace CodeGen;
25
Anders Carlssonfcbfdc12009-12-10 00:57:45 +000026static void EmitDeclInit(CodeGenFunction &CGF, const VarDecl &D,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080027 ConstantAddress DeclPtr) {
Anders Carlssonfcbfdc12009-12-10 00:57:45 +000028 assert(D.hasGlobalStorage() && "VarDecl must have global storage!");
29 assert(!D.getType()->isReferenceType() &&
30 "Should not call EmitDeclInit on a reference!");
31
John McCalla07398e2011-06-16 04:16:24 +000032 QualType type = D.getType();
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080033 LValue lv = CGF.MakeAddrLValue(DeclPtr, type);
John McCalla07398e2011-06-16 04:16:24 +000034
35 const Expr *Init = D.getInit();
John McCall9d232c82013-03-07 21:37:08 +000036 switch (CGF.getEvaluationKind(type)) {
37 case TEK_Scalar: {
Fariborz Jahanianec805122011-01-13 20:00:54 +000038 CodeGenModule &CGM = CGF.CGM;
John McCalla07398e2011-06-16 04:16:24 +000039 if (lv.isObjCStrong())
John McCallf85e1932011-06-15 23:02:42 +000040 CGM.getObjCRuntime().EmitObjCGlobalAssign(CGF, CGF.EmitScalarExpr(Init),
Richard Smith38afbc72013-04-13 02:43:54 +000041 DeclPtr, D.getTLSKind());
John McCalla07398e2011-06-16 04:16:24 +000042 else if (lv.isObjCWeak())
43 CGM.getObjCRuntime().EmitObjCWeakAssign(CGF, CGF.EmitScalarExpr(Init),
44 DeclPtr);
Fariborz Jahanianec805122011-01-13 20:00:54 +000045 else
John McCalla07398e2011-06-16 04:16:24 +000046 CGF.EmitScalarInit(Init, &D, lv, false);
John McCall9d232c82013-03-07 21:37:08 +000047 return;
48 }
49 case TEK_Complex:
50 CGF.EmitComplexExprIntoLValue(Init, lv, /*isInit*/ true);
51 return;
52 case TEK_Aggregate:
Chad Rosier649b4a12012-03-29 17:37:10 +000053 CGF.EmitAggExpr(Init, AggValueSlot::forLValue(lv,AggValueSlot::IsDestructed,
54 AggValueSlot::DoesNotNeedGCBarriers,
55 AggValueSlot::IsNotAliased));
John McCall9d232c82013-03-07 21:37:08 +000056 return;
Anders Carlsson5ec2e7c2009-12-10 00:16:00 +000057 }
John McCall9d232c82013-03-07 21:37:08 +000058 llvm_unreachable("bad evaluation kind");
Anders Carlsson5ec2e7c2009-12-10 00:16:00 +000059}
60
John McCall5cd91b52010-09-08 01:44:27 +000061/// Emit code to cause the destruction of the given variable with
62/// static storage duration.
Douglas Gregorcc6a44b2010-05-05 15:38:32 +000063static void EmitDeclDestroy(CodeGenFunction &CGF, const VarDecl &D,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -080064 ConstantAddress addr) {
Douglas Gregorcc6a44b2010-05-05 15:38:32 +000065 CodeGenModule &CGM = CGF.CGM;
John McCalla91f6662011-07-13 03:01:35 +000066
67 // FIXME: __attribute__((cleanup)) ?
Douglas Gregorcc6a44b2010-05-05 15:38:32 +000068
John McCalla91f6662011-07-13 03:01:35 +000069 QualType type = D.getType();
70 QualType::DestructionKind dtorKind = type.isDestructedType();
71
72 switch (dtorKind) {
73 case QualType::DK_none:
Douglas Gregorcc6a44b2010-05-05 15:38:32 +000074 return;
John McCalla91f6662011-07-13 03:01:35 +000075
76 case QualType::DK_cxx_destructor:
77 break;
78
79 case QualType::DK_objc_strong_lifetime:
80 case QualType::DK_objc_weak_lifetime:
81 // We don't care about releasing objects during process teardown.
Richard Smith04e51762013-04-14 23:01:42 +000082 assert(!D.getTLSKind() && "should have rejected this");
Douglas Gregorcc6a44b2010-05-05 15:38:32 +000083 return;
John McCalla91f6662011-07-13 03:01:35 +000084 }
85
86 llvm::Constant *function;
87 llvm::Constant *argument;
88
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -070089 // Special-case non-array C++ destructors, if they have the right signature.
90 // Under some ABIs, destructors return this instead of void, and cannot be
91 // passed directly to __cxa_atexit if the target does not allow this mismatch.
92 const CXXRecordDecl *Record = type->getAsCXXRecordDecl();
93 bool CanRegisterDestructor =
94 Record && (!CGM.getCXXABI().HasThisReturn(
95 GlobalDecl(Record->getDestructor(), Dtor_Complete)) ||
96 CGM.getCXXABI().canCallMismatchedFunctionType());
97 // If __cxa_atexit is disabled via a flag, a different helper function is
98 // generated elsewhere which uses atexit instead, and it takes the destructor
99 // directly.
100 bool UsingExternalHelper = !CGM.getCodeGenOpts().CXAAtExit;
101 if (Record && (CanRegisterDestructor || UsingExternalHelper)) {
102 assert(!Record->hasTrivialDestructor());
103 CXXDestructorDecl *dtor = Record->getDestructor();
John McCalla91f6662011-07-13 03:01:35 +0000104
Stephen Hines176edba2014-12-01 14:53:08 -0800105 function = CGM.getAddrOfCXXStructor(dtor, StructorType::Complete);
Timur Iskhodzhanov9a3be4c2013-10-02 16:03:16 +0000106 argument = llvm::ConstantExpr::getBitCast(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800107 addr.getPointer(), CGF.getTypes().ConvertType(type)->getPointerTo());
John McCalla91f6662011-07-13 03:01:35 +0000108
109 // Otherwise, the standard logic requires a helper function.
110 } else {
David Blaikiec7971a92013-08-27 23:57:18 +0000111 function = CodeGenFunction(CGM)
112 .generateDestroyHelper(addr, type, CGF.getDestroyer(dtorKind),
113 CGF.needsEHCleanup(dtorKind), &D);
John McCalla91f6662011-07-13 03:01:35 +0000114 argument = llvm::Constant::getNullValue(CGF.Int8PtrTy);
115 }
116
Richard Smith04e51762013-04-14 23:01:42 +0000117 CGM.getCXXABI().registerGlobalDtor(CGF, D, function, argument);
Douglas Gregorcc6a44b2010-05-05 15:38:32 +0000118}
119
Richard Smithabb94322012-02-17 07:31:37 +0000120/// Emit code to cause the variable at the given address to be considered as
121/// constant from this point onwards.
Nick Lewyckyef784462012-02-21 00:26:58 +0000122static void EmitDeclInvariant(CodeGenFunction &CGF, const VarDecl &D,
123 llvm::Constant *Addr) {
Richard Smith00a8c3f2012-02-17 20:12:52 +0000124 // Don't emit the intrinsic if we're not optimizing.
125 if (!CGF.CGM.getCodeGenOpts().OptimizationLevel)
126 return;
127
Richard Smithabb94322012-02-17 07:31:37 +0000128 // Grab the llvm.invariant.start intrinsic.
129 llvm::Intrinsic::ID InvStartID = llvm::Intrinsic::invariant_start;
130 llvm::Constant *InvariantStart = CGF.CGM.getIntrinsic(InvStartID);
131
Nick Lewyckyef784462012-02-21 00:26:58 +0000132 // Emit a call with the size in bytes of the object.
133 CharUnits WidthChars = CGF.getContext().getTypeSizeInChars(D.getType());
134 uint64_t Width = WidthChars.getQuantity();
135 llvm::Value *Args[2] = { llvm::ConstantInt::getSigned(CGF.Int64Ty, Width),
Richard Smithabb94322012-02-17 07:31:37 +0000136 llvm::ConstantExpr::getBitCast(Addr, CGF.Int8PtrTy)};
137 CGF.Builder.CreateCall(InvariantStart, Args);
138}
139
Anders Carlssonfcbfdc12009-12-10 00:57:45 +0000140void CodeGenFunction::EmitCXXGlobalVarDeclInit(const VarDecl &D,
Richard Smith7ca48502012-02-13 22:16:19 +0000141 llvm::Constant *DeclPtr,
142 bool PerformInit) {
Anders Carlssonfcbfdc12009-12-10 00:57:45 +0000143
144 const Expr *Init = D.getInit();
145 QualType T = D.getType();
146
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700147 // The address space of a static local variable (DeclPtr) may be different
148 // from the address space of the "this" argument of the constructor. In that
149 // case, we need an addrspacecast before calling the constructor.
150 //
151 // struct StructWithCtor {
152 // __device__ StructWithCtor() {...}
153 // };
154 // __device__ void foo() {
155 // __shared__ StructWithCtor s;
156 // ...
157 // }
158 //
159 // For example, in the above CUDA code, the static local variable s has a
160 // "shared" address space qualifier, but the constructor of StructWithCtor
161 // expects "this" in the "generic" address space.
162 unsigned ExpectedAddrSpace = getContext().getTargetAddressSpace(T);
163 unsigned ActualAddrSpace = DeclPtr->getType()->getPointerAddressSpace();
164 if (ActualAddrSpace != ExpectedAddrSpace) {
165 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(T);
166 llvm::PointerType *PTy = llvm::PointerType::get(LTy, ExpectedAddrSpace);
167 DeclPtr = llvm::ConstantExpr::getAddrSpaceCast(DeclPtr, PTy);
168 }
169
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800170 ConstantAddress DeclAddr(DeclPtr, getContext().getDeclAlign(&D));
171
Anders Carlssonfcbfdc12009-12-10 00:57:45 +0000172 if (!T->isReferenceType()) {
Stephen Hines176edba2014-12-01 14:53:08 -0800173 if (getLangOpts().OpenMP && D.hasAttr<OMPThreadPrivateDeclAttr>())
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700174 (void)CGM.getOpenMPRuntime().emitThreadPrivateVarDefinition(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800175 &D, DeclAddr, D.getAttr<OMPThreadPrivateDeclAttr>()->getLocation(),
Stephen Hines176edba2014-12-01 14:53:08 -0800176 PerformInit, this);
Richard Smith7ca48502012-02-13 22:16:19 +0000177 if (PerformInit)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800178 EmitDeclInit(*this, D, DeclAddr);
Richard Smithabb94322012-02-17 07:31:37 +0000179 if (CGM.isTypeConstant(D.getType(), true))
Nick Lewyckyef784462012-02-21 00:26:58 +0000180 EmitDeclInvariant(*this, D, DeclPtr);
Richard Smithabb94322012-02-17 07:31:37 +0000181 else
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800182 EmitDeclDestroy(*this, D, DeclAddr);
Anders Carlssonfcbfdc12009-12-10 00:57:45 +0000183 return;
184 }
Anders Carlsson045a6d82010-06-27 17:52:15 +0000185
Richard Smith7ca48502012-02-13 22:16:19 +0000186 assert(PerformInit && "cannot have constant initializer which needs "
187 "destruction for reference");
Richard Smithd4ec5622013-06-12 23:38:09 +0000188 RValue RV = EmitReferenceBindingToExpr(Init);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800189 EmitStoreOfScalar(RV.getScalarVal(), DeclAddr, false, T);
Anders Carlssonfcbfdc12009-12-10 00:57:45 +0000190}
Anders Carlssoneb4072e2009-12-10 00:30:05 +0000191
John McCall30fa3702012-04-06 18:21:06 +0000192/// Create a stub function, suitable for being passed to atexit,
193/// which passes the given address to the given destructor function.
Stephen Hines176edba2014-12-01 14:53:08 -0800194llvm::Constant *CodeGenFunction::createAtExitStub(const VarDecl &VD,
195 llvm::Constant *dtor,
196 llvm::Constant *addr) {
John McCall30fa3702012-04-06 18:21:06 +0000197 // Get the destructor function type, void(*)(void).
198 llvm::FunctionType *ty = llvm::FunctionType::get(CGM.VoidTy, false);
Reid Kleckner942f9fe2013-09-10 20:14:30 +0000199 SmallString<256> FnName;
200 {
201 llvm::raw_svector_ostream Out(FnName);
202 CGM.getCXXABI().getMangleContext().mangleDynamicAtExitDestructor(&VD, Out);
203 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800204
205 const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
Stephen Hines176edba2014-12-01 14:53:08 -0800206 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(ty, FnName.str(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800207 FI,
Stephen Hines176edba2014-12-01 14:53:08 -0800208 VD.getLocation());
John McCall30fa3702012-04-06 18:21:06 +0000209
210 CodeGenFunction CGF(CGM);
211
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800212 CGF.StartFunction(&VD, CGM.getContext().VoidTy, fn, FI, FunctionArgList());
John McCall30fa3702012-04-06 18:21:06 +0000213
214 llvm::CallInst *call = CGF.Builder.CreateCall(dtor, addr);
215
216 // Make sure the call and the callee agree on calling convention.
217 if (llvm::Function *dtorFn =
218 dyn_cast<llvm::Function>(dtor->stripPointerCasts()))
219 call->setCallingConv(dtorFn->getCallingConv());
220
221 CGF.FinishFunction();
222
223 return fn;
224}
225
John McCall20bb1752012-05-01 06:13:13 +0000226/// Register a global destructor using the C atexit runtime function.
David Blaikiec7971a92013-08-27 23:57:18 +0000227void CodeGenFunction::registerGlobalDtorWithAtExit(const VarDecl &VD,
228 llvm::Constant *dtor,
John McCall20bb1752012-05-01 06:13:13 +0000229 llvm::Constant *addr) {
John McCall30fa3702012-04-06 18:21:06 +0000230 // Create a function which calls the destructor.
Stephen Hines176edba2014-12-01 14:53:08 -0800231 llvm::Constant *dtorStub = createAtExitStub(VD, dtor, addr);
John McCall30fa3702012-04-06 18:21:06 +0000232
233 // extern "C" int atexit(void (*f)(void));
234 llvm::FunctionType *atexitTy =
John McCall20bb1752012-05-01 06:13:13 +0000235 llvm::FunctionType::get(IntTy, dtorStub->getType(), false);
John McCall30fa3702012-04-06 18:21:06 +0000236
237 llvm::Constant *atexit =
John McCall20bb1752012-05-01 06:13:13 +0000238 CGM.CreateRuntimeFunction(atexitTy, "atexit");
John McCall30fa3702012-04-06 18:21:06 +0000239 if (llvm::Function *atexitFn = dyn_cast<llvm::Function>(atexit))
240 atexitFn->setDoesNotThrow();
241
John McCallbd7370a2013-02-28 19:01:20 +0000242 EmitNounwindRuntimeCall(atexit, dtorStub);
Anders Carlssoneb4072e2009-12-10 00:30:05 +0000243}
244
John McCall3030eb82010-11-06 09:44:32 +0000245void CodeGenFunction::EmitCXXGuardedInit(const VarDecl &D,
Chandler Carruth0f30a122012-03-30 19:44:53 +0000246 llvm::GlobalVariable *DeclPtr,
Richard Smith7ca48502012-02-13 22:16:19 +0000247 bool PerformInit) {
John McCall32096692011-03-18 02:56:14 +0000248 // If we've been asked to forbid guard variables, emit an error now.
249 // This diagnostic is hard-coded for Darwin's use case; we can find
250 // better phrasing if someone else needs it.
251 if (CGM.getCodeGenOpts().ForbidGuardVariables)
252 CGM.Error(D.getLocation(),
253 "this initialization requires a guard variable, which "
254 "the kernel does not support");
255
Chandler Carruth0f30a122012-03-30 19:44:53 +0000256 CGM.getCXXABI().EmitGuardedInit(*this, D, DeclPtr, PerformInit);
John McCall5cd91b52010-09-08 01:44:27 +0000257}
258
Stephen Hines176edba2014-12-01 14:53:08 -0800259llvm::Function *CodeGenModule::CreateGlobalInitOrDestructFunction(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800260 llvm::FunctionType *FTy, const Twine &Name, const CGFunctionInfo &FI,
261 SourceLocation Loc, bool TLS) {
Anders Carlsson9dc046e2010-06-08 22:40:05 +0000262 llvm::Function *Fn =
263 llvm::Function::Create(FTy, llvm::GlobalValue::InternalLinkage,
Stephen Hines176edba2014-12-01 14:53:08 -0800264 Name, &getModule());
265 if (!getLangOpts().AppleKext && !TLS) {
Fariborz Jahaniand6c9a0f2011-02-15 18:54:46 +0000266 // Set the section if needed.
Stephen Hines176edba2014-12-01 14:53:08 -0800267 if (const char *Section = getTarget().getStaticInitSectionSpecifier())
Fariborz Jahaniand6c9a0f2011-02-15 18:54:46 +0000268 Fn->setSection(Section);
269 }
Anders Carlsson18af3682010-06-08 22:47:50 +0000270
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800271 SetInternalFunctionAttributes(nullptr, Fn, FI);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700272
Stephen Hines176edba2014-12-01 14:53:08 -0800273 Fn->setCallingConv(getRuntimeCC());
John McCallbd7370a2013-02-28 19:01:20 +0000274
Stephen Hines176edba2014-12-01 14:53:08 -0800275 if (!getLangOpts().Exceptions)
John McCall044cc542010-07-06 04:38:10 +0000276 Fn->setDoesNotThrow();
277
Stephen Hines176edba2014-12-01 14:53:08 -0800278 if (!isInSanitizerBlacklist(Fn, Loc)) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800279 if (getLangOpts().Sanitize.hasOneOf(SanitizerKind::Address |
280 SanitizerKind::KernelAddress))
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700281 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
Stephen Hines176edba2014-12-01 14:53:08 -0800282 if (getLangOpts().Sanitize.has(SanitizerKind::Thread))
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700283 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
Stephen Hines176edba2014-12-01 14:53:08 -0800284 if (getLangOpts().Sanitize.has(SanitizerKind::Memory))
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700285 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700286 if (getLangOpts().Sanitize.has(SanitizerKind::SafeStack))
287 Fn->addFnAttr(llvm::Attribute::SafeStack);
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700288 }
Kostya Serebryanyb9d2b3b2012-06-26 08:56:33 +0000289
Anders Carlsson9dc046e2010-06-08 22:40:05 +0000290 return Fn;
291}
292
Stephen Hines176edba2014-12-01 14:53:08 -0800293/// Create a global pointer to a function that will initialize a global
294/// variable. The user has requested that this pointer be emitted in a specific
295/// section.
296void CodeGenModule::EmitPointerToInitFunc(const VarDecl *D,
297 llvm::GlobalVariable *GV,
298 llvm::Function *InitFunc,
299 InitSegAttr *ISA) {
300 llvm::GlobalVariable *PtrArray = new llvm::GlobalVariable(
301 TheModule, InitFunc->getType(), /*isConstant=*/true,
302 llvm::GlobalValue::PrivateLinkage, InitFunc, "__cxx_init_fn_ptr");
303 PtrArray->setSection(ISA->getSection());
304 addUsedGlobal(PtrArray);
305
306 // If the GV is already in a comdat group, then we have to join it.
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700307 if (llvm::Comdat *C = GV->getComdat())
Stephen Hines176edba2014-12-01 14:53:08 -0800308 PtrArray->setComdat(C);
309}
310
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000311void
John McCall3030eb82010-11-06 09:44:32 +0000312CodeGenModule::EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
Richard Smith7ca48502012-02-13 22:16:19 +0000313 llvm::GlobalVariable *Addr,
314 bool PerformInit) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700315
316 // According to E.2.3.1 in CUDA-7.5 Programming guide: __device__,
317 // __constant__ and __shared__ variables defined in namespace scope,
318 // that are of class type, cannot have a non-empty constructor. All
319 // the checks have been done in Sema by now. Whatever initializers
320 // are allowed are empty and we just need to ignore them here.
321 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
322 (D->hasAttr<CUDADeviceAttr>() || D->hasAttr<CUDAConstantAttr>() ||
323 D->hasAttr<CUDASharedAttr>()))
324 return;
325
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -0700326 // Check if we've already initialized this decl.
327 auto I = DelayedCXXInitPosition.find(D);
328 if (I != DelayedCXXInitPosition.end() && I->second == ~0U)
329 return;
330
Chris Lattner8b418682012-02-07 00:39:47 +0000331 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Reid Klecknerc5c6fa72013-09-10 20:43:12 +0000332 SmallString<256> FnName;
333 {
334 llvm::raw_svector_ostream Out(FnName);
335 getCXXABI().getMangleContext().mangleDynamicInitializer(D, Out);
336 }
Eli Friedman6c6bda32010-01-08 00:50:11 +0000337
338 // Create a variable initialization function.
339 llvm::Function *Fn =
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800340 CreateGlobalInitOrDestructFunction(FTy, FnName.str(),
341 getTypes().arrangeNullaryFunction(),
342 D->getLocation());
Eli Friedman6c6bda32010-01-08 00:50:11 +0000343
Stephen Hines176edba2014-12-01 14:53:08 -0800344 auto *ISA = D->getAttr<InitSegAttr>();
Richard Smith7ca48502012-02-13 22:16:19 +0000345 CodeGenFunction(*this).GenerateCXXGlobalVarDeclInitFunc(Fn, D, Addr,
346 PerformInit);
Eli Friedman6c6bda32010-01-08 00:50:11 +0000347
Stephen Hines176edba2014-12-01 14:53:08 -0800348 llvm::GlobalVariable *COMDATKey =
349 supportsCOMDAT() && D->isExternallyVisible() ? Addr : nullptr;
350
Richard Smithb80a16e2013-04-19 16:42:07 +0000351 if (D->getTLSKind()) {
352 // FIXME: Should we support init_priority for thread_local?
353 // FIXME: Ideally, initialization of instantiated thread_local static data
354 // members of class templates should not trigger initialization of other
355 // entities in the TU.
356 // FIXME: We only need to register one __cxa_thread_atexit function for the
357 // entire TU.
358 CXXThreadLocalInits.push_back(Fn);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800359 CXXThreadLocalInitVars.push_back(D);
Stephen Hines176edba2014-12-01 14:53:08 -0800360 } else if (PerformInit && ISA) {
361 EmitPointerToInitFunc(D, Addr, Fn, ISA);
Stephen Hines176edba2014-12-01 14:53:08 -0800362 } else if (auto *IPA = D->getAttr<InitPriorityAttr>()) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700363 OrderGlobalInits Key(IPA->getPriority(), PrioritizedCXXGlobalInits.size());
Fariborz Jahaniane0b691a2010-06-21 21:27:42 +0000364 PrioritizedCXXGlobalInits.push_back(std::make_pair(Key, Fn));
Stephen Hines176edba2014-12-01 14:53:08 -0800365 } else if (isTemplateInstantiation(D->getTemplateSpecializationKind())) {
Reid Klecknerb969e842013-08-22 20:07:45 +0000366 // C++ [basic.start.init]p2:
Reid Klecknerc47063e2013-09-04 00:54:24 +0000367 // Definitions of explicitly specialized class template static data
368 // members have ordered initialization. Other class template static data
369 // members (i.e., implicitly or explicitly instantiated specializations)
370 // have unordered initialization.
Reid Klecknerb969e842013-08-22 20:07:45 +0000371 //
372 // As a consequence, we can put them into their own llvm.global_ctors entry.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700373 //
Stephen Hines176edba2014-12-01 14:53:08 -0800374 // If the global is externally visible, put the initializer into a COMDAT
375 // group with the global being initialized. On most platforms, this is a
376 // minor startup time optimization. In the MS C++ ABI, there are no guard
377 // variables, so this COMDAT key is required for correctness.
378 AddGlobalCtor(Fn, 65535, COMDATKey);
Stephen Hines176edba2014-12-01 14:53:08 -0800379 } else if (D->hasAttr<SelectAnyAttr>()) {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700380 // SelectAny globals will be comdat-folded. Put the initializer into a
381 // COMDAT group associated with the global, so the initializers get folded
382 // too.
Stephen Hines176edba2014-12-01 14:53:08 -0800383 AddGlobalCtor(Fn, 65535, COMDATKey);
Richard Smithb80a16e2013-04-19 16:42:07 +0000384 } else {
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -0700385 I = DelayedCXXInitPosition.find(D); // Re-do lookup in case of re-hash.
John McCallbf40cb52010-07-15 23:40:35 +0000386 if (I == DelayedCXXInitPosition.end()) {
387 CXXGlobalInits.push_back(Fn);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -0700388 } else if (I->second != ~0U) {
389 assert(I->second < CXXGlobalInits.size() &&
390 CXXGlobalInits[I->second] == nullptr);
John McCallbf40cb52010-07-15 23:40:35 +0000391 CXXGlobalInits[I->second] = Fn;
John McCallbf40cb52010-07-15 23:40:35 +0000392 }
393 }
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -0700394
395 // Remember that we already emitted the initializer for this global.
396 DelayedCXXInitPosition[D] = ~0U;
Eli Friedman6c6bda32010-01-08 00:50:11 +0000397}
398
Richard Smithb80a16e2013-04-19 16:42:07 +0000399void CodeGenModule::EmitCXXThreadLocalInitFunc() {
Stephen Hines176edba2014-12-01 14:53:08 -0800400 getCXXABI().EmitThreadLocalInitFuncs(
401 *this, CXXThreadLocals, CXXThreadLocalInits, CXXThreadLocalInitVars);
Richard Smithb80a16e2013-04-19 16:42:07 +0000402
403 CXXThreadLocalInits.clear();
Stephen Hines176edba2014-12-01 14:53:08 -0800404 CXXThreadLocalInitVars.clear();
Richard Smithb80a16e2013-04-19 16:42:07 +0000405 CXXThreadLocals.clear();
406}
407
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000408void
409CodeGenModule::EmitCXXGlobalInitFunc() {
John McCallbf40cb52010-07-15 23:40:35 +0000410 while (!CXXGlobalInits.empty() && !CXXGlobalInits.back())
411 CXXGlobalInits.pop_back();
412
Fariborz Jahanian9f967c52010-06-21 18:45:05 +0000413 if (CXXGlobalInits.empty() && PrioritizedCXXGlobalInits.empty())
Anders Carlssoneb4072e2009-12-10 00:30:05 +0000414 return;
415
Chris Lattner8b418682012-02-07 00:39:47 +0000416 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800417 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
Anders Carlssoneb4072e2009-12-10 00:30:05 +0000418
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +0000419 // Create our global initialization function.
Fariborz Jahanian9f967c52010-06-21 18:45:05 +0000420 if (!PrioritizedCXXGlobalInits.empty()) {
Stephen Hines176edba2014-12-01 14:53:08 -0800421 SmallVector<llvm::Function *, 8> LocalCXXGlobalInits;
Fariborz Jahanian027d7ed2010-06-21 19:49:38 +0000422 llvm::array_pod_sort(PrioritizedCXXGlobalInits.begin(),
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +0000423 PrioritizedCXXGlobalInits.end());
424 // Iterate over "chunks" of ctors with same priority and emit each chunk
425 // into separate function. Note - everything is sorted first by priority,
426 // second - by lex order, so we emit ctor functions in proper order.
427 for (SmallVectorImpl<GlobalInitData >::iterator
428 I = PrioritizedCXXGlobalInits.begin(),
429 E = PrioritizedCXXGlobalInits.end(); I != E; ) {
430 SmallVectorImpl<GlobalInitData >::iterator
431 PrioE = std::upper_bound(I + 1, E, *I, GlobalInitPriorityCmp());
432
433 LocalCXXGlobalInits.clear();
434 unsigned Priority = I->first.priority;
435 // Compute the function suffix from priority. Prepend with zeroes to make
436 // sure the function names are also ordered as priorities.
437 std::string PrioritySuffix = llvm::utostr(Priority);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700438 // Priority is always <= 65535 (enforced by sema).
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +0000439 PrioritySuffix = std::string(6-PrioritySuffix.size(), '0')+PrioritySuffix;
Stephen Hines176edba2014-12-01 14:53:08 -0800440 llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800441 FTy, "_GLOBAL__I_" + PrioritySuffix, FI);
Stephen Hines176edba2014-12-01 14:53:08 -0800442
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +0000443 for (; I < PrioE; ++I)
444 LocalCXXGlobalInits.push_back(I->second);
445
Benjamin Kramerc7b5f382013-04-26 21:32:52 +0000446 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, LocalCXXGlobalInits);
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +0000447 AddGlobalCtor(Fn, Priority);
448 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800449 PrioritizedCXXGlobalInits.clear();
Fariborz Jahanian9f967c52010-06-21 18:45:05 +0000450 }
Stephen Hines176edba2014-12-01 14:53:08 -0800451
452 SmallString<128> FileName;
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700453 SourceManager &SM = Context.getSourceManager();
Stephen Hines176edba2014-12-01 14:53:08 -0800454 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
455 // Include the filename in the symbol name. Including "sub_" matches gcc and
456 // makes sure these symbols appear lexicographically behind the symbols with
457 // priority emitted above.
458 FileName = llvm::sys::path::filename(MainFile->getName());
459 } else {
Pirama Arumuga Nainarb6d69932015-07-01 12:25:36 -0700460 FileName = "<null>";
Stephen Hines176edba2014-12-01 14:53:08 -0800461 }
462
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700463 for (size_t i = 0; i < FileName.size(); ++i) {
464 // Replace everything that's not [a-zA-Z0-9._] with a _. This set happens
465 // to be the set of C preprocessing numbers.
466 if (!isPreprocessingNumberBody(FileName[i]))
467 FileName[i] = '_';
468 }
Stephen Hines176edba2014-12-01 14:53:08 -0800469
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700470 llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800471 FTy, llvm::Twine("_GLOBAL__sub_I_", FileName), FI);
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +0000472
Benjamin Kramerc7b5f382013-04-26 21:32:52 +0000473 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, CXXGlobalInits);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000474 AddGlobalCtor(Fn);
Anton Korobeynikov4179ddd2012-11-06 22:44:45 +0000475
Axel Naumann54ec6c52011-05-06 15:24:04 +0000476 CXXGlobalInits.clear();
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000477}
478
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000479void CodeGenModule::EmitCXXGlobalDtorFunc() {
480 if (CXXGlobalDtors.empty())
481 return;
482
Chris Lattner8b418682012-02-07 00:39:47 +0000483 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000484
485 // Create our global destructor function.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800486 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
487 llvm::Function *Fn =
488 CreateGlobalInitOrDestructFunction(FTy, "_GLOBAL__D_a", FI);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000489
John McCall3f88f682012-04-06 18:21:03 +0000490 CodeGenFunction(*this).GenerateCXXGlobalDtorsFunc(Fn, CXXGlobalDtors);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000491 AddGlobalDtor(Fn);
492}
493
John McCall3030eb82010-11-06 09:44:32 +0000494/// Emit the code necessary to initialize the given global variable.
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000495void CodeGenFunction::GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
John McCall3030eb82010-11-06 09:44:32 +0000496 const VarDecl *D,
Richard Smith7ca48502012-02-13 22:16:19 +0000497 llvm::GlobalVariable *Addr,
498 bool PerformInit) {
Alexey Samsonova240df22012-10-16 07:22:28 +0000499 // Check if we need to emit debug info for variable initializer.
David Blaikiec3030bc2013-08-26 20:33:21 +0000500 if (D->hasAttr<NoDebugAttr>())
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700501 DebugInfo = nullptr; // disable debug info indefinitely for this function
Nick Lewycky78d1a102012-07-24 01:40:49 +0000502
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700503 CurEHLocation = D->getLocStart();
504
Nick Lewycky78d1a102012-07-24 01:40:49 +0000505 StartFunction(GlobalDecl(D), getContext().VoidTy, Fn,
John McCallde5d3c72012-02-17 03:33:10 +0000506 getTypes().arrangeNullaryFunction(),
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700507 FunctionArgList(), D->getLocation(),
508 D->getInit()->getExprLoc());
Daniel Dunbar5c6846e2010-03-20 04:15:29 +0000509
Douglas Gregore67d1512011-07-01 21:54:36 +0000510 // Use guarded initialization if the global variable is weak. This
511 // occurs for, e.g., instantiated static data members and
512 // definitions explicitly marked weak.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700513 if (Addr->hasWeakLinkage() || Addr->hasLinkOnceLinkage()) {
Richard Smith7ca48502012-02-13 22:16:19 +0000514 EmitCXXGuardedInit(*D, Addr, PerformInit);
John McCall3030eb82010-11-06 09:44:32 +0000515 } else {
Richard Smith7ca48502012-02-13 22:16:19 +0000516 EmitCXXGlobalVarDeclInit(*D, Addr, PerformInit);
Fariborz Jahanian92d835a2010-10-26 22:47:47 +0000517 }
Daniel Dunbar5c6846e2010-03-20 04:15:29 +0000518
519 FinishFunction();
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000520}
Daniel Dunbar5c6846e2010-03-20 04:15:29 +0000521
Benjamin Kramerc7b5f382013-04-26 21:32:52 +0000522void
523CodeGenFunction::GenerateCXXGlobalInitFunc(llvm::Function *Fn,
Stephen Hines176edba2014-12-01 14:53:08 -0800524 ArrayRef<llvm::Function *> Decls,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800525 Address Guard) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700526 {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700527 auto NL = ApplyDebugLocation::CreateEmpty(*this);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700528 StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
529 getTypes().arrangeNullaryFunction(), FunctionArgList());
530 // Emit an artificial location for this function.
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700531 auto AL = ApplyDebugLocation::CreateArtificial(*this);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000532
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700533 llvm::BasicBlock *ExitBlock = nullptr;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800534 if (Guard.isValid()) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700535 // If we have a guard variable, check whether we've already performed
536 // these initializations. This happens for TLS initialization functions.
537 llvm::Value *GuardVal = Builder.CreateLoad(Guard);
538 llvm::Value *Uninit = Builder.CreateIsNull(GuardVal,
539 "guard.uninitialized");
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700540 llvm::BasicBlock *InitBlock = createBasicBlock("init");
541 ExitBlock = createBasicBlock("exit");
542 Builder.CreateCondBr(Uninit, InitBlock, ExitBlock);
543 EmitBlock(InitBlock);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800544 // Mark as initialized before initializing anything else. If the
545 // initializers use previously-initialized thread_local vars, that's
546 // probably supposed to be OK, but the standard doesn't say.
547 Builder.CreateStore(llvm::ConstantInt::get(GuardVal->getType(),1), Guard);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700548 }
Richard Smithb80a16e2013-04-19 16:42:07 +0000549
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700550 RunCleanupsScope Scope(*this);
John McCallf85e1932011-06-15 23:02:42 +0000551
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700552 // When building in Objective-C++ ARC mode, create an autorelease pool
553 // around the global initializers.
554 if (getLangOpts().ObjCAutoRefCount && getLangOpts().CPlusPlus) {
555 llvm::Value *token = EmitObjCAutoreleasePoolPush();
556 EmitObjCAutoreleasePoolCleanup(token);
557 }
Benjamin Kramerc7b5f382013-04-26 21:32:52 +0000558
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700559 for (unsigned i = 0, e = Decls.size(); i != e; ++i)
560 if (Decls[i])
561 EmitRuntimeCall(Decls[i]);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000562
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700563 Scope.ForceCleanup();
Richard Smithb80a16e2013-04-19 16:42:07 +0000564
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700565 if (ExitBlock) {
566 Builder.CreateBr(ExitBlock);
567 EmitBlock(ExitBlock);
568 }
Richard Smithb80a16e2013-04-19 16:42:07 +0000569 }
570
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000571 FinishFunction();
572}
573
John McCall3f88f682012-04-06 18:21:03 +0000574void CodeGenFunction::GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
Chris Lattner810112e2010-06-19 05:52:45 +0000575 const std::vector<std::pair<llvm::WeakVH, llvm::Constant*> >
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000576 &DtorsAndObjects) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700577 {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700578 auto NL = ApplyDebugLocation::CreateEmpty(*this);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700579 StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
580 getTypes().arrangeNullaryFunction(), FunctionArgList());
581 // Emit an artificial location for this function.
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700582 auto AL = ApplyDebugLocation::CreateArtificial(*this);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000583
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700584 // Emit the dtors, in reverse order from construction.
585 for (unsigned i = 0, e = DtorsAndObjects.size(); i != e; ++i) {
586 llvm::Value *Callee = DtorsAndObjects[e - i - 1].first;
587 llvm::CallInst *CI = Builder.CreateCall(Callee,
588 DtorsAndObjects[e - i - 1].second);
589 // Make sure the call and the callee agree on calling convention.
590 if (llvm::Function *F = dyn_cast<llvm::Function>(Callee))
591 CI->setCallingConv(F->getCallingConv());
592 }
Chris Lattnerc9a85f92010-04-26 20:35:54 +0000593 }
Daniel Dunbarefb0fa92010-03-20 04:15:41 +0000594
595 FinishFunction();
Anders Carlssoneb4072e2009-12-10 00:30:05 +0000596}
597
John McCalla91f6662011-07-13 03:01:35 +0000598/// generateDestroyHelper - Generates a helper function which, when
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800599/// invoked, destroys the given object. The address of the object
600/// should be in global memory.
David Blaikiec7971a92013-08-27 23:57:18 +0000601llvm::Function *CodeGenFunction::generateDestroyHelper(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800602 Address addr, QualType type, Destroyer *destroyer,
David Blaikiec7971a92013-08-27 23:57:18 +0000603 bool useEHCleanupForArray, const VarDecl *VD) {
John McCalld26bc762011-03-09 04:27:21 +0000604 FunctionArgList args;
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700605 ImplicitParamDecl dst(getContext(), nullptr, SourceLocation(), nullptr,
606 getContext().VoidPtrTy);
John McCalld26bc762011-03-09 04:27:21 +0000607 args.push_back(&dst);
Stephen Hines651f13c2014-04-23 16:59:28 -0700608
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700609 const CGFunctionInfo &FI =
610 CGM.getTypes().arrangeBuiltinFunctionDeclaration(getContext().VoidTy, args);
John McCallde5d3c72012-02-17 03:33:10 +0000611 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
Stephen Hines176edba2014-12-01 14:53:08 -0800612 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800613 FTy, "__cxx_global_array_dtor", FI, VD->getLocation());
Anders Carlsson77291362010-06-08 22:17:27 +0000614
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700615 CurEHLocation = VD->getLocStart();
616
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700617 StartFunction(VD, getContext().VoidTy, fn, FI, args);
Anders Carlsson77291362010-06-08 22:17:27 +0000618
John McCalla91f6662011-07-13 03:01:35 +0000619 emitDestroy(addr, type, destroyer, useEHCleanupForArray);
Anders Carlsson77291362010-06-08 22:17:27 +0000620
621 FinishFunction();
622
John McCalla91f6662011-07-13 03:01:35 +0000623 return fn;
Anders Carlsson77291362010-06-08 22:17:27 +0000624}