blob: 9b22c7f95673ed055ac62154430f1cb67e74490a [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Decl nodes as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
Sanjiv Guptacc9b1632008-05-30 10:30:31 +000014#include "CGDebugInfo.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000015#include "CodeGenFunction.h"
Anders Carlsson1a86b332007-10-17 00:52:43 +000016#include "CodeGenModule.h"
Daniel Dunbarde7fb842008-08-11 05:00:27 +000017#include "clang/AST/ASTContext.h"
Ken Dyckbdc601b2009-12-22 14:23:30 +000018#include "clang/AST/CharUnits.h"
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000019#include "clang/AST/Decl.h"
Anders Carlsson19567ee2008-08-25 01:38:19 +000020#include "clang/AST/DeclObjC.h"
Nate Begeman8bd4afe2008-04-19 04:17:09 +000021#include "clang/Basic/SourceManager.h"
Chris Lattner2621fd12008-05-08 05:58:21 +000022#include "clang/Basic/TargetInfo.h"
Chandler Carruth06057ce2010-06-15 23:19:56 +000023#include "clang/Frontend/CodeGenOptions.h"
Anders Carlsson1a86b332007-10-17 00:52:43 +000024#include "llvm/GlobalVariable.h"
Anders Carlsson5d463152008-12-12 07:38:43 +000025#include "llvm/Intrinsics.h"
Mike Stumpdab514f2009-03-04 03:23:46 +000026#include "llvm/Target/TargetData.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000027#include "llvm/Type.h"
28using namespace clang;
29using namespace CodeGen;
30
31
32void CodeGenFunction::EmitDecl(const Decl &D) {
Reid Spencer5f016e22007-07-11 17:01:13 +000033 switch (D.getKind()) {
Douglas Gregor08688ac2010-04-23 02:02:43 +000034 case Decl::TranslationUnit:
35 case Decl::Namespace:
36 case Decl::UnresolvedUsingTypename:
37 case Decl::ClassTemplateSpecialization:
38 case Decl::ClassTemplatePartialSpecialization:
39 case Decl::TemplateTypeParm:
40 case Decl::UnresolvedUsingValue:
Sean Hunt9a555912010-05-30 07:21:58 +000041 case Decl::NonTypeTemplateParm:
Douglas Gregor08688ac2010-04-23 02:02:43 +000042 case Decl::CXXMethod:
43 case Decl::CXXConstructor:
44 case Decl::CXXDestructor:
45 case Decl::CXXConversion:
46 case Decl::Field:
Francois Pichet41f5e662010-11-21 06:49:41 +000047 case Decl::IndirectField:
Douglas Gregor08688ac2010-04-23 02:02:43 +000048 case Decl::ObjCIvar:
49 case Decl::ObjCAtDefsField:
Chris Lattneraa9fc462007-10-08 21:37:32 +000050 case Decl::ParmVar:
Douglas Gregor08688ac2010-04-23 02:02:43 +000051 case Decl::ImplicitParam:
52 case Decl::ClassTemplate:
53 case Decl::FunctionTemplate:
Richard Smith3e4c6c42011-05-05 21:57:07 +000054 case Decl::TypeAliasTemplate:
Douglas Gregor08688ac2010-04-23 02:02:43 +000055 case Decl::TemplateTemplateParm:
56 case Decl::ObjCMethod:
57 case Decl::ObjCCategory:
58 case Decl::ObjCProtocol:
59 case Decl::ObjCInterface:
60 case Decl::ObjCCategoryImpl:
61 case Decl::ObjCImplementation:
62 case Decl::ObjCProperty:
63 case Decl::ObjCCompatibleAlias:
Abramo Bagnara6206d532010-06-05 05:09:32 +000064 case Decl::AccessSpec:
Douglas Gregor08688ac2010-04-23 02:02:43 +000065 case Decl::LinkageSpec:
66 case Decl::ObjCPropertyImpl:
67 case Decl::ObjCClass:
68 case Decl::ObjCForwardProtocol:
69 case Decl::FileScopeAsm:
70 case Decl::Friend:
71 case Decl::FriendTemplate:
72 case Decl::Block:
Devang Patel12e6d832011-04-05 20:28:21 +000073 assert(0 && "Declaration should not be in declstmts!");
Reid Spencer5f016e22007-07-11 17:01:13 +000074 case Decl::Function: // void X();
Argyrios Kyrtzidis35bc0822008-10-15 00:42:39 +000075 case Decl::Record: // struct/union/class X;
Reid Spencer5f016e22007-07-11 17:01:13 +000076 case Decl::Enum: // enum X;
Mike Stump1eb44332009-09-09 15:08:12 +000077 case Decl::EnumConstant: // enum ? { X = ? }
Argyrios Kyrtzidis35bc0822008-10-15 00:42:39 +000078 case Decl::CXXRecord: // struct/union/class X; [C++]
Daniel Dunbarfa133a12009-11-23 00:07:06 +000079 case Decl::Using: // using X; [C++]
80 case Decl::UsingShadow:
81 case Decl::UsingDirective: // using namespace X; [C++]
Douglas Gregor08688ac2010-04-23 02:02:43 +000082 case Decl::NamespaceAlias:
Anders Carlsson7b0ca3f2009-12-03 17:26:31 +000083 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner4ae493c2011-02-18 02:08:43 +000084 case Decl::Label: // __label__ x;
Reid Spencer5f016e22007-07-11 17:01:13 +000085 // None of these decls require codegen support.
86 return;
Mike Stump1eb44332009-09-09 15:08:12 +000087
Daniel Dunbar662174c82008-08-29 17:28:43 +000088 case Decl::Var: {
89 const VarDecl &VD = cast<VarDecl>(D);
John McCallb6bbcc92010-10-15 04:57:14 +000090 assert(VD.isLocalVarDecl() &&
Daniel Dunbar662174c82008-08-29 17:28:43 +000091 "Should not see file-scope variables inside a function!");
John McCallb6bbcc92010-10-15 04:57:14 +000092 return EmitVarDecl(VD);
Reid Spencer5f016e22007-07-11 17:01:13 +000093 }
Mike Stump1eb44332009-09-09 15:08:12 +000094
Richard Smith162e1c12011-04-15 14:24:37 +000095 case Decl::Typedef: // typedef int X;
96 case Decl::TypeAlias: { // using X = int; [C++0x]
97 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlssonfcdbb932008-12-20 21:51:53 +000098 QualType Ty = TD.getUnderlyingType();
Mike Stump1eb44332009-09-09 15:08:12 +000099
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000100 if (Ty->isVariablyModifiedType())
John McCallbc8d40d2011-06-24 21:55:10 +0000101 EmitVariablyModifiedType(Ty);
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000102 }
Daniel Dunbar662174c82008-08-29 17:28:43 +0000103 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000104}
105
John McCallb6bbcc92010-10-15 04:57:14 +0000106/// EmitVarDecl - This method handles emission of any variable declaration
Reid Spencer5f016e22007-07-11 17:01:13 +0000107/// inside a function, including static vars etc.
John McCallb6bbcc92010-10-15 04:57:14 +0000108void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000109 switch (D.getStorageClass()) {
John McCalld931b082010-08-26 03:08:43 +0000110 case SC_None:
111 case SC_Auto:
112 case SC_Register:
John McCallb6bbcc92010-10-15 04:57:14 +0000113 return EmitAutoVarDecl(D);
John McCalld931b082010-08-26 03:08:43 +0000114 case SC_Static: {
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000115 llvm::GlobalValue::LinkageTypes Linkage =
116 llvm::GlobalValue::InternalLinkage;
117
John McCall8b242332010-05-25 04:30:21 +0000118 // If the function definition has some sort of weak linkage, its
119 // static variables should also be weak so that they get properly
120 // uniqued. We can't do this in C, though, because there's no
121 // standard way to agree on which variables are the same (i.e.
122 // there's no mangling).
123 if (getContext().getLangOptions().CPlusPlus)
124 if (llvm::GlobalValue::isWeakForLinker(CurFn->getLinkage()))
125 Linkage = CurFn->getLinkage();
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000126
John McCallb6bbcc92010-10-15 04:57:14 +0000127 return EmitStaticVarDecl(D, Linkage);
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000128 }
John McCalld931b082010-08-26 03:08:43 +0000129 case SC_Extern:
130 case SC_PrivateExtern:
Lauro Ramos Venanciofea90b82008-02-16 22:30:38 +0000131 // Don't emit it now, allow it to be emitted lazily on its first use.
132 return;
Reid Spencer5f016e22007-07-11 17:01:13 +0000133 }
Daniel Dunbar5466c7b2009-04-14 02:25:56 +0000134
135 assert(0 && "Unknown storage class");
Reid Spencer5f016e22007-07-11 17:01:13 +0000136}
137
Chris Lattner761acc12009-12-05 08:22:11 +0000138static std::string GetStaticDeclName(CodeGenFunction &CGF, const VarDecl &D,
139 const char *Separator) {
140 CodeGenModule &CGM = CGF.CGM;
John McCallf746aa62010-03-19 23:29:14 +0000141 if (CGF.getContext().getLangOptions().CPlusPlus) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000142 StringRef Name = CGM.getMangledName(&D);
Anders Carlsson9a20d552010-06-22 16:16:50 +0000143 return Name.str();
John McCallf746aa62010-03-19 23:29:14 +0000144 }
Chris Lattner761acc12009-12-05 08:22:11 +0000145
146 std::string ContextName;
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000147 if (!CGF.CurFuncDecl) {
148 // Better be in a block declared in global scope.
149 const NamedDecl *ND = cast<NamedDecl>(&D);
150 const DeclContext *DC = ND->getDeclContext();
151 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
152 MangleBuffer Name;
Peter Collingbourne14110472011-01-13 18:57:25 +0000153 CGM.getBlockMangledName(GlobalDecl(), Name, BD);
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000154 ContextName = Name.getString();
155 }
156 else
157 assert(0 && "Unknown context for block static var decl");
158 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CGF.CurFuncDecl)) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000159 StringRef Name = CGM.getMangledName(FD);
Anders Carlsson9a20d552010-06-22 16:16:50 +0000160 ContextName = Name.str();
John McCallf746aa62010-03-19 23:29:14 +0000161 } else if (isa<ObjCMethodDecl>(CGF.CurFuncDecl))
Chris Lattner761acc12009-12-05 08:22:11 +0000162 ContextName = CGF.CurFn->getName();
163 else
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000164 assert(0 && "Unknown context for static var decl");
Chris Lattner761acc12009-12-05 08:22:11 +0000165
166 return ContextName + Separator + D.getNameAsString();
167}
168
Daniel Dunbar0096acf2009-02-25 19:24:29 +0000169llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +0000170CodeGenFunction::CreateStaticVarDecl(const VarDecl &D,
171 const char *Separator,
172 llvm::GlobalValue::LinkageTypes Linkage) {
Chris Lattner8bcfc5b2008-04-06 23:10:54 +0000173 QualType Ty = D.getType();
Eli Friedman3c2b3172008-02-15 12:20:59 +0000174 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000175
Chris Lattner761acc12009-12-05 08:22:11 +0000176 std::string Name = GetStaticDeclName(*this, D, Separator);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000177
Chris Lattner2acc6e32011-07-18 04:24:23 +0000178 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(Ty);
Anders Carlsson41f8a132009-09-26 18:16:06 +0000179 llvm::GlobalVariable *GV =
180 new llvm::GlobalVariable(CGM.getModule(), LTy,
181 Ty.isConstant(getContext()), Linkage,
182 CGM.EmitNullConstant(D.getType()), Name, 0,
Peter Collingbourne207f4d82011-03-18 22:38:29 +0000183 D.isThreadSpecified(),
184 CGM.getContext().getTargetAddressSpace(Ty));
Ken Dyck8b752f12010-01-27 17:10:57 +0000185 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
John McCall112c9672010-11-02 21:04:24 +0000186 if (Linkage != llvm::GlobalValue::InternalLinkage)
187 GV->setVisibility(CurFn->getVisibility());
Anders Carlsson41f8a132009-09-26 18:16:06 +0000188 return GV;
Daniel Dunbar0096acf2009-02-25 19:24:29 +0000189}
190
John McCallb6bbcc92010-10-15 04:57:14 +0000191/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
Chris Lattner761acc12009-12-05 08:22:11 +0000192/// global variable that has already been created for it. If the initializer
193/// has a different type than GV does, this may free GV and return a different
194/// one. Otherwise it just returns GV.
195llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +0000196CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
197 llvm::GlobalVariable *GV) {
Chris Lattner761acc12009-12-05 08:22:11 +0000198 llvm::Constant *Init = CGM.EmitConstantExpr(D.getInit(), D.getType(), this);
John McCallbf40cb52010-07-15 23:40:35 +0000199
Chris Lattner761acc12009-12-05 08:22:11 +0000200 // If constant emission failed, then this should be a C++ static
201 // initializer.
202 if (!Init) {
203 if (!getContext().getLangOptions().CPlusPlus)
204 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
John McCall5cd91b52010-09-08 01:44:27 +0000205 else if (Builder.GetInsertBlock()) {
Anders Carlsson071c8102010-01-26 04:02:23 +0000206 // Since we have a static initializer, this global variable can't
207 // be constant.
208 GV->setConstant(false);
John McCall5cd91b52010-09-08 01:44:27 +0000209
John McCall3030eb82010-11-06 09:44:32 +0000210 EmitCXXGuardedInit(D, GV);
Anders Carlsson071c8102010-01-26 04:02:23 +0000211 }
Chris Lattner761acc12009-12-05 08:22:11 +0000212 return GV;
213 }
John McCallbf40cb52010-07-15 23:40:35 +0000214
Chris Lattner761acc12009-12-05 08:22:11 +0000215 // The initializer may differ in type from the global. Rewrite
216 // the global to match the initializer. (We have to do this
217 // because some types, like unions, can't be completely represented
218 // in the LLVM type system.)
John McCall9c20fa92010-09-03 18:58:50 +0000219 if (GV->getType()->getElementType() != Init->getType()) {
Chris Lattner761acc12009-12-05 08:22:11 +0000220 llvm::GlobalVariable *OldGV = GV;
221
222 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
223 OldGV->isConstant(),
224 OldGV->getLinkage(), Init, "",
John McCall112c9672010-11-02 21:04:24 +0000225 /*InsertBefore*/ OldGV,
226 D.isThreadSpecified(),
Peter Collingbourne207f4d82011-03-18 22:38:29 +0000227 CGM.getContext().getTargetAddressSpace(D.getType()));
John McCall112c9672010-11-02 21:04:24 +0000228 GV->setVisibility(OldGV->getVisibility());
Chris Lattner761acc12009-12-05 08:22:11 +0000229
230 // Steal the name of the old global
231 GV->takeName(OldGV);
232
233 // Replace all uses of the old global with the new global
234 llvm::Constant *NewPtrForOldDecl =
235 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
236 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
237
238 // Erase the old global, since it is no longer used.
239 OldGV->eraseFromParent();
240 }
241
242 GV->setInitializer(Init);
243 return GV;
244}
245
John McCallb6bbcc92010-10-15 04:57:14 +0000246void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000247 llvm::GlobalValue::LinkageTypes Linkage) {
Daniel Dunbara985b312009-02-25 19:45:19 +0000248 llvm::Value *&DMEntry = LocalDeclMap[&D];
249 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
Mike Stump1eb44332009-09-09 15:08:12 +0000250
John McCallb6bbcc92010-10-15 04:57:14 +0000251 llvm::GlobalVariable *GV = CreateStaticVarDecl(D, ".", Linkage);
Daniel Dunbara985b312009-02-25 19:45:19 +0000252
Daniel Dunbare5731f82009-02-25 20:08:33 +0000253 // Store into LocalDeclMap before generating initializer to handle
254 // circular references.
255 DMEntry = GV;
256
John McCallfe67f3b2010-05-04 20:45:42 +0000257 // We can't have a VLA here, but we can have a pointer to a VLA,
258 // even though that doesn't really make any sense.
Eli Friedmanc62aad82009-04-20 03:54:15 +0000259 // Make sure to evaluate VLA bounds now so that we have them for later.
260 if (D.getType()->isVariablyModifiedType())
John McCallbc8d40d2011-06-24 21:55:10 +0000261 EmitVariablyModifiedType(D.getType());
Fariborz Jahanian09349142010-09-07 23:26:17 +0000262
263 // Local static block variables must be treated as globals as they may be
264 // referenced in their RHS initializer block-literal expresion.
265 CGM.setStaticLocalDeclAddress(&D, GV);
Eli Friedmanc62aad82009-04-20 03:54:15 +0000266
Chris Lattner761acc12009-12-05 08:22:11 +0000267 // If this value has an initializer, emit it.
268 if (D.getInit())
John McCallb6bbcc92010-10-15 04:57:14 +0000269 GV = AddInitializerToStaticVarDecl(D, GV);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000270
Chris Lattner0af95232010-03-10 23:59:59 +0000271 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
272
Daniel Dunbar30510ab2009-02-12 23:32:54 +0000273 // FIXME: Merge attribute handling.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000274 if (const AnnotateAttr *AA = D.getAttr<AnnotateAttr>()) {
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000275 SourceManager &SM = CGM.getContext().getSourceManager();
276 llvm::Constant *Ann =
Mike Stump1eb44332009-09-09 15:08:12 +0000277 CGM.EmitAnnotateAttr(GV, AA,
Chris Lattnerf7cf85b2009-01-16 07:36:28 +0000278 SM.getInstantiationLineNumber(D.getLocation()));
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000279 CGM.AddAnnotation(Ann);
280 }
281
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000282 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
Daniel Dunbar30510ab2009-02-12 23:32:54 +0000283 GV->setSection(SA->getName());
Mike Stump1eb44332009-09-09 15:08:12 +0000284
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000285 if (D.hasAttr<UsedAttr>())
Daniel Dunbar5c61d972009-02-13 22:08:43 +0000286 CGM.AddUsedGlobal(GV);
287
Daniel Dunbare5731f82009-02-25 20:08:33 +0000288 // We may have to cast the constant because of the initializer
289 // mismatch above.
290 //
291 // FIXME: It is really dangerous to store this in the map; if anyone
292 // RAUW's the GV uses of this constant will be invalid.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000293 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(D.getType());
294 llvm::Type *LPtrTy =
Peter Collingbourne207f4d82011-03-18 22:38:29 +0000295 LTy->getPointerTo(CGM.getContext().getTargetAddressSpace(D.getType()));
Owen Anderson3c4972d2009-07-29 18:54:39 +0000296 DMEntry = llvm::ConstantExpr::getBitCast(GV, LPtrTy);
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000297
298 // Emit global variable debug descriptor for static vars.
Anders Carlssone896d982009-02-13 08:11:52 +0000299 CGDebugInfo *DI = getDebugInfo();
Mike Stump4451bd92009-02-20 00:19:45 +0000300 if (DI) {
Daniel Dunbar66031a52008-10-17 16:15:48 +0000301 DI->setLocation(D.getLocation());
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000302 DI->EmitGlobalVariable(static_cast<llvm::GlobalVariable *>(GV), &D);
303 }
Anders Carlsson1a86b332007-10-17 00:52:43 +0000304}
Mike Stump1eb44332009-09-09 15:08:12 +0000305
John McCallda65ea82010-07-13 20:32:21 +0000306namespace {
John McCallbdc4d802011-07-09 01:37:26 +0000307 struct DestroyObject : EHScopeStack::Cleanup {
308 DestroyObject(llvm::Value *addr, QualType type,
John McCall2673c682011-07-11 08:38:19 +0000309 CodeGenFunction::Destroyer *destroyer,
310 bool useEHCleanupForArray)
311 : addr(addr), type(type), destroyer(*destroyer),
312 useEHCleanupForArray(useEHCleanupForArray) {}
John McCallda65ea82010-07-13 20:32:21 +0000313
John McCallbdc4d802011-07-09 01:37:26 +0000314 llvm::Value *addr;
315 QualType type;
316 CodeGenFunction::Destroyer &destroyer;
John McCall2673c682011-07-11 08:38:19 +0000317 bool useEHCleanupForArray;
John McCallda65ea82010-07-13 20:32:21 +0000318
John McCallad346f42011-07-12 20:27:29 +0000319 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +0000320 // Don't use an EH cleanup recursively from an EH cleanup.
John McCallad346f42011-07-12 20:27:29 +0000321 bool useEHCleanupForArray =
322 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall2673c682011-07-11 08:38:19 +0000323
324 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCallda65ea82010-07-13 20:32:21 +0000325 }
326 };
327
John McCallbdc4d802011-07-09 01:37:26 +0000328 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
329 DestroyNRVOVariable(llvm::Value *addr,
330 const CXXDestructorDecl *Dtor,
331 llvm::Value *NRVOFlag)
332 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {}
John McCallda65ea82010-07-13 20:32:21 +0000333
334 const CXXDestructorDecl *Dtor;
335 llvm::Value *NRVOFlag;
336 llvm::Value *Loc;
337
John McCallad346f42011-07-12 20:27:29 +0000338 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallda65ea82010-07-13 20:32:21 +0000339 // Along the exceptions path we always execute the dtor.
John McCallad346f42011-07-12 20:27:29 +0000340 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCallda65ea82010-07-13 20:32:21 +0000341
342 llvm::BasicBlock *SkipDtorBB = 0;
343 if (NRVO) {
344 // If we exited via NRVO, we skip the destructor call.
345 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
346 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
347 llvm::Value *DidNRVO = CGF.Builder.CreateLoad(NRVOFlag, "nrvo.val");
348 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
349 CGF.EmitBlock(RunDtorBB);
350 }
351
352 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
353 /*ForVirtualBase=*/false, Loc);
354
355 if (NRVO) CGF.EmitBlock(SkipDtorBB);
356 }
357 };
John McCallda65ea82010-07-13 20:32:21 +0000358
John McCall1f0fca52010-07-21 07:22:38 +0000359 struct CallStackRestore : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000360 llvm::Value *Stack;
361 CallStackRestore(llvm::Value *Stack) : Stack(Stack) {}
John McCallad346f42011-07-12 20:27:29 +0000362 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCalld8715092010-07-21 06:13:08 +0000363 llvm::Value *V = CGF.Builder.CreateLoad(Stack, "tmp");
364 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
365 CGF.Builder.CreateCall(F, V);
366 }
367 };
368
John McCall0c24c802011-06-24 23:21:27 +0000369 struct ExtendGCLifetime : EHScopeStack::Cleanup {
370 const VarDecl &Var;
371 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
372
John McCallad346f42011-07-12 20:27:29 +0000373 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall0c24c802011-06-24 23:21:27 +0000374 // Compute the address of the local variable, in case it's a
375 // byref or something.
376 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), Var.getType(), VK_LValue,
377 SourceLocation());
378 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE));
379 CGF.EmitExtendGCLifetime(value);
380 }
381 };
382
John McCall1f0fca52010-07-21 07:22:38 +0000383 struct CallCleanupFunction : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000384 llvm::Constant *CleanupFn;
385 const CGFunctionInfo &FnInfo;
John McCalld8715092010-07-21 06:13:08 +0000386 const VarDecl &Var;
387
388 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCall34695852011-02-22 06:44:22 +0000389 const VarDecl *Var)
390 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalld8715092010-07-21 06:13:08 +0000391
John McCallad346f42011-07-12 20:27:29 +0000392 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall34695852011-02-22 06:44:22 +0000393 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), Var.getType(), VK_LValue,
394 SourceLocation());
395 // Compute the address of the local variable, in case it's a byref
396 // or something.
397 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getAddress();
398
John McCalld8715092010-07-21 06:13:08 +0000399 // In some cases, the type of the function argument will be different from
400 // the type of the pointer. An example of this is
401 // void f(void* arg);
402 // __attribute__((cleanup(f))) void *g;
403 //
404 // To fix this we insert a bitcast here.
405 QualType ArgTy = FnInfo.arg_begin()->type;
406 llvm::Value *Arg =
407 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
408
409 CallArgList Args;
Eli Friedman04c9a492011-05-02 17:57:46 +0000410 Args.add(RValue::get(Arg),
411 CGF.getContext().getPointerType(Var.getType()));
John McCalld8715092010-07-21 06:13:08 +0000412 CGF.EmitCall(FnInfo, CleanupFn, ReturnValueSlot(), Args);
413 }
414 };
John McCalld8715092010-07-21 06:13:08 +0000415}
416
John McCallf85e1932011-06-15 23:02:42 +0000417/// EmitAutoVarWithLifetime - Does the setup required for an automatic
418/// variable with lifetime.
419static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
420 llvm::Value *addr,
421 Qualifiers::ObjCLifetime lifetime) {
422 switch (lifetime) {
423 case Qualifiers::OCL_None:
424 llvm_unreachable("present but none");
425
426 case Qualifiers::OCL_ExplicitNone:
427 // nothing to do
428 break;
429
430 case Qualifiers::OCL_Strong: {
John McCall9928c482011-07-12 16:41:08 +0000431 CodeGenFunction::Destroyer &destroyer =
432 (var.hasAttr<ObjCPreciseLifetimeAttr>()
433 ? CodeGenFunction::destroyARCStrongPrecise
434 : CodeGenFunction::destroyARCStrongImprecise);
435
436 CleanupKind cleanupKind = CGF.getARCCleanupKind();
437 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
438 cleanupKind & EHCleanup);
John McCallf85e1932011-06-15 23:02:42 +0000439 break;
440 }
441 case Qualifiers::OCL_Autoreleasing:
442 // nothing to do
443 break;
444
445 case Qualifiers::OCL_Weak:
446 // __weak objects always get EH cleanups; otherwise, exceptions
447 // could cause really nasty crashes instead of mere leaks.
John McCall9928c482011-07-12 16:41:08 +0000448 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
449 CodeGenFunction::destroyARCWeak,
450 /*useEHCleanup*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000451 break;
452 }
453}
454
455static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
456 if (const Expr *e = dyn_cast<Expr>(s)) {
457 // Skip the most common kinds of expressions that make
458 // hierarchy-walking expensive.
459 s = e = e->IgnoreParenCasts();
460
461 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
462 return (ref->getDecl() == &var);
463 }
464
465 for (Stmt::const_child_range children = s->children(); children; ++children)
Fariborz Jahanian8fefc8e2011-06-29 20:00:16 +0000466 // children might be null; as in missing decl or conditional of an if-stmt.
467 if ((*children) && isAccessedBy(var, *children))
John McCallf85e1932011-06-15 23:02:42 +0000468 return true;
469
470 return false;
471}
472
473static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
474 if (!decl) return false;
475 if (!isa<VarDecl>(decl)) return false;
476 const VarDecl *var = cast<VarDecl>(decl);
477 return isAccessedBy(*var, e);
478}
479
John McCalla07398e2011-06-16 04:16:24 +0000480static void drillIntoBlockVariable(CodeGenFunction &CGF,
481 LValue &lvalue,
482 const VarDecl *var) {
483 lvalue.setAddress(CGF.BuildBlockByrefAddress(lvalue.getAddress(), var));
484}
485
John McCallf85e1932011-06-15 23:02:42 +0000486void CodeGenFunction::EmitScalarInit(const Expr *init,
487 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +0000488 LValue lvalue,
489 bool capturedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000490 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCallf85e1932011-06-15 23:02:42 +0000491 if (!lifetime) {
492 llvm::Value *value = EmitScalarExpr(init);
John McCalla07398e2011-06-16 04:16:24 +0000493 if (capturedByInit)
494 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall545d9962011-06-25 02:11:03 +0000495 EmitStoreThroughLValue(RValue::get(value), lvalue);
John McCallf85e1932011-06-15 23:02:42 +0000496 return;
497 }
498
499 // If we're emitting a value with lifetime, we have to do the
500 // initialization *before* we leave the cleanup scopes.
501 CodeGenFunction::RunCleanupsScope Scope(*this);
502 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init))
503 init = ewc->getSubExpr();
504
505 // We have to maintain the illusion that the variable is
506 // zero-initialized. If the variable might be accessed in its
507 // initializer, zero-initialize before running the initializer, then
508 // actually perform the initialization with an assign.
509 bool accessedByInit = false;
510 if (lifetime != Qualifiers::OCL_ExplicitNone)
511 accessedByInit = isAccessedBy(D, init);
512 if (accessedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000513 LValue tempLV = lvalue;
John McCallf85e1932011-06-15 23:02:42 +0000514 // Drill down to the __block object if necessary.
John McCallf85e1932011-06-15 23:02:42 +0000515 if (capturedByInit) {
516 // We can use a simple GEP for this because it can't have been
517 // moved yet.
John McCalla07398e2011-06-16 04:16:24 +0000518 tempLV.setAddress(Builder.CreateStructGEP(tempLV.getAddress(),
519 getByRefValueLLVMField(cast<VarDecl>(D))));
John McCallf85e1932011-06-15 23:02:42 +0000520 }
521
Chris Lattner2acc6e32011-07-18 04:24:23 +0000522 llvm::PointerType *ty
John McCalla07398e2011-06-16 04:16:24 +0000523 = cast<llvm::PointerType>(tempLV.getAddress()->getType());
John McCallf85e1932011-06-15 23:02:42 +0000524 ty = cast<llvm::PointerType>(ty->getElementType());
525
526 llvm::Value *zero = llvm::ConstantPointerNull::get(ty);
527
528 // If __weak, we want to use a barrier under certain conditions.
529 if (lifetime == Qualifiers::OCL_Weak)
John McCalla07398e2011-06-16 04:16:24 +0000530 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCallf85e1932011-06-15 23:02:42 +0000531
532 // Otherwise just do a simple store.
533 else
John McCalla07398e2011-06-16 04:16:24 +0000534 EmitStoreOfScalar(zero, tempLV);
John McCallf85e1932011-06-15 23:02:42 +0000535 }
536
537 // Emit the initializer.
538 llvm::Value *value = 0;
539
540 switch (lifetime) {
541 case Qualifiers::OCL_None:
542 llvm_unreachable("present but none");
543
544 case Qualifiers::OCL_ExplicitNone:
545 // nothing to do
546 value = EmitScalarExpr(init);
547 break;
548
549 case Qualifiers::OCL_Strong: {
550 value = EmitARCRetainScalarExpr(init);
551 break;
552 }
553
554 case Qualifiers::OCL_Weak: {
555 // No way to optimize a producing initializer into this. It's not
556 // worth optimizing for, because the value will immediately
557 // disappear in the common case.
558 value = EmitScalarExpr(init);
559
John McCalla07398e2011-06-16 04:16:24 +0000560 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000561 if (accessedByInit)
John McCalla07398e2011-06-16 04:16:24 +0000562 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000563 else
John McCalla07398e2011-06-16 04:16:24 +0000564 EmitARCInitWeak(lvalue.getAddress(), value);
John McCallf85e1932011-06-15 23:02:42 +0000565 return;
566 }
567
568 case Qualifiers::OCL_Autoreleasing:
569 value = EmitARCRetainAutoreleaseScalarExpr(init);
570 break;
571 }
572
John McCalla07398e2011-06-16 04:16:24 +0000573 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000574
575 // If the variable might have been accessed by its initializer, we
576 // might have to initialize with a barrier. We have to do this for
577 // both __weak and __strong, but __weak got filtered out above.
578 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
John McCalla07398e2011-06-16 04:16:24 +0000579 llvm::Value *oldValue = EmitLoadOfScalar(lvalue);
580 EmitStoreOfScalar(value, lvalue);
John McCallf85e1932011-06-15 23:02:42 +0000581 EmitARCRelease(oldValue, /*precise*/ false);
582 return;
583 }
584
John McCalla07398e2011-06-16 04:16:24 +0000585 EmitStoreOfScalar(value, lvalue);
John McCallf85e1932011-06-15 23:02:42 +0000586}
Chris Lattner94cd0112010-12-01 02:05:19 +0000587
John McCall7acddac2011-06-17 06:42:21 +0000588/// EmitScalarInit - Initialize the given lvalue with the given object.
589void CodeGenFunction::EmitScalarInit(llvm::Value *init, LValue lvalue) {
590 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
591 if (!lifetime)
John McCall545d9962011-06-25 02:11:03 +0000592 return EmitStoreThroughLValue(RValue::get(init), lvalue);
John McCall7acddac2011-06-17 06:42:21 +0000593
594 switch (lifetime) {
595 case Qualifiers::OCL_None:
596 llvm_unreachable("present but none");
597
598 case Qualifiers::OCL_ExplicitNone:
599 // nothing to do
600 break;
601
602 case Qualifiers::OCL_Strong:
603 init = EmitARCRetain(lvalue.getType(), init);
604 break;
605
606 case Qualifiers::OCL_Weak:
607 // Initialize and then skip the primitive store.
608 EmitARCInitWeak(lvalue.getAddress(), init);
609 return;
610
611 case Qualifiers::OCL_Autoreleasing:
612 init = EmitARCRetainAutorelease(lvalue.getType(), init);
613 break;
614 }
615
616 EmitStoreOfScalar(init, lvalue);
617}
618
Chris Lattner94cd0112010-12-01 02:05:19 +0000619/// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the
620/// non-zero parts of the specified initializer with equal or fewer than
621/// NumStores scalar stores.
622static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init,
623 unsigned &NumStores) {
Chris Lattner70b02942010-12-02 01:58:41 +0000624 // Zero and Undef never requires any extra stores.
625 if (isa<llvm::ConstantAggregateZero>(Init) ||
626 isa<llvm::ConstantPointerNull>(Init) ||
627 isa<llvm::UndefValue>(Init))
628 return true;
629 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
630 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
631 isa<llvm::ConstantExpr>(Init))
632 return Init->isNullValue() || NumStores--;
633
634 // See if we can emit each element.
635 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
636 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
637 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
638 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
639 return false;
640 }
641 return true;
642 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000643
644 // Anything else is hard and scary.
645 return false;
646}
647
648/// emitStoresForInitAfterMemset - For inits that
649/// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar
650/// stores that would be required.
651static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc,
John McCall34695852011-02-22 06:44:22 +0000652 bool isVolatile, CGBuilderTy &Builder) {
Chris Lattner94cd0112010-12-01 02:05:19 +0000653 // Zero doesn't require any stores.
Chris Lattner70b02942010-12-02 01:58:41 +0000654 if (isa<llvm::ConstantAggregateZero>(Init) ||
655 isa<llvm::ConstantPointerNull>(Init) ||
656 isa<llvm::UndefValue>(Init))
657 return;
Chris Lattner94cd0112010-12-01 02:05:19 +0000658
Chris Lattner70b02942010-12-02 01:58:41 +0000659 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
660 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
661 isa<llvm::ConstantExpr>(Init)) {
662 if (!Init->isNullValue())
John McCall34695852011-02-22 06:44:22 +0000663 Builder.CreateStore(Init, Loc, isVolatile);
Chris Lattner70b02942010-12-02 01:58:41 +0000664 return;
665 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000666
Chris Lattner70b02942010-12-02 01:58:41 +0000667 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
668 "Unknown value type!");
669
670 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
671 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
672 if (Elt->isNullValue()) continue;
673
674 // Otherwise, get a pointer to the element and emit it.
675 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
John McCall34695852011-02-22 06:44:22 +0000676 isVolatile, Builder);
Chris Lattner70b02942010-12-02 01:58:41 +0000677 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000678}
679
680
681/// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset
682/// plus some stores to initialize a local variable instead of using a memcpy
683/// from a constant global. It is beneficial to use memset if the global is all
684/// zeros, or mostly zeros and large.
685static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init,
686 uint64_t GlobalSize) {
687 // If a global is all zeros, always use a memset.
688 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
689
690
691 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
692 // do it if it will require 6 or fewer scalar stores.
693 // TODO: Should budget depends on the size? Avoiding a large global warrants
694 // plopping in more stores.
695 unsigned StoreBudget = 6;
696 uint64_t SizeLimit = 32;
697
698 return GlobalSize > SizeLimit &&
699 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget);
700}
701
702
Nick Lewyckya9de3fa2010-12-30 20:21:55 +0000703/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Reid Spencer5f016e22007-07-11 17:01:13 +0000704/// variable declaration with auto, register, or no storage class specifier.
Chris Lattner2621fd12008-05-08 05:58:21 +0000705/// These turn into simple stack objects, or GlobalValues depending on target.
John McCall34695852011-02-22 06:44:22 +0000706void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
707 AutoVarEmission emission = EmitAutoVarAlloca(D);
708 EmitAutoVarInit(emission);
709 EmitAutoVarCleanups(emission);
710}
Reid Spencer5f016e22007-07-11 17:01:13 +0000711
John McCall34695852011-02-22 06:44:22 +0000712/// EmitAutoVarAlloca - Emit the alloca and debug information for a
713/// local variable. Does not emit initalization or destruction.
714CodeGenFunction::AutoVarEmission
715CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
716 QualType Ty = D.getType();
717
718 AutoVarEmission emission(D);
719
720 bool isByRef = D.hasAttr<BlocksAttr>();
721 emission.IsByRef = isByRef;
722
723 CharUnits alignment = getContext().getDeclAlign(&D);
724 emission.Alignment = alignment;
725
John McCallbc8d40d2011-06-24 21:55:10 +0000726 // If the type is variably-modified, emit all the VLA sizes for it.
727 if (Ty->isVariablyModifiedType())
728 EmitVariablyModifiedType(Ty);
729
Reid Spencer5f016e22007-07-11 17:01:13 +0000730 llvm::Value *DeclPtr;
Eli Friedman3c2b3172008-02-15 12:20:59 +0000731 if (Ty->isConstantSizeType()) {
Chris Lattner2621fd12008-05-08 05:58:21 +0000732 if (!Target.useGlobalsForAutomaticVariables()) {
John McCall34695852011-02-22 06:44:22 +0000733 bool NRVO = getContext().getLangOptions().ElideConstructors &&
734 D.isNRVOVariable();
735
736 // If this value is a POD array or struct with a statically
737 // determinable constant initializer, there are optimizations we
738 // can do.
739 // TODO: we can potentially constant-evaluate non-POD structs and
740 // arrays as long as the initialization is trivial (e.g. if they
741 // have a non-trivial destructor, but not a non-trivial constructor).
742 if (D.getInit() &&
John McCallf85e1932011-06-15 23:02:42 +0000743 (Ty->isArrayType() || Ty->isRecordType()) &&
744 (Ty.isPODType(getContext()) ||
745 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
John McCall4204f072010-08-02 21:13:48 +0000746 D.getInit()->isConstantInitializer(getContext(), false)) {
John McCall34695852011-02-22 06:44:22 +0000747
748 // If the variable's a const type, and it's neither an NRVO
749 // candidate nor a __block variable, emit it as a global instead.
750 if (CGM.getCodeGenOpts().MergeAllConstants && Ty.isConstQualified() &&
751 !NRVO && !isByRef) {
Douglas Gregor4707b9a2011-03-06 23:28:21 +0000752 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCall34695852011-02-22 06:44:22 +0000753
754 emission.Address = 0; // signal this condition to later callbacks
755 assert(emission.wasEmittedAsGlobal());
756 return emission;
Tanya Lattner59876c22009-11-04 01:18:09 +0000757 }
John McCall34695852011-02-22 06:44:22 +0000758
759 // Otherwise, tell the initialization code that we're in this case.
760 emission.IsConstantAggregate = true;
Tanya Lattner59876c22009-11-04 01:18:09 +0000761 }
762
Douglas Gregord86c4772010-05-15 06:46:45 +0000763 // A normal fixed sized variable becomes an alloca in the entry block,
764 // unless it's an NRVO variable.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000765 llvm::Type *LTy = ConvertTypeForMem(Ty);
Douglas Gregord86c4772010-05-15 06:46:45 +0000766
767 if (NRVO) {
768 // The named return value optimization: allocate this variable in the
769 // return slot, so that we can elide the copy when returning this
770 // variable (C++0x [class.copy]p34).
771 DeclPtr = ReturnValue;
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000772
773 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
774 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) {
775 // Create a flag that is used to indicate when the NRVO was applied
776 // to this variable. Set it to zero to indicate that NRVO was not
777 // applied.
Chris Lattner4c53dc12010-12-01 01:47:15 +0000778 llvm::Value *Zero = Builder.getFalse();
John McCall34695852011-02-22 06:44:22 +0000779 llvm::Value *NRVOFlag = CreateTempAlloca(Zero->getType(), "nrvo");
Nick Lewyckya03733b2011-02-16 23:59:08 +0000780 EnsureInsertPoint();
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000781 Builder.CreateStore(Zero, NRVOFlag);
782
783 // Record the NRVO flag for this variable.
784 NRVOFlags[&D] = NRVOFlag;
John McCall34695852011-02-22 06:44:22 +0000785 emission.NRVOFlag = NRVOFlag;
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000786 }
787 }
Douglas Gregord86c4772010-05-15 06:46:45 +0000788 } else {
789 if (isByRef)
790 LTy = BuildByRefType(&D);
791
792 llvm::AllocaInst *Alloc = CreateTempAlloca(LTy);
793 Alloc->setName(D.getNameAsString());
Mike Stump1eb44332009-09-09 15:08:12 +0000794
John McCall34695852011-02-22 06:44:22 +0000795 CharUnits allocaAlignment = alignment;
Douglas Gregord86c4772010-05-15 06:46:45 +0000796 if (isByRef)
John McCall34695852011-02-22 06:44:22 +0000797 allocaAlignment = std::max(allocaAlignment,
Ken Dyck06f486e2011-01-18 02:01:14 +0000798 getContext().toCharUnitsFromBits(Target.getPointerAlign(0)));
John McCall34695852011-02-22 06:44:22 +0000799 Alloc->setAlignment(allocaAlignment.getQuantity());
Douglas Gregord86c4772010-05-15 06:46:45 +0000800 DeclPtr = Alloc;
801 }
Chris Lattner2621fd12008-05-08 05:58:21 +0000802 } else {
803 // Targets that don't support recursion emit locals as globals.
804 const char *Class =
John McCalld931b082010-08-26 03:08:43 +0000805 D.getStorageClass() == SC_Register ? ".reg." : ".auto.";
John McCallb6bbcc92010-10-15 04:57:14 +0000806 DeclPtr = CreateStaticVarDecl(D, Class,
807 llvm::GlobalValue::InternalLinkage);
Chris Lattner2621fd12008-05-08 05:58:21 +0000808 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000809 } else {
Daniel Dunbard286f052009-07-19 06:58:07 +0000810 EnsureInsertPoint();
811
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000812 if (!DidCallStackSave) {
Anders Carlsson5d463152008-12-12 07:38:43 +0000813 // Save the stack.
John McCalld16c2cf2011-02-08 08:22:06 +0000814 llvm::Value *Stack = CreateTempAlloca(Int8PtrTy, "saved_stack");
Mike Stump1eb44332009-09-09 15:08:12 +0000815
Anders Carlsson5d463152008-12-12 07:38:43 +0000816 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
817 llvm::Value *V = Builder.CreateCall(F);
Mike Stump1eb44332009-09-09 15:08:12 +0000818
Anders Carlsson5d463152008-12-12 07:38:43 +0000819 Builder.CreateStore(V, Stack);
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000820
821 DidCallStackSave = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000822
John McCalld8715092010-07-21 06:13:08 +0000823 // Push a cleanup block and restore the stack there.
John McCall3ad32c82011-01-28 08:37:24 +0000824 // FIXME: in general circumstances, this should be an EH cleanup.
John McCall1f0fca52010-07-21 07:22:38 +0000825 EHStack.pushCleanup<CallStackRestore>(NormalCleanup, Stack);
Anders Carlsson5d463152008-12-12 07:38:43 +0000826 }
Mike Stump1eb44332009-09-09 15:08:12 +0000827
John McCallbc8d40d2011-06-24 21:55:10 +0000828 llvm::Value *elementCount;
829 QualType elementType;
830 llvm::tie(elementCount, elementType) = getVLASize(Ty);
Anders Carlsson5d463152008-12-12 07:38:43 +0000831
Chris Lattner2acc6e32011-07-18 04:24:23 +0000832 llvm::Type *llvmTy = ConvertTypeForMem(elementType);
Anders Carlsson5d463152008-12-12 07:38:43 +0000833
834 // Allocate memory for the array.
John McCallbc8d40d2011-06-24 21:55:10 +0000835 llvm::AllocaInst *vla = Builder.CreateAlloca(llvmTy, elementCount, "vla");
836 vla->setAlignment(alignment.getQuantity());
Anders Carlsson41f8a132009-09-26 18:16:06 +0000837
John McCallbc8d40d2011-06-24 21:55:10 +0000838 DeclPtr = vla;
Reid Spencer5f016e22007-07-11 17:01:13 +0000839 }
Eli Friedman8f39f5e2008-12-20 23:11:59 +0000840
Reid Spencer5f016e22007-07-11 17:01:13 +0000841 llvm::Value *&DMEntry = LocalDeclMap[&D];
842 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
843 DMEntry = DeclPtr;
John McCall34695852011-02-22 06:44:22 +0000844 emission.Address = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000845
846 // Emit debug info for local var declaration.
Devang Patelc594abd2011-06-03 19:21:47 +0000847 if (HaveInsertPoint())
848 if (CGDebugInfo *DI = getDebugInfo()) {
849 DI->setLocation(D.getLocation());
Devang Patelc594abd2011-06-03 19:21:47 +0000850 if (Target.useGlobalsForAutomaticVariables()) {
851 DI->EmitGlobalVariable(static_cast<llvm::GlobalVariable *>(DeclPtr), &D);
852 } else
853 DI->EmitDeclareOfAutoVariable(&D, DeclPtr, Builder);
854 }
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000855
John McCall34695852011-02-22 06:44:22 +0000856 return emission;
857}
858
859/// Determines whether the given __block variable is potentially
860/// captured by the given expression.
861static bool isCapturedBy(const VarDecl &var, const Expr *e) {
862 // Skip the most common kinds of expressions that make
863 // hierarchy-walking expensive.
864 e = e->IgnoreParenCasts();
865
866 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
867 const BlockDecl *block = be->getBlockDecl();
868 for (BlockDecl::capture_const_iterator i = block->capture_begin(),
869 e = block->capture_end(); i != e; ++i) {
870 if (i->getVariable() == &var)
871 return true;
872 }
873
874 // No need to walk into the subexpressions.
875 return false;
876 }
877
878 for (Stmt::const_child_range children = e->children(); children; ++children)
879 if (isCapturedBy(var, cast<Expr>(*children)))
880 return true;
881
882 return false;
883}
884
Douglas Gregorbcc3e662011-07-01 21:08:19 +0000885/// \brief Determine whether the given initializer is trivial in the sense
886/// that it requires no code to be generated.
887static bool isTrivialInitializer(const Expr *Init) {
888 if (!Init)
889 return true;
890
891 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
892 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
893 if (Constructor->isTrivial() &&
894 Constructor->isDefaultConstructor() &&
895 !Construct->requiresZeroInitialization())
896 return true;
897
898 return false;
899}
John McCall34695852011-02-22 06:44:22 +0000900void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +0000901 assert(emission.Variable && "emission was not valid!");
902
John McCall34695852011-02-22 06:44:22 +0000903 // If this was emitted as a global constant, we're done.
904 if (emission.wasEmittedAsGlobal()) return;
905
John McCall57b3b6a2011-02-22 07:16:58 +0000906 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +0000907 QualType type = D.getType();
908
Chris Lattner19785962007-07-12 00:39:48 +0000909 // If this local has an initializer, emit it now.
Daniel Dunbard286f052009-07-19 06:58:07 +0000910 const Expr *Init = D.getInit();
911
912 // If we are at an unreachable point, we don't need to emit the initializer
913 // unless it contains a label.
914 if (!HaveInsertPoint()) {
John McCall34695852011-02-22 06:44:22 +0000915 if (!Init || !ContainsLabel(Init)) return;
916 EnsureInsertPoint();
Daniel Dunbard286f052009-07-19 06:58:07 +0000917 }
918
John McCall5af02db2011-03-31 01:59:53 +0000919 // Initialize the structure of a __block variable.
920 if (emission.IsByRef)
921 emitByrefStructureInit(emission);
Anders Carlsson69c68b72009-02-07 23:51:38 +0000922
Douglas Gregorbcc3e662011-07-01 21:08:19 +0000923 if (isTrivialInitializer(Init))
924 return;
925
Mon P Wang3ecd7852010-04-04 03:10:52 +0000926
John McCall5af02db2011-03-31 01:59:53 +0000927 CharUnits alignment = emission.Alignment;
928
John McCall34695852011-02-22 06:44:22 +0000929 // Check whether this is a byref variable that's potentially
930 // captured and moved by its own initializer. If so, we'll need to
931 // emit the initializer first, then copy into the variable.
932 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init);
933
934 llvm::Value *Loc =
935 capturedByInit ? emission.Address : emission.getObjectAddress(*this);
936
John McCalla07398e2011-06-16 04:16:24 +0000937 if (!emission.IsConstantAggregate) {
938 LValue lv = MakeAddrLValue(Loc, type, alignment.getQuantity());
939 lv.setNonGC(true);
940 return EmitExprAsInit(Init, &D, lv, capturedByInit);
941 }
John McCall60d33652011-03-08 09:11:50 +0000942
John McCall34695852011-02-22 06:44:22 +0000943 // If this is a simple aggregate initialization, we can optimize it
944 // in various ways.
John McCall60d33652011-03-08 09:11:50 +0000945 assert(!capturedByInit && "constant init contains a capturing block?");
John McCall34695852011-02-22 06:44:22 +0000946
John McCall60d33652011-03-08 09:11:50 +0000947 bool isVolatile = type.isVolatileQualified();
John McCall34695852011-02-22 06:44:22 +0000948
John McCall60d33652011-03-08 09:11:50 +0000949 llvm::Constant *constant = CGM.EmitConstantExpr(D.getInit(), type, this);
950 assert(constant != 0 && "Wasn't a simple constant init?");
John McCall34695852011-02-22 06:44:22 +0000951
John McCall60d33652011-03-08 09:11:50 +0000952 llvm::Value *SizeVal =
953 llvm::ConstantInt::get(IntPtrTy,
954 getContext().getTypeSizeInChars(type).getQuantity());
John McCall34695852011-02-22 06:44:22 +0000955
Chris Lattner2acc6e32011-07-18 04:24:23 +0000956 llvm::Type *BP = Int8PtrTy;
John McCall60d33652011-03-08 09:11:50 +0000957 if (Loc->getType() != BP)
958 Loc = Builder.CreateBitCast(Loc, BP, "tmp");
Mon P Wang3ecd7852010-04-04 03:10:52 +0000959
John McCall60d33652011-03-08 09:11:50 +0000960 // If the initializer is all or mostly zeros, codegen with memset then do
961 // a few stores afterward.
962 if (shouldUseMemSetPlusStoresToInitialize(constant,
963 CGM.getTargetData().getTypeAllocSize(constant->getType()))) {
964 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
965 alignment.getQuantity(), isVolatile);
966 if (!constant->isNullValue()) {
967 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo());
968 emitStoresForInitAfterMemset(constant, Loc, isVolatile, Builder);
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +0000969 }
John McCall60d33652011-03-08 09:11:50 +0000970 } else {
971 // Otherwise, create a temporary global with the initializer then
972 // memcpy from the global to the alloca.
973 std::string Name = GetStaticDeclName(*this, D, ".");
974 llvm::GlobalVariable *GV =
975 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true,
976 llvm::GlobalValue::InternalLinkage,
977 constant, Name, 0, false, 0);
978 GV->setAlignment(alignment.getQuantity());
Eli Friedman460980d2011-05-27 22:32:55 +0000979 GV->setUnnamedAddr(true);
John McCall60d33652011-03-08 09:11:50 +0000980
981 llvm::Value *SrcPtr = GV;
982 if (SrcPtr->getType() != BP)
983 SrcPtr = Builder.CreateBitCast(SrcPtr, BP, "tmp");
984
985 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, alignment.getQuantity(),
986 isVolatile);
987 }
988}
989
990/// Emit an expression as an initializer for a variable at the given
991/// location. The expression is not necessarily the normal
992/// initializer for the variable, and the address is not necessarily
993/// its normal location.
994///
995/// \param init the initializing expression
996/// \param var the variable to act as if we're initializing
997/// \param loc the address to initialize; its type is a pointer
998/// to the LLVM mapping of the variable's type
999/// \param alignment the alignment of the address
1000/// \param capturedByInit true if the variable is a __block variable
1001/// whose address is potentially changed by the initializer
1002void CodeGenFunction::EmitExprAsInit(const Expr *init,
John McCallf85e1932011-06-15 23:02:42 +00001003 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001004 LValue lvalue,
John McCall60d33652011-03-08 09:11:50 +00001005 bool capturedByInit) {
John McCallf85e1932011-06-15 23:02:42 +00001006 QualType type = D->getType();
John McCall60d33652011-03-08 09:11:50 +00001007
1008 if (type->isReferenceType()) {
John McCalla07398e2011-06-16 04:16:24 +00001009 RValue rvalue = EmitReferenceBindingToExpr(init, D);
John McCallf85e1932011-06-15 23:02:42 +00001010 if (capturedByInit)
John McCalla07398e2011-06-16 04:16:24 +00001011 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall545d9962011-06-25 02:11:03 +00001012 EmitStoreThroughLValue(rvalue, lvalue);
John McCall34695852011-02-22 06:44:22 +00001013 } else if (!hasAggregateLLVMType(type)) {
John McCalla07398e2011-06-16 04:16:24 +00001014 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall34695852011-02-22 06:44:22 +00001015 } else if (type->isAnyComplexType()) {
John McCall60d33652011-03-08 09:11:50 +00001016 ComplexPairTy complex = EmitComplexExpr(init);
John McCalla07398e2011-06-16 04:16:24 +00001017 if (capturedByInit)
1018 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
1019 StoreComplexToAddr(complex, lvalue.getAddress(), lvalue.isVolatile());
John McCall34695852011-02-22 06:44:22 +00001020 } else {
1021 // TODO: how can we delay here if D is captured by its initializer?
John McCalla07398e2011-06-16 04:16:24 +00001022 EmitAggExpr(init, AggValueSlot::forLValue(lvalue, true, false));
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +00001023 }
John McCall34695852011-02-22 06:44:22 +00001024}
John McCallf1549f62010-07-06 01:34:17 +00001025
John McCallbdc4d802011-07-09 01:37:26 +00001026/// Enter a destroy cleanup for the given local variable.
1027void CodeGenFunction::emitAutoVarTypeCleanup(
1028 const CodeGenFunction::AutoVarEmission &emission,
1029 QualType::DestructionKind dtorKind) {
1030 assert(dtorKind != QualType::DK_none);
1031
1032 // Note that for __block variables, we want to destroy the
1033 // original stack object, not the possibly forwarded object.
1034 llvm::Value *addr = emission.getObjectAddress(*this);
1035
1036 const VarDecl *var = emission.Variable;
1037 QualType type = var->getType();
1038
1039 CleanupKind cleanupKind = NormalAndEHCleanup;
1040 CodeGenFunction::Destroyer *destroyer = 0;
1041
1042 switch (dtorKind) {
1043 case QualType::DK_none:
1044 llvm_unreachable("no cleanup for trivially-destructible variable");
1045
1046 case QualType::DK_cxx_destructor:
1047 // If there's an NRVO flag on the emission, we need a different
1048 // cleanup.
1049 if (emission.NRVOFlag) {
1050 assert(!type->isArrayType());
1051 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
1052 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr, dtor,
1053 emission.NRVOFlag);
1054 return;
1055 }
1056 break;
1057
1058 case QualType::DK_objc_strong_lifetime:
1059 // Suppress cleanups for pseudo-strong variables.
1060 if (var->isARCPseudoStrong()) return;
1061
1062 // Otherwise, consider whether to use an EH cleanup or not.
1063 cleanupKind = getARCCleanupKind();
1064
1065 // Use the imprecise destroyer by default.
1066 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1067 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1068 break;
1069
1070 case QualType::DK_objc_weak_lifetime:
1071 break;
1072 }
1073
1074 // If we haven't chosen a more specific destroyer, use the default.
1075 if (!destroyer) destroyer = &getDestroyer(dtorKind);
John McCall2673c682011-07-11 08:38:19 +00001076
1077 // Use an EH cleanup in array destructors iff the destructor itself
1078 // is being pushed as an EH cleanup.
1079 bool useEHCleanup = (cleanupKind & EHCleanup);
1080 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1081 useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001082}
1083
John McCall34695852011-02-22 06:44:22 +00001084void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +00001085 assert(emission.Variable && "emission was not valid!");
1086
John McCall34695852011-02-22 06:44:22 +00001087 // If this was emitted as a global constant, we're done.
1088 if (emission.wasEmittedAsGlobal()) return;
1089
John McCall57b3b6a2011-02-22 07:16:58 +00001090 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +00001091
John McCallbdc4d802011-07-09 01:37:26 +00001092 // Check the type for a cleanup.
1093 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1094 emitAutoVarTypeCleanup(emission, dtorKind);
John McCallf85e1932011-06-15 23:02:42 +00001095
John McCall0c24c802011-06-24 23:21:27 +00001096 // In GC mode, honor objc_precise_lifetime.
1097 if (getLangOptions().getGCMode() != LangOptions::NonGC &&
1098 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1099 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1100 }
1101
John McCall34695852011-02-22 06:44:22 +00001102 // Handle the cleanup attribute.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +00001103 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlsson69c68b72009-02-07 23:51:38 +00001104 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump1eb44332009-09-09 15:08:12 +00001105
John McCall34695852011-02-22 06:44:22 +00001106 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001107 assert(F && "Could not find function!");
Mike Stump1eb44332009-09-09 15:08:12 +00001108
Anders Carlssoncabec032009-04-26 00:34:20 +00001109 const CGFunctionInfo &Info = CGM.getTypes().getFunctionInfo(FD);
John McCall34695852011-02-22 06:44:22 +00001110 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001111 }
Mike Stump797b6322009-03-05 01:23:13 +00001112
John McCall34695852011-02-22 06:44:22 +00001113 // If this is a block variable, call _Block_object_destroy
1114 // (on the unforwarded address).
John McCall5af02db2011-03-31 01:59:53 +00001115 if (emission.IsByRef)
1116 enterByrefCleanup(emission);
Reid Spencer5f016e22007-07-11 17:01:13 +00001117}
1118
John McCallbdc4d802011-07-09 01:37:26 +00001119CodeGenFunction::Destroyer &
1120CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
John McCall0850e8d2011-07-09 09:09:00 +00001121 // This is surprisingly compiler-dependent. GCC 4.2 can't bind
1122 // references to functions directly in returns, and using '*&foo'
1123 // confuses MSVC. Luckily, the following code pattern works in both.
1124 Destroyer *destroyer = 0;
John McCallbdc4d802011-07-09 01:37:26 +00001125 switch (kind) {
1126 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCall0850e8d2011-07-09 09:09:00 +00001127 case QualType::DK_cxx_destructor:
1128 destroyer = &destroyCXXObject;
1129 break;
1130 case QualType::DK_objc_strong_lifetime:
1131 destroyer = &destroyARCStrongPrecise;
1132 break;
1133 case QualType::DK_objc_weak_lifetime:
1134 destroyer = &destroyARCWeak;
1135 break;
John McCallbdc4d802011-07-09 01:37:26 +00001136 }
John McCall0850e8d2011-07-09 09:09:00 +00001137 return *destroyer;
John McCallbdc4d802011-07-09 01:37:26 +00001138}
1139
John McCall9928c482011-07-12 16:41:08 +00001140/// pushDestroy - Push the standard destructor for the given type.
1141void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
1142 llvm::Value *addr, QualType type) {
1143 assert(dtorKind && "cannot push destructor for trivial type");
1144
1145 CleanupKind cleanupKind = getCleanupKind(dtorKind);
1146 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
1147 cleanupKind & EHCleanup);
1148}
1149
John McCallbdc4d802011-07-09 01:37:26 +00001150void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, llvm::Value *addr,
John McCall2673c682011-07-11 08:38:19 +00001151 QualType type, Destroyer &destroyer,
1152 bool useEHCleanupForArray) {
John McCall9928c482011-07-12 16:41:08 +00001153 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
1154 destroyer, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001155}
1156
John McCall2673c682011-07-11 08:38:19 +00001157/// emitDestroy - Immediately perform the destruction of the given
1158/// object.
1159///
1160/// \param addr - the address of the object; a type*
1161/// \param type - the type of the object; if an array type, all
1162/// objects are destroyed in reverse order
1163/// \param destroyer - the function to call to destroy individual
1164/// elements
1165/// \param useEHCleanupForArray - whether an EH cleanup should be
1166/// used when destroying array elements, in case one of the
1167/// destructions throws an exception
John McCallbdc4d802011-07-09 01:37:26 +00001168void CodeGenFunction::emitDestroy(llvm::Value *addr, QualType type,
John McCall2673c682011-07-11 08:38:19 +00001169 Destroyer &destroyer,
1170 bool useEHCleanupForArray) {
John McCallbdc4d802011-07-09 01:37:26 +00001171 const ArrayType *arrayType = getContext().getAsArrayType(type);
1172 if (!arrayType)
1173 return destroyer(*this, addr, type);
1174
1175 llvm::Value *begin = addr;
1176 llvm::Value *length = emitArrayLength(arrayType, type, begin);
John McCallfbf780a2011-07-13 08:09:46 +00001177
1178 // Normally we have to check whether the array is zero-length.
1179 bool checkZeroLength = true;
1180
1181 // But if the array length is constant, we can suppress that.
1182 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
1183 // ...and if it's constant zero, we can just skip the entire thing.
1184 if (constLength->isZero()) return;
1185 checkZeroLength = false;
1186 }
1187
John McCallbdc4d802011-07-09 01:37:26 +00001188 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCallfbf780a2011-07-13 08:09:46 +00001189 emitArrayDestroy(begin, end, type, destroyer,
1190 checkZeroLength, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001191}
1192
John McCall2673c682011-07-11 08:38:19 +00001193/// emitArrayDestroy - Destroys all the elements of the given array,
1194/// beginning from last to first. The array cannot be zero-length.
1195///
1196/// \param begin - a type* denoting the first element of the array
1197/// \param end - a type* denoting one past the end of the array
1198/// \param type - the element type of the array
1199/// \param destroyer - the function to call to destroy elements
1200/// \param useEHCleanup - whether to push an EH cleanup to destroy
1201/// the remaining elements in case the destruction of a single
1202/// element throws
John McCallbdc4d802011-07-09 01:37:26 +00001203void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
1204 llvm::Value *end,
1205 QualType type,
John McCall2673c682011-07-11 08:38:19 +00001206 Destroyer &destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001207 bool checkZeroLength,
John McCall2673c682011-07-11 08:38:19 +00001208 bool useEHCleanup) {
John McCallbdc4d802011-07-09 01:37:26 +00001209 assert(!type->isArrayType());
1210
1211 // The basic structure here is a do-while loop, because we don't
1212 // need to check for the zero-element case.
1213 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
1214 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
1215
John McCallfbf780a2011-07-13 08:09:46 +00001216 if (checkZeroLength) {
1217 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
1218 "arraydestroy.isempty");
1219 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
1220 }
1221
John McCallbdc4d802011-07-09 01:37:26 +00001222 // Enter the loop body, making that address the current address.
1223 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1224 EmitBlock(bodyBB);
1225 llvm::PHINode *elementPast =
1226 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
1227 elementPast->addIncoming(end, entryBB);
1228
1229 // Shift the address back by one element.
1230 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
1231 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
1232 "arraydestroy.element");
1233
John McCall2673c682011-07-11 08:38:19 +00001234 if (useEHCleanup)
1235 pushRegularPartialArrayCleanup(begin, element, type, destroyer);
1236
John McCallbdc4d802011-07-09 01:37:26 +00001237 // Perform the actual destruction there.
1238 destroyer(*this, element, type);
1239
John McCall2673c682011-07-11 08:38:19 +00001240 if (useEHCleanup)
1241 PopCleanupBlock();
1242
John McCallbdc4d802011-07-09 01:37:26 +00001243 // Check whether we've reached the end.
1244 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
1245 Builder.CreateCondBr(done, doneBB, bodyBB);
1246 elementPast->addIncoming(element, Builder.GetInsertBlock());
1247
1248 // Done.
1249 EmitBlock(doneBB);
1250}
1251
John McCall2673c682011-07-11 08:38:19 +00001252/// Perform partial array destruction as if in an EH cleanup. Unlike
1253/// emitArrayDestroy, the element type here may still be an array type.
John McCall2673c682011-07-11 08:38:19 +00001254static void emitPartialArrayDestroy(CodeGenFunction &CGF,
1255 llvm::Value *begin, llvm::Value *end,
1256 QualType type,
1257 CodeGenFunction::Destroyer &destroyer) {
John McCall2673c682011-07-11 08:38:19 +00001258 // If the element type is itself an array, drill down.
John McCallfbf780a2011-07-13 08:09:46 +00001259 unsigned arrayDepth = 0;
John McCall2673c682011-07-11 08:38:19 +00001260 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
1261 // VLAs don't require a GEP index to walk into.
1262 if (!isa<VariableArrayType>(arrayType))
John McCallfbf780a2011-07-13 08:09:46 +00001263 arrayDepth++;
John McCall2673c682011-07-11 08:38:19 +00001264 type = arrayType->getElementType();
1265 }
John McCallfbf780a2011-07-13 08:09:46 +00001266
1267 if (arrayDepth) {
1268 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, arrayDepth+1);
1269
Chris Lattner5f9e2722011-07-23 10:55:15 +00001270 SmallVector<llvm::Value*,4> gepIndices(arrayDepth, zero);
Jay Foad0f6ac7c2011-07-22 08:16:57 +00001271 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
1272 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall2673c682011-07-11 08:38:19 +00001273 }
1274
John McCallfbf780a2011-07-13 08:09:46 +00001275 // Destroy the array. We don't ever need an EH cleanup because we
1276 // assume that we're in an EH cleanup ourselves, so a throwing
1277 // destructor causes an immediate terminate.
1278 CGF.emitArrayDestroy(begin, end, type, destroyer,
1279 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall2673c682011-07-11 08:38:19 +00001280}
1281
John McCallbdc4d802011-07-09 01:37:26 +00001282namespace {
John McCall2673c682011-07-11 08:38:19 +00001283 /// RegularPartialArrayDestroy - a cleanup which performs a partial
1284 /// array destroy where the end pointer is regularly determined and
1285 /// does not need to be loaded from a local.
1286 class RegularPartialArrayDestroy : public EHScopeStack::Cleanup {
1287 llvm::Value *ArrayBegin;
1288 llvm::Value *ArrayEnd;
1289 QualType ElementType;
1290 CodeGenFunction::Destroyer &Destroyer;
1291 public:
1292 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
1293 QualType elementType,
1294 CodeGenFunction::Destroyer *destroyer)
1295 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
1296 ElementType(elementType), Destroyer(*destroyer) {}
1297
John McCallad346f42011-07-12 20:27:29 +00001298 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +00001299 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
1300 ElementType, Destroyer);
1301 }
1302 };
1303
1304 /// IrregularPartialArrayDestroy - a cleanup which performs a
1305 /// partial array destroy where the end pointer is irregularly
1306 /// determined and must be loaded from a local.
1307 class IrregularPartialArrayDestroy : public EHScopeStack::Cleanup {
John McCallbdc4d802011-07-09 01:37:26 +00001308 llvm::Value *ArrayBegin;
1309 llvm::Value *ArrayEndPointer;
1310 QualType ElementType;
1311 CodeGenFunction::Destroyer &Destroyer;
1312 public:
John McCall2673c682011-07-11 08:38:19 +00001313 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
1314 llvm::Value *arrayEndPointer,
1315 QualType elementType,
1316 CodeGenFunction::Destroyer *destroyer)
John McCallbdc4d802011-07-09 01:37:26 +00001317 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
1318 ElementType(elementType), Destroyer(*destroyer) {}
1319
John McCallad346f42011-07-12 20:27:29 +00001320 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallbdc4d802011-07-09 01:37:26 +00001321 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall2673c682011-07-11 08:38:19 +00001322 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
1323 ElementType, Destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001324 }
1325 };
1326}
1327
John McCall2673c682011-07-11 08:38:19 +00001328/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCallbdc4d802011-07-09 01:37:26 +00001329/// already-constructed elements of the given array. The cleanup
John McCall2673c682011-07-11 08:38:19 +00001330/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
John McCallbdc4d802011-07-09 01:37:26 +00001331///
1332/// \param elementType - the immediate element type of the array;
1333/// possibly still an array type
1334/// \param array - a value of type elementType*
1335/// \param destructionKind - the kind of destruction required
1336/// \param initializedElementCount - a value of type size_t* holding
1337/// the number of successfully-constructed elements
John McCall9928c482011-07-12 16:41:08 +00001338void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall2673c682011-07-11 08:38:19 +00001339 llvm::Value *arrayEndPointer,
1340 QualType elementType,
1341 Destroyer &destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001342 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
1343 arrayBegin, arrayEndPointer,
John McCall2673c682011-07-11 08:38:19 +00001344 elementType, &destroyer);
1345}
1346
1347/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
1348/// already-constructed elements of the given array. The cleanup
1349/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
1350///
1351/// \param elementType - the immediate element type of the array;
1352/// possibly still an array type
1353/// \param array - a value of type elementType*
1354/// \param destructionKind - the kind of destruction required
1355/// \param initializedElementCount - a value of type size_t* holding
1356/// the number of successfully-constructed elements
1357void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1358 llvm::Value *arrayEnd,
1359 QualType elementType,
1360 Destroyer &destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001361 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall2673c682011-07-11 08:38:19 +00001362 arrayBegin, arrayEnd,
1363 elementType, &destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001364}
1365
John McCallf85e1932011-06-15 23:02:42 +00001366namespace {
1367 /// A cleanup to perform a release of an object at the end of a
1368 /// function. This is used to balance out the incoming +1 of a
1369 /// ns_consumed argument when we can't reasonably do that just by
1370 /// not doing the initial retain for a __block argument.
1371 struct ConsumeARCParameter : EHScopeStack::Cleanup {
1372 ConsumeARCParameter(llvm::Value *param) : Param(param) {}
1373
1374 llvm::Value *Param;
1375
John McCallad346f42011-07-12 20:27:29 +00001376 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +00001377 CGF.EmitARCRelease(Param, /*precise*/ false);
1378 }
1379 };
1380}
1381
Mike Stump1eb44332009-09-09 15:08:12 +00001382/// Emit an alloca (or GlobalValue depending on target)
Chris Lattner2621fd12008-05-08 05:58:21 +00001383/// for the specified parameter and set up LocalDeclMap.
Devang Patel093ac462011-03-03 20:13:15 +00001384void CodeGenFunction::EmitParmDecl(const VarDecl &D, llvm::Value *Arg,
1385 unsigned ArgNo) {
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001386 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +00001387 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001388 "Invalid argument to EmitParmDecl");
John McCall8178df32011-02-22 22:38:33 +00001389
1390 Arg->setName(D.getName());
1391
1392 // Use better IR generation for certain implicit parameters.
1393 if (isa<ImplicitParamDecl>(D)) {
1394 // The only implicit argument a block has is its literal.
1395 if (BlockInfo) {
1396 LocalDeclMap[&D] = Arg;
1397
1398 if (CGDebugInfo *DI = getDebugInfo()) {
1399 DI->setLocation(D.getLocation());
1400 DI->EmitDeclareOfBlockLiteralArgVariable(*BlockInfo, Arg, Builder);
1401 }
1402
1403 return;
1404 }
1405 }
1406
Chris Lattner8bcfc5b2008-04-06 23:10:54 +00001407 QualType Ty = D.getType();
Mike Stump1eb44332009-09-09 15:08:12 +00001408
Reid Spencer5f016e22007-07-11 17:01:13 +00001409 llvm::Value *DeclPtr;
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001410 // If this is an aggregate or variable sized value, reuse the input pointer.
1411 if (!Ty->isConstantSizeType() ||
1412 CodeGenFunction::hasAggregateLLVMType(Ty)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001413 DeclPtr = Arg;
Reid Spencer5f016e22007-07-11 17:01:13 +00001414 } else {
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001415 // Otherwise, create a temporary to hold the value.
Daniel Dunbar195337d2010-02-09 02:48:28 +00001416 DeclPtr = CreateMemTemp(Ty, D.getName() + ".addr");
Mike Stump1eb44332009-09-09 15:08:12 +00001417
John McCallf85e1932011-06-15 23:02:42 +00001418 bool doStore = true;
1419
1420 Qualifiers qs = Ty.getQualifiers();
1421
1422 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
1423 // We honor __attribute__((ns_consumed)) for types with lifetime.
1424 // For __strong, it's handled by just skipping the initial retain;
1425 // otherwise we have to balance out the initial +1 with an extra
1426 // cleanup to do the release at the end of the function.
1427 bool isConsumed = D.hasAttr<NSConsumedAttr>();
1428
1429 // 'self' is always formally __strong, but if this is not an
1430 // init method then we don't want to retain it.
John McCall7acddac2011-06-17 06:42:21 +00001431 if (D.isARCPseudoStrong()) {
John McCallf85e1932011-06-15 23:02:42 +00001432 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl);
1433 assert(&D == method->getSelfDecl());
John McCall7acddac2011-06-17 06:42:21 +00001434 assert(lt == Qualifiers::OCL_Strong);
1435 assert(qs.hasConst());
John McCallf85e1932011-06-15 23:02:42 +00001436 assert(method->getMethodFamily() != OMF_init);
John McCall175d6592011-06-15 23:40:09 +00001437 (void) method;
John McCallf85e1932011-06-15 23:02:42 +00001438 lt = Qualifiers::OCL_ExplicitNone;
1439 }
1440
1441 if (lt == Qualifiers::OCL_Strong) {
1442 if (!isConsumed)
1443 // Don't use objc_retainBlock for block pointers, because we
1444 // don't want to Block_copy something just because we got it
1445 // as a parameter.
1446 Arg = EmitARCRetainNonBlock(Arg);
1447 } else {
1448 // Push the cleanup for a consumed parameter.
1449 if (isConsumed)
1450 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), Arg);
1451
1452 if (lt == Qualifiers::OCL_Weak) {
1453 EmitARCInitWeak(DeclPtr, Arg);
1454 doStore = false; // The weak init is a store, no need to do two
1455 }
1456 }
1457
1458 // Enter the cleanup scope.
1459 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
1460 }
1461
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001462 // Store the initial value into the alloca.
John McCall545d9962011-06-25 02:11:03 +00001463 if (doStore) {
1464 LValue lv = MakeAddrLValue(DeclPtr, Ty,
1465 getContext().getDeclAlign(&D).getQuantity());
1466 EmitStoreOfScalar(Arg, lv);
1467 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001468 }
1469
1470 llvm::Value *&DMEntry = LocalDeclMap[&D];
1471 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
1472 DMEntry = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00001473
1474 // Emit debug info for param declaration.
Devang Patel98703d32011-06-15 17:57:08 +00001475 if (CGDebugInfo *DI = getDebugInfo())
Devang Patel093ac462011-03-03 20:13:15 +00001476 DI->EmitDeclareOfArgVariable(&D, DeclPtr, ArgNo, Builder);
Reid Spencer5f016e22007-07-11 17:01:13 +00001477}