blob: 41f84091892b10038a397f06704721201eae705a [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Decl nodes as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000015#include "CGDebugInfo.h"
Peter Collingbourne8c25fc52011-09-19 21:14:35 +000016#include "CGOpenCLRuntime.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000017#include "CodeGenModule.h"
Daniel Dunbarde7fb842008-08-11 05:00:27 +000018#include "clang/AST/ASTContext.h"
Ken Dyckbdc601b2009-12-22 14:23:30 +000019#include "clang/AST/CharUnits.h"
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000020#include "clang/AST/Decl.h"
Anders Carlsson19567ee2008-08-25 01:38:19 +000021#include "clang/AST/DeclObjC.h"
Nate Begeman8bd4afe2008-04-19 04:17:09 +000022#include "clang/Basic/SourceManager.h"
Chris Lattner2621fd12008-05-08 05:58:21 +000023#include "clang/Basic/TargetInfo.h"
Chandler Carruth06057ce2010-06-15 23:19:56 +000024#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3b844ba2013-01-02 11:45:17 +000025#include "llvm/IR/DataLayout.h"
26#include "llvm/IR/GlobalVariable.h"
27#include "llvm/IR/Intrinsics.h"
28#include "llvm/IR/Type.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000029using namespace clang;
30using namespace CodeGen;
31
32
33void CodeGenFunction::EmitDecl(const Decl &D) {
Reid Spencer5f016e22007-07-11 17:01:13 +000034 switch (D.getKind()) {
Douglas Gregor08688ac2010-04-23 02:02:43 +000035 case Decl::TranslationUnit:
36 case Decl::Namespace:
37 case Decl::UnresolvedUsingTypename:
38 case Decl::ClassTemplateSpecialization:
39 case Decl::ClassTemplatePartialSpecialization:
40 case Decl::TemplateTypeParm:
41 case Decl::UnresolvedUsingValue:
Sean Hunt9a555912010-05-30 07:21:58 +000042 case Decl::NonTypeTemplateParm:
Douglas Gregor08688ac2010-04-23 02:02:43 +000043 case Decl::CXXMethod:
44 case Decl::CXXConstructor:
45 case Decl::CXXDestructor:
46 case Decl::CXXConversion:
47 case Decl::Field:
John McCall76da55d2013-04-16 07:28:30 +000048 case Decl::MSProperty:
Francois Pichet41f5e662010-11-21 06:49:41 +000049 case Decl::IndirectField:
Douglas Gregor08688ac2010-04-23 02:02:43 +000050 case Decl::ObjCIvar:
Eric Christophere1f54902011-08-23 22:38:00 +000051 case Decl::ObjCAtDefsField:
Chris Lattneraa9fc462007-10-08 21:37:32 +000052 case Decl::ParmVar:
Douglas Gregor08688ac2010-04-23 02:02:43 +000053 case Decl::ImplicitParam:
54 case Decl::ClassTemplate:
55 case Decl::FunctionTemplate:
Richard Smith3e4c6c42011-05-05 21:57:07 +000056 case Decl::TypeAliasTemplate:
Douglas Gregor08688ac2010-04-23 02:02:43 +000057 case Decl::TemplateTemplateParm:
58 case Decl::ObjCMethod:
59 case Decl::ObjCCategory:
60 case Decl::ObjCProtocol:
61 case Decl::ObjCInterface:
62 case Decl::ObjCCategoryImpl:
63 case Decl::ObjCImplementation:
64 case Decl::ObjCProperty:
65 case Decl::ObjCCompatibleAlias:
Abramo Bagnara6206d532010-06-05 05:09:32 +000066 case Decl::AccessSpec:
Douglas Gregor08688ac2010-04-23 02:02:43 +000067 case Decl::LinkageSpec:
68 case Decl::ObjCPropertyImpl:
Douglas Gregor08688ac2010-04-23 02:02:43 +000069 case Decl::FileScopeAsm:
70 case Decl::Friend:
71 case Decl::FriendTemplate:
72 case Decl::Block:
Tareq A. Siraj6afcf882013-04-16 19:37:38 +000073 case Decl::Captured:
Francois Pichetaf0f4d02011-08-14 03:52:19 +000074 case Decl::ClassScopeFunctionSpecialization:
David Blaikie3923d6a2013-05-08 06:01:46 +000075 case Decl::UsingShadow:
David Blaikieb219cfc2011-09-23 05:06:16 +000076 llvm_unreachable("Declaration should not be in declstmts!");
Reid Spencer5f016e22007-07-11 17:01:13 +000077 case Decl::Function: // void X();
Argyrios Kyrtzidis35bc0822008-10-15 00:42:39 +000078 case Decl::Record: // struct/union/class X;
Reid Spencer5f016e22007-07-11 17:01:13 +000079 case Decl::Enum: // enum X;
Mike Stump1eb44332009-09-09 15:08:12 +000080 case Decl::EnumConstant: // enum ? { X = ? }
Argyrios Kyrtzidis35bc0822008-10-15 00:42:39 +000081 case Decl::CXXRecord: // struct/union/class X; [C++]
Douglas Gregor08688ac2010-04-23 02:02:43 +000082 case Decl::NamespaceAlias:
Anders Carlsson7b0ca3f2009-12-03 17:26:31 +000083 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner4ae493c2011-02-18 02:08:43 +000084 case Decl::Label: // __label__ x;
Douglas Gregor15de72c2011-12-02 23:23:56 +000085 case Decl::Import:
Alexey Bataevc6400582013-03-22 06:34:35 +000086 case Decl::OMPThreadPrivate:
Michael Han684aa732013-02-22 17:15:32 +000087 case Decl::Empty:
Reid Spencer5f016e22007-07-11 17:01:13 +000088 // None of these decls require codegen support.
89 return;
David Blaikiec8c24272013-02-02 00:39:32 +000090
David Blaikie3923d6a2013-05-08 06:01:46 +000091 case Decl::Using: // using X; [C++]
92 if (CGDebugInfo *DI = getDebugInfo())
93 DI->EmitUsingDecl(cast<UsingDecl>(D));
94 return;
David Blaikie957dac52013-04-22 06:13:21 +000095 case Decl::UsingDirective: // using namespace X; [C++]
96 if (CGDebugInfo *DI = getDebugInfo())
97 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
98 return;
Daniel Dunbar662174c82008-08-29 17:28:43 +000099 case Decl::Var: {
100 const VarDecl &VD = cast<VarDecl>(D);
John McCallb6bbcc92010-10-15 04:57:14 +0000101 assert(VD.isLocalVarDecl() &&
Daniel Dunbar662174c82008-08-29 17:28:43 +0000102 "Should not see file-scope variables inside a function!");
John McCallb6bbcc92010-10-15 04:57:14 +0000103 return EmitVarDecl(VD);
Reid Spencer5f016e22007-07-11 17:01:13 +0000104 }
Mike Stump1eb44332009-09-09 15:08:12 +0000105
Richard Smith162e1c12011-04-15 14:24:37 +0000106 case Decl::Typedef: // typedef int X;
107 case Decl::TypeAlias: { // using X = int; [C++0x]
108 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000109 QualType Ty = TD.getUnderlyingType();
Mike Stump1eb44332009-09-09 15:08:12 +0000110
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000111 if (Ty->isVariablyModifiedType())
John McCallbc8d40d2011-06-24 21:55:10 +0000112 EmitVariablyModifiedType(Ty);
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000113 }
Daniel Dunbar662174c82008-08-29 17:28:43 +0000114 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000115}
116
John McCallb6bbcc92010-10-15 04:57:14 +0000117/// EmitVarDecl - This method handles emission of any variable declaration
Reid Spencer5f016e22007-07-11 17:01:13 +0000118/// inside a function, including static vars etc.
John McCallb6bbcc92010-10-15 04:57:14 +0000119void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Rafael Espindolad2615cc2013-04-03 19:27:57 +0000120 switch (D.getStorageClass()) {
John McCalld931b082010-08-26 03:08:43 +0000121 case SC_None:
122 case SC_Auto:
123 case SC_Register:
John McCallb6bbcc92010-10-15 04:57:14 +0000124 return EmitAutoVarDecl(D);
John McCalld931b082010-08-26 03:08:43 +0000125 case SC_Static: {
Eric Christophere1f54902011-08-23 22:38:00 +0000126 llvm::GlobalValue::LinkageTypes Linkage =
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000127 llvm::GlobalValue::InternalLinkage;
128
John McCall8b242332010-05-25 04:30:21 +0000129 // If the function definition has some sort of weak linkage, its
130 // static variables should also be weak so that they get properly
131 // uniqued. We can't do this in C, though, because there's no
132 // standard way to agree on which variables are the same (i.e.
133 // there's no mangling).
Richard Smith7edf9e32012-11-01 22:30:59 +0000134 if (getLangOpts().CPlusPlus)
John McCall8b242332010-05-25 04:30:21 +0000135 if (llvm::GlobalValue::isWeakForLinker(CurFn->getLinkage()))
136 Linkage = CurFn->getLinkage();
Eric Christophere1f54902011-08-23 22:38:00 +0000137
John McCallb6bbcc92010-10-15 04:57:14 +0000138 return EmitStaticVarDecl(D, Linkage);
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000139 }
John McCalld931b082010-08-26 03:08:43 +0000140 case SC_Extern:
141 case SC_PrivateExtern:
Lauro Ramos Venanciofea90b82008-02-16 22:30:38 +0000142 // Don't emit it now, allow it to be emitted lazily on its first use.
143 return;
Peter Collingbourne8c25fc52011-09-19 21:14:35 +0000144 case SC_OpenCLWorkGroupLocal:
145 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
Reid Spencer5f016e22007-07-11 17:01:13 +0000146 }
Daniel Dunbar5466c7b2009-04-14 02:25:56 +0000147
David Blaikieb219cfc2011-09-23 05:06:16 +0000148 llvm_unreachable("Unknown storage class");
Reid Spencer5f016e22007-07-11 17:01:13 +0000149}
150
Chris Lattner761acc12009-12-05 08:22:11 +0000151static std::string GetStaticDeclName(CodeGenFunction &CGF, const VarDecl &D,
152 const char *Separator) {
153 CodeGenModule &CGM = CGF.CGM;
Richard Smith7edf9e32012-11-01 22:30:59 +0000154 if (CGF.getLangOpts().CPlusPlus) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000155 StringRef Name = CGM.getMangledName(&D);
Anders Carlsson9a20d552010-06-22 16:16:50 +0000156 return Name.str();
John McCallf746aa62010-03-19 23:29:14 +0000157 }
Eric Christophere1f54902011-08-23 22:38:00 +0000158
Chris Lattner761acc12009-12-05 08:22:11 +0000159 std::string ContextName;
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000160 if (!CGF.CurFuncDecl) {
161 // Better be in a block declared in global scope.
162 const NamedDecl *ND = cast<NamedDecl>(&D);
163 const DeclContext *DC = ND->getDeclContext();
164 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
165 MangleBuffer Name;
Peter Collingbourne14110472011-01-13 18:57:25 +0000166 CGM.getBlockMangledName(GlobalDecl(), Name, BD);
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000167 ContextName = Name.getString();
168 }
169 else
David Blaikieb219cfc2011-09-23 05:06:16 +0000170 llvm_unreachable("Unknown context for block static var decl");
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000171 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CGF.CurFuncDecl)) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000172 StringRef Name = CGM.getMangledName(FD);
Anders Carlsson9a20d552010-06-22 16:16:50 +0000173 ContextName = Name.str();
John McCallf746aa62010-03-19 23:29:14 +0000174 } else if (isa<ObjCMethodDecl>(CGF.CurFuncDecl))
Chris Lattner761acc12009-12-05 08:22:11 +0000175 ContextName = CGF.CurFn->getName();
176 else
David Blaikieb219cfc2011-09-23 05:06:16 +0000177 llvm_unreachable("Unknown context for static var decl");
Eric Christophere1f54902011-08-23 22:38:00 +0000178
Chris Lattner761acc12009-12-05 08:22:11 +0000179 return ContextName + Separator + D.getNameAsString();
180}
181
Chandler Carruth0f30a122012-03-30 19:44:53 +0000182llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +0000183CodeGenFunction::CreateStaticVarDecl(const VarDecl &D,
184 const char *Separator,
185 llvm::GlobalValue::LinkageTypes Linkage) {
Chris Lattner8bcfc5b2008-04-06 23:10:54 +0000186 QualType Ty = D.getType();
Eli Friedman3c2b3172008-02-15 12:20:59 +0000187 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000188
Benjamin Kramer5c247db2011-11-20 21:05:04 +0000189 // Use the label if the variable is renamed with the asm-label extension.
190 std::string Name;
Benjamin Kramerc3c8f222011-11-21 15:47:23 +0000191 if (D.hasAttr<AsmLabelAttr>())
192 Name = CGM.getMangledName(&D);
193 else
Benjamin Kramer5c247db2011-11-20 21:05:04 +0000194 Name = GetStaticDeclName(*this, D, Separator);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000195
Chris Lattner2acc6e32011-07-18 04:24:23 +0000196 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(Ty);
Peter Collingbourne1aba7782012-08-28 20:37:10 +0000197 unsigned AddrSpace =
198 CGM.GetGlobalVarAddressSpace(&D, CGM.getContext().getTargetAddressSpace(Ty));
Anders Carlsson41f8a132009-09-26 18:16:06 +0000199 llvm::GlobalVariable *GV =
200 new llvm::GlobalVariable(CGM.getModule(), LTy,
201 Ty.isConstant(getContext()), Linkage,
Hans Wennborgde981f32012-06-28 08:01:44 +0000202 CGM.EmitNullConstant(D.getType()), Name, 0,
203 llvm::GlobalVariable::NotThreadLocal,
Peter Collingbourne1aba7782012-08-28 20:37:10 +0000204 AddrSpace);
Ken Dyck8b752f12010-01-27 17:10:57 +0000205 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
John McCall112c9672010-11-02 21:04:24 +0000206 if (Linkage != llvm::GlobalValue::InternalLinkage)
207 GV->setVisibility(CurFn->getVisibility());
Hans Wennborgde981f32012-06-28 08:01:44 +0000208
Richard Smith38afbc72013-04-13 02:43:54 +0000209 if (D.getTLSKind())
Hans Wennborgde981f32012-06-28 08:01:44 +0000210 CGM.setTLSMode(GV, D);
211
Anders Carlsson41f8a132009-09-26 18:16:06 +0000212 return GV;
Daniel Dunbar0096acf2009-02-25 19:24:29 +0000213}
214
Richard Smith7ca48502012-02-13 22:16:19 +0000215/// hasNontrivialDestruction - Determine whether a type's destruction is
216/// non-trivial. If so, and the variable uses static initialization, we must
217/// register its destructor to run on exit.
218static bool hasNontrivialDestruction(QualType T) {
219 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
220 return RD && !RD->hasTrivialDestructor();
221}
222
Chandler Carruth0f30a122012-03-30 19:44:53 +0000223/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
224/// global variable that has already been created for it. If the initializer
225/// has a different type than GV does, this may free GV and return a different
226/// one. Otherwise it just returns GV.
227llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +0000228CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth0f30a122012-03-30 19:44:53 +0000229 llvm::GlobalVariable *GV) {
230 llvm::Constant *Init = CGM.EmitConstantInit(D, this);
John McCallbf40cb52010-07-15 23:40:35 +0000231
Chris Lattner761acc12009-12-05 08:22:11 +0000232 // If constant emission failed, then this should be a C++ static
233 // initializer.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000234 if (!Init) {
Richard Smith7edf9e32012-11-01 22:30:59 +0000235 if (!getLangOpts().CPlusPlus)
Chris Lattner761acc12009-12-05 08:22:11 +0000236 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
John McCall5cd91b52010-09-08 01:44:27 +0000237 else if (Builder.GetInsertBlock()) {
Eric Christophere1f54902011-08-23 22:38:00 +0000238 // Since we have a static initializer, this global variable can't
Anders Carlsson071c8102010-01-26 04:02:23 +0000239 // be constant.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000240 GV->setConstant(false);
John McCall5cd91b52010-09-08 01:44:27 +0000241
Chandler Carruth0f30a122012-03-30 19:44:53 +0000242 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson071c8102010-01-26 04:02:23 +0000243 }
Chandler Carruth0f30a122012-03-30 19:44:53 +0000244 return GV;
Chris Lattner761acc12009-12-05 08:22:11 +0000245 }
John McCallbf40cb52010-07-15 23:40:35 +0000246
Chris Lattner761acc12009-12-05 08:22:11 +0000247 // The initializer may differ in type from the global. Rewrite
248 // the global to match the initializer. (We have to do this
249 // because some types, like unions, can't be completely represented
250 // in the LLVM type system.)
Chandler Carruth0f30a122012-03-30 19:44:53 +0000251 if (GV->getType()->getElementType() != Init->getType()) {
252 llvm::GlobalVariable *OldGV = GV;
253
254 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
255 OldGV->isConstant(),
256 OldGV->getLinkage(), Init, "",
257 /*InsertBefore*/ OldGV,
Hans Wennborg5e2d5de2012-06-23 11:51:46 +0000258 OldGV->getThreadLocalMode(),
Chandler Carruth0f30a122012-03-30 19:44:53 +0000259 CGM.getContext().getTargetAddressSpace(D.getType()));
260 GV->setVisibility(OldGV->getVisibility());
Eric Christophere1f54902011-08-23 22:38:00 +0000261
Chris Lattner761acc12009-12-05 08:22:11 +0000262 // Steal the name of the old global
Chandler Carruth0f30a122012-03-30 19:44:53 +0000263 GV->takeName(OldGV);
Eric Christophere1f54902011-08-23 22:38:00 +0000264
Chris Lattner761acc12009-12-05 08:22:11 +0000265 // Replace all uses of the old global with the new global
Chandler Carruth0f30a122012-03-30 19:44:53 +0000266 llvm::Constant *NewPtrForOldDecl =
267 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
268 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christophere1f54902011-08-23 22:38:00 +0000269
Chris Lattner761acc12009-12-05 08:22:11 +0000270 // Erase the old global, since it is no longer used.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000271 OldGV->eraseFromParent();
Chris Lattner761acc12009-12-05 08:22:11 +0000272 }
Eric Christophere1f54902011-08-23 22:38:00 +0000273
Chandler Carruth0f30a122012-03-30 19:44:53 +0000274 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
275 GV->setInitializer(Init);
Richard Smith7ca48502012-02-13 22:16:19 +0000276
277 if (hasNontrivialDestruction(D.getType())) {
278 // We have a constant initializer, but a nontrivial destructor. We still
279 // need to perform a guarded "initialization" in order to register the
Richard Smitha9b21d22012-02-17 06:48:11 +0000280 // destructor.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000281 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith7ca48502012-02-13 22:16:19 +0000282 }
283
Chandler Carruth0f30a122012-03-30 19:44:53 +0000284 return GV;
Chris Lattner761acc12009-12-05 08:22:11 +0000285}
286
John McCallb6bbcc92010-10-15 04:57:14 +0000287void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000288 llvm::GlobalValue::LinkageTypes Linkage) {
Chandler Carruth0f30a122012-03-30 19:44:53 +0000289 llvm::Value *&DMEntry = LocalDeclMap[&D];
290 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
Mike Stump1eb44332009-09-09 15:08:12 +0000291
John McCall355bba72012-03-30 21:00:39 +0000292 // Check to see if we already have a global variable for this
293 // declaration. This can happen when double-emitting function
294 // bodies, e.g. with complete and base constructors.
295 llvm::Constant *addr =
296 CGM.getStaticLocalDeclAddress(&D);
297
298 llvm::GlobalVariable *var;
299 if (addr) {
300 var = cast<llvm::GlobalVariable>(addr->stripPointerCasts());
301 } else {
302 addr = var = CreateStaticVarDecl(D, ".", Linkage);
303 }
Daniel Dunbara985b312009-02-25 19:45:19 +0000304
Daniel Dunbare5731f82009-02-25 20:08:33 +0000305 // Store into LocalDeclMap before generating initializer to handle
306 // circular references.
John McCall355bba72012-03-30 21:00:39 +0000307 DMEntry = addr;
308 CGM.setStaticLocalDeclAddress(&D, addr);
Daniel Dunbare5731f82009-02-25 20:08:33 +0000309
John McCallfe67f3b2010-05-04 20:45:42 +0000310 // We can't have a VLA here, but we can have a pointer to a VLA,
311 // even though that doesn't really make any sense.
Eli Friedmanc62aad82009-04-20 03:54:15 +0000312 // Make sure to evaluate VLA bounds now so that we have them for later.
313 if (D.getType()->isVariablyModifiedType())
John McCallbc8d40d2011-06-24 21:55:10 +0000314 EmitVariablyModifiedType(D.getType());
Eric Christophere1f54902011-08-23 22:38:00 +0000315
John McCall355bba72012-03-30 21:00:39 +0000316 // Save the type in case adding the initializer forces a type change.
317 llvm::Type *expectedType = addr->getType();
Eli Friedmanc62aad82009-04-20 03:54:15 +0000318
Chris Lattner761acc12009-12-05 08:22:11 +0000319 // If this value has an initializer, emit it.
320 if (D.getInit())
John McCall355bba72012-03-30 21:00:39 +0000321 var = AddInitializerToStaticVarDecl(D, var);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000322
John McCall355bba72012-03-30 21:00:39 +0000323 var->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Chris Lattner0af95232010-03-10 23:59:59 +0000324
Julien Lerouge77f68bb2011-09-09 22:41:49 +0000325 if (D.hasAttr<AnnotateAttr>())
John McCall355bba72012-03-30 21:00:39 +0000326 CGM.AddGlobalAnnotations(&D, var);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000327
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000328 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCall355bba72012-03-30 21:00:39 +0000329 var->setSection(SA->getName());
Mike Stump1eb44332009-09-09 15:08:12 +0000330
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000331 if (D.hasAttr<UsedAttr>())
John McCall355bba72012-03-30 21:00:39 +0000332 CGM.AddUsedGlobal(var);
Daniel Dunbar5c61d972009-02-13 22:08:43 +0000333
Chandler Carruth0f30a122012-03-30 19:44:53 +0000334 // We may have to cast the constant because of the initializer
335 // mismatch above.
336 //
337 // FIXME: It is really dangerous to store this in the map; if anyone
338 // RAUW's the GV uses of this constant will be invalid.
John McCall355bba72012-03-30 21:00:39 +0000339 llvm::Constant *castedAddr = llvm::ConstantExpr::getBitCast(var, expectedType);
340 DMEntry = castedAddr;
341 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000342
343 // Emit global variable debug descriptor for static vars.
Anders Carlssone896d982009-02-13 08:11:52 +0000344 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonovfd00eec2012-05-04 07:39:27 +0000345 if (DI &&
Douglas Gregor4cdad312012-10-23 20:05:01 +0000346 CGM.getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo) {
Daniel Dunbar66031a52008-10-17 16:15:48 +0000347 DI->setLocation(D.getLocation());
John McCall355bba72012-03-30 21:00:39 +0000348 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000349 }
Anders Carlsson1a86b332007-10-17 00:52:43 +0000350}
Mike Stump1eb44332009-09-09 15:08:12 +0000351
John McCallda65ea82010-07-13 20:32:21 +0000352namespace {
John McCallbdc4d802011-07-09 01:37:26 +0000353 struct DestroyObject : EHScopeStack::Cleanup {
354 DestroyObject(llvm::Value *addr, QualType type,
John McCall2673c682011-07-11 08:38:19 +0000355 CodeGenFunction::Destroyer *destroyer,
356 bool useEHCleanupForArray)
Peter Collingbourne516bbd42012-01-26 03:33:36 +0000357 : addr(addr), type(type), destroyer(destroyer),
John McCall2673c682011-07-11 08:38:19 +0000358 useEHCleanupForArray(useEHCleanupForArray) {}
John McCallda65ea82010-07-13 20:32:21 +0000359
John McCallbdc4d802011-07-09 01:37:26 +0000360 llvm::Value *addr;
361 QualType type;
Peter Collingbourne516bbd42012-01-26 03:33:36 +0000362 CodeGenFunction::Destroyer *destroyer;
John McCall2673c682011-07-11 08:38:19 +0000363 bool useEHCleanupForArray;
John McCallda65ea82010-07-13 20:32:21 +0000364
John McCallad346f42011-07-12 20:27:29 +0000365 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +0000366 // Don't use an EH cleanup recursively from an EH cleanup.
John McCallad346f42011-07-12 20:27:29 +0000367 bool useEHCleanupForArray =
368 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall2673c682011-07-11 08:38:19 +0000369
370 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCallda65ea82010-07-13 20:32:21 +0000371 }
372 };
373
John McCallbdc4d802011-07-09 01:37:26 +0000374 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
375 DestroyNRVOVariable(llvm::Value *addr,
376 const CXXDestructorDecl *Dtor,
377 llvm::Value *NRVOFlag)
378 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {}
John McCallda65ea82010-07-13 20:32:21 +0000379
380 const CXXDestructorDecl *Dtor;
381 llvm::Value *NRVOFlag;
382 llvm::Value *Loc;
383
John McCallad346f42011-07-12 20:27:29 +0000384 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallda65ea82010-07-13 20:32:21 +0000385 // Along the exceptions path we always execute the dtor.
John McCallad346f42011-07-12 20:27:29 +0000386 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCallda65ea82010-07-13 20:32:21 +0000387
388 llvm::BasicBlock *SkipDtorBB = 0;
389 if (NRVO) {
390 // If we exited via NRVO, we skip the destructor call.
391 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
392 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
393 llvm::Value *DidNRVO = CGF.Builder.CreateLoad(NRVOFlag, "nrvo.val");
394 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
395 CGF.EmitBlock(RunDtorBB);
396 }
Eric Christophere1f54902011-08-23 22:38:00 +0000397
John McCallda65ea82010-07-13 20:32:21 +0000398 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor378e1e72013-01-31 05:50:40 +0000399 /*ForVirtualBase=*/false,
400 /*Delegating=*/false,
401 Loc);
John McCallda65ea82010-07-13 20:32:21 +0000402
403 if (NRVO) CGF.EmitBlock(SkipDtorBB);
404 }
405 };
John McCallda65ea82010-07-13 20:32:21 +0000406
John McCall1f0fca52010-07-21 07:22:38 +0000407 struct CallStackRestore : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000408 llvm::Value *Stack;
409 CallStackRestore(llvm::Value *Stack) : Stack(Stack) {}
John McCallad346f42011-07-12 20:27:29 +0000410 void Emit(CodeGenFunction &CGF, Flags flags) {
Benjamin Kramer578faa82011-09-27 21:06:10 +0000411 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
John McCalld8715092010-07-21 06:13:08 +0000412 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
413 CGF.Builder.CreateCall(F, V);
414 }
415 };
416
John McCall0c24c802011-06-24 23:21:27 +0000417 struct ExtendGCLifetime : EHScopeStack::Cleanup {
418 const VarDecl &Var;
419 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
420
John McCallad346f42011-07-12 20:27:29 +0000421 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall0c24c802011-06-24 23:21:27 +0000422 // Compute the address of the local variable, in case it's a
423 // byref or something.
John McCallf4b88a42012-03-10 09:33:50 +0000424 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
425 Var.getType(), VK_LValue, SourceLocation());
John McCall0c24c802011-06-24 23:21:27 +0000426 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE));
427 CGF.EmitExtendGCLifetime(value);
428 }
429 };
430
John McCall1f0fca52010-07-21 07:22:38 +0000431 struct CallCleanupFunction : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000432 llvm::Constant *CleanupFn;
433 const CGFunctionInfo &FnInfo;
John McCalld8715092010-07-21 06:13:08 +0000434 const VarDecl &Var;
Eric Christophere1f54902011-08-23 22:38:00 +0000435
John McCalld8715092010-07-21 06:13:08 +0000436 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCall34695852011-02-22 06:44:22 +0000437 const VarDecl *Var)
438 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalld8715092010-07-21 06:13:08 +0000439
John McCallad346f42011-07-12 20:27:29 +0000440 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf4b88a42012-03-10 09:33:50 +0000441 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
442 Var.getType(), VK_LValue, SourceLocation());
John McCall34695852011-02-22 06:44:22 +0000443 // Compute the address of the local variable, in case it's a byref
444 // or something.
445 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getAddress();
446
John McCalld8715092010-07-21 06:13:08 +0000447 // In some cases, the type of the function argument will be different from
448 // the type of the pointer. An example of this is
449 // void f(void* arg);
450 // __attribute__((cleanup(f))) void *g;
451 //
452 // To fix this we insert a bitcast here.
453 QualType ArgTy = FnInfo.arg_begin()->type;
454 llvm::Value *Arg =
455 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
456
457 CallArgList Args;
Eli Friedman04c9a492011-05-02 17:57:46 +0000458 Args.add(RValue::get(Arg),
459 CGF.getContext().getPointerType(Var.getType()));
John McCalld8715092010-07-21 06:13:08 +0000460 CGF.EmitCall(FnInfo, CleanupFn, ReturnValueSlot(), Args);
461 }
462 };
Nadav Rotem495cfa42013-03-23 06:43:35 +0000463
464 /// A cleanup to call @llvm.lifetime.end.
465 class CallLifetimeEnd : public EHScopeStack::Cleanup {
466 llvm::Value *Addr;
467 llvm::Value *Size;
468 public:
469 CallLifetimeEnd(llvm::Value *addr, llvm::Value *size)
470 : Addr(addr), Size(size) {}
471
472 void Emit(CodeGenFunction &CGF, Flags flags) {
473 llvm::Value *castAddr = CGF.Builder.CreateBitCast(Addr, CGF.Int8PtrTy);
474 CGF.Builder.CreateCall2(CGF.CGM.getLLVMLifetimeEndFn(),
475 Size, castAddr)
476 ->setDoesNotThrow();
477 }
478 };
John McCalld8715092010-07-21 06:13:08 +0000479}
480
John McCallf85e1932011-06-15 23:02:42 +0000481/// EmitAutoVarWithLifetime - Does the setup required for an automatic
482/// variable with lifetime.
483static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
484 llvm::Value *addr,
485 Qualifiers::ObjCLifetime lifetime) {
486 switch (lifetime) {
487 case Qualifiers::OCL_None:
488 llvm_unreachable("present but none");
489
490 case Qualifiers::OCL_ExplicitNone:
491 // nothing to do
492 break;
493
494 case Qualifiers::OCL_Strong: {
Peter Collingbourne516bbd42012-01-26 03:33:36 +0000495 CodeGenFunction::Destroyer *destroyer =
John McCall9928c482011-07-12 16:41:08 +0000496 (var.hasAttr<ObjCPreciseLifetimeAttr>()
497 ? CodeGenFunction::destroyARCStrongPrecise
498 : CodeGenFunction::destroyARCStrongImprecise);
499
500 CleanupKind cleanupKind = CGF.getARCCleanupKind();
501 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
502 cleanupKind & EHCleanup);
John McCallf85e1932011-06-15 23:02:42 +0000503 break;
504 }
505 case Qualifiers::OCL_Autoreleasing:
506 // nothing to do
507 break;
Eric Christophere1f54902011-08-23 22:38:00 +0000508
John McCallf85e1932011-06-15 23:02:42 +0000509 case Qualifiers::OCL_Weak:
510 // __weak objects always get EH cleanups; otherwise, exceptions
511 // could cause really nasty crashes instead of mere leaks.
John McCall9928c482011-07-12 16:41:08 +0000512 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
513 CodeGenFunction::destroyARCWeak,
514 /*useEHCleanup*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000515 break;
516 }
517}
518
519static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
520 if (const Expr *e = dyn_cast<Expr>(s)) {
521 // Skip the most common kinds of expressions that make
522 // hierarchy-walking expensive.
523 s = e = e->IgnoreParenCasts();
524
525 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
526 return (ref->getDecl() == &var);
Fariborz Jahanianddfc8a12012-06-19 20:53:26 +0000527 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
528 const BlockDecl *block = be->getBlockDecl();
529 for (BlockDecl::capture_const_iterator i = block->capture_begin(),
530 e = block->capture_end(); i != e; ++i) {
531 if (i->getVariable() == &var)
532 return true;
533 }
534 }
John McCallf85e1932011-06-15 23:02:42 +0000535 }
536
537 for (Stmt::const_child_range children = s->children(); children; ++children)
Fariborz Jahanian8fefc8e2011-06-29 20:00:16 +0000538 // children might be null; as in missing decl or conditional of an if-stmt.
539 if ((*children) && isAccessedBy(var, *children))
John McCallf85e1932011-06-15 23:02:42 +0000540 return true;
541
542 return false;
543}
544
545static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
546 if (!decl) return false;
547 if (!isa<VarDecl>(decl)) return false;
548 const VarDecl *var = cast<VarDecl>(decl);
549 return isAccessedBy(*var, e);
550}
551
John McCalla07398e2011-06-16 04:16:24 +0000552static void drillIntoBlockVariable(CodeGenFunction &CGF,
553 LValue &lvalue,
554 const VarDecl *var) {
555 lvalue.setAddress(CGF.BuildBlockByrefAddress(lvalue.getAddress(), var));
556}
557
John McCallf85e1932011-06-15 23:02:42 +0000558void CodeGenFunction::EmitScalarInit(const Expr *init,
559 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +0000560 LValue lvalue,
561 bool capturedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000562 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCallf85e1932011-06-15 23:02:42 +0000563 if (!lifetime) {
564 llvm::Value *value = EmitScalarExpr(init);
John McCalla07398e2011-06-16 04:16:24 +0000565 if (capturedByInit)
566 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Chisnall7a7ee302012-01-16 17:27:18 +0000567 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCallf85e1932011-06-15 23:02:42 +0000568 return;
569 }
570
571 // If we're emitting a value with lifetime, we have to do the
572 // initialization *before* we leave the cleanup scopes.
John McCall1a343eb2011-11-10 08:15:53 +0000573 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init)) {
574 enterFullExpression(ewc);
John McCallf85e1932011-06-15 23:02:42 +0000575 init = ewc->getSubExpr();
John McCall1a343eb2011-11-10 08:15:53 +0000576 }
577 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCallf85e1932011-06-15 23:02:42 +0000578
579 // We have to maintain the illusion that the variable is
580 // zero-initialized. If the variable might be accessed in its
581 // initializer, zero-initialize before running the initializer, then
582 // actually perform the initialization with an assign.
583 bool accessedByInit = false;
584 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallfb720812011-07-28 07:23:35 +0000585 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCallf85e1932011-06-15 23:02:42 +0000586 if (accessedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000587 LValue tempLV = lvalue;
John McCallf85e1932011-06-15 23:02:42 +0000588 // Drill down to the __block object if necessary.
John McCallf85e1932011-06-15 23:02:42 +0000589 if (capturedByInit) {
590 // We can use a simple GEP for this because it can't have been
591 // moved yet.
John McCalla07398e2011-06-16 04:16:24 +0000592 tempLV.setAddress(Builder.CreateStructGEP(tempLV.getAddress(),
593 getByRefValueLLVMField(cast<VarDecl>(D))));
John McCallf85e1932011-06-15 23:02:42 +0000594 }
595
Chris Lattner2acc6e32011-07-18 04:24:23 +0000596 llvm::PointerType *ty
John McCalla07398e2011-06-16 04:16:24 +0000597 = cast<llvm::PointerType>(tempLV.getAddress()->getType());
John McCallf85e1932011-06-15 23:02:42 +0000598 ty = cast<llvm::PointerType>(ty->getElementType());
599
600 llvm::Value *zero = llvm::ConstantPointerNull::get(ty);
Eric Christophere1f54902011-08-23 22:38:00 +0000601
John McCallf85e1932011-06-15 23:02:42 +0000602 // If __weak, we want to use a barrier under certain conditions.
603 if (lifetime == Qualifiers::OCL_Weak)
John McCalla07398e2011-06-16 04:16:24 +0000604 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCallf85e1932011-06-15 23:02:42 +0000605
606 // Otherwise just do a simple store.
607 else
David Chisnall7a7ee302012-01-16 17:27:18 +0000608 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCallf85e1932011-06-15 23:02:42 +0000609 }
610
611 // Emit the initializer.
612 llvm::Value *value = 0;
613
614 switch (lifetime) {
615 case Qualifiers::OCL_None:
616 llvm_unreachable("present but none");
617
618 case Qualifiers::OCL_ExplicitNone:
619 // nothing to do
620 value = EmitScalarExpr(init);
621 break;
622
623 case Qualifiers::OCL_Strong: {
624 value = EmitARCRetainScalarExpr(init);
625 break;
626 }
627
628 case Qualifiers::OCL_Weak: {
629 // No way to optimize a producing initializer into this. It's not
630 // worth optimizing for, because the value will immediately
631 // disappear in the common case.
632 value = EmitScalarExpr(init);
633
John McCalla07398e2011-06-16 04:16:24 +0000634 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000635 if (accessedByInit)
John McCalla07398e2011-06-16 04:16:24 +0000636 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000637 else
John McCalla07398e2011-06-16 04:16:24 +0000638 EmitARCInitWeak(lvalue.getAddress(), value);
John McCallf85e1932011-06-15 23:02:42 +0000639 return;
640 }
641
642 case Qualifiers::OCL_Autoreleasing:
643 value = EmitARCRetainAutoreleaseScalarExpr(init);
644 break;
645 }
646
John McCalla07398e2011-06-16 04:16:24 +0000647 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000648
649 // If the variable might have been accessed by its initializer, we
650 // might have to initialize with a barrier. We have to do this for
651 // both __weak and __strong, but __weak got filtered out above.
652 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
John McCalla07398e2011-06-16 04:16:24 +0000653 llvm::Value *oldValue = EmitLoadOfScalar(lvalue);
David Chisnall7a7ee302012-01-16 17:27:18 +0000654 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall5b07e802013-03-13 03:10:54 +0000655 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCallf85e1932011-06-15 23:02:42 +0000656 return;
657 }
658
David Chisnall7a7ee302012-01-16 17:27:18 +0000659 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallf85e1932011-06-15 23:02:42 +0000660}
Chris Lattner94cd0112010-12-01 02:05:19 +0000661
John McCall7acddac2011-06-17 06:42:21 +0000662/// EmitScalarInit - Initialize the given lvalue with the given object.
663void CodeGenFunction::EmitScalarInit(llvm::Value *init, LValue lvalue) {
664 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
665 if (!lifetime)
David Chisnall7a7ee302012-01-16 17:27:18 +0000666 return EmitStoreThroughLValue(RValue::get(init), lvalue, true);
John McCall7acddac2011-06-17 06:42:21 +0000667
668 switch (lifetime) {
669 case Qualifiers::OCL_None:
670 llvm_unreachable("present but none");
671
672 case Qualifiers::OCL_ExplicitNone:
673 // nothing to do
674 break;
675
676 case Qualifiers::OCL_Strong:
677 init = EmitARCRetain(lvalue.getType(), init);
678 break;
679
680 case Qualifiers::OCL_Weak:
681 // Initialize and then skip the primitive store.
682 EmitARCInitWeak(lvalue.getAddress(), init);
683 return;
684
685 case Qualifiers::OCL_Autoreleasing:
686 init = EmitARCRetainAutorelease(lvalue.getType(), init);
687 break;
688 }
689
David Chisnall7a7ee302012-01-16 17:27:18 +0000690 EmitStoreOfScalar(init, lvalue, /* isInitialization */ true);
John McCall7acddac2011-06-17 06:42:21 +0000691}
692
Chris Lattner94cd0112010-12-01 02:05:19 +0000693/// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the
694/// non-zero parts of the specified initializer with equal or fewer than
695/// NumStores scalar stores.
696static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init,
697 unsigned &NumStores) {
Chris Lattner70b02942010-12-02 01:58:41 +0000698 // Zero and Undef never requires any extra stores.
699 if (isa<llvm::ConstantAggregateZero>(Init) ||
700 isa<llvm::ConstantPointerNull>(Init) ||
701 isa<llvm::UndefValue>(Init))
702 return true;
703 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
704 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
705 isa<llvm::ConstantExpr>(Init))
706 return Init->isNullValue() || NumStores--;
707
708 // See if we can emit each element.
709 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
710 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
711 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
712 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
713 return false;
714 }
715 return true;
716 }
Chris Lattnerf492cb12012-01-31 04:36:19 +0000717
718 if (llvm::ConstantDataSequential *CDS =
719 dyn_cast<llvm::ConstantDataSequential>(Init)) {
720 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
721 llvm::Constant *Elt = CDS->getElementAsConstant(i);
722 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
723 return false;
724 }
725 return true;
726 }
Eric Christophere1f54902011-08-23 22:38:00 +0000727
Chris Lattner94cd0112010-12-01 02:05:19 +0000728 // Anything else is hard and scary.
729 return false;
730}
731
732/// emitStoresForInitAfterMemset - For inits that
733/// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar
734/// stores that would be required.
735static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc,
John McCall34695852011-02-22 06:44:22 +0000736 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer06d43682012-08-27 22:07:02 +0000737 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
738 "called emitStoresForInitAfterMemset for zero or undef value.");
Eric Christophere1f54902011-08-23 22:38:00 +0000739
Chris Lattner70b02942010-12-02 01:58:41 +0000740 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
741 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
742 isa<llvm::ConstantExpr>(Init)) {
Chris Lattnerf492cb12012-01-31 04:36:19 +0000743 Builder.CreateStore(Init, Loc, isVolatile);
744 return;
745 }
746
747 if (llvm::ConstantDataSequential *CDS =
748 dyn_cast<llvm::ConstantDataSequential>(Init)) {
749 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
750 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramercfa07e32012-08-27 21:35:58 +0000751
752 // If necessary, get a pointer to the element and emit it.
753 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
754 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
755 isVolatile, Builder);
Chris Lattnerf492cb12012-01-31 04:36:19 +0000756 }
Chris Lattner70b02942010-12-02 01:58:41 +0000757 return;
758 }
Eric Christophere1f54902011-08-23 22:38:00 +0000759
Chris Lattner70b02942010-12-02 01:58:41 +0000760 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
761 "Unknown value type!");
Eric Christophere1f54902011-08-23 22:38:00 +0000762
Chris Lattner70b02942010-12-02 01:58:41 +0000763 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
764 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramercfa07e32012-08-27 21:35:58 +0000765
766 // If necessary, get a pointer to the element and emit it.
767 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
768 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
769 isVolatile, Builder);
Chris Lattner70b02942010-12-02 01:58:41 +0000770 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000771}
772
773
774/// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset
775/// plus some stores to initialize a local variable instead of using a memcpy
776/// from a constant global. It is beneficial to use memset if the global is all
777/// zeros, or mostly zeros and large.
778static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init,
779 uint64_t GlobalSize) {
780 // If a global is all zeros, always use a memset.
781 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
782
Chris Lattner94cd0112010-12-01 02:05:19 +0000783 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
784 // do it if it will require 6 or fewer scalar stores.
785 // TODO: Should budget depends on the size? Avoiding a large global warrants
786 // plopping in more stores.
787 unsigned StoreBudget = 6;
788 uint64_t SizeLimit = 32;
Eric Christophere1f54902011-08-23 22:38:00 +0000789
790 return GlobalSize > SizeLimit &&
Chris Lattner94cd0112010-12-01 02:05:19 +0000791 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget);
792}
793
Nadav Rotem495cfa42013-03-23 06:43:35 +0000794/// Should we use the LLVM lifetime intrinsics for the given local variable?
795static bool shouldUseLifetimeMarkers(CodeGenFunction &CGF, const VarDecl &D,
796 unsigned Size) {
Alexey Samsonov4f01ed42013-04-02 13:19:46 +0000797 // Always emit lifetime markers in -fsanitize=use-after-scope mode.
798 if (CGF.getLangOpts().Sanitize.UseAfterScope)
799 return true;
Nadav Rotem495cfa42013-03-23 06:43:35 +0000800 // For now, only in optimized builds.
801 if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0)
802 return false;
803
804 // Limit the size of marked objects to 32 bytes. We don't want to increase
805 // compile time by marking tiny objects.
806 unsigned SizeThreshold = 32;
807
808 return Size > SizeThreshold;
809}
810
Chris Lattner94cd0112010-12-01 02:05:19 +0000811
Nick Lewyckya9de3fa2010-12-30 20:21:55 +0000812/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Reid Spencer5f016e22007-07-11 17:01:13 +0000813/// variable declaration with auto, register, or no storage class specifier.
Chris Lattner2621fd12008-05-08 05:58:21 +0000814/// These turn into simple stack objects, or GlobalValues depending on target.
John McCall34695852011-02-22 06:44:22 +0000815void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
816 AutoVarEmission emission = EmitAutoVarAlloca(D);
817 EmitAutoVarInit(emission);
818 EmitAutoVarCleanups(emission);
819}
Reid Spencer5f016e22007-07-11 17:01:13 +0000820
John McCall34695852011-02-22 06:44:22 +0000821/// EmitAutoVarAlloca - Emit the alloca and debug information for a
822/// local variable. Does not emit initalization or destruction.
823CodeGenFunction::AutoVarEmission
824CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
825 QualType Ty = D.getType();
826
827 AutoVarEmission emission(D);
828
829 bool isByRef = D.hasAttr<BlocksAttr>();
830 emission.IsByRef = isByRef;
831
832 CharUnits alignment = getContext().getDeclAlign(&D);
833 emission.Alignment = alignment;
834
John McCallbc8d40d2011-06-24 21:55:10 +0000835 // If the type is variably-modified, emit all the VLA sizes for it.
836 if (Ty->isVariablyModifiedType())
837 EmitVariablyModifiedType(Ty);
838
Reid Spencer5f016e22007-07-11 17:01:13 +0000839 llvm::Value *DeclPtr;
Eli Friedman3c2b3172008-02-15 12:20:59 +0000840 if (Ty->isConstantSizeType()) {
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000841 bool NRVO = getLangOpts().ElideConstructors &&
842 D.isNRVOVariable();
John McCall34695852011-02-22 06:44:22 +0000843
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000844 // If this value is a POD array or struct with a statically
845 // determinable constant initializer, there are optimizations we can do.
846 //
847 // TODO: We should constant-evaluate the initializer of any variable,
848 // as long as it is initialized by a constant expression. Currently,
849 // isConstantInitializer produces wrong answers for structs with
850 // reference or bitfield members, and a few other cases, and checking
851 // for POD-ness protects us from some of these.
852 if (D.getInit() &&
853 (Ty->isArrayType() || Ty->isRecordType()) &&
854 (Ty.isPODType(getContext()) ||
855 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
856 D.getInit()->isConstantInitializer(getContext(), false)) {
John McCall34695852011-02-22 06:44:22 +0000857
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000858 // If the variable's a const type, and it's neither an NRVO
859 // candidate nor a __block variable and has no mutable members,
860 // emit it as a global instead.
861 if (CGM.getCodeGenOpts().MergeAllConstants && !NRVO && !isByRef &&
862 CGM.isTypeConstant(Ty, true)) {
863 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCall34695852011-02-22 06:44:22 +0000864
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000865 emission.Address = 0; // signal this condition to later callbacks
866 assert(emission.wasEmittedAsGlobal());
867 return emission;
Tanya Lattner59876c22009-11-04 01:18:09 +0000868 }
Eric Christophere1f54902011-08-23 22:38:00 +0000869
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000870 // Otherwise, tell the initialization code that we're in this case.
871 emission.IsConstantAggregate = true;
872 }
Eric Christophere1f54902011-08-23 22:38:00 +0000873
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000874 // A normal fixed sized variable becomes an alloca in the entry block,
875 // unless it's an NRVO variable.
876 llvm::Type *LTy = ConvertTypeForMem(Ty);
Eric Christophere1f54902011-08-23 22:38:00 +0000877
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000878 if (NRVO) {
879 // The named return value optimization: allocate this variable in the
880 // return slot, so that we can elide the copy when returning this
881 // variable (C++0x [class.copy]p34).
882 DeclPtr = ReturnValue;
Eric Christophere1f54902011-08-23 22:38:00 +0000883
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000884 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
885 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) {
886 // Create a flag that is used to indicate when the NRVO was applied
887 // to this variable. Set it to zero to indicate that NRVO was not
888 // applied.
889 llvm::Value *Zero = Builder.getFalse();
890 llvm::Value *NRVOFlag = CreateTempAlloca(Zero->getType(), "nrvo");
891 EnsureInsertPoint();
892 Builder.CreateStore(Zero, NRVOFlag);
Eric Christophere1f54902011-08-23 22:38:00 +0000893
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000894 // Record the NRVO flag for this variable.
895 NRVOFlags[&D] = NRVOFlag;
896 emission.NRVOFlag = NRVOFlag;
Nadav Rotem495cfa42013-03-23 06:43:35 +0000897 }
Douglas Gregord86c4772010-05-15 06:46:45 +0000898 }
Chris Lattner2621fd12008-05-08 05:58:21 +0000899 } else {
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000900 if (isByRef)
901 LTy = BuildByRefType(&D);
902
903 llvm::AllocaInst *Alloc = CreateTempAlloca(LTy);
904 Alloc->setName(D.getName());
905
906 CharUnits allocaAlignment = alignment;
907 if (isByRef)
908 allocaAlignment = std::max(allocaAlignment,
John McCall64aa4b32013-04-16 22:48:15 +0000909 getContext().toCharUnitsFromBits(getTarget().getPointerAlign(0)));
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000910 Alloc->setAlignment(allocaAlignment.getQuantity());
911 DeclPtr = Alloc;
912
913 // Emit a lifetime intrinsic if meaningful. There's no point
914 // in doing this if we don't have a valid insertion point (?).
915 uint64_t size = CGM.getDataLayout().getTypeAllocSize(LTy);
916 if (HaveInsertPoint() && shouldUseLifetimeMarkers(*this, D, size)) {
917 llvm::Value *sizeV = llvm::ConstantInt::get(Int64Ty, size);
918
919 emission.SizeForLifetimeMarkers = sizeV;
920 llvm::Value *castAddr = Builder.CreateBitCast(Alloc, Int8PtrTy);
921 Builder.CreateCall2(CGM.getLLVMLifetimeStartFn(), sizeV, castAddr)
922 ->setDoesNotThrow();
923 } else {
924 assert(!emission.useLifetimeMarkers());
925 }
Chris Lattner2621fd12008-05-08 05:58:21 +0000926 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000927 } else {
Daniel Dunbard286f052009-07-19 06:58:07 +0000928 EnsureInsertPoint();
929
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000930 if (!DidCallStackSave) {
Anders Carlsson5d463152008-12-12 07:38:43 +0000931 // Save the stack.
John McCalld16c2cf2011-02-08 08:22:06 +0000932 llvm::Value *Stack = CreateTempAlloca(Int8PtrTy, "saved_stack");
Mike Stump1eb44332009-09-09 15:08:12 +0000933
Anders Carlsson5d463152008-12-12 07:38:43 +0000934 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
935 llvm::Value *V = Builder.CreateCall(F);
Mike Stump1eb44332009-09-09 15:08:12 +0000936
Anders Carlsson5d463152008-12-12 07:38:43 +0000937 Builder.CreateStore(V, Stack);
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000938
939 DidCallStackSave = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000940
John McCalld8715092010-07-21 06:13:08 +0000941 // Push a cleanup block and restore the stack there.
John McCall3ad32c82011-01-28 08:37:24 +0000942 // FIXME: in general circumstances, this should be an EH cleanup.
John McCall1f0fca52010-07-21 07:22:38 +0000943 EHStack.pushCleanup<CallStackRestore>(NormalCleanup, Stack);
Anders Carlsson5d463152008-12-12 07:38:43 +0000944 }
Mike Stump1eb44332009-09-09 15:08:12 +0000945
John McCallbc8d40d2011-06-24 21:55:10 +0000946 llvm::Value *elementCount;
947 QualType elementType;
948 llvm::tie(elementCount, elementType) = getVLASize(Ty);
Anders Carlsson5d463152008-12-12 07:38:43 +0000949
Chris Lattner2acc6e32011-07-18 04:24:23 +0000950 llvm::Type *llvmTy = ConvertTypeForMem(elementType);
Anders Carlsson5d463152008-12-12 07:38:43 +0000951
952 // Allocate memory for the array.
John McCallbc8d40d2011-06-24 21:55:10 +0000953 llvm::AllocaInst *vla = Builder.CreateAlloca(llvmTy, elementCount, "vla");
954 vla->setAlignment(alignment.getQuantity());
Anders Carlsson41f8a132009-09-26 18:16:06 +0000955
John McCallbc8d40d2011-06-24 21:55:10 +0000956 DeclPtr = vla;
Reid Spencer5f016e22007-07-11 17:01:13 +0000957 }
Eli Friedman8f39f5e2008-12-20 23:11:59 +0000958
Reid Spencer5f016e22007-07-11 17:01:13 +0000959 llvm::Value *&DMEntry = LocalDeclMap[&D];
960 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
961 DMEntry = DeclPtr;
John McCall34695852011-02-22 06:44:22 +0000962 emission.Address = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000963
964 // Emit debug info for local var declaration.
Devang Patelc594abd2011-06-03 19:21:47 +0000965 if (HaveInsertPoint())
966 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregor4cdad312012-10-23 20:05:01 +0000967 if (CGM.getCodeGenOpts().getDebugInfo()
968 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +0000969 DI->setLocation(D.getLocation());
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000970 DI->EmitDeclareOfAutoVariable(&D, DeclPtr, Builder);
Alexey Samsonovfd00eec2012-05-04 07:39:27 +0000971 }
Devang Patelc594abd2011-06-03 19:21:47 +0000972 }
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000973
Julien Lerouge77f68bb2011-09-09 22:41:49 +0000974 if (D.hasAttr<AnnotateAttr>())
975 EmitVarAnnotations(&D, emission.Address);
976
John McCall34695852011-02-22 06:44:22 +0000977 return emission;
978}
979
980/// Determines whether the given __block variable is potentially
981/// captured by the given expression.
982static bool isCapturedBy(const VarDecl &var, const Expr *e) {
983 // Skip the most common kinds of expressions that make
984 // hierarchy-walking expensive.
985 e = e->IgnoreParenCasts();
986
987 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
988 const BlockDecl *block = be->getBlockDecl();
989 for (BlockDecl::capture_const_iterator i = block->capture_begin(),
990 e = block->capture_end(); i != e; ++i) {
991 if (i->getVariable() == &var)
992 return true;
993 }
994
995 // No need to walk into the subexpressions.
996 return false;
997 }
998
Fariborz Jahanian5033be12011-08-23 16:47:15 +0000999 if (const StmtExpr *SE = dyn_cast<StmtExpr>(e)) {
1000 const CompoundStmt *CS = SE->getSubStmt();
Eric Christopherc6fad602011-08-23 23:44:09 +00001001 for (CompoundStmt::const_body_iterator BI = CS->body_begin(),
1002 BE = CS->body_end(); BI != BE; ++BI)
Fariborz Jahanian045c8422011-08-25 00:06:26 +00001003 if (Expr *E = dyn_cast<Expr>((*BI))) {
Fariborz Jahanian5033be12011-08-23 16:47:15 +00001004 if (isCapturedBy(var, E))
1005 return true;
Fariborz Jahanian045c8422011-08-25 00:06:26 +00001006 }
1007 else if (DeclStmt *DS = dyn_cast<DeclStmt>((*BI))) {
1008 // special case declarations
1009 for (DeclStmt::decl_iterator I = DS->decl_begin(), E = DS->decl_end();
1010 I != E; ++I) {
1011 if (VarDecl *VD = dyn_cast<VarDecl>((*I))) {
1012 Expr *Init = VD->getInit();
1013 if (Init && isCapturedBy(var, Init))
1014 return true;
1015 }
1016 }
1017 }
1018 else
1019 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1020 // Later, provide code to poke into statements for capture analysis.
1021 return true;
Fariborz Jahanian5033be12011-08-23 16:47:15 +00001022 return false;
1023 }
Eric Christophere1f54902011-08-23 22:38:00 +00001024
John McCall34695852011-02-22 06:44:22 +00001025 for (Stmt::const_child_range children = e->children(); children; ++children)
1026 if (isCapturedBy(var, cast<Expr>(*children)))
1027 return true;
1028
1029 return false;
1030}
1031
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001032/// \brief Determine whether the given initializer is trivial in the sense
1033/// that it requires no code to be generated.
1034static bool isTrivialInitializer(const Expr *Init) {
1035 if (!Init)
1036 return true;
Eric Christophere1f54902011-08-23 22:38:00 +00001037
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001038 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1039 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1040 if (Constructor->isTrivial() &&
1041 Constructor->isDefaultConstructor() &&
1042 !Construct->requiresZeroInitialization())
1043 return true;
Eric Christophere1f54902011-08-23 22:38:00 +00001044
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001045 return false;
1046}
John McCall34695852011-02-22 06:44:22 +00001047void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +00001048 assert(emission.Variable && "emission was not valid!");
1049
John McCall34695852011-02-22 06:44:22 +00001050 // If this was emitted as a global constant, we're done.
1051 if (emission.wasEmittedAsGlobal()) return;
1052
John McCall57b3b6a2011-02-22 07:16:58 +00001053 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +00001054 QualType type = D.getType();
1055
Chris Lattner19785962007-07-12 00:39:48 +00001056 // If this local has an initializer, emit it now.
Daniel Dunbard286f052009-07-19 06:58:07 +00001057 const Expr *Init = D.getInit();
1058
1059 // If we are at an unreachable point, we don't need to emit the initializer
1060 // unless it contains a label.
1061 if (!HaveInsertPoint()) {
John McCall34695852011-02-22 06:44:22 +00001062 if (!Init || !ContainsLabel(Init)) return;
1063 EnsureInsertPoint();
Daniel Dunbard286f052009-07-19 06:58:07 +00001064 }
1065
John McCall5af02db2011-03-31 01:59:53 +00001066 // Initialize the structure of a __block variable.
1067 if (emission.IsByRef)
1068 emitByrefStructureInit(emission);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001069
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001070 if (isTrivialInitializer(Init))
1071 return;
Eric Christophere1f54902011-08-23 22:38:00 +00001072
John McCall5af02db2011-03-31 01:59:53 +00001073 CharUnits alignment = emission.Alignment;
1074
John McCall34695852011-02-22 06:44:22 +00001075 // Check whether this is a byref variable that's potentially
1076 // captured and moved by its own initializer. If so, we'll need to
1077 // emit the initializer first, then copy into the variable.
1078 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init);
1079
1080 llvm::Value *Loc =
1081 capturedByInit ? emission.Address : emission.getObjectAddress(*this);
1082
Richard Smith51201882011-12-30 21:15:51 +00001083 llvm::Constant *constant = 0;
1084 if (emission.IsConstantAggregate) {
1085 assert(!capturedByInit && "constant init contains a capturing block?");
Richard Smith2d6a5672012-01-14 04:30:29 +00001086 constant = CGM.EmitConstantInit(D, this);
Richard Smith51201882011-12-30 21:15:51 +00001087 }
1088
1089 if (!constant) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001090 LValue lv = MakeAddrLValue(Loc, type, alignment);
John McCalla07398e2011-06-16 04:16:24 +00001091 lv.setNonGC(true);
1092 return EmitExprAsInit(Init, &D, lv, capturedByInit);
1093 }
John McCall60d33652011-03-08 09:11:50 +00001094
John McCall34695852011-02-22 06:44:22 +00001095 // If this is a simple aggregate initialization, we can optimize it
1096 // in various ways.
John McCall60d33652011-03-08 09:11:50 +00001097 bool isVolatile = type.isVolatileQualified();
John McCall34695852011-02-22 06:44:22 +00001098
John McCall60d33652011-03-08 09:11:50 +00001099 llvm::Value *SizeVal =
Eric Christophere1f54902011-08-23 22:38:00 +00001100 llvm::ConstantInt::get(IntPtrTy,
John McCall60d33652011-03-08 09:11:50 +00001101 getContext().getTypeSizeInChars(type).getQuantity());
John McCall34695852011-02-22 06:44:22 +00001102
Chris Lattner2acc6e32011-07-18 04:24:23 +00001103 llvm::Type *BP = Int8PtrTy;
John McCall60d33652011-03-08 09:11:50 +00001104 if (Loc->getType() != BP)
Benjamin Kramer578faa82011-09-27 21:06:10 +00001105 Loc = Builder.CreateBitCast(Loc, BP);
Mon P Wang3ecd7852010-04-04 03:10:52 +00001106
John McCall60d33652011-03-08 09:11:50 +00001107 // If the initializer is all or mostly zeros, codegen with memset then do
1108 // a few stores afterward.
Eric Christophere1f54902011-08-23 22:38:00 +00001109 if (shouldUseMemSetPlusStoresToInitialize(constant,
Micah Villmow25a6a842012-10-08 16:25:52 +00001110 CGM.getDataLayout().getTypeAllocSize(constant->getType()))) {
John McCall60d33652011-03-08 09:11:50 +00001111 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1112 alignment.getQuantity(), isVolatile);
Benjamin Kramer06d43682012-08-27 22:07:02 +00001113 // Zero and undef don't require a stores.
1114 if (!constant->isNullValue() && !isa<llvm::UndefValue>(constant)) {
John McCall60d33652011-03-08 09:11:50 +00001115 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo());
1116 emitStoresForInitAfterMemset(constant, Loc, isVolatile, Builder);
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +00001117 }
John McCall60d33652011-03-08 09:11:50 +00001118 } else {
Eric Christophere1f54902011-08-23 22:38:00 +00001119 // Otherwise, create a temporary global with the initializer then
John McCall60d33652011-03-08 09:11:50 +00001120 // memcpy from the global to the alloca.
1121 std::string Name = GetStaticDeclName(*this, D, ".");
1122 llvm::GlobalVariable *GV =
1123 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true,
Eric Christopher736a9c22011-08-24 00:33:55 +00001124 llvm::GlobalValue::PrivateLinkage,
Hans Wennborg5e2d5de2012-06-23 11:51:46 +00001125 constant, Name);
John McCall60d33652011-03-08 09:11:50 +00001126 GV->setAlignment(alignment.getQuantity());
Eli Friedman460980d2011-05-27 22:32:55 +00001127 GV->setUnnamedAddr(true);
Eric Christophere1f54902011-08-23 22:38:00 +00001128
John McCall60d33652011-03-08 09:11:50 +00001129 llvm::Value *SrcPtr = GV;
1130 if (SrcPtr->getType() != BP)
Benjamin Kramer578faa82011-09-27 21:06:10 +00001131 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
John McCall60d33652011-03-08 09:11:50 +00001132
1133 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, alignment.getQuantity(),
1134 isVolatile);
1135 }
1136}
1137
1138/// Emit an expression as an initializer for a variable at the given
1139/// location. The expression is not necessarily the normal
1140/// initializer for the variable, and the address is not necessarily
1141/// its normal location.
1142///
1143/// \param init the initializing expression
1144/// \param var the variable to act as if we're initializing
1145/// \param loc the address to initialize; its type is a pointer
1146/// to the LLVM mapping of the variable's type
1147/// \param alignment the alignment of the address
1148/// \param capturedByInit true if the variable is a __block variable
1149/// whose address is potentially changed by the initializer
1150void CodeGenFunction::EmitExprAsInit(const Expr *init,
John McCallf85e1932011-06-15 23:02:42 +00001151 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001152 LValue lvalue,
John McCall60d33652011-03-08 09:11:50 +00001153 bool capturedByInit) {
John McCallf85e1932011-06-15 23:02:42 +00001154 QualType type = D->getType();
John McCall60d33652011-03-08 09:11:50 +00001155
1156 if (type->isReferenceType()) {
John McCalla07398e2011-06-16 04:16:24 +00001157 RValue rvalue = EmitReferenceBindingToExpr(init, D);
Eric Christophere1f54902011-08-23 22:38:00 +00001158 if (capturedByInit)
John McCalla07398e2011-06-16 04:16:24 +00001159 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Chisnall7a7ee302012-01-16 17:27:18 +00001160 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall9d232c82013-03-07 21:37:08 +00001161 return;
1162 }
1163 switch (getEvaluationKind(type)) {
1164 case TEK_Scalar:
John McCalla07398e2011-06-16 04:16:24 +00001165 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall9d232c82013-03-07 21:37:08 +00001166 return;
1167 case TEK_Complex: {
John McCall60d33652011-03-08 09:11:50 +00001168 ComplexPairTy complex = EmitComplexExpr(init);
John McCalla07398e2011-06-16 04:16:24 +00001169 if (capturedByInit)
1170 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall9d232c82013-03-07 21:37:08 +00001171 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
1172 return;
1173 }
1174 case TEK_Aggregate:
John McCall9eda3ab2013-03-07 21:37:17 +00001175 if (type->isAtomicType()) {
1176 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1177 } else {
1178 // TODO: how can we delay here if D is captured by its initializer?
1179 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier649b4a12012-03-29 17:37:10 +00001180 AggValueSlot::IsDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001181 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00001182 AggValueSlot::IsNotAliased));
John McCall9eda3ab2013-03-07 21:37:17 +00001183 }
Sebastian Redl972edf02012-02-19 16:03:09 +00001184 MaybeEmitStdInitializerListCleanup(lvalue.getAddress(), init);
John McCall9d232c82013-03-07 21:37:08 +00001185 return;
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +00001186 }
John McCall9d232c82013-03-07 21:37:08 +00001187 llvm_unreachable("bad evaluation kind");
John McCall34695852011-02-22 06:44:22 +00001188}
John McCallf1549f62010-07-06 01:34:17 +00001189
John McCallbdc4d802011-07-09 01:37:26 +00001190/// Enter a destroy cleanup for the given local variable.
1191void CodeGenFunction::emitAutoVarTypeCleanup(
1192 const CodeGenFunction::AutoVarEmission &emission,
1193 QualType::DestructionKind dtorKind) {
1194 assert(dtorKind != QualType::DK_none);
1195
1196 // Note that for __block variables, we want to destroy the
1197 // original stack object, not the possibly forwarded object.
1198 llvm::Value *addr = emission.getObjectAddress(*this);
1199
1200 const VarDecl *var = emission.Variable;
1201 QualType type = var->getType();
1202
1203 CleanupKind cleanupKind = NormalAndEHCleanup;
1204 CodeGenFunction::Destroyer *destroyer = 0;
1205
1206 switch (dtorKind) {
1207 case QualType::DK_none:
1208 llvm_unreachable("no cleanup for trivially-destructible variable");
1209
1210 case QualType::DK_cxx_destructor:
1211 // If there's an NRVO flag on the emission, we need a different
1212 // cleanup.
1213 if (emission.NRVOFlag) {
1214 assert(!type->isArrayType());
1215 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
1216 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr, dtor,
1217 emission.NRVOFlag);
1218 return;
1219 }
1220 break;
1221
1222 case QualType::DK_objc_strong_lifetime:
1223 // Suppress cleanups for pseudo-strong variables.
1224 if (var->isARCPseudoStrong()) return;
Eric Christophere1f54902011-08-23 22:38:00 +00001225
John McCallbdc4d802011-07-09 01:37:26 +00001226 // Otherwise, consider whether to use an EH cleanup or not.
1227 cleanupKind = getARCCleanupKind();
1228
1229 // Use the imprecise destroyer by default.
1230 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1231 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1232 break;
1233
1234 case QualType::DK_objc_weak_lifetime:
1235 break;
1236 }
1237
1238 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001239 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall2673c682011-07-11 08:38:19 +00001240
Sylvestre Ledruf3477c12012-09-27 10:16:10 +00001241 // Use an EH cleanup in array destructors iff the destructor itself
John McCall2673c682011-07-11 08:38:19 +00001242 // is being pushed as an EH cleanup.
1243 bool useEHCleanup = (cleanupKind & EHCleanup);
1244 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1245 useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001246}
1247
John McCall34695852011-02-22 06:44:22 +00001248void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +00001249 assert(emission.Variable && "emission was not valid!");
1250
John McCall34695852011-02-22 06:44:22 +00001251 // If this was emitted as a global constant, we're done.
1252 if (emission.wasEmittedAsGlobal()) return;
1253
John McCall38baeab2012-04-13 18:44:05 +00001254 // If we don't have an insertion point, we're done. Sema prevents
1255 // us from jumping into any of these scopes anyway.
1256 if (!HaveInsertPoint()) return;
1257
John McCall57b3b6a2011-02-22 07:16:58 +00001258 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +00001259
Nadav Rotem495cfa42013-03-23 06:43:35 +00001260 // Make sure we call @llvm.lifetime.end. This needs to happen
1261 // *last*, so the cleanup needs to be pushed *first*.
1262 if (emission.useLifetimeMarkers()) {
1263 EHStack.pushCleanup<CallLifetimeEnd>(NormalCleanup,
1264 emission.getAllocatedAddress(),
1265 emission.getSizeForLifetimeMarkers());
1266 }
1267
John McCallbdc4d802011-07-09 01:37:26 +00001268 // Check the type for a cleanup.
1269 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1270 emitAutoVarTypeCleanup(emission, dtorKind);
John McCallf85e1932011-06-15 23:02:42 +00001271
John McCall0c24c802011-06-24 23:21:27 +00001272 // In GC mode, honor objc_precise_lifetime.
David Blaikie4e4d0842012-03-11 07:00:24 +00001273 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall0c24c802011-06-24 23:21:27 +00001274 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1275 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1276 }
1277
John McCall34695852011-02-22 06:44:22 +00001278 // Handle the cleanup attribute.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +00001279 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlsson69c68b72009-02-07 23:51:38 +00001280 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump1eb44332009-09-09 15:08:12 +00001281
John McCall34695852011-02-22 06:44:22 +00001282 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001283 assert(F && "Could not find function!");
Mike Stump1eb44332009-09-09 15:08:12 +00001284
John McCallde5d3c72012-02-17 03:33:10 +00001285 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCall34695852011-02-22 06:44:22 +00001286 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001287 }
Mike Stump797b6322009-03-05 01:23:13 +00001288
John McCall34695852011-02-22 06:44:22 +00001289 // If this is a block variable, call _Block_object_destroy
1290 // (on the unforwarded address).
John McCall5af02db2011-03-31 01:59:53 +00001291 if (emission.IsByRef)
1292 enterByrefCleanup(emission);
Reid Spencer5f016e22007-07-11 17:01:13 +00001293}
1294
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001295CodeGenFunction::Destroyer *
John McCallbdc4d802011-07-09 01:37:26 +00001296CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
1297 switch (kind) {
1298 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCall0850e8d2011-07-09 09:09:00 +00001299 case QualType::DK_cxx_destructor:
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001300 return destroyCXXObject;
John McCall0850e8d2011-07-09 09:09:00 +00001301 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001302 return destroyARCStrongPrecise;
John McCall0850e8d2011-07-09 09:09:00 +00001303 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001304 return destroyARCWeak;
John McCallbdc4d802011-07-09 01:37:26 +00001305 }
Matt Beaumont-Gayba4be252012-01-27 00:46:27 +00001306 llvm_unreachable("Unknown DestructionKind");
John McCallbdc4d802011-07-09 01:37:26 +00001307}
1308
John McCall074cae02013-02-01 05:11:40 +00001309/// pushEHDestroy - Push the standard destructor for the given type as
1310/// an EH-only cleanup.
1311void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
1312 llvm::Value *addr, QualType type) {
1313 assert(dtorKind && "cannot push destructor for trivial type");
1314 assert(needsEHCleanup(dtorKind));
1315
1316 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
1317}
1318
1319/// pushDestroy - Push the standard destructor for the given type as
1320/// at least a normal cleanup.
John McCall9928c482011-07-12 16:41:08 +00001321void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
1322 llvm::Value *addr, QualType type) {
1323 assert(dtorKind && "cannot push destructor for trivial type");
1324
1325 CleanupKind cleanupKind = getCleanupKind(dtorKind);
1326 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
1327 cleanupKind & EHCleanup);
1328}
1329
John McCallbdc4d802011-07-09 01:37:26 +00001330void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, llvm::Value *addr,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001331 QualType type, Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001332 bool useEHCleanupForArray) {
John McCall9928c482011-07-12 16:41:08 +00001333 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
1334 destroyer, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001335}
1336
John McCall2673c682011-07-11 08:38:19 +00001337/// emitDestroy - Immediately perform the destruction of the given
1338/// object.
1339///
1340/// \param addr - the address of the object; a type*
1341/// \param type - the type of the object; if an array type, all
1342/// objects are destroyed in reverse order
1343/// \param destroyer - the function to call to destroy individual
1344/// elements
1345/// \param useEHCleanupForArray - whether an EH cleanup should be
1346/// used when destroying array elements, in case one of the
1347/// destructions throws an exception
John McCallbdc4d802011-07-09 01:37:26 +00001348void CodeGenFunction::emitDestroy(llvm::Value *addr, QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001349 Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001350 bool useEHCleanupForArray) {
John McCallbdc4d802011-07-09 01:37:26 +00001351 const ArrayType *arrayType = getContext().getAsArrayType(type);
1352 if (!arrayType)
1353 return destroyer(*this, addr, type);
1354
1355 llvm::Value *begin = addr;
1356 llvm::Value *length = emitArrayLength(arrayType, type, begin);
John McCallfbf780a2011-07-13 08:09:46 +00001357
1358 // Normally we have to check whether the array is zero-length.
1359 bool checkZeroLength = true;
1360
1361 // But if the array length is constant, we can suppress that.
1362 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
1363 // ...and if it's constant zero, we can just skip the entire thing.
1364 if (constLength->isZero()) return;
1365 checkZeroLength = false;
1366 }
1367
John McCallbdc4d802011-07-09 01:37:26 +00001368 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCallfbf780a2011-07-13 08:09:46 +00001369 emitArrayDestroy(begin, end, type, destroyer,
1370 checkZeroLength, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001371}
1372
John McCall2673c682011-07-11 08:38:19 +00001373/// emitArrayDestroy - Destroys all the elements of the given array,
1374/// beginning from last to first. The array cannot be zero-length.
1375///
1376/// \param begin - a type* denoting the first element of the array
1377/// \param end - a type* denoting one past the end of the array
1378/// \param type - the element type of the array
1379/// \param destroyer - the function to call to destroy elements
1380/// \param useEHCleanup - whether to push an EH cleanup to destroy
1381/// the remaining elements in case the destruction of a single
1382/// element throws
John McCallbdc4d802011-07-09 01:37:26 +00001383void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
1384 llvm::Value *end,
1385 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001386 Destroyer *destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001387 bool checkZeroLength,
John McCall2673c682011-07-11 08:38:19 +00001388 bool useEHCleanup) {
John McCallbdc4d802011-07-09 01:37:26 +00001389 assert(!type->isArrayType());
1390
1391 // The basic structure here is a do-while loop, because we don't
1392 // need to check for the zero-element case.
1393 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
1394 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
1395
John McCallfbf780a2011-07-13 08:09:46 +00001396 if (checkZeroLength) {
1397 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
1398 "arraydestroy.isempty");
1399 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
1400 }
1401
John McCallbdc4d802011-07-09 01:37:26 +00001402 // Enter the loop body, making that address the current address.
1403 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1404 EmitBlock(bodyBB);
1405 llvm::PHINode *elementPast =
1406 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
1407 elementPast->addIncoming(end, entryBB);
1408
1409 // Shift the address back by one element.
1410 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
1411 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
1412 "arraydestroy.element");
1413
John McCall2673c682011-07-11 08:38:19 +00001414 if (useEHCleanup)
1415 pushRegularPartialArrayCleanup(begin, element, type, destroyer);
1416
John McCallbdc4d802011-07-09 01:37:26 +00001417 // Perform the actual destruction there.
1418 destroyer(*this, element, type);
1419
John McCall2673c682011-07-11 08:38:19 +00001420 if (useEHCleanup)
1421 PopCleanupBlock();
1422
John McCallbdc4d802011-07-09 01:37:26 +00001423 // Check whether we've reached the end.
1424 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
1425 Builder.CreateCondBr(done, doneBB, bodyBB);
1426 elementPast->addIncoming(element, Builder.GetInsertBlock());
1427
1428 // Done.
1429 EmitBlock(doneBB);
1430}
1431
John McCall2673c682011-07-11 08:38:19 +00001432/// Perform partial array destruction as if in an EH cleanup. Unlike
1433/// emitArrayDestroy, the element type here may still be an array type.
John McCall2673c682011-07-11 08:38:19 +00001434static void emitPartialArrayDestroy(CodeGenFunction &CGF,
1435 llvm::Value *begin, llvm::Value *end,
1436 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001437 CodeGenFunction::Destroyer *destroyer) {
John McCall2673c682011-07-11 08:38:19 +00001438 // If the element type is itself an array, drill down.
John McCallfbf780a2011-07-13 08:09:46 +00001439 unsigned arrayDepth = 0;
John McCall2673c682011-07-11 08:38:19 +00001440 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
1441 // VLAs don't require a GEP index to walk into.
1442 if (!isa<VariableArrayType>(arrayType))
John McCallfbf780a2011-07-13 08:09:46 +00001443 arrayDepth++;
John McCall2673c682011-07-11 08:38:19 +00001444 type = arrayType->getElementType();
1445 }
John McCallfbf780a2011-07-13 08:09:46 +00001446
1447 if (arrayDepth) {
1448 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, arrayDepth+1);
1449
Chris Lattner5f9e2722011-07-23 10:55:15 +00001450 SmallVector<llvm::Value*,4> gepIndices(arrayDepth, zero);
Jay Foad0f6ac7c2011-07-22 08:16:57 +00001451 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
1452 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall2673c682011-07-11 08:38:19 +00001453 }
1454
John McCallfbf780a2011-07-13 08:09:46 +00001455 // Destroy the array. We don't ever need an EH cleanup because we
1456 // assume that we're in an EH cleanup ourselves, so a throwing
1457 // destructor causes an immediate terminate.
1458 CGF.emitArrayDestroy(begin, end, type, destroyer,
1459 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall2673c682011-07-11 08:38:19 +00001460}
1461
John McCallbdc4d802011-07-09 01:37:26 +00001462namespace {
John McCall2673c682011-07-11 08:38:19 +00001463 /// RegularPartialArrayDestroy - a cleanup which performs a partial
1464 /// array destroy where the end pointer is regularly determined and
1465 /// does not need to be loaded from a local.
1466 class RegularPartialArrayDestroy : public EHScopeStack::Cleanup {
1467 llvm::Value *ArrayBegin;
1468 llvm::Value *ArrayEnd;
1469 QualType ElementType;
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001470 CodeGenFunction::Destroyer *Destroyer;
John McCall2673c682011-07-11 08:38:19 +00001471 public:
1472 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
1473 QualType elementType,
1474 CodeGenFunction::Destroyer *destroyer)
1475 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001476 ElementType(elementType), Destroyer(destroyer) {}
John McCall2673c682011-07-11 08:38:19 +00001477
John McCallad346f42011-07-12 20:27:29 +00001478 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +00001479 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
1480 ElementType, Destroyer);
1481 }
1482 };
1483
1484 /// IrregularPartialArrayDestroy - a cleanup which performs a
1485 /// partial array destroy where the end pointer is irregularly
1486 /// determined and must be loaded from a local.
1487 class IrregularPartialArrayDestroy : public EHScopeStack::Cleanup {
John McCallbdc4d802011-07-09 01:37:26 +00001488 llvm::Value *ArrayBegin;
1489 llvm::Value *ArrayEndPointer;
1490 QualType ElementType;
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001491 CodeGenFunction::Destroyer *Destroyer;
John McCallbdc4d802011-07-09 01:37:26 +00001492 public:
John McCall2673c682011-07-11 08:38:19 +00001493 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
1494 llvm::Value *arrayEndPointer,
1495 QualType elementType,
1496 CodeGenFunction::Destroyer *destroyer)
John McCallbdc4d802011-07-09 01:37:26 +00001497 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001498 ElementType(elementType), Destroyer(destroyer) {}
John McCallbdc4d802011-07-09 01:37:26 +00001499
John McCallad346f42011-07-12 20:27:29 +00001500 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallbdc4d802011-07-09 01:37:26 +00001501 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall2673c682011-07-11 08:38:19 +00001502 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
1503 ElementType, Destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001504 }
1505 };
1506}
1507
John McCall2673c682011-07-11 08:38:19 +00001508/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCallbdc4d802011-07-09 01:37:26 +00001509/// already-constructed elements of the given array. The cleanup
John McCall2673c682011-07-11 08:38:19 +00001510/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christophere1f54902011-08-23 22:38:00 +00001511///
John McCallbdc4d802011-07-09 01:37:26 +00001512/// \param elementType - the immediate element type of the array;
1513/// possibly still an array type
John McCall9928c482011-07-12 16:41:08 +00001514void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall2673c682011-07-11 08:38:19 +00001515 llvm::Value *arrayEndPointer,
1516 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001517 Destroyer *destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001518 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
1519 arrayBegin, arrayEndPointer,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001520 elementType, destroyer);
John McCall2673c682011-07-11 08:38:19 +00001521}
1522
1523/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
1524/// already-constructed elements of the given array. The cleanup
1525/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christophere1f54902011-08-23 22:38:00 +00001526///
John McCall2673c682011-07-11 08:38:19 +00001527/// \param elementType - the immediate element type of the array;
1528/// possibly still an array type
John McCall2673c682011-07-11 08:38:19 +00001529void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1530 llvm::Value *arrayEnd,
1531 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001532 Destroyer *destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001533 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall2673c682011-07-11 08:38:19 +00001534 arrayBegin, arrayEnd,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001535 elementType, destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001536}
1537
Nadav Rotem495cfa42013-03-23 06:43:35 +00001538/// Lazily declare the @llvm.lifetime.start intrinsic.
1539llvm::Constant *CodeGenModule::getLLVMLifetimeStartFn() {
1540 if (LifetimeStartFn) return LifetimeStartFn;
1541 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
1542 llvm::Intrinsic::lifetime_start);
1543 return LifetimeStartFn;
1544}
1545
1546/// Lazily declare the @llvm.lifetime.end intrinsic.
1547llvm::Constant *CodeGenModule::getLLVMLifetimeEndFn() {
1548 if (LifetimeEndFn) return LifetimeEndFn;
1549 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
1550 llvm::Intrinsic::lifetime_end);
1551 return LifetimeEndFn;
1552}
1553
John McCallf85e1932011-06-15 23:02:42 +00001554namespace {
1555 /// A cleanup to perform a release of an object at the end of a
1556 /// function. This is used to balance out the incoming +1 of a
1557 /// ns_consumed argument when we can't reasonably do that just by
1558 /// not doing the initial retain for a __block argument.
1559 struct ConsumeARCParameter : EHScopeStack::Cleanup {
John McCall5b07e802013-03-13 03:10:54 +00001560 ConsumeARCParameter(llvm::Value *param,
1561 ARCPreciseLifetime_t precise)
1562 : Param(param), Precise(precise) {}
John McCallf85e1932011-06-15 23:02:42 +00001563
1564 llvm::Value *Param;
John McCall5b07e802013-03-13 03:10:54 +00001565 ARCPreciseLifetime_t Precise;
John McCallf85e1932011-06-15 23:02:42 +00001566
John McCallad346f42011-07-12 20:27:29 +00001567 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall5b07e802013-03-13 03:10:54 +00001568 CGF.EmitARCRelease(Param, Precise);
John McCallf85e1932011-06-15 23:02:42 +00001569 }
1570 };
1571}
1572
Mike Stump1eb44332009-09-09 15:08:12 +00001573/// Emit an alloca (or GlobalValue depending on target)
Chris Lattner2621fd12008-05-08 05:58:21 +00001574/// for the specified parameter and set up LocalDeclMap.
Devang Patel093ac462011-03-03 20:13:15 +00001575void CodeGenFunction::EmitParmDecl(const VarDecl &D, llvm::Value *Arg,
1576 unsigned ArgNo) {
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001577 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +00001578 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001579 "Invalid argument to EmitParmDecl");
John McCall8178df32011-02-22 22:38:33 +00001580
1581 Arg->setName(D.getName());
1582
Adrian Prantl836e7c92013-03-14 17:53:33 +00001583 QualType Ty = D.getType();
1584
John McCall8178df32011-02-22 22:38:33 +00001585 // Use better IR generation for certain implicit parameters.
1586 if (isa<ImplicitParamDecl>(D)) {
1587 // The only implicit argument a block has is its literal.
1588 if (BlockInfo) {
1589 LocalDeclMap[&D] = Arg;
Adrian Prantl836e7c92013-03-14 17:53:33 +00001590 llvm::Value *LocalAddr = 0;
1591 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
Adrian Prantl9b97adf2013-03-29 19:20:35 +00001592 // Allocate a stack slot to let the debug info survive the RA.
Adrian Prantl836e7c92013-03-14 17:53:33 +00001593 llvm::AllocaInst *Alloc = CreateTempAlloca(ConvertTypeForMem(Ty),
1594 D.getName() + ".addr");
1595 Alloc->setAlignment(getContext().getDeclAlign(&D).getQuantity());
1596 LValue lv = MakeAddrLValue(Alloc, Ty, getContext().getDeclAlign(&D));
1597 EmitStoreOfScalar(Arg, lv, /* isInitialization */ true);
1598 LocalAddr = Builder.CreateLoad(Alloc);
1599 }
John McCall8178df32011-02-22 22:38:33 +00001600
1601 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregor4cdad312012-10-23 20:05:01 +00001602 if (CGM.getCodeGenOpts().getDebugInfo()
1603 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001604 DI->setLocation(D.getLocation());
Adrian Prantl836e7c92013-03-14 17:53:33 +00001605 DI->EmitDeclareOfBlockLiteralArgVariable(*BlockInfo, Arg, LocalAddr, Builder);
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001606 }
John McCall8178df32011-02-22 22:38:33 +00001607 }
1608
1609 return;
1610 }
1611 }
1612
Reid Spencer5f016e22007-07-11 17:01:13 +00001613 llvm::Value *DeclPtr;
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001614 // If this is an aggregate or variable sized value, reuse the input pointer.
1615 if (!Ty->isConstantSizeType() ||
John McCall9d232c82013-03-07 21:37:08 +00001616 !CodeGenFunction::hasScalarEvaluationKind(Ty)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001617 DeclPtr = Arg;
Reid Spencer5f016e22007-07-11 17:01:13 +00001618 } else {
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001619 // Otherwise, create a temporary to hold the value.
Eli Friedmanddfb8d12011-11-03 20:31:28 +00001620 llvm::AllocaInst *Alloc = CreateTempAlloca(ConvertTypeForMem(Ty),
1621 D.getName() + ".addr");
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001622 CharUnits Align = getContext().getDeclAlign(&D);
1623 Alloc->setAlignment(Align.getQuantity());
Eli Friedmanddfb8d12011-11-03 20:31:28 +00001624 DeclPtr = Alloc;
Mike Stump1eb44332009-09-09 15:08:12 +00001625
John McCallf85e1932011-06-15 23:02:42 +00001626 bool doStore = true;
1627
1628 Qualifiers qs = Ty.getQualifiers();
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001629 LValue lv = MakeAddrLValue(DeclPtr, Ty, Align);
John McCallf85e1932011-06-15 23:02:42 +00001630 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
1631 // We honor __attribute__((ns_consumed)) for types with lifetime.
1632 // For __strong, it's handled by just skipping the initial retain;
1633 // otherwise we have to balance out the initial +1 with an extra
1634 // cleanup to do the release at the end of the function.
1635 bool isConsumed = D.hasAttr<NSConsumedAttr>();
1636
1637 // 'self' is always formally __strong, but if this is not an
1638 // init method then we don't want to retain it.
John McCall7acddac2011-06-17 06:42:21 +00001639 if (D.isARCPseudoStrong()) {
John McCallf85e1932011-06-15 23:02:42 +00001640 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl);
1641 assert(&D == method->getSelfDecl());
John McCall7acddac2011-06-17 06:42:21 +00001642 assert(lt == Qualifiers::OCL_Strong);
1643 assert(qs.hasConst());
John McCallf85e1932011-06-15 23:02:42 +00001644 assert(method->getMethodFamily() != OMF_init);
John McCall175d6592011-06-15 23:40:09 +00001645 (void) method;
John McCallf85e1932011-06-15 23:02:42 +00001646 lt = Qualifiers::OCL_ExplicitNone;
1647 }
1648
1649 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001650 if (!isConsumed) {
1651 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1652 // use objc_storeStrong(&dest, value) for retaining the
1653 // object. But first, store a null into 'dest' because
1654 // objc_storeStrong attempts to release its old value.
1655 llvm::Value * Null = CGM.EmitNullConstant(D.getType());
1656 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
1657 EmitARCStoreStrongCall(lv.getAddress(), Arg, true);
1658 doStore = false;
1659 }
1660 else
John McCallf85e1932011-06-15 23:02:42 +00001661 // Don't use objc_retainBlock for block pointers, because we
1662 // don't want to Block_copy something just because we got it
1663 // as a parameter.
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001664 Arg = EmitARCRetainNonBlock(Arg);
1665 }
John McCallf85e1932011-06-15 23:02:42 +00001666 } else {
1667 // Push the cleanup for a consumed parameter.
John McCall5b07e802013-03-13 03:10:54 +00001668 if (isConsumed) {
1669 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
1670 ? ARCPreciseLifetime : ARCImpreciseLifetime);
1671 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), Arg,
1672 precise);
1673 }
John McCallf85e1932011-06-15 23:02:42 +00001674
1675 if (lt == Qualifiers::OCL_Weak) {
1676 EmitARCInitWeak(DeclPtr, Arg);
Chad Rosier7acebfb2012-02-18 01:20:35 +00001677 doStore = false; // The weak init is a store, no need to do two.
John McCallf85e1932011-06-15 23:02:42 +00001678 }
1679 }
1680
1681 // Enter the cleanup scope.
1682 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
1683 }
1684
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001685 // Store the initial value into the alloca.
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001686 if (doStore)
David Chisnall7a7ee302012-01-16 17:27:18 +00001687 EmitStoreOfScalar(Arg, lv, /* isInitialization */ true);
Reid Spencer5f016e22007-07-11 17:01:13 +00001688 }
1689
1690 llvm::Value *&DMEntry = LocalDeclMap[&D];
1691 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
1692 DMEntry = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00001693
1694 // Emit debug info for param declaration.
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001695 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregor4cdad312012-10-23 20:05:01 +00001696 if (CGM.getCodeGenOpts().getDebugInfo()
1697 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001698 DI->EmitDeclareOfArgVariable(&D, DeclPtr, ArgNo, Builder);
1699 }
1700 }
Julien Lerouge77f68bb2011-09-09 22:41:49 +00001701
1702 if (D.hasAttr<AnnotateAttr>())
1703 EmitVarAnnotations(&D, DeclPtr);
Reid Spencer5f016e22007-07-11 17:01:13 +00001704}