blob: f56e18216931172e4719ef43c36b01bb7de2e7b1 [file] [log] [blame]
Anders Carlssonbc49cfe2009-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 McCall5d865c322010-08-31 07:33:07 +000015#include "CGCXXABI.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000016#include "CGObjCRuntime.h"
Alexey Bataev97720002014-11-11 04:05:39 +000017#include "CGOpenMPRuntime.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000018#include "clang/Frontend/CodeGenOptions.h"
Anton Korobeynikovabed7492012-11-06 22:44:45 +000019#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000020#include "llvm/IR/Intrinsics.h"
Nico Weberbdc96982014-05-06 20:32:45 +000021#include "llvm/Support/Path.h"
Douglas Gregor51150ab2010-05-16 01:24:12 +000022
Anders Carlssonbc49cfe2009-12-10 00:16:00 +000023using namespace clang;
24using namespace CodeGen;
25
Anders Carlsson364051c2009-12-10 00:57:45 +000026static void EmitDeclInit(CodeGenFunction &CGF, const VarDecl &D,
John McCall7f416cc2015-09-08 08:05:57 +000027 ConstantAddress DeclPtr) {
Anders Carlsson364051c2009-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 McCall1553b192011-06-16 04:16:24 +000032 QualType type = D.getType();
John McCall7f416cc2015-09-08 08:05:57 +000033 LValue lv = CGF.MakeAddrLValue(DeclPtr, type);
John McCall1553b192011-06-16 04:16:24 +000034
35 const Expr *Init = D.getInit();
John McCall47fb9502013-03-07 21:37:08 +000036 switch (CGF.getEvaluationKind(type)) {
37 case TEK_Scalar: {
Fariborz Jahaniand1339792011-01-13 20:00:54 +000038 CodeGenModule &CGM = CGF.CGM;
John McCall1553b192011-06-16 04:16:24 +000039 if (lv.isObjCStrong())
John McCall31168b02011-06-15 23:02:42 +000040 CGM.getObjCRuntime().EmitObjCGlobalAssign(CGF, CGF.EmitScalarExpr(Init),
Richard Smithfd3834f2013-04-13 02:43:54 +000041 DeclPtr, D.getTLSKind());
John McCall1553b192011-06-16 04:16:24 +000042 else if (lv.isObjCWeak())
43 CGM.getObjCRuntime().EmitObjCWeakAssign(CGF, CGF.EmitScalarExpr(Init),
44 DeclPtr);
Fariborz Jahaniand1339792011-01-13 20:00:54 +000045 else
John McCall1553b192011-06-16 04:16:24 +000046 CGF.EmitScalarInit(Init, &D, lv, false);
John McCall47fb9502013-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 Rosier615ed1a2012-03-29 17:37:10 +000053 CGF.EmitAggExpr(Init, AggValueSlot::forLValue(lv,AggValueSlot::IsDestructed,
54 AggValueSlot::DoesNotNeedGCBarriers,
55 AggValueSlot::IsNotAliased));
John McCall47fb9502013-03-07 21:37:08 +000056 return;
Anders Carlssonbc49cfe2009-12-10 00:16:00 +000057 }
John McCall47fb9502013-03-07 21:37:08 +000058 llvm_unreachable("bad evaluation kind");
Anders Carlssonbc49cfe2009-12-10 00:16:00 +000059}
60
John McCall68ff0372010-09-08 01:44:27 +000061/// Emit code to cause the destruction of the given variable with
62/// static storage duration.
Douglas Gregor370eadf2010-05-05 15:38:32 +000063static void EmitDeclDestroy(CodeGenFunction &CGF, const VarDecl &D,
John McCall7f416cc2015-09-08 08:05:57 +000064 ConstantAddress addr) {
Douglas Gregor370eadf2010-05-05 15:38:32 +000065 CodeGenModule &CGM = CGF.CGM;
John McCall98de3d72011-07-13 03:01:35 +000066
67 // FIXME: __attribute__((cleanup)) ?
Douglas Gregor370eadf2010-05-05 15:38:32 +000068
John McCall98de3d72011-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 Gregor370eadf2010-05-05 15:38:32 +000074 return;
John McCall98de3d72011-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 Smithdbf74ba2013-04-14 23:01:42 +000082 assert(!D.getTLSKind() && "should have rejected this");
Douglas Gregor370eadf2010-05-05 15:38:32 +000083 return;
John McCall98de3d72011-07-13 03:01:35 +000084 }
85
86 llvm::Constant *function;
87 llvm::Constant *argument;
88
Derek Schuff09b24922016-05-10 17:44:52 +000089 // 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
Derek Schuff8179be42016-05-10 17:44:55 +000091 // passed directly to __cxa_atexit if the target does not allow this mismatch.
Derek Schuff060fd222016-05-10 17:44:48 +000092 const CXXRecordDecl *Record = type->getAsCXXRecordDecl();
Derek Schuff8179be42016-05-10 17:44:55 +000093 bool CanRegisterDestructor =
94 Record && (!CGM.getCXXABI().HasThisReturn(
95 GlobalDecl(Record->getDestructor(), Dtor_Complete)) ||
96 CGM.getCXXABI().canCallMismatchedFunctionType());
Derek Schuff2136eed2016-05-10 17:44:50 +000097 // 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;
Derek Schuff09b24922016-05-10 17:44:52 +0000101 if (Record && (CanRegisterDestructor || UsingExternalHelper)) {
Derek Schuff060fd222016-05-10 17:44:48 +0000102 assert(!Record->hasTrivialDestructor());
103 CXXDestructorDecl *dtor = Record->getDestructor();
John McCall98de3d72011-07-13 03:01:35 +0000104
Rafael Espindola1ac0ec82014-09-11 15:42:06 +0000105 function = CGM.getAddrOfCXXStructor(dtor, StructorType::Complete);
Timur Iskhodzhanov40c585a2013-10-02 16:03:16 +0000106 argument = llvm::ConstantExpr::getBitCast(
John McCall7f416cc2015-09-08 08:05:57 +0000107 addr.getPointer(), CGF.getTypes().ConvertType(type)->getPointerTo());
John McCall98de3d72011-07-13 03:01:35 +0000108
109 // Otherwise, the standard logic requires a helper function.
110 } else {
David Blaikieebe87e12013-08-27 23:57:18 +0000111 function = CodeGenFunction(CGM)
112 .generateDestroyHelper(addr, type, CGF.getDestroyer(dtorKind),
113 CGF.needsEHCleanup(dtorKind), &D);
John McCall98de3d72011-07-13 03:01:35 +0000114 argument = llvm::Constant::getNullValue(CGF.Int8PtrTy);
115 }
116
Richard Smithdbf74ba2013-04-14 23:01:42 +0000117 CGM.getCXXABI().registerGlobalDtor(CGF, D, function, argument);
Douglas Gregor370eadf2010-05-05 15:38:32 +0000118}
119
Richard Smith08a51442012-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 Lewycky45062042012-02-21 00:26:58 +0000122static void EmitDeclInvariant(CodeGenFunction &CGF, const VarDecl &D,
123 llvm::Constant *Addr) {
Anna Thomasb7721512016-07-22 15:37:56 +0000124 // Do not emit the intrinsic if we're not optimizing.
Richard Smith132bea92012-02-17 20:12:52 +0000125 if (!CGF.CGM.getCodeGenOpts().OptimizationLevel)
126 return;
127
Richard Smith08a51442012-02-17 07:31:37 +0000128 // Grab the llvm.invariant.start intrinsic.
129 llvm::Intrinsic::ID InvStartID = llvm::Intrinsic::invariant_start;
Anna Thomas142ea992016-07-22 17:50:08 +0000130 // Overloaded address space type.
131 llvm::Type *ObjectPtr[1] = {CGF.Int8PtrTy};
132 llvm::Constant *InvariantStart = CGF.CGM.getIntrinsic(InvStartID, ObjectPtr);
Richard Smith08a51442012-02-17 07:31:37 +0000133
Nick Lewycky45062042012-02-21 00:26:58 +0000134 // Emit a call with the size in bytes of the object.
135 CharUnits WidthChars = CGF.getContext().getTypeSizeInChars(D.getType());
136 uint64_t Width = WidthChars.getQuantity();
137 llvm::Value *Args[2] = { llvm::ConstantInt::getSigned(CGF.Int64Ty, Width),
Richard Smith08a51442012-02-17 07:31:37 +0000138 llvm::ConstantExpr::getBitCast(Addr, CGF.Int8PtrTy)};
139 CGF.Builder.CreateCall(InvariantStart, Args);
140}
141
Anders Carlsson364051c2009-12-10 00:57:45 +0000142void CodeGenFunction::EmitCXXGlobalVarDeclInit(const VarDecl &D,
Richard Smith6331c402012-02-13 22:16:19 +0000143 llvm::Constant *DeclPtr,
144 bool PerformInit) {
Anders Carlsson364051c2009-12-10 00:57:45 +0000145
146 const Expr *Init = D.getInit();
147 QualType T = D.getType();
148
Jingyue Wu4f7b9eb2015-03-25 20:06:28 +0000149 // The address space of a static local variable (DeclPtr) may be different
150 // from the address space of the "this" argument of the constructor. In that
151 // case, we need an addrspacecast before calling the constructor.
152 //
153 // struct StructWithCtor {
154 // __device__ StructWithCtor() {...}
155 // };
156 // __device__ void foo() {
157 // __shared__ StructWithCtor s;
158 // ...
159 // }
160 //
161 // For example, in the above CUDA code, the static local variable s has a
162 // "shared" address space qualifier, but the constructor of StructWithCtor
163 // expects "this" in the "generic" address space.
164 unsigned ExpectedAddrSpace = getContext().getTargetAddressSpace(T);
165 unsigned ActualAddrSpace = DeclPtr->getType()->getPointerAddressSpace();
166 if (ActualAddrSpace != ExpectedAddrSpace) {
167 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(T);
168 llvm::PointerType *PTy = llvm::PointerType::get(LTy, ExpectedAddrSpace);
169 DeclPtr = llvm::ConstantExpr::getAddrSpaceCast(DeclPtr, PTy);
170 }
171
John McCall7f416cc2015-09-08 08:05:57 +0000172 ConstantAddress DeclAddr(DeclPtr, getContext().getDeclAlign(&D));
173
Anders Carlsson364051c2009-12-10 00:57:45 +0000174 if (!T->isReferenceType()) {
Alexey Bataev97720002014-11-11 04:05:39 +0000175 if (getLangOpts().OpenMP && D.hasAttr<OMPThreadPrivateDeclAttr>())
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000176 (void)CGM.getOpenMPRuntime().emitThreadPrivateVarDefinition(
John McCall7f416cc2015-09-08 08:05:57 +0000177 &D, DeclAddr, D.getAttr<OMPThreadPrivateDeclAttr>()->getLocation(),
Alexey Bataev97720002014-11-11 04:05:39 +0000178 PerformInit, this);
Richard Smith6331c402012-02-13 22:16:19 +0000179 if (PerformInit)
John McCall7f416cc2015-09-08 08:05:57 +0000180 EmitDeclInit(*this, D, DeclAddr);
Richard Smith08a51442012-02-17 07:31:37 +0000181 if (CGM.isTypeConstant(D.getType(), true))
Nick Lewycky45062042012-02-21 00:26:58 +0000182 EmitDeclInvariant(*this, D, DeclPtr);
Richard Smith08a51442012-02-17 07:31:37 +0000183 else
John McCall7f416cc2015-09-08 08:05:57 +0000184 EmitDeclDestroy(*this, D, DeclAddr);
Anders Carlsson364051c2009-12-10 00:57:45 +0000185 return;
186 }
Anders Carlsson3f48c602010-06-27 17:52:15 +0000187
Richard Smith6331c402012-02-13 22:16:19 +0000188 assert(PerformInit && "cannot have constant initializer which needs "
189 "destruction for reference");
Richard Smitha1c9d4d2013-06-12 23:38:09 +0000190 RValue RV = EmitReferenceBindingToExpr(Init);
John McCall7f416cc2015-09-08 08:05:57 +0000191 EmitStoreOfScalar(RV.getScalarVal(), DeclAddr, false, T);
Anders Carlsson364051c2009-12-10 00:57:45 +0000192}
Anders Carlsson633c6f62009-12-10 00:30:05 +0000193
John McCall76cc43a2012-04-06 18:21:06 +0000194/// Create a stub function, suitable for being passed to atexit,
195/// which passes the given address to the given destructor function.
David Majnemerb3341ea2014-10-05 05:05:40 +0000196llvm::Constant *CodeGenFunction::createAtExitStub(const VarDecl &VD,
197 llvm::Constant *dtor,
198 llvm::Constant *addr) {
John McCall76cc43a2012-04-06 18:21:06 +0000199 // Get the destructor function type, void(*)(void).
200 llvm::FunctionType *ty = llvm::FunctionType::get(CGM.VoidTy, false);
Reid Klecknerd8110b62013-09-10 20:14:30 +0000201 SmallString<256> FnName;
202 {
203 llvm::raw_svector_ostream Out(FnName);
204 CGM.getCXXABI().getMangleContext().mangleDynamicAtExitDestructor(&VD, Out);
205 }
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000206
207 const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000208 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(ty, FnName.str(),
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000209 FI,
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000210 VD.getLocation());
John McCall76cc43a2012-04-06 18:21:06 +0000211
212 CodeGenFunction CGF(CGM);
213
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000214 CGF.StartFunction(&VD, CGM.getContext().VoidTy, fn, FI, FunctionArgList());
John McCall76cc43a2012-04-06 18:21:06 +0000215
216 llvm::CallInst *call = CGF.Builder.CreateCall(dtor, addr);
217
218 // Make sure the call and the callee agree on calling convention.
219 if (llvm::Function *dtorFn =
220 dyn_cast<llvm::Function>(dtor->stripPointerCasts()))
221 call->setCallingConv(dtorFn->getCallingConv());
222
223 CGF.FinishFunction();
224
225 return fn;
226}
227
John McCallc84ed6a2012-05-01 06:13:13 +0000228/// Register a global destructor using the C atexit runtime function.
David Blaikieebe87e12013-08-27 23:57:18 +0000229void CodeGenFunction::registerGlobalDtorWithAtExit(const VarDecl &VD,
230 llvm::Constant *dtor,
John McCallc84ed6a2012-05-01 06:13:13 +0000231 llvm::Constant *addr) {
John McCall76cc43a2012-04-06 18:21:06 +0000232 // Create a function which calls the destructor.
David Majnemerb3341ea2014-10-05 05:05:40 +0000233 llvm::Constant *dtorStub = createAtExitStub(VD, dtor, addr);
John McCall76cc43a2012-04-06 18:21:06 +0000234
235 // extern "C" int atexit(void (*f)(void));
236 llvm::FunctionType *atexitTy =
John McCallc84ed6a2012-05-01 06:13:13 +0000237 llvm::FunctionType::get(IntTy, dtorStub->getType(), false);
John McCall76cc43a2012-04-06 18:21:06 +0000238
239 llvm::Constant *atexit =
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +0000240 CGM.CreateRuntimeFunction(atexitTy, "atexit", llvm::AttributeSet(),
241 /*Local=*/true);
John McCall76cc43a2012-04-06 18:21:06 +0000242 if (llvm::Function *atexitFn = dyn_cast<llvm::Function>(atexit))
243 atexitFn->setDoesNotThrow();
244
John McCall882987f2013-02-28 19:01:20 +0000245 EmitNounwindRuntimeCall(atexit, dtorStub);
Anders Carlsson633c6f62009-12-10 00:30:05 +0000246}
247
John McCallcdf7ef52010-11-06 09:44:32 +0000248void CodeGenFunction::EmitCXXGuardedInit(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000249 llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +0000250 bool PerformInit) {
John McCall7ef5cb32011-03-18 02:56:14 +0000251 // If we've been asked to forbid guard variables, emit an error now.
252 // This diagnostic is hard-coded for Darwin's use case; we can find
253 // better phrasing if someone else needs it.
254 if (CGM.getCodeGenOpts().ForbidGuardVariables)
255 CGM.Error(D.getLocation(),
256 "this initialization requires a guard variable, which "
257 "the kernel does not support");
258
Chandler Carruth84537952012-03-30 19:44:53 +0000259 CGM.getCXXABI().EmitGuardedInit(*this, D, DeclPtr, PerformInit);
John McCall68ff0372010-09-08 01:44:27 +0000260}
261
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000262llvm::Function *CodeGenModule::CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000263 llvm::FunctionType *FTy, const Twine &Name, const CGFunctionInfo &FI,
264 SourceLocation Loc, bool TLS) {
Anders Carlssonb2839e42010-06-08 22:40:05 +0000265 llvm::Function *Fn =
266 llvm::Function::Create(FTy, llvm::GlobalValue::InternalLinkage,
David Majnemerb3341ea2014-10-05 05:05:40 +0000267 Name, &getModule());
268 if (!getLangOpts().AppleKext && !TLS) {
Fariborz Jahanian09948f12011-02-15 18:54:46 +0000269 // Set the section if needed.
David Majnemerb3341ea2014-10-05 05:05:40 +0000270 if (const char *Section = getTarget().getStaticInitSectionSpecifier())
Fariborz Jahanian09948f12011-02-15 18:54:46 +0000271 Fn->setSection(Section);
272 }
Anders Carlsson851318a2010-06-08 22:47:50 +0000273
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000274 SetInternalFunctionAttributes(nullptr, Fn, FI);
Reid Kleckner787dc432015-04-22 19:37:32 +0000275
David Majnemerb3341ea2014-10-05 05:05:40 +0000276 Fn->setCallingConv(getRuntimeCC());
John McCall882987f2013-02-28 19:01:20 +0000277
David Majnemerb3341ea2014-10-05 05:05:40 +0000278 if (!getLangOpts().Exceptions)
John McCall466e2212010-07-06 04:38:10 +0000279 Fn->setDoesNotThrow();
280
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000281 if (!isInSanitizerBlacklist(Fn, Loc)) {
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000282 if (getLangOpts().Sanitize.hasOneOf(SanitizerKind::Address |
283 SanitizerKind::KernelAddress))
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000284 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000285 if (getLangOpts().Sanitize.has(SanitizerKind::Thread))
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000286 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000287 if (getLangOpts().Sanitize.has(SanitizerKind::Memory))
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000288 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000289 if (getLangOpts().Sanitize.has(SanitizerKind::SafeStack))
290 Fn->addFnAttr(llvm::Attribute::SafeStack);
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000291 }
Kostya Serebryanybf84b8f2012-06-26 08:56:33 +0000292
Anders Carlssonb2839e42010-06-08 22:40:05 +0000293 return Fn;
294}
295
Reid Kleckner1a711b12014-07-22 00:53:05 +0000296/// Create a global pointer to a function that will initialize a global
297/// variable. The user has requested that this pointer be emitted in a specific
298/// section.
299void CodeGenModule::EmitPointerToInitFunc(const VarDecl *D,
300 llvm::GlobalVariable *GV,
301 llvm::Function *InitFunc,
302 InitSegAttr *ISA) {
303 llvm::GlobalVariable *PtrArray = new llvm::GlobalVariable(
304 TheModule, InitFunc->getType(), /*isConstant=*/true,
305 llvm::GlobalValue::PrivateLinkage, InitFunc, "__cxx_init_fn_ptr");
306 PtrArray->setSection(ISA->getSection());
307 addUsedGlobal(PtrArray);
308
309 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000310 if (llvm::Comdat *C = GV->getComdat())
Reid Kleckner1a711b12014-07-22 00:53:05 +0000311 PtrArray->setComdat(C);
312}
313
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000314void
John McCallcdf7ef52010-11-06 09:44:32 +0000315CodeGenModule::EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +0000316 llvm::GlobalVariable *Addr,
317 bool PerformInit) {
Artem Belevich97c01c32016-02-02 22:29:48 +0000318
319 // According to E.2.3.1 in CUDA-7.5 Programming guide: __device__,
320 // __constant__ and __shared__ variables defined in namespace scope,
321 // that are of class type, cannot have a non-empty constructor. All
322 // the checks have been done in Sema by now. Whatever initializers
323 // are allowed are empty and we just need to ignore them here.
324 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
325 (D->hasAttr<CUDADeviceAttr>() || D->hasAttr<CUDAConstantAttr>() ||
326 D->hasAttr<CUDASharedAttr>()))
327 return;
328
Reid Klecknere07140e2015-04-15 01:08:06 +0000329 // Check if we've already initialized this decl.
330 auto I = DelayedCXXInitPosition.find(D);
331 if (I != DelayedCXXInitPosition.end() && I->second == ~0U)
332 return;
333
Chris Lattnerece04092012-02-07 00:39:47 +0000334 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000335 SmallString<256> FnName;
336 {
337 llvm::raw_svector_ostream Out(FnName);
338 getCXXABI().getMangleContext().mangleDynamicInitializer(D, Out);
339 }
Eli Friedman5866fe32010-01-08 00:50:11 +0000340
341 // Create a variable initialization function.
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000342 llvm::Function *Fn =
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000343 CreateGlobalInitOrDestructFunction(FTy, FnName.str(),
344 getTypes().arrangeNullaryFunction(),
345 D->getLocation());
Eli Friedman5866fe32010-01-08 00:50:11 +0000346
Reid Kleckner1a711b12014-07-22 00:53:05 +0000347 auto *ISA = D->getAttr<InitSegAttr>();
Richard Smith6331c402012-02-13 22:16:19 +0000348 CodeGenFunction(*this).GenerateCXXGlobalVarDeclInitFunc(Fn, D, Addr,
349 PerformInit);
Rafael Espindola9f834732014-09-19 01:54:22 +0000350
Reid Kleckner72d03be2014-10-15 16:38:00 +0000351 llvm::GlobalVariable *COMDATKey =
352 supportsCOMDAT() && D->isExternallyVisible() ? Addr : nullptr;
Rafael Espindola9f834732014-09-19 01:54:22 +0000353
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000354 if (D->getTLSKind()) {
355 // FIXME: Should we support init_priority for thread_local?
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000356 // FIXME: We only need to register one __cxa_thread_atexit function for the
357 // entire TU.
358 CXXThreadLocalInits.push_back(Fn);
Richard Smith5a99c492015-12-01 01:10:48 +0000359 CXXThreadLocalInitVars.push_back(D);
Reid Kleckner1a711b12014-07-22 00:53:05 +0000360 } else if (PerformInit && ISA) {
361 EmitPointerToInitFunc(D, Addr, Fn, ISA);
Reid Kleckner1a711b12014-07-22 00:53:05 +0000362 } else if (auto *IPA = D->getAttr<InitPriorityAttr>()) {
Aaron Ballmane8d9f8d2013-12-19 03:02:49 +0000363 OrderGlobalInits Key(IPA->getPriority(), PrioritizedCXXGlobalInits.size());
Fariborz Jahanian89bdd142010-06-21 21:27:42 +0000364 PrioritizedCXXGlobalInits.push_back(std::make_pair(Key, Fn));
Reid Kleckner72d03be2014-10-15 16:38:00 +0000365 } else if (isTemplateInstantiation(D->getTemplateSpecializationKind())) {
Reid Kleckner37384452013-08-22 20:07:45 +0000366 // C++ [basic.start.init]p2:
Reid Kleckner27533242013-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 Kleckner37384452013-08-22 20:07:45 +0000371 //
372 // As a consequence, we can put them into their own llvm.global_ctors entry.
Reid Kleckner563f0e82014-05-23 21:13:45 +0000373 //
Reid Kleckner72d03be2014-10-15 16:38:00 +0000374 // 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);
Hans Wennborg7b556ea2014-09-10 19:28:48 +0000379 } else if (D->hasAttr<SelectAnyAttr>()) {
Nico Weber0a029922015-01-12 21:24:10 +0000380 // 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.
Reid Kleckner72d03be2014-10-15 16:38:00 +0000383 AddGlobalCtor(Fn, 65535, COMDATKey);
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000384 } else {
Reid Klecknere07140e2015-04-15 01:08:06 +0000385 I = DelayedCXXInitPosition.find(D); // Re-do lookup in case of re-hash.
John McCall70013b62010-07-15 23:40:35 +0000386 if (I == DelayedCXXInitPosition.end()) {
387 CXXGlobalInits.push_back(Fn);
Reid Klecknere07140e2015-04-15 01:08:06 +0000388 } else if (I->second != ~0U) {
389 assert(I->second < CXXGlobalInits.size() &&
390 CXXGlobalInits[I->second] == nullptr);
John McCall70013b62010-07-15 23:40:35 +0000391 CXXGlobalInits[I->second] = Fn;
John McCall70013b62010-07-15 23:40:35 +0000392 }
393 }
Reid Klecknere07140e2015-04-15 01:08:06 +0000394
395 // Remember that we already emitted the initializer for this global.
396 DelayedCXXInitPosition[D] = ~0U;
Eli Friedman5866fe32010-01-08 00:50:11 +0000397}
398
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000399void CodeGenModule::EmitCXXThreadLocalInitFunc() {
David Majnemerb3341ea2014-10-05 05:05:40 +0000400 getCXXABI().EmitThreadLocalInitFuncs(
401 *this, CXXThreadLocals, CXXThreadLocalInits, CXXThreadLocalInitVars);
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000402
403 CXXThreadLocalInits.clear();
David Majnemerb3341ea2014-10-05 05:05:40 +0000404 CXXThreadLocalInitVars.clear();
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000405 CXXThreadLocals.clear();
406}
407
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000408void
409CodeGenModule::EmitCXXGlobalInitFunc() {
John McCall70013b62010-07-15 23:40:35 +0000410 while (!CXXGlobalInits.empty() && !CXXGlobalInits.back())
411 CXXGlobalInits.pop_back();
412
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000413 if (CXXGlobalInits.empty() && PrioritizedCXXGlobalInits.empty())
Anders Carlsson633c6f62009-12-10 00:30:05 +0000414 return;
415
Chris Lattnerece04092012-02-07 00:39:47 +0000416 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000417 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
Anders Carlsson633c6f62009-12-10 00:30:05 +0000418
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000419 // Create our global initialization function.
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000420 if (!PrioritizedCXXGlobalInits.empty()) {
David Majnemerb3341ea2014-10-05 05:05:40 +0000421 SmallVector<llvm::Function *, 8> LocalCXXGlobalInits;
Fariborz Jahanian090e4e52010-06-21 19:49:38 +0000422 llvm::array_pod_sort(PrioritizedCXXGlobalInits.begin(),
Anton Korobeynikovabed7492012-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);
Nico Weberbdc96982014-05-06 20:32:45 +0000438 // Priority is always <= 65535 (enforced by sema).
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000439 PrioritySuffix = std::string(6-PrioritySuffix.size(), '0')+PrioritySuffix;
David Majnemerb3341ea2014-10-05 05:05:40 +0000440 llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000441 FTy, "_GLOBAL__I_" + PrioritySuffix, FI);
David Majnemerb3341ea2014-10-05 05:05:40 +0000442
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000443 for (; I < PrioE; ++I)
444 LocalCXXGlobalInits.push_back(I->second);
445
Benjamin Kramer139cfc22013-04-26 21:32:52 +0000446 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, LocalCXXGlobalInits);
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000447 AddGlobalCtor(Fn, Priority);
448 }
Yaron Keren35071ac2015-06-20 15:51:52 +0000449 PrioritizedCXXGlobalInits.clear();
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000450 }
Keno Fischer84778b22014-08-26 22:10:15 +0000451
452 SmallString<128> FileName;
Nico Weberbdc96982014-05-06 20:32:45 +0000453 SourceManager &SM = Context.getSourceManager();
Keno Fischer84778b22014-08-26 22:10:15 +0000454 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 {
Yaron Kereneac8a1e2015-05-12 12:47:05 +0000460 FileName = "<null>";
Keno Fischer84778b22014-08-26 22:10:15 +0000461 }
462
Nico Weberbdc96982014-05-06 20:32:45 +0000463 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 }
Keno Fischer84778b22014-08-26 22:10:15 +0000469
Nico Weberbdc96982014-05-06 20:32:45 +0000470 llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000471 FTy, llvm::Twine("_GLOBAL__sub_I_", FileName), FI);
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000472
Benjamin Kramer139cfc22013-04-26 21:32:52 +0000473 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, CXXGlobalInits);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000474 AddGlobalCtor(Fn);
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000475
Axel Naumannbd26a582011-05-06 15:24:04 +0000476 CXXGlobalInits.clear();
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000477}
478
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000479void CodeGenModule::EmitCXXGlobalDtorFunc() {
480 if (CXXGlobalDtors.empty())
481 return;
482
Chris Lattnerece04092012-02-07 00:39:47 +0000483 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000484
485 // Create our global destructor function.
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000486 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
487 llvm::Function *Fn =
488 CreateGlobalInitOrDestructFunction(FTy, "_GLOBAL__D_a", FI);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000489
John McCallee08c532012-04-06 18:21:03 +0000490 CodeGenFunction(*this).GenerateCXXGlobalDtorsFunc(Fn, CXXGlobalDtors);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000491 AddGlobalDtor(Fn);
492}
493
John McCallcdf7ef52010-11-06 09:44:32 +0000494/// Emit the code necessary to initialize the given global variable.
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000495void CodeGenFunction::GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
John McCallcdf7ef52010-11-06 09:44:32 +0000496 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +0000497 llvm::GlobalVariable *Addr,
498 bool PerformInit) {
Alexey Samsonov38e24962012-10-16 07:22:28 +0000499 // Check if we need to emit debug info for variable initializer.
David Blaikie92848de2013-08-26 20:33:21 +0000500 if (D->hasAttr<NoDebugAttr>())
Craig Topper8a13c412014-05-21 05:09:00 +0000501 DebugInfo = nullptr; // disable debug info indefinitely for this function
Nick Lewycky08597072012-07-24 01:40:49 +0000502
David Blaikie47d28e02015-01-14 07:10:46 +0000503 CurEHLocation = D->getLocStart();
504
Nick Lewycky08597072012-07-24 01:40:49 +0000505 StartFunction(GlobalDecl(D), getContext().VoidTy, Fn,
John McCalla729c622012-02-17 03:33:10 +0000506 getTypes().arrangeNullaryFunction(),
Adrian Prantl42d71b92014-04-10 23:21:53 +0000507 FunctionArgList(), D->getLocation(),
508 D->getInit()->getExprLoc());
Daniel Dunbar75722842010-03-20 04:15:29 +0000509
Douglas Gregorfa918f62011-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.
Reid Kleckner563f0e82014-05-23 21:13:45 +0000513 if (Addr->hasWeakLinkage() || Addr->hasLinkOnceLinkage()) {
Richard Smith6331c402012-02-13 22:16:19 +0000514 EmitCXXGuardedInit(*D, Addr, PerformInit);
John McCallcdf7ef52010-11-06 09:44:32 +0000515 } else {
Richard Smith6331c402012-02-13 22:16:19 +0000516 EmitCXXGlobalVarDeclInit(*D, Addr, PerformInit);
Fariborz Jahanian67ca8c42010-10-26 22:47:47 +0000517 }
Daniel Dunbar75722842010-03-20 04:15:29 +0000518
519 FinishFunction();
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000520}
Daniel Dunbar75722842010-03-20 04:15:29 +0000521
Benjamin Kramer139cfc22013-04-26 21:32:52 +0000522void
523CodeGenFunction::GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +0000524 ArrayRef<llvm::Function *> Decls,
John McCall7f416cc2015-09-08 08:05:57 +0000525 Address Guard) {
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000526 {
Adrian Prantl95b24e92015-02-03 20:00:54 +0000527 auto NL = ApplyDebugLocation::CreateEmpty(*this);
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000528 StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
529 getTypes().arrangeNullaryFunction(), FunctionArgList());
530 // Emit an artificial location for this function.
Adrian Prantl95b24e92015-02-03 20:00:54 +0000531 auto AL = ApplyDebugLocation::CreateArtificial(*this);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000532
Craig Topper8a13c412014-05-21 05:09:00 +0000533 llvm::BasicBlock *ExitBlock = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000534 if (Guard.isValid()) {
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000535 // 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");
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000540 llvm::BasicBlock *InitBlock = createBasicBlock("init");
541 ExitBlock = createBasicBlock("exit");
542 Builder.CreateCondBr(Uninit, InitBlock, ExitBlock);
543 EmitBlock(InitBlock);
Manman Ren14f88152015-11-11 19:19:26 +0000544 // 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);
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000548 }
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000549
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000550 RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000551
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000552 // 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 Kramer139cfc22013-04-26 21:32:52 +0000558
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000559 for (unsigned i = 0, e = Decls.size(); i != e; ++i)
560 if (Decls[i])
561 EmitRuntimeCall(Decls[i]);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000562
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000563 Scope.ForceCleanup();
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000564
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000565 if (ExitBlock) {
566 Builder.CreateBr(ExitBlock);
567 EmitBlock(ExitBlock);
568 }
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000569 }
570
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000571 FinishFunction();
572}
573
John McCallee08c532012-04-06 18:21:03 +0000574void CodeGenFunction::GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
Chris Lattner87233f72010-06-19 05:52:45 +0000575 const std::vector<std::pair<llvm::WeakVH, llvm::Constant*> >
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000576 &DtorsAndObjects) {
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000577 {
Adrian Prantl95b24e92015-02-03 20:00:54 +0000578 auto NL = ApplyDebugLocation::CreateEmpty(*this);
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000579 StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
580 getTypes().arrangeNullaryFunction(), FunctionArgList());
581 // Emit an artificial location for this function.
Adrian Prantl95b24e92015-02-03 20:00:54 +0000582 auto AL = ApplyDebugLocation::CreateArtificial(*this);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000583
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000584 // 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 Lattner5e8416a2010-04-26 20:35:54 +0000593 }
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000594
595 FinishFunction();
Anders Carlsson633c6f62009-12-10 00:30:05 +0000596}
597
John McCall98de3d72011-07-13 03:01:35 +0000598/// generateDestroyHelper - Generates a helper function which, when
John McCall7f416cc2015-09-08 08:05:57 +0000599/// invoked, destroys the given object. The address of the object
600/// should be in global memory.
David Blaikieebe87e12013-08-27 23:57:18 +0000601llvm::Function *CodeGenFunction::generateDestroyHelper(
John McCall7f416cc2015-09-08 08:05:57 +0000602 Address addr, QualType type, Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +0000603 bool useEHCleanupForArray, const VarDecl *VD) {
John McCalla738c252011-03-09 04:27:21 +0000604 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +0000605 ImplicitParamDecl dst(getContext(), nullptr, SourceLocation(), nullptr,
Richard Smith053f6c62014-05-16 23:01:30 +0000606 getContext().VoidPtrTy);
John McCalla738c252011-03-09 04:27:21 +0000607 args.push_back(&dst);
Reid Kleckner4982b822014-01-31 22:54:50 +0000608
John McCallc56a8b32016-03-11 04:30:31 +0000609 const CGFunctionInfo &FI =
610 CGM.getTypes().arrangeBuiltinFunctionDeclaration(getContext().VoidTy, args);
John McCalla729c622012-02-17 03:33:10 +0000611 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000612 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000613 FTy, "__cxx_global_array_dtor", FI, VD->getLocation());
Anders Carlsson282bc102010-06-08 22:17:27 +0000614
David Blaikie47d28e02015-01-14 07:10:46 +0000615 CurEHLocation = VD->getLocStart();
616
Adrian Prantl22e66b42014-04-11 01:13:04 +0000617 StartFunction(VD, getContext().VoidTy, fn, FI, args);
Anders Carlsson282bc102010-06-08 22:17:27 +0000618
John McCall98de3d72011-07-13 03:01:35 +0000619 emitDestroy(addr, type, destroyer, useEHCleanupForArray);
Anders Carlsson282bc102010-06-08 22:17:27 +0000620
621 FinishFunction();
622
John McCall98de3d72011-07-13 03:01:35 +0000623 return fn;
Anders Carlsson282bc102010-06-08 22:17:27 +0000624}