blob: 15bb6a6e45ea1620b89fb25948c6ed5d62144fb7 [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Decl nodes as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000015#include "CGDebugInfo.h"
Peter Collingbourne8c25fc52011-09-19 21:14:35 +000016#include "CGOpenCLRuntime.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000017#include "CodeGenModule.h"
Daniel Dunbarde7fb842008-08-11 05:00:27 +000018#include "clang/AST/ASTContext.h"
Ken Dyckbdc601b2009-12-22 14:23:30 +000019#include "clang/AST/CharUnits.h"
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000020#include "clang/AST/Decl.h"
Anders Carlsson19567ee2008-08-25 01:38:19 +000021#include "clang/AST/DeclObjC.h"
Nate Begeman8bd4afe2008-04-19 04:17:09 +000022#include "clang/Basic/SourceManager.h"
Chris Lattner2621fd12008-05-08 05:58:21 +000023#include "clang/Basic/TargetInfo.h"
Chandler Carruth06057ce2010-06-15 23:19:56 +000024#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3b844ba2013-01-02 11:45:17 +000025#include "llvm/IR/DataLayout.h"
26#include "llvm/IR/GlobalVariable.h"
27#include "llvm/IR/Intrinsics.h"
28#include "llvm/IR/Type.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000029using namespace clang;
30using namespace CodeGen;
31
32
33void CodeGenFunction::EmitDecl(const Decl &D) {
Reid Spencer5f016e22007-07-11 17:01:13 +000034 switch (D.getKind()) {
Douglas Gregor08688ac2010-04-23 02:02:43 +000035 case Decl::TranslationUnit:
36 case Decl::Namespace:
37 case Decl::UnresolvedUsingTypename:
38 case Decl::ClassTemplateSpecialization:
39 case Decl::ClassTemplatePartialSpecialization:
40 case Decl::TemplateTypeParm:
41 case Decl::UnresolvedUsingValue:
Sean Hunt9a555912010-05-30 07:21:58 +000042 case Decl::NonTypeTemplateParm:
Douglas Gregor08688ac2010-04-23 02:02:43 +000043 case Decl::CXXMethod:
44 case Decl::CXXConstructor:
45 case Decl::CXXDestructor:
46 case Decl::CXXConversion:
47 case Decl::Field:
John McCall76da55d2013-04-16 07:28:30 +000048 case Decl::MSProperty:
Francois Pichet41f5e662010-11-21 06:49:41 +000049 case Decl::IndirectField:
Douglas Gregor08688ac2010-04-23 02:02:43 +000050 case Decl::ObjCIvar:
Eric Christophere1f54902011-08-23 22:38:00 +000051 case Decl::ObjCAtDefsField:
Chris Lattneraa9fc462007-10-08 21:37:32 +000052 case Decl::ParmVar:
Douglas Gregor08688ac2010-04-23 02:02:43 +000053 case Decl::ImplicitParam:
54 case Decl::ClassTemplate:
55 case Decl::FunctionTemplate:
Richard Smith3e4c6c42011-05-05 21:57:07 +000056 case Decl::TypeAliasTemplate:
Douglas Gregor08688ac2010-04-23 02:02:43 +000057 case Decl::TemplateTemplateParm:
58 case Decl::ObjCMethod:
59 case Decl::ObjCCategory:
60 case Decl::ObjCProtocol:
61 case Decl::ObjCInterface:
62 case Decl::ObjCCategoryImpl:
63 case Decl::ObjCImplementation:
64 case Decl::ObjCProperty:
65 case Decl::ObjCCompatibleAlias:
Abramo Bagnara6206d532010-06-05 05:09:32 +000066 case Decl::AccessSpec:
Douglas Gregor08688ac2010-04-23 02:02:43 +000067 case Decl::LinkageSpec:
68 case Decl::ObjCPropertyImpl:
Douglas Gregor08688ac2010-04-23 02:02:43 +000069 case Decl::FileScopeAsm:
70 case Decl::Friend:
71 case Decl::FriendTemplate:
72 case Decl::Block:
Francois Pichetaf0f4d02011-08-14 03:52:19 +000073 case Decl::ClassScopeFunctionSpecialization:
David Blaikieb219cfc2011-09-23 05:06:16 +000074 llvm_unreachable("Declaration should not be in declstmts!");
Reid Spencer5f016e22007-07-11 17:01:13 +000075 case Decl::Function: // void X();
Argyrios Kyrtzidis35bc0822008-10-15 00:42:39 +000076 case Decl::Record: // struct/union/class X;
Reid Spencer5f016e22007-07-11 17:01:13 +000077 case Decl::Enum: // enum X;
Mike Stump1eb44332009-09-09 15:08:12 +000078 case Decl::EnumConstant: // enum ? { X = ? }
Argyrios Kyrtzidis35bc0822008-10-15 00:42:39 +000079 case Decl::CXXRecord: // struct/union/class X; [C++]
Daniel Dunbarfa133a12009-11-23 00:07:06 +000080 case Decl::Using: // using X; [C++]
81 case Decl::UsingShadow:
David Blaikiec8c24272013-02-02 00:39:32 +000082 case Decl::UsingDirective: // using namespace X; [C++]
Douglas Gregor08688ac2010-04-23 02:02:43 +000083 case Decl::NamespaceAlias:
Anders Carlsson7b0ca3f2009-12-03 17:26:31 +000084 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner4ae493c2011-02-18 02:08:43 +000085 case Decl::Label: // __label__ x;
Douglas Gregor15de72c2011-12-02 23:23:56 +000086 case Decl::Import:
Alexey Bataevc6400582013-03-22 06:34:35 +000087 case Decl::OMPThreadPrivate:
Michael Han684aa732013-02-22 17:15:32 +000088 case Decl::Empty:
Reid Spencer5f016e22007-07-11 17:01:13 +000089 // None of these decls require codegen support.
90 return;
David Blaikiec8c24272013-02-02 00:39:32 +000091
Daniel Dunbar662174c82008-08-29 17:28:43 +000092 case Decl::Var: {
93 const VarDecl &VD = cast<VarDecl>(D);
John McCallb6bbcc92010-10-15 04:57:14 +000094 assert(VD.isLocalVarDecl() &&
Daniel Dunbar662174c82008-08-29 17:28:43 +000095 "Should not see file-scope variables inside a function!");
John McCallb6bbcc92010-10-15 04:57:14 +000096 return EmitVarDecl(VD);
Reid Spencer5f016e22007-07-11 17:01:13 +000097 }
Mike Stump1eb44332009-09-09 15:08:12 +000098
Richard Smith162e1c12011-04-15 14:24:37 +000099 case Decl::Typedef: // typedef int X;
100 case Decl::TypeAlias: { // using X = int; [C++0x]
101 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000102 QualType Ty = TD.getUnderlyingType();
Mike Stump1eb44332009-09-09 15:08:12 +0000103
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000104 if (Ty->isVariablyModifiedType())
John McCallbc8d40d2011-06-24 21:55:10 +0000105 EmitVariablyModifiedType(Ty);
Anders Carlssonfcdbb932008-12-20 21:51:53 +0000106 }
Daniel Dunbar662174c82008-08-29 17:28:43 +0000107 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000108}
109
John McCallb6bbcc92010-10-15 04:57:14 +0000110/// EmitVarDecl - This method handles emission of any variable declaration
Reid Spencer5f016e22007-07-11 17:01:13 +0000111/// inside a function, including static vars etc.
John McCallb6bbcc92010-10-15 04:57:14 +0000112void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Rafael Espindolad2615cc2013-04-03 19:27:57 +0000113 switch (D.getStorageClass()) {
John McCalld931b082010-08-26 03:08:43 +0000114 case SC_None:
115 case SC_Auto:
116 case SC_Register:
John McCallb6bbcc92010-10-15 04:57:14 +0000117 return EmitAutoVarDecl(D);
John McCalld931b082010-08-26 03:08:43 +0000118 case SC_Static: {
Eric Christophere1f54902011-08-23 22:38:00 +0000119 llvm::GlobalValue::LinkageTypes Linkage =
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000120 llvm::GlobalValue::InternalLinkage;
121
John McCall8b242332010-05-25 04:30:21 +0000122 // If the function definition has some sort of weak linkage, its
123 // static variables should also be weak so that they get properly
124 // uniqued. We can't do this in C, though, because there's no
125 // standard way to agree on which variables are the same (i.e.
126 // there's no mangling).
Richard Smith7edf9e32012-11-01 22:30:59 +0000127 if (getLangOpts().CPlusPlus)
John McCall8b242332010-05-25 04:30:21 +0000128 if (llvm::GlobalValue::isWeakForLinker(CurFn->getLinkage()))
129 Linkage = CurFn->getLinkage();
Eric Christophere1f54902011-08-23 22:38:00 +0000130
John McCallb6bbcc92010-10-15 04:57:14 +0000131 return EmitStaticVarDecl(D, Linkage);
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000132 }
John McCalld931b082010-08-26 03:08:43 +0000133 case SC_Extern:
134 case SC_PrivateExtern:
Lauro Ramos Venanciofea90b82008-02-16 22:30:38 +0000135 // Don't emit it now, allow it to be emitted lazily on its first use.
136 return;
Peter Collingbourne8c25fc52011-09-19 21:14:35 +0000137 case SC_OpenCLWorkGroupLocal:
138 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
Reid Spencer5f016e22007-07-11 17:01:13 +0000139 }
Daniel Dunbar5466c7b2009-04-14 02:25:56 +0000140
David Blaikieb219cfc2011-09-23 05:06:16 +0000141 llvm_unreachable("Unknown storage class");
Reid Spencer5f016e22007-07-11 17:01:13 +0000142}
143
Chris Lattner761acc12009-12-05 08:22:11 +0000144static std::string GetStaticDeclName(CodeGenFunction &CGF, const VarDecl &D,
145 const char *Separator) {
146 CodeGenModule &CGM = CGF.CGM;
Richard Smith7edf9e32012-11-01 22:30:59 +0000147 if (CGF.getLangOpts().CPlusPlus) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000148 StringRef Name = CGM.getMangledName(&D);
Anders Carlsson9a20d552010-06-22 16:16:50 +0000149 return Name.str();
John McCallf746aa62010-03-19 23:29:14 +0000150 }
Eric Christophere1f54902011-08-23 22:38:00 +0000151
Chris Lattner761acc12009-12-05 08:22:11 +0000152 std::string ContextName;
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000153 if (!CGF.CurFuncDecl) {
154 // Better be in a block declared in global scope.
155 const NamedDecl *ND = cast<NamedDecl>(&D);
156 const DeclContext *DC = ND->getDeclContext();
157 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
158 MangleBuffer Name;
Peter Collingbourne14110472011-01-13 18:57:25 +0000159 CGM.getBlockMangledName(GlobalDecl(), Name, BD);
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000160 ContextName = Name.getString();
161 }
162 else
David Blaikieb219cfc2011-09-23 05:06:16 +0000163 llvm_unreachable("Unknown context for block static var decl");
Fariborz Jahanianfaa5bfc2010-11-30 23:07:14 +0000164 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CGF.CurFuncDecl)) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000165 StringRef Name = CGM.getMangledName(FD);
Anders Carlsson9a20d552010-06-22 16:16:50 +0000166 ContextName = Name.str();
John McCallf746aa62010-03-19 23:29:14 +0000167 } else if (isa<ObjCMethodDecl>(CGF.CurFuncDecl))
Chris Lattner761acc12009-12-05 08:22:11 +0000168 ContextName = CGF.CurFn->getName();
169 else
David Blaikieb219cfc2011-09-23 05:06:16 +0000170 llvm_unreachable("Unknown context for static var decl");
Eric Christophere1f54902011-08-23 22:38:00 +0000171
Chris Lattner761acc12009-12-05 08:22:11 +0000172 return ContextName + Separator + D.getNameAsString();
173}
174
Chandler Carruth0f30a122012-03-30 19:44:53 +0000175llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +0000176CodeGenFunction::CreateStaticVarDecl(const VarDecl &D,
177 const char *Separator,
178 llvm::GlobalValue::LinkageTypes Linkage) {
Chris Lattner8bcfc5b2008-04-06 23:10:54 +0000179 QualType Ty = D.getType();
Eli Friedman3c2b3172008-02-15 12:20:59 +0000180 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000181
Benjamin Kramer5c247db2011-11-20 21:05:04 +0000182 // Use the label if the variable is renamed with the asm-label extension.
183 std::string Name;
Benjamin Kramerc3c8f222011-11-21 15:47:23 +0000184 if (D.hasAttr<AsmLabelAttr>())
185 Name = CGM.getMangledName(&D);
186 else
Benjamin Kramer5c247db2011-11-20 21:05:04 +0000187 Name = GetStaticDeclName(*this, D, Separator);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000188
Chris Lattner2acc6e32011-07-18 04:24:23 +0000189 llvm::Type *LTy = CGM.getTypes().ConvertTypeForMem(Ty);
Peter Collingbourne1aba7782012-08-28 20:37:10 +0000190 unsigned AddrSpace =
191 CGM.GetGlobalVarAddressSpace(&D, CGM.getContext().getTargetAddressSpace(Ty));
Anders Carlsson41f8a132009-09-26 18:16:06 +0000192 llvm::GlobalVariable *GV =
193 new llvm::GlobalVariable(CGM.getModule(), LTy,
194 Ty.isConstant(getContext()), Linkage,
Hans Wennborgde981f32012-06-28 08:01:44 +0000195 CGM.EmitNullConstant(D.getType()), Name, 0,
196 llvm::GlobalVariable::NotThreadLocal,
Peter Collingbourne1aba7782012-08-28 20:37:10 +0000197 AddrSpace);
Ken Dyck8b752f12010-01-27 17:10:57 +0000198 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
John McCall112c9672010-11-02 21:04:24 +0000199 if (Linkage != llvm::GlobalValue::InternalLinkage)
200 GV->setVisibility(CurFn->getVisibility());
Hans Wennborgde981f32012-06-28 08:01:44 +0000201
Richard Smith38afbc72013-04-13 02:43:54 +0000202 if (D.getTLSKind())
Hans Wennborgde981f32012-06-28 08:01:44 +0000203 CGM.setTLSMode(GV, D);
204
Anders Carlsson41f8a132009-09-26 18:16:06 +0000205 return GV;
Daniel Dunbar0096acf2009-02-25 19:24:29 +0000206}
207
Richard Smith7ca48502012-02-13 22:16:19 +0000208/// hasNontrivialDestruction - Determine whether a type's destruction is
209/// non-trivial. If so, and the variable uses static initialization, we must
210/// register its destructor to run on exit.
211static bool hasNontrivialDestruction(QualType T) {
212 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
213 return RD && !RD->hasTrivialDestructor();
214}
215
Chandler Carruth0f30a122012-03-30 19:44:53 +0000216/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
217/// global variable that has already been created for it. If the initializer
218/// has a different type than GV does, this may free GV and return a different
219/// one. Otherwise it just returns GV.
220llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +0000221CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth0f30a122012-03-30 19:44:53 +0000222 llvm::GlobalVariable *GV) {
223 llvm::Constant *Init = CGM.EmitConstantInit(D, this);
John McCallbf40cb52010-07-15 23:40:35 +0000224
Chris Lattner761acc12009-12-05 08:22:11 +0000225 // If constant emission failed, then this should be a C++ static
226 // initializer.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000227 if (!Init) {
Richard Smith7edf9e32012-11-01 22:30:59 +0000228 if (!getLangOpts().CPlusPlus)
Chris Lattner761acc12009-12-05 08:22:11 +0000229 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
John McCall5cd91b52010-09-08 01:44:27 +0000230 else if (Builder.GetInsertBlock()) {
Eric Christophere1f54902011-08-23 22:38:00 +0000231 // Since we have a static initializer, this global variable can't
Anders Carlsson071c8102010-01-26 04:02:23 +0000232 // be constant.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000233 GV->setConstant(false);
John McCall5cd91b52010-09-08 01:44:27 +0000234
Chandler Carruth0f30a122012-03-30 19:44:53 +0000235 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson071c8102010-01-26 04:02:23 +0000236 }
Chandler Carruth0f30a122012-03-30 19:44:53 +0000237 return GV;
Chris Lattner761acc12009-12-05 08:22:11 +0000238 }
John McCallbf40cb52010-07-15 23:40:35 +0000239
Chris Lattner761acc12009-12-05 08:22:11 +0000240 // The initializer may differ in type from the global. Rewrite
241 // the global to match the initializer. (We have to do this
242 // because some types, like unions, can't be completely represented
243 // in the LLVM type system.)
Chandler Carruth0f30a122012-03-30 19:44:53 +0000244 if (GV->getType()->getElementType() != Init->getType()) {
245 llvm::GlobalVariable *OldGV = GV;
246
247 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
248 OldGV->isConstant(),
249 OldGV->getLinkage(), Init, "",
250 /*InsertBefore*/ OldGV,
Hans Wennborg5e2d5de2012-06-23 11:51:46 +0000251 OldGV->getThreadLocalMode(),
Chandler Carruth0f30a122012-03-30 19:44:53 +0000252 CGM.getContext().getTargetAddressSpace(D.getType()));
253 GV->setVisibility(OldGV->getVisibility());
Eric Christophere1f54902011-08-23 22:38:00 +0000254
Chris Lattner761acc12009-12-05 08:22:11 +0000255 // Steal the name of the old global
Chandler Carruth0f30a122012-03-30 19:44:53 +0000256 GV->takeName(OldGV);
Eric Christophere1f54902011-08-23 22:38:00 +0000257
Chris Lattner761acc12009-12-05 08:22:11 +0000258 // Replace all uses of the old global with the new global
Chandler Carruth0f30a122012-03-30 19:44:53 +0000259 llvm::Constant *NewPtrForOldDecl =
260 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
261 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christophere1f54902011-08-23 22:38:00 +0000262
Chris Lattner761acc12009-12-05 08:22:11 +0000263 // Erase the old global, since it is no longer used.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000264 OldGV->eraseFromParent();
Chris Lattner761acc12009-12-05 08:22:11 +0000265 }
Eric Christophere1f54902011-08-23 22:38:00 +0000266
Chandler Carruth0f30a122012-03-30 19:44:53 +0000267 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
268 GV->setInitializer(Init);
Richard Smith7ca48502012-02-13 22:16:19 +0000269
270 if (hasNontrivialDestruction(D.getType())) {
271 // We have a constant initializer, but a nontrivial destructor. We still
272 // need to perform a guarded "initialization" in order to register the
Richard Smitha9b21d22012-02-17 06:48:11 +0000273 // destructor.
Chandler Carruth0f30a122012-03-30 19:44:53 +0000274 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith7ca48502012-02-13 22:16:19 +0000275 }
276
Chandler Carruth0f30a122012-03-30 19:44:53 +0000277 return GV;
Chris Lattner761acc12009-12-05 08:22:11 +0000278}
279
John McCallb6bbcc92010-10-15 04:57:14 +0000280void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssonf6b89a12010-02-07 02:03:08 +0000281 llvm::GlobalValue::LinkageTypes Linkage) {
Chandler Carruth0f30a122012-03-30 19:44:53 +0000282 llvm::Value *&DMEntry = LocalDeclMap[&D];
283 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
Mike Stump1eb44332009-09-09 15:08:12 +0000284
John McCall355bba72012-03-30 21:00:39 +0000285 // Check to see if we already have a global variable for this
286 // declaration. This can happen when double-emitting function
287 // bodies, e.g. with complete and base constructors.
288 llvm::Constant *addr =
289 CGM.getStaticLocalDeclAddress(&D);
290
291 llvm::GlobalVariable *var;
292 if (addr) {
293 var = cast<llvm::GlobalVariable>(addr->stripPointerCasts());
294 } else {
295 addr = var = CreateStaticVarDecl(D, ".", Linkage);
296 }
Daniel Dunbara985b312009-02-25 19:45:19 +0000297
Daniel Dunbare5731f82009-02-25 20:08:33 +0000298 // Store into LocalDeclMap before generating initializer to handle
299 // circular references.
John McCall355bba72012-03-30 21:00:39 +0000300 DMEntry = addr;
301 CGM.setStaticLocalDeclAddress(&D, addr);
Daniel Dunbare5731f82009-02-25 20:08:33 +0000302
John McCallfe67f3b2010-05-04 20:45:42 +0000303 // We can't have a VLA here, but we can have a pointer to a VLA,
304 // even though that doesn't really make any sense.
Eli Friedmanc62aad82009-04-20 03:54:15 +0000305 // Make sure to evaluate VLA bounds now so that we have them for later.
306 if (D.getType()->isVariablyModifiedType())
John McCallbc8d40d2011-06-24 21:55:10 +0000307 EmitVariablyModifiedType(D.getType());
Eric Christophere1f54902011-08-23 22:38:00 +0000308
John McCall355bba72012-03-30 21:00:39 +0000309 // Save the type in case adding the initializer forces a type change.
310 llvm::Type *expectedType = addr->getType();
Eli Friedmanc62aad82009-04-20 03:54:15 +0000311
Chris Lattner761acc12009-12-05 08:22:11 +0000312 // If this value has an initializer, emit it.
313 if (D.getInit())
John McCall355bba72012-03-30 21:00:39 +0000314 var = AddInitializerToStaticVarDecl(D, var);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000315
John McCall355bba72012-03-30 21:00:39 +0000316 var->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Chris Lattner0af95232010-03-10 23:59:59 +0000317
Julien Lerouge77f68bb2011-09-09 22:41:49 +0000318 if (D.hasAttr<AnnotateAttr>())
John McCall355bba72012-03-30 21:00:39 +0000319 CGM.AddGlobalAnnotations(&D, var);
Nate Begeman8bd4afe2008-04-19 04:17:09 +0000320
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000321 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCall355bba72012-03-30 21:00:39 +0000322 var->setSection(SA->getName());
Mike Stump1eb44332009-09-09 15:08:12 +0000323
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000324 if (D.hasAttr<UsedAttr>())
John McCall355bba72012-03-30 21:00:39 +0000325 CGM.AddUsedGlobal(var);
Daniel Dunbar5c61d972009-02-13 22:08:43 +0000326
Chandler Carruth0f30a122012-03-30 19:44:53 +0000327 // We may have to cast the constant because of the initializer
328 // mismatch above.
329 //
330 // FIXME: It is really dangerous to store this in the map; if anyone
331 // RAUW's the GV uses of this constant will be invalid.
John McCall355bba72012-03-30 21:00:39 +0000332 llvm::Constant *castedAddr = llvm::ConstantExpr::getBitCast(var, expectedType);
333 DMEntry = castedAddr;
334 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000335
336 // Emit global variable debug descriptor for static vars.
Anders Carlssone896d982009-02-13 08:11:52 +0000337 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonovfd00eec2012-05-04 07:39:27 +0000338 if (DI &&
Douglas Gregor4cdad312012-10-23 20:05:01 +0000339 CGM.getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo) {
Daniel Dunbar66031a52008-10-17 16:15:48 +0000340 DI->setLocation(D.getLocation());
John McCall355bba72012-03-30 21:00:39 +0000341 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000342 }
Anders Carlsson1a86b332007-10-17 00:52:43 +0000343}
Mike Stump1eb44332009-09-09 15:08:12 +0000344
John McCallda65ea82010-07-13 20:32:21 +0000345namespace {
John McCallbdc4d802011-07-09 01:37:26 +0000346 struct DestroyObject : EHScopeStack::Cleanup {
347 DestroyObject(llvm::Value *addr, QualType type,
John McCall2673c682011-07-11 08:38:19 +0000348 CodeGenFunction::Destroyer *destroyer,
349 bool useEHCleanupForArray)
Peter Collingbourne516bbd42012-01-26 03:33:36 +0000350 : addr(addr), type(type), destroyer(destroyer),
John McCall2673c682011-07-11 08:38:19 +0000351 useEHCleanupForArray(useEHCleanupForArray) {}
John McCallda65ea82010-07-13 20:32:21 +0000352
John McCallbdc4d802011-07-09 01:37:26 +0000353 llvm::Value *addr;
354 QualType type;
Peter Collingbourne516bbd42012-01-26 03:33:36 +0000355 CodeGenFunction::Destroyer *destroyer;
John McCall2673c682011-07-11 08:38:19 +0000356 bool useEHCleanupForArray;
John McCallda65ea82010-07-13 20:32:21 +0000357
John McCallad346f42011-07-12 20:27:29 +0000358 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +0000359 // Don't use an EH cleanup recursively from an EH cleanup.
John McCallad346f42011-07-12 20:27:29 +0000360 bool useEHCleanupForArray =
361 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall2673c682011-07-11 08:38:19 +0000362
363 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCallda65ea82010-07-13 20:32:21 +0000364 }
365 };
366
John McCallbdc4d802011-07-09 01:37:26 +0000367 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
368 DestroyNRVOVariable(llvm::Value *addr,
369 const CXXDestructorDecl *Dtor,
370 llvm::Value *NRVOFlag)
371 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {}
John McCallda65ea82010-07-13 20:32:21 +0000372
373 const CXXDestructorDecl *Dtor;
374 llvm::Value *NRVOFlag;
375 llvm::Value *Loc;
376
John McCallad346f42011-07-12 20:27:29 +0000377 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallda65ea82010-07-13 20:32:21 +0000378 // Along the exceptions path we always execute the dtor.
John McCallad346f42011-07-12 20:27:29 +0000379 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCallda65ea82010-07-13 20:32:21 +0000380
381 llvm::BasicBlock *SkipDtorBB = 0;
382 if (NRVO) {
383 // If we exited via NRVO, we skip the destructor call.
384 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
385 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
386 llvm::Value *DidNRVO = CGF.Builder.CreateLoad(NRVOFlag, "nrvo.val");
387 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
388 CGF.EmitBlock(RunDtorBB);
389 }
Eric Christophere1f54902011-08-23 22:38:00 +0000390
John McCallda65ea82010-07-13 20:32:21 +0000391 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor378e1e72013-01-31 05:50:40 +0000392 /*ForVirtualBase=*/false,
393 /*Delegating=*/false,
394 Loc);
John McCallda65ea82010-07-13 20:32:21 +0000395
396 if (NRVO) CGF.EmitBlock(SkipDtorBB);
397 }
398 };
John McCallda65ea82010-07-13 20:32:21 +0000399
John McCall1f0fca52010-07-21 07:22:38 +0000400 struct CallStackRestore : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000401 llvm::Value *Stack;
402 CallStackRestore(llvm::Value *Stack) : Stack(Stack) {}
John McCallad346f42011-07-12 20:27:29 +0000403 void Emit(CodeGenFunction &CGF, Flags flags) {
Benjamin Kramer578faa82011-09-27 21:06:10 +0000404 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
John McCalld8715092010-07-21 06:13:08 +0000405 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
406 CGF.Builder.CreateCall(F, V);
407 }
408 };
409
John McCall0c24c802011-06-24 23:21:27 +0000410 struct ExtendGCLifetime : EHScopeStack::Cleanup {
411 const VarDecl &Var;
412 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
413
John McCallad346f42011-07-12 20:27:29 +0000414 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall0c24c802011-06-24 23:21:27 +0000415 // Compute the address of the local variable, in case it's a
416 // byref or something.
John McCallf4b88a42012-03-10 09:33:50 +0000417 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
418 Var.getType(), VK_LValue, SourceLocation());
John McCall0c24c802011-06-24 23:21:27 +0000419 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE));
420 CGF.EmitExtendGCLifetime(value);
421 }
422 };
423
John McCall1f0fca52010-07-21 07:22:38 +0000424 struct CallCleanupFunction : EHScopeStack::Cleanup {
John McCalld8715092010-07-21 06:13:08 +0000425 llvm::Constant *CleanupFn;
426 const CGFunctionInfo &FnInfo;
John McCalld8715092010-07-21 06:13:08 +0000427 const VarDecl &Var;
Eric Christophere1f54902011-08-23 22:38:00 +0000428
John McCalld8715092010-07-21 06:13:08 +0000429 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCall34695852011-02-22 06:44:22 +0000430 const VarDecl *Var)
431 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalld8715092010-07-21 06:13:08 +0000432
John McCallad346f42011-07-12 20:27:29 +0000433 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf4b88a42012-03-10 09:33:50 +0000434 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
435 Var.getType(), VK_LValue, SourceLocation());
John McCall34695852011-02-22 06:44:22 +0000436 // Compute the address of the local variable, in case it's a byref
437 // or something.
438 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getAddress();
439
John McCalld8715092010-07-21 06:13:08 +0000440 // In some cases, the type of the function argument will be different from
441 // the type of the pointer. An example of this is
442 // void f(void* arg);
443 // __attribute__((cleanup(f))) void *g;
444 //
445 // To fix this we insert a bitcast here.
446 QualType ArgTy = FnInfo.arg_begin()->type;
447 llvm::Value *Arg =
448 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
449
450 CallArgList Args;
Eli Friedman04c9a492011-05-02 17:57:46 +0000451 Args.add(RValue::get(Arg),
452 CGF.getContext().getPointerType(Var.getType()));
John McCalld8715092010-07-21 06:13:08 +0000453 CGF.EmitCall(FnInfo, CleanupFn, ReturnValueSlot(), Args);
454 }
455 };
Nadav Rotem495cfa42013-03-23 06:43:35 +0000456
457 /// A cleanup to call @llvm.lifetime.end.
458 class CallLifetimeEnd : public EHScopeStack::Cleanup {
459 llvm::Value *Addr;
460 llvm::Value *Size;
461 public:
462 CallLifetimeEnd(llvm::Value *addr, llvm::Value *size)
463 : Addr(addr), Size(size) {}
464
465 void Emit(CodeGenFunction &CGF, Flags flags) {
466 llvm::Value *castAddr = CGF.Builder.CreateBitCast(Addr, CGF.Int8PtrTy);
467 CGF.Builder.CreateCall2(CGF.CGM.getLLVMLifetimeEndFn(),
468 Size, castAddr)
469 ->setDoesNotThrow();
470 }
471 };
John McCalld8715092010-07-21 06:13:08 +0000472}
473
John McCallf85e1932011-06-15 23:02:42 +0000474/// EmitAutoVarWithLifetime - Does the setup required for an automatic
475/// variable with lifetime.
476static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
477 llvm::Value *addr,
478 Qualifiers::ObjCLifetime lifetime) {
479 switch (lifetime) {
480 case Qualifiers::OCL_None:
481 llvm_unreachable("present but none");
482
483 case Qualifiers::OCL_ExplicitNone:
484 // nothing to do
485 break;
486
487 case Qualifiers::OCL_Strong: {
Peter Collingbourne516bbd42012-01-26 03:33:36 +0000488 CodeGenFunction::Destroyer *destroyer =
John McCall9928c482011-07-12 16:41:08 +0000489 (var.hasAttr<ObjCPreciseLifetimeAttr>()
490 ? CodeGenFunction::destroyARCStrongPrecise
491 : CodeGenFunction::destroyARCStrongImprecise);
492
493 CleanupKind cleanupKind = CGF.getARCCleanupKind();
494 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
495 cleanupKind & EHCleanup);
John McCallf85e1932011-06-15 23:02:42 +0000496 break;
497 }
498 case Qualifiers::OCL_Autoreleasing:
499 // nothing to do
500 break;
Eric Christophere1f54902011-08-23 22:38:00 +0000501
John McCallf85e1932011-06-15 23:02:42 +0000502 case Qualifiers::OCL_Weak:
503 // __weak objects always get EH cleanups; otherwise, exceptions
504 // could cause really nasty crashes instead of mere leaks.
John McCall9928c482011-07-12 16:41:08 +0000505 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
506 CodeGenFunction::destroyARCWeak,
507 /*useEHCleanup*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000508 break;
509 }
510}
511
512static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
513 if (const Expr *e = dyn_cast<Expr>(s)) {
514 // Skip the most common kinds of expressions that make
515 // hierarchy-walking expensive.
516 s = e = e->IgnoreParenCasts();
517
518 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
519 return (ref->getDecl() == &var);
Fariborz Jahanianddfc8a12012-06-19 20:53:26 +0000520 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
521 const BlockDecl *block = be->getBlockDecl();
522 for (BlockDecl::capture_const_iterator i = block->capture_begin(),
523 e = block->capture_end(); i != e; ++i) {
524 if (i->getVariable() == &var)
525 return true;
526 }
527 }
John McCallf85e1932011-06-15 23:02:42 +0000528 }
529
530 for (Stmt::const_child_range children = s->children(); children; ++children)
Fariborz Jahanian8fefc8e2011-06-29 20:00:16 +0000531 // children might be null; as in missing decl or conditional of an if-stmt.
532 if ((*children) && isAccessedBy(var, *children))
John McCallf85e1932011-06-15 23:02:42 +0000533 return true;
534
535 return false;
536}
537
538static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
539 if (!decl) return false;
540 if (!isa<VarDecl>(decl)) return false;
541 const VarDecl *var = cast<VarDecl>(decl);
542 return isAccessedBy(*var, e);
543}
544
John McCalla07398e2011-06-16 04:16:24 +0000545static void drillIntoBlockVariable(CodeGenFunction &CGF,
546 LValue &lvalue,
547 const VarDecl *var) {
548 lvalue.setAddress(CGF.BuildBlockByrefAddress(lvalue.getAddress(), var));
549}
550
John McCallf85e1932011-06-15 23:02:42 +0000551void CodeGenFunction::EmitScalarInit(const Expr *init,
552 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +0000553 LValue lvalue,
554 bool capturedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000555 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCallf85e1932011-06-15 23:02:42 +0000556 if (!lifetime) {
557 llvm::Value *value = EmitScalarExpr(init);
John McCalla07398e2011-06-16 04:16:24 +0000558 if (capturedByInit)
559 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Chisnall7a7ee302012-01-16 17:27:18 +0000560 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCallf85e1932011-06-15 23:02:42 +0000561 return;
562 }
563
564 // If we're emitting a value with lifetime, we have to do the
565 // initialization *before* we leave the cleanup scopes.
John McCall1a343eb2011-11-10 08:15:53 +0000566 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init)) {
567 enterFullExpression(ewc);
John McCallf85e1932011-06-15 23:02:42 +0000568 init = ewc->getSubExpr();
John McCall1a343eb2011-11-10 08:15:53 +0000569 }
570 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCallf85e1932011-06-15 23:02:42 +0000571
572 // We have to maintain the illusion that the variable is
573 // zero-initialized. If the variable might be accessed in its
574 // initializer, zero-initialize before running the initializer, then
575 // actually perform the initialization with an assign.
576 bool accessedByInit = false;
577 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallfb720812011-07-28 07:23:35 +0000578 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCallf85e1932011-06-15 23:02:42 +0000579 if (accessedByInit) {
John McCalla07398e2011-06-16 04:16:24 +0000580 LValue tempLV = lvalue;
John McCallf85e1932011-06-15 23:02:42 +0000581 // Drill down to the __block object if necessary.
John McCallf85e1932011-06-15 23:02:42 +0000582 if (capturedByInit) {
583 // We can use a simple GEP for this because it can't have been
584 // moved yet.
John McCalla07398e2011-06-16 04:16:24 +0000585 tempLV.setAddress(Builder.CreateStructGEP(tempLV.getAddress(),
586 getByRefValueLLVMField(cast<VarDecl>(D))));
John McCallf85e1932011-06-15 23:02:42 +0000587 }
588
Chris Lattner2acc6e32011-07-18 04:24:23 +0000589 llvm::PointerType *ty
John McCalla07398e2011-06-16 04:16:24 +0000590 = cast<llvm::PointerType>(tempLV.getAddress()->getType());
John McCallf85e1932011-06-15 23:02:42 +0000591 ty = cast<llvm::PointerType>(ty->getElementType());
592
593 llvm::Value *zero = llvm::ConstantPointerNull::get(ty);
Eric Christophere1f54902011-08-23 22:38:00 +0000594
John McCallf85e1932011-06-15 23:02:42 +0000595 // If __weak, we want to use a barrier under certain conditions.
596 if (lifetime == Qualifiers::OCL_Weak)
John McCalla07398e2011-06-16 04:16:24 +0000597 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCallf85e1932011-06-15 23:02:42 +0000598
599 // Otherwise just do a simple store.
600 else
David Chisnall7a7ee302012-01-16 17:27:18 +0000601 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCallf85e1932011-06-15 23:02:42 +0000602 }
603
604 // Emit the initializer.
605 llvm::Value *value = 0;
606
607 switch (lifetime) {
608 case Qualifiers::OCL_None:
609 llvm_unreachable("present but none");
610
611 case Qualifiers::OCL_ExplicitNone:
612 // nothing to do
613 value = EmitScalarExpr(init);
614 break;
615
616 case Qualifiers::OCL_Strong: {
617 value = EmitARCRetainScalarExpr(init);
618 break;
619 }
620
621 case Qualifiers::OCL_Weak: {
622 // No way to optimize a producing initializer into this. It's not
623 // worth optimizing for, because the value will immediately
624 // disappear in the common case.
625 value = EmitScalarExpr(init);
626
John McCalla07398e2011-06-16 04:16:24 +0000627 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000628 if (accessedByInit)
John McCalla07398e2011-06-16 04:16:24 +0000629 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCallf85e1932011-06-15 23:02:42 +0000630 else
John McCalla07398e2011-06-16 04:16:24 +0000631 EmitARCInitWeak(lvalue.getAddress(), value);
John McCallf85e1932011-06-15 23:02:42 +0000632 return;
633 }
634
635 case Qualifiers::OCL_Autoreleasing:
636 value = EmitARCRetainAutoreleaseScalarExpr(init);
637 break;
638 }
639
John McCalla07398e2011-06-16 04:16:24 +0000640 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCallf85e1932011-06-15 23:02:42 +0000641
642 // If the variable might have been accessed by its initializer, we
643 // might have to initialize with a barrier. We have to do this for
644 // both __weak and __strong, but __weak got filtered out above.
645 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
John McCalla07398e2011-06-16 04:16:24 +0000646 llvm::Value *oldValue = EmitLoadOfScalar(lvalue);
David Chisnall7a7ee302012-01-16 17:27:18 +0000647 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall5b07e802013-03-13 03:10:54 +0000648 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCallf85e1932011-06-15 23:02:42 +0000649 return;
650 }
651
David Chisnall7a7ee302012-01-16 17:27:18 +0000652 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallf85e1932011-06-15 23:02:42 +0000653}
Chris Lattner94cd0112010-12-01 02:05:19 +0000654
John McCall7acddac2011-06-17 06:42:21 +0000655/// EmitScalarInit - Initialize the given lvalue with the given object.
656void CodeGenFunction::EmitScalarInit(llvm::Value *init, LValue lvalue) {
657 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
658 if (!lifetime)
David Chisnall7a7ee302012-01-16 17:27:18 +0000659 return EmitStoreThroughLValue(RValue::get(init), lvalue, true);
John McCall7acddac2011-06-17 06:42:21 +0000660
661 switch (lifetime) {
662 case Qualifiers::OCL_None:
663 llvm_unreachable("present but none");
664
665 case Qualifiers::OCL_ExplicitNone:
666 // nothing to do
667 break;
668
669 case Qualifiers::OCL_Strong:
670 init = EmitARCRetain(lvalue.getType(), init);
671 break;
672
673 case Qualifiers::OCL_Weak:
674 // Initialize and then skip the primitive store.
675 EmitARCInitWeak(lvalue.getAddress(), init);
676 return;
677
678 case Qualifiers::OCL_Autoreleasing:
679 init = EmitARCRetainAutorelease(lvalue.getType(), init);
680 break;
681 }
682
David Chisnall7a7ee302012-01-16 17:27:18 +0000683 EmitStoreOfScalar(init, lvalue, /* isInitialization */ true);
John McCall7acddac2011-06-17 06:42:21 +0000684}
685
Chris Lattner94cd0112010-12-01 02:05:19 +0000686/// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the
687/// non-zero parts of the specified initializer with equal or fewer than
688/// NumStores scalar stores.
689static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init,
690 unsigned &NumStores) {
Chris Lattner70b02942010-12-02 01:58:41 +0000691 // Zero and Undef never requires any extra stores.
692 if (isa<llvm::ConstantAggregateZero>(Init) ||
693 isa<llvm::ConstantPointerNull>(Init) ||
694 isa<llvm::UndefValue>(Init))
695 return true;
696 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
697 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
698 isa<llvm::ConstantExpr>(Init))
699 return Init->isNullValue() || NumStores--;
700
701 // See if we can emit each element.
702 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
703 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
704 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
705 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
706 return false;
707 }
708 return true;
709 }
Chris Lattnerf492cb12012-01-31 04:36:19 +0000710
711 if (llvm::ConstantDataSequential *CDS =
712 dyn_cast<llvm::ConstantDataSequential>(Init)) {
713 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
714 llvm::Constant *Elt = CDS->getElementAsConstant(i);
715 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
716 return false;
717 }
718 return true;
719 }
Eric Christophere1f54902011-08-23 22:38:00 +0000720
Chris Lattner94cd0112010-12-01 02:05:19 +0000721 // Anything else is hard and scary.
722 return false;
723}
724
725/// emitStoresForInitAfterMemset - For inits that
726/// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar
727/// stores that would be required.
728static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc,
John McCall34695852011-02-22 06:44:22 +0000729 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer06d43682012-08-27 22:07:02 +0000730 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
731 "called emitStoresForInitAfterMemset for zero or undef value.");
Eric Christophere1f54902011-08-23 22:38:00 +0000732
Chris Lattner70b02942010-12-02 01:58:41 +0000733 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
734 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
735 isa<llvm::ConstantExpr>(Init)) {
Chris Lattnerf492cb12012-01-31 04:36:19 +0000736 Builder.CreateStore(Init, Loc, isVolatile);
737 return;
738 }
739
740 if (llvm::ConstantDataSequential *CDS =
741 dyn_cast<llvm::ConstantDataSequential>(Init)) {
742 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
743 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramercfa07e32012-08-27 21:35:58 +0000744
745 // If necessary, get a pointer to the element and emit it.
746 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
747 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
748 isVolatile, Builder);
Chris Lattnerf492cb12012-01-31 04:36:19 +0000749 }
Chris Lattner70b02942010-12-02 01:58:41 +0000750 return;
751 }
Eric Christophere1f54902011-08-23 22:38:00 +0000752
Chris Lattner70b02942010-12-02 01:58:41 +0000753 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
754 "Unknown value type!");
Eric Christophere1f54902011-08-23 22:38:00 +0000755
Chris Lattner70b02942010-12-02 01:58:41 +0000756 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
757 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramercfa07e32012-08-27 21:35:58 +0000758
759 // If necessary, get a pointer to the element and emit it.
760 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
761 emitStoresForInitAfterMemset(Elt, Builder.CreateConstGEP2_32(Loc, 0, i),
762 isVolatile, Builder);
Chris Lattner70b02942010-12-02 01:58:41 +0000763 }
Chris Lattner94cd0112010-12-01 02:05:19 +0000764}
765
766
767/// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset
768/// plus some stores to initialize a local variable instead of using a memcpy
769/// from a constant global. It is beneficial to use memset if the global is all
770/// zeros, or mostly zeros and large.
771static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init,
772 uint64_t GlobalSize) {
773 // If a global is all zeros, always use a memset.
774 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
775
Chris Lattner94cd0112010-12-01 02:05:19 +0000776 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
777 // do it if it will require 6 or fewer scalar stores.
778 // TODO: Should budget depends on the size? Avoiding a large global warrants
779 // plopping in more stores.
780 unsigned StoreBudget = 6;
781 uint64_t SizeLimit = 32;
Eric Christophere1f54902011-08-23 22:38:00 +0000782
783 return GlobalSize > SizeLimit &&
Chris Lattner94cd0112010-12-01 02:05:19 +0000784 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget);
785}
786
Nadav Rotem495cfa42013-03-23 06:43:35 +0000787/// Should we use the LLVM lifetime intrinsics for the given local variable?
788static bool shouldUseLifetimeMarkers(CodeGenFunction &CGF, const VarDecl &D,
789 unsigned Size) {
Alexey Samsonov4f01ed42013-04-02 13:19:46 +0000790 // Always emit lifetime markers in -fsanitize=use-after-scope mode.
791 if (CGF.getLangOpts().Sanitize.UseAfterScope)
792 return true;
Nadav Rotem495cfa42013-03-23 06:43:35 +0000793 // For now, only in optimized builds.
794 if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0)
795 return false;
796
797 // Limit the size of marked objects to 32 bytes. We don't want to increase
798 // compile time by marking tiny objects.
799 unsigned SizeThreshold = 32;
800
801 return Size > SizeThreshold;
802}
803
Chris Lattner94cd0112010-12-01 02:05:19 +0000804
Nick Lewyckya9de3fa2010-12-30 20:21:55 +0000805/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Reid Spencer5f016e22007-07-11 17:01:13 +0000806/// variable declaration with auto, register, or no storage class specifier.
Chris Lattner2621fd12008-05-08 05:58:21 +0000807/// These turn into simple stack objects, or GlobalValues depending on target.
John McCall34695852011-02-22 06:44:22 +0000808void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
809 AutoVarEmission emission = EmitAutoVarAlloca(D);
810 EmitAutoVarInit(emission);
811 EmitAutoVarCleanups(emission);
812}
Reid Spencer5f016e22007-07-11 17:01:13 +0000813
John McCall34695852011-02-22 06:44:22 +0000814/// EmitAutoVarAlloca - Emit the alloca and debug information for a
815/// local variable. Does not emit initalization or destruction.
816CodeGenFunction::AutoVarEmission
817CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
818 QualType Ty = D.getType();
819
820 AutoVarEmission emission(D);
821
822 bool isByRef = D.hasAttr<BlocksAttr>();
823 emission.IsByRef = isByRef;
824
825 CharUnits alignment = getContext().getDeclAlign(&D);
826 emission.Alignment = alignment;
827
John McCallbc8d40d2011-06-24 21:55:10 +0000828 // If the type is variably-modified, emit all the VLA sizes for it.
829 if (Ty->isVariablyModifiedType())
830 EmitVariablyModifiedType(Ty);
831
Reid Spencer5f016e22007-07-11 17:01:13 +0000832 llvm::Value *DeclPtr;
Eli Friedman3c2b3172008-02-15 12:20:59 +0000833 if (Ty->isConstantSizeType()) {
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000834 bool NRVO = getLangOpts().ElideConstructors &&
835 D.isNRVOVariable();
John McCall34695852011-02-22 06:44:22 +0000836
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000837 // If this value is a POD array or struct with a statically
838 // determinable constant initializer, there are optimizations we can do.
839 //
840 // TODO: We should constant-evaluate the initializer of any variable,
841 // as long as it is initialized by a constant expression. Currently,
842 // isConstantInitializer produces wrong answers for structs with
843 // reference or bitfield members, and a few other cases, and checking
844 // for POD-ness protects us from some of these.
845 if (D.getInit() &&
846 (Ty->isArrayType() || Ty->isRecordType()) &&
847 (Ty.isPODType(getContext()) ||
848 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
849 D.getInit()->isConstantInitializer(getContext(), false)) {
John McCall34695852011-02-22 06:44:22 +0000850
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000851 // If the variable's a const type, and it's neither an NRVO
852 // candidate nor a __block variable and has no mutable members,
853 // emit it as a global instead.
854 if (CGM.getCodeGenOpts().MergeAllConstants && !NRVO && !isByRef &&
855 CGM.isTypeConstant(Ty, true)) {
856 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCall34695852011-02-22 06:44:22 +0000857
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000858 emission.Address = 0; // signal this condition to later callbacks
859 assert(emission.wasEmittedAsGlobal());
860 return emission;
Tanya Lattner59876c22009-11-04 01:18:09 +0000861 }
Eric Christophere1f54902011-08-23 22:38:00 +0000862
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000863 // Otherwise, tell the initialization code that we're in this case.
864 emission.IsConstantAggregate = true;
865 }
Eric Christophere1f54902011-08-23 22:38:00 +0000866
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000867 // A normal fixed sized variable becomes an alloca in the entry block,
868 // unless it's an NRVO variable.
869 llvm::Type *LTy = ConvertTypeForMem(Ty);
Eric Christophere1f54902011-08-23 22:38:00 +0000870
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000871 if (NRVO) {
872 // The named return value optimization: allocate this variable in the
873 // return slot, so that we can elide the copy when returning this
874 // variable (C++0x [class.copy]p34).
875 DeclPtr = ReturnValue;
Eric Christophere1f54902011-08-23 22:38:00 +0000876
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000877 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
878 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) {
879 // Create a flag that is used to indicate when the NRVO was applied
880 // to this variable. Set it to zero to indicate that NRVO was not
881 // applied.
882 llvm::Value *Zero = Builder.getFalse();
883 llvm::Value *NRVOFlag = CreateTempAlloca(Zero->getType(), "nrvo");
884 EnsureInsertPoint();
885 Builder.CreateStore(Zero, NRVOFlag);
Eric Christophere1f54902011-08-23 22:38:00 +0000886
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000887 // Record the NRVO flag for this variable.
888 NRVOFlags[&D] = NRVOFlag;
889 emission.NRVOFlag = NRVOFlag;
Nadav Rotem495cfa42013-03-23 06:43:35 +0000890 }
Douglas Gregord86c4772010-05-15 06:46:45 +0000891 }
Chris Lattner2621fd12008-05-08 05:58:21 +0000892 } else {
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000893 if (isByRef)
894 LTy = BuildByRefType(&D);
895
896 llvm::AllocaInst *Alloc = CreateTempAlloca(LTy);
897 Alloc->setName(D.getName());
898
899 CharUnits allocaAlignment = alignment;
900 if (isByRef)
901 allocaAlignment = std::max(allocaAlignment,
902 getContext().toCharUnitsFromBits(Target.getPointerAlign(0)));
903 Alloc->setAlignment(allocaAlignment.getQuantity());
904 DeclPtr = Alloc;
905
906 // Emit a lifetime intrinsic if meaningful. There's no point
907 // in doing this if we don't have a valid insertion point (?).
908 uint64_t size = CGM.getDataLayout().getTypeAllocSize(LTy);
909 if (HaveInsertPoint() && shouldUseLifetimeMarkers(*this, D, size)) {
910 llvm::Value *sizeV = llvm::ConstantInt::get(Int64Ty, size);
911
912 emission.SizeForLifetimeMarkers = sizeV;
913 llvm::Value *castAddr = Builder.CreateBitCast(Alloc, Int8PtrTy);
914 Builder.CreateCall2(CGM.getLLVMLifetimeStartFn(), sizeV, castAddr)
915 ->setDoesNotThrow();
916 } else {
917 assert(!emission.useLifetimeMarkers());
918 }
Chris Lattner2621fd12008-05-08 05:58:21 +0000919 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000920 } else {
Daniel Dunbard286f052009-07-19 06:58:07 +0000921 EnsureInsertPoint();
922
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000923 if (!DidCallStackSave) {
Anders Carlsson5d463152008-12-12 07:38:43 +0000924 // Save the stack.
John McCalld16c2cf2011-02-08 08:22:06 +0000925 llvm::Value *Stack = CreateTempAlloca(Int8PtrTy, "saved_stack");
Mike Stump1eb44332009-09-09 15:08:12 +0000926
Anders Carlsson5d463152008-12-12 07:38:43 +0000927 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
928 llvm::Value *V = Builder.CreateCall(F);
Mike Stump1eb44332009-09-09 15:08:12 +0000929
Anders Carlsson5d463152008-12-12 07:38:43 +0000930 Builder.CreateStore(V, Stack);
Anders Carlsson5ecb1b92009-02-09 20:41:50 +0000931
932 DidCallStackSave = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000933
John McCalld8715092010-07-21 06:13:08 +0000934 // Push a cleanup block and restore the stack there.
John McCall3ad32c82011-01-28 08:37:24 +0000935 // FIXME: in general circumstances, this should be an EH cleanup.
John McCall1f0fca52010-07-21 07:22:38 +0000936 EHStack.pushCleanup<CallStackRestore>(NormalCleanup, Stack);
Anders Carlsson5d463152008-12-12 07:38:43 +0000937 }
Mike Stump1eb44332009-09-09 15:08:12 +0000938
John McCallbc8d40d2011-06-24 21:55:10 +0000939 llvm::Value *elementCount;
940 QualType elementType;
941 llvm::tie(elementCount, elementType) = getVLASize(Ty);
Anders Carlsson5d463152008-12-12 07:38:43 +0000942
Chris Lattner2acc6e32011-07-18 04:24:23 +0000943 llvm::Type *llvmTy = ConvertTypeForMem(elementType);
Anders Carlsson5d463152008-12-12 07:38:43 +0000944
945 // Allocate memory for the array.
John McCallbc8d40d2011-06-24 21:55:10 +0000946 llvm::AllocaInst *vla = Builder.CreateAlloca(llvmTy, elementCount, "vla");
947 vla->setAlignment(alignment.getQuantity());
Anders Carlsson41f8a132009-09-26 18:16:06 +0000948
John McCallbc8d40d2011-06-24 21:55:10 +0000949 DeclPtr = vla;
Reid Spencer5f016e22007-07-11 17:01:13 +0000950 }
Eli Friedman8f39f5e2008-12-20 23:11:59 +0000951
Reid Spencer5f016e22007-07-11 17:01:13 +0000952 llvm::Value *&DMEntry = LocalDeclMap[&D];
953 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
954 DMEntry = DeclPtr;
John McCall34695852011-02-22 06:44:22 +0000955 emission.Address = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000956
957 // Emit debug info for local var declaration.
Devang Patelc594abd2011-06-03 19:21:47 +0000958 if (HaveInsertPoint())
959 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregor4cdad312012-10-23 20:05:01 +0000960 if (CGM.getCodeGenOpts().getDebugInfo()
961 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +0000962 DI->setLocation(D.getLocation());
Rafael Espindola6c82fc62013-03-26 18:41:47 +0000963 DI->EmitDeclareOfAutoVariable(&D, DeclPtr, Builder);
Alexey Samsonovfd00eec2012-05-04 07:39:27 +0000964 }
Devang Patelc594abd2011-06-03 19:21:47 +0000965 }
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000966
Julien Lerouge77f68bb2011-09-09 22:41:49 +0000967 if (D.hasAttr<AnnotateAttr>())
968 EmitVarAnnotations(&D, emission.Address);
969
John McCall34695852011-02-22 06:44:22 +0000970 return emission;
971}
972
973/// Determines whether the given __block variable is potentially
974/// captured by the given expression.
975static bool isCapturedBy(const VarDecl &var, const Expr *e) {
976 // Skip the most common kinds of expressions that make
977 // hierarchy-walking expensive.
978 e = e->IgnoreParenCasts();
979
980 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
981 const BlockDecl *block = be->getBlockDecl();
982 for (BlockDecl::capture_const_iterator i = block->capture_begin(),
983 e = block->capture_end(); i != e; ++i) {
984 if (i->getVariable() == &var)
985 return true;
986 }
987
988 // No need to walk into the subexpressions.
989 return false;
990 }
991
Fariborz Jahanian5033be12011-08-23 16:47:15 +0000992 if (const StmtExpr *SE = dyn_cast<StmtExpr>(e)) {
993 const CompoundStmt *CS = SE->getSubStmt();
Eric Christopherc6fad602011-08-23 23:44:09 +0000994 for (CompoundStmt::const_body_iterator BI = CS->body_begin(),
995 BE = CS->body_end(); BI != BE; ++BI)
Fariborz Jahanian045c8422011-08-25 00:06:26 +0000996 if (Expr *E = dyn_cast<Expr>((*BI))) {
Fariborz Jahanian5033be12011-08-23 16:47:15 +0000997 if (isCapturedBy(var, E))
998 return true;
Fariborz Jahanian045c8422011-08-25 00:06:26 +0000999 }
1000 else if (DeclStmt *DS = dyn_cast<DeclStmt>((*BI))) {
1001 // special case declarations
1002 for (DeclStmt::decl_iterator I = DS->decl_begin(), E = DS->decl_end();
1003 I != E; ++I) {
1004 if (VarDecl *VD = dyn_cast<VarDecl>((*I))) {
1005 Expr *Init = VD->getInit();
1006 if (Init && isCapturedBy(var, Init))
1007 return true;
1008 }
1009 }
1010 }
1011 else
1012 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1013 // Later, provide code to poke into statements for capture analysis.
1014 return true;
Fariborz Jahanian5033be12011-08-23 16:47:15 +00001015 return false;
1016 }
Eric Christophere1f54902011-08-23 22:38:00 +00001017
John McCall34695852011-02-22 06:44:22 +00001018 for (Stmt::const_child_range children = e->children(); children; ++children)
1019 if (isCapturedBy(var, cast<Expr>(*children)))
1020 return true;
1021
1022 return false;
1023}
1024
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001025/// \brief Determine whether the given initializer is trivial in the sense
1026/// that it requires no code to be generated.
1027static bool isTrivialInitializer(const Expr *Init) {
1028 if (!Init)
1029 return true;
Eric Christophere1f54902011-08-23 22:38:00 +00001030
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001031 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1032 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1033 if (Constructor->isTrivial() &&
1034 Constructor->isDefaultConstructor() &&
1035 !Construct->requiresZeroInitialization())
1036 return true;
Eric Christophere1f54902011-08-23 22:38:00 +00001037
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001038 return false;
1039}
John McCall34695852011-02-22 06:44:22 +00001040void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +00001041 assert(emission.Variable && "emission was not valid!");
1042
John McCall34695852011-02-22 06:44:22 +00001043 // If this was emitted as a global constant, we're done.
1044 if (emission.wasEmittedAsGlobal()) return;
1045
John McCall57b3b6a2011-02-22 07:16:58 +00001046 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +00001047 QualType type = D.getType();
1048
Chris Lattner19785962007-07-12 00:39:48 +00001049 // If this local has an initializer, emit it now.
Daniel Dunbard286f052009-07-19 06:58:07 +00001050 const Expr *Init = D.getInit();
1051
1052 // If we are at an unreachable point, we don't need to emit the initializer
1053 // unless it contains a label.
1054 if (!HaveInsertPoint()) {
John McCall34695852011-02-22 06:44:22 +00001055 if (!Init || !ContainsLabel(Init)) return;
1056 EnsureInsertPoint();
Daniel Dunbard286f052009-07-19 06:58:07 +00001057 }
1058
John McCall5af02db2011-03-31 01:59:53 +00001059 // Initialize the structure of a __block variable.
1060 if (emission.IsByRef)
1061 emitByrefStructureInit(emission);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001062
Douglas Gregorbcc3e662011-07-01 21:08:19 +00001063 if (isTrivialInitializer(Init))
1064 return;
Eric Christophere1f54902011-08-23 22:38:00 +00001065
John McCall5af02db2011-03-31 01:59:53 +00001066 CharUnits alignment = emission.Alignment;
1067
John McCall34695852011-02-22 06:44:22 +00001068 // Check whether this is a byref variable that's potentially
1069 // captured and moved by its own initializer. If so, we'll need to
1070 // emit the initializer first, then copy into the variable.
1071 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init);
1072
1073 llvm::Value *Loc =
1074 capturedByInit ? emission.Address : emission.getObjectAddress(*this);
1075
Richard Smith51201882011-12-30 21:15:51 +00001076 llvm::Constant *constant = 0;
1077 if (emission.IsConstantAggregate) {
1078 assert(!capturedByInit && "constant init contains a capturing block?");
Richard Smith2d6a5672012-01-14 04:30:29 +00001079 constant = CGM.EmitConstantInit(D, this);
Richard Smith51201882011-12-30 21:15:51 +00001080 }
1081
1082 if (!constant) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001083 LValue lv = MakeAddrLValue(Loc, type, alignment);
John McCalla07398e2011-06-16 04:16:24 +00001084 lv.setNonGC(true);
1085 return EmitExprAsInit(Init, &D, lv, capturedByInit);
1086 }
John McCall60d33652011-03-08 09:11:50 +00001087
John McCall34695852011-02-22 06:44:22 +00001088 // If this is a simple aggregate initialization, we can optimize it
1089 // in various ways.
John McCall60d33652011-03-08 09:11:50 +00001090 bool isVolatile = type.isVolatileQualified();
John McCall34695852011-02-22 06:44:22 +00001091
John McCall60d33652011-03-08 09:11:50 +00001092 llvm::Value *SizeVal =
Eric Christophere1f54902011-08-23 22:38:00 +00001093 llvm::ConstantInt::get(IntPtrTy,
John McCall60d33652011-03-08 09:11:50 +00001094 getContext().getTypeSizeInChars(type).getQuantity());
John McCall34695852011-02-22 06:44:22 +00001095
Chris Lattner2acc6e32011-07-18 04:24:23 +00001096 llvm::Type *BP = Int8PtrTy;
John McCall60d33652011-03-08 09:11:50 +00001097 if (Loc->getType() != BP)
Benjamin Kramer578faa82011-09-27 21:06:10 +00001098 Loc = Builder.CreateBitCast(Loc, BP);
Mon P Wang3ecd7852010-04-04 03:10:52 +00001099
John McCall60d33652011-03-08 09:11:50 +00001100 // If the initializer is all or mostly zeros, codegen with memset then do
1101 // a few stores afterward.
Eric Christophere1f54902011-08-23 22:38:00 +00001102 if (shouldUseMemSetPlusStoresToInitialize(constant,
Micah Villmow25a6a842012-10-08 16:25:52 +00001103 CGM.getDataLayout().getTypeAllocSize(constant->getType()))) {
John McCall60d33652011-03-08 09:11:50 +00001104 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1105 alignment.getQuantity(), isVolatile);
Benjamin Kramer06d43682012-08-27 22:07:02 +00001106 // Zero and undef don't require a stores.
1107 if (!constant->isNullValue() && !isa<llvm::UndefValue>(constant)) {
John McCall60d33652011-03-08 09:11:50 +00001108 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo());
1109 emitStoresForInitAfterMemset(constant, Loc, isVolatile, Builder);
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +00001110 }
John McCall60d33652011-03-08 09:11:50 +00001111 } else {
Eric Christophere1f54902011-08-23 22:38:00 +00001112 // Otherwise, create a temporary global with the initializer then
John McCall60d33652011-03-08 09:11:50 +00001113 // memcpy from the global to the alloca.
1114 std::string Name = GetStaticDeclName(*this, D, ".");
1115 llvm::GlobalVariable *GV =
1116 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true,
Eric Christopher736a9c22011-08-24 00:33:55 +00001117 llvm::GlobalValue::PrivateLinkage,
Hans Wennborg5e2d5de2012-06-23 11:51:46 +00001118 constant, Name);
John McCall60d33652011-03-08 09:11:50 +00001119 GV->setAlignment(alignment.getQuantity());
Eli Friedman460980d2011-05-27 22:32:55 +00001120 GV->setUnnamedAddr(true);
Eric Christophere1f54902011-08-23 22:38:00 +00001121
John McCall60d33652011-03-08 09:11:50 +00001122 llvm::Value *SrcPtr = GV;
1123 if (SrcPtr->getType() != BP)
Benjamin Kramer578faa82011-09-27 21:06:10 +00001124 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
John McCall60d33652011-03-08 09:11:50 +00001125
1126 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, alignment.getQuantity(),
1127 isVolatile);
1128 }
1129}
1130
1131/// Emit an expression as an initializer for a variable at the given
1132/// location. The expression is not necessarily the normal
1133/// initializer for the variable, and the address is not necessarily
1134/// its normal location.
1135///
1136/// \param init the initializing expression
1137/// \param var the variable to act as if we're initializing
1138/// \param loc the address to initialize; its type is a pointer
1139/// to the LLVM mapping of the variable's type
1140/// \param alignment the alignment of the address
1141/// \param capturedByInit true if the variable is a __block variable
1142/// whose address is potentially changed by the initializer
1143void CodeGenFunction::EmitExprAsInit(const Expr *init,
John McCallf85e1932011-06-15 23:02:42 +00001144 const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001145 LValue lvalue,
John McCall60d33652011-03-08 09:11:50 +00001146 bool capturedByInit) {
John McCallf85e1932011-06-15 23:02:42 +00001147 QualType type = D->getType();
John McCall60d33652011-03-08 09:11:50 +00001148
1149 if (type->isReferenceType()) {
John McCalla07398e2011-06-16 04:16:24 +00001150 RValue rvalue = EmitReferenceBindingToExpr(init, D);
Eric Christophere1f54902011-08-23 22:38:00 +00001151 if (capturedByInit)
John McCalla07398e2011-06-16 04:16:24 +00001152 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Chisnall7a7ee302012-01-16 17:27:18 +00001153 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall9d232c82013-03-07 21:37:08 +00001154 return;
1155 }
1156 switch (getEvaluationKind(type)) {
1157 case TEK_Scalar:
John McCalla07398e2011-06-16 04:16:24 +00001158 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall9d232c82013-03-07 21:37:08 +00001159 return;
1160 case TEK_Complex: {
John McCall60d33652011-03-08 09:11:50 +00001161 ComplexPairTy complex = EmitComplexExpr(init);
John McCalla07398e2011-06-16 04:16:24 +00001162 if (capturedByInit)
1163 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall9d232c82013-03-07 21:37:08 +00001164 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
1165 return;
1166 }
1167 case TEK_Aggregate:
John McCall9eda3ab2013-03-07 21:37:17 +00001168 if (type->isAtomicType()) {
1169 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1170 } else {
1171 // TODO: how can we delay here if D is captured by its initializer?
1172 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier649b4a12012-03-29 17:37:10 +00001173 AggValueSlot::IsDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001174 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00001175 AggValueSlot::IsNotAliased));
John McCall9eda3ab2013-03-07 21:37:17 +00001176 }
Sebastian Redl972edf02012-02-19 16:03:09 +00001177 MaybeEmitStdInitializerListCleanup(lvalue.getAddress(), init);
John McCall9d232c82013-03-07 21:37:08 +00001178 return;
Fariborz Jahanian20e1c7e2010-03-12 21:40:43 +00001179 }
John McCall9d232c82013-03-07 21:37:08 +00001180 llvm_unreachable("bad evaluation kind");
John McCall34695852011-02-22 06:44:22 +00001181}
John McCallf1549f62010-07-06 01:34:17 +00001182
John McCallbdc4d802011-07-09 01:37:26 +00001183/// Enter a destroy cleanup for the given local variable.
1184void CodeGenFunction::emitAutoVarTypeCleanup(
1185 const CodeGenFunction::AutoVarEmission &emission,
1186 QualType::DestructionKind dtorKind) {
1187 assert(dtorKind != QualType::DK_none);
1188
1189 // Note that for __block variables, we want to destroy the
1190 // original stack object, not the possibly forwarded object.
1191 llvm::Value *addr = emission.getObjectAddress(*this);
1192
1193 const VarDecl *var = emission.Variable;
1194 QualType type = var->getType();
1195
1196 CleanupKind cleanupKind = NormalAndEHCleanup;
1197 CodeGenFunction::Destroyer *destroyer = 0;
1198
1199 switch (dtorKind) {
1200 case QualType::DK_none:
1201 llvm_unreachable("no cleanup for trivially-destructible variable");
1202
1203 case QualType::DK_cxx_destructor:
1204 // If there's an NRVO flag on the emission, we need a different
1205 // cleanup.
1206 if (emission.NRVOFlag) {
1207 assert(!type->isArrayType());
1208 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
1209 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr, dtor,
1210 emission.NRVOFlag);
1211 return;
1212 }
1213 break;
1214
1215 case QualType::DK_objc_strong_lifetime:
1216 // Suppress cleanups for pseudo-strong variables.
1217 if (var->isARCPseudoStrong()) return;
Eric Christophere1f54902011-08-23 22:38:00 +00001218
John McCallbdc4d802011-07-09 01:37:26 +00001219 // Otherwise, consider whether to use an EH cleanup or not.
1220 cleanupKind = getARCCleanupKind();
1221
1222 // Use the imprecise destroyer by default.
1223 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1224 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1225 break;
1226
1227 case QualType::DK_objc_weak_lifetime:
1228 break;
1229 }
1230
1231 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001232 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall2673c682011-07-11 08:38:19 +00001233
Sylvestre Ledruf3477c12012-09-27 10:16:10 +00001234 // Use an EH cleanup in array destructors iff the destructor itself
John McCall2673c682011-07-11 08:38:19 +00001235 // is being pushed as an EH cleanup.
1236 bool useEHCleanup = (cleanupKind & EHCleanup);
1237 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1238 useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001239}
1240
John McCall34695852011-02-22 06:44:22 +00001241void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall57b3b6a2011-02-22 07:16:58 +00001242 assert(emission.Variable && "emission was not valid!");
1243
John McCall34695852011-02-22 06:44:22 +00001244 // If this was emitted as a global constant, we're done.
1245 if (emission.wasEmittedAsGlobal()) return;
1246
John McCall38baeab2012-04-13 18:44:05 +00001247 // If we don't have an insertion point, we're done. Sema prevents
1248 // us from jumping into any of these scopes anyway.
1249 if (!HaveInsertPoint()) return;
1250
John McCall57b3b6a2011-02-22 07:16:58 +00001251 const VarDecl &D = *emission.Variable;
John McCall34695852011-02-22 06:44:22 +00001252
Nadav Rotem495cfa42013-03-23 06:43:35 +00001253 // Make sure we call @llvm.lifetime.end. This needs to happen
1254 // *last*, so the cleanup needs to be pushed *first*.
1255 if (emission.useLifetimeMarkers()) {
1256 EHStack.pushCleanup<CallLifetimeEnd>(NormalCleanup,
1257 emission.getAllocatedAddress(),
1258 emission.getSizeForLifetimeMarkers());
1259 }
1260
John McCallbdc4d802011-07-09 01:37:26 +00001261 // Check the type for a cleanup.
1262 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1263 emitAutoVarTypeCleanup(emission, dtorKind);
John McCallf85e1932011-06-15 23:02:42 +00001264
John McCall0c24c802011-06-24 23:21:27 +00001265 // In GC mode, honor objc_precise_lifetime.
David Blaikie4e4d0842012-03-11 07:00:24 +00001266 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall0c24c802011-06-24 23:21:27 +00001267 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1268 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1269 }
1270
John McCall34695852011-02-22 06:44:22 +00001271 // Handle the cleanup attribute.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +00001272 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlsson69c68b72009-02-07 23:51:38 +00001273 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump1eb44332009-09-09 15:08:12 +00001274
John McCall34695852011-02-22 06:44:22 +00001275 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001276 assert(F && "Could not find function!");
Mike Stump1eb44332009-09-09 15:08:12 +00001277
John McCallde5d3c72012-02-17 03:33:10 +00001278 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCall34695852011-02-22 06:44:22 +00001279 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlsson69c68b72009-02-07 23:51:38 +00001280 }
Mike Stump797b6322009-03-05 01:23:13 +00001281
John McCall34695852011-02-22 06:44:22 +00001282 // If this is a block variable, call _Block_object_destroy
1283 // (on the unforwarded address).
John McCall5af02db2011-03-31 01:59:53 +00001284 if (emission.IsByRef)
1285 enterByrefCleanup(emission);
Reid Spencer5f016e22007-07-11 17:01:13 +00001286}
1287
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001288CodeGenFunction::Destroyer *
John McCallbdc4d802011-07-09 01:37:26 +00001289CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
1290 switch (kind) {
1291 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCall0850e8d2011-07-09 09:09:00 +00001292 case QualType::DK_cxx_destructor:
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001293 return destroyCXXObject;
John McCall0850e8d2011-07-09 09:09:00 +00001294 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001295 return destroyARCStrongPrecise;
John McCall0850e8d2011-07-09 09:09:00 +00001296 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001297 return destroyARCWeak;
John McCallbdc4d802011-07-09 01:37:26 +00001298 }
Matt Beaumont-Gayba4be252012-01-27 00:46:27 +00001299 llvm_unreachable("Unknown DestructionKind");
John McCallbdc4d802011-07-09 01:37:26 +00001300}
1301
John McCall074cae02013-02-01 05:11:40 +00001302/// pushEHDestroy - Push the standard destructor for the given type as
1303/// an EH-only cleanup.
1304void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
1305 llvm::Value *addr, QualType type) {
1306 assert(dtorKind && "cannot push destructor for trivial type");
1307 assert(needsEHCleanup(dtorKind));
1308
1309 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
1310}
1311
1312/// pushDestroy - Push the standard destructor for the given type as
1313/// at least a normal cleanup.
John McCall9928c482011-07-12 16:41:08 +00001314void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
1315 llvm::Value *addr, QualType type) {
1316 assert(dtorKind && "cannot push destructor for trivial type");
1317
1318 CleanupKind cleanupKind = getCleanupKind(dtorKind);
1319 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
1320 cleanupKind & EHCleanup);
1321}
1322
John McCallbdc4d802011-07-09 01:37:26 +00001323void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, llvm::Value *addr,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001324 QualType type, Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001325 bool useEHCleanupForArray) {
John McCall9928c482011-07-12 16:41:08 +00001326 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
1327 destroyer, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001328}
1329
John McCall2673c682011-07-11 08:38:19 +00001330/// emitDestroy - Immediately perform the destruction of the given
1331/// object.
1332///
1333/// \param addr - the address of the object; a type*
1334/// \param type - the type of the object; if an array type, all
1335/// objects are destroyed in reverse order
1336/// \param destroyer - the function to call to destroy individual
1337/// elements
1338/// \param useEHCleanupForArray - whether an EH cleanup should be
1339/// used when destroying array elements, in case one of the
1340/// destructions throws an exception
John McCallbdc4d802011-07-09 01:37:26 +00001341void CodeGenFunction::emitDestroy(llvm::Value *addr, QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001342 Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001343 bool useEHCleanupForArray) {
John McCallbdc4d802011-07-09 01:37:26 +00001344 const ArrayType *arrayType = getContext().getAsArrayType(type);
1345 if (!arrayType)
1346 return destroyer(*this, addr, type);
1347
1348 llvm::Value *begin = addr;
1349 llvm::Value *length = emitArrayLength(arrayType, type, begin);
John McCallfbf780a2011-07-13 08:09:46 +00001350
1351 // Normally we have to check whether the array is zero-length.
1352 bool checkZeroLength = true;
1353
1354 // But if the array length is constant, we can suppress that.
1355 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
1356 // ...and if it's constant zero, we can just skip the entire thing.
1357 if (constLength->isZero()) return;
1358 checkZeroLength = false;
1359 }
1360
John McCallbdc4d802011-07-09 01:37:26 +00001361 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCallfbf780a2011-07-13 08:09:46 +00001362 emitArrayDestroy(begin, end, type, destroyer,
1363 checkZeroLength, useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001364}
1365
John McCall2673c682011-07-11 08:38:19 +00001366/// emitArrayDestroy - Destroys all the elements of the given array,
1367/// beginning from last to first. The array cannot be zero-length.
1368///
1369/// \param begin - a type* denoting the first element of the array
1370/// \param end - a type* denoting one past the end of the array
1371/// \param type - the element type of the array
1372/// \param destroyer - the function to call to destroy elements
1373/// \param useEHCleanup - whether to push an EH cleanup to destroy
1374/// the remaining elements in case the destruction of a single
1375/// element throws
John McCallbdc4d802011-07-09 01:37:26 +00001376void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
1377 llvm::Value *end,
1378 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001379 Destroyer *destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001380 bool checkZeroLength,
John McCall2673c682011-07-11 08:38:19 +00001381 bool useEHCleanup) {
John McCallbdc4d802011-07-09 01:37:26 +00001382 assert(!type->isArrayType());
1383
1384 // The basic structure here is a do-while loop, because we don't
1385 // need to check for the zero-element case.
1386 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
1387 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
1388
John McCallfbf780a2011-07-13 08:09:46 +00001389 if (checkZeroLength) {
1390 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
1391 "arraydestroy.isempty");
1392 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
1393 }
1394
John McCallbdc4d802011-07-09 01:37:26 +00001395 // Enter the loop body, making that address the current address.
1396 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1397 EmitBlock(bodyBB);
1398 llvm::PHINode *elementPast =
1399 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
1400 elementPast->addIncoming(end, entryBB);
1401
1402 // Shift the address back by one element.
1403 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
1404 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
1405 "arraydestroy.element");
1406
John McCall2673c682011-07-11 08:38:19 +00001407 if (useEHCleanup)
1408 pushRegularPartialArrayCleanup(begin, element, type, destroyer);
1409
John McCallbdc4d802011-07-09 01:37:26 +00001410 // Perform the actual destruction there.
1411 destroyer(*this, element, type);
1412
John McCall2673c682011-07-11 08:38:19 +00001413 if (useEHCleanup)
1414 PopCleanupBlock();
1415
John McCallbdc4d802011-07-09 01:37:26 +00001416 // Check whether we've reached the end.
1417 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
1418 Builder.CreateCondBr(done, doneBB, bodyBB);
1419 elementPast->addIncoming(element, Builder.GetInsertBlock());
1420
1421 // Done.
1422 EmitBlock(doneBB);
1423}
1424
John McCall2673c682011-07-11 08:38:19 +00001425/// Perform partial array destruction as if in an EH cleanup. Unlike
1426/// emitArrayDestroy, the element type here may still be an array type.
John McCall2673c682011-07-11 08:38:19 +00001427static void emitPartialArrayDestroy(CodeGenFunction &CGF,
1428 llvm::Value *begin, llvm::Value *end,
1429 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001430 CodeGenFunction::Destroyer *destroyer) {
John McCall2673c682011-07-11 08:38:19 +00001431 // If the element type is itself an array, drill down.
John McCallfbf780a2011-07-13 08:09:46 +00001432 unsigned arrayDepth = 0;
John McCall2673c682011-07-11 08:38:19 +00001433 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
1434 // VLAs don't require a GEP index to walk into.
1435 if (!isa<VariableArrayType>(arrayType))
John McCallfbf780a2011-07-13 08:09:46 +00001436 arrayDepth++;
John McCall2673c682011-07-11 08:38:19 +00001437 type = arrayType->getElementType();
1438 }
John McCallfbf780a2011-07-13 08:09:46 +00001439
1440 if (arrayDepth) {
1441 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, arrayDepth+1);
1442
Chris Lattner5f9e2722011-07-23 10:55:15 +00001443 SmallVector<llvm::Value*,4> gepIndices(arrayDepth, zero);
Jay Foad0f6ac7c2011-07-22 08:16:57 +00001444 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
1445 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall2673c682011-07-11 08:38:19 +00001446 }
1447
John McCallfbf780a2011-07-13 08:09:46 +00001448 // Destroy the array. We don't ever need an EH cleanup because we
1449 // assume that we're in an EH cleanup ourselves, so a throwing
1450 // destructor causes an immediate terminate.
1451 CGF.emitArrayDestroy(begin, end, type, destroyer,
1452 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall2673c682011-07-11 08:38:19 +00001453}
1454
John McCallbdc4d802011-07-09 01:37:26 +00001455namespace {
John McCall2673c682011-07-11 08:38:19 +00001456 /// RegularPartialArrayDestroy - a cleanup which performs a partial
1457 /// array destroy where the end pointer is regularly determined and
1458 /// does not need to be loaded from a local.
1459 class RegularPartialArrayDestroy : public EHScopeStack::Cleanup {
1460 llvm::Value *ArrayBegin;
1461 llvm::Value *ArrayEnd;
1462 QualType ElementType;
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001463 CodeGenFunction::Destroyer *Destroyer;
John McCall2673c682011-07-11 08:38:19 +00001464 public:
1465 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
1466 QualType elementType,
1467 CodeGenFunction::Destroyer *destroyer)
1468 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001469 ElementType(elementType), Destroyer(destroyer) {}
John McCall2673c682011-07-11 08:38:19 +00001470
John McCallad346f42011-07-12 20:27:29 +00001471 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall2673c682011-07-11 08:38:19 +00001472 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
1473 ElementType, Destroyer);
1474 }
1475 };
1476
1477 /// IrregularPartialArrayDestroy - a cleanup which performs a
1478 /// partial array destroy where the end pointer is irregularly
1479 /// determined and must be loaded from a local.
1480 class IrregularPartialArrayDestroy : public EHScopeStack::Cleanup {
John McCallbdc4d802011-07-09 01:37:26 +00001481 llvm::Value *ArrayBegin;
1482 llvm::Value *ArrayEndPointer;
1483 QualType ElementType;
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001484 CodeGenFunction::Destroyer *Destroyer;
John McCallbdc4d802011-07-09 01:37:26 +00001485 public:
John McCall2673c682011-07-11 08:38:19 +00001486 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
1487 llvm::Value *arrayEndPointer,
1488 QualType elementType,
1489 CodeGenFunction::Destroyer *destroyer)
John McCallbdc4d802011-07-09 01:37:26 +00001490 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001491 ElementType(elementType), Destroyer(destroyer) {}
John McCallbdc4d802011-07-09 01:37:26 +00001492
John McCallad346f42011-07-12 20:27:29 +00001493 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallbdc4d802011-07-09 01:37:26 +00001494 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall2673c682011-07-11 08:38:19 +00001495 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
1496 ElementType, Destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001497 }
1498 };
1499}
1500
John McCall2673c682011-07-11 08:38:19 +00001501/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCallbdc4d802011-07-09 01:37:26 +00001502/// already-constructed elements of the given array. The cleanup
John McCall2673c682011-07-11 08:38:19 +00001503/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christophere1f54902011-08-23 22:38:00 +00001504///
John McCallbdc4d802011-07-09 01:37:26 +00001505/// \param elementType - the immediate element type of the array;
1506/// possibly still an array type
John McCall9928c482011-07-12 16:41:08 +00001507void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall2673c682011-07-11 08:38:19 +00001508 llvm::Value *arrayEndPointer,
1509 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001510 Destroyer *destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001511 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
1512 arrayBegin, arrayEndPointer,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001513 elementType, destroyer);
John McCall2673c682011-07-11 08:38:19 +00001514}
1515
1516/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
1517/// already-constructed elements of the given array. The cleanup
1518/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christophere1f54902011-08-23 22:38:00 +00001519///
John McCall2673c682011-07-11 08:38:19 +00001520/// \param elementType - the immediate element type of the array;
1521/// possibly still an array type
John McCall2673c682011-07-11 08:38:19 +00001522void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1523 llvm::Value *arrayEnd,
1524 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001525 Destroyer *destroyer) {
John McCall9928c482011-07-12 16:41:08 +00001526 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall2673c682011-07-11 08:38:19 +00001527 arrayBegin, arrayEnd,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001528 elementType, destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001529}
1530
Nadav Rotem495cfa42013-03-23 06:43:35 +00001531/// Lazily declare the @llvm.lifetime.start intrinsic.
1532llvm::Constant *CodeGenModule::getLLVMLifetimeStartFn() {
1533 if (LifetimeStartFn) return LifetimeStartFn;
1534 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
1535 llvm::Intrinsic::lifetime_start);
1536 return LifetimeStartFn;
1537}
1538
1539/// Lazily declare the @llvm.lifetime.end intrinsic.
1540llvm::Constant *CodeGenModule::getLLVMLifetimeEndFn() {
1541 if (LifetimeEndFn) return LifetimeEndFn;
1542 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
1543 llvm::Intrinsic::lifetime_end);
1544 return LifetimeEndFn;
1545}
1546
John McCallf85e1932011-06-15 23:02:42 +00001547namespace {
1548 /// A cleanup to perform a release of an object at the end of a
1549 /// function. This is used to balance out the incoming +1 of a
1550 /// ns_consumed argument when we can't reasonably do that just by
1551 /// not doing the initial retain for a __block argument.
1552 struct ConsumeARCParameter : EHScopeStack::Cleanup {
John McCall5b07e802013-03-13 03:10:54 +00001553 ConsumeARCParameter(llvm::Value *param,
1554 ARCPreciseLifetime_t precise)
1555 : Param(param), Precise(precise) {}
John McCallf85e1932011-06-15 23:02:42 +00001556
1557 llvm::Value *Param;
John McCall5b07e802013-03-13 03:10:54 +00001558 ARCPreciseLifetime_t Precise;
John McCallf85e1932011-06-15 23:02:42 +00001559
John McCallad346f42011-07-12 20:27:29 +00001560 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall5b07e802013-03-13 03:10:54 +00001561 CGF.EmitARCRelease(Param, Precise);
John McCallf85e1932011-06-15 23:02:42 +00001562 }
1563 };
1564}
1565
Mike Stump1eb44332009-09-09 15:08:12 +00001566/// Emit an alloca (or GlobalValue depending on target)
Chris Lattner2621fd12008-05-08 05:58:21 +00001567/// for the specified parameter and set up LocalDeclMap.
Devang Patel093ac462011-03-03 20:13:15 +00001568void CodeGenFunction::EmitParmDecl(const VarDecl &D, llvm::Value *Arg,
1569 unsigned ArgNo) {
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001570 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +00001571 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001572 "Invalid argument to EmitParmDecl");
John McCall8178df32011-02-22 22:38:33 +00001573
1574 Arg->setName(D.getName());
1575
Adrian Prantl836e7c92013-03-14 17:53:33 +00001576 QualType Ty = D.getType();
1577
John McCall8178df32011-02-22 22:38:33 +00001578 // Use better IR generation for certain implicit parameters.
1579 if (isa<ImplicitParamDecl>(D)) {
1580 // The only implicit argument a block has is its literal.
1581 if (BlockInfo) {
1582 LocalDeclMap[&D] = Arg;
Adrian Prantl836e7c92013-03-14 17:53:33 +00001583 llvm::Value *LocalAddr = 0;
1584 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
Adrian Prantl9b97adf2013-03-29 19:20:35 +00001585 // Allocate a stack slot to let the debug info survive the RA.
Adrian Prantl836e7c92013-03-14 17:53:33 +00001586 llvm::AllocaInst *Alloc = CreateTempAlloca(ConvertTypeForMem(Ty),
1587 D.getName() + ".addr");
1588 Alloc->setAlignment(getContext().getDeclAlign(&D).getQuantity());
1589 LValue lv = MakeAddrLValue(Alloc, Ty, getContext().getDeclAlign(&D));
1590 EmitStoreOfScalar(Arg, lv, /* isInitialization */ true);
1591 LocalAddr = Builder.CreateLoad(Alloc);
1592 }
John McCall8178df32011-02-22 22:38:33 +00001593
1594 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregor4cdad312012-10-23 20:05:01 +00001595 if (CGM.getCodeGenOpts().getDebugInfo()
1596 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001597 DI->setLocation(D.getLocation());
Adrian Prantl836e7c92013-03-14 17:53:33 +00001598 DI->EmitDeclareOfBlockLiteralArgVariable(*BlockInfo, Arg, LocalAddr, Builder);
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001599 }
John McCall8178df32011-02-22 22:38:33 +00001600 }
1601
1602 return;
1603 }
1604 }
1605
Reid Spencer5f016e22007-07-11 17:01:13 +00001606 llvm::Value *DeclPtr;
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001607 // If this is an aggregate or variable sized value, reuse the input pointer.
1608 if (!Ty->isConstantSizeType() ||
John McCall9d232c82013-03-07 21:37:08 +00001609 !CodeGenFunction::hasScalarEvaluationKind(Ty)) {
Reid Spencer5f016e22007-07-11 17:01:13 +00001610 DeclPtr = Arg;
Reid Spencer5f016e22007-07-11 17:01:13 +00001611 } else {
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001612 // Otherwise, create a temporary to hold the value.
Eli Friedmanddfb8d12011-11-03 20:31:28 +00001613 llvm::AllocaInst *Alloc = CreateTempAlloca(ConvertTypeForMem(Ty),
1614 D.getName() + ".addr");
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001615 CharUnits Align = getContext().getDeclAlign(&D);
1616 Alloc->setAlignment(Align.getQuantity());
Eli Friedmanddfb8d12011-11-03 20:31:28 +00001617 DeclPtr = Alloc;
Mike Stump1eb44332009-09-09 15:08:12 +00001618
John McCallf85e1932011-06-15 23:02:42 +00001619 bool doStore = true;
1620
1621 Qualifiers qs = Ty.getQualifiers();
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001622 LValue lv = MakeAddrLValue(DeclPtr, Ty, Align);
John McCallf85e1932011-06-15 23:02:42 +00001623 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
1624 // We honor __attribute__((ns_consumed)) for types with lifetime.
1625 // For __strong, it's handled by just skipping the initial retain;
1626 // otherwise we have to balance out the initial +1 with an extra
1627 // cleanup to do the release at the end of the function.
1628 bool isConsumed = D.hasAttr<NSConsumedAttr>();
1629
1630 // 'self' is always formally __strong, but if this is not an
1631 // init method then we don't want to retain it.
John McCall7acddac2011-06-17 06:42:21 +00001632 if (D.isARCPseudoStrong()) {
John McCallf85e1932011-06-15 23:02:42 +00001633 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl);
1634 assert(&D == method->getSelfDecl());
John McCall7acddac2011-06-17 06:42:21 +00001635 assert(lt == Qualifiers::OCL_Strong);
1636 assert(qs.hasConst());
John McCallf85e1932011-06-15 23:02:42 +00001637 assert(method->getMethodFamily() != OMF_init);
John McCall175d6592011-06-15 23:40:09 +00001638 (void) method;
John McCallf85e1932011-06-15 23:02:42 +00001639 lt = Qualifiers::OCL_ExplicitNone;
1640 }
1641
1642 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001643 if (!isConsumed) {
1644 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1645 // use objc_storeStrong(&dest, value) for retaining the
1646 // object. But first, store a null into 'dest' because
1647 // objc_storeStrong attempts to release its old value.
1648 llvm::Value * Null = CGM.EmitNullConstant(D.getType());
1649 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
1650 EmitARCStoreStrongCall(lv.getAddress(), Arg, true);
1651 doStore = false;
1652 }
1653 else
John McCallf85e1932011-06-15 23:02:42 +00001654 // Don't use objc_retainBlock for block pointers, because we
1655 // don't want to Block_copy something just because we got it
1656 // as a parameter.
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001657 Arg = EmitARCRetainNonBlock(Arg);
1658 }
John McCallf85e1932011-06-15 23:02:42 +00001659 } else {
1660 // Push the cleanup for a consumed parameter.
John McCall5b07e802013-03-13 03:10:54 +00001661 if (isConsumed) {
1662 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
1663 ? ARCPreciseLifetime : ARCImpreciseLifetime);
1664 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), Arg,
1665 precise);
1666 }
John McCallf85e1932011-06-15 23:02:42 +00001667
1668 if (lt == Qualifiers::OCL_Weak) {
1669 EmitARCInitWeak(DeclPtr, Arg);
Chad Rosier7acebfb2012-02-18 01:20:35 +00001670 doStore = false; // The weak init is a store, no need to do two.
John McCallf85e1932011-06-15 23:02:42 +00001671 }
1672 }
1673
1674 // Enter the cleanup scope.
1675 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
1676 }
1677
Daniel Dunbare86bcf02010-02-08 22:53:07 +00001678 // Store the initial value into the alloca.
Fariborz Jahanian41a6a3e2013-02-21 00:40:10 +00001679 if (doStore)
David Chisnall7a7ee302012-01-16 17:27:18 +00001680 EmitStoreOfScalar(Arg, lv, /* isInitialization */ true);
Reid Spencer5f016e22007-07-11 17:01:13 +00001681 }
1682
1683 llvm::Value *&DMEntry = LocalDeclMap[&D];
1684 assert(DMEntry == 0 && "Decl already exists in localdeclmap!");
1685 DMEntry = DeclPtr;
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00001686
1687 // Emit debug info for param declaration.
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001688 if (CGDebugInfo *DI = getDebugInfo()) {
Douglas Gregor4cdad312012-10-23 20:05:01 +00001689 if (CGM.getCodeGenOpts().getDebugInfo()
1690 >= CodeGenOptions::LimitedDebugInfo) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001691 DI->EmitDeclareOfArgVariable(&D, DeclPtr, ArgNo, Builder);
1692 }
1693 }
Julien Lerouge77f68bb2011-09-09 22:41:49 +00001694
1695 if (D.hasAttr<AnnotateAttr>())
1696 EmitVarAnnotations(&D, DeclPtr);
Reid Spencer5f016e22007-07-11 17:01:13 +00001697}