blob: 508720f5b9a04f15405d2aa6e3dd8c1c8ae96ec9 [file] [log] [blame]
Chris Lattner84915fa2007-06-02 04:16:21 +00001//===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner84915fa2007-06-02 04:16:21 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Decl nodes as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
John McCall7f416cc2015-09-08 08:05:57 +000015#include "CGBlocks.h"
David Majnemerdc012fa2015-04-22 21:38:15 +000016#include "CGCleanup.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGDebugInfo.h"
Peter Collingbourne2dbb7082011-09-19 21:14:35 +000018#include "CGOpenCLRuntime.h"
Alexey Bataevc5b1d322016-03-04 09:22:22 +000019#include "CGOpenMPRuntime.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "CodeGenModule.h"
Daniel Dunbarad319a72008-08-11 05:00:27 +000021#include "clang/AST/ASTContext.h"
Ken Dyck8c89d592009-12-22 14:23:30 +000022#include "clang/AST/CharUnits.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000023#include "clang/AST/Decl.h"
Anders Carlsson4c03d982008-08-25 01:38:19 +000024#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000025#include "clang/AST/DeclOpenMP.h"
Nate Begemanfaae0812008-04-19 04:17:09 +000026#include "clang/Basic/SourceManager.h"
Chris Lattnerb781dc792008-05-08 05:58:21 +000027#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000028#include "clang/CodeGen/CGFunctionInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000029#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000030#include "llvm/IR/DataLayout.h"
31#include "llvm/IR/GlobalVariable.h"
32#include "llvm/IR/Intrinsics.h"
33#include "llvm/IR/Type.h"
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +000034
Chris Lattner84915fa2007-06-02 04:16:21 +000035using namespace clang;
36using namespace CodeGen;
37
Chris Lattner1ad38f82007-06-09 01:20:56 +000038void CodeGenFunction::EmitDecl(const Decl &D) {
Chris Lattner1ad38f82007-06-09 01:20:56 +000039 switch (D.getKind()) {
David Majnemerd9b1a4f2015-11-04 03:40:30 +000040 case Decl::BuiltinTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000041 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +000042 case Decl::ExternCContext:
Douglas Gregor19043f02010-04-23 02:02:43 +000043 case Decl::Namespace:
44 case Decl::UnresolvedUsingTypename:
45 case Decl::ClassTemplateSpecialization:
46 case Decl::ClassTemplatePartialSpecialization:
Larisse Voufo39a1e502013-08-06 01:03:05 +000047 case Decl::VarTemplateSpecialization:
48 case Decl::VarTemplatePartialSpecialization:
Douglas Gregor19043f02010-04-23 02:02:43 +000049 case Decl::TemplateTypeParm:
50 case Decl::UnresolvedUsingValue:
Alexis Hunted053252010-05-30 07:21:58 +000051 case Decl::NonTypeTemplateParm:
Douglas Gregor19043f02010-04-23 02:02:43 +000052 case Decl::CXXMethod:
53 case Decl::CXXConstructor:
54 case Decl::CXXDestructor:
55 case Decl::CXXConversion:
56 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +000057 case Decl::MSProperty:
Francois Pichetdf946c32010-11-21 06:49:41 +000058 case Decl::IndirectField:
Douglas Gregor19043f02010-04-23 02:02:43 +000059 case Decl::ObjCIvar:
Eric Christopher31ab1302011-08-23 22:38:00 +000060 case Decl::ObjCAtDefsField:
Chris Lattnerba9dddb2007-10-08 21:37:32 +000061 case Decl::ParmVar:
Douglas Gregor19043f02010-04-23 02:02:43 +000062 case Decl::ImplicitParam:
63 case Decl::ClassTemplate:
Larisse Voufo39a1e502013-08-06 01:03:05 +000064 case Decl::VarTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000065 case Decl::FunctionTemplate:
Richard Smith3f1b5d02011-05-05 21:57:07 +000066 case Decl::TypeAliasTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000067 case Decl::TemplateTemplateParm:
68 case Decl::ObjCMethod:
69 case Decl::ObjCCategory:
70 case Decl::ObjCProtocol:
71 case Decl::ObjCInterface:
72 case Decl::ObjCCategoryImpl:
73 case Decl::ObjCImplementation:
74 case Decl::ObjCProperty:
75 case Decl::ObjCCompatibleAlias:
Nico Weber66220292016-03-02 17:28:48 +000076 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +000077 case Decl::PragmaDetectMismatch:
Abramo Bagnarad7340582010-06-05 05:09:32 +000078 case Decl::AccessSpec:
Douglas Gregor19043f02010-04-23 02:02:43 +000079 case Decl::LinkageSpec:
80 case Decl::ObjCPropertyImpl:
Douglas Gregor19043f02010-04-23 02:02:43 +000081 case Decl::FileScopeAsm:
82 case Decl::Friend:
83 case Decl::FriendTemplate:
84 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +000085 case Decl::Captured:
Francois Pichet00c7e6c2011-08-14 03:52:19 +000086 case Decl::ClassScopeFunctionSpecialization:
David Blaikiebd483762013-05-20 04:58:53 +000087 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +000088 case Decl::ConstructorUsingShadow:
Douglas Gregor85f3f952015-07-07 03:57:15 +000089 case Decl::ObjCTypeParam:
David Blaikie83d382b2011-09-23 05:06:16 +000090 llvm_unreachable("Declaration should not be in declstmts!");
Amjad Abouddc4531e2016-04-30 01:44:38 +000091 case Decl::Function: // void X();
92 case Decl::Record: // struct/union/class X;
93 case Decl::Enum: // enum X;
94 case Decl::EnumConstant: // enum ? { X = ? }
95 case Decl::CXXRecord: // struct/union/class X; [C++]
Anders Carlssonce2cd012009-12-03 17:26:31 +000096 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner43e7f312011-02-18 02:08:43 +000097 case Decl::Label: // __label__ x;
Douglas Gregorba345522011-12-02 23:23:56 +000098 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +000099 case Decl::OMPThreadPrivate:
Alexey Bataev4244be22016-02-11 05:35:55 +0000100 case Decl::OMPCapturedExpr:
Michael Han84324352013-02-22 17:15:32 +0000101 case Decl::Empty:
Chris Lattner84915fa2007-06-02 04:16:21 +0000102 // None of these decls require codegen support.
103 return;
David Blaikieb7d1e1f2013-02-02 00:39:32 +0000104
David Blaikief121b932013-05-20 22:50:41 +0000105 case Decl::NamespaceAlias:
106 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000107 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
David Blaikief121b932013-05-20 22:50:41 +0000108 return;
David Blaikiebd483762013-05-20 04:58:53 +0000109 case Decl::Using: // using X; [C++]
110 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000111 DI->EmitUsingDecl(cast<UsingDecl>(D));
David Blaikiebd483762013-05-20 04:58:53 +0000112 return;
David Blaikie9f88fe82013-04-22 06:13:21 +0000113 case Decl::UsingDirective: // using namespace X; [C++]
114 if (CGDebugInfo *DI = getDebugInfo())
115 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
116 return;
Daniel Dunbara7998072008-08-29 17:28:43 +0000117 case Decl::Var: {
118 const VarDecl &VD = cast<VarDecl>(D);
John McCall1c9c3fd2010-10-15 04:57:14 +0000119 assert(VD.isLocalVarDecl() &&
Daniel Dunbara7998072008-08-29 17:28:43 +0000120 "Should not see file-scope variables inside a function!");
John McCall1c9c3fd2010-10-15 04:57:14 +0000121 return EmitVarDecl(VD);
Chris Lattner84915fa2007-06-02 04:16:21 +0000122 }
Mike Stump11289f42009-09-09 15:08:12 +0000123
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000124 case Decl::OMPDeclareReduction:
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000125 return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this);
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000126
Richard Smithdda56e42011-04-15 14:24:37 +0000127 case Decl::Typedef: // typedef int X;
128 case Decl::TypeAlias: { // using X = int; [C++0x]
129 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000130 QualType Ty = TD.getUnderlyingType();
Mike Stump11289f42009-09-09 15:08:12 +0000131
Anders Carlsson5d985f52008-12-20 21:51:53 +0000132 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000133 EmitVariablyModifiedType(Ty);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000134 }
Daniel Dunbara7998072008-08-29 17:28:43 +0000135 }
Chris Lattner84915fa2007-06-02 04:16:21 +0000136}
Chris Lattner03df1222007-06-02 04:53:11 +0000137
John McCall1c9c3fd2010-10-15 04:57:14 +0000138/// EmitVarDecl - This method handles emission of any variable declaration
Chris Lattner03df1222007-06-02 04:53:11 +0000139/// inside a function, including static vars etc.
John McCall1c9c3fd2010-10-15 04:57:14 +0000140void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000141 if (D.isStaticLocal()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000142 llvm::GlobalValue::LinkageTypes Linkage =
David Majnemer27d69db2014-04-28 22:17:59 +0000143 CGM.getLLVMLinkageVarDefinition(&D, /*isConstant=*/false);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000144
David Majnemer27d69db2014-04-28 22:17:59 +0000145 // FIXME: We need to force the emission/use of a guard variable for
146 // some variables even if we can constant-evaluate them because
147 // we can't guarantee every translation unit will constant-evaluate them.
Eric Christopher31ab1302011-08-23 22:38:00 +0000148
John McCall1c9c3fd2010-10-15 04:57:14 +0000149 return EmitStaticVarDecl(D, Linkage);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000150 }
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000151
152 if (D.hasExternalStorage())
Lauro Ramos Venanciobada8d42008-02-16 22:30:38 +0000153 // Don't emit it now, allow it to be emitted lazily on its first use.
154 return;
Daniel Dunbar0ca16602009-04-14 02:25:56 +0000155
Anastasia Stulovabcea6962015-09-30 14:08:20 +0000156 if (D.getType().getAddressSpace() == LangAS::opencl_local)
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000157 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
158
159 assert(D.hasLocalStorage());
160 return EmitAutoVarDecl(D);
Chris Lattner03df1222007-06-02 04:53:11 +0000161}
162
Reid Kleckner453e0562014-10-08 01:07:54 +0000163static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) {
164 if (CGM.getLangOpts().CPlusPlus)
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000165 return CGM.getMangledName(&D).str();
166
Reid Kleckner453e0562014-10-08 01:07:54 +0000167 // If this isn't C++, we don't need a mangled name, just a pretty one.
168 assert(!D.isExternallyVisible() && "name shouldn't matter");
169 std::string ContextName;
170 const DeclContext *DC = D.getDeclContext();
Alexey Bataev43f74392015-05-07 06:28:46 +0000171 if (auto *CD = dyn_cast<CapturedDecl>(DC))
172 DC = cast<DeclContext>(CD->getNonClosureContext());
Reid Kleckner453e0562014-10-08 01:07:54 +0000173 if (const auto *FD = dyn_cast<FunctionDecl>(DC))
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000174 ContextName = CGM.getMangledName(FD);
Reid Kleckner453e0562014-10-08 01:07:54 +0000175 else if (const auto *BD = dyn_cast<BlockDecl>(DC))
176 ContextName = CGM.getBlockMangledName(GlobalDecl(), BD);
177 else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC))
178 ContextName = OMD->getSelector().getAsString();
Chris Lattnere99c1102009-12-05 08:22:11 +0000179 else
David Blaikie83d382b2011-09-23 05:06:16 +0000180 llvm_unreachable("Unknown context for static var decl");
Eric Christopher31ab1302011-08-23 22:38:00 +0000181
Reid Kleckner453e0562014-10-08 01:07:54 +0000182 ContextName += "." + D.getNameAsString();
183 return ContextName;
Chris Lattnere99c1102009-12-05 08:22:11 +0000184}
185
Reid Kleckner453e0562014-10-08 01:07:54 +0000186llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl(
187 const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) {
188 // In general, we don't always emit static var decls once before we reference
189 // them. It is possible to reference them before emitting the function that
190 // contains them, and it is possible to emit the containing function multiple
191 // times.
192 if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D])
193 return ExistingGV;
194
Chris Lattnerfc4379f2008-04-06 23:10:54 +0000195 QualType Ty = D.getType();
Eli Friedmana682d392008-02-15 12:20:59 +0000196 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begemanfaae0812008-04-19 04:17:09 +0000197
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000198 // Use the label if the variable is renamed with the asm-label extension.
199 std::string Name;
Benjamin Kramer5642e192011-11-21 15:47:23 +0000200 if (D.hasAttr<AsmLabelAttr>())
Reid Kleckner453e0562014-10-08 01:07:54 +0000201 Name = getMangledName(&D);
Benjamin Kramer5642e192011-11-21 15:47:23 +0000202 else
Reid Kleckner453e0562014-10-08 01:07:54 +0000203 Name = getStaticDeclName(*this, D);
Nate Begemanfaae0812008-04-19 04:17:09 +0000204
Reid Kleckner453e0562014-10-08 01:07:54 +0000205 llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty);
Peter Collingbourneee0502d2012-08-28 20:37:10 +0000206 unsigned AddrSpace =
Reid Kleckner453e0562014-10-08 01:07:54 +0000207 GetGlobalVarAddressSpace(&D, getContext().getTargetAddressSpace(Ty));
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000208
209 // Local address space cannot have an initializer.
210 llvm::Constant *Init = nullptr;
211 if (Ty.getAddressSpace() != LangAS::opencl_local)
212 Init = EmitNullConstant(Ty);
213 else
214 Init = llvm::UndefValue::get(LTy);
215
Anders Carlssone33eed52009-09-26 18:16:06 +0000216 llvm::GlobalVariable *GV =
Reid Kleckner453e0562014-10-08 01:07:54 +0000217 new llvm::GlobalVariable(getModule(), LTy,
Anders Carlssone33eed52009-09-26 18:16:06 +0000218 Ty.isConstant(getContext()), Linkage,
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000219 Init, Name, nullptr,
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000220 llvm::GlobalVariable::NotThreadLocal,
Peter Collingbourneee0502d2012-08-28 20:37:10 +0000221 AddrSpace);
Ken Dyck160146e2010-01-27 17:10:57 +0000222 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Reid Kleckner453e0562014-10-08 01:07:54 +0000223 setGlobalVisibility(GV, &D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000224
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +0000225 if (supportsCOMDAT() && GV->isWeakForLinker())
226 GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000227
Richard Smithfd3834f2013-04-13 02:43:54 +0000228 if (D.getTLSKind())
Reid Kleckner453e0562014-10-08 01:07:54 +0000229 setTLSMode(GV, D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000230
Hans Wennborgef2272c2014-06-18 15:55:13 +0000231 if (D.isExternallyVisible()) {
232 if (D.hasAttr<DLLImportAttr>())
233 GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
234 else if (D.hasAttr<DLLExportAttr>())
235 GV->setDLLStorageClass(llvm::GlobalVariable::DLLExportStorageClass);
236 }
237
Eli Benderskycb399432014-03-24 22:05:38 +0000238 // Make sure the result is of the correct type.
Reid Kleckner453e0562014-10-08 01:07:54 +0000239 unsigned ExpectedAddrSpace = getContext().getTargetAddressSpace(Ty);
240 llvm::Constant *Addr = GV;
Eli Benderskycb399432014-03-24 22:05:38 +0000241 if (AddrSpace != ExpectedAddrSpace) {
242 llvm::PointerType *PTy = llvm::PointerType::get(LTy, ExpectedAddrSpace);
Reid Kleckner453e0562014-10-08 01:07:54 +0000243 Addr = llvm::ConstantExpr::getAddrSpaceCast(GV, PTy);
Eli Benderskycb399432014-03-24 22:05:38 +0000244 }
245
Reid Kleckner453e0562014-10-08 01:07:54 +0000246 setStaticLocalDeclAddress(&D, Addr);
247
248 // Ensure that the static local gets initialized by making sure the parent
249 // function gets emitted eventually.
250 const Decl *DC = cast<Decl>(D.getDeclContext());
251
252 // We can't name blocks or captured statements directly, so try to emit their
253 // parents.
254 if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) {
255 DC = DC->getNonClosureContext();
256 // FIXME: Ensure that global blocks get emitted.
257 if (!DC)
258 return Addr;
259 }
260
261 GlobalDecl GD;
262 if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC))
263 GD = GlobalDecl(CD, Ctor_Base);
264 else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC))
265 GD = GlobalDecl(DD, Dtor_Base);
266 else if (const auto *FD = dyn_cast<FunctionDecl>(DC))
267 GD = GlobalDecl(FD);
268 else {
269 // Don't do anything for Obj-C method decls or global closures. We should
270 // never defer them.
271 assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl");
272 }
273 if (GD.getDecl())
274 (void)GetAddrOfGlobal(GD);
275
276 return Addr;
Daniel Dunbar22a87f92009-02-25 19:24:29 +0000277}
278
Richard Smith6331c402012-02-13 22:16:19 +0000279/// hasNontrivialDestruction - Determine whether a type's destruction is
280/// non-trivial. If so, and the variable uses static initialization, we must
281/// register its destructor to run on exit.
282static bool hasNontrivialDestruction(QualType T) {
283 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
284 return RD && !RD->hasTrivialDestructor();
285}
286
Chandler Carruth84537952012-03-30 19:44:53 +0000287/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
288/// global variable that has already been created for it. If the initializer
289/// has a different type than GV does, this may free GV and return a different
290/// one. Otherwise it just returns GV.
291llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +0000292CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000293 llvm::GlobalVariable *GV) {
294 llvm::Constant *Init = CGM.EmitConstantInit(D, this);
John McCall70013b62010-07-15 23:40:35 +0000295
Chris Lattnere99c1102009-12-05 08:22:11 +0000296 // If constant emission failed, then this should be a C++ static
297 // initializer.
Chandler Carruth84537952012-03-30 19:44:53 +0000298 if (!Init) {
Richard Smith9c6890a2012-11-01 22:30:59 +0000299 if (!getLangOpts().CPlusPlus)
Chris Lattnere99c1102009-12-05 08:22:11 +0000300 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
John McCall68ff0372010-09-08 01:44:27 +0000301 else if (Builder.GetInsertBlock()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000302 // Since we have a static initializer, this global variable can't
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000303 // be constant.
Chandler Carruth84537952012-03-30 19:44:53 +0000304 GV->setConstant(false);
John McCall68ff0372010-09-08 01:44:27 +0000305
Chandler Carruth84537952012-03-30 19:44:53 +0000306 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000307 }
Chandler Carruth84537952012-03-30 19:44:53 +0000308 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000309 }
John McCall70013b62010-07-15 23:40:35 +0000310
Chris Lattnere99c1102009-12-05 08:22:11 +0000311 // The initializer may differ in type from the global. Rewrite
312 // the global to match the initializer. (We have to do this
313 // because some types, like unions, can't be completely represented
314 // in the LLVM type system.)
Chandler Carruth84537952012-03-30 19:44:53 +0000315 if (GV->getType()->getElementType() != Init->getType()) {
316 llvm::GlobalVariable *OldGV = GV;
317
318 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
319 OldGV->isConstant(),
320 OldGV->getLinkage(), Init, "",
321 /*InsertBefore*/ OldGV,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +0000322 OldGV->getThreadLocalMode(),
Chandler Carruth84537952012-03-30 19:44:53 +0000323 CGM.getContext().getTargetAddressSpace(D.getType()));
324 GV->setVisibility(OldGV->getVisibility());
Reid Klecknereab97d32015-07-20 20:35:30 +0000325 GV->setComdat(OldGV->getComdat());
Eric Christopher31ab1302011-08-23 22:38:00 +0000326
Chris Lattnere99c1102009-12-05 08:22:11 +0000327 // Steal the name of the old global
Chandler Carruth84537952012-03-30 19:44:53 +0000328 GV->takeName(OldGV);
Eric Christopher31ab1302011-08-23 22:38:00 +0000329
Chris Lattnere99c1102009-12-05 08:22:11 +0000330 // Replace all uses of the old global with the new global
Chandler Carruth84537952012-03-30 19:44:53 +0000331 llvm::Constant *NewPtrForOldDecl =
332 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
333 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christopher31ab1302011-08-23 22:38:00 +0000334
Chris Lattnere99c1102009-12-05 08:22:11 +0000335 // Erase the old global, since it is no longer used.
Chandler Carruth84537952012-03-30 19:44:53 +0000336 OldGV->eraseFromParent();
Chris Lattnere99c1102009-12-05 08:22:11 +0000337 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000338
Chandler Carruth84537952012-03-30 19:44:53 +0000339 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
340 GV->setInitializer(Init);
Richard Smith6331c402012-02-13 22:16:19 +0000341
342 if (hasNontrivialDestruction(D.getType())) {
343 // We have a constant initializer, but a nontrivial destructor. We still
344 // need to perform a guarded "initialization" in order to register the
Richard Smithe070fd22012-02-17 06:48:11 +0000345 // destructor.
Chandler Carruth84537952012-03-30 19:44:53 +0000346 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith6331c402012-02-13 22:16:19 +0000347 }
348
Chandler Carruth84537952012-03-30 19:44:53 +0000349 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000350}
351
John McCall1c9c3fd2010-10-15 04:57:14 +0000352void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000353 llvm::GlobalValue::LinkageTypes Linkage) {
John McCallb88a5662012-03-30 21:00:39 +0000354 // Check to see if we already have a global variable for this
355 // declaration. This can happen when double-emitting function
356 // bodies, e.g. with complete and base constructors.
Reid Kleckner453e0562014-10-08 01:07:54 +0000357 llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage);
John McCall7f416cc2015-09-08 08:05:57 +0000358 CharUnits alignment = getContext().getDeclAlign(&D);
Daniel Dunbara374e602009-02-25 19:45:19 +0000359
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000360 // Store into LocalDeclMap before generating initializer to handle
361 // circular references.
John McCall7f416cc2015-09-08 08:05:57 +0000362 setAddrOfLocalVar(&D, Address(addr, alignment));
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000363
John McCall4a39ab82010-05-04 20:45:42 +0000364 // We can't have a VLA here, but we can have a pointer to a VLA,
365 // even though that doesn't really make any sense.
Eli Friedmanbc633be2009-04-20 03:54:15 +0000366 // Make sure to evaluate VLA bounds now so that we have them for later.
367 if (D.getType()->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000368 EmitVariablyModifiedType(D.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000369
John McCallb88a5662012-03-30 21:00:39 +0000370 // Save the type in case adding the initializer forces a type change.
371 llvm::Type *expectedType = addr->getType();
Eli Friedmanbc633be2009-04-20 03:54:15 +0000372
Eli Benderskycb399432014-03-24 22:05:38 +0000373 llvm::GlobalVariable *var =
374 cast<llvm::GlobalVariable>(addr->stripPointerCasts());
Artem Belevich4d430ba2016-05-09 22:09:56 +0000375
376 // CUDA's local and local static __shared__ variables should not
377 // have any non-empty initializers. This is ensured by Sema.
378 // Whatever initializer such variable may have when it gets here is
379 // a no-op and should not be emitted.
380 bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
381 D.hasAttr<CUDASharedAttr>();
Chris Lattnere99c1102009-12-05 08:22:11 +0000382 // If this value has an initializer, emit it.
Artem Belevich4d430ba2016-05-09 22:09:56 +0000383 if (D.getInit() && !isCudaSharedVar)
John McCallb88a5662012-03-30 21:00:39 +0000384 var = AddInitializerToStaticVarDecl(D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000385
John McCall7f416cc2015-09-08 08:05:57 +0000386 var->setAlignment(alignment.getQuantity());
Chris Lattner4d941092010-03-10 23:59:59 +0000387
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000388 if (D.hasAttr<AnnotateAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000389 CGM.AddGlobalAnnotations(&D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000390
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000391 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000392 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000393
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000394 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000395 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000396
Chandler Carruth84537952012-03-30 19:44:53 +0000397 // We may have to cast the constant because of the initializer
398 // mismatch above.
399 //
400 // FIXME: It is really dangerous to store this in the map; if anyone
401 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000402 llvm::Constant *castedAddr =
403 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCall7f416cc2015-09-08 08:05:57 +0000404 if (var != castedAddr)
405 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
John McCallb88a5662012-03-30 21:00:39 +0000406 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000407
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000408 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
Alexey Samsonov4f319cc2014-07-02 16:54:41 +0000409
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000410 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000411 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000412 if (DI &&
Benjamin Kramer8c305922016-02-02 11:06:51 +0000413 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000414 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000415 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000416 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000417}
Mike Stump11289f42009-09-09 15:08:12 +0000418
John McCall2b7fc382010-07-13 20:32:21 +0000419namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000420 struct DestroyObject final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000421 DestroyObject(Address addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000422 CodeGenFunction::Destroyer *destroyer,
423 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000424 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000425 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000426
John McCall7f416cc2015-09-08 08:05:57 +0000427 Address addr;
John McCall82fe67b2011-07-09 01:37:26 +0000428 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000429 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000430 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000431
Craig Topper4f12f102014-03-12 06:41:41 +0000432 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000433 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000434 bool useEHCleanupForArray =
435 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000436
437 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000438 }
439 };
440
David Blaikie7e70d682015-08-18 22:40:54 +0000441 struct DestroyNRVOVariable final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000442 DestroyNRVOVariable(Address addr,
John McCall82fe67b2011-07-09 01:37:26 +0000443 const CXXDestructorDecl *Dtor,
444 llvm::Value *NRVOFlag)
445 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {}
John McCall2b7fc382010-07-13 20:32:21 +0000446
447 const CXXDestructorDecl *Dtor;
448 llvm::Value *NRVOFlag;
John McCall7f416cc2015-09-08 08:05:57 +0000449 Address Loc;
John McCall2b7fc382010-07-13 20:32:21 +0000450
Craig Topper4f12f102014-03-12 06:41:41 +0000451 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000452 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000453 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000454
Craig Topper8a13c412014-05-21 05:09:00 +0000455 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000456 if (NRVO) {
457 // If we exited via NRVO, we skip the destructor call.
458 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
459 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
John McCall7f416cc2015-09-08 08:05:57 +0000460 llvm::Value *DidNRVO =
461 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
John McCall2b7fc382010-07-13 20:32:21 +0000462 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
463 CGF.EmitBlock(RunDtorBB);
464 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000465
John McCall2b7fc382010-07-13 20:32:21 +0000466 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +0000467 /*ForVirtualBase=*/false,
468 /*Delegating=*/false,
469 Loc);
John McCall2b7fc382010-07-13 20:32:21 +0000470
471 if (NRVO) CGF.EmitBlock(SkipDtorBB);
472 }
473 };
John McCall2b7fc382010-07-13 20:32:21 +0000474
David Blaikie7e70d682015-08-18 22:40:54 +0000475 struct CallStackRestore final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000476 Address Stack;
477 CallStackRestore(Address Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000478 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000479 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
John McCalla464ff92010-07-21 06:13:08 +0000480 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
481 CGF.Builder.CreateCall(F, V);
482 }
483 };
484
David Blaikie7e70d682015-08-18 22:40:54 +0000485 struct ExtendGCLifetime final : EHScopeStack::Cleanup {
John McCall1bd25562011-06-24 23:21:27 +0000486 const VarDecl &Var;
487 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
488
Craig Topper4f12f102014-03-12 06:41:41 +0000489 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000490 // Compute the address of the local variable, in case it's a
491 // byref or something.
John McCall113bee02012-03-10 09:33:50 +0000492 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
493 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000494 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
495 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000496 CGF.EmitExtendGCLifetime(value);
497 }
498 };
499
David Blaikie7e70d682015-08-18 22:40:54 +0000500 struct CallCleanupFunction final : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000501 llvm::Constant *CleanupFn;
502 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000503 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000504
John McCalla464ff92010-07-21 06:13:08 +0000505 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000506 const VarDecl *Var)
507 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000508
Craig Topper4f12f102014-03-12 06:41:41 +0000509 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall113bee02012-03-10 09:33:50 +0000510 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
511 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000512 // Compute the address of the local variable, in case it's a byref
513 // or something.
John McCall7f416cc2015-09-08 08:05:57 +0000514 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer();
John McCallc533cb72011-02-22 06:44:22 +0000515
John McCalla464ff92010-07-21 06:13:08 +0000516 // In some cases, the type of the function argument will be different from
517 // the type of the pointer. An example of this is
518 // void f(void* arg);
519 // __attribute__((cleanup(f))) void *g;
520 //
521 // To fix this we insert a bitcast here.
522 QualType ArgTy = FnInfo.arg_begin()->type;
523 llvm::Value *Arg =
524 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
525
526 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000527 Args.add(RValue::get(Arg),
528 CGF.getContext().getPointerType(Var.getType()));
John McCalla464ff92010-07-21 06:13:08 +0000529 CGF.EmitCall(FnInfo, CleanupFn, ReturnValueSlot(), Args);
530 }
531 };
Arnaud A. de Grandmaison6e24a462014-07-21 19:47:02 +0000532
533 /// A cleanup to call @llvm.lifetime.end.
David Blaikie7e70d682015-08-18 22:40:54 +0000534 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
Arnaud A. de Grandmaison6e24a462014-07-21 19:47:02 +0000535 llvm::Value *Addr;
536 llvm::Value *Size;
537 public:
John McCall7f416cc2015-09-08 08:05:57 +0000538 CallLifetimeEnd(Address addr, llvm::Value *size)
539 : Addr(addr.getPointer()), Size(size) {}
Arnaud A. de Grandmaison6e24a462014-07-21 19:47:02 +0000540
541 void Emit(CodeGenFunction &CGF, Flags flags) override {
David Majnemerdc012fa2015-04-22 21:38:15 +0000542 CGF.EmitLifetimeEnd(Size, Addr);
Arnaud A. de Grandmaison6e24a462014-07-21 19:47:02 +0000543 }
544 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000545} // end anonymous namespace
John McCalla464ff92010-07-21 06:13:08 +0000546
John McCall31168b02011-06-15 23:02:42 +0000547/// EmitAutoVarWithLifetime - Does the setup required for an automatic
548/// variable with lifetime.
549static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
John McCall7f416cc2015-09-08 08:05:57 +0000550 Address addr,
John McCall31168b02011-06-15 23:02:42 +0000551 Qualifiers::ObjCLifetime lifetime) {
552 switch (lifetime) {
553 case Qualifiers::OCL_None:
554 llvm_unreachable("present but none");
555
556 case Qualifiers::OCL_ExplicitNone:
557 // nothing to do
558 break;
559
560 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000561 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000562 (var.hasAttr<ObjCPreciseLifetimeAttr>()
563 ? CodeGenFunction::destroyARCStrongPrecise
564 : CodeGenFunction::destroyARCStrongImprecise);
565
566 CleanupKind cleanupKind = CGF.getARCCleanupKind();
567 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
568 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000569 break;
570 }
571 case Qualifiers::OCL_Autoreleasing:
572 // nothing to do
573 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000574
John McCall31168b02011-06-15 23:02:42 +0000575 case Qualifiers::OCL_Weak:
576 // __weak objects always get EH cleanups; otherwise, exceptions
577 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000578 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
579 CodeGenFunction::destroyARCWeak,
580 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000581 break;
582 }
583}
584
585static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
586 if (const Expr *e = dyn_cast<Expr>(s)) {
587 // Skip the most common kinds of expressions that make
588 // hierarchy-walking expensive.
589 s = e = e->IgnoreParenCasts();
590
591 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
592 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000593 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
594 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000595 for (const auto &I : block->captures()) {
596 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000597 return true;
598 }
599 }
John McCall31168b02011-06-15 23:02:42 +0000600 }
601
Benjamin Kramer642f1732015-07-02 21:03:14 +0000602 for (const Stmt *SubStmt : s->children())
603 // SubStmt might be null; as in missing decl or conditional of an if-stmt.
604 if (SubStmt && isAccessedBy(var, SubStmt))
John McCall31168b02011-06-15 23:02:42 +0000605 return true;
606
607 return false;
608}
609
610static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
611 if (!decl) return false;
612 if (!isa<VarDecl>(decl)) return false;
613 const VarDecl *var = cast<VarDecl>(decl);
614 return isAccessedBy(*var, e);
615}
616
John McCallf8a9b662015-10-21 18:06:31 +0000617static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
618 const LValue &destLV, const Expr *init) {
John McCall0204e342015-11-16 22:11:41 +0000619 bool needsCast = false;
620
John McCallf8a9b662015-10-21 18:06:31 +0000621 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
622 switch (castExpr->getCastKind()) {
623 // Look through casts that don't require representation changes.
624 case CK_NoOp:
625 case CK_BitCast:
626 case CK_BlockPointerToObjCPointerCast:
John McCall0204e342015-11-16 22:11:41 +0000627 needsCast = true;
John McCallf8a9b662015-10-21 18:06:31 +0000628 break;
629
630 // If we find an l-value to r-value cast from a __weak variable,
631 // emit this operation as a copy or move.
632 case CK_LValueToRValue: {
633 const Expr *srcExpr = castExpr->getSubExpr();
634 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
635 return false;
636
637 // Emit the source l-value.
638 LValue srcLV = CGF.EmitLValue(srcExpr);
639
John McCall0204e342015-11-16 22:11:41 +0000640 // Handle a formal type change to avoid asserting.
641 auto srcAddr = srcLV.getAddress();
642 if (needsCast) {
643 srcAddr = CGF.Builder.CreateElementBitCast(srcAddr,
644 destLV.getAddress().getElementType());
645 }
646
John McCallf8a9b662015-10-21 18:06:31 +0000647 // If it was an l-value, use objc_copyWeak.
648 if (srcExpr->getValueKind() == VK_LValue) {
John McCall0204e342015-11-16 22:11:41 +0000649 CGF.EmitARCCopyWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000650 } else {
651 assert(srcExpr->getValueKind() == VK_XValue);
John McCall0204e342015-11-16 22:11:41 +0000652 CGF.EmitARCMoveWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000653 }
654 return true;
655 }
656
657 // Stop at anything else.
658 default:
659 return false;
660 }
661
662 init = castExpr->getSubExpr();
John McCallf8a9b662015-10-21 18:06:31 +0000663 }
664 return false;
665}
666
John McCall1553b192011-06-16 04:16:24 +0000667static void drillIntoBlockVariable(CodeGenFunction &CGF,
668 LValue &lvalue,
669 const VarDecl *var) {
John McCall7f416cc2015-09-08 08:05:57 +0000670 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(), var));
John McCall1553b192011-06-16 04:16:24 +0000671}
672
David Blaikie73ca5692014-12-09 00:32:22 +0000673void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +0000674 LValue lvalue, bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000675 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000676 if (!lifetime) {
677 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000678 if (capturedByInit)
679 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +0000680 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000681 return;
682 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000683
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000684 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
685 init = DIE->getExpr();
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000686
John McCall31168b02011-06-15 23:02:42 +0000687 // If we're emitting a value with lifetime, we have to do the
688 // initialization *before* we leave the cleanup scopes.
John McCall08ef4662011-11-10 08:15:53 +0000689 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init)) {
690 enterFullExpression(ewc);
John McCall31168b02011-06-15 23:02:42 +0000691 init = ewc->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000692 }
693 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000694
695 // We have to maintain the illusion that the variable is
696 // zero-initialized. If the variable might be accessed in its
697 // initializer, zero-initialize before running the initializer, then
698 // actually perform the initialization with an assign.
699 bool accessedByInit = false;
700 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000701 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000702 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000703 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000704 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000705 if (capturedByInit) {
706 // We can use a simple GEP for this because it can't have been
707 // moved yet.
John McCall7f416cc2015-09-08 08:05:57 +0000708 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(),
709 cast<VarDecl>(D),
710 /*follow*/ false));
John McCall31168b02011-06-15 23:02:42 +0000711 }
712
John McCall7f416cc2015-09-08 08:05:57 +0000713 auto ty = cast<llvm::PointerType>(tempLV.getAddress().getElementType());
John McCall31168b02011-06-15 23:02:42 +0000714 llvm::Value *zero = llvm::ConstantPointerNull::get(ty);
Eric Christopher31ab1302011-08-23 22:38:00 +0000715
John McCall31168b02011-06-15 23:02:42 +0000716 // If __weak, we want to use a barrier under certain conditions.
717 if (lifetime == Qualifiers::OCL_Weak)
John McCall1553b192011-06-16 04:16:24 +0000718 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCall31168b02011-06-15 23:02:42 +0000719
720 // Otherwise just do a simple store.
721 else
David Chisnallfa35df62012-01-16 17:27:18 +0000722 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000723 }
724
725 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000726 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000727
728 switch (lifetime) {
729 case Qualifiers::OCL_None:
730 llvm_unreachable("present but none");
731
732 case Qualifiers::OCL_ExplicitNone:
John McCalle399e5b2016-01-27 18:32:30 +0000733 value = EmitARCUnsafeUnretainedScalarExpr(init);
John McCall31168b02011-06-15 23:02:42 +0000734 break;
735
736 case Qualifiers::OCL_Strong: {
737 value = EmitARCRetainScalarExpr(init);
738 break;
739 }
740
741 case Qualifiers::OCL_Weak: {
John McCallf8a9b662015-10-21 18:06:31 +0000742 // If it's not accessed by the initializer, try to emit the
743 // initialization with a copy or move.
744 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
745 return;
746 }
747
John McCall31168b02011-06-15 23:02:42 +0000748 // No way to optimize a producing initializer into this. It's not
749 // worth optimizing for, because the value will immediately
750 // disappear in the common case.
751 value = EmitScalarExpr(init);
752
John McCall1553b192011-06-16 04:16:24 +0000753 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000754 if (accessedByInit)
John McCall1553b192011-06-16 04:16:24 +0000755 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000756 else
John McCall1553b192011-06-16 04:16:24 +0000757 EmitARCInitWeak(lvalue.getAddress(), value);
John McCall31168b02011-06-15 23:02:42 +0000758 return;
759 }
760
761 case Qualifiers::OCL_Autoreleasing:
762 value = EmitARCRetainAutoreleaseScalarExpr(init);
763 break;
764 }
765
John McCall1553b192011-06-16 04:16:24 +0000766 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000767
768 // If the variable might have been accessed by its initializer, we
769 // might have to initialize with a barrier. We have to do this for
770 // both __weak and __strong, but __weak got filtered out above.
771 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000772 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000773 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000774 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000775 return;
776 }
777
David Chisnallfa35df62012-01-16 17:27:18 +0000778 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000779}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000780
John McCalld4631322011-06-17 06:42:21 +0000781/// EmitScalarInit - Initialize the given lvalue with the given object.
782void CodeGenFunction::EmitScalarInit(llvm::Value *init, LValue lvalue) {
783 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
784 if (!lifetime)
David Chisnallfa35df62012-01-16 17:27:18 +0000785 return EmitStoreThroughLValue(RValue::get(init), lvalue, true);
John McCalld4631322011-06-17 06:42:21 +0000786
787 switch (lifetime) {
788 case Qualifiers::OCL_None:
789 llvm_unreachable("present but none");
790
791 case Qualifiers::OCL_ExplicitNone:
792 // nothing to do
793 break;
794
795 case Qualifiers::OCL_Strong:
796 init = EmitARCRetain(lvalue.getType(), init);
797 break;
798
799 case Qualifiers::OCL_Weak:
800 // Initialize and then skip the primitive store.
801 EmitARCInitWeak(lvalue.getAddress(), init);
802 return;
803
804 case Qualifiers::OCL_Autoreleasing:
805 init = EmitARCRetainAutorelease(lvalue.getType(), init);
806 break;
807 }
808
David Chisnallfa35df62012-01-16 17:27:18 +0000809 EmitStoreOfScalar(init, lvalue, /* isInitialization */ true);
John McCalld4631322011-06-17 06:42:21 +0000810}
811
Chris Lattnerb85025f2010-12-01 02:05:19 +0000812/// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the
813/// non-zero parts of the specified initializer with equal or fewer than
814/// NumStores scalar stores.
815static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init,
816 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000817 // Zero and Undef never requires any extra stores.
818 if (isa<llvm::ConstantAggregateZero>(Init) ||
819 isa<llvm::ConstantPointerNull>(Init) ||
820 isa<llvm::UndefValue>(Init))
821 return true;
822 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
823 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
824 isa<llvm::ConstantExpr>(Init))
825 return Init->isNullValue() || NumStores--;
826
827 // See if we can emit each element.
828 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
829 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
830 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
831 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
832 return false;
833 }
834 return true;
835 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000836
Chris Lattner236b3572012-01-31 04:36:19 +0000837 if (llvm::ConstantDataSequential *CDS =
838 dyn_cast<llvm::ConstantDataSequential>(Init)) {
839 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
840 llvm::Constant *Elt = CDS->getElementAsConstant(i);
841 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
842 return false;
843 }
844 return true;
845 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000846
Chris Lattnerb85025f2010-12-01 02:05:19 +0000847 // Anything else is hard and scary.
848 return false;
849}
850
851/// emitStoresForInitAfterMemset - For inits that
852/// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar
853/// stores that would be required.
854static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc,
John McCallc533cb72011-02-22 06:44:22 +0000855 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000856 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
857 "called emitStoresForInitAfterMemset for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000858
Chris Lattnere6af8862010-12-02 01:58:41 +0000859 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
860 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
861 isa<llvm::ConstantExpr>(Init)) {
John McCall7f416cc2015-09-08 08:05:57 +0000862 Builder.CreateDefaultAlignedStore(Init, Loc, isVolatile);
Chris Lattner236b3572012-01-31 04:36:19 +0000863 return;
864 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000865
866 if (llvm::ConstantDataSequential *CDS =
867 dyn_cast<llvm::ConstantDataSequential>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000868 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
869 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000870
871 // If necessary, get a pointer to the element and emit it.
872 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
David Blaikie17ea2662015-04-04 21:07:17 +0000873 emitStoresForInitAfterMemset(
874 Elt, Builder.CreateConstGEP2_32(Init->getType(), Loc, 0, i),
875 isVolatile, Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000876 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000877 return;
878 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000879
Chris Lattnere6af8862010-12-02 01:58:41 +0000880 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
881 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000882
Chris Lattnere6af8862010-12-02 01:58:41 +0000883 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
884 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000885
886 // If necessary, get a pointer to the element and emit it.
887 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
David Blaikie17ea2662015-04-04 21:07:17 +0000888 emitStoresForInitAfterMemset(
889 Elt, Builder.CreateConstGEP2_32(Init->getType(), Loc, 0, i),
890 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000891 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000892}
893
Chris Lattnerb85025f2010-12-01 02:05:19 +0000894/// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset
895/// plus some stores to initialize a local variable instead of using a memcpy
896/// from a constant global. It is beneficial to use memset if the global is all
897/// zeros, or mostly zeros and large.
898static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init,
899 uint64_t GlobalSize) {
900 // If a global is all zeros, always use a memset.
901 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
902
Chris Lattnerb85025f2010-12-01 02:05:19 +0000903 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
904 // do it if it will require 6 or fewer scalar stores.
905 // TODO: Should budget depends on the size? Avoiding a large global warrants
906 // plopping in more stores.
907 unsigned StoreBudget = 6;
908 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000909
910 return GlobalSize > SizeLimit &&
Chris Lattnerb85025f2010-12-01 02:05:19 +0000911 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget);
912}
913
Nick Lewycky8a7d90b2010-12-30 20:21:55 +0000914/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +0000915/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +0000916/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +0000917void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
918 AutoVarEmission emission = EmitAutoVarAlloca(D);
919 EmitAutoVarInit(emission);
920 EmitAutoVarCleanups(emission);
921}
Chris Lattner03df1222007-06-02 04:53:11 +0000922
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000923/// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time
924/// markers.
925static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts,
926 const LangOptions &LangOpts) {
927 // Asan uses markers for use-after-scope checks.
928 if (CGOpts.SanitizeAddressUseAfterScope)
929 return true;
930
931 // Disable lifetime markers in msan builds.
932 // FIXME: Remove this when msan works with lifetime markers.
933 if (LangOpts.Sanitize.has(SanitizerKind::Memory))
934 return false;
935
936 // For now, only in optimized builds.
937 return CGOpts.OptimizationLevel != 0;
938}
939
David Majnemerdc012fa2015-04-22 21:38:15 +0000940/// Emit a lifetime.begin marker if some criteria are satisfied.
941/// \return a pointer to the temporary size Value if a marker was emitted, null
942/// otherwise
943llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
944 llvm::Value *Addr) {
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000945 if (!shouldEmitLifetimeMarkers(CGM.getCodeGenOpts(), getLangOpts()))
Reid Kleckner1ef49212015-04-23 18:07:13 +0000946 return nullptr;
947
David Majnemerdc012fa2015-04-22 21:38:15 +0000948 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
Alexey Samsonovd918ff62015-06-12 22:31:32 +0000949 Addr = Builder.CreateBitCast(Addr, Int8PtrTy);
950 llvm::CallInst *C =
951 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +0000952 C->setDoesNotThrow();
953 return SizeV;
954}
955
956void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
Alexey Samsonovd918ff62015-06-12 22:31:32 +0000957 Addr = Builder.CreateBitCast(Addr, Int8PtrTy);
958 llvm::CallInst *C =
959 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +0000960 C->setDoesNotThrow();
961}
962
John McCallc533cb72011-02-22 06:44:22 +0000963/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000964/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +0000965CodeGenFunction::AutoVarEmission
966CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
967 QualType Ty = D.getType();
968
969 AutoVarEmission emission(D);
970
971 bool isByRef = D.hasAttr<BlocksAttr>();
972 emission.IsByRef = isByRef;
973
974 CharUnits alignment = getContext().getDeclAlign(&D);
John McCallc533cb72011-02-22 06:44:22 +0000975
John McCall23c29fe2011-06-24 21:55:10 +0000976 // If the type is variably-modified, emit all the VLA sizes for it.
977 if (Ty->isVariablyModifiedType())
978 EmitVariablyModifiedType(Ty);
979
John McCall7f416cc2015-09-08 08:05:57 +0000980 Address address = Address::invalid();
Eli Friedmana682d392008-02-15 12:20:59 +0000981 if (Ty->isConstantSizeType()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +0000982 bool NRVO = getLangOpts().ElideConstructors &&
983 D.isNRVOVariable();
John McCallc533cb72011-02-22 06:44:22 +0000984
Richard Smith2bcde3a2013-06-02 00:09:52 +0000985 // If this value is an array or struct with a statically determinable
986 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +0000987 //
988 // TODO: We should constant-evaluate the initializer of any variable,
989 // as long as it is initialized by a constant expression. Currently,
990 // isConstantInitializer produces wrong answers for structs with
991 // reference or bitfield members, and a few other cases, and checking
992 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +0000993 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
994 (D.isConstexpr() ||
995 ((Ty.isPODType(getContext()) ||
996 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
997 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +0000998
Rafael Espindola609f5d92013-03-26 18:41:47 +0000999 // If the variable's a const type, and it's neither an NRVO
1000 // candidate nor a __block variable and has no mutable members,
1001 // emit it as a global instead.
1002 if (CGM.getCodeGenOpts().MergeAllConstants && !NRVO && !isByRef &&
1003 CGM.isTypeConstant(Ty, true)) {
1004 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +00001005
John McCall7f416cc2015-09-08 08:05:57 +00001006 // Signal this condition to later callbacks.
1007 emission.Addr = Address::invalid();
Rafael Espindola609f5d92013-03-26 18:41:47 +00001008 assert(emission.wasEmittedAsGlobal());
1009 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +00001010 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001011
Rafael Espindola609f5d92013-03-26 18:41:47 +00001012 // Otherwise, tell the initialization code that we're in this case.
1013 emission.IsConstantAggregate = true;
1014 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001015
Rafael Espindola609f5d92013-03-26 18:41:47 +00001016 // A normal fixed sized variable becomes an alloca in the entry block,
1017 // unless it's an NRVO variable.
Eric Christopher31ab1302011-08-23 22:38:00 +00001018
Rafael Espindola609f5d92013-03-26 18:41:47 +00001019 if (NRVO) {
1020 // The named return value optimization: allocate this variable in the
1021 // return slot, so that we can elide the copy when returning this
1022 // variable (C++0x [class.copy]p34).
John McCall7f416cc2015-09-08 08:05:57 +00001023 address = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +00001024
Rafael Espindola609f5d92013-03-26 18:41:47 +00001025 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
1026 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) {
1027 // Create a flag that is used to indicate when the NRVO was applied
1028 // to this variable. Set it to zero to indicate that NRVO was not
1029 // applied.
1030 llvm::Value *Zero = Builder.getFalse();
John McCall7f416cc2015-09-08 08:05:57 +00001031 Address NRVOFlag =
1032 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
Rafael Espindola609f5d92013-03-26 18:41:47 +00001033 EnsureInsertPoint();
1034 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +00001035
Rafael Espindola609f5d92013-03-26 18:41:47 +00001036 // Record the NRVO flag for this variable.
John McCall7f416cc2015-09-08 08:05:57 +00001037 NRVOFlags[&D] = NRVOFlag.getPointer();
1038 emission.NRVOFlag = NRVOFlag.getPointer();
Nadav Rotem1da30942013-03-23 06:43:35 +00001039 }
Douglas Gregor290c93e2010-05-15 06:46:45 +00001040 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001041 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001042 CharUnits allocaAlignment;
1043 llvm::Type *allocaTy;
1044 if (isByRef) {
1045 auto &byrefInfo = getBlockByrefInfo(&D);
1046 allocaTy = byrefInfo.Type;
1047 allocaAlignment = byrefInfo.ByrefAlignment;
1048 } else {
1049 allocaTy = ConvertTypeForMem(Ty);
1050 allocaAlignment = alignment;
1051 }
Rafael Espindola609f5d92013-03-26 18:41:47 +00001052
John McCall999110f2015-09-08 09:18:30 +00001053 // Create the alloca. Note that we set the name separately from
1054 // building the instruction so that it's there even in no-asserts
1055 // builds.
1056 address = CreateTempAlloca(allocaTy, allocaAlignment);
1057 address.getPointer()->setName(D.getName());
Rafael Espindola609f5d92013-03-26 18:41:47 +00001058
Reid Kleckner1f88e932015-10-07 21:03:41 +00001059 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1060 // the catch parameter starts in the catchpad instruction, and we can't
1061 // insert code in those basic blocks.
1062 bool IsMSCatchParam =
1063 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1064
Rafael Espindola609f5d92013-03-26 18:41:47 +00001065 // Emit a lifetime intrinsic if meaningful. There's no point
1066 // in doing this if we don't have a valid insertion point (?).
Reid Kleckner1f88e932015-10-07 21:03:41 +00001067 if (HaveInsertPoint() && !IsMSCatchParam) {
John McCall7f416cc2015-09-08 08:05:57 +00001068 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1069 emission.SizeForLifetimeMarkers =
1070 EmitLifetimeStart(size, address.getPointer());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001071 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001072 assert(!emission.useLifetimeMarkers());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001073 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001074 }
Chris Lattner03df1222007-06-02 04:53:11 +00001075 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001076 EnsureInsertPoint();
1077
Anders Carlsson15949b32009-02-09 20:41:50 +00001078 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +00001079 // Save the stack.
John McCall7f416cc2015-09-08 08:05:57 +00001080 Address Stack =
1081 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +00001082
Anders Carlsson30032882008-12-12 07:38:43 +00001083 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie4ba525b2015-07-14 17:27:39 +00001084 llvm::Value *V = Builder.CreateCall(F);
Anders Carlsson30032882008-12-12 07:38:43 +00001085 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +00001086
1087 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +00001088
John McCalla464ff92010-07-21 06:13:08 +00001089 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +00001090 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001091 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +00001092 }
Mike Stump11289f42009-09-09 15:08:12 +00001093
John McCall23c29fe2011-06-24 21:55:10 +00001094 llvm::Value *elementCount;
1095 QualType elementType;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001096 std::tie(elementCount, elementType) = getVLASize(Ty);
Anders Carlsson30032882008-12-12 07:38:43 +00001097
Chris Lattner2192fe52011-07-18 04:24:23 +00001098 llvm::Type *llvmTy = ConvertTypeForMem(elementType);
Anders Carlsson30032882008-12-12 07:38:43 +00001099
1100 // Allocate memory for the array.
John McCall23c29fe2011-06-24 21:55:10 +00001101 llvm::AllocaInst *vla = Builder.CreateAlloca(llvmTy, elementCount, "vla");
1102 vla->setAlignment(alignment.getQuantity());
Anders Carlssone33eed52009-09-26 18:16:06 +00001103
John McCall7f416cc2015-09-08 08:05:57 +00001104 address = Address(vla, alignment);
Chris Lattner03df1222007-06-02 04:53:11 +00001105 }
Eli Friedmanf4084702008-12-20 23:11:59 +00001106
John McCall7f416cc2015-09-08 08:05:57 +00001107 setAddrOfLocalVar(&D, address);
1108 emission.Addr = address;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001109
1110 // Emit debug info for local var declaration.
Devang Patel887e2152011-06-03 19:21:47 +00001111 if (HaveInsertPoint())
1112 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001113 if (CGM.getCodeGenOpts().getDebugInfo() >=
1114 codegenoptions::LimitedDebugInfo) {
Alexey Samsonov74a38682012-05-04 07:39:27 +00001115 DI->setLocation(D.getLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001116 DI->EmitDeclareOfAutoVariable(&D, address.getPointer(), Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00001117 }
Devang Patel887e2152011-06-03 19:21:47 +00001118 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001119
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001120 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00001121 EmitVarAnnotations(&D, address.getPointer());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001122
John McCallc533cb72011-02-22 06:44:22 +00001123 return emission;
1124}
1125
1126/// Determines whether the given __block variable is potentially
1127/// captured by the given expression.
1128static bool isCapturedBy(const VarDecl &var, const Expr *e) {
1129 // Skip the most common kinds of expressions that make
1130 // hierarchy-walking expensive.
1131 e = e->IgnoreParenCasts();
1132
1133 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
1134 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +00001135 for (const auto &I : block->captures()) {
1136 if (I.getVariable() == &var)
John McCallc533cb72011-02-22 06:44:22 +00001137 return true;
1138 }
1139
1140 // No need to walk into the subexpressions.
1141 return false;
1142 }
1143
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001144 if (const StmtExpr *SE = dyn_cast<StmtExpr>(e)) {
1145 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001146 for (const auto *BI : CS->body())
1147 if (const auto *E = dyn_cast<Expr>(BI)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001148 if (isCapturedBy(var, E))
1149 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001150 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001151 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001152 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001153 for (const auto *I : DS->decls()) {
1154 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1155 const Expr *Init = VD->getInit();
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001156 if (Init && isCapturedBy(var, Init))
1157 return true;
1158 }
1159 }
1160 }
1161 else
1162 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1163 // Later, provide code to poke into statements for capture analysis.
1164 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001165 return false;
1166 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001167
Benjamin Kramer642f1732015-07-02 21:03:14 +00001168 for (const Stmt *SubStmt : e->children())
1169 if (isCapturedBy(var, cast<Expr>(SubStmt)))
John McCallc533cb72011-02-22 06:44:22 +00001170 return true;
1171
1172 return false;
1173}
1174
Douglas Gregor82e1af22011-07-01 21:08:19 +00001175/// \brief Determine whether the given initializer is trivial in the sense
1176/// that it requires no code to be generated.
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001177bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
Douglas Gregor82e1af22011-07-01 21:08:19 +00001178 if (!Init)
1179 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001180
Douglas Gregor82e1af22011-07-01 21:08:19 +00001181 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1182 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1183 if (Constructor->isTrivial() &&
1184 Constructor->isDefaultConstructor() &&
1185 !Construct->requiresZeroInitialization())
1186 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001187
Douglas Gregor82e1af22011-07-01 21:08:19 +00001188 return false;
1189}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001190
John McCallc533cb72011-02-22 06:44:22 +00001191void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001192 assert(emission.Variable && "emission was not valid!");
1193
John McCallc533cb72011-02-22 06:44:22 +00001194 // If this was emitted as a global constant, we're done.
1195 if (emission.wasEmittedAsGlobal()) return;
1196
John McCall9e2e22f2011-02-22 07:16:58 +00001197 const VarDecl &D = *emission.Variable;
Adrian Prantl95b24e92015-02-03 20:00:54 +00001198 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
John McCallc533cb72011-02-22 06:44:22 +00001199 QualType type = D.getType();
1200
Chris Lattner07eb7332007-07-12 00:39:48 +00001201 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001202 const Expr *Init = D.getInit();
1203
1204 // If we are at an unreachable point, we don't need to emit the initializer
1205 // unless it contains a label.
1206 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001207 if (!Init || !ContainsLabel(Init)) return;
1208 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001209 }
1210
John McCall73064872011-03-31 01:59:53 +00001211 // Initialize the structure of a __block variable.
1212 if (emission.IsByRef)
1213 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001214
Douglas Gregor82e1af22011-07-01 21:08:19 +00001215 if (isTrivialInitializer(Init))
1216 return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001217
John McCallc533cb72011-02-22 06:44:22 +00001218 // Check whether this is a byref variable that's potentially
1219 // captured and moved by its own initializer. If so, we'll need to
1220 // emit the initializer first, then copy into the variable.
1221 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init);
1222
John McCall7f416cc2015-09-08 08:05:57 +00001223 Address Loc =
1224 capturedByInit ? emission.Addr : emission.getObjectAddress(*this);
John McCallc533cb72011-02-22 06:44:22 +00001225
Craig Topper8a13c412014-05-21 05:09:00 +00001226 llvm::Constant *constant = nullptr;
Richard Smith2bcde3a2013-06-02 00:09:52 +00001227 if (emission.IsConstantAggregate || D.isConstexpr()) {
Richard Smithfddd3842011-12-30 21:15:51 +00001228 assert(!capturedByInit && "constant init contains a capturing block?");
Richard Smithdafff942012-01-14 04:30:29 +00001229 constant = CGM.EmitConstantInit(D, this);
Richard Smithfddd3842011-12-30 21:15:51 +00001230 }
1231
1232 if (!constant) {
John McCall7f416cc2015-09-08 08:05:57 +00001233 LValue lv = MakeAddrLValue(Loc, type);
John McCall1553b192011-06-16 04:16:24 +00001234 lv.setNonGC(true);
David Blaikie66e41972015-01-14 07:38:27 +00001235 return EmitExprAsInit(Init, &D, lv, capturedByInit);
John McCall1553b192011-06-16 04:16:24 +00001236 }
John McCall91ca10f2011-03-08 09:11:50 +00001237
Richard Smith2bcde3a2013-06-02 00:09:52 +00001238 if (!emission.IsConstantAggregate) {
1239 // For simple scalar/complex initialization, store the value directly.
John McCall7f416cc2015-09-08 08:05:57 +00001240 LValue lv = MakeAddrLValue(Loc, type);
Richard Smith2bcde3a2013-06-02 00:09:52 +00001241 lv.setNonGC(true);
1242 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1243 }
1244
John McCallc533cb72011-02-22 06:44:22 +00001245 // If this is a simple aggregate initialization, we can optimize it
1246 // in various ways.
John McCall91ca10f2011-03-08 09:11:50 +00001247 bool isVolatile = type.isVolatileQualified();
John McCallc533cb72011-02-22 06:44:22 +00001248
John McCall91ca10f2011-03-08 09:11:50 +00001249 llvm::Value *SizeVal =
Eric Christopher31ab1302011-08-23 22:38:00 +00001250 llvm::ConstantInt::get(IntPtrTy,
John McCall91ca10f2011-03-08 09:11:50 +00001251 getContext().getTypeSizeInChars(type).getQuantity());
John McCallc533cb72011-02-22 06:44:22 +00001252
Chris Lattner2192fe52011-07-18 04:24:23 +00001253 llvm::Type *BP = Int8PtrTy;
John McCall7f416cc2015-09-08 08:05:57 +00001254 if (Loc.getType() != BP)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001255 Loc = Builder.CreateBitCast(Loc, BP);
Mon P Wangcc2ab0c2010-04-04 03:10:52 +00001256
John McCall91ca10f2011-03-08 09:11:50 +00001257 // If the initializer is all or mostly zeros, codegen with memset then do
1258 // a few stores afterward.
Eric Christopher31ab1302011-08-23 22:38:00 +00001259 if (shouldUseMemSetPlusStoresToInitialize(constant,
Micah Villmowdd31ca12012-10-08 16:25:52 +00001260 CGM.getDataLayout().getTypeAllocSize(constant->getType()))) {
John McCall91ca10f2011-03-08 09:11:50 +00001261 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
John McCall7f416cc2015-09-08 08:05:57 +00001262 isVolatile);
Benjamin Kramer29f9a002012-08-27 22:07:02 +00001263 // Zero and undef don't require a stores.
1264 if (!constant->isNullValue() && !isa<llvm::UndefValue>(constant)) {
John McCall91ca10f2011-03-08 09:11:50 +00001265 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00001266 emitStoresForInitAfterMemset(constant, Loc.getPointer(),
1267 isVolatile, Builder);
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001268 }
John McCall91ca10f2011-03-08 09:11:50 +00001269 } else {
Eric Christopher31ab1302011-08-23 22:38:00 +00001270 // Otherwise, create a temporary global with the initializer then
John McCall91ca10f2011-03-08 09:11:50 +00001271 // memcpy from the global to the alloca.
Reid Kleckner453e0562014-10-08 01:07:54 +00001272 std::string Name = getStaticDeclName(CGM, D);
John McCall91ca10f2011-03-08 09:11:50 +00001273 llvm::GlobalVariable *GV =
1274 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true,
Eric Christopherb58b3e82011-08-24 00:33:55 +00001275 llvm::GlobalValue::PrivateLinkage,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +00001276 constant, Name);
John McCall7f416cc2015-09-08 08:05:57 +00001277 GV->setAlignment(Loc.getAlignment().getQuantity());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001278 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Eric Christopher31ab1302011-08-23 22:38:00 +00001279
John McCall7f416cc2015-09-08 08:05:57 +00001280 Address SrcPtr = Address(GV, Loc.getAlignment());
1281 if (SrcPtr.getType() != BP)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001282 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
John McCall91ca10f2011-03-08 09:11:50 +00001283
John McCall7f416cc2015-09-08 08:05:57 +00001284 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, isVolatile);
John McCall91ca10f2011-03-08 09:11:50 +00001285 }
1286}
1287
1288/// Emit an expression as an initializer for a variable at the given
1289/// location. The expression is not necessarily the normal
1290/// initializer for the variable, and the address is not necessarily
1291/// its normal location.
1292///
1293/// \param init the initializing expression
1294/// \param var the variable to act as if we're initializing
1295/// \param loc the address to initialize; its type is a pointer
1296/// to the LLVM mapping of the variable's type
1297/// \param alignment the alignment of the address
1298/// \param capturedByInit true if the variable is a __block variable
1299/// whose address is potentially changed by the initializer
David Blaikie73ca5692014-12-09 00:32:22 +00001300void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +00001301 LValue lvalue, bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001302 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001303
1304 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001305 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001306 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001307 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001308 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001309 return;
1310 }
1311 switch (getEvaluationKind(type)) {
1312 case TEK_Scalar:
David Blaikie66e41972015-01-14 07:38:27 +00001313 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001314 return;
1315 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001316 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001317 if (capturedByInit)
1318 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001319 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
John McCall47fb9502013-03-07 21:37:08 +00001320 return;
1321 }
1322 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001323 if (type->isAtomicType()) {
1324 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1325 } else {
1326 // TODO: how can we delay here if D is captured by its initializer?
1327 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001328 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001329 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001330 AggValueSlot::IsNotAliased));
John McCalla8ec7eb2013-03-07 21:37:17 +00001331 }
John McCall47fb9502013-03-07 21:37:08 +00001332 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001333 }
John McCall47fb9502013-03-07 21:37:08 +00001334 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001335}
John McCallbd309292010-07-06 01:34:17 +00001336
John McCall82fe67b2011-07-09 01:37:26 +00001337/// Enter a destroy cleanup for the given local variable.
1338void CodeGenFunction::emitAutoVarTypeCleanup(
1339 const CodeGenFunction::AutoVarEmission &emission,
1340 QualType::DestructionKind dtorKind) {
1341 assert(dtorKind != QualType::DK_none);
1342
1343 // Note that for __block variables, we want to destroy the
1344 // original stack object, not the possibly forwarded object.
John McCall7f416cc2015-09-08 08:05:57 +00001345 Address addr = emission.getObjectAddress(*this);
John McCall82fe67b2011-07-09 01:37:26 +00001346
1347 const VarDecl *var = emission.Variable;
1348 QualType type = var->getType();
1349
1350 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001351 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001352
1353 switch (dtorKind) {
1354 case QualType::DK_none:
1355 llvm_unreachable("no cleanup for trivially-destructible variable");
1356
1357 case QualType::DK_cxx_destructor:
1358 // If there's an NRVO flag on the emission, we need a different
1359 // cleanup.
1360 if (emission.NRVOFlag) {
1361 assert(!type->isArrayType());
1362 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
John McCall7f416cc2015-09-08 08:05:57 +00001363 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr,
1364 dtor, emission.NRVOFlag);
John McCall82fe67b2011-07-09 01:37:26 +00001365 return;
1366 }
1367 break;
1368
1369 case QualType::DK_objc_strong_lifetime:
1370 // Suppress cleanups for pseudo-strong variables.
1371 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001372
John McCall82fe67b2011-07-09 01:37:26 +00001373 // Otherwise, consider whether to use an EH cleanup or not.
1374 cleanupKind = getARCCleanupKind();
1375
1376 // Use the imprecise destroyer by default.
1377 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1378 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1379 break;
1380
1381 case QualType::DK_objc_weak_lifetime:
1382 break;
1383 }
1384
1385 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001386 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001387
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001388 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001389 // is being pushed as an EH cleanup.
1390 bool useEHCleanup = (cleanupKind & EHCleanup);
1391 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1392 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001393}
1394
John McCallc533cb72011-02-22 06:44:22 +00001395void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001396 assert(emission.Variable && "emission was not valid!");
1397
John McCallc533cb72011-02-22 06:44:22 +00001398 // If this was emitted as a global constant, we're done.
1399 if (emission.wasEmittedAsGlobal()) return;
1400
John McCall8c38d352012-04-13 18:44:05 +00001401 // If we don't have an insertion point, we're done. Sema prevents
1402 // us from jumping into any of these scopes anyway.
1403 if (!HaveInsertPoint()) return;
1404
John McCall9e2e22f2011-02-22 07:16:58 +00001405 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001406
Nadav Rotem1da30942013-03-23 06:43:35 +00001407 // Make sure we call @llvm.lifetime.end. This needs to happen
1408 // *last*, so the cleanup needs to be pushed *first*.
1409 if (emission.useLifetimeMarkers()) {
Akira Hatanaka8af7bb22016-04-01 22:58:55 +00001410 EHStack.pushCleanup<CallLifetimeEnd>(NormalAndEHCleanup,
Nadav Rotem1da30942013-03-23 06:43:35 +00001411 emission.getAllocatedAddress(),
1412 emission.getSizeForLifetimeMarkers());
David Majnemerdc012fa2015-04-22 21:38:15 +00001413 EHCleanupScope &cleanup = cast<EHCleanupScope>(*EHStack.begin());
1414 cleanup.setLifetimeMarker();
Nadav Rotem1da30942013-03-23 06:43:35 +00001415 }
1416
John McCall82fe67b2011-07-09 01:37:26 +00001417 // Check the type for a cleanup.
1418 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1419 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001420
John McCall1bd25562011-06-24 23:21:27 +00001421 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001422 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001423 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1424 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1425 }
1426
John McCallc533cb72011-02-22 06:44:22 +00001427 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001428 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001429 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00001430
John McCallc533cb72011-02-22 06:44:22 +00001431 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001432 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00001433
John McCalla729c622012-02-17 03:33:10 +00001434 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00001435 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001436 }
Mike Stump626aecc2009-03-05 01:23:13 +00001437
John McCallc533cb72011-02-22 06:44:22 +00001438 // If this is a block variable, call _Block_object_destroy
1439 // (on the unforwarded address).
John McCall73064872011-03-31 01:59:53 +00001440 if (emission.IsByRef)
1441 enterByrefCleanup(emission);
Chris Lattner03df1222007-06-02 04:53:11 +00001442}
Chris Lattner53621a52007-06-13 20:44:40 +00001443
Peter Collingbourne1425b452012-01-26 03:33:36 +00001444CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00001445CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
1446 switch (kind) {
1447 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00001448 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001449 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00001450 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001451 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00001452 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001453 return destroyARCWeak;
John McCall82fe67b2011-07-09 01:37:26 +00001454 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00001455 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00001456}
1457
John McCall12cc42a2013-02-01 05:11:40 +00001458/// pushEHDestroy - Push the standard destructor for the given type as
1459/// an EH-only cleanup.
1460void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001461 Address addr, QualType type) {
John McCall12cc42a2013-02-01 05:11:40 +00001462 assert(dtorKind && "cannot push destructor for trivial type");
1463 assert(needsEHCleanup(dtorKind));
1464
1465 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
1466}
1467
1468/// pushDestroy - Push the standard destructor for the given type as
1469/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00001470void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001471 Address addr, QualType type) {
John McCall4bd0fb12011-07-12 16:41:08 +00001472 assert(dtorKind && "cannot push destructor for trivial type");
1473
1474 CleanupKind cleanupKind = getCleanupKind(dtorKind);
1475 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
1476 cleanupKind & EHCleanup);
1477}
1478
John McCall7f416cc2015-09-08 08:05:57 +00001479void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001480 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001481 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00001482 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
1483 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001484}
1485
John McCall7f416cc2015-09-08 08:05:57 +00001486void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001487 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
1488}
1489
Richard Smith736a9472013-06-12 20:42:33 +00001490void CodeGenFunction::pushLifetimeExtendedDestroy(
John McCall7f416cc2015-09-08 08:05:57 +00001491 CleanupKind cleanupKind, Address addr, QualType type,
Richard Smith736a9472013-06-12 20:42:33 +00001492 Destroyer *destroyer, bool useEHCleanupForArray) {
1493 assert(!isInConditionalBranch() &&
1494 "performing lifetime extension from within conditional");
1495
1496 // Push an EH-only cleanup for the object now.
1497 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
1498 // around in case a temporary's destructor throws an exception.
1499 if (cleanupKind & EHCleanup)
1500 EHStack.pushCleanup<DestroyObject>(
1501 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
1502 destroyer, useEHCleanupForArray);
1503
1504 // Remember that we need to push a full cleanup for the object at the
1505 // end of the full-expression.
1506 pushCleanupAfterFullExpr<DestroyObject>(
1507 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
1508}
1509
John McCall178360e2011-07-11 08:38:19 +00001510/// emitDestroy - Immediately perform the destruction of the given
1511/// object.
1512///
1513/// \param addr - the address of the object; a type*
1514/// \param type - the type of the object; if an array type, all
1515/// objects are destroyed in reverse order
1516/// \param destroyer - the function to call to destroy individual
1517/// elements
1518/// \param useEHCleanupForArray - whether an EH cleanup should be
1519/// used when destroying array elements, in case one of the
1520/// destructions throws an exception
John McCall7f416cc2015-09-08 08:05:57 +00001521void CodeGenFunction::emitDestroy(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001522 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001523 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00001524 const ArrayType *arrayType = getContext().getAsArrayType(type);
1525 if (!arrayType)
1526 return destroyer(*this, addr, type);
1527
John McCall7f416cc2015-09-08 08:05:57 +00001528 llvm::Value *length = emitArrayLength(arrayType, type, addr);
1529
1530 CharUnits elementAlign =
1531 addr.getAlignment()
1532 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
John McCall97eab0a2011-07-13 08:09:46 +00001533
1534 // Normally we have to check whether the array is zero-length.
1535 bool checkZeroLength = true;
1536
1537 // But if the array length is constant, we can suppress that.
1538 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
1539 // ...and if it's constant zero, we can just skip the entire thing.
1540 if (constLength->isZero()) return;
1541 checkZeroLength = false;
1542 }
1543
John McCall7f416cc2015-09-08 08:05:57 +00001544 llvm::Value *begin = addr.getPointer();
John McCall82fe67b2011-07-09 01:37:26 +00001545 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall7f416cc2015-09-08 08:05:57 +00001546 emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001547 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001548}
1549
John McCall178360e2011-07-11 08:38:19 +00001550/// emitArrayDestroy - Destroys all the elements of the given array,
1551/// beginning from last to first. The array cannot be zero-length.
1552///
1553/// \param begin - a type* denoting the first element of the array
1554/// \param end - a type* denoting one past the end of the array
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00001555/// \param elementType - the element type of the array
John McCall178360e2011-07-11 08:38:19 +00001556/// \param destroyer - the function to call to destroy elements
1557/// \param useEHCleanup - whether to push an EH cleanup to destroy
1558/// the remaining elements in case the destruction of a single
1559/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00001560void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
1561 llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001562 QualType elementType,
1563 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001564 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001565 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00001566 bool useEHCleanup) {
John McCall7f416cc2015-09-08 08:05:57 +00001567 assert(!elementType->isArrayType());
John McCall82fe67b2011-07-09 01:37:26 +00001568
1569 // The basic structure here is a do-while loop, because we don't
1570 // need to check for the zero-element case.
1571 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
1572 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
1573
John McCall97eab0a2011-07-13 08:09:46 +00001574 if (checkZeroLength) {
1575 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
1576 "arraydestroy.isempty");
1577 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
1578 }
1579
John McCall82fe67b2011-07-09 01:37:26 +00001580 // Enter the loop body, making that address the current address.
1581 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1582 EmitBlock(bodyBB);
1583 llvm::PHINode *elementPast =
1584 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
1585 elementPast->addIncoming(end, entryBB);
1586
1587 // Shift the address back by one element.
1588 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
1589 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
1590 "arraydestroy.element");
1591
John McCall178360e2011-07-11 08:38:19 +00001592 if (useEHCleanup)
John McCall7f416cc2015-09-08 08:05:57 +00001593 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
1594 destroyer);
John McCall178360e2011-07-11 08:38:19 +00001595
John McCall82fe67b2011-07-09 01:37:26 +00001596 // Perform the actual destruction there.
John McCall7f416cc2015-09-08 08:05:57 +00001597 destroyer(*this, Address(element, elementAlign), elementType);
John McCall82fe67b2011-07-09 01:37:26 +00001598
John McCall178360e2011-07-11 08:38:19 +00001599 if (useEHCleanup)
1600 PopCleanupBlock();
1601
John McCall82fe67b2011-07-09 01:37:26 +00001602 // Check whether we've reached the end.
1603 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
1604 Builder.CreateCondBr(done, doneBB, bodyBB);
1605 elementPast->addIncoming(element, Builder.GetInsertBlock());
1606
1607 // Done.
1608 EmitBlock(doneBB);
1609}
1610
John McCall178360e2011-07-11 08:38:19 +00001611/// Perform partial array destruction as if in an EH cleanup. Unlike
1612/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00001613static void emitPartialArrayDestroy(CodeGenFunction &CGF,
1614 llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001615 QualType type, CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001616 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00001617 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00001618 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00001619 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
1620 // VLAs don't require a GEP index to walk into.
1621 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00001622 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00001623 type = arrayType->getElementType();
1624 }
John McCall97eab0a2011-07-13 08:09:46 +00001625
1626 if (arrayDepth) {
John McCallf0f0b7a2015-09-14 18:57:08 +00001627 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
John McCall97eab0a2011-07-13 08:09:46 +00001628
John McCallf0f0b7a2015-09-14 18:57:08 +00001629 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
Jay Foad040dd822011-07-22 08:16:57 +00001630 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
1631 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00001632 }
1633
John McCall97eab0a2011-07-13 08:09:46 +00001634 // Destroy the array. We don't ever need an EH cleanup because we
1635 // assume that we're in an EH cleanup ourselves, so a throwing
1636 // destructor causes an immediate terminate.
John McCall7f416cc2015-09-08 08:05:57 +00001637 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001638 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00001639}
1640
John McCall82fe67b2011-07-09 01:37:26 +00001641namespace {
John McCall178360e2011-07-11 08:38:19 +00001642 /// RegularPartialArrayDestroy - a cleanup which performs a partial
1643 /// array destroy where the end pointer is regularly determined and
1644 /// does not need to be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00001645 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall178360e2011-07-11 08:38:19 +00001646 llvm::Value *ArrayBegin;
1647 llvm::Value *ArrayEnd;
1648 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001649 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00001650 CharUnits ElementAlign;
John McCall178360e2011-07-11 08:38:19 +00001651 public:
1652 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001653 QualType elementType, CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00001654 CodeGenFunction::Destroyer *destroyer)
1655 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
John McCall7f416cc2015-09-08 08:05:57 +00001656 ElementType(elementType), Destroyer(destroyer),
1657 ElementAlign(elementAlign) {}
John McCall178360e2011-07-11 08:38:19 +00001658
Craig Topper4f12f102014-03-12 06:41:41 +00001659 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00001660 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001661 ElementType, ElementAlign, Destroyer);
John McCall178360e2011-07-11 08:38:19 +00001662 }
1663 };
1664
1665 /// IrregularPartialArrayDestroy - a cleanup which performs a
1666 /// partial array destroy where the end pointer is irregularly
1667 /// determined and must be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00001668 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00001669 llvm::Value *ArrayBegin;
John McCall7f416cc2015-09-08 08:05:57 +00001670 Address ArrayEndPointer;
John McCall82fe67b2011-07-09 01:37:26 +00001671 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001672 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00001673 CharUnits ElementAlign;
John McCall82fe67b2011-07-09 01:37:26 +00001674 public:
John McCall178360e2011-07-11 08:38:19 +00001675 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001676 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001677 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001678 CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00001679 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00001680 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
John McCall7f416cc2015-09-08 08:05:57 +00001681 ElementType(elementType), Destroyer(destroyer),
1682 ElementAlign(elementAlign) {}
John McCall82fe67b2011-07-09 01:37:26 +00001683
Craig Topper4f12f102014-03-12 06:41:41 +00001684 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00001685 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00001686 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001687 ElementType, ElementAlign, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001688 }
1689 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001690} // end anonymous namespace
John McCall82fe67b2011-07-09 01:37:26 +00001691
John McCall178360e2011-07-11 08:38:19 +00001692/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00001693/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00001694/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00001695///
John McCall82fe67b2011-07-09 01:37:26 +00001696/// \param elementType - the immediate element type of the array;
1697/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00001698void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001699 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001700 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001701 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001702 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00001703 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
1704 arrayBegin, arrayEndPointer,
John McCall7f416cc2015-09-08 08:05:57 +00001705 elementType, elementAlign,
1706 destroyer);
John McCall178360e2011-07-11 08:38:19 +00001707}
1708
1709/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
1710/// already-constructed elements of the given array. The cleanup
1711/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00001712///
John McCall178360e2011-07-11 08:38:19 +00001713/// \param elementType - the immediate element type of the array;
1714/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00001715void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1716 llvm::Value *arrayEnd,
1717 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001718 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001719 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00001720 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00001721 arrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001722 elementType, elementAlign,
1723 destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001724}
1725
Nadav Rotem1da30942013-03-23 06:43:35 +00001726/// Lazily declare the @llvm.lifetime.start intrinsic.
1727llvm::Constant *CodeGenModule::getLLVMLifetimeStartFn() {
1728 if (LifetimeStartFn) return LifetimeStartFn;
1729 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
1730 llvm::Intrinsic::lifetime_start);
1731 return LifetimeStartFn;
1732}
1733
1734/// Lazily declare the @llvm.lifetime.end intrinsic.
1735llvm::Constant *CodeGenModule::getLLVMLifetimeEndFn() {
1736 if (LifetimeEndFn) return LifetimeEndFn;
1737 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
1738 llvm::Intrinsic::lifetime_end);
1739 return LifetimeEndFn;
1740}
1741
John McCall31168b02011-06-15 23:02:42 +00001742namespace {
1743 /// A cleanup to perform a release of an object at the end of a
1744 /// function. This is used to balance out the incoming +1 of a
1745 /// ns_consumed argument when we can't reasonably do that just by
1746 /// not doing the initial retain for a __block argument.
David Blaikie7e70d682015-08-18 22:40:54 +00001747 struct ConsumeARCParameter final : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00001748 ConsumeARCParameter(llvm::Value *param,
1749 ARCPreciseLifetime_t precise)
1750 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00001751
1752 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00001753 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00001754
Craig Topper4f12f102014-03-12 06:41:41 +00001755 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00001756 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00001757 }
1758 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001759} // end anonymous namespace
John McCall31168b02011-06-15 23:02:42 +00001760
Mike Stump11289f42009-09-09 15:08:12 +00001761/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00001762/// for the specified parameter and set up LocalDeclMap.
John McCall7f416cc2015-09-08 08:05:57 +00001763void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
1764 unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001765 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00001766 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001767 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00001768
John McCall7f416cc2015-09-08 08:05:57 +00001769 Arg.getAnyValue()->setName(D.getName());
John McCall147d0212011-02-22 22:38:33 +00001770
Adrian Prantl51936dd2013-03-14 17:53:33 +00001771 QualType Ty = D.getType();
1772
John McCall147d0212011-02-22 22:38:33 +00001773 // Use better IR generation for certain implicit parameters.
John McCall7f416cc2015-09-08 08:05:57 +00001774 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
John McCall147d0212011-02-22 22:38:33 +00001775 // The only implicit argument a block has is its literal.
John McCall7f416cc2015-09-08 08:05:57 +00001776 // We assume this is always passed directly.
John McCall147d0212011-02-22 22:38:33 +00001777 if (BlockInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001778 setBlockContextParameter(IPD, ArgNo, Arg.getDirectValue());
John McCall147d0212011-02-22 22:38:33 +00001779 return;
1780 }
1781 }
1782
John McCall7f416cc2015-09-08 08:05:57 +00001783 Address DeclPtr = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001784 bool DoStore = false;
1785 bool IsScalar = hasScalarEvaluationKind(Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001786 // If we already have a pointer to the argument, reuse the input pointer.
John McCall7f416cc2015-09-08 08:05:57 +00001787 if (Arg.isIndirect()) {
1788 DeclPtr = Arg.getIndirectAddress();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00001789 // If we have a prettier pointer type at this point, bitcast to that.
John McCall7f416cc2015-09-08 08:05:57 +00001790 unsigned AS = DeclPtr.getType()->getAddressSpace();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00001791 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
John McCall7f416cc2015-09-08 08:05:57 +00001792 if (DeclPtr.getType() != IRTy)
1793 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
1794
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00001795 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner19819442014-07-25 21:39:46 +00001796 // Don't push a cleanup in a thunk for a method that will also emit a
1797 // cleanup.
1798 if (!IsScalar && !CurFuncIsThunk &&
Reid Kleckner739756c2013-12-04 19:23:12 +00001799 getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001800 const CXXRecordDecl *RD = Ty->getAsCXXRecordDecl();
1801 if (RD && RD->hasNonTrivialDestructor())
1802 pushDestroy(QualType::DK_cxx_destructor, DeclPtr, Ty);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00001803 }
Chris Lattner53621a52007-06-13 20:44:40 +00001804 } else {
Daniel Dunbar3d33fab2010-02-08 22:53:07 +00001805 // Otherwise, create a temporary to hold the value.
John McCall7f416cc2015-09-08 08:05:57 +00001806 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D),
1807 D.getName() + ".addr");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001808 DoStore = true;
1809 }
Mike Stump11289f42009-09-09 15:08:12 +00001810
John McCall7f416cc2015-09-08 08:05:57 +00001811 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr);
1812
1813 LValue lv = MakeAddrLValue(DeclPtr, Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001814 if (IsScalar) {
John McCall31168b02011-06-15 23:02:42 +00001815 Qualifiers qs = Ty.getQualifiers();
John McCall31168b02011-06-15 23:02:42 +00001816 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
1817 // We honor __attribute__((ns_consumed)) for types with lifetime.
1818 // For __strong, it's handled by just skipping the initial retain;
1819 // otherwise we have to balance out the initial +1 with an extra
1820 // cleanup to do the release at the end of the function.
1821 bool isConsumed = D.hasAttr<NSConsumedAttr>();
1822
1823 // 'self' is always formally __strong, but if this is not an
1824 // init method then we don't want to retain it.
John McCalld4631322011-06-17 06:42:21 +00001825 if (D.isARCPseudoStrong()) {
John McCall31168b02011-06-15 23:02:42 +00001826 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl);
1827 assert(&D == method->getSelfDecl());
John McCalld4631322011-06-17 06:42:21 +00001828 assert(lt == Qualifiers::OCL_Strong);
1829 assert(qs.hasConst());
John McCall31168b02011-06-15 23:02:42 +00001830 assert(method->getMethodFamily() != OMF_init);
John McCall10123692011-06-15 23:40:09 +00001831 (void) method;
John McCall31168b02011-06-15 23:02:42 +00001832 lt = Qualifiers::OCL_ExplicitNone;
1833 }
1834
1835 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001836 if (!isConsumed) {
1837 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1838 // use objc_storeStrong(&dest, value) for retaining the
1839 // object. But first, store a null into 'dest' because
1840 // objc_storeStrong attempts to release its old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001841 llvm::Value *Null = CGM.EmitNullConstant(D.getType());
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001842 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
John McCall7f416cc2015-09-08 08:05:57 +00001843 EmitARCStoreStrongCall(lv.getAddress(), ArgVal, true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001844 DoStore = false;
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001845 }
1846 else
John McCall31168b02011-06-15 23:02:42 +00001847 // Don't use objc_retainBlock for block pointers, because we
1848 // don't want to Block_copy something just because we got it
1849 // as a parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001850 ArgVal = EmitARCRetainNonBlock(ArgVal);
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001851 }
John McCall31168b02011-06-15 23:02:42 +00001852 } else {
1853 // Push the cleanup for a consumed parameter.
John McCallcdda29c2013-03-13 03:10:54 +00001854 if (isConsumed) {
1855 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
1856 ? ARCPreciseLifetime : ARCImpreciseLifetime);
John McCall7f416cc2015-09-08 08:05:57 +00001857 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal,
John McCallcdda29c2013-03-13 03:10:54 +00001858 precise);
1859 }
John McCall31168b02011-06-15 23:02:42 +00001860
1861 if (lt == Qualifiers::OCL_Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00001862 EmitARCInitWeak(DeclPtr, ArgVal);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001863 DoStore = false; // The weak init is a store, no need to do two.
John McCall31168b02011-06-15 23:02:42 +00001864 }
1865 }
1866
1867 // Enter the cleanup scope.
1868 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
1869 }
Chris Lattner53621a52007-06-13 20:44:40 +00001870 }
1871
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001872 // Store the initial value into the alloca.
1873 if (DoStore)
John McCall7f416cc2015-09-08 08:05:57 +00001874 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001875
John McCall7f416cc2015-09-08 08:05:57 +00001876 setAddrOfLocalVar(&D, DeclPtr);
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001877
1878 // Emit debug info for param declaration.
Alexey Samsonov74a38682012-05-04 07:39:27 +00001879 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001880 if (CGM.getCodeGenOpts().getDebugInfo() >=
1881 codegenoptions::LimitedDebugInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001882 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00001883 }
1884 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001885
1886 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00001887 EmitVarAnnotations(&D, DeclPtr.getPointer());
Chris Lattner53621a52007-06-13 20:44:40 +00001888}
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00001889
Alexey Bataevc5b1d322016-03-04 09:22:22 +00001890void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
1891 CodeGenFunction *CGF) {
1892 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
1893 return;
1894 getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
1895}