blob: 23517867437c7ca3f3cd72fc2f21db9c0000a308 [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
John McCall7f416cc2015-09-08 08:05:57 +000014#include "CGBlocks.h"
Reid Klecknere5a321b2016-09-07 18:21:30 +000015#include "CGCXXABI.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"
Yaxun Liu6d96f1632017-05-18 18:51:09 +000020#include "CodeGenFunction.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Yaxun Liu6d96f1632017-05-18 18:51:09 +000022#include "TargetInfo.h"
Daniel Dunbarad319a72008-08-11 05:00:27 +000023#include "clang/AST/ASTContext.h"
Ken Dyck8c89d592009-12-22 14:23:30 +000024#include "clang/AST/CharUnits.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000025#include "clang/AST/Decl.h"
Anders Carlsson4c03d982008-08-25 01:38:19 +000026#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000027#include "clang/AST/DeclOpenMP.h"
Nate Begemanfaae0812008-04-19 04:17:09 +000028#include "clang/Basic/SourceManager.h"
Chris Lattnerb781dc792008-05-08 05:58:21 +000029#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000030#include "clang/CodeGen/CGFunctionInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000031#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000032#include "llvm/IR/DataLayout.h"
33#include "llvm/IR/GlobalVariable.h"
34#include "llvm/IR/Intrinsics.h"
35#include "llvm/IR/Type.h"
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +000036
Chris Lattner84915fa2007-06-02 04:16:21 +000037using namespace clang;
38using namespace CodeGen;
39
Chris Lattner1ad38f82007-06-09 01:20:56 +000040void CodeGenFunction::EmitDecl(const Decl &D) {
Chris Lattner1ad38f82007-06-09 01:20:56 +000041 switch (D.getKind()) {
David Majnemerd9b1a4f2015-11-04 03:40:30 +000042 case Decl::BuiltinTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000043 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +000044 case Decl::ExternCContext:
Douglas Gregor19043f02010-04-23 02:02:43 +000045 case Decl::Namespace:
46 case Decl::UnresolvedUsingTypename:
47 case Decl::ClassTemplateSpecialization:
48 case Decl::ClassTemplatePartialSpecialization:
Larisse Voufo39a1e502013-08-06 01:03:05 +000049 case Decl::VarTemplateSpecialization:
50 case Decl::VarTemplatePartialSpecialization:
Douglas Gregor19043f02010-04-23 02:02:43 +000051 case Decl::TemplateTypeParm:
52 case Decl::UnresolvedUsingValue:
Alexis Hunted053252010-05-30 07:21:58 +000053 case Decl::NonTypeTemplateParm:
Richard Smithbc491202017-02-17 20:05:37 +000054 case Decl::CXXDeductionGuide:
Douglas Gregor19043f02010-04-23 02:02:43 +000055 case Decl::CXXMethod:
56 case Decl::CXXConstructor:
57 case Decl::CXXDestructor:
58 case Decl::CXXConversion:
59 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +000060 case Decl::MSProperty:
Francois Pichetdf946c32010-11-21 06:49:41 +000061 case Decl::IndirectField:
Douglas Gregor19043f02010-04-23 02:02:43 +000062 case Decl::ObjCIvar:
Eric Christopher31ab1302011-08-23 22:38:00 +000063 case Decl::ObjCAtDefsField:
Chris Lattnerba9dddb2007-10-08 21:37:32 +000064 case Decl::ParmVar:
Douglas Gregor19043f02010-04-23 02:02:43 +000065 case Decl::ImplicitParam:
66 case Decl::ClassTemplate:
Larisse Voufo39a1e502013-08-06 01:03:05 +000067 case Decl::VarTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000068 case Decl::FunctionTemplate:
Richard Smith3f1b5d02011-05-05 21:57:07 +000069 case Decl::TypeAliasTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000070 case Decl::TemplateTemplateParm:
71 case Decl::ObjCMethod:
72 case Decl::ObjCCategory:
73 case Decl::ObjCProtocol:
74 case Decl::ObjCInterface:
75 case Decl::ObjCCategoryImpl:
76 case Decl::ObjCImplementation:
77 case Decl::ObjCProperty:
78 case Decl::ObjCCompatibleAlias:
Nico Weber66220292016-03-02 17:28:48 +000079 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +000080 case Decl::PragmaDetectMismatch:
Abramo Bagnarad7340582010-06-05 05:09:32 +000081 case Decl::AccessSpec:
Douglas Gregor19043f02010-04-23 02:02:43 +000082 case Decl::LinkageSpec:
Richard Smith8df390f2016-09-08 23:14:54 +000083 case Decl::Export:
Douglas Gregor19043f02010-04-23 02:02:43 +000084 case Decl::ObjCPropertyImpl:
Douglas Gregor19043f02010-04-23 02:02:43 +000085 case Decl::FileScopeAsm:
86 case Decl::Friend:
87 case Decl::FriendTemplate:
88 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +000089 case Decl::Captured:
Francois Pichet00c7e6c2011-08-14 03:52:19 +000090 case Decl::ClassScopeFunctionSpecialization:
David Blaikiebd483762013-05-20 04:58:53 +000091 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +000092 case Decl::ConstructorUsingShadow:
Douglas Gregor85f3f952015-07-07 03:57:15 +000093 case Decl::ObjCTypeParam:
Richard Smithda383632016-08-15 01:33:41 +000094 case Decl::Binding:
David Blaikie83d382b2011-09-23 05:06:16 +000095 llvm_unreachable("Declaration should not be in declstmts!");
Amjad Abouddc4531e2016-04-30 01:44:38 +000096 case Decl::Function: // void X();
97 case Decl::Record: // struct/union/class X;
98 case Decl::Enum: // enum X;
99 case Decl::EnumConstant: // enum ? { X = ? }
100 case Decl::CXXRecord: // struct/union/class X; [C++]
Anders Carlssonce2cd012009-12-03 17:26:31 +0000101 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner43e7f312011-02-18 02:08:43 +0000102 case Decl::Label: // __label__ x;
Douglas Gregorba345522011-12-02 23:23:56 +0000103 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +0000104 case Decl::OMPThreadPrivate:
Alexey Bataev4244be22016-02-11 05:35:55 +0000105 case Decl::OMPCapturedExpr:
Michael Han84324352013-02-22 17:15:32 +0000106 case Decl::Empty:
Chris Lattner84915fa2007-06-02 04:16:21 +0000107 // None of these decls require codegen support.
108 return;
David Blaikieb7d1e1f2013-02-02 00:39:32 +0000109
David Blaikief121b932013-05-20 22:50:41 +0000110 case Decl::NamespaceAlias:
111 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000112 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
David Blaikief121b932013-05-20 22:50:41 +0000113 return;
David Blaikiebd483762013-05-20 04:58:53 +0000114 case Decl::Using: // using X; [C++]
115 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000116 DI->EmitUsingDecl(cast<UsingDecl>(D));
David Blaikiebd483762013-05-20 04:58:53 +0000117 return;
Richard Smith151c4562016-12-20 21:35:28 +0000118 case Decl::UsingPack:
119 for (auto *Using : cast<UsingPackDecl>(D).expansions())
120 EmitDecl(*Using);
121 return;
David Blaikie9f88fe82013-04-22 06:13:21 +0000122 case Decl::UsingDirective: // using namespace X; [C++]
123 if (CGDebugInfo *DI = getDebugInfo())
124 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
125 return;
Richard Smithbdb84f32016-07-22 23:36:59 +0000126 case Decl::Var:
127 case Decl::Decomposition: {
Daniel Dunbara7998072008-08-29 17:28:43 +0000128 const VarDecl &VD = cast<VarDecl>(D);
John McCall1c9c3fd2010-10-15 04:57:14 +0000129 assert(VD.isLocalVarDecl() &&
Daniel Dunbara7998072008-08-29 17:28:43 +0000130 "Should not see file-scope variables inside a function!");
Richard Smithda383632016-08-15 01:33:41 +0000131 EmitVarDecl(VD);
132 if (auto *DD = dyn_cast<DecompositionDecl>(&VD))
133 for (auto *B : DD->bindings())
134 if (auto *HD = B->getHoldingVar())
135 EmitVarDecl(*HD);
136 return;
Chris Lattner84915fa2007-06-02 04:16:21 +0000137 }
Mike Stump11289f42009-09-09 15:08:12 +0000138
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000139 case Decl::OMPDeclareReduction:
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000140 return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this);
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000141
Richard Smithdda56e42011-04-15 14:24:37 +0000142 case Decl::Typedef: // typedef int X;
143 case Decl::TypeAlias: { // using X = int; [C++0x]
144 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000145 QualType Ty = TD.getUnderlyingType();
Mike Stump11289f42009-09-09 15:08:12 +0000146
Anders Carlsson5d985f52008-12-20 21:51:53 +0000147 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000148 EmitVariablyModifiedType(Ty);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000149 }
Daniel Dunbara7998072008-08-29 17:28:43 +0000150 }
Chris Lattner84915fa2007-06-02 04:16:21 +0000151}
Chris Lattner03df1222007-06-02 04:53:11 +0000152
John McCall1c9c3fd2010-10-15 04:57:14 +0000153/// EmitVarDecl - This method handles emission of any variable declaration
Chris Lattner03df1222007-06-02 04:53:11 +0000154/// inside a function, including static vars etc.
John McCall1c9c3fd2010-10-15 04:57:14 +0000155void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Yaxun Liu4f33b3d2017-05-15 14:47:47 +0000156 if (D.hasExternalStorage())
157 // Don't emit it now, allow it to be emitted lazily on its first use.
158 return;
159
160 // Some function-scope variable does not have static storage but still
161 // needs to be emitted like a static variable, e.g. a function-scope
162 // variable in constant address space in OpenCL.
163 if (D.getStorageDuration() != SD_Automatic) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000164 llvm::GlobalValue::LinkageTypes Linkage =
David Majnemer27d69db2014-04-28 22:17:59 +0000165 CGM.getLLVMLinkageVarDefinition(&D, /*isConstant=*/false);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000166
David Majnemer27d69db2014-04-28 22:17:59 +0000167 // FIXME: We need to force the emission/use of a guard variable for
168 // some variables even if we can constant-evaluate them because
169 // we can't guarantee every translation unit will constant-evaluate them.
Eric Christopher31ab1302011-08-23 22:38:00 +0000170
John McCall1c9c3fd2010-10-15 04:57:14 +0000171 return EmitStaticVarDecl(D, Linkage);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000172 }
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000173
Anastasia Stulovabcea6962015-09-30 14:08:20 +0000174 if (D.getType().getAddressSpace() == LangAS::opencl_local)
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000175 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
176
177 assert(D.hasLocalStorage());
178 return EmitAutoVarDecl(D);
Chris Lattner03df1222007-06-02 04:53:11 +0000179}
180
Reid Kleckner453e0562014-10-08 01:07:54 +0000181static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) {
182 if (CGM.getLangOpts().CPlusPlus)
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000183 return CGM.getMangledName(&D).str();
184
Reid Kleckner453e0562014-10-08 01:07:54 +0000185 // If this isn't C++, we don't need a mangled name, just a pretty one.
186 assert(!D.isExternallyVisible() && "name shouldn't matter");
187 std::string ContextName;
188 const DeclContext *DC = D.getDeclContext();
Alexey Bataev43f74392015-05-07 06:28:46 +0000189 if (auto *CD = dyn_cast<CapturedDecl>(DC))
190 DC = cast<DeclContext>(CD->getNonClosureContext());
Reid Kleckner453e0562014-10-08 01:07:54 +0000191 if (const auto *FD = dyn_cast<FunctionDecl>(DC))
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000192 ContextName = CGM.getMangledName(FD);
Reid Kleckner453e0562014-10-08 01:07:54 +0000193 else if (const auto *BD = dyn_cast<BlockDecl>(DC))
194 ContextName = CGM.getBlockMangledName(GlobalDecl(), BD);
195 else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC))
196 ContextName = OMD->getSelector().getAsString();
Chris Lattnere99c1102009-12-05 08:22:11 +0000197 else
David Blaikie83d382b2011-09-23 05:06:16 +0000198 llvm_unreachable("Unknown context for static var decl");
Eric Christopher31ab1302011-08-23 22:38:00 +0000199
Reid Kleckner453e0562014-10-08 01:07:54 +0000200 ContextName += "." + D.getNameAsString();
201 return ContextName;
Chris Lattnere99c1102009-12-05 08:22:11 +0000202}
203
Reid Kleckner453e0562014-10-08 01:07:54 +0000204llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl(
205 const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) {
206 // In general, we don't always emit static var decls once before we reference
207 // them. It is possible to reference them before emitting the function that
208 // contains them, and it is possible to emit the containing function multiple
209 // times.
210 if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D])
211 return ExistingGV;
212
Chris Lattnerfc4379f2008-04-06 23:10:54 +0000213 QualType Ty = D.getType();
Eli Friedmana682d392008-02-15 12:20:59 +0000214 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begemanfaae0812008-04-19 04:17:09 +0000215
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000216 // Use the label if the variable is renamed with the asm-label extension.
217 std::string Name;
Benjamin Kramer5642e192011-11-21 15:47:23 +0000218 if (D.hasAttr<AsmLabelAttr>())
Reid Kleckner453e0562014-10-08 01:07:54 +0000219 Name = getMangledName(&D);
Benjamin Kramer5642e192011-11-21 15:47:23 +0000220 else
Reid Kleckner453e0562014-10-08 01:07:54 +0000221 Name = getStaticDeclName(*this, D);
Nate Begemanfaae0812008-04-19 04:17:09 +0000222
Reid Kleckner453e0562014-10-08 01:07:54 +0000223 llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty);
Yaxun Liucbf647c2017-07-08 13:24:52 +0000224 unsigned AS = GetGlobalVarAddressSpace(&D);
225 unsigned TargetAS = getContext().getTargetAddressSpace(AS);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000226
227 // Local address space cannot have an initializer.
228 llvm::Constant *Init = nullptr;
229 if (Ty.getAddressSpace() != LangAS::opencl_local)
230 Init = EmitNullConstant(Ty);
231 else
232 Init = llvm::UndefValue::get(LTy);
233
Yaxun Liucbf647c2017-07-08 13:24:52 +0000234 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
235 getModule(), LTy, Ty.isConstant(getContext()), Linkage, Init, Name,
236 nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS);
Ken Dyck160146e2010-01-27 17:10:57 +0000237 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Reid Kleckner453e0562014-10-08 01:07:54 +0000238 setGlobalVisibility(GV, &D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000239
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +0000240 if (supportsCOMDAT() && GV->isWeakForLinker())
241 GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000242
Richard Smithfd3834f2013-04-13 02:43:54 +0000243 if (D.getTLSKind())
Reid Kleckner453e0562014-10-08 01:07:54 +0000244 setTLSMode(GV, D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000245
Hans Wennborgef2272c2014-06-18 15:55:13 +0000246 if (D.isExternallyVisible()) {
247 if (D.hasAttr<DLLImportAttr>())
248 GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
249 else if (D.hasAttr<DLLExportAttr>())
250 GV->setDLLStorageClass(llvm::GlobalVariable::DLLExportStorageClass);
251 }
252
Eli Benderskycb399432014-03-24 22:05:38 +0000253 // Make sure the result is of the correct type.
Yaxun Liucbf647c2017-07-08 13:24:52 +0000254 unsigned ExpectedAS = Ty.getAddressSpace();
Reid Kleckner453e0562014-10-08 01:07:54 +0000255 llvm::Constant *Addr = GV;
Yaxun Liucbf647c2017-07-08 13:24:52 +0000256 if (AS != ExpectedAS) {
257 Addr = getTargetCodeGenInfo().performAddrSpaceCast(
258 *this, GV, AS, ExpectedAS,
259 LTy->getPointerTo(getContext().getTargetAddressSpace(ExpectedAS)));
Eli Benderskycb399432014-03-24 22:05:38 +0000260 }
261
Reid Kleckner453e0562014-10-08 01:07:54 +0000262 setStaticLocalDeclAddress(&D, Addr);
263
264 // Ensure that the static local gets initialized by making sure the parent
265 // function gets emitted eventually.
266 const Decl *DC = cast<Decl>(D.getDeclContext());
267
268 // We can't name blocks or captured statements directly, so try to emit their
269 // parents.
270 if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) {
271 DC = DC->getNonClosureContext();
272 // FIXME: Ensure that global blocks get emitted.
273 if (!DC)
274 return Addr;
275 }
276
277 GlobalDecl GD;
278 if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC))
279 GD = GlobalDecl(CD, Ctor_Base);
280 else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC))
281 GD = GlobalDecl(DD, Dtor_Base);
282 else if (const auto *FD = dyn_cast<FunctionDecl>(DC))
283 GD = GlobalDecl(FD);
284 else {
285 // Don't do anything for Obj-C method decls or global closures. We should
286 // never defer them.
287 assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl");
288 }
289 if (GD.getDecl())
290 (void)GetAddrOfGlobal(GD);
291
292 return Addr;
Daniel Dunbar22a87f92009-02-25 19:24:29 +0000293}
294
Richard Smith6331c402012-02-13 22:16:19 +0000295/// hasNontrivialDestruction - Determine whether a type's destruction is
296/// non-trivial. If so, and the variable uses static initialization, we must
297/// register its destructor to run on exit.
298static bool hasNontrivialDestruction(QualType T) {
299 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
300 return RD && !RD->hasTrivialDestructor();
301}
302
Chandler Carruth84537952012-03-30 19:44:53 +0000303/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
304/// global variable that has already been created for it. If the initializer
305/// has a different type than GV does, this may free GV and return a different
306/// one. Otherwise it just returns GV.
307llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +0000308CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000309 llvm::GlobalVariable *GV) {
310 llvm::Constant *Init = CGM.EmitConstantInit(D, this);
John McCall70013b62010-07-15 23:40:35 +0000311
Chris Lattnere99c1102009-12-05 08:22:11 +0000312 // If constant emission failed, then this should be a C++ static
313 // initializer.
Chandler Carruth84537952012-03-30 19:44:53 +0000314 if (!Init) {
Richard Smith9c6890a2012-11-01 22:30:59 +0000315 if (!getLangOpts().CPlusPlus)
Chris Lattnere99c1102009-12-05 08:22:11 +0000316 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
Matthias Braun44bfe032017-01-10 17:43:01 +0000317 else if (HaveInsertPoint()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000318 // Since we have a static initializer, this global variable can't
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000319 // be constant.
Chandler Carruth84537952012-03-30 19:44:53 +0000320 GV->setConstant(false);
John McCall68ff0372010-09-08 01:44:27 +0000321
Chandler Carruth84537952012-03-30 19:44:53 +0000322 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000323 }
Chandler Carruth84537952012-03-30 19:44:53 +0000324 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000325 }
John McCall70013b62010-07-15 23:40:35 +0000326
Chris Lattnere99c1102009-12-05 08:22:11 +0000327 // The initializer may differ in type from the global. Rewrite
328 // the global to match the initializer. (We have to do this
329 // because some types, like unions, can't be completely represented
330 // in the LLVM type system.)
Chandler Carruth84537952012-03-30 19:44:53 +0000331 if (GV->getType()->getElementType() != Init->getType()) {
332 llvm::GlobalVariable *OldGV = GV;
333
334 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
335 OldGV->isConstant(),
336 OldGV->getLinkage(), Init, "",
337 /*InsertBefore*/ OldGV,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +0000338 OldGV->getThreadLocalMode(),
Chandler Carruth84537952012-03-30 19:44:53 +0000339 CGM.getContext().getTargetAddressSpace(D.getType()));
340 GV->setVisibility(OldGV->getVisibility());
Reid Klecknereab97d32015-07-20 20:35:30 +0000341 GV->setComdat(OldGV->getComdat());
Eric Christopher31ab1302011-08-23 22:38:00 +0000342
Chris Lattnere99c1102009-12-05 08:22:11 +0000343 // Steal the name of the old global
Chandler Carruth84537952012-03-30 19:44:53 +0000344 GV->takeName(OldGV);
Eric Christopher31ab1302011-08-23 22:38:00 +0000345
Chris Lattnere99c1102009-12-05 08:22:11 +0000346 // Replace all uses of the old global with the new global
Chandler Carruth84537952012-03-30 19:44:53 +0000347 llvm::Constant *NewPtrForOldDecl =
348 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
349 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christopher31ab1302011-08-23 22:38:00 +0000350
Chris Lattnere99c1102009-12-05 08:22:11 +0000351 // Erase the old global, since it is no longer used.
Chandler Carruth84537952012-03-30 19:44:53 +0000352 OldGV->eraseFromParent();
Chris Lattnere99c1102009-12-05 08:22:11 +0000353 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000354
Chandler Carruth84537952012-03-30 19:44:53 +0000355 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
356 GV->setInitializer(Init);
Richard Smith6331c402012-02-13 22:16:19 +0000357
Matthias Braun44bfe032017-01-10 17:43:01 +0000358 if (hasNontrivialDestruction(D.getType()) && HaveInsertPoint()) {
Richard Smith6331c402012-02-13 22:16:19 +0000359 // We have a constant initializer, but a nontrivial destructor. We still
360 // need to perform a guarded "initialization" in order to register the
Richard Smithe070fd22012-02-17 06:48:11 +0000361 // destructor.
Chandler Carruth84537952012-03-30 19:44:53 +0000362 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith6331c402012-02-13 22:16:19 +0000363 }
364
Chandler Carruth84537952012-03-30 19:44:53 +0000365 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000366}
367
John McCall1c9c3fd2010-10-15 04:57:14 +0000368void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000369 llvm::GlobalValue::LinkageTypes Linkage) {
John McCallb88a5662012-03-30 21:00:39 +0000370 // Check to see if we already have a global variable for this
371 // declaration. This can happen when double-emitting function
372 // bodies, e.g. with complete and base constructors.
Reid Kleckner453e0562014-10-08 01:07:54 +0000373 llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage);
John McCall7f416cc2015-09-08 08:05:57 +0000374 CharUnits alignment = getContext().getDeclAlign(&D);
Daniel Dunbara374e602009-02-25 19:45:19 +0000375
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000376 // Store into LocalDeclMap before generating initializer to handle
377 // circular references.
John McCall7f416cc2015-09-08 08:05:57 +0000378 setAddrOfLocalVar(&D, Address(addr, alignment));
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000379
John McCall4a39ab82010-05-04 20:45:42 +0000380 // We can't have a VLA here, but we can have a pointer to a VLA,
381 // even though that doesn't really make any sense.
Eli Friedmanbc633be2009-04-20 03:54:15 +0000382 // Make sure to evaluate VLA bounds now so that we have them for later.
383 if (D.getType()->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000384 EmitVariablyModifiedType(D.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000385
John McCallb88a5662012-03-30 21:00:39 +0000386 // Save the type in case adding the initializer forces a type change.
387 llvm::Type *expectedType = addr->getType();
Eli Friedmanbc633be2009-04-20 03:54:15 +0000388
Eli Benderskycb399432014-03-24 22:05:38 +0000389 llvm::GlobalVariable *var =
390 cast<llvm::GlobalVariable>(addr->stripPointerCasts());
Artem Belevich4d430ba2016-05-09 22:09:56 +0000391
392 // CUDA's local and local static __shared__ variables should not
393 // have any non-empty initializers. This is ensured by Sema.
394 // Whatever initializer such variable may have when it gets here is
395 // a no-op and should not be emitted.
396 bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
397 D.hasAttr<CUDASharedAttr>();
Chris Lattnere99c1102009-12-05 08:22:11 +0000398 // If this value has an initializer, emit it.
Artem Belevich4d430ba2016-05-09 22:09:56 +0000399 if (D.getInit() && !isCudaSharedVar)
John McCallb88a5662012-03-30 21:00:39 +0000400 var = AddInitializerToStaticVarDecl(D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000401
John McCall7f416cc2015-09-08 08:05:57 +0000402 var->setAlignment(alignment.getQuantity());
Chris Lattner4d941092010-03-10 23:59:59 +0000403
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000404 if (D.hasAttr<AnnotateAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000405 CGM.AddGlobalAnnotations(&D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000406
Javed Absar2a67c9e2017-06-05 10:11:57 +0000407 if (auto *SA = D.getAttr<PragmaClangBSSSectionAttr>())
408 var->addAttribute("bss-section", SA->getName());
409 if (auto *SA = D.getAttr<PragmaClangDataSectionAttr>())
410 var->addAttribute("data-section", SA->getName());
411 if (auto *SA = D.getAttr<PragmaClangRodataSectionAttr>())
412 var->addAttribute("rodata-section", SA->getName());
413
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000414 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000415 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000416
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000417 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000418 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000419
Chandler Carruth84537952012-03-30 19:44:53 +0000420 // We may have to cast the constant because of the initializer
421 // mismatch above.
422 //
423 // FIXME: It is really dangerous to store this in the map; if anyone
424 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000425 llvm::Constant *castedAddr =
426 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCall7f416cc2015-09-08 08:05:57 +0000427 if (var != castedAddr)
428 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
John McCallb88a5662012-03-30 21:00:39 +0000429 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000430
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000431 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
Alexey Samsonov4f319cc2014-07-02 16:54:41 +0000432
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000433 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000434 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000435 if (DI &&
Benjamin Kramer8c305922016-02-02 11:06:51 +0000436 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000437 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000438 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000439 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000440}
Mike Stump11289f42009-09-09 15:08:12 +0000441
John McCall2b7fc382010-07-13 20:32:21 +0000442namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000443 struct DestroyObject final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000444 DestroyObject(Address addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000445 CodeGenFunction::Destroyer *destroyer,
446 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000447 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000448 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000449
John McCall7f416cc2015-09-08 08:05:57 +0000450 Address addr;
John McCall82fe67b2011-07-09 01:37:26 +0000451 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000452 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000453 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000454
Craig Topper4f12f102014-03-12 06:41:41 +0000455 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000456 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000457 bool useEHCleanupForArray =
458 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000459
460 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000461 }
462 };
463
David Blaikie7e70d682015-08-18 22:40:54 +0000464 struct DestroyNRVOVariable final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000465 DestroyNRVOVariable(Address addr,
John McCall82fe67b2011-07-09 01:37:26 +0000466 const CXXDestructorDecl *Dtor,
467 llvm::Value *NRVOFlag)
468 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {}
John McCall2b7fc382010-07-13 20:32:21 +0000469
470 const CXXDestructorDecl *Dtor;
471 llvm::Value *NRVOFlag;
John McCall7f416cc2015-09-08 08:05:57 +0000472 Address Loc;
John McCall2b7fc382010-07-13 20:32:21 +0000473
Craig Topper4f12f102014-03-12 06:41:41 +0000474 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000475 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000476 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000477
Craig Topper8a13c412014-05-21 05:09:00 +0000478 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000479 if (NRVO) {
480 // If we exited via NRVO, we skip the destructor call.
481 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
482 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
John McCall7f416cc2015-09-08 08:05:57 +0000483 llvm::Value *DidNRVO =
484 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
John McCall2b7fc382010-07-13 20:32:21 +0000485 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
486 CGF.EmitBlock(RunDtorBB);
487 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000488
John McCall2b7fc382010-07-13 20:32:21 +0000489 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +0000490 /*ForVirtualBase=*/false,
491 /*Delegating=*/false,
492 Loc);
John McCall2b7fc382010-07-13 20:32:21 +0000493
494 if (NRVO) CGF.EmitBlock(SkipDtorBB);
495 }
496 };
John McCall2b7fc382010-07-13 20:32:21 +0000497
David Blaikie7e70d682015-08-18 22:40:54 +0000498 struct CallStackRestore final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000499 Address Stack;
500 CallStackRestore(Address Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000501 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000502 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
John McCalla464ff92010-07-21 06:13:08 +0000503 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
504 CGF.Builder.CreateCall(F, V);
505 }
506 };
507
David Blaikie7e70d682015-08-18 22:40:54 +0000508 struct ExtendGCLifetime final : EHScopeStack::Cleanup {
John McCall1bd25562011-06-24 23:21:27 +0000509 const VarDecl &Var;
510 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
511
Craig Topper4f12f102014-03-12 06:41:41 +0000512 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000513 // Compute the address of the local variable, in case it's a
514 // byref or something.
John McCall113bee02012-03-10 09:33:50 +0000515 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
516 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000517 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
518 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000519 CGF.EmitExtendGCLifetime(value);
520 }
521 };
522
David Blaikie7e70d682015-08-18 22:40:54 +0000523 struct CallCleanupFunction final : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000524 llvm::Constant *CleanupFn;
525 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000526 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000527
John McCalla464ff92010-07-21 06:13:08 +0000528 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000529 const VarDecl *Var)
530 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000531
Craig Topper4f12f102014-03-12 06:41:41 +0000532 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall113bee02012-03-10 09:33:50 +0000533 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false,
534 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000535 // Compute the address of the local variable, in case it's a byref
536 // or something.
John McCall7f416cc2015-09-08 08:05:57 +0000537 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer();
John McCallc533cb72011-02-22 06:44:22 +0000538
John McCalla464ff92010-07-21 06:13:08 +0000539 // In some cases, the type of the function argument will be different from
540 // the type of the pointer. An example of this is
541 // void f(void* arg);
542 // __attribute__((cleanup(f))) void *g;
543 //
544 // To fix this we insert a bitcast here.
545 QualType ArgTy = FnInfo.arg_begin()->type;
546 llvm::Value *Arg =
547 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
548
549 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000550 Args.add(RValue::get(Arg),
551 CGF.getContext().getPointerType(Var.getType()));
John McCallb92ab1a2016-10-26 23:46:34 +0000552 auto Callee = CGCallee::forDirect(CleanupFn);
553 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
John McCalla464ff92010-07-21 06:13:08 +0000554 }
555 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000556} // end anonymous namespace
John McCalla464ff92010-07-21 06:13:08 +0000557
John McCall31168b02011-06-15 23:02:42 +0000558/// EmitAutoVarWithLifetime - Does the setup required for an automatic
559/// variable with lifetime.
560static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
John McCall7f416cc2015-09-08 08:05:57 +0000561 Address addr,
John McCall31168b02011-06-15 23:02:42 +0000562 Qualifiers::ObjCLifetime lifetime) {
563 switch (lifetime) {
564 case Qualifiers::OCL_None:
565 llvm_unreachable("present but none");
566
567 case Qualifiers::OCL_ExplicitNone:
568 // nothing to do
569 break;
570
571 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000572 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000573 (var.hasAttr<ObjCPreciseLifetimeAttr>()
574 ? CodeGenFunction::destroyARCStrongPrecise
575 : CodeGenFunction::destroyARCStrongImprecise);
576
577 CleanupKind cleanupKind = CGF.getARCCleanupKind();
578 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
579 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000580 break;
581 }
582 case Qualifiers::OCL_Autoreleasing:
583 // nothing to do
584 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000585
John McCall31168b02011-06-15 23:02:42 +0000586 case Qualifiers::OCL_Weak:
587 // __weak objects always get EH cleanups; otherwise, exceptions
588 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000589 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
590 CodeGenFunction::destroyARCWeak,
591 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000592 break;
593 }
594}
595
596static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
597 if (const Expr *e = dyn_cast<Expr>(s)) {
598 // Skip the most common kinds of expressions that make
599 // hierarchy-walking expensive.
600 s = e = e->IgnoreParenCasts();
601
602 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
603 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000604 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
605 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000606 for (const auto &I : block->captures()) {
607 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000608 return true;
609 }
610 }
John McCall31168b02011-06-15 23:02:42 +0000611 }
612
Benjamin Kramer642f1732015-07-02 21:03:14 +0000613 for (const Stmt *SubStmt : s->children())
614 // SubStmt might be null; as in missing decl or conditional of an if-stmt.
615 if (SubStmt && isAccessedBy(var, SubStmt))
John McCall31168b02011-06-15 23:02:42 +0000616 return true;
617
618 return false;
619}
620
621static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
622 if (!decl) return false;
623 if (!isa<VarDecl>(decl)) return false;
624 const VarDecl *var = cast<VarDecl>(decl);
625 return isAccessedBy(*var, e);
626}
627
John McCallf8a9b662015-10-21 18:06:31 +0000628static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
629 const LValue &destLV, const Expr *init) {
John McCall0204e342015-11-16 22:11:41 +0000630 bool needsCast = false;
631
John McCallf8a9b662015-10-21 18:06:31 +0000632 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
633 switch (castExpr->getCastKind()) {
634 // Look through casts that don't require representation changes.
635 case CK_NoOp:
636 case CK_BitCast:
637 case CK_BlockPointerToObjCPointerCast:
John McCall0204e342015-11-16 22:11:41 +0000638 needsCast = true;
John McCallf8a9b662015-10-21 18:06:31 +0000639 break;
640
641 // If we find an l-value to r-value cast from a __weak variable,
642 // emit this operation as a copy or move.
643 case CK_LValueToRValue: {
644 const Expr *srcExpr = castExpr->getSubExpr();
645 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
646 return false;
647
648 // Emit the source l-value.
649 LValue srcLV = CGF.EmitLValue(srcExpr);
650
John McCall0204e342015-11-16 22:11:41 +0000651 // Handle a formal type change to avoid asserting.
652 auto srcAddr = srcLV.getAddress();
653 if (needsCast) {
654 srcAddr = CGF.Builder.CreateElementBitCast(srcAddr,
655 destLV.getAddress().getElementType());
656 }
657
John McCallf8a9b662015-10-21 18:06:31 +0000658 // If it was an l-value, use objc_copyWeak.
659 if (srcExpr->getValueKind() == VK_LValue) {
John McCall0204e342015-11-16 22:11:41 +0000660 CGF.EmitARCCopyWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000661 } else {
662 assert(srcExpr->getValueKind() == VK_XValue);
John McCall0204e342015-11-16 22:11:41 +0000663 CGF.EmitARCMoveWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000664 }
665 return true;
666 }
667
668 // Stop at anything else.
669 default:
670 return false;
671 }
672
673 init = castExpr->getSubExpr();
John McCallf8a9b662015-10-21 18:06:31 +0000674 }
675 return false;
676}
677
John McCall1553b192011-06-16 04:16:24 +0000678static void drillIntoBlockVariable(CodeGenFunction &CGF,
679 LValue &lvalue,
680 const VarDecl *var) {
John McCall7f416cc2015-09-08 08:05:57 +0000681 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(), var));
John McCall1553b192011-06-16 04:16:24 +0000682}
683
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000684void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS,
685 SourceLocation Loc) {
686 if (!SanOpts.has(SanitizerKind::NullabilityAssign))
687 return;
688
689 auto Nullability = LHS.getType()->getNullability(getContext());
690 if (!Nullability || *Nullability != NullabilityKind::NonNull)
691 return;
692
693 // Check if the right hand side of the assignment is nonnull, if the left
694 // hand side must be nonnull.
695 SanitizerScope SanScope(this);
696 llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS);
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000697 llvm::Constant *StaticData[] = {
698 EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()),
Simon Pilgrim2df19982017-03-14 21:43:52 +0000699 llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000700 llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)};
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000701 EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}},
702 SanitizerHandler::TypeMismatch, StaticData, RHS);
703}
704
David Blaikie73ca5692014-12-09 00:32:22 +0000705void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +0000706 LValue lvalue, bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000707 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000708 if (!lifetime) {
709 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000710 if (capturedByInit)
711 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000712 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
David Blaikie66e41972015-01-14 07:38:27 +0000713 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000714 return;
715 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000716
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000717 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
718 init = DIE->getExpr();
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000719
John McCall31168b02011-06-15 23:02:42 +0000720 // If we're emitting a value with lifetime, we have to do the
721 // initialization *before* we leave the cleanup scopes.
John McCall08ef4662011-11-10 08:15:53 +0000722 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init)) {
723 enterFullExpression(ewc);
John McCall31168b02011-06-15 23:02:42 +0000724 init = ewc->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000725 }
726 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000727
728 // We have to maintain the illusion that the variable is
729 // zero-initialized. If the variable might be accessed in its
730 // initializer, zero-initialize before running the initializer, then
731 // actually perform the initialization with an assign.
732 bool accessedByInit = false;
733 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000734 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000735 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000736 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000737 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000738 if (capturedByInit) {
739 // We can use a simple GEP for this because it can't have been
740 // moved yet.
John McCall7f416cc2015-09-08 08:05:57 +0000741 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(),
742 cast<VarDecl>(D),
743 /*follow*/ false));
John McCall31168b02011-06-15 23:02:42 +0000744 }
745
John McCall7f416cc2015-09-08 08:05:57 +0000746 auto ty = cast<llvm::PointerType>(tempLV.getAddress().getElementType());
Yaxun Liu402804b2016-12-15 08:09:08 +0000747 llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000748
John McCall31168b02011-06-15 23:02:42 +0000749 // If __weak, we want to use a barrier under certain conditions.
750 if (lifetime == Qualifiers::OCL_Weak)
John McCall1553b192011-06-16 04:16:24 +0000751 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCall31168b02011-06-15 23:02:42 +0000752
753 // Otherwise just do a simple store.
754 else
David Chisnallfa35df62012-01-16 17:27:18 +0000755 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000756 }
757
758 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000759 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000760
761 switch (lifetime) {
762 case Qualifiers::OCL_None:
763 llvm_unreachable("present but none");
764
765 case Qualifiers::OCL_ExplicitNone:
John McCalle399e5b2016-01-27 18:32:30 +0000766 value = EmitARCUnsafeUnretainedScalarExpr(init);
John McCall31168b02011-06-15 23:02:42 +0000767 break;
768
769 case Qualifiers::OCL_Strong: {
770 value = EmitARCRetainScalarExpr(init);
771 break;
772 }
773
774 case Qualifiers::OCL_Weak: {
John McCallf8a9b662015-10-21 18:06:31 +0000775 // If it's not accessed by the initializer, try to emit the
776 // initialization with a copy or move.
777 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
778 return;
779 }
780
John McCall31168b02011-06-15 23:02:42 +0000781 // No way to optimize a producing initializer into this. It's not
782 // worth optimizing for, because the value will immediately
783 // disappear in the common case.
784 value = EmitScalarExpr(init);
785
John McCall1553b192011-06-16 04:16:24 +0000786 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000787 if (accessedByInit)
John McCall1553b192011-06-16 04:16:24 +0000788 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000789 else
John McCall1553b192011-06-16 04:16:24 +0000790 EmitARCInitWeak(lvalue.getAddress(), value);
John McCall31168b02011-06-15 23:02:42 +0000791 return;
792 }
793
794 case Qualifiers::OCL_Autoreleasing:
795 value = EmitARCRetainAutoreleaseScalarExpr(init);
796 break;
797 }
798
John McCall1553b192011-06-16 04:16:24 +0000799 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000800
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000801 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
802
John McCall31168b02011-06-15 23:02:42 +0000803 // If the variable might have been accessed by its initializer, we
804 // might have to initialize with a barrier. We have to do this for
805 // both __weak and __strong, but __weak got filtered out above.
806 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000807 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000808 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000809 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000810 return;
811 }
812
David Chisnallfa35df62012-01-16 17:27:18 +0000813 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000814}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000815
816/// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the
817/// non-zero parts of the specified initializer with equal or fewer than
818/// NumStores scalar stores.
819static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init,
820 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000821 // Zero and Undef never requires any extra stores.
822 if (isa<llvm::ConstantAggregateZero>(Init) ||
823 isa<llvm::ConstantPointerNull>(Init) ||
824 isa<llvm::UndefValue>(Init))
825 return true;
826 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
827 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
828 isa<llvm::ConstantExpr>(Init))
829 return Init->isNullValue() || NumStores--;
830
831 // See if we can emit each element.
832 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
833 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
834 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
835 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
836 return false;
837 }
838 return true;
839 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000840
Chris Lattner236b3572012-01-31 04:36:19 +0000841 if (llvm::ConstantDataSequential *CDS =
842 dyn_cast<llvm::ConstantDataSequential>(Init)) {
843 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
844 llvm::Constant *Elt = CDS->getElementAsConstant(i);
845 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores))
846 return false;
847 }
848 return true;
849 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000850
Chris Lattnerb85025f2010-12-01 02:05:19 +0000851 // Anything else is hard and scary.
852 return false;
853}
854
855/// emitStoresForInitAfterMemset - For inits that
856/// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar
857/// stores that would be required.
858static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc,
John McCallc533cb72011-02-22 06:44:22 +0000859 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000860 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
861 "called emitStoresForInitAfterMemset for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000862
Chris Lattnere6af8862010-12-02 01:58:41 +0000863 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
864 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
865 isa<llvm::ConstantExpr>(Init)) {
John McCall7f416cc2015-09-08 08:05:57 +0000866 Builder.CreateDefaultAlignedStore(Init, Loc, isVolatile);
Chris Lattner236b3572012-01-31 04:36:19 +0000867 return;
868 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000869
870 if (llvm::ConstantDataSequential *CDS =
871 dyn_cast<llvm::ConstantDataSequential>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000872 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
873 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000874
875 // If necessary, get a pointer to the element and emit it.
876 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
David Blaikie17ea2662015-04-04 21:07:17 +0000877 emitStoresForInitAfterMemset(
878 Elt, Builder.CreateConstGEP2_32(Init->getType(), Loc, 0, i),
879 isVolatile, Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000880 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000881 return;
882 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000883
Chris Lattnere6af8862010-12-02 01:58:41 +0000884 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
885 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000886
Chris Lattnere6af8862010-12-02 01:58:41 +0000887 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
888 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000889
890 // If necessary, get a pointer to the element and emit it.
891 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
David Blaikie17ea2662015-04-04 21:07:17 +0000892 emitStoresForInitAfterMemset(
893 Elt, Builder.CreateConstGEP2_32(Init->getType(), Loc, 0, i),
894 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000895 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000896}
897
Chris Lattnerb85025f2010-12-01 02:05:19 +0000898/// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset
899/// plus some stores to initialize a local variable instead of using a memcpy
900/// from a constant global. It is beneficial to use memset if the global is all
901/// zeros, or mostly zeros and large.
902static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init,
903 uint64_t GlobalSize) {
904 // If a global is all zeros, always use a memset.
905 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
906
Chris Lattnerb85025f2010-12-01 02:05:19 +0000907 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
908 // do it if it will require 6 or fewer scalar stores.
909 // TODO: Should budget depends on the size? Avoiding a large global warrants
910 // plopping in more stores.
911 unsigned StoreBudget = 6;
912 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000913
914 return GlobalSize > SizeLimit &&
Chris Lattnerb85025f2010-12-01 02:05:19 +0000915 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget);
916}
917
Nick Lewycky8a7d90b2010-12-30 20:21:55 +0000918/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +0000919/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +0000920/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +0000921void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
922 AutoVarEmission emission = EmitAutoVarAlloca(D);
923 EmitAutoVarInit(emission);
924 EmitAutoVarCleanups(emission);
925}
Chris Lattner03df1222007-06-02 04:53:11 +0000926
David Majnemerdc012fa2015-04-22 21:38:15 +0000927/// Emit a lifetime.begin marker if some criteria are satisfied.
928/// \return a pointer to the temporary size Value if a marker was emitted, null
929/// otherwise
930llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
931 llvm::Value *Addr) {
Vitaly Buka1c943322016-10-26 01:59:57 +0000932 if (!ShouldEmitLifetimeMarkers)
Reid Kleckner1ef49212015-04-23 18:07:13 +0000933 return nullptr;
934
David Majnemerdc012fa2015-04-22 21:38:15 +0000935 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
Yaxun Liu7f7f3232017-04-17 20:03:11 +0000936 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +0000937 llvm::CallInst *C =
938 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +0000939 C->setDoesNotThrow();
940 return SizeV;
941}
942
943void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
Yaxun Liu7f7f3232017-04-17 20:03:11 +0000944 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +0000945 llvm::CallInst *C =
946 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +0000947 C->setDoesNotThrow();
948}
949
John McCallc533cb72011-02-22 06:44:22 +0000950/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000951/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +0000952CodeGenFunction::AutoVarEmission
953CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
954 QualType Ty = D.getType();
Yaxun Liu84744c12017-06-19 17:03:41 +0000955 assert(Ty.getAddressSpace() == LangAS::Default);
John McCallc533cb72011-02-22 06:44:22 +0000956
957 AutoVarEmission emission(D);
958
959 bool isByRef = D.hasAttr<BlocksAttr>();
960 emission.IsByRef = isByRef;
961
962 CharUnits alignment = getContext().getDeclAlign(&D);
John McCallc533cb72011-02-22 06:44:22 +0000963
John McCall23c29fe2011-06-24 21:55:10 +0000964 // If the type is variably-modified, emit all the VLA sizes for it.
965 if (Ty->isVariablyModifiedType())
966 EmitVariablyModifiedType(Ty);
967
John McCall7f416cc2015-09-08 08:05:57 +0000968 Address address = Address::invalid();
Eli Friedmana682d392008-02-15 12:20:59 +0000969 if (Ty->isConstantSizeType()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +0000970 bool NRVO = getLangOpts().ElideConstructors &&
971 D.isNRVOVariable();
John McCallc533cb72011-02-22 06:44:22 +0000972
Richard Smith2bcde3a2013-06-02 00:09:52 +0000973 // If this value is an array or struct with a statically determinable
974 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +0000975 //
976 // TODO: We should constant-evaluate the initializer of any variable,
977 // as long as it is initialized by a constant expression. Currently,
978 // isConstantInitializer produces wrong answers for structs with
979 // reference or bitfield members, and a few other cases, and checking
980 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +0000981 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
982 (D.isConstexpr() ||
983 ((Ty.isPODType(getContext()) ||
984 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
985 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +0000986
Rafael Espindola609f5d92013-03-26 18:41:47 +0000987 // If the variable's a const type, and it's neither an NRVO
988 // candidate nor a __block variable and has no mutable members,
989 // emit it as a global instead.
Anastasia Stulovae4a1c382016-11-29 17:01:19 +0000990 // Exception is if a variable is located in non-constant address space
991 // in OpenCL.
992 if ((!getLangOpts().OpenCL ||
993 Ty.getAddressSpace() == LangAS::opencl_constant) &&
994 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO && !isByRef &&
995 CGM.isTypeConstant(Ty, true))) {
Rafael Espindola609f5d92013-03-26 18:41:47 +0000996 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +0000997
John McCall7f416cc2015-09-08 08:05:57 +0000998 // Signal this condition to later callbacks.
999 emission.Addr = Address::invalid();
Rafael Espindola609f5d92013-03-26 18:41:47 +00001000 assert(emission.wasEmittedAsGlobal());
1001 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +00001002 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001003
Rafael Espindola609f5d92013-03-26 18:41:47 +00001004 // Otherwise, tell the initialization code that we're in this case.
1005 emission.IsConstantAggregate = true;
1006 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001007
Rafael Espindola609f5d92013-03-26 18:41:47 +00001008 // A normal fixed sized variable becomes an alloca in the entry block,
1009 // unless it's an NRVO variable.
Eric Christopher31ab1302011-08-23 22:38:00 +00001010
Rafael Espindola609f5d92013-03-26 18:41:47 +00001011 if (NRVO) {
1012 // The named return value optimization: allocate this variable in the
1013 // return slot, so that we can elide the copy when returning this
1014 // variable (C++0x [class.copy]p34).
John McCall7f416cc2015-09-08 08:05:57 +00001015 address = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +00001016
Rafael Espindola609f5d92013-03-26 18:41:47 +00001017 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
1018 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) {
1019 // Create a flag that is used to indicate when the NRVO was applied
1020 // to this variable. Set it to zero to indicate that NRVO was not
1021 // applied.
1022 llvm::Value *Zero = Builder.getFalse();
John McCall7f416cc2015-09-08 08:05:57 +00001023 Address NRVOFlag =
1024 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
Rafael Espindola609f5d92013-03-26 18:41:47 +00001025 EnsureInsertPoint();
1026 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +00001027
Rafael Espindola609f5d92013-03-26 18:41:47 +00001028 // Record the NRVO flag for this variable.
John McCall7f416cc2015-09-08 08:05:57 +00001029 NRVOFlags[&D] = NRVOFlag.getPointer();
1030 emission.NRVOFlag = NRVOFlag.getPointer();
Nadav Rotem1da30942013-03-23 06:43:35 +00001031 }
Douglas Gregor290c93e2010-05-15 06:46:45 +00001032 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001033 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001034 CharUnits allocaAlignment;
1035 llvm::Type *allocaTy;
1036 if (isByRef) {
1037 auto &byrefInfo = getBlockByrefInfo(&D);
1038 allocaTy = byrefInfo.Type;
1039 allocaAlignment = byrefInfo.ByrefAlignment;
1040 } else {
1041 allocaTy = ConvertTypeForMem(Ty);
1042 allocaAlignment = alignment;
1043 }
Rafael Espindola609f5d92013-03-26 18:41:47 +00001044
John McCall999110f2015-09-08 09:18:30 +00001045 // Create the alloca. Note that we set the name separately from
1046 // building the instruction so that it's there even in no-asserts
1047 // builds.
Yaxun Liu84744c12017-06-19 17:03:41 +00001048 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName());
Rafael Espindola609f5d92013-03-26 18:41:47 +00001049
Reid Kleckner1f88e932015-10-07 21:03:41 +00001050 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1051 // the catch parameter starts in the catchpad instruction, and we can't
1052 // insert code in those basic blocks.
1053 bool IsMSCatchParam =
1054 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1055
Vitaly Buka64c80b42016-10-26 05:42:30 +00001056 // Emit a lifetime intrinsic if meaningful. There's no point in doing this
1057 // if we don't have a valid insertion point (?).
Reid Kleckner1f88e932015-10-07 21:03:41 +00001058 if (HaveInsertPoint() && !IsMSCatchParam) {
Akira Hatanakafdcd18b2017-01-25 22:55:13 +00001059 // If there's a jump into the lifetime of this variable, its lifetime
1060 // gets broken up into several regions in IR, which requires more work
1061 // to handle correctly. For now, just omit the intrinsics; this is a
1062 // rare case, and it's better to just be conservatively correct.
1063 // PR28267.
1064 //
1065 // We have to do this in all language modes if there's a jump past the
1066 // declaration. We also have to do it in C if there's a jump to an
1067 // earlier point in the current block because non-VLA lifetimes begin as
1068 // soon as the containing block is entered, not when its variables
1069 // actually come into scope; suppressing the lifetime annotations
1070 // completely in this case is unnecessarily pessimistic, but again, this
1071 // is rare.
1072 if (!Bypasses.IsBypassed(&D) &&
1073 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) {
Vitaly Buka64c80b42016-10-26 05:42:30 +00001074 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1075 emission.SizeForLifetimeMarkers =
1076 EmitLifetimeStart(size, address.getPointer());
1077 }
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001078 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001079 assert(!emission.useLifetimeMarkers());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001080 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001081 }
Chris Lattner03df1222007-06-02 04:53:11 +00001082 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001083 EnsureInsertPoint();
1084
Anders Carlsson15949b32009-02-09 20:41:50 +00001085 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +00001086 // Save the stack.
John McCall7f416cc2015-09-08 08:05:57 +00001087 Address Stack =
1088 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +00001089
Anders Carlsson30032882008-12-12 07:38:43 +00001090 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie4ba525b2015-07-14 17:27:39 +00001091 llvm::Value *V = Builder.CreateCall(F);
Anders Carlsson30032882008-12-12 07:38:43 +00001092 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +00001093
1094 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +00001095
John McCalla464ff92010-07-21 06:13:08 +00001096 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +00001097 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001098 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +00001099 }
Mike Stump11289f42009-09-09 15:08:12 +00001100
John McCall23c29fe2011-06-24 21:55:10 +00001101 llvm::Value *elementCount;
1102 QualType elementType;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001103 std::tie(elementCount, elementType) = getVLASize(Ty);
Anders Carlsson30032882008-12-12 07:38:43 +00001104
Chris Lattner2192fe52011-07-18 04:24:23 +00001105 llvm::Type *llvmTy = ConvertTypeForMem(elementType);
Anders Carlsson30032882008-12-12 07:38:43 +00001106
1107 // Allocate memory for the array.
Yaxun Liu84744c12017-06-19 17:03:41 +00001108 address = CreateTempAlloca(llvmTy, alignment, "vla", elementCount);
Chris Lattner03df1222007-06-02 04:53:11 +00001109 }
Eli Friedmanf4084702008-12-20 23:11:59 +00001110
John McCall7f416cc2015-09-08 08:05:57 +00001111 setAddrOfLocalVar(&D, address);
1112 emission.Addr = address;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001113
1114 // Emit debug info for local var declaration.
Devang Patel887e2152011-06-03 19:21:47 +00001115 if (HaveInsertPoint())
1116 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001117 if (CGM.getCodeGenOpts().getDebugInfo() >=
1118 codegenoptions::LimitedDebugInfo) {
Alexey Samsonov74a38682012-05-04 07:39:27 +00001119 DI->setLocation(D.getLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001120 DI->EmitDeclareOfAutoVariable(&D, address.getPointer(), Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00001121 }
Devang Patel887e2152011-06-03 19:21:47 +00001122 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001123
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001124 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00001125 EmitVarAnnotations(&D, address.getPointer());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001126
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001127 // Make sure we call @llvm.lifetime.end.
1128 if (emission.useLifetimeMarkers())
1129 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker,
1130 emission.getAllocatedAddress(),
1131 emission.getSizeForLifetimeMarkers());
1132
John McCallc533cb72011-02-22 06:44:22 +00001133 return emission;
1134}
1135
1136/// Determines whether the given __block variable is potentially
1137/// captured by the given expression.
1138static bool isCapturedBy(const VarDecl &var, const Expr *e) {
1139 // Skip the most common kinds of expressions that make
1140 // hierarchy-walking expensive.
1141 e = e->IgnoreParenCasts();
1142
1143 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
1144 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +00001145 for (const auto &I : block->captures()) {
1146 if (I.getVariable() == &var)
John McCallc533cb72011-02-22 06:44:22 +00001147 return true;
1148 }
1149
1150 // No need to walk into the subexpressions.
1151 return false;
1152 }
1153
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001154 if (const StmtExpr *SE = dyn_cast<StmtExpr>(e)) {
1155 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001156 for (const auto *BI : CS->body())
1157 if (const auto *E = dyn_cast<Expr>(BI)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001158 if (isCapturedBy(var, E))
1159 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001160 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001161 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001162 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001163 for (const auto *I : DS->decls()) {
1164 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1165 const Expr *Init = VD->getInit();
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001166 if (Init && isCapturedBy(var, Init))
1167 return true;
1168 }
1169 }
1170 }
1171 else
1172 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1173 // Later, provide code to poke into statements for capture analysis.
1174 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001175 return false;
1176 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001177
Benjamin Kramer642f1732015-07-02 21:03:14 +00001178 for (const Stmt *SubStmt : e->children())
1179 if (isCapturedBy(var, cast<Expr>(SubStmt)))
John McCallc533cb72011-02-22 06:44:22 +00001180 return true;
1181
1182 return false;
1183}
1184
Douglas Gregor82e1af22011-07-01 21:08:19 +00001185/// \brief Determine whether the given initializer is trivial in the sense
1186/// that it requires no code to be generated.
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001187bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
Douglas Gregor82e1af22011-07-01 21:08:19 +00001188 if (!Init)
1189 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001190
Douglas Gregor82e1af22011-07-01 21:08:19 +00001191 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1192 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1193 if (Constructor->isTrivial() &&
1194 Constructor->isDefaultConstructor() &&
1195 !Construct->requiresZeroInitialization())
1196 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001197
Douglas Gregor82e1af22011-07-01 21:08:19 +00001198 return false;
1199}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001200
John McCallc533cb72011-02-22 06:44:22 +00001201void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001202 assert(emission.Variable && "emission was not valid!");
1203
John McCallc533cb72011-02-22 06:44:22 +00001204 // If this was emitted as a global constant, we're done.
1205 if (emission.wasEmittedAsGlobal()) return;
1206
John McCall9e2e22f2011-02-22 07:16:58 +00001207 const VarDecl &D = *emission.Variable;
Adrian Prantl95b24e92015-02-03 20:00:54 +00001208 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
John McCallc533cb72011-02-22 06:44:22 +00001209 QualType type = D.getType();
1210
Chris Lattner07eb7332007-07-12 00:39:48 +00001211 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001212 const Expr *Init = D.getInit();
1213
1214 // If we are at an unreachable point, we don't need to emit the initializer
1215 // unless it contains a label.
1216 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001217 if (!Init || !ContainsLabel(Init)) return;
1218 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001219 }
1220
John McCall73064872011-03-31 01:59:53 +00001221 // Initialize the structure of a __block variable.
1222 if (emission.IsByRef)
1223 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001224
Douglas Gregor82e1af22011-07-01 21:08:19 +00001225 if (isTrivialInitializer(Init))
1226 return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001227
John McCallc533cb72011-02-22 06:44:22 +00001228 // Check whether this is a byref variable that's potentially
1229 // captured and moved by its own initializer. If so, we'll need to
1230 // emit the initializer first, then copy into the variable.
1231 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init);
1232
John McCall7f416cc2015-09-08 08:05:57 +00001233 Address Loc =
1234 capturedByInit ? emission.Addr : emission.getObjectAddress(*this);
John McCallc533cb72011-02-22 06:44:22 +00001235
Craig Topper8a13c412014-05-21 05:09:00 +00001236 llvm::Constant *constant = nullptr;
Richard Smith2bcde3a2013-06-02 00:09:52 +00001237 if (emission.IsConstantAggregate || D.isConstexpr()) {
Richard Smithfddd3842011-12-30 21:15:51 +00001238 assert(!capturedByInit && "constant init contains a capturing block?");
Richard Smithdafff942012-01-14 04:30:29 +00001239 constant = CGM.EmitConstantInit(D, this);
Richard Smithfddd3842011-12-30 21:15:51 +00001240 }
1241
1242 if (!constant) {
John McCall7f416cc2015-09-08 08:05:57 +00001243 LValue lv = MakeAddrLValue(Loc, type);
John McCall1553b192011-06-16 04:16:24 +00001244 lv.setNonGC(true);
David Blaikie66e41972015-01-14 07:38:27 +00001245 return EmitExprAsInit(Init, &D, lv, capturedByInit);
John McCall1553b192011-06-16 04:16:24 +00001246 }
John McCall91ca10f2011-03-08 09:11:50 +00001247
Richard Smith2bcde3a2013-06-02 00:09:52 +00001248 if (!emission.IsConstantAggregate) {
1249 // For simple scalar/complex initialization, store the value directly.
John McCall7f416cc2015-09-08 08:05:57 +00001250 LValue lv = MakeAddrLValue(Loc, type);
Richard Smith2bcde3a2013-06-02 00:09:52 +00001251 lv.setNonGC(true);
1252 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1253 }
1254
John McCallc533cb72011-02-22 06:44:22 +00001255 // If this is a simple aggregate initialization, we can optimize it
1256 // in various ways.
John McCall91ca10f2011-03-08 09:11:50 +00001257 bool isVolatile = type.isVolatileQualified();
John McCallc533cb72011-02-22 06:44:22 +00001258
John McCall91ca10f2011-03-08 09:11:50 +00001259 llvm::Value *SizeVal =
Eric Christopher31ab1302011-08-23 22:38:00 +00001260 llvm::ConstantInt::get(IntPtrTy,
John McCall91ca10f2011-03-08 09:11:50 +00001261 getContext().getTypeSizeInChars(type).getQuantity());
John McCallc533cb72011-02-22 06:44:22 +00001262
Chris Lattner2192fe52011-07-18 04:24:23 +00001263 llvm::Type *BP = Int8PtrTy;
John McCall7f416cc2015-09-08 08:05:57 +00001264 if (Loc.getType() != BP)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001265 Loc = Builder.CreateBitCast(Loc, BP);
Mon P Wangcc2ab0c2010-04-04 03:10:52 +00001266
John McCall91ca10f2011-03-08 09:11:50 +00001267 // If the initializer is all or mostly zeros, codegen with memset then do
1268 // a few stores afterward.
Eric Christopher31ab1302011-08-23 22:38:00 +00001269 if (shouldUseMemSetPlusStoresToInitialize(constant,
Micah Villmowdd31ca12012-10-08 16:25:52 +00001270 CGM.getDataLayout().getTypeAllocSize(constant->getType()))) {
John McCall91ca10f2011-03-08 09:11:50 +00001271 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
John McCall7f416cc2015-09-08 08:05:57 +00001272 isVolatile);
Benjamin Kramer29f9a002012-08-27 22:07:02 +00001273 // Zero and undef don't require a stores.
1274 if (!constant->isNullValue() && !isa<llvm::UndefValue>(constant)) {
John McCall91ca10f2011-03-08 09:11:50 +00001275 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00001276 emitStoresForInitAfterMemset(constant, Loc.getPointer(),
1277 isVolatile, Builder);
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001278 }
John McCall91ca10f2011-03-08 09:11:50 +00001279 } else {
Eric Christopher31ab1302011-08-23 22:38:00 +00001280 // Otherwise, create a temporary global with the initializer then
John McCall91ca10f2011-03-08 09:11:50 +00001281 // memcpy from the global to the alloca.
Reid Kleckner453e0562014-10-08 01:07:54 +00001282 std::string Name = getStaticDeclName(CGM, D);
Alexey Baderabdcfc12016-10-31 10:26:31 +00001283 unsigned AS = 0;
1284 if (getLangOpts().OpenCL) {
1285 AS = CGM.getContext().getTargetAddressSpace(LangAS::opencl_constant);
1286 BP = llvm::PointerType::getInt8PtrTy(getLLVMContext(), AS);
1287 }
John McCall91ca10f2011-03-08 09:11:50 +00001288 llvm::GlobalVariable *GV =
1289 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true,
Eric Christopherb58b3e82011-08-24 00:33:55 +00001290 llvm::GlobalValue::PrivateLinkage,
Alexey Baderabdcfc12016-10-31 10:26:31 +00001291 constant, Name, nullptr,
1292 llvm::GlobalValue::NotThreadLocal, AS);
John McCall7f416cc2015-09-08 08:05:57 +00001293 GV->setAlignment(Loc.getAlignment().getQuantity());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001294 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Eric Christopher31ab1302011-08-23 22:38:00 +00001295
John McCall7f416cc2015-09-08 08:05:57 +00001296 Address SrcPtr = Address(GV, Loc.getAlignment());
1297 if (SrcPtr.getType() != BP)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001298 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
John McCall91ca10f2011-03-08 09:11:50 +00001299
John McCall7f416cc2015-09-08 08:05:57 +00001300 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, isVolatile);
John McCall91ca10f2011-03-08 09:11:50 +00001301 }
1302}
1303
1304/// Emit an expression as an initializer for a variable at the given
1305/// location. The expression is not necessarily the normal
1306/// initializer for the variable, and the address is not necessarily
1307/// its normal location.
1308///
1309/// \param init the initializing expression
1310/// \param var the variable to act as if we're initializing
1311/// \param loc the address to initialize; its type is a pointer
1312/// to the LLVM mapping of the variable's type
1313/// \param alignment the alignment of the address
1314/// \param capturedByInit true if the variable is a __block variable
1315/// whose address is potentially changed by the initializer
David Blaikie73ca5692014-12-09 00:32:22 +00001316void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +00001317 LValue lvalue, bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001318 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001319
1320 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001321 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001322 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001323 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001324 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001325 return;
1326 }
1327 switch (getEvaluationKind(type)) {
1328 case TEK_Scalar:
David Blaikie66e41972015-01-14 07:38:27 +00001329 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001330 return;
1331 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001332 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001333 if (capturedByInit)
1334 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001335 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
John McCall47fb9502013-03-07 21:37:08 +00001336 return;
1337 }
1338 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001339 if (type->isAtomicType()) {
1340 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1341 } else {
1342 // TODO: how can we delay here if D is captured by its initializer?
1343 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001344 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001345 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001346 AggValueSlot::IsNotAliased));
John McCalla8ec7eb2013-03-07 21:37:17 +00001347 }
John McCall47fb9502013-03-07 21:37:08 +00001348 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001349 }
John McCall47fb9502013-03-07 21:37:08 +00001350 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001351}
John McCallbd309292010-07-06 01:34:17 +00001352
John McCall82fe67b2011-07-09 01:37:26 +00001353/// Enter a destroy cleanup for the given local variable.
1354void CodeGenFunction::emitAutoVarTypeCleanup(
1355 const CodeGenFunction::AutoVarEmission &emission,
1356 QualType::DestructionKind dtorKind) {
1357 assert(dtorKind != QualType::DK_none);
1358
1359 // Note that for __block variables, we want to destroy the
1360 // original stack object, not the possibly forwarded object.
John McCall7f416cc2015-09-08 08:05:57 +00001361 Address addr = emission.getObjectAddress(*this);
John McCall82fe67b2011-07-09 01:37:26 +00001362
1363 const VarDecl *var = emission.Variable;
1364 QualType type = var->getType();
1365
1366 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001367 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001368
1369 switch (dtorKind) {
1370 case QualType::DK_none:
1371 llvm_unreachable("no cleanup for trivially-destructible variable");
1372
1373 case QualType::DK_cxx_destructor:
1374 // If there's an NRVO flag on the emission, we need a different
1375 // cleanup.
1376 if (emission.NRVOFlag) {
1377 assert(!type->isArrayType());
1378 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
John McCall7f416cc2015-09-08 08:05:57 +00001379 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr,
1380 dtor, emission.NRVOFlag);
John McCall82fe67b2011-07-09 01:37:26 +00001381 return;
1382 }
1383 break;
1384
1385 case QualType::DK_objc_strong_lifetime:
1386 // Suppress cleanups for pseudo-strong variables.
1387 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001388
John McCall82fe67b2011-07-09 01:37:26 +00001389 // Otherwise, consider whether to use an EH cleanup or not.
1390 cleanupKind = getARCCleanupKind();
1391
1392 // Use the imprecise destroyer by default.
1393 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1394 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1395 break;
1396
1397 case QualType::DK_objc_weak_lifetime:
1398 break;
1399 }
1400
1401 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001402 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001403
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001404 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001405 // is being pushed as an EH cleanup.
1406 bool useEHCleanup = (cleanupKind & EHCleanup);
1407 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1408 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001409}
1410
John McCallc533cb72011-02-22 06:44:22 +00001411void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001412 assert(emission.Variable && "emission was not valid!");
1413
John McCallc533cb72011-02-22 06:44:22 +00001414 // If this was emitted as a global constant, we're done.
1415 if (emission.wasEmittedAsGlobal()) return;
1416
John McCall8c38d352012-04-13 18:44:05 +00001417 // If we don't have an insertion point, we're done. Sema prevents
1418 // us from jumping into any of these scopes anyway.
1419 if (!HaveInsertPoint()) return;
1420
John McCall9e2e22f2011-02-22 07:16:58 +00001421 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001422
John McCall82fe67b2011-07-09 01:37:26 +00001423 // Check the type for a cleanup.
1424 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1425 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001426
John McCall1bd25562011-06-24 23:21:27 +00001427 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001428 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001429 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1430 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1431 }
1432
John McCallc533cb72011-02-22 06:44:22 +00001433 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001434 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001435 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00001436
John McCallc533cb72011-02-22 06:44:22 +00001437 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001438 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00001439
John McCalla729c622012-02-17 03:33:10 +00001440 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00001441 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001442 }
Mike Stump626aecc2009-03-05 01:23:13 +00001443
John McCallc533cb72011-02-22 06:44:22 +00001444 // If this is a block variable, call _Block_object_destroy
1445 // (on the unforwarded address).
John McCall73064872011-03-31 01:59:53 +00001446 if (emission.IsByRef)
1447 enterByrefCleanup(emission);
Chris Lattner03df1222007-06-02 04:53:11 +00001448}
Chris Lattner53621a52007-06-13 20:44:40 +00001449
Peter Collingbourne1425b452012-01-26 03:33:36 +00001450CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00001451CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
1452 switch (kind) {
1453 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00001454 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001455 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00001456 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001457 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00001458 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00001459 return destroyARCWeak;
John McCall82fe67b2011-07-09 01:37:26 +00001460 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00001461 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00001462}
1463
John McCall12cc42a2013-02-01 05:11:40 +00001464/// pushEHDestroy - Push the standard destructor for the given type as
1465/// an EH-only cleanup.
1466void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001467 Address addr, QualType type) {
John McCall12cc42a2013-02-01 05:11:40 +00001468 assert(dtorKind && "cannot push destructor for trivial type");
1469 assert(needsEHCleanup(dtorKind));
1470
1471 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
1472}
1473
1474/// pushDestroy - Push the standard destructor for the given type as
1475/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00001476void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00001477 Address addr, QualType type) {
John McCall4bd0fb12011-07-12 16:41:08 +00001478 assert(dtorKind && "cannot push destructor for trivial type");
1479
1480 CleanupKind cleanupKind = getCleanupKind(dtorKind);
1481 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
1482 cleanupKind & EHCleanup);
1483}
1484
John McCall7f416cc2015-09-08 08:05:57 +00001485void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001486 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001487 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00001488 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
1489 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001490}
1491
John McCall7f416cc2015-09-08 08:05:57 +00001492void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001493 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
1494}
1495
Richard Smith736a9472013-06-12 20:42:33 +00001496void CodeGenFunction::pushLifetimeExtendedDestroy(
John McCall7f416cc2015-09-08 08:05:57 +00001497 CleanupKind cleanupKind, Address addr, QualType type,
Richard Smith736a9472013-06-12 20:42:33 +00001498 Destroyer *destroyer, bool useEHCleanupForArray) {
1499 assert(!isInConditionalBranch() &&
1500 "performing lifetime extension from within conditional");
1501
1502 // Push an EH-only cleanup for the object now.
1503 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
1504 // around in case a temporary's destructor throws an exception.
1505 if (cleanupKind & EHCleanup)
1506 EHStack.pushCleanup<DestroyObject>(
1507 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
1508 destroyer, useEHCleanupForArray);
1509
1510 // Remember that we need to push a full cleanup for the object at the
1511 // end of the full-expression.
1512 pushCleanupAfterFullExpr<DestroyObject>(
1513 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
1514}
1515
John McCall178360e2011-07-11 08:38:19 +00001516/// emitDestroy - Immediately perform the destruction of the given
1517/// object.
1518///
1519/// \param addr - the address of the object; a type*
1520/// \param type - the type of the object; if an array type, all
1521/// objects are destroyed in reverse order
1522/// \param destroyer - the function to call to destroy individual
1523/// elements
1524/// \param useEHCleanupForArray - whether an EH cleanup should be
1525/// used when destroying array elements, in case one of the
1526/// destructions throws an exception
John McCall7f416cc2015-09-08 08:05:57 +00001527void CodeGenFunction::emitDestroy(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001528 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001529 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00001530 const ArrayType *arrayType = getContext().getAsArrayType(type);
1531 if (!arrayType)
1532 return destroyer(*this, addr, type);
1533
John McCall7f416cc2015-09-08 08:05:57 +00001534 llvm::Value *length = emitArrayLength(arrayType, type, addr);
1535
1536 CharUnits elementAlign =
1537 addr.getAlignment()
1538 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
John McCall97eab0a2011-07-13 08:09:46 +00001539
1540 // Normally we have to check whether the array is zero-length.
1541 bool checkZeroLength = true;
1542
1543 // But if the array length is constant, we can suppress that.
1544 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
1545 // ...and if it's constant zero, we can just skip the entire thing.
1546 if (constLength->isZero()) return;
1547 checkZeroLength = false;
1548 }
1549
John McCall7f416cc2015-09-08 08:05:57 +00001550 llvm::Value *begin = addr.getPointer();
John McCall82fe67b2011-07-09 01:37:26 +00001551 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall7f416cc2015-09-08 08:05:57 +00001552 emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001553 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001554}
1555
John McCall178360e2011-07-11 08:38:19 +00001556/// emitArrayDestroy - Destroys all the elements of the given array,
1557/// beginning from last to first. The array cannot be zero-length.
1558///
1559/// \param begin - a type* denoting the first element of the array
1560/// \param end - a type* denoting one past the end of the array
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00001561/// \param elementType - the element type of the array
John McCall178360e2011-07-11 08:38:19 +00001562/// \param destroyer - the function to call to destroy elements
1563/// \param useEHCleanup - whether to push an EH cleanup to destroy
1564/// the remaining elements in case the destruction of a single
1565/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00001566void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
1567 llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001568 QualType elementType,
1569 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001570 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001571 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00001572 bool useEHCleanup) {
John McCall7f416cc2015-09-08 08:05:57 +00001573 assert(!elementType->isArrayType());
John McCall82fe67b2011-07-09 01:37:26 +00001574
1575 // The basic structure here is a do-while loop, because we don't
1576 // need to check for the zero-element case.
1577 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
1578 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
1579
John McCall97eab0a2011-07-13 08:09:46 +00001580 if (checkZeroLength) {
1581 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
1582 "arraydestroy.isempty");
1583 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
1584 }
1585
John McCall82fe67b2011-07-09 01:37:26 +00001586 // Enter the loop body, making that address the current address.
1587 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
1588 EmitBlock(bodyBB);
1589 llvm::PHINode *elementPast =
1590 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
1591 elementPast->addIncoming(end, entryBB);
1592
1593 // Shift the address back by one element.
1594 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
1595 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
1596 "arraydestroy.element");
1597
John McCall178360e2011-07-11 08:38:19 +00001598 if (useEHCleanup)
John McCall7f416cc2015-09-08 08:05:57 +00001599 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
1600 destroyer);
John McCall178360e2011-07-11 08:38:19 +00001601
John McCall82fe67b2011-07-09 01:37:26 +00001602 // Perform the actual destruction there.
John McCall7f416cc2015-09-08 08:05:57 +00001603 destroyer(*this, Address(element, elementAlign), elementType);
John McCall82fe67b2011-07-09 01:37:26 +00001604
John McCall178360e2011-07-11 08:38:19 +00001605 if (useEHCleanup)
1606 PopCleanupBlock();
1607
John McCall82fe67b2011-07-09 01:37:26 +00001608 // Check whether we've reached the end.
1609 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
1610 Builder.CreateCondBr(done, doneBB, bodyBB);
1611 elementPast->addIncoming(element, Builder.GetInsertBlock());
1612
1613 // Done.
1614 EmitBlock(doneBB);
1615}
1616
John McCall178360e2011-07-11 08:38:19 +00001617/// Perform partial array destruction as if in an EH cleanup. Unlike
1618/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00001619static void emitPartialArrayDestroy(CodeGenFunction &CGF,
1620 llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00001621 QualType type, CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001622 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00001623 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00001624 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00001625 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
1626 // VLAs don't require a GEP index to walk into.
1627 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00001628 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00001629 type = arrayType->getElementType();
1630 }
John McCall97eab0a2011-07-13 08:09:46 +00001631
1632 if (arrayDepth) {
John McCallf0f0b7a2015-09-14 18:57:08 +00001633 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
John McCall97eab0a2011-07-13 08:09:46 +00001634
John McCallf0f0b7a2015-09-14 18:57:08 +00001635 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
Jay Foad040dd822011-07-22 08:16:57 +00001636 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
1637 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00001638 }
1639
John McCall97eab0a2011-07-13 08:09:46 +00001640 // Destroy the array. We don't ever need an EH cleanup because we
1641 // assume that we're in an EH cleanup ourselves, so a throwing
1642 // destructor causes an immediate terminate.
John McCall7f416cc2015-09-08 08:05:57 +00001643 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001644 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00001645}
1646
John McCall82fe67b2011-07-09 01:37:26 +00001647namespace {
John McCall178360e2011-07-11 08:38:19 +00001648 /// RegularPartialArrayDestroy - a cleanup which performs a partial
1649 /// array destroy where the end pointer is regularly determined and
1650 /// does not need to be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00001651 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall178360e2011-07-11 08:38:19 +00001652 llvm::Value *ArrayBegin;
1653 llvm::Value *ArrayEnd;
1654 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001655 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00001656 CharUnits ElementAlign;
John McCall178360e2011-07-11 08:38:19 +00001657 public:
1658 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001659 QualType elementType, CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00001660 CodeGenFunction::Destroyer *destroyer)
1661 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
John McCall7f416cc2015-09-08 08:05:57 +00001662 ElementType(elementType), Destroyer(destroyer),
1663 ElementAlign(elementAlign) {}
John McCall178360e2011-07-11 08:38:19 +00001664
Craig Topper4f12f102014-03-12 06:41:41 +00001665 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00001666 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001667 ElementType, ElementAlign, Destroyer);
John McCall178360e2011-07-11 08:38:19 +00001668 }
1669 };
1670
1671 /// IrregularPartialArrayDestroy - a cleanup which performs a
1672 /// partial array destroy where the end pointer is irregularly
1673 /// determined and must be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00001674 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00001675 llvm::Value *ArrayBegin;
John McCall7f416cc2015-09-08 08:05:57 +00001676 Address ArrayEndPointer;
John McCall82fe67b2011-07-09 01:37:26 +00001677 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001678 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00001679 CharUnits ElementAlign;
John McCall82fe67b2011-07-09 01:37:26 +00001680 public:
John McCall178360e2011-07-11 08:38:19 +00001681 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001682 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001683 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001684 CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00001685 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00001686 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
John McCall7f416cc2015-09-08 08:05:57 +00001687 ElementType(elementType), Destroyer(destroyer),
1688 ElementAlign(elementAlign) {}
John McCall82fe67b2011-07-09 01:37:26 +00001689
Craig Topper4f12f102014-03-12 06:41:41 +00001690 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00001691 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00001692 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001693 ElementType, ElementAlign, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001694 }
1695 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001696} // end anonymous namespace
John McCall82fe67b2011-07-09 01:37:26 +00001697
John McCall178360e2011-07-11 08:38:19 +00001698/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00001699/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00001700/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00001701///
John McCall82fe67b2011-07-09 01:37:26 +00001702/// \param elementType - the immediate element type of the array;
1703/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00001704void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00001705 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00001706 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001707 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001708 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00001709 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
1710 arrayBegin, arrayEndPointer,
John McCall7f416cc2015-09-08 08:05:57 +00001711 elementType, elementAlign,
1712 destroyer);
John McCall178360e2011-07-11 08:38:19 +00001713}
1714
1715/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
1716/// already-constructed elements of the given array. The cleanup
1717/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00001718///
John McCall178360e2011-07-11 08:38:19 +00001719/// \param elementType - the immediate element type of the array;
1720/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00001721void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1722 llvm::Value *arrayEnd,
1723 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00001724 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001725 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00001726 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00001727 arrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00001728 elementType, elementAlign,
1729 destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001730}
1731
Nadav Rotem1da30942013-03-23 06:43:35 +00001732/// Lazily declare the @llvm.lifetime.start intrinsic.
1733llvm::Constant *CodeGenModule::getLLVMLifetimeStartFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00001734 if (LifetimeStartFn)
1735 return LifetimeStartFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00001736 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001737 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00001738 return LifetimeStartFn;
1739}
1740
1741/// Lazily declare the @llvm.lifetime.end intrinsic.
1742llvm::Constant *CodeGenModule::getLLVMLifetimeEndFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00001743 if (LifetimeEndFn)
1744 return LifetimeEndFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00001745 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001746 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00001747 return LifetimeEndFn;
1748}
1749
John McCall31168b02011-06-15 23:02:42 +00001750namespace {
1751 /// A cleanup to perform a release of an object at the end of a
1752 /// function. This is used to balance out the incoming +1 of a
1753 /// ns_consumed argument when we can't reasonably do that just by
1754 /// not doing the initial retain for a __block argument.
David Blaikie7e70d682015-08-18 22:40:54 +00001755 struct ConsumeARCParameter final : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00001756 ConsumeARCParameter(llvm::Value *param,
1757 ARCPreciseLifetime_t precise)
1758 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00001759
1760 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00001761 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00001762
Craig Topper4f12f102014-03-12 06:41:41 +00001763 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00001764 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00001765 }
1766 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001767} // end anonymous namespace
John McCall31168b02011-06-15 23:02:42 +00001768
Mike Stump11289f42009-09-09 15:08:12 +00001769/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00001770/// for the specified parameter and set up LocalDeclMap.
John McCall7f416cc2015-09-08 08:05:57 +00001771void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
1772 unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001773 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00001774 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001775 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00001776
John McCall7f416cc2015-09-08 08:05:57 +00001777 Arg.getAnyValue()->setName(D.getName());
John McCall147d0212011-02-22 22:38:33 +00001778
Adrian Prantl51936dd2013-03-14 17:53:33 +00001779 QualType Ty = D.getType();
1780
John McCall147d0212011-02-22 22:38:33 +00001781 // Use better IR generation for certain implicit parameters.
John McCall7f416cc2015-09-08 08:05:57 +00001782 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
John McCall147d0212011-02-22 22:38:33 +00001783 // The only implicit argument a block has is its literal.
John McCall7f416cc2015-09-08 08:05:57 +00001784 // We assume this is always passed directly.
John McCall147d0212011-02-22 22:38:33 +00001785 if (BlockInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001786 setBlockContextParameter(IPD, ArgNo, Arg.getDirectValue());
John McCall147d0212011-02-22 22:38:33 +00001787 return;
1788 }
Reid Klecknere5a321b2016-09-07 18:21:30 +00001789
1790 // Apply any prologue 'this' adjustments required by the ABI. Be careful to
1791 // handle the case where 'this' is passed indirectly as part of an inalloca
1792 // struct.
1793 if (const CXXMethodDecl *MD =
1794 dyn_cast_or_null<CXXMethodDecl>(CurCodeDecl)) {
1795 if (MD->isVirtual() && IPD == CXXABIThisDecl) {
1796 llvm::Value *This = Arg.isIndirect()
1797 ? Builder.CreateLoad(Arg.getIndirectAddress())
1798 : Arg.getDirectValue();
1799 This = CGM.getCXXABI().adjustThisParameterInVirtualFunctionPrologue(
1800 *this, CurGD, This);
1801 if (Arg.isIndirect())
1802 Builder.CreateStore(This, Arg.getIndirectAddress());
1803 else
1804 Arg = ParamValue::forDirect(This);
1805 }
1806 }
John McCall147d0212011-02-22 22:38:33 +00001807 }
1808
John McCall7f416cc2015-09-08 08:05:57 +00001809 Address DeclPtr = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001810 bool DoStore = false;
1811 bool IsScalar = hasScalarEvaluationKind(Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001812 // If we already have a pointer to the argument, reuse the input pointer.
John McCall7f416cc2015-09-08 08:05:57 +00001813 if (Arg.isIndirect()) {
1814 DeclPtr = Arg.getIndirectAddress();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00001815 // If we have a prettier pointer type at this point, bitcast to that.
John McCall7f416cc2015-09-08 08:05:57 +00001816 unsigned AS = DeclPtr.getType()->getAddressSpace();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00001817 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
John McCall7f416cc2015-09-08 08:05:57 +00001818 if (DeclPtr.getType() != IRTy)
1819 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
1820
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00001821 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner19819442014-07-25 21:39:46 +00001822 // Don't push a cleanup in a thunk for a method that will also emit a
1823 // cleanup.
1824 if (!IsScalar && !CurFuncIsThunk &&
Reid Kleckner739756c2013-12-04 19:23:12 +00001825 getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001826 const CXXRecordDecl *RD = Ty->getAsCXXRecordDecl();
1827 if (RD && RD->hasNonTrivialDestructor())
1828 pushDestroy(QualType::DK_cxx_destructor, DeclPtr, Ty);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00001829 }
Chris Lattner53621a52007-06-13 20:44:40 +00001830 } else {
Daniel Dunbar3d33fab2010-02-08 22:53:07 +00001831 // Otherwise, create a temporary to hold the value.
John McCall7f416cc2015-09-08 08:05:57 +00001832 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D),
1833 D.getName() + ".addr");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001834 DoStore = true;
1835 }
Mike Stump11289f42009-09-09 15:08:12 +00001836
John McCall7f416cc2015-09-08 08:05:57 +00001837 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr);
1838
1839 LValue lv = MakeAddrLValue(DeclPtr, Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001840 if (IsScalar) {
John McCall31168b02011-06-15 23:02:42 +00001841 Qualifiers qs = Ty.getQualifiers();
John McCall31168b02011-06-15 23:02:42 +00001842 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
1843 // We honor __attribute__((ns_consumed)) for types with lifetime.
1844 // For __strong, it's handled by just skipping the initial retain;
1845 // otherwise we have to balance out the initial +1 with an extra
1846 // cleanup to do the release at the end of the function.
1847 bool isConsumed = D.hasAttr<NSConsumedAttr>();
1848
1849 // 'self' is always formally __strong, but if this is not an
1850 // init method then we don't want to retain it.
John McCalld4631322011-06-17 06:42:21 +00001851 if (D.isARCPseudoStrong()) {
John McCall31168b02011-06-15 23:02:42 +00001852 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl);
1853 assert(&D == method->getSelfDecl());
John McCalld4631322011-06-17 06:42:21 +00001854 assert(lt == Qualifiers::OCL_Strong);
1855 assert(qs.hasConst());
John McCall31168b02011-06-15 23:02:42 +00001856 assert(method->getMethodFamily() != OMF_init);
John McCall10123692011-06-15 23:40:09 +00001857 (void) method;
John McCall31168b02011-06-15 23:02:42 +00001858 lt = Qualifiers::OCL_ExplicitNone;
1859 }
1860
Saleem Abdulrasoolda6784e2017-06-27 18:37:51 +00001861 // Load objects passed indirectly.
1862 if (Arg.isIndirect() && !ArgVal)
1863 ArgVal = Builder.CreateLoad(DeclPtr);
1864
John McCall31168b02011-06-15 23:02:42 +00001865 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001866 if (!isConsumed) {
1867 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1868 // use objc_storeStrong(&dest, value) for retaining the
1869 // object. But first, store a null into 'dest' because
1870 // objc_storeStrong attempts to release its old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00001871 llvm::Value *Null = CGM.EmitNullConstant(D.getType());
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001872 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
John McCall7f416cc2015-09-08 08:05:57 +00001873 EmitARCStoreStrongCall(lv.getAddress(), ArgVal, true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001874 DoStore = false;
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001875 }
1876 else
John McCall31168b02011-06-15 23:02:42 +00001877 // Don't use objc_retainBlock for block pointers, because we
1878 // don't want to Block_copy something just because we got it
1879 // as a parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001880 ArgVal = EmitARCRetainNonBlock(ArgVal);
Fariborz Jahanian134cec62013-02-21 00:40:10 +00001881 }
John McCall31168b02011-06-15 23:02:42 +00001882 } else {
1883 // Push the cleanup for a consumed parameter.
John McCallcdda29c2013-03-13 03:10:54 +00001884 if (isConsumed) {
1885 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
1886 ? ARCPreciseLifetime : ARCImpreciseLifetime);
John McCall7f416cc2015-09-08 08:05:57 +00001887 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal,
John McCallcdda29c2013-03-13 03:10:54 +00001888 precise);
1889 }
John McCall31168b02011-06-15 23:02:42 +00001890
1891 if (lt == Qualifiers::OCL_Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00001892 EmitARCInitWeak(DeclPtr, ArgVal);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001893 DoStore = false; // The weak init is a store, no need to do two.
John McCall31168b02011-06-15 23:02:42 +00001894 }
1895 }
1896
1897 // Enter the cleanup scope.
1898 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
1899 }
Chris Lattner53621a52007-06-13 20:44:40 +00001900 }
1901
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001902 // Store the initial value into the alloca.
1903 if (DoStore)
John McCall7f416cc2015-09-08 08:05:57 +00001904 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001905
John McCall7f416cc2015-09-08 08:05:57 +00001906 setAddrOfLocalVar(&D, DeclPtr);
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001907
1908 // Emit debug info for param declaration.
Alexey Samsonov74a38682012-05-04 07:39:27 +00001909 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001910 if (CGM.getCodeGenOpts().getDebugInfo() >=
1911 codegenoptions::LimitedDebugInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00001912 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00001913 }
1914 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001915
1916 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00001917 EmitVarAnnotations(&D, DeclPtr.getPointer());
Vedant Kumar42c17ec2017-03-14 01:56:34 +00001918
1919 // We can only check return value nullability if all arguments to the
1920 // function satisfy their nullability preconditions. This makes it necessary
1921 // to emit null checks for args in the function body itself.
1922 if (requiresReturnValueNullabilityCheck()) {
1923 auto Nullability = Ty->getNullability(getContext());
1924 if (Nullability && *Nullability == NullabilityKind::NonNull) {
1925 SanitizerScope SanScope(this);
1926 RetValNullabilityPrecondition =
1927 Builder.CreateAnd(RetValNullabilityPrecondition,
1928 Builder.CreateIsNotNull(Arg.getAnyValue()));
1929 }
1930 }
Chris Lattner53621a52007-06-13 20:44:40 +00001931}
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00001932
Alexey Bataevc5b1d322016-03-04 09:22:22 +00001933void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
1934 CodeGenFunction *CGF) {
1935 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
1936 return;
1937 getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
1938}