blob: 98d904b15687a4f19507e6151639111d5edeb13d [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"
Chandler Carruth85098242010-06-15 23:19:56 +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
89 // Special-case non-array C++ destructors, where there's a function
90 // with the right signature that we can just call.
Craig Topper8a13c412014-05-21 05:09:00 +000091 const CXXRecordDecl *record = nullptr;
John McCall98de3d72011-07-13 03:01:35 +000092 if (dtorKind == QualType::DK_cxx_destructor &&
93 (record = type->getAsCXXRecordDecl())) {
94 assert(!record->hasTrivialDestructor());
95 CXXDestructorDecl *dtor = record->getDestructor();
96
Rafael Espindola1ac0ec82014-09-11 15:42:06 +000097 function = CGM.getAddrOfCXXStructor(dtor, StructorType::Complete);
Timur Iskhodzhanov40c585a2013-10-02 16:03:16 +000098 argument = llvm::ConstantExpr::getBitCast(
John McCall7f416cc2015-09-08 08:05:57 +000099 addr.getPointer(), CGF.getTypes().ConvertType(type)->getPointerTo());
John McCall98de3d72011-07-13 03:01:35 +0000100
101 // Otherwise, the standard logic requires a helper function.
102 } else {
David Blaikieebe87e12013-08-27 23:57:18 +0000103 function = CodeGenFunction(CGM)
104 .generateDestroyHelper(addr, type, CGF.getDestroyer(dtorKind),
105 CGF.needsEHCleanup(dtorKind), &D);
John McCall98de3d72011-07-13 03:01:35 +0000106 argument = llvm::Constant::getNullValue(CGF.Int8PtrTy);
107 }
108
Richard Smithdbf74ba2013-04-14 23:01:42 +0000109 CGM.getCXXABI().registerGlobalDtor(CGF, D, function, argument);
Douglas Gregor370eadf2010-05-05 15:38:32 +0000110}
111
Richard Smith08a51442012-02-17 07:31:37 +0000112/// Emit code to cause the variable at the given address to be considered as
113/// constant from this point onwards.
Nick Lewycky45062042012-02-21 00:26:58 +0000114static void EmitDeclInvariant(CodeGenFunction &CGF, const VarDecl &D,
115 llvm::Constant *Addr) {
Richard Smith132bea92012-02-17 20:12:52 +0000116 // Don't emit the intrinsic if we're not optimizing.
117 if (!CGF.CGM.getCodeGenOpts().OptimizationLevel)
118 return;
119
Richard Smith08a51442012-02-17 07:31:37 +0000120 // Grab the llvm.invariant.start intrinsic.
121 llvm::Intrinsic::ID InvStartID = llvm::Intrinsic::invariant_start;
122 llvm::Constant *InvariantStart = CGF.CGM.getIntrinsic(InvStartID);
123
Nick Lewycky45062042012-02-21 00:26:58 +0000124 // Emit a call with the size in bytes of the object.
125 CharUnits WidthChars = CGF.getContext().getTypeSizeInChars(D.getType());
126 uint64_t Width = WidthChars.getQuantity();
127 llvm::Value *Args[2] = { llvm::ConstantInt::getSigned(CGF.Int64Ty, Width),
Richard Smith08a51442012-02-17 07:31:37 +0000128 llvm::ConstantExpr::getBitCast(Addr, CGF.Int8PtrTy)};
129 CGF.Builder.CreateCall(InvariantStart, Args);
130}
131
Anders Carlsson364051c2009-12-10 00:57:45 +0000132void CodeGenFunction::EmitCXXGlobalVarDeclInit(const VarDecl &D,
Richard Smith6331c402012-02-13 22:16:19 +0000133 llvm::Constant *DeclPtr,
134 bool PerformInit) {
Anders Carlsson364051c2009-12-10 00:57:45 +0000135
136 const Expr *Init = D.getInit();
137 QualType T = D.getType();
138
Jingyue Wu4f7b9eb2015-03-25 20:06:28 +0000139 // The address space of a static local variable (DeclPtr) may be different
140 // from the address space of the "this" argument of the constructor. In that
141 // case, we need an addrspacecast before calling the constructor.
142 //
143 // struct StructWithCtor {
144 // __device__ StructWithCtor() {...}
145 // };
146 // __device__ void foo() {
147 // __shared__ StructWithCtor s;
148 // ...
149 // }
150 //
151 // For example, in the above CUDA code, the static local variable s has a
152 // "shared" address space qualifier, but the constructor of StructWithCtor
153 // expects "this" in the "generic" address space.
154 unsigned ExpectedAddrSpace = getContext().getTargetAddressSpace(T);
155 unsigned ActualAddrSpace = DeclPtr->getType()->getPointerAddressSpace();
156 if (ActualAddrSpace != ExpectedAddrSpace) {
157 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(T);
158 llvm::PointerType *PTy = llvm::PointerType::get(LTy, ExpectedAddrSpace);
159 DeclPtr = llvm::ConstantExpr::getAddrSpaceCast(DeclPtr, PTy);
160 }
161
John McCall7f416cc2015-09-08 08:05:57 +0000162 ConstantAddress DeclAddr(DeclPtr, getContext().getDeclAlign(&D));
163
Anders Carlsson364051c2009-12-10 00:57:45 +0000164 if (!T->isReferenceType()) {
Alexey Bataev97720002014-11-11 04:05:39 +0000165 if (getLangOpts().OpenMP && D.hasAttr<OMPThreadPrivateDeclAttr>())
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000166 (void)CGM.getOpenMPRuntime().emitThreadPrivateVarDefinition(
John McCall7f416cc2015-09-08 08:05:57 +0000167 &D, DeclAddr, D.getAttr<OMPThreadPrivateDeclAttr>()->getLocation(),
Alexey Bataev97720002014-11-11 04:05:39 +0000168 PerformInit, this);
Richard Smith6331c402012-02-13 22:16:19 +0000169 if (PerformInit)
John McCall7f416cc2015-09-08 08:05:57 +0000170 EmitDeclInit(*this, D, DeclAddr);
Richard Smith08a51442012-02-17 07:31:37 +0000171 if (CGM.isTypeConstant(D.getType(), true))
Nick Lewycky45062042012-02-21 00:26:58 +0000172 EmitDeclInvariant(*this, D, DeclPtr);
Richard Smith08a51442012-02-17 07:31:37 +0000173 else
John McCall7f416cc2015-09-08 08:05:57 +0000174 EmitDeclDestroy(*this, D, DeclAddr);
Anders Carlsson364051c2009-12-10 00:57:45 +0000175 return;
176 }
Anders Carlsson3f48c602010-06-27 17:52:15 +0000177
Richard Smith6331c402012-02-13 22:16:19 +0000178 assert(PerformInit && "cannot have constant initializer which needs "
179 "destruction for reference");
Richard Smitha1c9d4d2013-06-12 23:38:09 +0000180 RValue RV = EmitReferenceBindingToExpr(Init);
John McCall7f416cc2015-09-08 08:05:57 +0000181 EmitStoreOfScalar(RV.getScalarVal(), DeclAddr, false, T);
Anders Carlsson364051c2009-12-10 00:57:45 +0000182}
Anders Carlsson633c6f62009-12-10 00:30:05 +0000183
John McCall76cc43a2012-04-06 18:21:06 +0000184/// Create a stub function, suitable for being passed to atexit,
185/// which passes the given address to the given destructor function.
David Majnemerb3341ea2014-10-05 05:05:40 +0000186llvm::Constant *CodeGenFunction::createAtExitStub(const VarDecl &VD,
187 llvm::Constant *dtor,
188 llvm::Constant *addr) {
John McCall76cc43a2012-04-06 18:21:06 +0000189 // Get the destructor function type, void(*)(void).
190 llvm::FunctionType *ty = llvm::FunctionType::get(CGM.VoidTy, false);
Reid Klecknerd8110b62013-09-10 20:14:30 +0000191 SmallString<256> FnName;
192 {
193 llvm::raw_svector_ostream Out(FnName);
194 CGM.getCXXABI().getMangleContext().mangleDynamicAtExitDestructor(&VD, Out);
195 }
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000196
197 const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000198 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(ty, FnName.str(),
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000199 FI,
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000200 VD.getLocation());
John McCall76cc43a2012-04-06 18:21:06 +0000201
202 CodeGenFunction CGF(CGM);
203
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000204 CGF.StartFunction(&VD, CGM.getContext().VoidTy, fn, FI, FunctionArgList());
John McCall76cc43a2012-04-06 18:21:06 +0000205
206 llvm::CallInst *call = CGF.Builder.CreateCall(dtor, addr);
207
208 // Make sure the call and the callee agree on calling convention.
209 if (llvm::Function *dtorFn =
210 dyn_cast<llvm::Function>(dtor->stripPointerCasts()))
211 call->setCallingConv(dtorFn->getCallingConv());
212
213 CGF.FinishFunction();
214
215 return fn;
216}
217
John McCallc84ed6a2012-05-01 06:13:13 +0000218/// Register a global destructor using the C atexit runtime function.
David Blaikieebe87e12013-08-27 23:57:18 +0000219void CodeGenFunction::registerGlobalDtorWithAtExit(const VarDecl &VD,
220 llvm::Constant *dtor,
John McCallc84ed6a2012-05-01 06:13:13 +0000221 llvm::Constant *addr) {
John McCall76cc43a2012-04-06 18:21:06 +0000222 // Create a function which calls the destructor.
David Majnemerb3341ea2014-10-05 05:05:40 +0000223 llvm::Constant *dtorStub = createAtExitStub(VD, dtor, addr);
John McCall76cc43a2012-04-06 18:21:06 +0000224
225 // extern "C" int atexit(void (*f)(void));
226 llvm::FunctionType *atexitTy =
John McCallc84ed6a2012-05-01 06:13:13 +0000227 llvm::FunctionType::get(IntTy, dtorStub->getType(), false);
John McCall76cc43a2012-04-06 18:21:06 +0000228
229 llvm::Constant *atexit =
John McCallc84ed6a2012-05-01 06:13:13 +0000230 CGM.CreateRuntimeFunction(atexitTy, "atexit");
John McCall76cc43a2012-04-06 18:21:06 +0000231 if (llvm::Function *atexitFn = dyn_cast<llvm::Function>(atexit))
232 atexitFn->setDoesNotThrow();
233
John McCall882987f2013-02-28 19:01:20 +0000234 EmitNounwindRuntimeCall(atexit, dtorStub);
Anders Carlsson633c6f62009-12-10 00:30:05 +0000235}
236
John McCallcdf7ef52010-11-06 09:44:32 +0000237void CodeGenFunction::EmitCXXGuardedInit(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000238 llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +0000239 bool PerformInit) {
John McCall7ef5cb32011-03-18 02:56:14 +0000240 // If we've been asked to forbid guard variables, emit an error now.
241 // This diagnostic is hard-coded for Darwin's use case; we can find
242 // better phrasing if someone else needs it.
243 if (CGM.getCodeGenOpts().ForbidGuardVariables)
244 CGM.Error(D.getLocation(),
245 "this initialization requires a guard variable, which "
246 "the kernel does not support");
247
Chandler Carruth84537952012-03-30 19:44:53 +0000248 CGM.getCXXABI().EmitGuardedInit(*this, D, DeclPtr, PerformInit);
John McCall68ff0372010-09-08 01:44:27 +0000249}
250
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000251llvm::Function *CodeGenModule::CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000252 llvm::FunctionType *FTy, const Twine &Name, const CGFunctionInfo &FI,
253 SourceLocation Loc, bool TLS) {
Anders Carlssonb2839e42010-06-08 22:40:05 +0000254 llvm::Function *Fn =
255 llvm::Function::Create(FTy, llvm::GlobalValue::InternalLinkage,
David Majnemerb3341ea2014-10-05 05:05:40 +0000256 Name, &getModule());
257 if (!getLangOpts().AppleKext && !TLS) {
Fariborz Jahanian09948f12011-02-15 18:54:46 +0000258 // Set the section if needed.
David Majnemerb3341ea2014-10-05 05:05:40 +0000259 if (const char *Section = getTarget().getStaticInitSectionSpecifier())
Fariborz Jahanian09948f12011-02-15 18:54:46 +0000260 Fn->setSection(Section);
261 }
Anders Carlsson851318a2010-06-08 22:47:50 +0000262
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000263 SetInternalFunctionAttributes(nullptr, Fn, FI);
Reid Kleckner787dc432015-04-22 19:37:32 +0000264
David Majnemerb3341ea2014-10-05 05:05:40 +0000265 Fn->setCallingConv(getRuntimeCC());
John McCall882987f2013-02-28 19:01:20 +0000266
David Majnemerb3341ea2014-10-05 05:05:40 +0000267 if (!getLangOpts().Exceptions)
John McCall466e2212010-07-06 04:38:10 +0000268 Fn->setDoesNotThrow();
269
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000270 if (!isInSanitizerBlacklist(Fn, Loc)) {
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000271 if (getLangOpts().Sanitize.hasOneOf(SanitizerKind::Address |
272 SanitizerKind::KernelAddress))
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000273 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000274 if (getLangOpts().Sanitize.has(SanitizerKind::Thread))
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000275 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000276 if (getLangOpts().Sanitize.has(SanitizerKind::Memory))
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000277 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000278 if (getLangOpts().Sanitize.has(SanitizerKind::SafeStack))
279 Fn->addFnAttr(llvm::Attribute::SafeStack);
Alexey Samsonove7a8ccf2014-07-07 23:34:34 +0000280 }
Kostya Serebryanybf84b8f2012-06-26 08:56:33 +0000281
Anders Carlssonb2839e42010-06-08 22:40:05 +0000282 return Fn;
283}
284
Reid Kleckner1a711b12014-07-22 00:53:05 +0000285/// Create a global pointer to a function that will initialize a global
286/// variable. The user has requested that this pointer be emitted in a specific
287/// section.
288void CodeGenModule::EmitPointerToInitFunc(const VarDecl *D,
289 llvm::GlobalVariable *GV,
290 llvm::Function *InitFunc,
291 InitSegAttr *ISA) {
292 llvm::GlobalVariable *PtrArray = new llvm::GlobalVariable(
293 TheModule, InitFunc->getType(), /*isConstant=*/true,
294 llvm::GlobalValue::PrivateLinkage, InitFunc, "__cxx_init_fn_ptr");
295 PtrArray->setSection(ISA->getSection());
296 addUsedGlobal(PtrArray);
297
298 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000299 if (llvm::Comdat *C = GV->getComdat())
Reid Kleckner1a711b12014-07-22 00:53:05 +0000300 PtrArray->setComdat(C);
301}
302
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000303void
John McCallcdf7ef52010-11-06 09:44:32 +0000304CodeGenModule::EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +0000305 llvm::GlobalVariable *Addr,
306 bool PerformInit) {
Artem Belevich97c01c32016-02-02 22:29:48 +0000307
308 // According to E.2.3.1 in CUDA-7.5 Programming guide: __device__,
309 // __constant__ and __shared__ variables defined in namespace scope,
310 // that are of class type, cannot have a non-empty constructor. All
311 // the checks have been done in Sema by now. Whatever initializers
312 // are allowed are empty and we just need to ignore them here.
313 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
314 (D->hasAttr<CUDADeviceAttr>() || D->hasAttr<CUDAConstantAttr>() ||
315 D->hasAttr<CUDASharedAttr>()))
316 return;
317
Reid Klecknere07140e2015-04-15 01:08:06 +0000318 // Check if we've already initialized this decl.
319 auto I = DelayedCXXInitPosition.find(D);
320 if (I != DelayedCXXInitPosition.end() && I->second == ~0U)
321 return;
322
Chris Lattnerece04092012-02-07 00:39:47 +0000323 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000324 SmallString<256> FnName;
325 {
326 llvm::raw_svector_ostream Out(FnName);
327 getCXXABI().getMangleContext().mangleDynamicInitializer(D, Out);
328 }
Eli Friedman5866fe32010-01-08 00:50:11 +0000329
330 // Create a variable initialization function.
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000331 llvm::Function *Fn =
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000332 CreateGlobalInitOrDestructFunction(FTy, FnName.str(),
333 getTypes().arrangeNullaryFunction(),
334 D->getLocation());
Eli Friedman5866fe32010-01-08 00:50:11 +0000335
Reid Kleckner1a711b12014-07-22 00:53:05 +0000336 auto *ISA = D->getAttr<InitSegAttr>();
Richard Smith6331c402012-02-13 22:16:19 +0000337 CodeGenFunction(*this).GenerateCXXGlobalVarDeclInitFunc(Fn, D, Addr,
338 PerformInit);
Rafael Espindola9f834732014-09-19 01:54:22 +0000339
Reid Kleckner72d03be2014-10-15 16:38:00 +0000340 llvm::GlobalVariable *COMDATKey =
341 supportsCOMDAT() && D->isExternallyVisible() ? Addr : nullptr;
Rafael Espindola9f834732014-09-19 01:54:22 +0000342
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000343 if (D->getTLSKind()) {
344 // FIXME: Should we support init_priority for thread_local?
345 // FIXME: Ideally, initialization of instantiated thread_local static data
346 // members of class templates should not trigger initialization of other
347 // entities in the TU.
348 // FIXME: We only need to register one __cxa_thread_atexit function for the
349 // entire TU.
350 CXXThreadLocalInits.push_back(Fn);
Richard Smith5a99c492015-12-01 01:10:48 +0000351 CXXThreadLocalInitVars.push_back(D);
Reid Kleckner1a711b12014-07-22 00:53:05 +0000352 } else if (PerformInit && ISA) {
353 EmitPointerToInitFunc(D, Addr, Fn, ISA);
Reid Kleckner1a711b12014-07-22 00:53:05 +0000354 } else if (auto *IPA = D->getAttr<InitPriorityAttr>()) {
Aaron Ballmane8d9f8d2013-12-19 03:02:49 +0000355 OrderGlobalInits Key(IPA->getPriority(), PrioritizedCXXGlobalInits.size());
Fariborz Jahanian89bdd142010-06-21 21:27:42 +0000356 PrioritizedCXXGlobalInits.push_back(std::make_pair(Key, Fn));
Reid Kleckner72d03be2014-10-15 16:38:00 +0000357 } else if (isTemplateInstantiation(D->getTemplateSpecializationKind())) {
Reid Kleckner37384452013-08-22 20:07:45 +0000358 // C++ [basic.start.init]p2:
Reid Kleckner27533242013-09-04 00:54:24 +0000359 // Definitions of explicitly specialized class template static data
360 // members have ordered initialization. Other class template static data
361 // members (i.e., implicitly or explicitly instantiated specializations)
362 // have unordered initialization.
Reid Kleckner37384452013-08-22 20:07:45 +0000363 //
364 // As a consequence, we can put them into their own llvm.global_ctors entry.
Reid Kleckner563f0e82014-05-23 21:13:45 +0000365 //
Reid Kleckner72d03be2014-10-15 16:38:00 +0000366 // If the global is externally visible, put the initializer into a COMDAT
367 // group with the global being initialized. On most platforms, this is a
368 // minor startup time optimization. In the MS C++ ABI, there are no guard
369 // variables, so this COMDAT key is required for correctness.
370 AddGlobalCtor(Fn, 65535, COMDATKey);
Hans Wennborg7b556ea2014-09-10 19:28:48 +0000371 } else if (D->hasAttr<SelectAnyAttr>()) {
Nico Weber0a029922015-01-12 21:24:10 +0000372 // SelectAny globals will be comdat-folded. Put the initializer into a
373 // COMDAT group associated with the global, so the initializers get folded
374 // too.
Reid Kleckner72d03be2014-10-15 16:38:00 +0000375 AddGlobalCtor(Fn, 65535, COMDATKey);
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000376 } else {
Reid Klecknere07140e2015-04-15 01:08:06 +0000377 I = DelayedCXXInitPosition.find(D); // Re-do lookup in case of re-hash.
John McCall70013b62010-07-15 23:40:35 +0000378 if (I == DelayedCXXInitPosition.end()) {
379 CXXGlobalInits.push_back(Fn);
Reid Klecknere07140e2015-04-15 01:08:06 +0000380 } else if (I->second != ~0U) {
381 assert(I->second < CXXGlobalInits.size() &&
382 CXXGlobalInits[I->second] == nullptr);
John McCall70013b62010-07-15 23:40:35 +0000383 CXXGlobalInits[I->second] = Fn;
John McCall70013b62010-07-15 23:40:35 +0000384 }
385 }
Reid Klecknere07140e2015-04-15 01:08:06 +0000386
387 // Remember that we already emitted the initializer for this global.
388 DelayedCXXInitPosition[D] = ~0U;
Eli Friedman5866fe32010-01-08 00:50:11 +0000389}
390
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000391void CodeGenModule::EmitCXXThreadLocalInitFunc() {
David Majnemerb3341ea2014-10-05 05:05:40 +0000392 getCXXABI().EmitThreadLocalInitFuncs(
393 *this, CXXThreadLocals, CXXThreadLocalInits, CXXThreadLocalInitVars);
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000394
395 CXXThreadLocalInits.clear();
David Majnemerb3341ea2014-10-05 05:05:40 +0000396 CXXThreadLocalInitVars.clear();
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000397 CXXThreadLocals.clear();
398}
399
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000400void
401CodeGenModule::EmitCXXGlobalInitFunc() {
John McCall70013b62010-07-15 23:40:35 +0000402 while (!CXXGlobalInits.empty() && !CXXGlobalInits.back())
403 CXXGlobalInits.pop_back();
404
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000405 if (CXXGlobalInits.empty() && PrioritizedCXXGlobalInits.empty())
Anders Carlsson633c6f62009-12-10 00:30:05 +0000406 return;
407
Chris Lattnerece04092012-02-07 00:39:47 +0000408 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000409 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
Anders Carlsson633c6f62009-12-10 00:30:05 +0000410
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000411 // Create our global initialization function.
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000412 if (!PrioritizedCXXGlobalInits.empty()) {
David Majnemerb3341ea2014-10-05 05:05:40 +0000413 SmallVector<llvm::Function *, 8> LocalCXXGlobalInits;
Fariborz Jahanian090e4e52010-06-21 19:49:38 +0000414 llvm::array_pod_sort(PrioritizedCXXGlobalInits.begin(),
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000415 PrioritizedCXXGlobalInits.end());
416 // Iterate over "chunks" of ctors with same priority and emit each chunk
417 // into separate function. Note - everything is sorted first by priority,
418 // second - by lex order, so we emit ctor functions in proper order.
419 for (SmallVectorImpl<GlobalInitData >::iterator
420 I = PrioritizedCXXGlobalInits.begin(),
421 E = PrioritizedCXXGlobalInits.end(); I != E; ) {
422 SmallVectorImpl<GlobalInitData >::iterator
423 PrioE = std::upper_bound(I + 1, E, *I, GlobalInitPriorityCmp());
424
425 LocalCXXGlobalInits.clear();
426 unsigned Priority = I->first.priority;
427 // Compute the function suffix from priority. Prepend with zeroes to make
428 // sure the function names are also ordered as priorities.
429 std::string PrioritySuffix = llvm::utostr(Priority);
Nico Weberbdc96982014-05-06 20:32:45 +0000430 // Priority is always <= 65535 (enforced by sema).
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000431 PrioritySuffix = std::string(6-PrioritySuffix.size(), '0')+PrioritySuffix;
David Majnemerb3341ea2014-10-05 05:05:40 +0000432 llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000433 FTy, "_GLOBAL__I_" + PrioritySuffix, FI);
David Majnemerb3341ea2014-10-05 05:05:40 +0000434
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000435 for (; I < PrioE; ++I)
436 LocalCXXGlobalInits.push_back(I->second);
437
Benjamin Kramer139cfc22013-04-26 21:32:52 +0000438 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, LocalCXXGlobalInits);
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000439 AddGlobalCtor(Fn, Priority);
440 }
Yaron Keren35071ac2015-06-20 15:51:52 +0000441 PrioritizedCXXGlobalInits.clear();
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000442 }
Keno Fischer84778b22014-08-26 22:10:15 +0000443
444 SmallString<128> FileName;
Nico Weberbdc96982014-05-06 20:32:45 +0000445 SourceManager &SM = Context.getSourceManager();
Keno Fischer84778b22014-08-26 22:10:15 +0000446 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
447 // Include the filename in the symbol name. Including "sub_" matches gcc and
448 // makes sure these symbols appear lexicographically behind the symbols with
449 // priority emitted above.
450 FileName = llvm::sys::path::filename(MainFile->getName());
451 } else {
Yaron Kereneac8a1e2015-05-12 12:47:05 +0000452 FileName = "<null>";
Keno Fischer84778b22014-08-26 22:10:15 +0000453 }
454
Nico Weberbdc96982014-05-06 20:32:45 +0000455 for (size_t i = 0; i < FileName.size(); ++i) {
456 // Replace everything that's not [a-zA-Z0-9._] with a _. This set happens
457 // to be the set of C preprocessing numbers.
458 if (!isPreprocessingNumberBody(FileName[i]))
459 FileName[i] = '_';
460 }
Keno Fischer84778b22014-08-26 22:10:15 +0000461
Nico Weberbdc96982014-05-06 20:32:45 +0000462 llvm::Function *Fn = CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000463 FTy, llvm::Twine("_GLOBAL__sub_I_", FileName), FI);
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000464
Benjamin Kramer139cfc22013-04-26 21:32:52 +0000465 CodeGenFunction(*this).GenerateCXXGlobalInitFunc(Fn, CXXGlobalInits);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000466 AddGlobalCtor(Fn);
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000467
Axel Naumannbd26a582011-05-06 15:24:04 +0000468 CXXGlobalInits.clear();
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000469}
470
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000471void CodeGenModule::EmitCXXGlobalDtorFunc() {
472 if (CXXGlobalDtors.empty())
473 return;
474
Chris Lattnerece04092012-02-07 00:39:47 +0000475 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000476
477 // Create our global destructor function.
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000478 const CGFunctionInfo &FI = getTypes().arrangeNullaryFunction();
479 llvm::Function *Fn =
480 CreateGlobalInitOrDestructFunction(FTy, "_GLOBAL__D_a", FI);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000481
John McCallee08c532012-04-06 18:21:03 +0000482 CodeGenFunction(*this).GenerateCXXGlobalDtorsFunc(Fn, CXXGlobalDtors);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000483 AddGlobalDtor(Fn);
484}
485
John McCallcdf7ef52010-11-06 09:44:32 +0000486/// Emit the code necessary to initialize the given global variable.
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000487void CodeGenFunction::GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
John McCallcdf7ef52010-11-06 09:44:32 +0000488 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +0000489 llvm::GlobalVariable *Addr,
490 bool PerformInit) {
Alexey Samsonov38e24962012-10-16 07:22:28 +0000491 // Check if we need to emit debug info for variable initializer.
David Blaikie92848de2013-08-26 20:33:21 +0000492 if (D->hasAttr<NoDebugAttr>())
Craig Topper8a13c412014-05-21 05:09:00 +0000493 DebugInfo = nullptr; // disable debug info indefinitely for this function
Nick Lewycky08597072012-07-24 01:40:49 +0000494
David Blaikie47d28e02015-01-14 07:10:46 +0000495 CurEHLocation = D->getLocStart();
496
Nick Lewycky08597072012-07-24 01:40:49 +0000497 StartFunction(GlobalDecl(D), getContext().VoidTy, Fn,
John McCalla729c622012-02-17 03:33:10 +0000498 getTypes().arrangeNullaryFunction(),
Adrian Prantl42d71b92014-04-10 23:21:53 +0000499 FunctionArgList(), D->getLocation(),
500 D->getInit()->getExprLoc());
Daniel Dunbar75722842010-03-20 04:15:29 +0000501
Douglas Gregorfa918f62011-07-01 21:54:36 +0000502 // Use guarded initialization if the global variable is weak. This
503 // occurs for, e.g., instantiated static data members and
504 // definitions explicitly marked weak.
Reid Kleckner563f0e82014-05-23 21:13:45 +0000505 if (Addr->hasWeakLinkage() || Addr->hasLinkOnceLinkage()) {
Richard Smith6331c402012-02-13 22:16:19 +0000506 EmitCXXGuardedInit(*D, Addr, PerformInit);
John McCallcdf7ef52010-11-06 09:44:32 +0000507 } else {
Richard Smith6331c402012-02-13 22:16:19 +0000508 EmitCXXGlobalVarDeclInit(*D, Addr, PerformInit);
Fariborz Jahanian67ca8c42010-10-26 22:47:47 +0000509 }
Daniel Dunbar75722842010-03-20 04:15:29 +0000510
511 FinishFunction();
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000512}
Daniel Dunbar75722842010-03-20 04:15:29 +0000513
Benjamin Kramer139cfc22013-04-26 21:32:52 +0000514void
515CodeGenFunction::GenerateCXXGlobalInitFunc(llvm::Function *Fn,
David Majnemerb3341ea2014-10-05 05:05:40 +0000516 ArrayRef<llvm::Function *> Decls,
John McCall7f416cc2015-09-08 08:05:57 +0000517 Address Guard) {
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000518 {
Adrian Prantl95b24e92015-02-03 20:00:54 +0000519 auto NL = ApplyDebugLocation::CreateEmpty(*this);
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000520 StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
521 getTypes().arrangeNullaryFunction(), FunctionArgList());
522 // Emit an artificial location for this function.
Adrian Prantl95b24e92015-02-03 20:00:54 +0000523 auto AL = ApplyDebugLocation::CreateArtificial(*this);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000524
Craig Topper8a13c412014-05-21 05:09:00 +0000525 llvm::BasicBlock *ExitBlock = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000526 if (Guard.isValid()) {
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000527 // If we have a guard variable, check whether we've already performed
528 // these initializations. This happens for TLS initialization functions.
529 llvm::Value *GuardVal = Builder.CreateLoad(Guard);
530 llvm::Value *Uninit = Builder.CreateIsNull(GuardVal,
531 "guard.uninitialized");
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000532 llvm::BasicBlock *InitBlock = createBasicBlock("init");
533 ExitBlock = createBasicBlock("exit");
534 Builder.CreateCondBr(Uninit, InitBlock, ExitBlock);
535 EmitBlock(InitBlock);
Manman Ren14f88152015-11-11 19:19:26 +0000536 // Mark as initialized before initializing anything else. If the
537 // initializers use previously-initialized thread_local vars, that's
538 // probably supposed to be OK, but the standard doesn't say.
539 Builder.CreateStore(llvm::ConstantInt::get(GuardVal->getType(),1), Guard);
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000540 }
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000541
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000542 RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000543
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000544 // When building in Objective-C++ ARC mode, create an autorelease pool
545 // around the global initializers.
546 if (getLangOpts().ObjCAutoRefCount && getLangOpts().CPlusPlus) {
547 llvm::Value *token = EmitObjCAutoreleasePoolPush();
548 EmitObjCAutoreleasePoolCleanup(token);
549 }
Benjamin Kramer139cfc22013-04-26 21:32:52 +0000550
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000551 for (unsigned i = 0, e = Decls.size(); i != e; ++i)
552 if (Decls[i])
553 EmitRuntimeCall(Decls[i]);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000554
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000555 Scope.ForceCleanup();
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000556
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000557 if (ExitBlock) {
558 Builder.CreateBr(ExitBlock);
559 EmitBlock(ExitBlock);
560 }
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000561 }
562
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000563 FinishFunction();
564}
565
John McCallee08c532012-04-06 18:21:03 +0000566void CodeGenFunction::GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
Chris Lattner87233f72010-06-19 05:52:45 +0000567 const std::vector<std::pair<llvm::WeakVH, llvm::Constant*> >
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000568 &DtorsAndObjects) {
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000569 {
Adrian Prantl95b24e92015-02-03 20:00:54 +0000570 auto NL = ApplyDebugLocation::CreateEmpty(*this);
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000571 StartFunction(GlobalDecl(), getContext().VoidTy, Fn,
572 getTypes().arrangeNullaryFunction(), FunctionArgList());
573 // Emit an artificial location for this function.
Adrian Prantl95b24e92015-02-03 20:00:54 +0000574 auto AL = ApplyDebugLocation::CreateArtificial(*this);
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000575
Adrian Prantl0ce2b872014-04-11 23:45:01 +0000576 // Emit the dtors, in reverse order from construction.
577 for (unsigned i = 0, e = DtorsAndObjects.size(); i != e; ++i) {
578 llvm::Value *Callee = DtorsAndObjects[e - i - 1].first;
579 llvm::CallInst *CI = Builder.CreateCall(Callee,
580 DtorsAndObjects[e - i - 1].second);
581 // Make sure the call and the callee agree on calling convention.
582 if (llvm::Function *F = dyn_cast<llvm::Function>(Callee))
583 CI->setCallingConv(F->getCallingConv());
584 }
Chris Lattner5e8416a2010-04-26 20:35:54 +0000585 }
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000586
587 FinishFunction();
Anders Carlsson633c6f62009-12-10 00:30:05 +0000588}
589
John McCall98de3d72011-07-13 03:01:35 +0000590/// generateDestroyHelper - Generates a helper function which, when
John McCall7f416cc2015-09-08 08:05:57 +0000591/// invoked, destroys the given object. The address of the object
592/// should be in global memory.
David Blaikieebe87e12013-08-27 23:57:18 +0000593llvm::Function *CodeGenFunction::generateDestroyHelper(
John McCall7f416cc2015-09-08 08:05:57 +0000594 Address addr, QualType type, Destroyer *destroyer,
David Blaikieebe87e12013-08-27 23:57:18 +0000595 bool useEHCleanupForArray, const VarDecl *VD) {
John McCalla738c252011-03-09 04:27:21 +0000596 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +0000597 ImplicitParamDecl dst(getContext(), nullptr, SourceLocation(), nullptr,
Richard Smith053f6c62014-05-16 23:01:30 +0000598 getContext().VoidPtrTy);
John McCalla738c252011-03-09 04:27:21 +0000599 args.push_back(&dst);
Reid Kleckner4982b822014-01-31 22:54:50 +0000600
601 const CGFunctionInfo &FI = CGM.getTypes().arrangeFreeFunctionDeclaration(
602 getContext().VoidTy, args, FunctionType::ExtInfo(), /*variadic=*/false);
John McCalla729c622012-02-17 03:33:10 +0000603 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000604 llvm::Function *fn = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000605 FTy, "__cxx_global_array_dtor", FI, VD->getLocation());
Anders Carlsson282bc102010-06-08 22:17:27 +0000606
David Blaikie47d28e02015-01-14 07:10:46 +0000607 CurEHLocation = VD->getLocStart();
608
Adrian Prantl22e66b42014-04-11 01:13:04 +0000609 StartFunction(VD, getContext().VoidTy, fn, FI, args);
Anders Carlsson282bc102010-06-08 22:17:27 +0000610
John McCall98de3d72011-07-13 03:01:35 +0000611 emitDestroy(addr, type, destroyer, useEHCleanupForArray);
Anders Carlsson282bc102010-06-08 22:17:27 +0000612
613 FinishFunction();
614
John McCall98de3d72011-07-13 03:01:35 +0000615 return fn;
Anders Carlsson282bc102010-06-08 22:17:27 +0000616}