blob: a372d7d6964fa3fd4830b907307ee91e2efc8d56 [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 =
Chandler Carruth64211622011-07-25 21:09:52 +0000277 CGM.EmitAnnotateAttr(GV, AA, SM.getExpansionLineNumber(D.getLocation()));
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000278 CGM.AddAnnotation(Ann);
279 }
280
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000281 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
Daniel Dunbar30510ab2009-02-12 23:32:54 +0000282 GV->setSection(SA->getName());
Mike Stump1eb44332009-09-09 15:08:12 +0000283
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000284 if (D.hasAttr<UsedAttr>())
Daniel Dunbar5c61d972009-02-13 22:08:43 +0000285 CGM.AddUsedGlobal(GV);
286
Daniel Dunbare5731f82009-02-25 20:08:33 +0000287 // We may have to cast the constant because of the initializer
288 // mismatch above.
289 //
290 // FIXME: It is really dangerous to store this in the map; if anyone
291 // RAUW's the GV uses of this constant will be invalid.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000292 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(D.getType());
293 llvm::Type *LPtrTy =
Peter Collingbourne207f4d82011-03-18 22:38:29 +0000294 LTy->getPointerTo(CGM.getContext().getTargetAddressSpace(D.getType()));
Owen Anderson3c4972d2009-07-29 18:54:39 +0000295 DMEntry = llvm::ConstantExpr::getBitCast(GV, LPtrTy);
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000296
297 // Emit global variable debug descriptor for static vars.
Anders Carlssone896d982009-02-13 08:11:52 +0000298 CGDebugInfo *DI = getDebugInfo();
Mike Stump4451bd92009-02-20 00:19:45 +0000299 if (DI) {
Daniel Dunbar66031a52008-10-17 16:15:48 +0000300 DI->setLocation(D.getLocation());
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000301 DI->EmitGlobalVariable(static_cast<llvm::GlobalVariable *>(GV), &D);
302 }
Anders Carlsson1a86b332007-10-17 00:52:43 +0000303}
Mike Stump1eb44332009-09-09 15:08:12 +0000304
John McCallda65ea82010-07-13 20:32:21 +0000305namespace {
John McCallbdc4d802011-07-09 01:37:26 +0000306 struct DestroyObject : EHScopeStack::Cleanup {
307 DestroyObject(llvm::Value *addr, QualType type,
John McCall2673c682011-07-11 08:38:19 +0000308 CodeGenFunction::Destroyer *destroyer,
309 bool useEHCleanupForArray)
310 : addr(addr), type(type), destroyer(*destroyer),
311 useEHCleanupForArray(useEHCleanupForArray) {}
John McCallda65ea82010-07-13 20:32:21 +0000312
John McCallbdc4d802011-07-09 01:37:26 +0000313 llvm::Value *addr;
314 QualType type;
315 CodeGenFunction::Destroyer &destroyer;
John McCall2673c682011-07-11 08:38:19 +0000316 bool useEHCleanupForArray;
John McCallda65ea82010-07-13 20:32:21 +0000317
John McCallad346f42011-07-12 20:27:29 +0000318 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +0000319 // Don't use an EH cleanup recursively from an EH cleanup.
John McCallad346f42011-07-12 20:27:29 +0000320 bool useEHCleanupForArray =
321 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall2673c682011-07-11 08:38:19 +0000322
323 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCallda65ea82010-07-13 20:32:21 +0000324 }
325 };
326
John McCallbdc4d802011-07-09 01:37:26 +0000327 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
328 DestroyNRVOVariable(llvm::Value *addr,
329 const CXXDestructorDecl *Dtor,
330 llvm::Value *NRVOFlag)
331 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {}
John McCallda65ea82010-07-13 20:32:21 +0000332
333 const CXXDestructorDecl *Dtor;
334 llvm::Value *NRVOFlag;
335 llvm::Value *Loc;
336
John McCallad346f42011-07-12 20:27:29 +0000337 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallda65ea82010-07-13 20:32:21 +0000338 // Along the exceptions path we always execute the dtor.
John McCallad346f42011-07-12 20:27:29 +0000339 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCallda65ea82010-07-13 20:32:21 +0000340
341 llvm::BasicBlock *SkipDtorBB = 0;
342 if (NRVO) {
343 // If we exited via NRVO, we skip the destructor call.
344 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
345 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
346 llvm::Value *DidNRVO = CGF.Builder.CreateLoad(NRVOFlag, "nrvo.val");
347 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
348 CGF.EmitBlock(RunDtorBB);
349 }
350
351 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
352 /*ForVirtualBase=*/false, Loc);
353
354 if (NRVO) CGF.EmitBlock(SkipDtorBB);
355 }
356 };
John McCallda65ea82010-07-13 20:32:21 +0000357
John McCall1f0fca52010-07-21 07:22:38 +0000358 struct CallStackRestore : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000359 llvm::Value *Stack;
360 CallStackRestore(llvm::Value *Stack) : Stack(Stack) {}
John McCallad346f42011-07-12 20:27:29 +0000361 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCalld8715092010-07-21 06:13:08 +0000362 llvm::Value *V = CGF.Builder.CreateLoad(Stack, "tmp");
363 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
364 CGF.Builder.CreateCall(F, V);
365 }
366 };
367
John McCall0c24c802011-06-24 23:21:27 +0000368 struct ExtendGCLifetime : EHScopeStack::Cleanup {
369 const VarDecl &Var;
370 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
371
John McCallad346f42011-07-12 20:27:29 +0000372 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall0c24c802011-06-24 23:21:27 +0000373 // Compute the address of the local variable, in case it's a
374 // byref or something.
375 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), Var.getType(), VK_LValue,
376 SourceLocation());
377 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE));
378 CGF.EmitExtendGCLifetime(value);
379 }
380 };
381
John McCall1f0fca52010-07-21 07:22:38 +0000382 struct CallCleanupFunction : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000383 llvm::Constant *CleanupFn;
384 const CGFunctionInfo &FnInfo;
John McCalld8715092010-07-21 06:13:08 +0000385 const VarDecl &Var;
386
387 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCall34695852011-02-22 06:44:22 +0000388 const VarDecl *Var)
389 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalld8715092010-07-21 06:13:08 +0000390
John McCallad346f42011-07-12 20:27:29 +0000391 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall34695852011-02-22 06:44:22 +0000392 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), Var.getType(), VK_LValue,
393 SourceLocation());
394 // Compute the address of the local variable, in case it's a byref
395 // or something.
396 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getAddress();
397
John McCalld8715092010-07-21 06:13:08 +0000398 // In some cases, the type of the function argument will be different from
399 // the type of the pointer. An example of this is
400 // void f(void* arg);
401 // __attribute__((cleanup(f))) void *g;
402 //
403 // To fix this we insert a bitcast here.
404 QualType ArgTy = FnInfo.arg_begin()->type;
405 llvm::Value *Arg =
406 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
407
408 CallArgList Args;
Eli Friedman04c9a492011-05-02 17:57:46 +0000409 Args.add(RValue::get(Arg),
410 CGF.getContext().getPointerType(Var.getType()));
John McCalld8715092010-07-21 06:13:08 +0000411 CGF.EmitCall(FnInfo, CleanupFn, ReturnValueSlot(), Args);
412 }
413 };
John McCalld8715092010-07-21 06:13:08 +0000414}
415
John McCallf85e1932011-06-15 23:02:42 +0000416/// EmitAutoVarWithLifetime - Does the setup required for an automatic
417/// variable with lifetime.
418static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
419 llvm::Value *addr,
420 Qualifiers::ObjCLifetime lifetime) {
421 switch (lifetime) {
422 case Qualifiers::OCL_None:
423 llvm_unreachable("present but none");
424
425 case Qualifiers::OCL_ExplicitNone:
426 // nothing to do
427 break;
428
429 case Qualifiers::OCL_Strong: {
John McCall9928c482011-07-12 16:41:08 +0000430 CodeGenFunction::Destroyer &destroyer =
431 (var.hasAttr<ObjCPreciseLifetimeAttr>()
432 ? CodeGenFunction::destroyARCStrongPrecise
433 : CodeGenFunction::destroyARCStrongImprecise);
434
435 CleanupKind cleanupKind = CGF.getARCCleanupKind();
436 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
437 cleanupKind & EHCleanup);
John McCallf85e1932011-06-15 23:02:42 +0000438 break;
439 }
440 case Qualifiers::OCL_Autoreleasing:
441 // nothing to do
442 break;
443
444 case Qualifiers::OCL_Weak:
445 // __weak objects always get EH cleanups; otherwise, exceptions
446 // could cause really nasty crashes instead of mere leaks.
John McCall9928c482011-07-12 16:41:08 +0000447 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
448 CodeGenFunction::destroyARCWeak,
449 /*useEHCleanup*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000450 break;
451 }
452}
453
454static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
455 if (const Expr *e = dyn_cast<Expr>(s)) {
456 // Skip the most common kinds of expressions that make
457 // hierarchy-walking expensive.
458 s = e = e->IgnoreParenCasts();
459
460 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
461 return (ref->getDecl() == &var);
462 }
463
464 for (Stmt::const_child_range children = s->children(); children; ++children)
Fariborz Jahanian8fefc8e2011-06-29 20:00:16 +0000465 // children might be null; as in missing decl or conditional of an if-stmt.
466 if ((*children) && isAccessedBy(var, *children))
John McCallf85e1932011-06-15 23:02:42 +0000467 return true;
468
469 return false;
470}
471
472static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
473 if (!decl) return false;
474 if (!isa<VarDecl>(decl)) return false;
475 const VarDecl *var = cast<VarDecl>(decl);
476 return isAccessedBy(*var, e);
477}
478
John McCalla07398e2011-06-16 04:16:24 +0000479static void drillIntoBlockVariable(CodeGenFunction &CGF,
480 LValue &lvalue,
481 const VarDecl *var) {
482 lvalue.setAddress(CGF.BuildBlockByrefAddress(lvalue.getAddress(), var));
483}
484
John McCallf85e1932011-06-15 23:02:42 +0000485void CodeGenFunction::EmitScalarInit(const Expr *init,
486 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +0000487 LValue lvalue,
488 bool capturedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000489 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCallf85e1932011-06-15 23:02:42 +0000490 if (!lifetime) {
491 llvm::Value *value = EmitScalarExpr(init);
John McCalla07398e2011-06-16 04:16:24 +0000492 if (capturedByInit)
493 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall545d9962011-06-25 02:11:03 +0000494 EmitStoreThroughLValue(RValue::get(value), lvalue);
John McCallf85e1932011-06-15 23:02:42 +0000495 return;
496 }
497
498 // If we're emitting a value with lifetime, we have to do the
499 // initialization *before* we leave the cleanup scopes.
500 CodeGenFunction::RunCleanupsScope Scope(*this);
501 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init))
502 init = ewc->getSubExpr();
503
504 // We have to maintain the illusion that the variable is
505 // zero-initialized. If the variable might be accessed in its
506 // initializer, zero-initialize before running the initializer, then
507 // actually perform the initialization with an assign.
508 bool accessedByInit = false;
509 if (lifetime != Qualifiers::OCL_ExplicitNone)
510 accessedByInit = isAccessedBy(D, init);
511 if (accessedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000512 LValue tempLV = lvalue;
John McCallf85e1932011-06-15 23:02:42 +0000513 // Drill down to the __block object if necessary.
John McCallf85e1932011-06-15 23:02:42 +0000514 if (capturedByInit) {
515 // We can use a simple GEP for this because it can't have been
516 // moved yet.
John McCalla07398e2011-06-16 04:16:24 +0000517 tempLV.setAddress(Builder.CreateStructGEP(tempLV.getAddress(),
518 getByRefValueLLVMField(cast<VarDecl>(D))));
John McCallf85e1932011-06-15 23:02:42 +0000519 }
520
Chris Lattner2acc6e32011-07-18 04:24:23 +0000521 llvm::PointerType *ty
John McCalla07398e2011-06-16 04:16:24 +0000522 = cast<llvm::PointerType>(tempLV.getAddress()->getType());
John McCallf85e1932011-06-15 23:02:42 +0000523 ty = cast<llvm::PointerType>(ty->getElementType());
524
525 llvm::Value *zero = llvm::ConstantPointerNull::get(ty);
526
527 // If __weak, we want to use a barrier under certain conditions.
528 if (lifetime == Qualifiers::OCL_Weak)
John McCalla07398e2011-06-16 04:16:24 +0000529 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCallf85e1932011-06-15 23:02:42 +0000530
531 // Otherwise just do a simple store.
532 else
John McCalla07398e2011-06-16 04:16:24 +0000533 EmitStoreOfScalar(zero, tempLV);
John McCallf85e1932011-06-15 23:02:42 +0000534 }
535
536 // Emit the initializer.
537 llvm::Value *value = 0;
538
539 switch (lifetime) {
540 case Qualifiers::OCL_None:
541 llvm_unreachable("present but none");
542
543 case Qualifiers::OCL_ExplicitNone:
544 // nothing to do
545 value = EmitScalarExpr(init);
546 break;
547
548 case Qualifiers::OCL_Strong: {
549 value = EmitARCRetainScalarExpr(init);
550 break;
551 }
552
553 case Qualifiers::OCL_Weak: {
554 // No way to optimize a producing initializer into this. It's not
555 // worth optimizing for, because the value will immediately
556 // disappear in the common case.
557 value = EmitScalarExpr(init);
558
John McCalla07398e2011-06-16 04:16:24 +0000559 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000560 if (accessedByInit)
John McCalla07398e2011-06-16 04:16:24 +0000561 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000562 else
John McCalla07398e2011-06-16 04:16:24 +0000563 EmitARCInitWeak(lvalue.getAddress(), value);
John McCallf85e1932011-06-15 23:02:42 +0000564 return;
565 }
566
567 case Qualifiers::OCL_Autoreleasing:
568 value = EmitARCRetainAutoreleaseScalarExpr(init);
569 break;
570 }
571
John McCalla07398e2011-06-16 04:16:24 +0000572 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000573
574 // If the variable might have been accessed by its initializer, we
575 // might have to initialize with a barrier. We have to do this for
576 // both __weak and __strong, but __weak got filtered out above.
577 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
John McCalla07398e2011-06-16 04:16:24 +0000578 llvm::Value *oldValue = EmitLoadOfScalar(lvalue);
579 EmitStoreOfScalar(value, lvalue);
John McCallf85e1932011-06-15 23:02:42 +0000580 EmitARCRelease(oldValue, /*precise*/ false);
581 return;
582 }
583
John McCalla07398e2011-06-16 04:16:24 +0000584 EmitStoreOfScalar(value, lvalue);
John McCallf85e1932011-06-15 23:02:42 +0000585}
Chris Lattner94cd0112010-12-01 02:05:19 +0000586
John McCall7acddac2011-06-17 06:42:21 +0000587/// EmitScalarInit - Initialize the given lvalue with the given object.
588void CodeGenFunction::EmitScalarInit(llvm::Value *init, LValue lvalue) {
589 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
590 if (!lifetime)
John McCall545d9962011-06-25 02:11:03 +0000591 return EmitStoreThroughLValue(RValue::get(init), lvalue);
John McCall7acddac2011-06-17 06:42:21 +0000592
593 switch (lifetime) {
594 case Qualifiers::OCL_None:
595 llvm_unreachable("present but none");
596
597 case Qualifiers::OCL_ExplicitNone:
598 // nothing to do
599 break;
600
601 case Qualifiers::OCL_Strong:
602 init = EmitARCRetain(lvalue.getType(), init);
603 break;
604
605 case Qualifiers::OCL_Weak:
606 // Initialize and then skip the primitive store.
607 EmitARCInitWeak(lvalue.getAddress(), init);
608 return;
609
610 case Qualifiers::OCL_Autoreleasing:
611 init = EmitARCRetainAutorelease(lvalue.getType(), init);
612 break;
613 }
614
615 EmitStoreOfScalar(init, lvalue);
616}
617
Chris Lattner94cd0112010-12-01 02:05:19 +0000618/// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the
619/// non-zero parts of the specified initializer with equal or fewer than
620/// NumStores scalar stores.
621static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init,
622 unsigned &NumStores) {
Chris Lattner70b02942010-12-02 01:58:41 +0000623 // Zero and Undef never requires any extra stores.
624 if (isa<llvm::ConstantAggregateZero>(Init) ||
625 isa<llvm::ConstantPointerNull>(Init) ||
626 isa<llvm::UndefValue>(Init))
627 return true;
628 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
629 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
630 isa<llvm::ConstantExpr>(Init))
631 return Init->isNullValue() || NumStores--;
632
633 // See if we can emit each element.
634 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
635 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
636 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
637 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
638 return false;
639 }
640 return true;
641 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000642
643 // Anything else is hard and scary.
644 return false;
645}
646
647/// emitStoresForInitAfterMemset - For inits that
648/// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar
649/// stores that would be required.
650static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc,
John McCall34695852011-02-22 06:44:22 +0000651 bool isVolatile, CGBuilderTy &Builder) {
Chris Lattner94cd0112010-12-01 02:05:19 +0000652 // Zero doesn't require any stores.
Chris Lattner70b02942010-12-02 01:58:41 +0000653 if (isa<llvm::ConstantAggregateZero>(Init) ||
654 isa<llvm::ConstantPointerNull>(Init) ||
655 isa<llvm::UndefValue>(Init))
656 return;
Chris Lattner94cd0112010-12-01 02:05:19 +0000657
Chris Lattner70b02942010-12-02 01:58:41 +0000658 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
659 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
660 isa<llvm::ConstantExpr>(Init)) {
661 if (!Init->isNullValue())
John McCall34695852011-02-22 06:44:22 +0000662 Builder.CreateStore(Init, Loc, isVolatile);
Chris Lattner70b02942010-12-02 01:58:41 +0000663 return;
664 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000665
Chris Lattner70b02942010-12-02 01:58:41 +0000666 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
667 "Unknown value type!");
668
669 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
670 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
671 if (Elt->isNullValue()) continue;
672
673 // Otherwise, get a pointer to the element and emit it.
674 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
John McCall34695852011-02-22 06:44:22 +0000675 isVolatile, Builder);
Chris Lattner70b02942010-12-02 01:58:41 +0000676 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000677}
678
679
680/// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset
681/// plus some stores to initialize a local variable instead of using a memcpy
682/// from a constant global. It is beneficial to use memset if the global is all
683/// zeros, or mostly zeros and large.
684static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init,
685 uint64_t GlobalSize) {
686 // If a global is all zeros, always use a memset.
687 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
688
689
690 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
691 // do it if it will require 6 or fewer scalar stores.
692 // TODO: Should budget depends on the size? Avoiding a large global warrants
693 // plopping in more stores.
694 unsigned StoreBudget = 6;
695 uint64_t SizeLimit = 32;
696
697 return GlobalSize > SizeLimit &&
698 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget);
699}
700
701
Nick Lewyckya9de3fa2010-12-30 20:21:55 +0000702/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Reid Spencer5f016e22007-07-11 17:01:13 +0000703/// variable declaration with auto, register, or no storage class specifier.
Chris Lattner2621fd12008-05-08 05:58:21 +0000704/// These turn into simple stack objects, or GlobalValues depending on target.
John McCall34695852011-02-22 06:44:22 +0000705void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
706 AutoVarEmission emission = EmitAutoVarAlloca(D);
707 EmitAutoVarInit(emission);
708 EmitAutoVarCleanups(emission);
709}
Reid Spencer5f016e22007-07-11 17:01:13 +0000710
John McCall34695852011-02-22 06:44:22 +0000711/// EmitAutoVarAlloca - Emit the alloca and debug information for a
712/// local variable. Does not emit initalization or destruction.
713CodeGenFunction::AutoVarEmission
714CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
715 QualType Ty = D.getType();
716
717 AutoVarEmission emission(D);
718
719 bool isByRef = D.hasAttr<BlocksAttr>();
720 emission.IsByRef = isByRef;
721
722 CharUnits alignment = getContext().getDeclAlign(&D);
723 emission.Alignment = alignment;
724
John McCallbc8d40d2011-06-24 21:55:10 +0000725 // If the type is variably-modified, emit all the VLA sizes for it.
726 if (Ty->isVariablyModifiedType())
727 EmitVariablyModifiedType(Ty);
728
Reid Spencer5f016e22007-07-11 17:01:13 +0000729 llvm::Value *DeclPtr;
Eli Friedman3c2b3172008-02-15 12:20:59 +0000730 if (Ty->isConstantSizeType()) {
Chris Lattner2621fd12008-05-08 05:58:21 +0000731 if (!Target.useGlobalsForAutomaticVariables()) {
John McCall34695852011-02-22 06:44:22 +0000732 bool NRVO = getContext().getLangOptions().ElideConstructors &&
733 D.isNRVOVariable();
734
735 // If this value is a POD array or struct with a statically
736 // determinable constant initializer, there are optimizations we
737 // can do.
738 // TODO: we can potentially constant-evaluate non-POD structs and
739 // arrays as long as the initialization is trivial (e.g. if they
740 // have a non-trivial destructor, but not a non-trivial constructor).
741 if (D.getInit() &&
John McCallf85e1932011-06-15 23:02:42 +0000742 (Ty->isArrayType() || Ty->isRecordType()) &&
743 (Ty.isPODType(getContext()) ||
744 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
John McCall4204f072010-08-02 21:13:48 +0000745 D.getInit()->isConstantInitializer(getContext(), false)) {
John McCall34695852011-02-22 06:44:22 +0000746
747 // If the variable's a const type, and it's neither an NRVO
748 // candidate nor a __block variable, emit it as a global instead.
749 if (CGM.getCodeGenOpts().MergeAllConstants && Ty.isConstQualified() &&
750 !NRVO && !isByRef) {
Douglas Gregor4707b9a2011-03-06 23:28:21 +0000751 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCall34695852011-02-22 06:44:22 +0000752
753 emission.Address = 0; // signal this condition to later callbacks
754 assert(emission.wasEmittedAsGlobal());
755 return emission;
Tanya Lattner59876c22009-11-04 01:18:09 +0000756 }
John McCall34695852011-02-22 06:44:22 +0000757
758 // Otherwise, tell the initialization code that we're in this case.
759 emission.IsConstantAggregate = true;
Tanya Lattner59876c22009-11-04 01:18:09 +0000760 }
761
Douglas Gregord86c4772010-05-15 06:46:45 +0000762 // A normal fixed sized variable becomes an alloca in the entry block,
763 // unless it's an NRVO variable.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000764 llvm::Type *LTy = ConvertTypeForMem(Ty);
Douglas Gregord86c4772010-05-15 06:46:45 +0000765
766 if (NRVO) {
767 // The named return value optimization: allocate this variable in the
768 // return slot, so that we can elide the copy when returning this
769 // variable (C++0x [class.copy]p34).
770 DeclPtr = ReturnValue;
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000771
772 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
773 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) {
774 // Create a flag that is used to indicate when the NRVO was applied
775 // to this variable. Set it to zero to indicate that NRVO was not
776 // applied.
Chris Lattner4c53dc12010-12-01 01:47:15 +0000777 llvm::Value *Zero = Builder.getFalse();
John McCall34695852011-02-22 06:44:22 +0000778 llvm::Value *NRVOFlag = CreateTempAlloca(Zero->getType(), "nrvo");
Nick Lewyckya03733b2011-02-16 23:59:08 +0000779 EnsureInsertPoint();
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000780 Builder.CreateStore(Zero, NRVOFlag);
781
782 // Record the NRVO flag for this variable.
783 NRVOFlags[&D] = NRVOFlag;
John McCall34695852011-02-22 06:44:22 +0000784 emission.NRVOFlag = NRVOFlag;
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000785 }
786 }
Douglas Gregord86c4772010-05-15 06:46:45 +0000787 } else {
788 if (isByRef)
789 LTy = BuildByRefType(&D);
790
791 llvm::AllocaInst *Alloc = CreateTempAlloca(LTy);
792 Alloc->setName(D.getNameAsString());
Mike Stump1eb44332009-09-09 15:08:12 +0000793
John McCall34695852011-02-22 06:44:22 +0000794 CharUnits allocaAlignment = alignment;
Douglas Gregord86c4772010-05-15 06:46:45 +0000795 if (isByRef)
John McCall34695852011-02-22 06:44:22 +0000796 allocaAlignment = std::max(allocaAlignment,
Ken Dyck06f486e2011-01-18 02:01:14 +0000797 getContext().toCharUnitsFromBits(Target.getPointerAlign(0)));
John McCall34695852011-02-22 06:44:22 +0000798 Alloc->setAlignment(allocaAlignment.getQuantity());
Douglas Gregord86c4772010-05-15 06:46:45 +0000799 DeclPtr = Alloc;
800 }
Chris Lattner2621fd12008-05-08 05:58:21 +0000801 } else {
802 // Targets that don't support recursion emit locals as globals.
803 const char *Class =
John McCalld931b082010-08-26 03:08:43 +0000804 D.getStorageClass() == SC_Register ? ".reg." : ".auto.";
John McCallb6bbcc92010-10-15 04:57:14 +0000805 DeclPtr = CreateStaticVarDecl(D, Class,
806 llvm::GlobalValue::InternalLinkage);
Chris Lattner2621fd12008-05-08 05:58:21 +0000807 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000808 } else {
Daniel Dunbard286f052009-07-19 06:58:07 +0000809 EnsureInsertPoint();
810
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000811 if (!DidCallStackSave) {
Anders Carlsson5d463152008-12-12 07:38:43 +0000812 // Save the stack.
John McCalld16c2cf2011-02-08 08:22:06 +0000813 llvm::Value *Stack = CreateTempAlloca(Int8PtrTy, "saved_stack");
Mike Stump1eb44332009-09-09 15:08:12 +0000814
Anders Carlsson5d463152008-12-12 07:38:43 +0000815 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
816 llvm::Value *V = Builder.CreateCall(F);
Mike Stump1eb44332009-09-09 15:08:12 +0000817
Anders Carlsson5d463152008-12-12 07:38:43 +0000818 Builder.CreateStore(V, Stack);
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000819
820 DidCallStackSave = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000821
John McCalld8715092010-07-21 06:13:08 +0000822 // Push a cleanup block and restore the stack there.
John McCall3ad32c82011-01-28 08:37:24 +0000823 // FIXME: in general circumstances, this should be an EH cleanup.
John McCall1f0fca52010-07-21 07:22:38 +0000824 EHStack.pushCleanup<CallStackRestore>(NormalCleanup, Stack);
Anders Carlsson5d463152008-12-12 07:38:43 +0000825 }
Mike Stump1eb44332009-09-09 15:08:12 +0000826
John McCallbc8d40d2011-06-24 21:55:10 +0000827 llvm::Value *elementCount;
828 QualType elementType;
829 llvm::tie(elementCount, elementType) = getVLASize(Ty);
Anders Carlsson5d463152008-12-12 07:38:43 +0000830
Chris Lattner2acc6e32011-07-18 04:24:23 +0000831 llvm::Type *llvmTy = ConvertTypeForMem(elementType);
Anders Carlsson5d463152008-12-12 07:38:43 +0000832
833 // Allocate memory for the array.
John McCallbc8d40d2011-06-24 21:55:10 +0000834 llvm::AllocaInst *vla = Builder.CreateAlloca(llvmTy, elementCount, "vla");
835 vla->setAlignment(alignment.getQuantity());
Anders Carlsson41f8a132009-09-26 18:16:06 +0000836
John McCallbc8d40d2011-06-24 21:55:10 +0000837 DeclPtr = vla;
Reid Spencer5f016e22007-07-11 17:01:13 +0000838 }
Eli Friedman8f39f5e2008-12-20 23:11:59 +0000839
Reid Spencer5f016e22007-07-11 17:01:13 +0000840 llvm::Value *&DMEntry = LocalDeclMap[&D];
841 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
842 DMEntry = DeclPtr;
John McCall34695852011-02-22 06:44:22 +0000843 emission.Address = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000844
845 // Emit debug info for local var declaration.
Devang Patelc594abd2011-06-03 19:21:47 +0000846 if (HaveInsertPoint())
847 if (CGDebugInfo *DI = getDebugInfo()) {
848 DI->setLocation(D.getLocation());
Devang Patelc594abd2011-06-03 19:21:47 +0000849 if (Target.useGlobalsForAutomaticVariables()) {
850 DI->EmitGlobalVariable(static_cast<llvm::GlobalVariable *>(DeclPtr), &D);
851 } else
852 DI->EmitDeclareOfAutoVariable(&D, DeclPtr, Builder);
853 }
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000854
John McCall34695852011-02-22 06:44:22 +0000855 return emission;
856}
857
858/// Determines whether the given __block variable is potentially
859/// captured by the given expression.
860static bool isCapturedBy(const VarDecl &var, const Expr *e) {
861 // Skip the most common kinds of expressions that make
862 // hierarchy-walking expensive.
863 e = e->IgnoreParenCasts();
864
865 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
866 const BlockDecl *block = be->getBlockDecl();
867 for (BlockDecl::capture_const_iterator i = block->capture_begin(),
868 e = block->capture_end(); i != e; ++i) {
869 if (i->getVariable() == &var)
870 return true;
871 }
872
873 // No need to walk into the subexpressions.
874 return false;
875 }
876
877 for (Stmt::const_child_range children = e->children(); children; ++children)
878 if (isCapturedBy(var, cast<Expr>(*children)))
879 return true;
880
881 return false;
882}
883
Douglas Gregorbcc3e662011-07-01 21:08:19 +0000884/// \brief Determine whether the given initializer is trivial in the sense
885/// that it requires no code to be generated.
886static bool isTrivialInitializer(const Expr *Init) {
887 if (!Init)
888 return true;
889
890 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
891 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
892 if (Constructor->isTrivial() &&
893 Constructor->isDefaultConstructor() &&
894 !Construct->requiresZeroInitialization())
895 return true;
896
897 return false;
898}
John McCall34695852011-02-22 06:44:22 +0000899void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +0000900 assert(emission.Variable && "emission was not valid!");
901
John McCall34695852011-02-22 06:44:22 +0000902 // If this was emitted as a global constant, we're done.
903 if (emission.wasEmittedAsGlobal()) return;
904
John McCall57b3b6a2011-02-22 07:16:58 +0000905 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +0000906 QualType type = D.getType();
907
Chris Lattner19785962007-07-12 00:39:48 +0000908 // If this local has an initializer, emit it now.
Daniel Dunbard286f052009-07-19 06:58:07 +0000909 const Expr *Init = D.getInit();
910
911 // If we are at an unreachable point, we don't need to emit the initializer
912 // unless it contains a label.
913 if (!HaveInsertPoint()) {
John McCall34695852011-02-22 06:44:22 +0000914 if (!Init || !ContainsLabel(Init)) return;
915 EnsureInsertPoint();
Daniel Dunbard286f052009-07-19 06:58:07 +0000916 }
917
John McCall5af02db2011-03-31 01:59:53 +0000918 // Initialize the structure of a __block variable.
919 if (emission.IsByRef)
920 emitByrefStructureInit(emission);
Anders Carlsson69c68b72009-02-07 23:51:38 +0000921
Douglas Gregorbcc3e662011-07-01 21:08:19 +0000922 if (isTrivialInitializer(Init))
923 return;
924
Mon P Wang3ecd7852010-04-04 03:10:52 +0000925
John McCall5af02db2011-03-31 01:59:53 +0000926 CharUnits alignment = emission.Alignment;
927
John McCall34695852011-02-22 06:44:22 +0000928 // Check whether this is a byref variable that's potentially
929 // captured and moved by its own initializer. If so, we'll need to
930 // emit the initializer first, then copy into the variable.
931 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init);
932
933 llvm::Value *Loc =
934 capturedByInit ? emission.Address : emission.getObjectAddress(*this);
935
John McCalla07398e2011-06-16 04:16:24 +0000936 if (!emission.IsConstantAggregate) {
937 LValue lv = MakeAddrLValue(Loc, type, alignment.getQuantity());
938 lv.setNonGC(true);
939 return EmitExprAsInit(Init, &D, lv, capturedByInit);
940 }
John McCall60d33652011-03-08 09:11:50 +0000941
John McCall34695852011-02-22 06:44:22 +0000942 // If this is a simple aggregate initialization, we can optimize it
943 // in various ways.
John McCall60d33652011-03-08 09:11:50 +0000944 assert(!capturedByInit && "constant init contains a capturing block?");
John McCall34695852011-02-22 06:44:22 +0000945
John McCall60d33652011-03-08 09:11:50 +0000946 bool isVolatile = type.isVolatileQualified();
John McCall34695852011-02-22 06:44:22 +0000947
John McCall60d33652011-03-08 09:11:50 +0000948 llvm::Constant *constant = CGM.EmitConstantExpr(D.getInit(), type, this);
949 assert(constant != 0 && "Wasn't a simple constant init?");
John McCall34695852011-02-22 06:44:22 +0000950
John McCall60d33652011-03-08 09:11:50 +0000951 llvm::Value *SizeVal =
952 llvm::ConstantInt::get(IntPtrTy,
953 getContext().getTypeSizeInChars(type).getQuantity());
John McCall34695852011-02-22 06:44:22 +0000954
Chris Lattner2acc6e32011-07-18 04:24:23 +0000955 llvm::Type *BP = Int8PtrTy;
John McCall60d33652011-03-08 09:11:50 +0000956 if (Loc->getType() != BP)
957 Loc = Builder.CreateBitCast(Loc, BP, "tmp");
Mon P Wang3ecd7852010-04-04 03:10:52 +0000958
John McCall60d33652011-03-08 09:11:50 +0000959 // If the initializer is all or mostly zeros, codegen with memset then do
960 // a few stores afterward.
961 if (shouldUseMemSetPlusStoresToInitialize(constant,
962 CGM.getTargetData().getTypeAllocSize(constant->getType()))) {
963 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
964 alignment.getQuantity(), isVolatile);
965 if (!constant->isNullValue()) {
966 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo());
967 emitStoresForInitAfterMemset(constant, Loc, isVolatile, Builder);
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +0000968 }
John McCall60d33652011-03-08 09:11:50 +0000969 } else {
970 // Otherwise, create a temporary global with the initializer then
971 // memcpy from the global to the alloca.
972 std::string Name = GetStaticDeclName(*this, D, ".");
973 llvm::GlobalVariable *GV =
974 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true,
975 llvm::GlobalValue::InternalLinkage,
976 constant, Name, 0, false, 0);
977 GV->setAlignment(alignment.getQuantity());
Eli Friedman460980d2011-05-27 22:32:55 +0000978 GV->setUnnamedAddr(true);
John McCall60d33652011-03-08 09:11:50 +0000979
980 llvm::Value *SrcPtr = GV;
981 if (SrcPtr->getType() != BP)
982 SrcPtr = Builder.CreateBitCast(SrcPtr, BP, "tmp");
983
984 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, alignment.getQuantity(),
985 isVolatile);
986 }
987}
988
989/// Emit an expression as an initializer for a variable at the given
990/// location. The expression is not necessarily the normal
991/// initializer for the variable, and the address is not necessarily
992/// its normal location.
993///
994/// \param init the initializing expression
995/// \param var the variable to act as if we're initializing
996/// \param loc the address to initialize; its type is a pointer
997/// to the LLVM mapping of the variable's type
998/// \param alignment the alignment of the address
999/// \param capturedByInit true if the variable is a __block variable
1000/// whose address is potentially changed by the initializer
1001void CodeGenFunction::EmitExprAsInit(const Expr *init,
John McCallf85e1932011-06-15 23:02:42 +00001002 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001003 LValue lvalue,
John McCall60d33652011-03-08 09:11:50 +00001004 bool capturedByInit) {
John McCallf85e1932011-06-15 23:02:42 +00001005 QualType type = D->getType();
John McCall60d33652011-03-08 09:11:50 +00001006
1007 if (type->isReferenceType()) {
John McCalla07398e2011-06-16 04:16:24 +00001008 RValue rvalue = EmitReferenceBindingToExpr(init, D);
John McCallf85e1932011-06-15 23:02:42 +00001009 if (capturedByInit)
John McCalla07398e2011-06-16 04:16:24 +00001010 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall545d9962011-06-25 02:11:03 +00001011 EmitStoreThroughLValue(rvalue, lvalue);
John McCall34695852011-02-22 06:44:22 +00001012 } else if (!hasAggregateLLVMType(type)) {
John McCalla07398e2011-06-16 04:16:24 +00001013 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall34695852011-02-22 06:44:22 +00001014 } else if (type->isAnyComplexType()) {
John McCall60d33652011-03-08 09:11:50 +00001015 ComplexPairTy complex = EmitComplexExpr(init);
John McCalla07398e2011-06-16 04:16:24 +00001016 if (capturedByInit)
1017 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
1018 StoreComplexToAddr(complex, lvalue.getAddress(), lvalue.isVolatile());
John McCall34695852011-02-22 06:44:22 +00001019 } else {
1020 // TODO: how can we delay here if D is captured by its initializer?
John McCalla07398e2011-06-16 04:16:24 +00001021 EmitAggExpr(init, AggValueSlot::forLValue(lvalue, true, false));
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +00001022 }
John McCall34695852011-02-22 06:44:22 +00001023}
John McCallf1549f62010-07-06 01:34:17 +00001024
John McCallbdc4d802011-07-09 01:37:26 +00001025/// Enter a destroy cleanup for the given local variable.
1026void CodeGenFunction::emitAutoVarTypeCleanup(
1027 const CodeGenFunction::AutoVarEmission &emission,
1028 QualType::DestructionKind dtorKind) {
1029 assert(dtorKind != QualType::DK_none);
1030
1031 // Note that for __block variables, we want to destroy the
1032 // original stack object, not the possibly forwarded object.
1033 llvm::Value *addr = emission.getObjectAddress(*this);
1034
1035 const VarDecl *var = emission.Variable;
1036 QualType type = var->getType();
1037
1038 CleanupKind cleanupKind = NormalAndEHCleanup;
1039 CodeGenFunction::Destroyer *destroyer = 0;
1040
1041 switch (dtorKind) {
1042 case QualType::DK_none:
1043 llvm_unreachable("no cleanup for trivially-destructible variable");
1044
1045 case QualType::DK_cxx_destructor:
1046 // If there's an NRVO flag on the emission, we need a different
1047 // cleanup.
1048 if (emission.NRVOFlag) {
1049 assert(!type->isArrayType());
1050 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
1051 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr, dtor,
1052 emission.NRVOFlag);
1053 return;
1054 }
1055 break;
1056
1057 case QualType::DK_objc_strong_lifetime:
1058 // Suppress cleanups for pseudo-strong variables.
1059 if (var->isARCPseudoStrong()) return;
1060
1061 // Otherwise, consider whether to use an EH cleanup or not.
1062 cleanupKind = getARCCleanupKind();
1063
1064 // Use the imprecise destroyer by default.
1065 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1066 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1067 break;
1068
1069 case QualType::DK_objc_weak_lifetime:
1070 break;
1071 }
1072
1073 // If we haven't chosen a more specific destroyer, use the default.
1074 if (!destroyer) destroyer = &getDestroyer(dtorKind);
John McCall2673c682011-07-11 08:38:19 +00001075
1076 // Use an EH cleanup in array destructors iff the destructor itself
1077 // is being pushed as an EH cleanup.
1078 bool useEHCleanup = (cleanupKind & EHCleanup);
1079 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1080 useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001081}
1082
John McCall34695852011-02-22 06:44:22 +00001083void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +00001084 assert(emission.Variable && "emission was not valid!");
1085
John McCall34695852011-02-22 06:44:22 +00001086 // If this was emitted as a global constant, we're done.
1087 if (emission.wasEmittedAsGlobal()) return;
1088
John McCall57b3b6a2011-02-22 07:16:58 +00001089 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +00001090
John McCallbdc4d802011-07-09 01:37:26 +00001091 // Check the type for a cleanup.
1092 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1093 emitAutoVarTypeCleanup(emission, dtorKind);
John McCallf85e1932011-06-15 23:02:42 +00001094
John McCall0c24c802011-06-24 23:21:27 +00001095 // In GC mode, honor objc_precise_lifetime.
1096 if (getLangOptions().getGCMode() != LangOptions::NonGC &&
1097 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1098 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1099 }
1100
John McCall34695852011-02-22 06:44:22 +00001101 // Handle the cleanup attribute.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +00001102 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlsson69c68b72009-02-07 23:51:38 +00001103 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump1eb44332009-09-09 15:08:12 +00001104
John McCall34695852011-02-22 06:44:22 +00001105 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001106 assert(F && "Could not find function!");
Mike Stump1eb44332009-09-09 15:08:12 +00001107
Anders Carlssoncabec032009-04-26 00:34:20 +00001108 const CGFunctionInfo &Info = CGM.getTypes().getFunctionInfo(FD);
John McCall34695852011-02-22 06:44:22 +00001109 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001110 }
Mike Stump797b6322009-03-05 01:23:13 +00001111
John McCall34695852011-02-22 06:44:22 +00001112 // If this is a block variable, call _Block_object_destroy
1113 // (on the unforwarded address).
John McCall5af02db2011-03-31 01:59:53 +00001114 if (emission.IsByRef)
1115 enterByrefCleanup(emission);
Reid Spencer5f016e22007-07-11 17:01:13 +00001116}
1117
John McCallbdc4d802011-07-09 01:37:26 +00001118CodeGenFunction::Destroyer &
1119CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
John McCall0850e8d2011-07-09 09:09:00 +00001120 // This is surprisingly compiler-dependent. GCC 4.2 can't bind
1121 // references to functions directly in returns, and using '*&foo'
1122 // confuses MSVC. Luckily, the following code pattern works in both.
1123 Destroyer *destroyer = 0;
John McCallbdc4d802011-07-09 01:37:26 +00001124 switch (kind) {
1125 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCall0850e8d2011-07-09 09:09:00 +00001126 case QualType::DK_cxx_destructor:
1127 destroyer = &destroyCXXObject;
1128 break;
1129 case QualType::DK_objc_strong_lifetime:
1130 destroyer = &destroyARCStrongPrecise;
1131 break;
1132 case QualType::DK_objc_weak_lifetime:
1133 destroyer = &destroyARCWeak;
1134 break;
John McCallbdc4d802011-07-09 01:37:26 +00001135 }
John McCall0850e8d2011-07-09 09:09:00 +00001136 return *destroyer;
John McCallbdc4d802011-07-09 01:37:26 +00001137}
1138
John McCall9928c482011-07-12 16:41:08 +00001139/// pushDestroy - Push the standard destructor for the given type.
1140void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
1141 llvm::Value *addr, QualType type) {
1142 assert(dtorKind && "cannot push destructor for trivial type");
1143
1144 CleanupKind cleanupKind = getCleanupKind(dtorKind);
1145 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
1146 cleanupKind & EHCleanup);
1147}
1148
John McCallbdc4d802011-07-09 01:37:26 +00001149void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, llvm::Value *addr,
John McCall2673c682011-07-11 08:38:19 +00001150 QualType type, Destroyer &destroyer,
1151 bool useEHCleanupForArray) {
John McCall9928c482011-07-12 16:41:08 +00001152 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
1153 destroyer, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001154}
1155
John McCall2673c682011-07-11 08:38:19 +00001156/// emitDestroy - Immediately perform the destruction of the given
1157/// object.
1158///
1159/// \param addr - the address of the object; a type*
1160/// \param type - the type of the object; if an array type, all
1161/// objects are destroyed in reverse order
1162/// \param destroyer - the function to call to destroy individual
1163/// elements
1164/// \param useEHCleanupForArray - whether an EH cleanup should be
1165/// used when destroying array elements, in case one of the
1166/// destructions throws an exception
John McCallbdc4d802011-07-09 01:37:26 +00001167void CodeGenFunction::emitDestroy(llvm::Value *addr, QualType type,
John McCall2673c682011-07-11 08:38:19 +00001168 Destroyer &destroyer,
1169 bool useEHCleanupForArray) {
John McCallbdc4d802011-07-09 01:37:26 +00001170 const ArrayType *arrayType = getContext().getAsArrayType(type);
1171 if (!arrayType)
1172 return destroyer(*this, addr, type);
1173
1174 llvm::Value *begin = addr;
1175 llvm::Value *length = emitArrayLength(arrayType, type, begin);
John McCallfbf780a2011-07-13 08:09:46 +00001176
1177 // Normally we have to check whether the array is zero-length.
1178 bool checkZeroLength = true;
1179
1180 // But if the array length is constant, we can suppress that.
1181 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
1182 // ...and if it's constant zero, we can just skip the entire thing.
1183 if (constLength->isZero()) return;
1184 checkZeroLength = false;
1185 }
1186
John McCallbdc4d802011-07-09 01:37:26 +00001187 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCallfbf780a2011-07-13 08:09:46 +00001188 emitArrayDestroy(begin, end, type, destroyer,
1189 checkZeroLength, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001190}
1191
John McCall2673c682011-07-11 08:38:19 +00001192/// emitArrayDestroy - Destroys all the elements of the given array,
1193/// beginning from last to first. The array cannot be zero-length.
1194///
1195/// \param begin - a type* denoting the first element of the array
1196/// \param end - a type* denoting one past the end of the array
1197/// \param type - the element type of the array
1198/// \param destroyer - the function to call to destroy elements
1199/// \param useEHCleanup - whether to push an EH cleanup to destroy
1200/// the remaining elements in case the destruction of a single
1201/// element throws
John McCallbdc4d802011-07-09 01:37:26 +00001202void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
1203 llvm::Value *end,
1204 QualType type,
John McCall2673c682011-07-11 08:38:19 +00001205 Destroyer &destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001206 bool checkZeroLength,
John McCall2673c682011-07-11 08:38:19 +00001207 bool useEHCleanup) {
John McCallbdc4d802011-07-09 01:37:26 +00001208 assert(!type->isArrayType());
1209
1210 // The basic structure here is a do-while loop, because we don't
1211 // need to check for the zero-element case.
1212 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
1213 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
1214
John McCallfbf780a2011-07-13 08:09:46 +00001215 if (checkZeroLength) {
1216 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
1217 "arraydestroy.isempty");
1218 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
1219 }
1220
John McCallbdc4d802011-07-09 01:37:26 +00001221 // Enter the loop body, making that address the current address.
1222 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1223 EmitBlock(bodyBB);
1224 llvm::PHINode *elementPast =
1225 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
1226 elementPast->addIncoming(end, entryBB);
1227
1228 // Shift the address back by one element.
1229 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
1230 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
1231 "arraydestroy.element");
1232
John McCall2673c682011-07-11 08:38:19 +00001233 if (useEHCleanup)
1234 pushRegularPartialArrayCleanup(begin, element, type, destroyer);
1235
John McCallbdc4d802011-07-09 01:37:26 +00001236 // Perform the actual destruction there.
1237 destroyer(*this, element, type);
1238
John McCall2673c682011-07-11 08:38:19 +00001239 if (useEHCleanup)
1240 PopCleanupBlock();
1241
John McCallbdc4d802011-07-09 01:37:26 +00001242 // Check whether we've reached the end.
1243 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
1244 Builder.CreateCondBr(done, doneBB, bodyBB);
1245 elementPast->addIncoming(element, Builder.GetInsertBlock());
1246
1247 // Done.
1248 EmitBlock(doneBB);
1249}
1250
John McCall2673c682011-07-11 08:38:19 +00001251/// Perform partial array destruction as if in an EH cleanup. Unlike
1252/// emitArrayDestroy, the element type here may still be an array type.
John McCall2673c682011-07-11 08:38:19 +00001253static void emitPartialArrayDestroy(CodeGenFunction &CGF,
1254 llvm::Value *begin, llvm::Value *end,
1255 QualType type,
1256 CodeGenFunction::Destroyer &destroyer) {
John McCall2673c682011-07-11 08:38:19 +00001257 // If the element type is itself an array, drill down.
John McCallfbf780a2011-07-13 08:09:46 +00001258 unsigned arrayDepth = 0;
John McCall2673c682011-07-11 08:38:19 +00001259 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
1260 // VLAs don't require a GEP index to walk into.
1261 if (!isa<VariableArrayType>(arrayType))
John McCallfbf780a2011-07-13 08:09:46 +00001262 arrayDepth++;
John McCall2673c682011-07-11 08:38:19 +00001263 type = arrayType->getElementType();
1264 }
John McCallfbf780a2011-07-13 08:09:46 +00001265
1266 if (arrayDepth) {
1267 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, arrayDepth+1);
1268
Chris Lattner5f9e2722011-07-23 10:55:15 +00001269 SmallVector<llvm::Value*,4> gepIndices(arrayDepth, zero);
Jay Foad0f6ac7c2011-07-22 08:16:57 +00001270 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
1271 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall2673c682011-07-11 08:38:19 +00001272 }
1273
John McCallfbf780a2011-07-13 08:09:46 +00001274 // Destroy the array. We don't ever need an EH cleanup because we
1275 // assume that we're in an EH cleanup ourselves, so a throwing
1276 // destructor causes an immediate terminate.
1277 CGF.emitArrayDestroy(begin, end, type, destroyer,
1278 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall2673c682011-07-11 08:38:19 +00001279}
1280
John McCallbdc4d802011-07-09 01:37:26 +00001281namespace {
John McCall2673c682011-07-11 08:38:19 +00001282 /// RegularPartialArrayDestroy - a cleanup which performs a partial
1283 /// array destroy where the end pointer is regularly determined and
1284 /// does not need to be loaded from a local.
1285 class RegularPartialArrayDestroy : public EHScopeStack::Cleanup {
1286 llvm::Value *ArrayBegin;
1287 llvm::Value *ArrayEnd;
1288 QualType ElementType;
1289 CodeGenFunction::Destroyer &Destroyer;
1290 public:
1291 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
1292 QualType elementType,
1293 CodeGenFunction::Destroyer *destroyer)
1294 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
1295 ElementType(elementType), Destroyer(*destroyer) {}
1296
John McCallad346f42011-07-12 20:27:29 +00001297 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +00001298 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
1299 ElementType, Destroyer);
1300 }
1301 };
1302
1303 /// IrregularPartialArrayDestroy - a cleanup which performs a
1304 /// partial array destroy where the end pointer is irregularly
1305 /// determined and must be loaded from a local.
1306 class IrregularPartialArrayDestroy : public EHScopeStack::Cleanup {
John McCallbdc4d802011-07-09 01:37:26 +00001307 llvm::Value *ArrayBegin;
1308 llvm::Value *ArrayEndPointer;
1309 QualType ElementType;
1310 CodeGenFunction::Destroyer &Destroyer;
1311 public:
John McCall2673c682011-07-11 08:38:19 +00001312 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
1313 llvm::Value *arrayEndPointer,
1314 QualType elementType,
1315 CodeGenFunction::Destroyer *destroyer)
John McCallbdc4d802011-07-09 01:37:26 +00001316 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
1317 ElementType(elementType), Destroyer(*destroyer) {}
1318
John McCallad346f42011-07-12 20:27:29 +00001319 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallbdc4d802011-07-09 01:37:26 +00001320 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall2673c682011-07-11 08:38:19 +00001321 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
1322 ElementType, Destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001323 }
1324 };
1325}
1326
John McCall2673c682011-07-11 08:38:19 +00001327/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCallbdc4d802011-07-09 01:37:26 +00001328/// already-constructed elements of the given array. The cleanup
John McCall2673c682011-07-11 08:38:19 +00001329/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
John McCallbdc4d802011-07-09 01:37:26 +00001330///
1331/// \param elementType - the immediate element type of the array;
1332/// possibly still an array type
1333/// \param array - a value of type elementType*
1334/// \param destructionKind - the kind of destruction required
1335/// \param initializedElementCount - a value of type size_t* holding
1336/// the number of successfully-constructed elements
John McCall9928c482011-07-12 16:41:08 +00001337void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall2673c682011-07-11 08:38:19 +00001338 llvm::Value *arrayEndPointer,
1339 QualType elementType,
1340 Destroyer &destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001341 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
1342 arrayBegin, arrayEndPointer,
John McCall2673c682011-07-11 08:38:19 +00001343 elementType, &destroyer);
1344}
1345
1346/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
1347/// already-constructed elements of the given array. The cleanup
1348/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
1349///
1350/// \param elementType - the immediate element type of the array;
1351/// possibly still an array type
1352/// \param array - a value of type elementType*
1353/// \param destructionKind - the kind of destruction required
1354/// \param initializedElementCount - a value of type size_t* holding
1355/// the number of successfully-constructed elements
1356void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1357 llvm::Value *arrayEnd,
1358 QualType elementType,
1359 Destroyer &destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001360 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall2673c682011-07-11 08:38:19 +00001361 arrayBegin, arrayEnd,
1362 elementType, &destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001363}
1364
John McCallf85e1932011-06-15 23:02:42 +00001365namespace {
1366 /// A cleanup to perform a release of an object at the end of a
1367 /// function. This is used to balance out the incoming +1 of a
1368 /// ns_consumed argument when we can't reasonably do that just by
1369 /// not doing the initial retain for a __block argument.
1370 struct ConsumeARCParameter : EHScopeStack::Cleanup {
1371 ConsumeARCParameter(llvm::Value *param) : Param(param) {}
1372
1373 llvm::Value *Param;
1374
John McCallad346f42011-07-12 20:27:29 +00001375 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +00001376 CGF.EmitARCRelease(Param, /*precise*/ false);
1377 }
1378 };
1379}
1380
Mike Stump1eb44332009-09-09 15:08:12 +00001381/// Emit an alloca (or GlobalValue depending on target)
Chris Lattner2621fd12008-05-08 05:58:21 +00001382/// for the specified parameter and set up LocalDeclMap.
Devang Patel093ac462011-03-03 20:13:15 +00001383void CodeGenFunction::EmitParmDecl(const VarDecl &D, llvm::Value *Arg,
1384 unsigned ArgNo) {
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001385 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +00001386 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001387 "Invalid argument to EmitParmDecl");
John McCall8178df32011-02-22 22:38:33 +00001388
1389 Arg->setName(D.getName());
1390
1391 // Use better IR generation for certain implicit parameters.
1392 if (isa<ImplicitParamDecl>(D)) {
1393 // The only implicit argument a block has is its literal.
1394 if (BlockInfo) {
1395 LocalDeclMap[&D] = Arg;
1396
1397 if (CGDebugInfo *DI = getDebugInfo()) {
1398 DI->setLocation(D.getLocation());
1399 DI->EmitDeclareOfBlockLiteralArgVariable(*BlockInfo, Arg, Builder);
1400 }
1401
1402 return;
1403 }
1404 }
1405
Chris Lattner8bcfc5b2008-04-06 23:10:54 +00001406 QualType Ty = D.getType();
Mike Stump1eb44332009-09-09 15:08:12 +00001407
Reid Spencer5f016e22007-07-11 17:01:13 +00001408 llvm::Value *DeclPtr;
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001409 // If this is an aggregate or variable sized value, reuse the input pointer.
1410 if (!Ty->isConstantSizeType() ||
1411 CodeGenFunction::hasAggregateLLVMType(Ty)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001412 DeclPtr = Arg;
Reid Spencer5f016e22007-07-11 17:01:13 +00001413 } else {
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001414 // Otherwise, create a temporary to hold the value.
Daniel Dunbar195337d2010-02-09 02:48:28 +00001415 DeclPtr = CreateMemTemp(Ty, D.getName() + ".addr");
Mike Stump1eb44332009-09-09 15:08:12 +00001416
John McCallf85e1932011-06-15 23:02:42 +00001417 bool doStore = true;
1418
1419 Qualifiers qs = Ty.getQualifiers();
1420
1421 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
1422 // We honor __attribute__((ns_consumed)) for types with lifetime.
1423 // For __strong, it's handled by just skipping the initial retain;
1424 // otherwise we have to balance out the initial +1 with an extra
1425 // cleanup to do the release at the end of the function.
1426 bool isConsumed = D.hasAttr<NSConsumedAttr>();
1427
1428 // 'self' is always formally __strong, but if this is not an
1429 // init method then we don't want to retain it.
John McCall7acddac2011-06-17 06:42:21 +00001430 if (D.isARCPseudoStrong()) {
John McCallf85e1932011-06-15 23:02:42 +00001431 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl);
1432 assert(&D == method->getSelfDecl());
John McCall7acddac2011-06-17 06:42:21 +00001433 assert(lt == Qualifiers::OCL_Strong);
1434 assert(qs.hasConst());
John McCallf85e1932011-06-15 23:02:42 +00001435 assert(method->getMethodFamily() != OMF_init);
John McCall175d6592011-06-15 23:40:09 +00001436 (void) method;
John McCallf85e1932011-06-15 23:02:42 +00001437 lt = Qualifiers::OCL_ExplicitNone;
1438 }
1439
1440 if (lt == Qualifiers::OCL_Strong) {
1441 if (!isConsumed)
1442 // Don't use objc_retainBlock for block pointers, because we
1443 // don't want to Block_copy something just because we got it
1444 // as a parameter.
1445 Arg = EmitARCRetainNonBlock(Arg);
1446 } else {
1447 // Push the cleanup for a consumed parameter.
1448 if (isConsumed)
1449 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), Arg);
1450
1451 if (lt == Qualifiers::OCL_Weak) {
1452 EmitARCInitWeak(DeclPtr, Arg);
1453 doStore = false; // The weak init is a store, no need to do two
1454 }
1455 }
1456
1457 // Enter the cleanup scope.
1458 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
1459 }
1460
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001461 // Store the initial value into the alloca.
John McCall545d9962011-06-25 02:11:03 +00001462 if (doStore) {
1463 LValue lv = MakeAddrLValue(DeclPtr, Ty,
1464 getContext().getDeclAlign(&D).getQuantity());
1465 EmitStoreOfScalar(Arg, lv);
1466 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001467 }
1468
1469 llvm::Value *&DMEntry = LocalDeclMap[&D];
1470 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
1471 DMEntry = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00001472
1473 // Emit debug info for param declaration.
Devang Patel98703d32011-06-15 17:57:08 +00001474 if (CGDebugInfo *DI = getDebugInfo())
Devang Patel093ac462011-03-03 20:13:15 +00001475 DI->EmitDeclareOfArgVariable(&D, DeclPtr, ArgNo, Builder);
Reid Spencer5f016e22007-07-11 17:01:13 +00001476}