blob: 1869c1c27a166e70b85daa9e6e2f2c94d2f8880f [file] [log] [blame]
Chris Lattner84915fa2007-06-02 04:16:21 +00001//===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner84915fa2007-06-02 04:16:21 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Decl nodes as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000015#include "CGDebugInfo.h"
Peter Collingbourne2dbb7082011-09-19 21:14:35 +000016#include "CGOpenCLRuntime.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CodeGenModule.h"
Daniel Dunbarad319a72008-08-11 05:00:27 +000018#include "clang/AST/ASTContext.h"
Ken Dyck8c89d592009-12-22 14:23:30 +000019#include "clang/AST/CharUnits.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000020#include "clang/AST/Decl.h"
Anders Carlsson4c03d982008-08-25 01:38:19 +000021#include "clang/AST/DeclObjC.h"
Nate Begemanfaae0812008-04-19 04:17:09 +000022#include "clang/Basic/SourceManager.h"
Chris Lattnerb781dc792008-05-08 05:58:21 +000023#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000024#include "clang/CodeGen/CGFunctionInfo.h"
Chandler Carruth85098242010-06-15 23:19:56 +000025#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/GlobalVariable.h"
28#include "llvm/IR/Intrinsics.h"
29#include "llvm/IR/Type.h"
Chris Lattner84915fa2007-06-02 04:16:21 +000030using namespace clang;
31using namespace CodeGen;
32
33
Chris Lattner1ad38f82007-06-09 01:20:56 +000034void CodeGenFunction::EmitDecl(const Decl &D) {
Chris Lattner1ad38f82007-06-09 01:20:56 +000035 switch (D.getKind()) {
Douglas Gregor19043f02010-04-23 02:02:43 +000036 case Decl::TranslationUnit:
37 case Decl::Namespace:
38 case Decl::UnresolvedUsingTypename:
39 case Decl::ClassTemplateSpecialization:
40 case Decl::ClassTemplatePartialSpecialization:
Larisse Voufo39a1e502013-08-06 01:03:05 +000041 case Decl::VarTemplateSpecialization:
42 case Decl::VarTemplatePartialSpecialization:
Douglas Gregor19043f02010-04-23 02:02:43 +000043 case Decl::TemplateTypeParm:
44 case Decl::UnresolvedUsingValue:
Alexis Hunted053252010-05-30 07:21:58 +000045 case Decl::NonTypeTemplateParm:
Douglas Gregor19043f02010-04-23 02:02:43 +000046 case Decl::CXXMethod:
47 case Decl::CXXConstructor:
48 case Decl::CXXDestructor:
49 case Decl::CXXConversion:
50 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +000051 case Decl::MSProperty:
Francois Pichetdf946c32010-11-21 06:49:41 +000052 case Decl::IndirectField:
Douglas Gregor19043f02010-04-23 02:02:43 +000053 case Decl::ObjCIvar:
Eric Christopher31ab1302011-08-23 22:38:00 +000054 case Decl::ObjCAtDefsField:
Chris Lattnerba9dddb2007-10-08 21:37:32 +000055 case Decl::ParmVar:
Douglas Gregor19043f02010-04-23 02:02:43 +000056 case Decl::ImplicitParam:
57 case Decl::ClassTemplate:
Larisse Voufo39a1e502013-08-06 01:03:05 +000058 case Decl::VarTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000059 case Decl::FunctionTemplate:
Richard Smith3f1b5d02011-05-05 21:57:07 +000060 case Decl::TypeAliasTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000061 case Decl::TemplateTemplateParm:
62 case Decl::ObjCMethod:
63 case Decl::ObjCCategory:
64 case Decl::ObjCProtocol:
65 case Decl::ObjCInterface:
66 case Decl::ObjCCategoryImpl:
67 case Decl::ObjCImplementation:
68 case Decl::ObjCProperty:
69 case Decl::ObjCCompatibleAlias:
Abramo Bagnarad7340582010-06-05 05:09:32 +000070 case Decl::AccessSpec:
Douglas Gregor19043f02010-04-23 02:02:43 +000071 case Decl::LinkageSpec:
72 case Decl::ObjCPropertyImpl:
Douglas Gregor19043f02010-04-23 02:02:43 +000073 case Decl::FileScopeAsm:
74 case Decl::Friend:
75 case Decl::FriendTemplate:
76 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +000077 case Decl::Captured:
Francois Pichet00c7e6c2011-08-14 03:52:19 +000078 case Decl::ClassScopeFunctionSpecialization:
David Blaikiebd483762013-05-20 04:58:53 +000079 case Decl::UsingShadow:
David Blaikie83d382b2011-09-23 05:06:16 +000080 llvm_unreachable("Declaration should not be in declstmts!");
Chris Lattner84915fa2007-06-02 04:16:21 +000081 case Decl::Function: // void X();
Argyrios Kyrtzidis88e1b972008-10-15 00:42:39 +000082 case Decl::Record: // struct/union/class X;
Chris Lattner84915fa2007-06-02 04:16:21 +000083 case Decl::Enum: // enum X;
Mike Stump11289f42009-09-09 15:08:12 +000084 case Decl::EnumConstant: // enum ? { X = ? }
Argyrios Kyrtzidis88e1b972008-10-15 00:42:39 +000085 case Decl::CXXRecord: // struct/union/class X; [C++]
Anders Carlssonce2cd012009-12-03 17:26:31 +000086 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner43e7f312011-02-18 02:08:43 +000087 case Decl::Label: // __label__ x;
Douglas Gregorba345522011-12-02 23:23:56 +000088 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +000089 case Decl::OMPThreadPrivate:
Michael Han84324352013-02-22 17:15:32 +000090 case Decl::Empty:
Chris Lattner84915fa2007-06-02 04:16:21 +000091 // None of these decls require codegen support.
92 return;
David Blaikieb7d1e1f2013-02-02 00:39:32 +000093
David Blaikief121b932013-05-20 22:50:41 +000094 case Decl::NamespaceAlias:
95 if (CGDebugInfo *DI = getDebugInfo())
96 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
97 return;
David Blaikiebd483762013-05-20 04:58:53 +000098 case Decl::Using: // using X; [C++]
99 if (CGDebugInfo *DI = getDebugInfo())
100 DI->EmitUsingDecl(cast<UsingDecl>(D));
101 return;
David Blaikie9f88fe82013-04-22 06:13:21 +0000102 case Decl::UsingDirective: // using namespace X; [C++]
103 if (CGDebugInfo *DI = getDebugInfo())
104 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
105 return;
Daniel Dunbara7998072008-08-29 17:28:43 +0000106 case Decl::Var: {
107 const VarDecl &VD = cast<VarDecl>(D);
John McCall1c9c3fd2010-10-15 04:57:14 +0000108 assert(VD.isLocalVarDecl() &&
Daniel Dunbara7998072008-08-29 17:28:43 +0000109 "Should not see file-scope variables inside a function!");
John McCall1c9c3fd2010-10-15 04:57:14 +0000110 return EmitVarDecl(VD);
Chris Lattner84915fa2007-06-02 04:16:21 +0000111 }
Mike Stump11289f42009-09-09 15:08:12 +0000112
Richard Smithdda56e42011-04-15 14:24:37 +0000113 case Decl::Typedef: // typedef int X;
114 case Decl::TypeAlias: { // using X = int; [C++0x]
115 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000116 QualType Ty = TD.getUnderlyingType();
Mike Stump11289f42009-09-09 15:08:12 +0000117
Anders Carlsson5d985f52008-12-20 21:51:53 +0000118 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000119 EmitVariablyModifiedType(Ty);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000120 }
Daniel Dunbara7998072008-08-29 17:28:43 +0000121 }
Chris Lattner84915fa2007-06-02 04:16:21 +0000122}
Chris Lattner03df1222007-06-02 04:53:11 +0000123
John McCall1c9c3fd2010-10-15 04:57:14 +0000124/// EmitVarDecl - This method handles emission of any variable declaration
Chris Lattner03df1222007-06-02 04:53:11 +0000125/// inside a function, including static vars etc.
John McCall1c9c3fd2010-10-15 04:57:14 +0000126void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000127 if (D.isStaticLocal()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000128 llvm::GlobalValue::LinkageTypes Linkage =
David Majnemer27d69db2014-04-28 22:17:59 +0000129 CGM.getLLVMLinkageVarDefinition(&D, /*isConstant=*/false);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000130
David Majnemer27d69db2014-04-28 22:17:59 +0000131 // FIXME: We need to force the emission/use of a guard variable for
132 // some variables even if we can constant-evaluate them because
133 // we can't guarantee every translation unit will constant-evaluate them.
Eric Christopher31ab1302011-08-23 22:38:00 +0000134
John McCall1c9c3fd2010-10-15 04:57:14 +0000135 return EmitStaticVarDecl(D, Linkage);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000136 }
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000137
138 if (D.hasExternalStorage())
Lauro Ramos Venanciobada8d42008-02-16 22:30:38 +0000139 // Don't emit it now, allow it to be emitted lazily on its first use.
140 return;
Daniel Dunbar0ca16602009-04-14 02:25:56 +0000141
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000142 if (D.getStorageClass() == SC_OpenCLWorkGroupLocal)
143 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
144
145 assert(D.hasLocalStorage());
146 return EmitAutoVarDecl(D);
Chris Lattner03df1222007-06-02 04:53:11 +0000147}
148
Chris Lattnere99c1102009-12-05 08:22:11 +0000149static std::string GetStaticDeclName(CodeGenFunction &CGF, const VarDecl &D,
150 const char *Separator) {
151 CodeGenModule &CGM = CGF.CGM;
Richard Smith9c6890a2012-11-01 22:30:59 +0000152 if (CGF.getLangOpts().CPlusPlus) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000153 StringRef Name = CGM.getMangledName(&D);
Anders Carlssonea836bc2010-06-22 16:16:50 +0000154 return Name.str();
John McCall7ec50432010-03-19 23:29:14 +0000155 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000156
Chris Lattnere99c1102009-12-05 08:22:11 +0000157 std::string ContextName;
Fariborz Jahanian3a4ea9a2010-11-30 23:07:14 +0000158 if (!CGF.CurFuncDecl) {
159 // Better be in a block declared in global scope.
160 const NamedDecl *ND = cast<NamedDecl>(&D);
161 const DeclContext *DC = ND->getDeclContext();
162 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
163 MangleBuffer Name;
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000164 CGM.getBlockMangledName(GlobalDecl(), Name, BD);
Fariborz Jahanian3a4ea9a2010-11-30 23:07:14 +0000165 ContextName = Name.getString();
166 }
167 else
David Blaikie83d382b2011-09-23 05:06:16 +0000168 llvm_unreachable("Unknown context for block static var decl");
Fariborz Jahanian3a4ea9a2010-11-30 23:07:14 +0000169 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CGF.CurFuncDecl)) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000170 StringRef Name = CGM.getMangledName(FD);
Anders Carlssonea836bc2010-06-22 16:16:50 +0000171 ContextName = Name.str();
John McCall7ec50432010-03-19 23:29:14 +0000172 } else if (isa<ObjCMethodDecl>(CGF.CurFuncDecl))
Chris Lattnere99c1102009-12-05 08:22:11 +0000173 ContextName = CGF.CurFn->getName();
174 else
David Blaikie83d382b2011-09-23 05:06:16 +0000175 llvm_unreachable("Unknown context for static var decl");
Eric Christopher31ab1302011-08-23 22:38:00 +0000176
Chris Lattnere99c1102009-12-05 08:22:11 +0000177 return ContextName + Separator + D.getNameAsString();
178}
179
Eli Benderskycb399432014-03-24 22:05:38 +0000180llvm::Constant *
John McCall1c9c3fd2010-10-15 04:57:14 +0000181CodeGenFunction::CreateStaticVarDecl(const VarDecl &D,
182 const char *Separator,
183 llvm::GlobalValue::LinkageTypes Linkage) {
Chris Lattnerfc4379f2008-04-06 23:10:54 +0000184 QualType Ty = D.getType();
Eli Friedmana682d392008-02-15 12:20:59 +0000185 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begemanfaae0812008-04-19 04:17:09 +0000186
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000187 // Use the label if the variable is renamed with the asm-label extension.
188 std::string Name;
Benjamin Kramer5642e192011-11-21 15:47:23 +0000189 if (D.hasAttr<AsmLabelAttr>())
190 Name = CGM.getMangledName(&D);
191 else
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000192 Name = GetStaticDeclName(*this, D, Separator);
Nate Begemanfaae0812008-04-19 04:17:09 +0000193
Chris Lattner2192fe52011-07-18 04:24:23 +0000194 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(Ty);
Peter Collingbourneee0502d2012-08-28 20:37:10 +0000195 unsigned AddrSpace =
196 CGM.GetGlobalVarAddressSpace(&D, CGM.getContext().getTargetAddressSpace(Ty));
Anders Carlssone33eed52009-09-26 18:16:06 +0000197 llvm::GlobalVariable *GV =
198 new llvm::GlobalVariable(CGM.getModule(), LTy,
199 Ty.isConstant(getContext()), Linkage,
Craig Topper8a13c412014-05-21 05:09:00 +0000200 CGM.EmitNullConstant(D.getType()), Name, nullptr,
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000201 llvm::GlobalVariable::NotThreadLocal,
Peter Collingbourneee0502d2012-08-28 20:37:10 +0000202 AddrSpace);
Ken Dyck160146e2010-01-27 17:10:57 +0000203 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Eli Friedman40a4bec2013-06-17 21:51:45 +0000204 CGM.setGlobalVisibility(GV, &D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000205
Richard Smithfd3834f2013-04-13 02:43:54 +0000206 if (D.getTLSKind())
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000207 CGM.setTLSMode(GV, D);
208
Eli Benderskycb399432014-03-24 22:05:38 +0000209 // Make sure the result is of the correct type.
210 unsigned ExpectedAddrSpace = CGM.getContext().getTargetAddressSpace(Ty);
211 if (AddrSpace != ExpectedAddrSpace) {
212 llvm::PointerType *PTy = llvm::PointerType::get(LTy, ExpectedAddrSpace);
213 return llvm::ConstantExpr::getAddrSpaceCast(GV, PTy);
214 }
215
Anders Carlssone33eed52009-09-26 18:16:06 +0000216 return GV;
Daniel Dunbar22a87f92009-02-25 19:24:29 +0000217}
218
Richard Smith6331c402012-02-13 22:16:19 +0000219/// hasNontrivialDestruction - Determine whether a type's destruction is
220/// non-trivial. If so, and the variable uses static initialization, we must
221/// register its destructor to run on exit.
222static bool hasNontrivialDestruction(QualType T) {
223 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
224 return RD && !RD->hasTrivialDestructor();
225}
226
Chandler Carruth84537952012-03-30 19:44:53 +0000227/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
228/// global variable that has already been created for it. If the initializer
229/// has a different type than GV does, this may free GV and return a different
230/// one. Otherwise it just returns GV.
231llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +0000232CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000233 llvm::GlobalVariable *GV) {
234 llvm::Constant *Init = CGM.EmitConstantInit(D, this);
John McCall70013b62010-07-15 23:40:35 +0000235
Chris Lattnere99c1102009-12-05 08:22:11 +0000236 // If constant emission failed, then this should be a C++ static
237 // initializer.
Chandler Carruth84537952012-03-30 19:44:53 +0000238 if (!Init) {
Richard Smith9c6890a2012-11-01 22:30:59 +0000239 if (!getLangOpts().CPlusPlus)
Chris Lattnere99c1102009-12-05 08:22:11 +0000240 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
John McCall68ff0372010-09-08 01:44:27 +0000241 else if (Builder.GetInsertBlock()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000242 // Since we have a static initializer, this global variable can't
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000243 // be constant.
Chandler Carruth84537952012-03-30 19:44:53 +0000244 GV->setConstant(false);
John McCall68ff0372010-09-08 01:44:27 +0000245
Chandler Carruth84537952012-03-30 19:44:53 +0000246 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000247 }
Chandler Carruth84537952012-03-30 19:44:53 +0000248 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000249 }
John McCall70013b62010-07-15 23:40:35 +0000250
Chris Lattnere99c1102009-12-05 08:22:11 +0000251 // The initializer may differ in type from the global. Rewrite
252 // the global to match the initializer. (We have to do this
253 // because some types, like unions, can't be completely represented
254 // in the LLVM type system.)
Chandler Carruth84537952012-03-30 19:44:53 +0000255 if (GV->getType()->getElementType() != Init->getType()) {
256 llvm::GlobalVariable *OldGV = GV;
257
258 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
259 OldGV->isConstant(),
260 OldGV->getLinkage(), Init, "",
261 /*InsertBefore*/ OldGV,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +0000262 OldGV->getThreadLocalMode(),
Chandler Carruth84537952012-03-30 19:44:53 +0000263 CGM.getContext().getTargetAddressSpace(D.getType()));
264 GV->setVisibility(OldGV->getVisibility());
Eric Christopher31ab1302011-08-23 22:38:00 +0000265
Chris Lattnere99c1102009-12-05 08:22:11 +0000266 // Steal the name of the old global
Chandler Carruth84537952012-03-30 19:44:53 +0000267 GV->takeName(OldGV);
Eric Christopher31ab1302011-08-23 22:38:00 +0000268
Chris Lattnere99c1102009-12-05 08:22:11 +0000269 // Replace all uses of the old global with the new global
Chandler Carruth84537952012-03-30 19:44:53 +0000270 llvm::Constant *NewPtrForOldDecl =
271 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
272 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christopher31ab1302011-08-23 22:38:00 +0000273
Chris Lattnere99c1102009-12-05 08:22:11 +0000274 // Erase the old global, since it is no longer used.
Chandler Carruth84537952012-03-30 19:44:53 +0000275 OldGV->eraseFromParent();
Chris Lattnere99c1102009-12-05 08:22:11 +0000276 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000277
Chandler Carruth84537952012-03-30 19:44:53 +0000278 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
279 GV->setInitializer(Init);
Richard Smith6331c402012-02-13 22:16:19 +0000280
281 if (hasNontrivialDestruction(D.getType())) {
282 // We have a constant initializer, but a nontrivial destructor. We still
283 // need to perform a guarded "initialization" in order to register the
Richard Smithe070fd22012-02-17 06:48:11 +0000284 // destructor.
Chandler Carruth84537952012-03-30 19:44:53 +0000285 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith6331c402012-02-13 22:16:19 +0000286 }
287
Chandler Carruth84537952012-03-30 19:44:53 +0000288 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000289}
290
John McCall1c9c3fd2010-10-15 04:57:14 +0000291void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000292 llvm::GlobalValue::LinkageTypes Linkage) {
Chandler Carruth84537952012-03-30 19:44:53 +0000293 llvm::Value *&DMEntry = LocalDeclMap[&D];
Craig Topper8a13c412014-05-21 05:09:00 +0000294 assert(!DMEntry && "Decl already exists in localdeclmap!");
Mike Stump11289f42009-09-09 15:08:12 +0000295
John McCallb88a5662012-03-30 21:00:39 +0000296 // Check to see if we already have a global variable for this
297 // declaration. This can happen when double-emitting function
298 // bodies, e.g. with complete and base constructors.
299 llvm::Constant *addr =
300 CGM.getStaticLocalDeclAddress(&D);
301
Eli Benderskycb399432014-03-24 22:05:38 +0000302 if (!addr)
303 addr = CreateStaticVarDecl(D, ".", Linkage);
Daniel Dunbara374e602009-02-25 19:45:19 +0000304
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000305 // Store into LocalDeclMap before generating initializer to handle
306 // circular references.
John McCallb88a5662012-03-30 21:00:39 +0000307 DMEntry = addr;
308 CGM.setStaticLocalDeclAddress(&D, addr);
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000309
John McCall4a39ab82010-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 Friedmanbc633be2009-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 McCall23c29fe2011-06-24 21:55:10 +0000314 EmitVariablyModifiedType(D.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000315
John McCallb88a5662012-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 Friedmanbc633be2009-04-20 03:54:15 +0000318
Eli Benderskycb399432014-03-24 22:05:38 +0000319 llvm::GlobalVariable *var =
320 cast<llvm::GlobalVariable>(addr->stripPointerCasts());
Chris Lattnere99c1102009-12-05 08:22:11 +0000321 // If this value has an initializer, emit it.
322 if (D.getInit())
John McCallb88a5662012-03-30 21:00:39 +0000323 var = AddInitializerToStaticVarDecl(D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000324
John McCallb88a5662012-03-30 21:00:39 +0000325 var->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Chris Lattner4d941092010-03-10 23:59:59 +0000326
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000327 if (D.hasAttr<AnnotateAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000328 CGM.AddGlobalAnnotations(&D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000329
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000330 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000331 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000332
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000333 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000334 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000335
Chandler Carruth84537952012-03-30 19:44:53 +0000336 // We may have to cast the constant because of the initializer
337 // mismatch above.
338 //
339 // FIXME: It is really dangerous to store this in the map; if anyone
340 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000341 llvm::Constant *castedAddr =
342 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCallb88a5662012-03-30 21:00:39 +0000343 DMEntry = castedAddr;
344 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000345
346 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000347 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000348 if (DI &&
Douglas Gregorb0eea8b2012-10-23 20:05:01 +0000349 CGM.getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000350 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000351 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000352 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000353}
Mike Stump11289f42009-09-09 15:08:12 +0000354
John McCall2b7fc382010-07-13 20:32:21 +0000355namespace {
John McCall82fe67b2011-07-09 01:37:26 +0000356 struct DestroyObject : EHScopeStack::Cleanup {
357 DestroyObject(llvm::Value *addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000358 CodeGenFunction::Destroyer *destroyer,
359 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000360 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000361 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000362
John McCall82fe67b2011-07-09 01:37:26 +0000363 llvm::Value *addr;
364 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000365 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000366 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000367
Craig Topper4f12f102014-03-12 06:41:41 +0000368 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000369 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000370 bool useEHCleanupForArray =
371 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000372
373 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000374 }
375 };
376
John McCall82fe67b2011-07-09 01:37:26 +0000377 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
378 DestroyNRVOVariable(llvm::Value *addr,
379 const CXXDestructorDecl *Dtor,
380 llvm::Value *NRVOFlag)
381 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {}
John McCall2b7fc382010-07-13 20:32:21 +0000382
383 const CXXDestructorDecl *Dtor;
384 llvm::Value *NRVOFlag;
385 llvm::Value *Loc;
386
Craig Topper4f12f102014-03-12 06:41:41 +0000387 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000388 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000389 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000390
Craig Topper8a13c412014-05-21 05:09:00 +0000391 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000392 if (NRVO) {
393 // If we exited via NRVO, we skip the destructor call.
394 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
395 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
396 llvm::Value *DidNRVO = CGF.Builder.CreateLoad(NRVOFlag, "nrvo.val");
397 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
398 CGF.EmitBlock(RunDtorBB);
399 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000400
John McCall2b7fc382010-07-13 20:32:21 +0000401 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +0000402 /*ForVirtualBase=*/false,
403 /*Delegating=*/false,
404 Loc);
John McCall2b7fc382010-07-13 20:32:21 +0000405
406 if (NRVO) CGF.EmitBlock(SkipDtorBB);
407 }
408 };
John McCall2b7fc382010-07-13 20:32:21 +0000409
John McCallcda666c2010-07-21 07:22:38 +0000410 struct CallStackRestore : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000411 llvm::Value *Stack;
412 CallStackRestore(llvm::Value *Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000413 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000414 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
John McCalla464ff92010-07-21 06:13:08 +0000415 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
416 CGF.Builder.CreateCall(F, V);
417 }
418 };
419
John McCall1bd25562011-06-24 23:21:27 +0000420 struct ExtendGCLifetime : EHScopeStack::Cleanup {
421 const VarDecl &Var;
422 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
423
Craig Topper4f12f102014-03-12 06:41:41 +0000424 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000425 // Compute the address of the local variable, in case it's a
426 // byref or something.
John McCall113bee02012-03-10 09:33:50 +0000427 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
428 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000429 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
430 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000431 CGF.EmitExtendGCLifetime(value);
432 }
433 };
434
John McCallcda666c2010-07-21 07:22:38 +0000435 struct CallCleanupFunction : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000436 llvm::Constant *CleanupFn;
437 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000438 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000439
John McCalla464ff92010-07-21 06:13:08 +0000440 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000441 const VarDecl *Var)
442 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000443
Craig Topper4f12f102014-03-12 06:41:41 +0000444 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall113bee02012-03-10 09:33:50 +0000445 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
446 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000447 // Compute the address of the local variable, in case it's a byref
448 // or something.
449 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getAddress();
450
John McCalla464ff92010-07-21 06:13:08 +0000451 // In some cases, the type of the function argument will be different from
452 // the type of the pointer. An example of this is
453 // void f(void* arg);
454 // __attribute__((cleanup(f))) void *g;
455 //
456 // To fix this we insert a bitcast here.
457 QualType ArgTy = FnInfo.arg_begin()->type;
458 llvm::Value *Arg =
459 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
460
461 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000462 Args.add(RValue::get(Arg),
463 CGF.getContext().getPointerType(Var.getType()));
John McCalla464ff92010-07-21 06:13:08 +0000464 CGF.EmitCall(FnInfo, CleanupFn, ReturnValueSlot(), Args);
465 }
466 };
Nadav Rotem1da30942013-03-23 06:43:35 +0000467
468 /// A cleanup to call @llvm.lifetime.end.
469 class CallLifetimeEnd : public EHScopeStack::Cleanup {
470 llvm::Value *Addr;
471 llvm::Value *Size;
472 public:
473 CallLifetimeEnd(llvm::Value *addr, llvm::Value *size)
474 : Addr(addr), Size(size) {}
475
Craig Topper4f12f102014-03-12 06:41:41 +0000476 void Emit(CodeGenFunction &CGF, Flags flags) override {
Nadav Rotem1da30942013-03-23 06:43:35 +0000477 llvm::Value *castAddr = CGF.Builder.CreateBitCast(Addr, CGF.Int8PtrTy);
478 CGF.Builder.CreateCall2(CGF.CGM.getLLVMLifetimeEndFn(),
479 Size, castAddr)
480 ->setDoesNotThrow();
481 }
482 };
John McCalla464ff92010-07-21 06:13:08 +0000483}
484
John McCall31168b02011-06-15 23:02:42 +0000485/// EmitAutoVarWithLifetime - Does the setup required for an automatic
486/// variable with lifetime.
487static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
488 llvm::Value *addr,
489 Qualifiers::ObjCLifetime lifetime) {
490 switch (lifetime) {
491 case Qualifiers::OCL_None:
492 llvm_unreachable("present but none");
493
494 case Qualifiers::OCL_ExplicitNone:
495 // nothing to do
496 break;
497
498 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000499 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000500 (var.hasAttr<ObjCPreciseLifetimeAttr>()
501 ? CodeGenFunction::destroyARCStrongPrecise
502 : CodeGenFunction::destroyARCStrongImprecise);
503
504 CleanupKind cleanupKind = CGF.getARCCleanupKind();
505 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
506 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000507 break;
508 }
509 case Qualifiers::OCL_Autoreleasing:
510 // nothing to do
511 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000512
John McCall31168b02011-06-15 23:02:42 +0000513 case Qualifiers::OCL_Weak:
514 // __weak objects always get EH cleanups; otherwise, exceptions
515 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000516 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
517 CodeGenFunction::destroyARCWeak,
518 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000519 break;
520 }
521}
522
523static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
524 if (const Expr *e = dyn_cast<Expr>(s)) {
525 // Skip the most common kinds of expressions that make
526 // hierarchy-walking expensive.
527 s = e = e->IgnoreParenCasts();
528
529 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
530 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000531 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
532 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000533 for (const auto &I : block->captures()) {
534 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000535 return true;
536 }
537 }
John McCall31168b02011-06-15 23:02:42 +0000538 }
539
540 for (Stmt::const_child_range children = s->children(); children; ++children)
Fariborz Jahanian326701e2011-06-29 20:00:16 +0000541 // children might be null; as in missing decl or conditional of an if-stmt.
542 if ((*children) && isAccessedBy(var, *children))
John McCall31168b02011-06-15 23:02:42 +0000543 return true;
544
545 return false;
546}
547
548static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
549 if (!decl) return false;
550 if (!isa<VarDecl>(decl)) return false;
551 const VarDecl *var = cast<VarDecl>(decl);
552 return isAccessedBy(*var, e);
553}
554
John McCall1553b192011-06-16 04:16:24 +0000555static void drillIntoBlockVariable(CodeGenFunction &CGF,
556 LValue &lvalue,
557 const VarDecl *var) {
558 lvalue.setAddress(CGF.BuildBlockByrefAddress(lvalue.getAddress(), var));
559}
560
John McCall31168b02011-06-15 23:02:42 +0000561void CodeGenFunction::EmitScalarInit(const Expr *init,
562 const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +0000563 LValue lvalue,
564 bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000565 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000566 if (!lifetime) {
567 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000568 if (capturedByInit)
569 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Chisnallfa35df62012-01-16 17:27:18 +0000570 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000571 return;
572 }
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000573
574 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
575 init = DIE->getExpr();
576
John McCall31168b02011-06-15 23:02:42 +0000577 // If we're emitting a value with lifetime, we have to do the
578 // initialization *before* we leave the cleanup scopes.
John McCall08ef4662011-11-10 08:15:53 +0000579 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init)) {
580 enterFullExpression(ewc);
John McCall31168b02011-06-15 23:02:42 +0000581 init = ewc->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000582 }
583 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000584
585 // We have to maintain the illusion that the variable is
586 // zero-initialized. If the variable might be accessed in its
587 // initializer, zero-initialize before running the initializer, then
588 // actually perform the initialization with an assign.
589 bool accessedByInit = false;
590 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000591 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000592 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000593 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000594 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000595 if (capturedByInit) {
596 // We can use a simple GEP for this because it can't have been
597 // moved yet.
John McCall1553b192011-06-16 04:16:24 +0000598 tempLV.setAddress(Builder.CreateStructGEP(tempLV.getAddress(),
599 getByRefValueLLVMField(cast<VarDecl>(D))));
John McCall31168b02011-06-15 23:02:42 +0000600 }
601
Chris Lattner2192fe52011-07-18 04:24:23 +0000602 llvm::PointerType *ty
John McCall1553b192011-06-16 04:16:24 +0000603 = cast<llvm::PointerType>(tempLV.getAddress()->getType());
John McCall31168b02011-06-15 23:02:42 +0000604 ty = cast<llvm::PointerType>(ty->getElementType());
605
606 llvm::Value *zero = llvm::ConstantPointerNull::get(ty);
Eric Christopher31ab1302011-08-23 22:38:00 +0000607
John McCall31168b02011-06-15 23:02:42 +0000608 // If __weak, we want to use a barrier under certain conditions.
609 if (lifetime == Qualifiers::OCL_Weak)
John McCall1553b192011-06-16 04:16:24 +0000610 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCall31168b02011-06-15 23:02:42 +0000611
612 // Otherwise just do a simple store.
613 else
David Chisnallfa35df62012-01-16 17:27:18 +0000614 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000615 }
616
617 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000618 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000619
620 switch (lifetime) {
621 case Qualifiers::OCL_None:
622 llvm_unreachable("present but none");
623
624 case Qualifiers::OCL_ExplicitNone:
625 // nothing to do
626 value = EmitScalarExpr(init);
627 break;
628
629 case Qualifiers::OCL_Strong: {
630 value = EmitARCRetainScalarExpr(init);
631 break;
632 }
633
634 case Qualifiers::OCL_Weak: {
635 // No way to optimize a producing initializer into this. It's not
636 // worth optimizing for, because the value will immediately
637 // disappear in the common case.
638 value = EmitScalarExpr(init);
639
John McCall1553b192011-06-16 04:16:24 +0000640 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000641 if (accessedByInit)
John McCall1553b192011-06-16 04:16:24 +0000642 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000643 else
John McCall1553b192011-06-16 04:16:24 +0000644 EmitARCInitWeak(lvalue.getAddress(), value);
John McCall31168b02011-06-15 23:02:42 +0000645 return;
646 }
647
648 case Qualifiers::OCL_Autoreleasing:
649 value = EmitARCRetainAutoreleaseScalarExpr(init);
650 break;
651 }
652
John McCall1553b192011-06-16 04:16:24 +0000653 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000654
655 // If the variable might have been accessed by its initializer, we
656 // might have to initialize with a barrier. We have to do this for
657 // both __weak and __strong, but __weak got filtered out above.
658 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000659 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000660 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000661 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000662 return;
663 }
664
David Chisnallfa35df62012-01-16 17:27:18 +0000665 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000666}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000667
John McCalld4631322011-06-17 06:42:21 +0000668/// EmitScalarInit - Initialize the given lvalue with the given object.
669void CodeGenFunction::EmitScalarInit(llvm::Value *init, LValue lvalue) {
670 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
671 if (!lifetime)
David Chisnallfa35df62012-01-16 17:27:18 +0000672 return EmitStoreThroughLValue(RValue::get(init), lvalue, true);
John McCalld4631322011-06-17 06:42:21 +0000673
674 switch (lifetime) {
675 case Qualifiers::OCL_None:
676 llvm_unreachable("present but none");
677
678 case Qualifiers::OCL_ExplicitNone:
679 // nothing to do
680 break;
681
682 case Qualifiers::OCL_Strong:
683 init = EmitARCRetain(lvalue.getType(), init);
684 break;
685
686 case Qualifiers::OCL_Weak:
687 // Initialize and then skip the primitive store.
688 EmitARCInitWeak(lvalue.getAddress(), init);
689 return;
690
691 case Qualifiers::OCL_Autoreleasing:
692 init = EmitARCRetainAutorelease(lvalue.getType(), init);
693 break;
694 }
695
David Chisnallfa35df62012-01-16 17:27:18 +0000696 EmitStoreOfScalar(init, lvalue, /* isInitialization */ true);
John McCalld4631322011-06-17 06:42:21 +0000697}
698
Chris Lattnerb85025f2010-12-01 02:05:19 +0000699/// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the
700/// non-zero parts of the specified initializer with equal or fewer than
701/// NumStores scalar stores.
702static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init,
703 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000704 // Zero and Undef never requires any extra stores.
705 if (isa<llvm::ConstantAggregateZero>(Init) ||
706 isa<llvm::ConstantPointerNull>(Init) ||
707 isa<llvm::UndefValue>(Init))
708 return true;
709 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
710 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
711 isa<llvm::ConstantExpr>(Init))
712 return Init->isNullValue() || NumStores--;
713
714 // See if we can emit each element.
715 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
716 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
717 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
718 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
719 return false;
720 }
721 return true;
722 }
Chris Lattner236b3572012-01-31 04:36:19 +0000723
724 if (llvm::ConstantDataSequential *CDS =
725 dyn_cast<llvm::ConstantDataSequential>(Init)) {
726 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
727 llvm::Constant *Elt = CDS->getElementAsConstant(i);
728 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
729 return false;
730 }
731 return true;
732 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000733
Chris Lattnerb85025f2010-12-01 02:05:19 +0000734 // Anything else is hard and scary.
735 return false;
736}
737
738/// emitStoresForInitAfterMemset - For inits that
739/// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar
740/// stores that would be required.
741static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc,
John McCallc533cb72011-02-22 06:44:22 +0000742 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000743 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
744 "called emitStoresForInitAfterMemset for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000745
Chris Lattnere6af8862010-12-02 01:58:41 +0000746 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
747 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
748 isa<llvm::ConstantExpr>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000749 Builder.CreateStore(Init, Loc, isVolatile);
750 return;
751 }
752
753 if (llvm::ConstantDataSequential *CDS =
754 dyn_cast<llvm::ConstantDataSequential>(Init)) {
755 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
756 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000757
758 // If necessary, get a pointer to the element and emit it.
759 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
760 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
761 isVolatile, Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000762 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000763 return;
764 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000765
Chris Lattnere6af8862010-12-02 01:58:41 +0000766 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
767 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000768
Chris Lattnere6af8862010-12-02 01:58:41 +0000769 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
770 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000771
772 // If necessary, get a pointer to the element and emit it.
773 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
774 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
775 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000776 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000777}
778
779
780/// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset
781/// plus some stores to initialize a local variable instead of using a memcpy
782/// from a constant global. It is beneficial to use memset if the global is all
783/// zeros, or mostly zeros and large.
784static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init,
785 uint64_t GlobalSize) {
786 // If a global is all zeros, always use a memset.
787 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
788
Chris Lattnerb85025f2010-12-01 02:05:19 +0000789 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
790 // do it if it will require 6 or fewer scalar stores.
791 // TODO: Should budget depends on the size? Avoiding a large global warrants
792 // plopping in more stores.
793 unsigned StoreBudget = 6;
794 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000795
796 return GlobalSize > SizeLimit &&
Chris Lattnerb85025f2010-12-01 02:05:19 +0000797 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget);
798}
799
Nadav Rotem1da30942013-03-23 06:43:35 +0000800/// Should we use the LLVM lifetime intrinsics for the given local variable?
801static bool shouldUseLifetimeMarkers(CodeGenFunction &CGF, const VarDecl &D,
802 unsigned Size) {
Alexey Samsonov262f05b2013-04-02 13:19:46 +0000803 // Always emit lifetime markers in -fsanitize=use-after-scope mode.
804 if (CGF.getLangOpts().Sanitize.UseAfterScope)
805 return true;
Nadav Rotem1da30942013-03-23 06:43:35 +0000806 // For now, only in optimized builds.
807 if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0)
808 return false;
809
810 // Limit the size of marked objects to 32 bytes. We don't want to increase
811 // compile time by marking tiny objects.
812 unsigned SizeThreshold = 32;
813
814 return Size > SizeThreshold;
815}
816
Chris Lattnerb85025f2010-12-01 02:05:19 +0000817
Nick Lewycky8a7d90b2010-12-30 20:21:55 +0000818/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +0000819/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +0000820/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +0000821void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
822 AutoVarEmission emission = EmitAutoVarAlloca(D);
823 EmitAutoVarInit(emission);
824 EmitAutoVarCleanups(emission);
825}
Chris Lattner03df1222007-06-02 04:53:11 +0000826
John McCallc533cb72011-02-22 06:44:22 +0000827/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000828/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +0000829CodeGenFunction::AutoVarEmission
830CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
831 QualType Ty = D.getType();
832
833 AutoVarEmission emission(D);
834
835 bool isByRef = D.hasAttr<BlocksAttr>();
836 emission.IsByRef = isByRef;
837
838 CharUnits alignment = getContext().getDeclAlign(&D);
839 emission.Alignment = alignment;
840
John McCall23c29fe2011-06-24 21:55:10 +0000841 // If the type is variably-modified, emit all the VLA sizes for it.
842 if (Ty->isVariablyModifiedType())
843 EmitVariablyModifiedType(Ty);
844
Chris Lattner03df1222007-06-02 04:53:11 +0000845 llvm::Value *DeclPtr;
Eli Friedmana682d392008-02-15 12:20:59 +0000846 if (Ty->isConstantSizeType()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +0000847 bool NRVO = getLangOpts().ElideConstructors &&
848 D.isNRVOVariable();
John McCallc533cb72011-02-22 06:44:22 +0000849
Richard Smith2bcde3a2013-06-02 00:09:52 +0000850 // If this value is an array or struct with a statically determinable
851 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +0000852 //
853 // TODO: We should constant-evaluate the initializer of any variable,
854 // as long as it is initialized by a constant expression. Currently,
855 // isConstantInitializer produces wrong answers for structs with
856 // reference or bitfield members, and a few other cases, and checking
857 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +0000858 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
859 (D.isConstexpr() ||
860 ((Ty.isPODType(getContext()) ||
861 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
862 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +0000863
Rafael Espindola609f5d92013-03-26 18:41:47 +0000864 // If the variable's a const type, and it's neither an NRVO
865 // candidate nor a __block variable and has no mutable members,
866 // emit it as a global instead.
867 if (CGM.getCodeGenOpts().MergeAllConstants && !NRVO && !isByRef &&
868 CGM.isTypeConstant(Ty, true)) {
869 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +0000870
Craig Topper8a13c412014-05-21 05:09:00 +0000871 emission.Address = nullptr; // signal this condition to later callbacks
Rafael Espindola609f5d92013-03-26 18:41:47 +0000872 assert(emission.wasEmittedAsGlobal());
873 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +0000874 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000875
Rafael Espindola609f5d92013-03-26 18:41:47 +0000876 // Otherwise, tell the initialization code that we're in this case.
877 emission.IsConstantAggregate = true;
878 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000879
Rafael Espindola609f5d92013-03-26 18:41:47 +0000880 // A normal fixed sized variable becomes an alloca in the entry block,
881 // unless it's an NRVO variable.
882 llvm::Type *LTy = ConvertTypeForMem(Ty);
Eric Christopher31ab1302011-08-23 22:38:00 +0000883
Rafael Espindola609f5d92013-03-26 18:41:47 +0000884 if (NRVO) {
885 // The named return value optimization: allocate this variable in the
886 // return slot, so that we can elide the copy when returning this
887 // variable (C++0x [class.copy]p34).
888 DeclPtr = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +0000889
Rafael Espindola609f5d92013-03-26 18:41:47 +0000890 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
891 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) {
892 // Create a flag that is used to indicate when the NRVO was applied
893 // to this variable. Set it to zero to indicate that NRVO was not
894 // applied.
895 llvm::Value *Zero = Builder.getFalse();
896 llvm::Value *NRVOFlag = CreateTempAlloca(Zero->getType(), "nrvo");
897 EnsureInsertPoint();
898 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +0000899
Rafael Espindola609f5d92013-03-26 18:41:47 +0000900 // Record the NRVO flag for this variable.
901 NRVOFlags[&D] = NRVOFlag;
902 emission.NRVOFlag = NRVOFlag;
Nadav Rotem1da30942013-03-23 06:43:35 +0000903 }
Douglas Gregor290c93e2010-05-15 06:46:45 +0000904 }
Chris Lattnerb781dc792008-05-08 05:58:21 +0000905 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +0000906 if (isByRef)
907 LTy = BuildByRefType(&D);
908
909 llvm::AllocaInst *Alloc = CreateTempAlloca(LTy);
910 Alloc->setName(D.getName());
911
912 CharUnits allocaAlignment = alignment;
913 if (isByRef)
914 allocaAlignment = std::max(allocaAlignment,
John McCallc8e01702013-04-16 22:48:15 +0000915 getContext().toCharUnitsFromBits(getTarget().getPointerAlign(0)));
Rafael Espindola609f5d92013-03-26 18:41:47 +0000916 Alloc->setAlignment(allocaAlignment.getQuantity());
917 DeclPtr = Alloc;
918
919 // Emit a lifetime intrinsic if meaningful. There's no point
920 // in doing this if we don't have a valid insertion point (?).
921 uint64_t size = CGM.getDataLayout().getTypeAllocSize(LTy);
922 if (HaveInsertPoint() && shouldUseLifetimeMarkers(*this, D, size)) {
923 llvm::Value *sizeV = llvm::ConstantInt::get(Int64Ty, size);
924
925 emission.SizeForLifetimeMarkers = sizeV;
926 llvm::Value *castAddr = Builder.CreateBitCast(Alloc, Int8PtrTy);
927 Builder.CreateCall2(CGM.getLLVMLifetimeStartFn(), sizeV, castAddr)
928 ->setDoesNotThrow();
929 } else {
930 assert(!emission.useLifetimeMarkers());
931 }
Chris Lattnerb781dc792008-05-08 05:58:21 +0000932 }
Chris Lattner03df1222007-06-02 04:53:11 +0000933 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +0000934 EnsureInsertPoint();
935
Anders Carlsson15949b32009-02-09 20:41:50 +0000936 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +0000937 // Save the stack.
John McCallad7c5c12011-02-08 08:22:06 +0000938 llvm::Value *Stack = CreateTempAlloca(Int8PtrTy, "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +0000939
Anders Carlsson30032882008-12-12 07:38:43 +0000940 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
941 llvm::Value *V = Builder.CreateCall(F);
Mike Stump11289f42009-09-09 15:08:12 +0000942
Anders Carlsson30032882008-12-12 07:38:43 +0000943 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +0000944
945 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +0000946
John McCalla464ff92010-07-21 06:13:08 +0000947 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +0000948 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000949 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +0000950 }
Mike Stump11289f42009-09-09 15:08:12 +0000951
John McCall23c29fe2011-06-24 21:55:10 +0000952 llvm::Value *elementCount;
953 QualType elementType;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000954 std::tie(elementCount, elementType) = getVLASize(Ty);
Anders Carlsson30032882008-12-12 07:38:43 +0000955
Chris Lattner2192fe52011-07-18 04:24:23 +0000956 llvm::Type *llvmTy = ConvertTypeForMem(elementType);
Anders Carlsson30032882008-12-12 07:38:43 +0000957
958 // Allocate memory for the array.
John McCall23c29fe2011-06-24 21:55:10 +0000959 llvm::AllocaInst *vla = Builder.CreateAlloca(llvmTy, elementCount, "vla");
960 vla->setAlignment(alignment.getQuantity());
Anders Carlssone33eed52009-09-26 18:16:06 +0000961
John McCall23c29fe2011-06-24 21:55:10 +0000962 DeclPtr = vla;
Chris Lattner03df1222007-06-02 04:53:11 +0000963 }
Eli Friedmanf4084702008-12-20 23:11:59 +0000964
Chris Lattner03df1222007-06-02 04:53:11 +0000965 llvm::Value *&DMEntry = LocalDeclMap[&D];
Craig Topper8a13c412014-05-21 05:09:00 +0000966 assert(!DMEntry && "Decl already exists in localdeclmap!");
Chris Lattner03df1222007-06-02 04:53:11 +0000967 DMEntry = DeclPtr;
John McCallc533cb72011-02-22 06:44:22 +0000968 emission.Address = DeclPtr;
Sanjiv Gupta18de6242008-05-30 10:30:31 +0000969
970 // Emit debug info for local var declaration.
Devang Patel887e2152011-06-03 19:21:47 +0000971 if (HaveInsertPoint())
972 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregorb0eea8b2012-10-23 20:05:01 +0000973 if (CGM.getCodeGenOpts().getDebugInfo()
974 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonov74a38682012-05-04 07:39:27 +0000975 DI->setLocation(D.getLocation());
Rafael Espindola609f5d92013-03-26 18:41:47 +0000976 DI->EmitDeclareOfAutoVariable(&D, DeclPtr, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +0000977 }
Devang Patel887e2152011-06-03 19:21:47 +0000978 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +0000979
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000980 if (D.hasAttr<AnnotateAttr>())
981 EmitVarAnnotations(&D, emission.Address);
982
John McCallc533cb72011-02-22 06:44:22 +0000983 return emission;
984}
985
986/// Determines whether the given __block variable is potentially
987/// captured by the given expression.
988static bool isCapturedBy(const VarDecl &var, const Expr *e) {
989 // Skip the most common kinds of expressions that make
990 // hierarchy-walking expensive.
991 e = e->IgnoreParenCasts();
992
993 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
994 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000995 for (const auto &I : block->captures()) {
996 if (I.getVariable() == &var)
John McCallc533cb72011-02-22 06:44:22 +0000997 return true;
998 }
999
1000 // No need to walk into the subexpressions.
1001 return false;
1002 }
1003
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001004 if (const StmtExpr *SE = dyn_cast<StmtExpr>(e)) {
1005 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001006 for (const auto *BI : CS->body())
1007 if (const auto *E = dyn_cast<Expr>(BI)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001008 if (isCapturedBy(var, E))
1009 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001010 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001011 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001012 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001013 for (const auto *I : DS->decls()) {
1014 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1015 const Expr *Init = VD->getInit();
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001016 if (Init && isCapturedBy(var, Init))
1017 return true;
1018 }
1019 }
1020 }
1021 else
1022 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1023 // Later, provide code to poke into statements for capture analysis.
1024 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001025 return false;
1026 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001027
John McCallc533cb72011-02-22 06:44:22 +00001028 for (Stmt::const_child_range children = e->children(); children; ++children)
1029 if (isCapturedBy(var, cast<Expr>(*children)))
1030 return true;
1031
1032 return false;
1033}
1034
Douglas Gregor82e1af22011-07-01 21:08:19 +00001035/// \brief Determine whether the given initializer is trivial in the sense
1036/// that it requires no code to be generated.
1037static bool isTrivialInitializer(const Expr *Init) {
1038 if (!Init)
1039 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001040
Douglas Gregor82e1af22011-07-01 21:08:19 +00001041 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1042 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1043 if (Constructor->isTrivial() &&
1044 Constructor->isDefaultConstructor() &&
1045 !Construct->requiresZeroInitialization())
1046 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001047
Douglas Gregor82e1af22011-07-01 21:08:19 +00001048 return false;
1049}
John McCallc533cb72011-02-22 06:44:22 +00001050void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001051 assert(emission.Variable && "emission was not valid!");
1052
John McCallc533cb72011-02-22 06:44:22 +00001053 // If this was emitted as a global constant, we're done.
1054 if (emission.wasEmittedAsGlobal()) return;
1055
John McCall9e2e22f2011-02-22 07:16:58 +00001056 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001057 QualType type = D.getType();
1058
Chris Lattner07eb7332007-07-12 00:39:48 +00001059 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001060 const Expr *Init = D.getInit();
1061
1062 // If we are at an unreachable point, we don't need to emit the initializer
1063 // unless it contains a label.
1064 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001065 if (!Init || !ContainsLabel(Init)) return;
1066 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001067 }
1068
John McCall73064872011-03-31 01:59:53 +00001069 // Initialize the structure of a __block variable.
1070 if (emission.IsByRef)
1071 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001072
Douglas Gregor82e1af22011-07-01 21:08:19 +00001073 if (isTrivialInitializer(Init))
1074 return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001075
John McCall73064872011-03-31 01:59:53 +00001076 CharUnits alignment = emission.Alignment;
1077
John McCallc533cb72011-02-22 06:44:22 +00001078 // Check whether this is a byref variable that's potentially
1079 // captured and moved by its own initializer. If so, we'll need to
1080 // emit the initializer first, then copy into the variable.
1081 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init);
1082
1083 llvm::Value *Loc =
1084 capturedByInit ? emission.Address : emission.getObjectAddress(*this);
1085
Craig Topper8a13c412014-05-21 05:09:00 +00001086 llvm::Constant *constant = nullptr;
Richard Smith2bcde3a2013-06-02 00:09:52 +00001087 if (emission.IsConstantAggregate || D.isConstexpr()) {
Richard Smithfddd3842011-12-30 21:15:51 +00001088 assert(!capturedByInit && "constant init contains a capturing block?");
Richard Smithdafff942012-01-14 04:30:29 +00001089 constant = CGM.EmitConstantInit(D, this);
Richard Smithfddd3842011-12-30 21:15:51 +00001090 }
1091
1092 if (!constant) {
Eli Friedmana0544d62011-12-03 04:14:32 +00001093 LValue lv = MakeAddrLValue(Loc, type, alignment);
John McCall1553b192011-06-16 04:16:24 +00001094 lv.setNonGC(true);
1095 return EmitExprAsInit(Init, &D, lv, capturedByInit);
1096 }
John McCall91ca10f2011-03-08 09:11:50 +00001097
Richard Smith2bcde3a2013-06-02 00:09:52 +00001098 if (!emission.IsConstantAggregate) {
1099 // For simple scalar/complex initialization, store the value directly.
1100 LValue lv = MakeAddrLValue(Loc, type, alignment);
1101 lv.setNonGC(true);
1102 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1103 }
1104
John McCallc533cb72011-02-22 06:44:22 +00001105 // If this is a simple aggregate initialization, we can optimize it
1106 // in various ways.
John McCall91ca10f2011-03-08 09:11:50 +00001107 bool isVolatile = type.isVolatileQualified();
John McCallc533cb72011-02-22 06:44:22 +00001108
John McCall91ca10f2011-03-08 09:11:50 +00001109 llvm::Value *SizeVal =
Eric Christopher31ab1302011-08-23 22:38:00 +00001110 llvm::ConstantInt::get(IntPtrTy,
John McCall91ca10f2011-03-08 09:11:50 +00001111 getContext().getTypeSizeInChars(type).getQuantity());
John McCallc533cb72011-02-22 06:44:22 +00001112
Chris Lattner2192fe52011-07-18 04:24:23 +00001113 llvm::Type *BP = Int8PtrTy;
John McCall91ca10f2011-03-08 09:11:50 +00001114 if (Loc->getType() != BP)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001115 Loc = Builder.CreateBitCast(Loc, BP);
Mon P Wangcc2ab0c2010-04-04 03:10:52 +00001116
John McCall91ca10f2011-03-08 09:11:50 +00001117 // If the initializer is all or mostly zeros, codegen with memset then do
1118 // a few stores afterward.
Eric Christopher31ab1302011-08-23 22:38:00 +00001119 if (shouldUseMemSetPlusStoresToInitialize(constant,
Micah Villmowdd31ca12012-10-08 16:25:52 +00001120 CGM.getDataLayout().getTypeAllocSize(constant->getType()))) {
John McCall91ca10f2011-03-08 09:11:50 +00001121 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1122 alignment.getQuantity(), isVolatile);
Benjamin Kramer29f9a002012-08-27 22:07:02 +00001123 // Zero and undef don't require a stores.
1124 if (!constant->isNullValue() && !isa<llvm::UndefValue>(constant)) {
John McCall91ca10f2011-03-08 09:11:50 +00001125 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo());
1126 emitStoresForInitAfterMemset(constant, Loc, isVolatile, Builder);
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001127 }
John McCall91ca10f2011-03-08 09:11:50 +00001128 } else {
Eric Christopher31ab1302011-08-23 22:38:00 +00001129 // Otherwise, create a temporary global with the initializer then
John McCall91ca10f2011-03-08 09:11:50 +00001130 // memcpy from the global to the alloca.
1131 std::string Name = GetStaticDeclName(*this, D, ".");
1132 llvm::GlobalVariable *GV =
1133 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true,
Eric Christopherb58b3e82011-08-24 00:33:55 +00001134 llvm::GlobalValue::PrivateLinkage,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +00001135 constant, Name);
John McCall91ca10f2011-03-08 09:11:50 +00001136 GV->setAlignment(alignment.getQuantity());
Eli Friedmanb8578422011-05-27 22:32:55 +00001137 GV->setUnnamedAddr(true);
Eric Christopher31ab1302011-08-23 22:38:00 +00001138
John McCall91ca10f2011-03-08 09:11:50 +00001139 llvm::Value *SrcPtr = GV;
1140 if (SrcPtr->getType() != BP)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001141 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
John McCall91ca10f2011-03-08 09:11:50 +00001142
1143 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, alignment.getQuantity(),
1144 isVolatile);
1145 }
1146}
1147
1148/// Emit an expression as an initializer for a variable at the given
1149/// location. The expression is not necessarily the normal
1150/// initializer for the variable, and the address is not necessarily
1151/// its normal location.
1152///
1153/// \param init the initializing expression
1154/// \param var the variable to act as if we're initializing
1155/// \param loc the address to initialize; its type is a pointer
1156/// to the LLVM mapping of the variable's type
1157/// \param alignment the alignment of the address
1158/// \param capturedByInit true if the variable is a __block variable
1159/// whose address is potentially changed by the initializer
1160void CodeGenFunction::EmitExprAsInit(const Expr *init,
John McCall31168b02011-06-15 23:02:42 +00001161 const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001162 LValue lvalue,
John McCall91ca10f2011-03-08 09:11:50 +00001163 bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001164 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001165
1166 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001167 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001168 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001169 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Chisnallfa35df62012-01-16 17:27:18 +00001170 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001171 return;
1172 }
1173 switch (getEvaluationKind(type)) {
1174 case TEK_Scalar:
John McCall1553b192011-06-16 04:16:24 +00001175 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001176 return;
1177 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001178 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001179 if (capturedByInit)
1180 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall47fb9502013-03-07 21:37:08 +00001181 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
1182 return;
1183 }
1184 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001185 if (type->isAtomicType()) {
1186 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1187 } else {
1188 // TODO: how can we delay here if D is captured by its initializer?
1189 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001190 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001191 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001192 AggValueSlot::IsNotAliased));
John McCalla8ec7eb2013-03-07 21:37:17 +00001193 }
John McCall47fb9502013-03-07 21:37:08 +00001194 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001195 }
John McCall47fb9502013-03-07 21:37:08 +00001196 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001197}
John McCallbd309292010-07-06 01:34:17 +00001198
John McCall82fe67b2011-07-09 01:37:26 +00001199/// Enter a destroy cleanup for the given local variable.
1200void CodeGenFunction::emitAutoVarTypeCleanup(
1201 const CodeGenFunction::AutoVarEmission &emission,
1202 QualType::DestructionKind dtorKind) {
1203 assert(dtorKind != QualType::DK_none);
1204
1205 // Note that for __block variables, we want to destroy the
1206 // original stack object, not the possibly forwarded object.
1207 llvm::Value *addr = emission.getObjectAddress(*this);
1208
1209 const VarDecl *var = emission.Variable;
1210 QualType type = var->getType();
1211
1212 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001213 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001214
1215 switch (dtorKind) {
1216 case QualType::DK_none:
1217 llvm_unreachable("no cleanup for trivially-destructible variable");
1218
1219 case QualType::DK_cxx_destructor:
1220 // If there's an NRVO flag on the emission, we need a different
1221 // cleanup.
1222 if (emission.NRVOFlag) {
1223 assert(!type->isArrayType());
1224 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
1225 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr, dtor,
1226 emission.NRVOFlag);
1227 return;
1228 }
1229 break;
1230
1231 case QualType::DK_objc_strong_lifetime:
1232 // Suppress cleanups for pseudo-strong variables.
1233 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001234
John McCall82fe67b2011-07-09 01:37:26 +00001235 // Otherwise, consider whether to use an EH cleanup or not.
1236 cleanupKind = getARCCleanupKind();
1237
1238 // Use the imprecise destroyer by default.
1239 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1240 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1241 break;
1242
1243 case QualType::DK_objc_weak_lifetime:
1244 break;
1245 }
1246
1247 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001248 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001249
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001250 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001251 // is being pushed as an EH cleanup.
1252 bool useEHCleanup = (cleanupKind & EHCleanup);
1253 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1254 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001255}
1256
John McCallc533cb72011-02-22 06:44:22 +00001257void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001258 assert(emission.Variable && "emission was not valid!");
1259
John McCallc533cb72011-02-22 06:44:22 +00001260 // If this was emitted as a global constant, we're done.
1261 if (emission.wasEmittedAsGlobal()) return;
1262
John McCall8c38d352012-04-13 18:44:05 +00001263 // If we don't have an insertion point, we're done. Sema prevents
1264 // us from jumping into any of these scopes anyway.
1265 if (!HaveInsertPoint()) return;
1266
John McCall9e2e22f2011-02-22 07:16:58 +00001267 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001268
Nadav Rotem1da30942013-03-23 06:43:35 +00001269 // Make sure we call @llvm.lifetime.end. This needs to happen
1270 // *last*, so the cleanup needs to be pushed *first*.
1271 if (emission.useLifetimeMarkers()) {
1272 EHStack.pushCleanup<CallLifetimeEnd>(NormalCleanup,
1273 emission.getAllocatedAddress(),
1274 emission.getSizeForLifetimeMarkers());
1275 }
1276
John McCall82fe67b2011-07-09 01:37:26 +00001277 // Check the type for a cleanup.
1278 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1279 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001280
John McCall1bd25562011-06-24 23:21:27 +00001281 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001282 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001283 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1284 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1285 }
1286
John McCallc533cb72011-02-22 06:44:22 +00001287 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001288 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001289 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00001290
John McCallc533cb72011-02-22 06:44:22 +00001291 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001292 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00001293
John McCalla729c622012-02-17 03:33:10 +00001294 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00001295 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001296 }
Mike Stump626aecc2009-03-05 01:23:13 +00001297
John McCallc533cb72011-02-22 06:44:22 +00001298 // If this is a block variable, call _Block_object_destroy
1299 // (on the unforwarded address).
John McCall73064872011-03-31 01:59:53 +00001300 if (emission.IsByRef)
1301 enterByrefCleanup(emission);
Chris Lattner03df1222007-06-02 04:53:11 +00001302}
Chris Lattner53621a52007-06-13 20:44:40 +00001303
Peter Collingbourne1425b452012-01-26 03:33:36 +00001304CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00001305CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
1306 switch (kind) {
1307 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00001308 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001309 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00001310 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001311 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00001312 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001313 return destroyARCWeak;
John McCall82fe67b2011-07-09 01:37:26 +00001314 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00001315 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00001316}
1317
John McCall12cc42a2013-02-01 05:11:40 +00001318/// pushEHDestroy - Push the standard destructor for the given type as
1319/// an EH-only cleanup.
1320void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
1321 llvm::Value *addr, QualType type) {
1322 assert(dtorKind && "cannot push destructor for trivial type");
1323 assert(needsEHCleanup(dtorKind));
1324
1325 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
1326}
1327
1328/// pushDestroy - Push the standard destructor for the given type as
1329/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00001330void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
1331 llvm::Value *addr, QualType type) {
1332 assert(dtorKind && "cannot push destructor for trivial type");
1333
1334 CleanupKind cleanupKind = getCleanupKind(dtorKind);
1335 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
1336 cleanupKind & EHCleanup);
1337}
1338
John McCall82fe67b2011-07-09 01:37:26 +00001339void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, llvm::Value *addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001340 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001341 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00001342 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
1343 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001344}
1345
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001346void CodeGenFunction::pushStackRestore(CleanupKind Kind, llvm::Value *SPMem) {
1347 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
1348}
1349
Richard Smith736a9472013-06-12 20:42:33 +00001350void CodeGenFunction::pushLifetimeExtendedDestroy(
1351 CleanupKind cleanupKind, llvm::Value *addr, QualType type,
1352 Destroyer *destroyer, bool useEHCleanupForArray) {
1353 assert(!isInConditionalBranch() &&
1354 "performing lifetime extension from within conditional");
1355
1356 // Push an EH-only cleanup for the object now.
1357 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
1358 // around in case a temporary's destructor throws an exception.
1359 if (cleanupKind & EHCleanup)
1360 EHStack.pushCleanup<DestroyObject>(
1361 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
1362 destroyer, useEHCleanupForArray);
1363
1364 // Remember that we need to push a full cleanup for the object at the
1365 // end of the full-expression.
1366 pushCleanupAfterFullExpr<DestroyObject>(
1367 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
1368}
1369
John McCall178360e2011-07-11 08:38:19 +00001370/// emitDestroy - Immediately perform the destruction of the given
1371/// object.
1372///
1373/// \param addr - the address of the object; a type*
1374/// \param type - the type of the object; if an array type, all
1375/// objects are destroyed in reverse order
1376/// \param destroyer - the function to call to destroy individual
1377/// elements
1378/// \param useEHCleanupForArray - whether an EH cleanup should be
1379/// used when destroying array elements, in case one of the
1380/// destructions throws an exception
John McCall82fe67b2011-07-09 01:37:26 +00001381void CodeGenFunction::emitDestroy(llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001382 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001383 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00001384 const ArrayType *arrayType = getContext().getAsArrayType(type);
1385 if (!arrayType)
1386 return destroyer(*this, addr, type);
1387
1388 llvm::Value *begin = addr;
1389 llvm::Value *length = emitArrayLength(arrayType, type, begin);
John McCall97eab0a2011-07-13 08:09:46 +00001390
1391 // Normally we have to check whether the array is zero-length.
1392 bool checkZeroLength = true;
1393
1394 // But if the array length is constant, we can suppress that.
1395 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
1396 // ...and if it's constant zero, we can just skip the entire thing.
1397 if (constLength->isZero()) return;
1398 checkZeroLength = false;
1399 }
1400
John McCall82fe67b2011-07-09 01:37:26 +00001401 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall97eab0a2011-07-13 08:09:46 +00001402 emitArrayDestroy(begin, end, type, destroyer,
1403 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001404}
1405
John McCall178360e2011-07-11 08:38:19 +00001406/// emitArrayDestroy - Destroys all the elements of the given array,
1407/// beginning from last to first. The array cannot be zero-length.
1408///
1409/// \param begin - a type* denoting the first element of the array
1410/// \param end - a type* denoting one past the end of the array
1411/// \param type - the element type of the array
1412/// \param destroyer - the function to call to destroy elements
1413/// \param useEHCleanup - whether to push an EH cleanup to destroy
1414/// the remaining elements in case the destruction of a single
1415/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00001416void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
1417 llvm::Value *end,
1418 QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001419 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001420 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00001421 bool useEHCleanup) {
John McCall82fe67b2011-07-09 01:37:26 +00001422 assert(!type->isArrayType());
1423
1424 // The basic structure here is a do-while loop, because we don't
1425 // need to check for the zero-element case.
1426 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
1427 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
1428
John McCall97eab0a2011-07-13 08:09:46 +00001429 if (checkZeroLength) {
1430 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
1431 "arraydestroy.isempty");
1432 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
1433 }
1434
John McCall82fe67b2011-07-09 01:37:26 +00001435 // Enter the loop body, making that address the current address.
1436 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1437 EmitBlock(bodyBB);
1438 llvm::PHINode *elementPast =
1439 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
1440 elementPast->addIncoming(end, entryBB);
1441
1442 // Shift the address back by one element.
1443 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
1444 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
1445 "arraydestroy.element");
1446
John McCall178360e2011-07-11 08:38:19 +00001447 if (useEHCleanup)
1448 pushRegularPartialArrayCleanup(begin, element, type, destroyer);
1449
John McCall82fe67b2011-07-09 01:37:26 +00001450 // Perform the actual destruction there.
1451 destroyer(*this, element, type);
1452
John McCall178360e2011-07-11 08:38:19 +00001453 if (useEHCleanup)
1454 PopCleanupBlock();
1455
John McCall82fe67b2011-07-09 01:37:26 +00001456 // Check whether we've reached the end.
1457 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
1458 Builder.CreateCondBr(done, doneBB, bodyBB);
1459 elementPast->addIncoming(element, Builder.GetInsertBlock());
1460
1461 // Done.
1462 EmitBlock(doneBB);
1463}
1464
John McCall178360e2011-07-11 08:38:19 +00001465/// Perform partial array destruction as if in an EH cleanup. Unlike
1466/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00001467static void emitPartialArrayDestroy(CodeGenFunction &CGF,
1468 llvm::Value *begin, llvm::Value *end,
1469 QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001470 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00001471 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00001472 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00001473 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
1474 // VLAs don't require a GEP index to walk into.
1475 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00001476 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00001477 type = arrayType->getElementType();
1478 }
John McCall97eab0a2011-07-13 08:09:46 +00001479
1480 if (arrayDepth) {
1481 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, arrayDepth+1);
1482
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001483 SmallVector<llvm::Value*,4> gepIndices(arrayDepth, zero);
Jay Foad040dd822011-07-22 08:16:57 +00001484 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
1485 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00001486 }
1487
John McCall97eab0a2011-07-13 08:09:46 +00001488 // Destroy the array. We don't ever need an EH cleanup because we
1489 // assume that we're in an EH cleanup ourselves, so a throwing
1490 // destructor causes an immediate terminate.
1491 CGF.emitArrayDestroy(begin, end, type, destroyer,
1492 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00001493}
1494
John McCall82fe67b2011-07-09 01:37:26 +00001495namespace {
John McCall178360e2011-07-11 08:38:19 +00001496 /// RegularPartialArrayDestroy - a cleanup which performs a partial
1497 /// array destroy where the end pointer is regularly determined and
1498 /// does not need to be loaded from a local.
1499 class RegularPartialArrayDestroy : public EHScopeStack::Cleanup {
1500 llvm::Value *ArrayBegin;
1501 llvm::Value *ArrayEnd;
1502 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001503 CodeGenFunction::Destroyer *Destroyer;
John McCall178360e2011-07-11 08:38:19 +00001504 public:
1505 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
1506 QualType elementType,
1507 CodeGenFunction::Destroyer *destroyer)
1508 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
Peter Collingbourne1425b452012-01-26 03:33:36 +00001509 ElementType(elementType), Destroyer(destroyer) {}
John McCall178360e2011-07-11 08:38:19 +00001510
Craig Topper4f12f102014-03-12 06:41:41 +00001511 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00001512 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
1513 ElementType, Destroyer);
1514 }
1515 };
1516
1517 /// IrregularPartialArrayDestroy - a cleanup which performs a
1518 /// partial array destroy where the end pointer is irregularly
1519 /// determined and must be loaded from a local.
1520 class IrregularPartialArrayDestroy : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00001521 llvm::Value *ArrayBegin;
1522 llvm::Value *ArrayEndPointer;
1523 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001524 CodeGenFunction::Destroyer *Destroyer;
John McCall82fe67b2011-07-09 01:37:26 +00001525 public:
John McCall178360e2011-07-11 08:38:19 +00001526 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
1527 llvm::Value *arrayEndPointer,
1528 QualType elementType,
1529 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00001530 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
Peter Collingbourne1425b452012-01-26 03:33:36 +00001531 ElementType(elementType), Destroyer(destroyer) {}
John McCall82fe67b2011-07-09 01:37:26 +00001532
Craig Topper4f12f102014-03-12 06:41:41 +00001533 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00001534 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00001535 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
1536 ElementType, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001537 }
1538 };
1539}
1540
John McCall178360e2011-07-11 08:38:19 +00001541/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00001542/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00001543/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00001544///
John McCall82fe67b2011-07-09 01:37:26 +00001545/// \param elementType - the immediate element type of the array;
1546/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00001547void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall178360e2011-07-11 08:38:19 +00001548 llvm::Value *arrayEndPointer,
1549 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001550 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00001551 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
1552 arrayBegin, arrayEndPointer,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001553 elementType, destroyer);
John McCall178360e2011-07-11 08:38:19 +00001554}
1555
1556/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
1557/// already-constructed elements of the given array. The cleanup
1558/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00001559///
John McCall178360e2011-07-11 08:38:19 +00001560/// \param elementType - the immediate element type of the array;
1561/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00001562void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1563 llvm::Value *arrayEnd,
1564 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001565 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00001566 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00001567 arrayBegin, arrayEnd,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001568 elementType, destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001569}
1570
Nadav Rotem1da30942013-03-23 06:43:35 +00001571/// Lazily declare the @llvm.lifetime.start intrinsic.
1572llvm::Constant *CodeGenModule::getLLVMLifetimeStartFn() {
1573 if (LifetimeStartFn) return LifetimeStartFn;
1574 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
1575 llvm::Intrinsic::lifetime_start);
1576 return LifetimeStartFn;
1577}
1578
1579/// Lazily declare the @llvm.lifetime.end intrinsic.
1580llvm::Constant *CodeGenModule::getLLVMLifetimeEndFn() {
1581 if (LifetimeEndFn) return LifetimeEndFn;
1582 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
1583 llvm::Intrinsic::lifetime_end);
1584 return LifetimeEndFn;
1585}
1586
John McCall31168b02011-06-15 23:02:42 +00001587namespace {
1588 /// A cleanup to perform a release of an object at the end of a
1589 /// function. This is used to balance out the incoming +1 of a
1590 /// ns_consumed argument when we can't reasonably do that just by
1591 /// not doing the initial retain for a __block argument.
1592 struct ConsumeARCParameter : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00001593 ConsumeARCParameter(llvm::Value *param,
1594 ARCPreciseLifetime_t precise)
1595 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00001596
1597 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00001598 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00001599
Craig Topper4f12f102014-03-12 06:41:41 +00001600 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00001601 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00001602 }
1603 };
1604}
1605
Mike Stump11289f42009-09-09 15:08:12 +00001606/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00001607/// for the specified parameter and set up LocalDeclMap.
Devang Patel68a15252011-03-03 20:13:15 +00001608void CodeGenFunction::EmitParmDecl(const VarDecl &D, llvm::Value *Arg,
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001609 bool ArgIsPointer, unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001610 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00001611 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001612 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00001613
1614 Arg->setName(D.getName());
1615
Adrian Prantl51936dd2013-03-14 17:53:33 +00001616 QualType Ty = D.getType();
1617
John McCall147d0212011-02-22 22:38:33 +00001618 // Use better IR generation for certain implicit parameters.
1619 if (isa<ImplicitParamDecl>(D)) {
1620 // The only implicit argument a block has is its literal.
1621 if (BlockInfo) {
1622 LocalDeclMap[&D] = Arg;
Craig Topper8a13c412014-05-21 05:09:00 +00001623 llvm::Value *LocalAddr = nullptr;
Adrian Prantl51936dd2013-03-14 17:53:33 +00001624 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
Adrian Prantl0f6df002013-03-29 19:20:35 +00001625 // Allocate a stack slot to let the debug info survive the RA.
Adrian Prantl51936dd2013-03-14 17:53:33 +00001626 llvm::AllocaInst *Alloc = CreateTempAlloca(ConvertTypeForMem(Ty),
1627 D.getName() + ".addr");
1628 Alloc->setAlignment(getContext().getDeclAlign(&D).getQuantity());
1629 LValue lv = MakeAddrLValue(Alloc, Ty, getContext().getDeclAlign(&D));
1630 EmitStoreOfScalar(Arg, lv, /* isInitialization */ true);
1631 LocalAddr = Builder.CreateLoad(Alloc);
1632 }
John McCall147d0212011-02-22 22:38:33 +00001633
1634 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregorb0eea8b2012-10-23 20:05:01 +00001635 if (CGM.getCodeGenOpts().getDebugInfo()
1636 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonov74a38682012-05-04 07:39:27 +00001637 DI->setLocation(D.getLocation());
Adrian Prantl51936dd2013-03-14 17:53:33 +00001638 DI->EmitDeclareOfBlockLiteralArgVariable(*BlockInfo, Arg, LocalAddr, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00001639 }
John McCall147d0212011-02-22 22:38:33 +00001640 }
1641
1642 return;
1643 }
1644 }
1645
Chris Lattner53621a52007-06-13 20:44:40 +00001646 llvm::Value *DeclPtr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001647 bool DoStore = false;
1648 bool IsScalar = hasScalarEvaluationKind(Ty);
1649 CharUnits Align = getContext().getDeclAlign(&D);
1650 // If we already have a pointer to the argument, reuse the input pointer.
1651 if (ArgIsPointer) {
Reid Kleckner5e8edba2014-04-02 00:16:53 +00001652 // If we have a prettier pointer type at this point, bitcast to that.
1653 unsigned AS = cast<llvm::PointerType>(Arg->getType())->getAddressSpace();
1654 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
1655 DeclPtr = Arg->getType() == IRTy ? Arg : Builder.CreateBitCast(Arg, IRTy,
1656 D.getName());
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00001657 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001658 if (!IsScalar &&
Reid Kleckner739756c2013-12-04 19:23:12 +00001659 getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001660 const CXXRecordDecl *RD = Ty->getAsCXXRecordDecl();
1661 if (RD && RD->hasNonTrivialDestructor())
1662 pushDestroy(QualType::DK_cxx_destructor, DeclPtr, Ty);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00001663 }
Chris Lattner53621a52007-06-13 20:44:40 +00001664 } else {
Daniel Dunbar3d33fab2010-02-08 22:53:07 +00001665 // Otherwise, create a temporary to hold the value.
Eli Friedmaneadd3e82011-11-03 20:31:28 +00001666 llvm::AllocaInst *Alloc = CreateTempAlloca(ConvertTypeForMem(Ty),
1667 D.getName() + ".addr");
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001668 Alloc->setAlignment(Align.getQuantity());
Eli Friedmaneadd3e82011-11-03 20:31:28 +00001669 DeclPtr = Alloc;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001670 DoStore = true;
1671 }
Mike Stump11289f42009-09-09 15:08:12 +00001672
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001673 LValue lv = MakeAddrLValue(DeclPtr, Ty, Align);
1674 if (IsScalar) {
John McCall31168b02011-06-15 23:02:42 +00001675 Qualifiers qs = Ty.getQualifiers();
John McCall31168b02011-06-15 23:02:42 +00001676 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
1677 // We honor __attribute__((ns_consumed)) for types with lifetime.
1678 // For __strong, it's handled by just skipping the initial retain;
1679 // otherwise we have to balance out the initial +1 with an extra
1680 // cleanup to do the release at the end of the function.
1681 bool isConsumed = D.hasAttr<NSConsumedAttr>();
1682
1683 // 'self' is always formally __strong, but if this is not an
1684 // init method then we don't want to retain it.
John McCalld4631322011-06-17 06:42:21 +00001685 if (D.isARCPseudoStrong()) {
John McCall31168b02011-06-15 23:02:42 +00001686 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl);
1687 assert(&D == method->getSelfDecl());
John McCalld4631322011-06-17 06:42:21 +00001688 assert(lt == Qualifiers::OCL_Strong);
1689 assert(qs.hasConst());
John McCall31168b02011-06-15 23:02:42 +00001690 assert(method->getMethodFamily() != OMF_init);
John McCall10123692011-06-15 23:40:09 +00001691 (void) method;
John McCall31168b02011-06-15 23:02:42 +00001692 lt = Qualifiers::OCL_ExplicitNone;
1693 }
1694
1695 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001696 if (!isConsumed) {
1697 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1698 // use objc_storeStrong(&dest, value) for retaining the
1699 // object. But first, store a null into 'dest' because
1700 // objc_storeStrong attempts to release its old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001701 llvm::Value *Null = CGM.EmitNullConstant(D.getType());
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001702 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
1703 EmitARCStoreStrongCall(lv.getAddress(), Arg, true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001704 DoStore = false;
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001705 }
1706 else
John McCall31168b02011-06-15 23:02:42 +00001707 // Don't use objc_retainBlock for block pointers, because we
1708 // don't want to Block_copy something just because we got it
1709 // as a parameter.
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001710 Arg = EmitARCRetainNonBlock(Arg);
1711 }
John McCall31168b02011-06-15 23:02:42 +00001712 } else {
1713 // Push the cleanup for a consumed parameter.
John McCallcdda29c2013-03-13 03:10:54 +00001714 if (isConsumed) {
1715 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
1716 ? ARCPreciseLifetime : ARCImpreciseLifetime);
1717 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), Arg,
1718 precise);
1719 }
John McCall31168b02011-06-15 23:02:42 +00001720
1721 if (lt == Qualifiers::OCL_Weak) {
1722 EmitARCInitWeak(DeclPtr, Arg);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001723 DoStore = false; // The weak init is a store, no need to do two.
John McCall31168b02011-06-15 23:02:42 +00001724 }
1725 }
1726
1727 // Enter the cleanup scope.
1728 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
1729 }
Chris Lattner53621a52007-06-13 20:44:40 +00001730 }
1731
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001732 // Store the initial value into the alloca.
1733 if (DoStore)
1734 EmitStoreOfScalar(Arg, lv, /* isInitialization */ true);
1735
Chris Lattner53621a52007-06-13 20:44:40 +00001736 llvm::Value *&DMEntry = LocalDeclMap[&D];
Craig Topper8a13c412014-05-21 05:09:00 +00001737 assert(!DMEntry && "Decl already exists in localdeclmap!");
Chris Lattner53621a52007-06-13 20:44:40 +00001738 DMEntry = DeclPtr;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001739
1740 // Emit debug info for param declaration.
Alexey Samsonov74a38682012-05-04 07:39:27 +00001741 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregorb0eea8b2012-10-23 20:05:01 +00001742 if (CGM.getCodeGenOpts().getDebugInfo()
1743 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonov74a38682012-05-04 07:39:27 +00001744 DI->EmitDeclareOfArgVariable(&D, DeclPtr, ArgNo, Builder);
1745 }
1746 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001747
1748 if (D.hasAttr<AnnotateAttr>())
1749 EmitVarAnnotations(&D, DeclPtr);
Chris Lattner53621a52007-06-13 20:44:40 +00001750}