blob: 91b0c970625f83c7d5407767494582e44bf4fdf7 [file] [log] [blame]
Chris Lattner84915fa2007-06-02 04:16:21 +00001//===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattner84915fa2007-06-02 04:16:21 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This contains code to emit Decl nodes as LLVM code.
10//
11//===----------------------------------------------------------------------===//
12
John McCall7f416cc2015-09-08 08:05:57 +000013#include "CGBlocks.h"
Reid Klecknere5a321b2016-09-07 18:21:30 +000014#include "CGCXXABI.h"
David Majnemerdc012fa2015-04-22 21:38:15 +000015#include "CGCleanup.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000016#include "CGDebugInfo.h"
Peter Collingbourne2dbb7082011-09-19 21:14:35 +000017#include "CGOpenCLRuntime.h"
Alexey Bataevc5b1d322016-03-04 09:22:22 +000018#include "CGOpenMPRuntime.h"
Yaxun Liu6d96f1632017-05-18 18:51:09 +000019#include "CodeGenFunction.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "CodeGenModule.h"
John McCallde0fe072017-08-15 21:42:52 +000021#include "ConstantEmitter.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"
Richard Trieu63688182018-12-11 03:18:39 +000028#include "clang/Basic/CodeGenOptions.h"
Nate Begemanfaae0812008-04-19 04:17:09 +000029#include "clang/Basic/SourceManager.h"
Chris Lattnerb781dc792008-05-08 05:58:21 +000030#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000031#include "clang/CodeGen/CGFunctionInfo.h"
JF Bastien2f0582f2018-09-21 13:54:09 +000032#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/DataLayout.h"
34#include "llvm/IR/GlobalVariable.h"
35#include "llvm/IR/Intrinsics.h"
36#include "llvm/IR/Type.h"
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +000037
Chris Lattner84915fa2007-06-02 04:16:21 +000038using namespace clang;
39using namespace CodeGen;
40
Chris Lattner1ad38f82007-06-09 01:20:56 +000041void CodeGenFunction::EmitDecl(const Decl &D) {
Chris Lattner1ad38f82007-06-09 01:20:56 +000042 switch (D.getKind()) {
David Majnemerd9b1a4f2015-11-04 03:40:30 +000043 case Decl::BuiltinTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000044 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +000045 case Decl::ExternCContext:
Douglas Gregor19043f02010-04-23 02:02:43 +000046 case Decl::Namespace:
47 case Decl::UnresolvedUsingTypename:
48 case Decl::ClassTemplateSpecialization:
49 case Decl::ClassTemplatePartialSpecialization:
Larisse Voufo39a1e502013-08-06 01:03:05 +000050 case Decl::VarTemplateSpecialization:
51 case Decl::VarTemplatePartialSpecialization:
Douglas Gregor19043f02010-04-23 02:02:43 +000052 case Decl::TemplateTypeParm:
53 case Decl::UnresolvedUsingValue:
Alexis Hunted053252010-05-30 07:21:58 +000054 case Decl::NonTypeTemplateParm:
Richard Smithbc491202017-02-17 20:05:37 +000055 case Decl::CXXDeductionGuide:
Douglas Gregor19043f02010-04-23 02:02:43 +000056 case Decl::CXXMethod:
57 case Decl::CXXConstructor:
58 case Decl::CXXDestructor:
59 case Decl::CXXConversion:
60 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +000061 case Decl::MSProperty:
Francois Pichetdf946c32010-11-21 06:49:41 +000062 case Decl::IndirectField:
Douglas Gregor19043f02010-04-23 02:02:43 +000063 case Decl::ObjCIvar:
Eric Christopher31ab1302011-08-23 22:38:00 +000064 case Decl::ObjCAtDefsField:
Chris Lattnerba9dddb2007-10-08 21:37:32 +000065 case Decl::ParmVar:
Douglas Gregor19043f02010-04-23 02:02:43 +000066 case Decl::ImplicitParam:
67 case Decl::ClassTemplate:
Larisse Voufo39a1e502013-08-06 01:03:05 +000068 case Decl::VarTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000069 case Decl::FunctionTemplate:
Richard Smith3f1b5d02011-05-05 21:57:07 +000070 case Decl::TypeAliasTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000071 case Decl::TemplateTemplateParm:
72 case Decl::ObjCMethod:
73 case Decl::ObjCCategory:
74 case Decl::ObjCProtocol:
75 case Decl::ObjCInterface:
76 case Decl::ObjCCategoryImpl:
77 case Decl::ObjCImplementation:
78 case Decl::ObjCProperty:
79 case Decl::ObjCCompatibleAlias:
Nico Weber66220292016-03-02 17:28:48 +000080 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +000081 case Decl::PragmaDetectMismatch:
Abramo Bagnarad7340582010-06-05 05:09:32 +000082 case Decl::AccessSpec:
Douglas Gregor19043f02010-04-23 02:02:43 +000083 case Decl::LinkageSpec:
Richard Smith8df390f2016-09-08 23:14:54 +000084 case Decl::Export:
Douglas Gregor19043f02010-04-23 02:02:43 +000085 case Decl::ObjCPropertyImpl:
Douglas Gregor19043f02010-04-23 02:02:43 +000086 case Decl::FileScopeAsm:
87 case Decl::Friend:
88 case Decl::FriendTemplate:
89 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +000090 case Decl::Captured:
Francois Pichet00c7e6c2011-08-14 03:52:19 +000091 case Decl::ClassScopeFunctionSpecialization:
David Blaikiebd483762013-05-20 04:58:53 +000092 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +000093 case Decl::ConstructorUsingShadow:
Douglas Gregor85f3f952015-07-07 03:57:15 +000094 case Decl::ObjCTypeParam:
Richard Smithda383632016-08-15 01:33:41 +000095 case Decl::Binding:
David Blaikie83d382b2011-09-23 05:06:16 +000096 llvm_unreachable("Declaration should not be in declstmts!");
Amjad Abouddc4531e2016-04-30 01:44:38 +000097 case Decl::Function: // void X();
98 case Decl::Record: // struct/union/class X;
99 case Decl::Enum: // enum X;
100 case Decl::EnumConstant: // enum ? { X = ? }
101 case Decl::CXXRecord: // struct/union/class X; [C++]
Anders Carlssonce2cd012009-12-03 17:26:31 +0000102 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner43e7f312011-02-18 02:08:43 +0000103 case Decl::Label: // __label__ x;
Douglas Gregorba345522011-12-02 23:23:56 +0000104 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +0000105 case Decl::OMPThreadPrivate:
Alexey Bataev4244be22016-02-11 05:35:55 +0000106 case Decl::OMPCapturedExpr:
Kelvin Li1408f912018-09-26 04:28:39 +0000107 case Decl::OMPRequires:
Michael Han84324352013-02-22 17:15:32 +0000108 case Decl::Empty:
Chris Lattner84915fa2007-06-02 04:16:21 +0000109 // None of these decls require codegen support.
110 return;
David Blaikieb7d1e1f2013-02-02 00:39:32 +0000111
David Blaikief121b932013-05-20 22:50:41 +0000112 case Decl::NamespaceAlias:
113 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000114 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
David Blaikief121b932013-05-20 22:50:41 +0000115 return;
David Blaikiebd483762013-05-20 04:58:53 +0000116 case Decl::Using: // using X; [C++]
117 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000118 DI->EmitUsingDecl(cast<UsingDecl>(D));
David Blaikiebd483762013-05-20 04:58:53 +0000119 return;
Richard Smith151c4562016-12-20 21:35:28 +0000120 case Decl::UsingPack:
121 for (auto *Using : cast<UsingPackDecl>(D).expansions())
122 EmitDecl(*Using);
123 return;
David Blaikie9f88fe82013-04-22 06:13:21 +0000124 case Decl::UsingDirective: // using namespace X; [C++]
125 if (CGDebugInfo *DI = getDebugInfo())
126 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
127 return;
Richard Smithbdb84f32016-07-22 23:36:59 +0000128 case Decl::Var:
129 case Decl::Decomposition: {
Daniel Dunbara7998072008-08-29 17:28:43 +0000130 const VarDecl &VD = cast<VarDecl>(D);
John McCall1c9c3fd2010-10-15 04:57:14 +0000131 assert(VD.isLocalVarDecl() &&
Daniel Dunbara7998072008-08-29 17:28:43 +0000132 "Should not see file-scope variables inside a function!");
Richard Smithda383632016-08-15 01:33:41 +0000133 EmitVarDecl(VD);
134 if (auto *DD = dyn_cast<DecompositionDecl>(&VD))
135 for (auto *B : DD->bindings())
136 if (auto *HD = B->getHoldingVar())
137 EmitVarDecl(*HD);
138 return;
Chris Lattner84915fa2007-06-02 04:16:21 +0000139 }
Mike Stump11289f42009-09-09 15:08:12 +0000140
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000141 case Decl::OMPDeclareReduction:
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000142 return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this);
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000143
Michael Kruse251e1482019-02-01 20:25:04 +0000144 case Decl::OMPDeclareMapper:
145 return CGM.EmitOMPDeclareMapper(cast<OMPDeclareMapperDecl>(&D), this);
146
Richard Smithdda56e42011-04-15 14:24:37 +0000147 case Decl::Typedef: // typedef int X;
148 case Decl::TypeAlias: { // using X = int; [C++0x]
149 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000150 QualType Ty = TD.getUnderlyingType();
Mike Stump11289f42009-09-09 15:08:12 +0000151
Anders Carlsson5d985f52008-12-20 21:51:53 +0000152 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000153 EmitVariablyModifiedType(Ty);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000154 }
Daniel Dunbara7998072008-08-29 17:28:43 +0000155 }
Chris Lattner84915fa2007-06-02 04:16:21 +0000156}
Chris Lattner03df1222007-06-02 04:53:11 +0000157
John McCall1c9c3fd2010-10-15 04:57:14 +0000158/// EmitVarDecl - This method handles emission of any variable declaration
Chris Lattner03df1222007-06-02 04:53:11 +0000159/// inside a function, including static vars etc.
John McCall1c9c3fd2010-10-15 04:57:14 +0000160void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Yaxun Liu4f33b3d2017-05-15 14:47:47 +0000161 if (D.hasExternalStorage())
162 // Don't emit it now, allow it to be emitted lazily on its first use.
163 return;
164
165 // Some function-scope variable does not have static storage but still
166 // needs to be emitted like a static variable, e.g. a function-scope
167 // variable in constant address space in OpenCL.
168 if (D.getStorageDuration() != SD_Automatic) {
Alexey Baderbed40092017-11-15 11:38:17 +0000169 // Static sampler variables translated to function calls.
170 if (D.getType()->isSamplerT())
171 return;
172
Eric Christopher31ab1302011-08-23 22:38:00 +0000173 llvm::GlobalValue::LinkageTypes Linkage =
David Majnemer27d69db2014-04-28 22:17:59 +0000174 CGM.getLLVMLinkageVarDefinition(&D, /*isConstant=*/false);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000175
David Majnemer27d69db2014-04-28 22:17:59 +0000176 // FIXME: We need to force the emission/use of a guard variable for
177 // some variables even if we can constant-evaluate them because
178 // we can't guarantee every translation unit will constant-evaluate them.
Eric Christopher31ab1302011-08-23 22:38:00 +0000179
John McCall1c9c3fd2010-10-15 04:57:14 +0000180 return EmitStaticVarDecl(D, Linkage);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000181 }
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000182
Anastasia Stulovabcea6962015-09-30 14:08:20 +0000183 if (D.getType().getAddressSpace() == LangAS::opencl_local)
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000184 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
185
186 assert(D.hasLocalStorage());
187 return EmitAutoVarDecl(D);
Chris Lattner03df1222007-06-02 04:53:11 +0000188}
189
Reid Kleckner453e0562014-10-08 01:07:54 +0000190static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) {
191 if (CGM.getLangOpts().CPlusPlus)
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000192 return CGM.getMangledName(&D).str();
193
Reid Kleckner453e0562014-10-08 01:07:54 +0000194 // If this isn't C++, we don't need a mangled name, just a pretty one.
195 assert(!D.isExternallyVisible() && "name shouldn't matter");
196 std::string ContextName;
197 const DeclContext *DC = D.getDeclContext();
Alexey Bataev43f74392015-05-07 06:28:46 +0000198 if (auto *CD = dyn_cast<CapturedDecl>(DC))
199 DC = cast<DeclContext>(CD->getNonClosureContext());
Reid Kleckner453e0562014-10-08 01:07:54 +0000200 if (const auto *FD = dyn_cast<FunctionDecl>(DC))
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000201 ContextName = CGM.getMangledName(FD);
Reid Kleckner453e0562014-10-08 01:07:54 +0000202 else if (const auto *BD = dyn_cast<BlockDecl>(DC))
203 ContextName = CGM.getBlockMangledName(GlobalDecl(), BD);
204 else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC))
205 ContextName = OMD->getSelector().getAsString();
Chris Lattnere99c1102009-12-05 08:22:11 +0000206 else
David Blaikie83d382b2011-09-23 05:06:16 +0000207 llvm_unreachable("Unknown context for static var decl");
Eric Christopher31ab1302011-08-23 22:38:00 +0000208
Reid Kleckner453e0562014-10-08 01:07:54 +0000209 ContextName += "." + D.getNameAsString();
210 return ContextName;
Chris Lattnere99c1102009-12-05 08:22:11 +0000211}
212
Reid Kleckner453e0562014-10-08 01:07:54 +0000213llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl(
214 const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) {
215 // In general, we don't always emit static var decls once before we reference
216 // them. It is possible to reference them before emitting the function that
217 // contains them, and it is possible to emit the containing function multiple
218 // times.
219 if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D])
220 return ExistingGV;
221
Chris Lattnerfc4379f2008-04-06 23:10:54 +0000222 QualType Ty = D.getType();
Eli Friedmana682d392008-02-15 12:20:59 +0000223 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begemanfaae0812008-04-19 04:17:09 +0000224
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000225 // Use the label if the variable is renamed with the asm-label extension.
226 std::string Name;
Benjamin Kramer5642e192011-11-21 15:47:23 +0000227 if (D.hasAttr<AsmLabelAttr>())
Reid Kleckner453e0562014-10-08 01:07:54 +0000228 Name = getMangledName(&D);
Benjamin Kramer5642e192011-11-21 15:47:23 +0000229 else
Reid Kleckner453e0562014-10-08 01:07:54 +0000230 Name = getStaticDeclName(*this, D);
Nate Begemanfaae0812008-04-19 04:17:09 +0000231
Reid Kleckner453e0562014-10-08 01:07:54 +0000232 llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty);
Alexander Richardson6d989432017-10-15 18:48:14 +0000233 LangAS AS = GetGlobalVarAddressSpace(&D);
Yaxun Liucbf647c2017-07-08 13:24:52 +0000234 unsigned TargetAS = getContext().getTargetAddressSpace(AS);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000235
Yaxun Liua64a4912018-04-02 17:38:24 +0000236 // OpenCL variables in local address space and CUDA shared
237 // variables cannot have an initializer.
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000238 llvm::Constant *Init = nullptr;
Yaxun Liua64a4912018-04-02 17:38:24 +0000239 if (Ty.getAddressSpace() == LangAS::opencl_local ||
240 D.hasAttr<CUDASharedAttr>())
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000241 Init = llvm::UndefValue::get(LTy);
Yaxun Liua64a4912018-04-02 17:38:24 +0000242 else
243 Init = EmitNullConstant(Ty);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000244
Yaxun Liucbf647c2017-07-08 13:24:52 +0000245 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
246 getModule(), LTy, Ty.isConstant(getContext()), Linkage, Init, Name,
247 nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS);
Ken Dyck160146e2010-01-27 17:10:57 +0000248 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000249
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +0000250 if (supportsCOMDAT() && GV->isWeakForLinker())
251 GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000252
Richard Smithfd3834f2013-04-13 02:43:54 +0000253 if (D.getTLSKind())
Reid Kleckner453e0562014-10-08 01:07:54 +0000254 setTLSMode(GV, D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000255
Rafael Espindola922f2aa2018-02-23 19:30:48 +0000256 setGVProperties(GV, &D);
257
Eli Benderskycb399432014-03-24 22:05:38 +0000258 // Make sure the result is of the correct type.
Alexander Richardson6d989432017-10-15 18:48:14 +0000259 LangAS ExpectedAS = Ty.getAddressSpace();
Reid Kleckner453e0562014-10-08 01:07:54 +0000260 llvm::Constant *Addr = GV;
Yaxun Liucbf647c2017-07-08 13:24:52 +0000261 if (AS != ExpectedAS) {
262 Addr = getTargetCodeGenInfo().performAddrSpaceCast(
263 *this, GV, AS, ExpectedAS,
264 LTy->getPointerTo(getContext().getTargetAddressSpace(ExpectedAS)));
Eli Benderskycb399432014-03-24 22:05:38 +0000265 }
266
Reid Kleckner453e0562014-10-08 01:07:54 +0000267 setStaticLocalDeclAddress(&D, Addr);
268
269 // Ensure that the static local gets initialized by making sure the parent
270 // function gets emitted eventually.
271 const Decl *DC = cast<Decl>(D.getDeclContext());
272
273 // We can't name blocks or captured statements directly, so try to emit their
274 // parents.
275 if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) {
276 DC = DC->getNonClosureContext();
277 // FIXME: Ensure that global blocks get emitted.
278 if (!DC)
279 return Addr;
280 }
281
282 GlobalDecl GD;
283 if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC))
284 GD = GlobalDecl(CD, Ctor_Base);
285 else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC))
286 GD = GlobalDecl(DD, Dtor_Base);
287 else if (const auto *FD = dyn_cast<FunctionDecl>(DC))
288 GD = GlobalDecl(FD);
289 else {
290 // Don't do anything for Obj-C method decls or global closures. We should
291 // never defer them.
292 assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl");
293 }
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000294 if (GD.getDecl()) {
295 // Disable emission of the parent function for the OpenMP device codegen.
296 CGOpenMPRuntime::DisableAutoDeclareTargetRAII NoDeclTarget(*this);
Reid Kleckner453e0562014-10-08 01:07:54 +0000297 (void)GetAddrOfGlobal(GD);
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000298 }
Reid Kleckner453e0562014-10-08 01:07:54 +0000299
300 return Addr;
Daniel Dunbar22a87f92009-02-25 19:24:29 +0000301}
302
Richard Smith6331c402012-02-13 22:16:19 +0000303/// hasNontrivialDestruction - Determine whether a type's destruction is
304/// non-trivial. If so, and the variable uses static initialization, we must
305/// register its destructor to run on exit.
306static bool hasNontrivialDestruction(QualType T) {
307 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
308 return RD && !RD->hasTrivialDestructor();
309}
310
Chandler Carruth84537952012-03-30 19:44:53 +0000311/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
312/// global variable that has already been created for it. If the initializer
313/// has a different type than GV does, this may free GV and return a different
314/// one. Otherwise it just returns GV.
315llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +0000316CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000317 llvm::GlobalVariable *GV) {
John McCallde0fe072017-08-15 21:42:52 +0000318 ConstantEmitter emitter(*this);
319 llvm::Constant *Init = emitter.tryEmitForInitializer(D);
John McCall70013b62010-07-15 23:40:35 +0000320
Chris Lattnere99c1102009-12-05 08:22:11 +0000321 // If constant emission failed, then this should be a C++ static
322 // initializer.
Chandler Carruth84537952012-03-30 19:44:53 +0000323 if (!Init) {
Richard Smith9c6890a2012-11-01 22:30:59 +0000324 if (!getLangOpts().CPlusPlus)
Chris Lattnere99c1102009-12-05 08:22:11 +0000325 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
Matthias Braun44bfe032017-01-10 17:43:01 +0000326 else if (HaveInsertPoint()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000327 // Since we have a static initializer, this global variable can't
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000328 // be constant.
Chandler Carruth84537952012-03-30 19:44:53 +0000329 GV->setConstant(false);
John McCall68ff0372010-09-08 01:44:27 +0000330
Chandler Carruth84537952012-03-30 19:44:53 +0000331 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000332 }
Chandler Carruth84537952012-03-30 19:44:53 +0000333 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000334 }
John McCall70013b62010-07-15 23:40:35 +0000335
Chris Lattnere99c1102009-12-05 08:22:11 +0000336 // The initializer may differ in type from the global. Rewrite
337 // the global to match the initializer. (We have to do this
338 // because some types, like unions, can't be completely represented
339 // in the LLVM type system.)
Chandler Carruth84537952012-03-30 19:44:53 +0000340 if (GV->getType()->getElementType() != Init->getType()) {
341 llvm::GlobalVariable *OldGV = GV;
342
343 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
344 OldGV->isConstant(),
345 OldGV->getLinkage(), Init, "",
346 /*InsertBefore*/ OldGV,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +0000347 OldGV->getThreadLocalMode(),
Chandler Carruth84537952012-03-30 19:44:53 +0000348 CGM.getContext().getTargetAddressSpace(D.getType()));
349 GV->setVisibility(OldGV->getVisibility());
Rafael Espindola699f5d62018-02-07 22:15:33 +0000350 GV->setDSOLocal(OldGV->isDSOLocal());
Reid Klecknereab97d32015-07-20 20:35:30 +0000351 GV->setComdat(OldGV->getComdat());
Eric Christopher31ab1302011-08-23 22:38:00 +0000352
Chris Lattnere99c1102009-12-05 08:22:11 +0000353 // Steal the name of the old global
Chandler Carruth84537952012-03-30 19:44:53 +0000354 GV->takeName(OldGV);
Eric Christopher31ab1302011-08-23 22:38:00 +0000355
Chris Lattnere99c1102009-12-05 08:22:11 +0000356 // Replace all uses of the old global with the new global
Chandler Carruth84537952012-03-30 19:44:53 +0000357 llvm::Constant *NewPtrForOldDecl =
358 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
359 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christopher31ab1302011-08-23 22:38:00 +0000360
Chris Lattnere99c1102009-12-05 08:22:11 +0000361 // Erase the old global, since it is no longer used.
Chandler Carruth84537952012-03-30 19:44:53 +0000362 OldGV->eraseFromParent();
Chris Lattnere99c1102009-12-05 08:22:11 +0000363 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000364
Chandler Carruth84537952012-03-30 19:44:53 +0000365 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
366 GV->setInitializer(Init);
Richard Smith6331c402012-02-13 22:16:19 +0000367
John McCallde0fe072017-08-15 21:42:52 +0000368 emitter.finalize(GV);
369
Matthias Braun44bfe032017-01-10 17:43:01 +0000370 if (hasNontrivialDestruction(D.getType()) && HaveInsertPoint()) {
Richard Smith6331c402012-02-13 22:16:19 +0000371 // We have a constant initializer, but a nontrivial destructor. We still
372 // need to perform a guarded "initialization" in order to register the
Richard Smithe070fd22012-02-17 06:48:11 +0000373 // destructor.
Chandler Carruth84537952012-03-30 19:44:53 +0000374 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith6331c402012-02-13 22:16:19 +0000375 }
376
Chandler Carruth84537952012-03-30 19:44:53 +0000377 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000378}
379
John McCall1c9c3fd2010-10-15 04:57:14 +0000380void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000381 llvm::GlobalValue::LinkageTypes Linkage) {
John McCallb88a5662012-03-30 21:00:39 +0000382 // Check to see if we already have a global variable for this
383 // declaration. This can happen when double-emitting function
384 // bodies, e.g. with complete and base constructors.
Reid Kleckner453e0562014-10-08 01:07:54 +0000385 llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage);
John McCall7f416cc2015-09-08 08:05:57 +0000386 CharUnits alignment = getContext().getDeclAlign(&D);
Daniel Dunbara374e602009-02-25 19:45:19 +0000387
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000388 // Store into LocalDeclMap before generating initializer to handle
389 // circular references.
John McCall7f416cc2015-09-08 08:05:57 +0000390 setAddrOfLocalVar(&D, Address(addr, alignment));
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000391
John McCall4a39ab82010-05-04 20:45:42 +0000392 // We can't have a VLA here, but we can have a pointer to a VLA,
393 // even though that doesn't really make any sense.
Eli Friedmanbc633be2009-04-20 03:54:15 +0000394 // Make sure to evaluate VLA bounds now so that we have them for later.
395 if (D.getType()->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000396 EmitVariablyModifiedType(D.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000397
John McCallb88a5662012-03-30 21:00:39 +0000398 // Save the type in case adding the initializer forces a type change.
399 llvm::Type *expectedType = addr->getType();
Eli Friedmanbc633be2009-04-20 03:54:15 +0000400
Eli Benderskycb399432014-03-24 22:05:38 +0000401 llvm::GlobalVariable *var =
402 cast<llvm::GlobalVariable>(addr->stripPointerCasts());
Artem Belevich4d430ba2016-05-09 22:09:56 +0000403
404 // CUDA's local and local static __shared__ variables should not
405 // have any non-empty initializers. This is ensured by Sema.
406 // Whatever initializer such variable may have when it gets here is
407 // a no-op and should not be emitted.
408 bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
409 D.hasAttr<CUDASharedAttr>();
Chris Lattnere99c1102009-12-05 08:22:11 +0000410 // If this value has an initializer, emit it.
Artem Belevich4d430ba2016-05-09 22:09:56 +0000411 if (D.getInit() && !isCudaSharedVar)
John McCallb88a5662012-03-30 21:00:39 +0000412 var = AddInitializerToStaticVarDecl(D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000413
John McCall7f416cc2015-09-08 08:05:57 +0000414 var->setAlignment(alignment.getQuantity());
Chris Lattner4d941092010-03-10 23:59:59 +0000415
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000416 if (D.hasAttr<AnnotateAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000417 CGM.AddGlobalAnnotations(&D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000418
Javed Absar2a67c9e2017-06-05 10:11:57 +0000419 if (auto *SA = D.getAttr<PragmaClangBSSSectionAttr>())
420 var->addAttribute("bss-section", SA->getName());
421 if (auto *SA = D.getAttr<PragmaClangDataSectionAttr>())
422 var->addAttribute("data-section", SA->getName());
423 if (auto *SA = D.getAttr<PragmaClangRodataSectionAttr>())
424 var->addAttribute("rodata-section", SA->getName());
425
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000426 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000427 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000428
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000429 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000430 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000431
Chandler Carruth84537952012-03-30 19:44:53 +0000432 // We may have to cast the constant because of the initializer
433 // mismatch above.
434 //
435 // FIXME: It is really dangerous to store this in the map; if anyone
436 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000437 llvm::Constant *castedAddr =
438 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCall7f416cc2015-09-08 08:05:57 +0000439 if (var != castedAddr)
440 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
John McCallb88a5662012-03-30 21:00:39 +0000441 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000442
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000443 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
Alexey Samsonov4f319cc2014-07-02 16:54:41 +0000444
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000445 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000446 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000447 if (DI &&
Benjamin Kramer8c305922016-02-02 11:06:51 +0000448 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000449 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000450 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000451 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000452}
Mike Stump11289f42009-09-09 15:08:12 +0000453
John McCall2b7fc382010-07-13 20:32:21 +0000454namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000455 struct DestroyObject final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000456 DestroyObject(Address addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000457 CodeGenFunction::Destroyer *destroyer,
458 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000459 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000460 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000461
John McCall7f416cc2015-09-08 08:05:57 +0000462 Address addr;
John McCall82fe67b2011-07-09 01:37:26 +0000463 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000464 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000465 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000466
Craig Topper4f12f102014-03-12 06:41:41 +0000467 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000468 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000469 bool useEHCleanupForArray =
470 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000471
472 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000473 }
474 };
475
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000476 template <class Derived>
477 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
478 DestroyNRVOVariable(Address addr, llvm::Value *NRVOFlag)
479 : NRVOFlag(NRVOFlag), Loc(addr) {}
John McCall2b7fc382010-07-13 20:32:21 +0000480
John McCall2b7fc382010-07-13 20:32:21 +0000481 llvm::Value *NRVOFlag;
John McCall7f416cc2015-09-08 08:05:57 +0000482 Address Loc;
John McCall2b7fc382010-07-13 20:32:21 +0000483
Craig Topper4f12f102014-03-12 06:41:41 +0000484 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000485 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000486 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000487
Craig Topper8a13c412014-05-21 05:09:00 +0000488 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000489 if (NRVO) {
490 // If we exited via NRVO, we skip the destructor call.
491 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
492 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
John McCall7f416cc2015-09-08 08:05:57 +0000493 llvm::Value *DidNRVO =
494 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
John McCall2b7fc382010-07-13 20:32:21 +0000495 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
496 CGF.EmitBlock(RunDtorBB);
497 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000498
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000499 static_cast<Derived *>(this)->emitDestructorCall(CGF);
John McCall2b7fc382010-07-13 20:32:21 +0000500
501 if (NRVO) CGF.EmitBlock(SkipDtorBB);
502 }
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000503
504 virtual ~DestroyNRVOVariable() = default;
505 };
506
507 struct DestroyNRVOVariableCXX final
508 : DestroyNRVOVariable<DestroyNRVOVariableCXX> {
509 DestroyNRVOVariableCXX(Address addr, const CXXDestructorDecl *Dtor,
510 llvm::Value *NRVOFlag)
511 : DestroyNRVOVariable<DestroyNRVOVariableCXX>(addr, NRVOFlag),
512 Dtor(Dtor) {}
513
514 const CXXDestructorDecl *Dtor;
515
516 void emitDestructorCall(CodeGenFunction &CGF) {
517 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
518 /*ForVirtualBase=*/false,
519 /*Delegating=*/false, Loc);
520 }
521 };
522
523 struct DestroyNRVOVariableC final
524 : DestroyNRVOVariable<DestroyNRVOVariableC> {
525 DestroyNRVOVariableC(Address addr, llvm::Value *NRVOFlag, QualType Ty)
526 : DestroyNRVOVariable<DestroyNRVOVariableC>(addr, NRVOFlag), Ty(Ty) {}
527
528 QualType Ty;
529
530 void emitDestructorCall(CodeGenFunction &CGF) {
531 CGF.destroyNonTrivialCStruct(CGF, Loc, Ty);
532 }
John McCall2b7fc382010-07-13 20:32:21 +0000533 };
John McCall2b7fc382010-07-13 20:32:21 +0000534
David Blaikie7e70d682015-08-18 22:40:54 +0000535 struct CallStackRestore final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000536 Address Stack;
537 CallStackRestore(Address Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000538 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000539 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
James Y Knight8799cae2019-02-03 21:53:49 +0000540 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
John McCalla464ff92010-07-21 06:13:08 +0000541 CGF.Builder.CreateCall(F, V);
542 }
543 };
544
David Blaikie7e70d682015-08-18 22:40:54 +0000545 struct ExtendGCLifetime final : EHScopeStack::Cleanup {
John McCall1bd25562011-06-24 23:21:27 +0000546 const VarDecl &Var;
547 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
548
Craig Topper4f12f102014-03-12 06:41:41 +0000549 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000550 // Compute the address of the local variable, in case it's a
551 // byref or something.
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000552 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000553 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000554 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
555 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000556 CGF.EmitExtendGCLifetime(value);
557 }
558 };
559
David Blaikie7e70d682015-08-18 22:40:54 +0000560 struct CallCleanupFunction final : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000561 llvm::Constant *CleanupFn;
562 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000563 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000564
John McCalla464ff92010-07-21 06:13:08 +0000565 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000566 const VarDecl *Var)
567 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000568
Craig Topper4f12f102014-03-12 06:41:41 +0000569 void Emit(CodeGenFunction &CGF, Flags flags) override {
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000570 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000571 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000572 // Compute the address of the local variable, in case it's a byref
573 // or something.
John McCall7f416cc2015-09-08 08:05:57 +0000574 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer();
John McCallc533cb72011-02-22 06:44:22 +0000575
John McCalla464ff92010-07-21 06:13:08 +0000576 // In some cases, the type of the function argument will be different from
577 // the type of the pointer. An example of this is
578 // void f(void* arg);
579 // __attribute__((cleanup(f))) void *g;
580 //
581 // To fix this we insert a bitcast here.
582 QualType ArgTy = FnInfo.arg_begin()->type;
583 llvm::Value *Arg =
584 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
585
586 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000587 Args.add(RValue::get(Arg),
588 CGF.getContext().getPointerType(Var.getType()));
John McCallb92ab1a2016-10-26 23:46:34 +0000589 auto Callee = CGCallee::forDirect(CleanupFn);
590 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
John McCalla464ff92010-07-21 06:13:08 +0000591 }
592 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000593} // end anonymous namespace
John McCalla464ff92010-07-21 06:13:08 +0000594
John McCall31168b02011-06-15 23:02:42 +0000595/// EmitAutoVarWithLifetime - Does the setup required for an automatic
596/// variable with lifetime.
597static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
John McCall7f416cc2015-09-08 08:05:57 +0000598 Address addr,
John McCall31168b02011-06-15 23:02:42 +0000599 Qualifiers::ObjCLifetime lifetime) {
600 switch (lifetime) {
601 case Qualifiers::OCL_None:
602 llvm_unreachable("present but none");
603
604 case Qualifiers::OCL_ExplicitNone:
605 // nothing to do
606 break;
607
608 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000609 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000610 (var.hasAttr<ObjCPreciseLifetimeAttr>()
611 ? CodeGenFunction::destroyARCStrongPrecise
612 : CodeGenFunction::destroyARCStrongImprecise);
613
614 CleanupKind cleanupKind = CGF.getARCCleanupKind();
615 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
616 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000617 break;
618 }
619 case Qualifiers::OCL_Autoreleasing:
620 // nothing to do
621 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000622
John McCall31168b02011-06-15 23:02:42 +0000623 case Qualifiers::OCL_Weak:
624 // __weak objects always get EH cleanups; otherwise, exceptions
625 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000626 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
627 CodeGenFunction::destroyARCWeak,
628 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000629 break;
630 }
631}
632
633static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
634 if (const Expr *e = dyn_cast<Expr>(s)) {
635 // Skip the most common kinds of expressions that make
636 // hierarchy-walking expensive.
637 s = e = e->IgnoreParenCasts();
638
639 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
640 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000641 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
642 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000643 for (const auto &I : block->captures()) {
644 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000645 return true;
646 }
647 }
John McCall31168b02011-06-15 23:02:42 +0000648 }
649
Benjamin Kramer642f1732015-07-02 21:03:14 +0000650 for (const Stmt *SubStmt : s->children())
651 // SubStmt might be null; as in missing decl or conditional of an if-stmt.
652 if (SubStmt && isAccessedBy(var, SubStmt))
John McCall31168b02011-06-15 23:02:42 +0000653 return true;
654
655 return false;
656}
657
658static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
659 if (!decl) return false;
660 if (!isa<VarDecl>(decl)) return false;
661 const VarDecl *var = cast<VarDecl>(decl);
662 return isAccessedBy(*var, e);
663}
664
John McCallf8a9b662015-10-21 18:06:31 +0000665static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
666 const LValue &destLV, const Expr *init) {
John McCall0204e342015-11-16 22:11:41 +0000667 bool needsCast = false;
668
John McCallf8a9b662015-10-21 18:06:31 +0000669 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
670 switch (castExpr->getCastKind()) {
671 // Look through casts that don't require representation changes.
672 case CK_NoOp:
673 case CK_BitCast:
674 case CK_BlockPointerToObjCPointerCast:
John McCall0204e342015-11-16 22:11:41 +0000675 needsCast = true;
John McCallf8a9b662015-10-21 18:06:31 +0000676 break;
677
678 // If we find an l-value to r-value cast from a __weak variable,
679 // emit this operation as a copy or move.
680 case CK_LValueToRValue: {
681 const Expr *srcExpr = castExpr->getSubExpr();
682 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
683 return false;
684
685 // Emit the source l-value.
686 LValue srcLV = CGF.EmitLValue(srcExpr);
687
John McCall0204e342015-11-16 22:11:41 +0000688 // Handle a formal type change to avoid asserting.
689 auto srcAddr = srcLV.getAddress();
690 if (needsCast) {
691 srcAddr = CGF.Builder.CreateElementBitCast(srcAddr,
692 destLV.getAddress().getElementType());
693 }
694
John McCallf8a9b662015-10-21 18:06:31 +0000695 // If it was an l-value, use objc_copyWeak.
696 if (srcExpr->getValueKind() == VK_LValue) {
John McCall0204e342015-11-16 22:11:41 +0000697 CGF.EmitARCCopyWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000698 } else {
699 assert(srcExpr->getValueKind() == VK_XValue);
John McCall0204e342015-11-16 22:11:41 +0000700 CGF.EmitARCMoveWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000701 }
702 return true;
703 }
704
705 // Stop at anything else.
706 default:
707 return false;
708 }
709
710 init = castExpr->getSubExpr();
John McCallf8a9b662015-10-21 18:06:31 +0000711 }
712 return false;
713}
714
John McCall1553b192011-06-16 04:16:24 +0000715static void drillIntoBlockVariable(CodeGenFunction &CGF,
716 LValue &lvalue,
717 const VarDecl *var) {
John McCall7f416cc2015-09-08 08:05:57 +0000718 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(), var));
John McCall1553b192011-06-16 04:16:24 +0000719}
720
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000721void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS,
722 SourceLocation Loc) {
723 if (!SanOpts.has(SanitizerKind::NullabilityAssign))
724 return;
725
726 auto Nullability = LHS.getType()->getNullability(getContext());
727 if (!Nullability || *Nullability != NullabilityKind::NonNull)
728 return;
729
730 // Check if the right hand side of the assignment is nonnull, if the left
731 // hand side must be nonnull.
732 SanitizerScope SanScope(this);
733 llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS);
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000734 llvm::Constant *StaticData[] = {
735 EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()),
Simon Pilgrim2df19982017-03-14 21:43:52 +0000736 llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000737 llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)};
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000738 EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}},
739 SanitizerHandler::TypeMismatch, StaticData, RHS);
740}
741
David Blaikie73ca5692014-12-09 00:32:22 +0000742void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +0000743 LValue lvalue, bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000744 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000745 if (!lifetime) {
746 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000747 if (capturedByInit)
748 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000749 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
David Blaikie66e41972015-01-14 07:38:27 +0000750 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000751 return;
752 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000753
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000754 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
755 init = DIE->getExpr();
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000756
John McCall31168b02011-06-15 23:02:42 +0000757 // If we're emitting a value with lifetime, we have to do the
758 // initialization *before* we leave the cleanup scopes.
Bill Wendling7c44da22018-10-31 03:48:47 +0000759 if (const FullExpr *fe = dyn_cast<FullExpr>(init)) {
760 enterFullExpression(fe);
761 init = fe->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000762 }
763 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000764
765 // We have to maintain the illusion that the variable is
766 // zero-initialized. If the variable might be accessed in its
767 // initializer, zero-initialize before running the initializer, then
768 // actually perform the initialization with an assign.
769 bool accessedByInit = false;
770 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000771 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000772 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000773 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000774 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000775 if (capturedByInit) {
776 // We can use a simple GEP for this because it can't have been
777 // moved yet.
John McCall7f416cc2015-09-08 08:05:57 +0000778 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(),
779 cast<VarDecl>(D),
780 /*follow*/ false));
John McCall31168b02011-06-15 23:02:42 +0000781 }
782
John McCall7f416cc2015-09-08 08:05:57 +0000783 auto ty = cast<llvm::PointerType>(tempLV.getAddress().getElementType());
Yaxun Liu402804b2016-12-15 08:09:08 +0000784 llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000785
John McCall31168b02011-06-15 23:02:42 +0000786 // If __weak, we want to use a barrier under certain conditions.
787 if (lifetime == Qualifiers::OCL_Weak)
John McCall1553b192011-06-16 04:16:24 +0000788 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCall31168b02011-06-15 23:02:42 +0000789
790 // Otherwise just do a simple store.
791 else
David Chisnallfa35df62012-01-16 17:27:18 +0000792 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000793 }
794
795 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000796 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000797
798 switch (lifetime) {
799 case Qualifiers::OCL_None:
800 llvm_unreachable("present but none");
801
Erik Pilkington1e368822019-01-04 18:33:06 +0000802 case Qualifiers::OCL_Strong: {
803 if (!D || !isa<VarDecl>(D) || !cast<VarDecl>(D)->isARCPseudoStrong()) {
804 value = EmitARCRetainScalarExpr(init);
805 break;
806 }
807 // If D is pseudo-strong, treat it like __unsafe_unretained here. This means
808 // that we omit the retain, and causes non-autoreleased return values to be
809 // immediately released.
810 LLVM_FALLTHROUGH;
811 }
812
John McCall31168b02011-06-15 23:02:42 +0000813 case Qualifiers::OCL_ExplicitNone:
John McCalle399e5b2016-01-27 18:32:30 +0000814 value = EmitARCUnsafeUnretainedScalarExpr(init);
John McCall31168b02011-06-15 23:02:42 +0000815 break;
816
John McCall31168b02011-06-15 23:02:42 +0000817 case Qualifiers::OCL_Weak: {
John McCallf8a9b662015-10-21 18:06:31 +0000818 // If it's not accessed by the initializer, try to emit the
819 // initialization with a copy or move.
820 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
821 return;
822 }
823
John McCall31168b02011-06-15 23:02:42 +0000824 // No way to optimize a producing initializer into this. It's not
825 // worth optimizing for, because the value will immediately
826 // disappear in the common case.
827 value = EmitScalarExpr(init);
828
John McCall1553b192011-06-16 04:16:24 +0000829 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000830 if (accessedByInit)
John McCall1553b192011-06-16 04:16:24 +0000831 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000832 else
John McCall1553b192011-06-16 04:16:24 +0000833 EmitARCInitWeak(lvalue.getAddress(), value);
John McCall31168b02011-06-15 23:02:42 +0000834 return;
835 }
836
837 case Qualifiers::OCL_Autoreleasing:
838 value = EmitARCRetainAutoreleaseScalarExpr(init);
839 break;
840 }
841
John McCall1553b192011-06-16 04:16:24 +0000842 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000843
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000844 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
845
John McCall31168b02011-06-15 23:02:42 +0000846 // If the variable might have been accessed by its initializer, we
847 // might have to initialize with a barrier. We have to do this for
848 // both __weak and __strong, but __weak got filtered out above.
849 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000850 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000851 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000852 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000853 return;
854 }
855
David Chisnallfa35df62012-01-16 17:27:18 +0000856 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000857}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000858
JF Bastiened92f602018-07-20 23:37:12 +0000859/// Decide whether we can emit the non-zero parts of the specified initializer
860/// with equal or fewer than NumStores scalar stores.
861static bool canEmitInitWithFewStoresAfterBZero(llvm::Constant *Init,
862 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000863 // Zero and Undef never requires any extra stores.
864 if (isa<llvm::ConstantAggregateZero>(Init) ||
865 isa<llvm::ConstantPointerNull>(Init) ||
866 isa<llvm::UndefValue>(Init))
867 return true;
868 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
869 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
870 isa<llvm::ConstantExpr>(Init))
871 return Init->isNullValue() || NumStores--;
872
873 // See if we can emit each element.
874 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
875 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
876 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
JF Bastiened92f602018-07-20 23:37:12 +0000877 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattnere6af8862010-12-02 01:58:41 +0000878 return false;
879 }
880 return true;
881 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000882
Chris Lattner236b3572012-01-31 04:36:19 +0000883 if (llvm::ConstantDataSequential *CDS =
884 dyn_cast<llvm::ConstantDataSequential>(Init)) {
885 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
886 llvm::Constant *Elt = CDS->getElementAsConstant(i);
JF Bastiened92f602018-07-20 23:37:12 +0000887 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattner236b3572012-01-31 04:36:19 +0000888 return false;
889 }
890 return true;
891 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000892
Chris Lattnerb85025f2010-12-01 02:05:19 +0000893 // Anything else is hard and scary.
894 return false;
895}
896
JF Bastiened92f602018-07-20 23:37:12 +0000897/// For inits that canEmitInitWithFewStoresAfterBZero returned true for, emit
898/// the scalar stores that would be required.
899static void emitStoresForInitAfterBZero(CodeGenModule &CGM,
900 llvm::Constant *Init, Address Loc,
901 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000902 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
JF Bastiened92f602018-07-20 23:37:12 +0000903 "called emitStoresForInitAfterBZero for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000904
Chris Lattnere6af8862010-12-02 01:58:41 +0000905 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
906 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
907 isa<llvm::ConstantExpr>(Init)) {
JF Bastien9aab85a2018-07-13 20:33:23 +0000908 Builder.CreateStore(Init, Loc, isVolatile);
Chris Lattner236b3572012-01-31 04:36:19 +0000909 return;
910 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000911
912 if (llvm::ConstantDataSequential *CDS =
913 dyn_cast<llvm::ConstantDataSequential>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000914 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
915 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000916
917 // If necessary, get a pointer to the element and emit it.
918 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
JF Bastiened92f602018-07-20 23:37:12 +0000919 emitStoresForInitAfterBZero(
James Y Knight751fe282019-02-09 22:22:28 +0000920 CGM, Elt, Builder.CreateConstInBoundsGEP2_32(Loc, 0, i), isVolatile,
921 Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000922 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000923 return;
924 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000925
Chris Lattnere6af8862010-12-02 01:58:41 +0000926 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
927 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000928
Chris Lattnere6af8862010-12-02 01:58:41 +0000929 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
930 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000931
932 // If necessary, get a pointer to the element and emit it.
933 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
James Y Knight751fe282019-02-09 22:22:28 +0000934 emitStoresForInitAfterBZero(CGM, Elt,
935 Builder.CreateConstInBoundsGEP2_32(Loc, 0, i),
936 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000937 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000938}
939
JF Bastiened92f602018-07-20 23:37:12 +0000940/// Decide whether we should use bzero plus some stores to initialize a local
941/// variable instead of using a memcpy from a constant global. It is beneficial
942/// to use bzero if the global is all zeros, or mostly zeros and large.
943static bool shouldUseBZeroPlusStoresToInitialize(llvm::Constant *Init,
944 uint64_t GlobalSize) {
945 // If a global is all zeros, always use a bzero.
Chris Lattnerb85025f2010-12-01 02:05:19 +0000946 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
947
Chris Lattnerb85025f2010-12-01 02:05:19 +0000948 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
949 // do it if it will require 6 or fewer scalar stores.
950 // TODO: Should budget depends on the size? Avoiding a large global warrants
951 // plopping in more stores.
952 unsigned StoreBudget = 6;
953 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000954
955 return GlobalSize > SizeLimit &&
JF Bastiened92f602018-07-20 23:37:12 +0000956 canEmitInitWithFewStoresAfterBZero(Init, StoreBudget);
Chris Lattnerb85025f2010-12-01 02:05:19 +0000957}
958
JF Bastien65089292018-07-25 04:29:03 +0000959/// Decide whether we should use memset to initialize a local variable instead
960/// of using a memcpy from a constant global. Assumes we've already decided to
961/// not user bzero.
962/// FIXME We could be more clever, as we are for bzero above, and generate
963/// memset followed by stores. It's unclear that's worth the effort.
JF Bastien2f0582f2018-09-21 13:54:09 +0000964static llvm::Value *shouldUseMemSetToInitialize(llvm::Constant *Init,
965 uint64_t GlobalSize) {
JF Bastien65089292018-07-25 04:29:03 +0000966 uint64_t SizeLimit = 32;
967 if (GlobalSize <= SizeLimit)
JF Bastien2f0582f2018-09-21 13:54:09 +0000968 return nullptr;
969 return llvm::isBytewiseValue(Init);
JF Bastien65089292018-07-25 04:29:03 +0000970}
971
JF Bastien14daa202018-12-18 05:12:21 +0000972static llvm::Constant *patternFor(CodeGenModule &CGM, llvm::Type *Ty) {
973 // The following value is a guaranteed unmappable pointer value and has a
974 // repeated byte-pattern which makes it easier to synthesize. We use it for
975 // pointers as well as integers so that aggregates are likely to be
976 // initialized with this repeated value.
977 constexpr uint64_t LargeValue = 0xAAAAAAAAAAAAAAAAull;
978 // For 32-bit platforms it's a bit trickier because, across systems, only the
979 // zero page can reasonably be expected to be unmapped, and even then we need
980 // a very low address. We use a smaller value, and that value sadly doesn't
981 // have a repeated byte-pattern. We don't use it for integers.
982 constexpr uint32_t SmallValue = 0x000000AA;
983 // Floating-point values are initialized as NaNs because they propagate. Using
984 // a repeated byte pattern means that it will be easier to initialize
985 // all-floating-point aggregates and arrays with memset. Further, aggregates
986 // which mix integral and a few floats might also initialize with memset
987 // followed by a handful of stores for the floats. Using fairly unique NaNs
988 // also means they'll be easier to distinguish in a crash.
989 constexpr bool NegativeNaN = true;
990 constexpr uint64_t NaNPayload = 0xFFFFFFFFFFFFFFFFull;
991 if (Ty->isIntOrIntVectorTy()) {
992 unsigned BitWidth = cast<llvm::IntegerType>(
993 Ty->isVectorTy() ? Ty->getVectorElementType() : Ty)
994 ->getBitWidth();
995 if (BitWidth <= 64)
996 return llvm::ConstantInt::get(Ty, LargeValue);
997 return llvm::ConstantInt::get(
998 Ty, llvm::APInt::getSplat(BitWidth, llvm::APInt(64, LargeValue)));
999 }
1000 if (Ty->isPtrOrPtrVectorTy()) {
1001 auto *PtrTy = cast<llvm::PointerType>(
1002 Ty->isVectorTy() ? Ty->getVectorElementType() : Ty);
1003 unsigned PtrWidth = CGM.getContext().getTargetInfo().getPointerWidth(
1004 PtrTy->getAddressSpace());
1005 llvm::Type *IntTy = llvm::IntegerType::get(CGM.getLLVMContext(), PtrWidth);
1006 uint64_t IntValue;
1007 switch (PtrWidth) {
1008 default:
1009 llvm_unreachable("pattern initialization of unsupported pointer width");
1010 case 64:
1011 IntValue = LargeValue;
1012 break;
1013 case 32:
1014 IntValue = SmallValue;
1015 break;
1016 }
1017 auto *Int = llvm::ConstantInt::get(IntTy, IntValue);
1018 return llvm::ConstantExpr::getIntToPtr(Int, PtrTy);
1019 }
1020 if (Ty->isFPOrFPVectorTy()) {
1021 unsigned BitWidth = llvm::APFloat::semanticsSizeInBits(
1022 (Ty->isVectorTy() ? Ty->getVectorElementType() : Ty)
1023 ->getFltSemantics());
1024 llvm::APInt Payload(64, NaNPayload);
1025 if (BitWidth >= 64)
1026 Payload = llvm::APInt::getSplat(BitWidth, Payload);
1027 return llvm::ConstantFP::getQNaN(Ty, NegativeNaN, &Payload);
1028 }
1029 if (Ty->isArrayTy()) {
1030 // Note: this doesn't touch tail padding (at the end of an object, before
1031 // the next array object). It is instead handled by replaceUndef.
1032 auto *ArrTy = cast<llvm::ArrayType>(Ty);
1033 llvm::SmallVector<llvm::Constant *, 8> Element(
1034 ArrTy->getNumElements(), patternFor(CGM, ArrTy->getElementType()));
1035 return llvm::ConstantArray::get(ArrTy, Element);
1036 }
1037
1038 // Note: this doesn't touch struct padding. It will initialize as much union
1039 // padding as is required for the largest type in the union. Padding is
1040 // instead handled by replaceUndef. Stores to structs with volatile members
1041 // don't have a volatile qualifier when initialized according to C++. This is
1042 // fine because stack-based volatiles don't really have volatile semantics
1043 // anyways, and the initialization shouldn't be observable.
1044 auto *StructTy = cast<llvm::StructType>(Ty);
1045 llvm::SmallVector<llvm::Constant *, 8> Struct(StructTy->getNumElements());
1046 for (unsigned El = 0; El != Struct.size(); ++El)
1047 Struct[El] = patternFor(CGM, StructTy->getElementType(El));
1048 return llvm::ConstantStruct::get(StructTy, Struct);
1049}
1050
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001051enum class IsPattern { No, Yes };
1052
1053/// Generate a constant filled with either a pattern or zeroes.
1054static llvm::Constant *patternOrZeroFor(CodeGenModule &CGM, IsPattern isPattern,
1055 llvm::Type *Ty) {
1056 if (isPattern == IsPattern::Yes)
1057 return patternFor(CGM, Ty);
1058 else
1059 return llvm::Constant::getNullValue(Ty);
1060}
1061
1062static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1063 llvm::Constant *constant);
1064
1065/// Helper function for constWithPadding() to deal with padding in structures.
1066static llvm::Constant *constStructWithPadding(CodeGenModule &CGM,
1067 IsPattern isPattern,
1068 llvm::StructType *STy,
1069 llvm::Constant *constant) {
1070 const llvm::DataLayout &DL = CGM.getDataLayout();
1071 const llvm::StructLayout *Layout = DL.getStructLayout(STy);
1072 llvm::Type *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext());
1073 unsigned SizeSoFar = 0;
1074 SmallVector<llvm::Constant *, 8> Values;
1075 bool NestedIntact = true;
1076 for (unsigned i = 0, e = STy->getNumElements(); i != e; i++) {
1077 unsigned CurOff = Layout->getElementOffset(i);
1078 if (SizeSoFar < CurOff) {
1079 assert(!STy->isPacked());
1080 auto *PadTy = llvm::ArrayType::get(Int8Ty, CurOff - SizeSoFar);
1081 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1082 }
1083 llvm::Constant *CurOp;
1084 if (constant->isZeroValue())
1085 CurOp = llvm::Constant::getNullValue(STy->getElementType(i));
1086 else
1087 CurOp = cast<llvm::Constant>(constant->getAggregateElement(i));
1088 auto *NewOp = constWithPadding(CGM, isPattern, CurOp);
1089 if (CurOp != NewOp)
1090 NestedIntact = false;
1091 Values.push_back(NewOp);
1092 SizeSoFar = CurOff + DL.getTypeAllocSize(CurOp->getType());
1093 }
1094 unsigned TotalSize = Layout->getSizeInBytes();
1095 if (SizeSoFar < TotalSize) {
1096 auto *PadTy = llvm::ArrayType::get(Int8Ty, TotalSize - SizeSoFar);
1097 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1098 }
1099 if (NestedIntact && Values.size() == STy->getNumElements())
1100 return constant;
1101 return llvm::ConstantStruct::getAnon(Values);
1102}
1103
1104/// Replace all padding bytes in a given constant with either a pattern byte or
1105/// 0x00.
1106static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1107 llvm::Constant *constant) {
1108 llvm::Type *OrigTy = constant->getType();
1109 if (const auto STy = dyn_cast<llvm::StructType>(OrigTy))
1110 return constStructWithPadding(CGM, isPattern, STy, constant);
1111 if (auto *STy = dyn_cast<llvm::SequentialType>(OrigTy)) {
1112 llvm::SmallVector<llvm::Constant *, 8> Values;
1113 unsigned Size = STy->getNumElements();
1114 if (!Size)
1115 return constant;
1116 llvm::Type *ElemTy = STy->getElementType();
1117 bool ZeroInitializer = constant->isZeroValue();
1118 llvm::Constant *OpValue, *PaddedOp;
1119 if (ZeroInitializer) {
1120 OpValue = llvm::Constant::getNullValue(ElemTy);
1121 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1122 }
1123 for (unsigned Op = 0; Op != Size; ++Op) {
1124 if (!ZeroInitializer) {
1125 OpValue = constant->getAggregateElement(Op);
1126 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1127 }
1128 Values.push_back(PaddedOp);
1129 }
1130 auto *NewElemTy = Values[0]->getType();
1131 if (NewElemTy == ElemTy)
1132 return constant;
1133 if (OrigTy->isArrayTy()) {
1134 auto *ArrayTy = llvm::ArrayType::get(NewElemTy, Size);
1135 return llvm::ConstantArray::get(ArrayTy, Values);
1136 } else {
1137 return llvm::ConstantVector::get(Values);
1138 }
1139 }
1140 return constant;
1141}
1142
JF Bastien3a881e62018-11-15 00:19:18 +00001143static Address createUnnamedGlobalFrom(CodeGenModule &CGM, const VarDecl &D,
1144 CGBuilderTy &Builder,
1145 llvm::Constant *Constant,
1146 CharUnits Align) {
1147 auto FunctionName = [&](const DeclContext *DC) -> std::string {
1148 if (const auto *FD = dyn_cast<FunctionDecl>(DC)) {
1149 if (const auto *CC = dyn_cast<CXXConstructorDecl>(FD))
1150 return CC->getNameAsString();
1151 if (const auto *CD = dyn_cast<CXXDestructorDecl>(FD))
1152 return CD->getNameAsString();
1153 return CGM.getMangledName(FD);
1154 } else if (const auto *OM = dyn_cast<ObjCMethodDecl>(DC)) {
1155 return OM->getNameAsString();
Mikael Holmenee846762018-11-15 13:01:54 +00001156 } else if (isa<BlockDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001157 return "<block>";
Mikael Holmenee846762018-11-15 13:01:54 +00001158 } else if (isa<CapturedDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001159 return "<captured>";
1160 } else {
1161 llvm::llvm_unreachable_internal("expected a function or method");
1162 }
1163 };
1164
1165 auto *Ty = Constant->getType();
1166 bool isConstant = true;
1167 llvm::GlobalVariable *InsertBefore = nullptr;
1168 unsigned AS = CGM.getContext().getTargetAddressSpace(
1169 CGM.getStringLiteralAddressSpace());
1170 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
1171 CGM.getModule(), Ty, isConstant, llvm::GlobalValue::PrivateLinkage,
1172 Constant,
1173 "__const." + FunctionName(D.getParentFunctionOrMethod()) + "." +
1174 D.getName(),
1175 InsertBefore, llvm::GlobalValue::NotThreadLocal, AS);
1176 GV->setAlignment(Align.getQuantity());
1177 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1178
1179 Address SrcPtr = Address(GV, Align);
1180 llvm::Type *BP = llvm::PointerType::getInt8PtrTy(CGM.getLLVMContext(), AS);
1181 if (SrcPtr.getType() != BP)
1182 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
1183 return SrcPtr;
1184}
1185
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001186static void emitStoresForConstant(CodeGenModule &CGM, const VarDecl &D,
1187 Address Loc, bool isVolatile,
1188 CGBuilderTy &Builder,
1189 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001190 auto *Ty = constant->getType();
1191 bool isScalar = Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy() ||
1192 Ty->isFPOrFPVectorTy();
1193 if (isScalar) {
1194 Builder.CreateStore(constant, Loc, isVolatile);
1195 return;
1196 }
1197
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001198 auto *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext());
1199 auto *IntPtrTy = CGM.getDataLayout().getIntPtrType(CGM.getLLVMContext());
1200
1201 // If the initializer is all or mostly the same, codegen with bzero / memset
1202 // then do a few stores afterward.
JF Bastien14daa202018-12-18 05:12:21 +00001203 uint64_t ConstantSize = CGM.getDataLayout().getTypeAllocSize(Ty);
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001204 auto *SizeVal = llvm::ConstantInt::get(IntPtrTy, ConstantSize);
1205 if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) {
1206 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1207 isVolatile);
1208
1209 bool valueAlreadyCorrect =
1210 constant->isNullValue() || isa<llvm::UndefValue>(constant);
1211 if (!valueAlreadyCorrect) {
JF Bastien14daa202018-12-18 05:12:21 +00001212 Loc = Builder.CreateBitCast(Loc, Ty->getPointerTo(Loc.getAddressSpace()));
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001213 emitStoresForInitAfterBZero(CGM, constant, Loc, isVolatile, Builder);
1214 }
1215 return;
1216 }
1217
JF Bastien2f0582f2018-09-21 13:54:09 +00001218 llvm::Value *Pattern = shouldUseMemSetToInitialize(constant, ConstantSize);
1219 if (Pattern) {
1220 uint64_t Value = 0x00;
1221 if (!isa<llvm::UndefValue>(Pattern)) {
1222 const llvm::APInt &AP = cast<llvm::ConstantInt>(Pattern)->getValue();
1223 assert(AP.getBitWidth() <= 8);
1224 Value = AP.getLimitedValue();
1225 }
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001226 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, Value), SizeVal,
1227 isVolatile);
1228 return;
1229 }
1230
JF Bastien3a881e62018-11-15 00:19:18 +00001231 Builder.CreateMemCpy(
1232 Loc,
1233 createUnnamedGlobalFrom(CGM, D, Builder, constant, Loc.getAlignment()),
1234 SizeVal, isVolatile);
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001235}
1236
JF Bastien14daa202018-12-18 05:12:21 +00001237static void emitStoresForZeroInit(CodeGenModule &CGM, const VarDecl &D,
1238 Address Loc, bool isVolatile,
1239 CGBuilderTy &Builder) {
1240 llvm::Type *ElTy = Loc.getElementType();
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001241 llvm::Constant *constant =
1242 constWithPadding(CGM, IsPattern::No, llvm::Constant::getNullValue(ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001243 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1244}
1245
1246static void emitStoresForPatternInit(CodeGenModule &CGM, const VarDecl &D,
1247 Address Loc, bool isVolatile,
1248 CGBuilderTy &Builder) {
1249 llvm::Type *ElTy = Loc.getElementType();
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001250 llvm::Constant *constant =
1251 constWithPadding(CGM, IsPattern::Yes, patternFor(CGM, ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001252 assert(!isa<llvm::UndefValue>(constant));
1253 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1254}
1255
1256static bool containsUndef(llvm::Constant *constant) {
1257 auto *Ty = constant->getType();
1258 if (isa<llvm::UndefValue>(constant))
1259 return true;
1260 if (Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy())
1261 for (llvm::Use &Op : constant->operands())
1262 if (containsUndef(cast<llvm::Constant>(Op)))
1263 return true;
1264 return false;
1265}
1266
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001267static llvm::Constant *replaceUndef(CodeGenModule &CGM, IsPattern isPattern,
1268 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001269 auto *Ty = constant->getType();
1270 if (isa<llvm::UndefValue>(constant))
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001271 return patternOrZeroFor(CGM, isPattern, Ty);
JF Bastien14daa202018-12-18 05:12:21 +00001272 if (!(Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()))
1273 return constant;
1274 if (!containsUndef(constant))
1275 return constant;
1276 llvm::SmallVector<llvm::Constant *, 8> Values(constant->getNumOperands());
1277 for (unsigned Op = 0, NumOp = constant->getNumOperands(); Op != NumOp; ++Op) {
1278 auto *OpValue = cast<llvm::Constant>(constant->getOperand(Op));
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001279 Values[Op] = replaceUndef(CGM, isPattern, OpValue);
JF Bastien14daa202018-12-18 05:12:21 +00001280 }
1281 if (Ty->isStructTy())
1282 return llvm::ConstantStruct::get(cast<llvm::StructType>(Ty), Values);
1283 if (Ty->isArrayTy())
1284 return llvm::ConstantArray::get(cast<llvm::ArrayType>(Ty), Values);
1285 assert(Ty->isVectorTy());
1286 return llvm::ConstantVector::get(Values);
1287}
1288
Nick Lewycky8a7d90b2010-12-30 20:21:55 +00001289/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +00001290/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +00001291/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +00001292void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
1293 AutoVarEmission emission = EmitAutoVarAlloca(D);
1294 EmitAutoVarInit(emission);
1295 EmitAutoVarCleanups(emission);
1296}
Chris Lattner03df1222007-06-02 04:53:11 +00001297
David Majnemerdc012fa2015-04-22 21:38:15 +00001298/// Emit a lifetime.begin marker if some criteria are satisfied.
1299/// \return a pointer to the temporary size Value if a marker was emitted, null
1300/// otherwise
1301llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
1302 llvm::Value *Addr) {
Vitaly Buka1c943322016-10-26 01:59:57 +00001303 if (!ShouldEmitLifetimeMarkers)
Reid Kleckner1ef49212015-04-23 18:07:13 +00001304 return nullptr;
1305
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001306 assert(Addr->getType()->getPointerAddressSpace() ==
1307 CGM.getDataLayout().getAllocaAddrSpace() &&
1308 "Pointer should be in alloca address space");
David Majnemerdc012fa2015-04-22 21:38:15 +00001309 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001310 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001311 llvm::CallInst *C =
1312 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001313 C->setDoesNotThrow();
1314 return SizeV;
1315}
1316
1317void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001318 assert(Addr->getType()->getPointerAddressSpace() ==
1319 CGM.getDataLayout().getAllocaAddrSpace() &&
1320 "Pointer should be in alloca address space");
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001321 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001322 llvm::CallInst *C =
1323 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001324 C->setDoesNotThrow();
1325}
1326
Sander de Smalen891af03a2018-02-03 13:55:59 +00001327void CodeGenFunction::EmitAndRegisterVariableArrayDimensions(
1328 CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) {
1329 // For each dimension stores its QualType and corresponding
1330 // size-expression Value.
1331 SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions;
Adrian Prantla40cce82018-11-09 19:17:56 +00001332 SmallVector<IdentifierInfo *, 4> VLAExprNames;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001333
1334 // Break down the array into individual dimensions.
1335 QualType Type1D = D.getType();
1336 while (getContext().getAsVariableArrayType(Type1D)) {
1337 auto VlaSize = getVLAElements1D(Type1D);
1338 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1339 Dimensions.emplace_back(C, Type1D.getUnqualifiedType());
1340 else {
Adrian Prantla40cce82018-11-09 19:17:56 +00001341 // Generate a locally unique name for the size expression.
1342 Twine Name = Twine("__vla_expr") + Twine(VLAExprCounter++);
1343 SmallString<12> Buffer;
1344 StringRef NameRef = Name.toStringRef(Buffer);
1345 auto &Ident = getContext().Idents.getOwn(NameRef);
1346 VLAExprNames.push_back(&Ident);
1347 auto SizeExprAddr =
1348 CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), NameRef);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001349 Builder.CreateStore(VlaSize.NumElts, SizeExprAddr);
1350 Dimensions.emplace_back(SizeExprAddr.getPointer(),
1351 Type1D.getUnqualifiedType());
1352 }
1353 Type1D = VlaSize.Type;
1354 }
1355
1356 if (!EmitDebugInfo)
1357 return;
1358
1359 // Register each dimension's size-expression with a DILocalVariable,
1360 // so that it can be used by CGDebugInfo when instantiating a DISubrange
1361 // to describe this array.
Adrian Prantla40cce82018-11-09 19:17:56 +00001362 unsigned NameIdx = 0;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001363 for (auto &VlaSize : Dimensions) {
1364 llvm::Metadata *MD;
1365 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1366 MD = llvm::ConstantAsMetadata::get(C);
1367 else {
1368 // Create an artificial VarDecl to generate debug info for.
Adrian Prantla40cce82018-11-09 19:17:56 +00001369 IdentifierInfo *NameIdent = VLAExprNames[NameIdx++];
Sander de Smalen891af03a2018-02-03 13:55:59 +00001370 auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType();
1371 auto QT = getContext().getIntTypeForBitwidth(
1372 VlaExprTy->getScalarSizeInBits(), false);
1373 auto *ArtificialDecl = VarDecl::Create(
1374 getContext(), const_cast<DeclContext *>(D.getDeclContext()),
Adrian Prantla40cce82018-11-09 19:17:56 +00001375 D.getLocation(), D.getLocation(), NameIdent, QT,
Sander de Smalen891af03a2018-02-03 13:55:59 +00001376 getContext().CreateTypeSourceInfo(QT), SC_Auto);
Sander de Smalen9084a3b2018-02-13 07:49:34 +00001377 ArtificialDecl->setImplicit();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001378
1379 MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts,
1380 Builder);
1381 }
1382 assert(MD && "No Size expression debug node created");
1383 DI->registerVLASizeExpression(VlaSize.Type, MD);
1384 }
1385}
1386
John McCallc533cb72011-02-22 06:44:22 +00001387/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001388/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +00001389CodeGenFunction::AutoVarEmission
1390CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
1391 QualType Ty = D.getType();
Yaxun Liub7318e02017-10-13 03:37:48 +00001392 assert(
1393 Ty.getAddressSpace() == LangAS::Default ||
1394 (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL));
John McCallc533cb72011-02-22 06:44:22 +00001395
1396 AutoVarEmission emission(D);
1397
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001398 bool isEscapingByRef = D.isEscapingByref();
1399 emission.IsEscapingByRef = isEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00001400
1401 CharUnits alignment = getContext().getDeclAlign(&D);
John McCallc533cb72011-02-22 06:44:22 +00001402
John McCall23c29fe2011-06-24 21:55:10 +00001403 // If the type is variably-modified, emit all the VLA sizes for it.
1404 if (Ty->isVariablyModifiedType())
1405 EmitVariablyModifiedType(Ty);
1406
Sander de Smalen891af03a2018-02-03 13:55:59 +00001407 auto *DI = getDebugInfo();
1408 bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >=
1409 codegenoptions::LimitedDebugInfo;
1410
John McCall7f416cc2015-09-08 08:05:57 +00001411 Address address = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001412 Address AllocaAddr = Address::invalid();
Eli Friedmana682d392008-02-15 12:20:59 +00001413 if (Ty->isConstantSizeType()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001414 bool NRVO = getLangOpts().ElideConstructors &&
1415 D.isNRVOVariable();
John McCallc533cb72011-02-22 06:44:22 +00001416
Richard Smith2bcde3a2013-06-02 00:09:52 +00001417 // If this value is an array or struct with a statically determinable
1418 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +00001419 //
1420 // TODO: We should constant-evaluate the initializer of any variable,
1421 // as long as it is initialized by a constant expression. Currently,
1422 // isConstantInitializer produces wrong answers for structs with
1423 // reference or bitfield members, and a few other cases, and checking
1424 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +00001425 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
1426 (D.isConstexpr() ||
1427 ((Ty.isPODType(getContext()) ||
1428 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
1429 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +00001430
Rafael Espindola609f5d92013-03-26 18:41:47 +00001431 // If the variable's a const type, and it's neither an NRVO
1432 // candidate nor a __block variable and has no mutable members,
1433 // emit it as a global instead.
Anastasia Stulovae4a1c382016-11-29 17:01:19 +00001434 // Exception is if a variable is located in non-constant address space
1435 // in OpenCL.
1436 if ((!getLangOpts().OpenCL ||
1437 Ty.getAddressSpace() == LangAS::opencl_constant) &&
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001438 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO &&
1439 !isEscapingByRef && CGM.isTypeConstant(Ty, true))) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001440 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +00001441
John McCall7f416cc2015-09-08 08:05:57 +00001442 // Signal this condition to later callbacks.
1443 emission.Addr = Address::invalid();
Rafael Espindola609f5d92013-03-26 18:41:47 +00001444 assert(emission.wasEmittedAsGlobal());
1445 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +00001446 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001447
Rafael Espindola609f5d92013-03-26 18:41:47 +00001448 // Otherwise, tell the initialization code that we're in this case.
1449 emission.IsConstantAggregate = true;
1450 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001451
Rafael Espindola609f5d92013-03-26 18:41:47 +00001452 // A normal fixed sized variable becomes an alloca in the entry block,
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001453 // unless:
1454 // - it's an NRVO variable.
1455 // - we are compiling OpenMP and it's an OpenMP local variable.
Eric Christopher31ab1302011-08-23 22:38:00 +00001456
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001457 Address OpenMPLocalAddr =
1458 getLangOpts().OpenMP
1459 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
1460 : Address::invalid();
1461 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
1462 address = OpenMPLocalAddr;
1463 } else if (NRVO) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001464 // The named return value optimization: allocate this variable in the
1465 // return slot, so that we can elide the copy when returning this
1466 // variable (C++0x [class.copy]p34).
John McCall7f416cc2015-09-08 08:05:57 +00001467 address = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +00001468
Rafael Espindola609f5d92013-03-26 18:41:47 +00001469 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001470 const auto *RD = RecordTy->getDecl();
1471 const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1472 if ((CXXRD && !CXXRD->hasTrivialDestructor()) ||
1473 RD->isNonTrivialToPrimitiveDestroy()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001474 // Create a flag that is used to indicate when the NRVO was applied
1475 // to this variable. Set it to zero to indicate that NRVO was not
1476 // applied.
1477 llvm::Value *Zero = Builder.getFalse();
John McCall7f416cc2015-09-08 08:05:57 +00001478 Address NRVOFlag =
1479 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
Rafael Espindola609f5d92013-03-26 18:41:47 +00001480 EnsureInsertPoint();
1481 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +00001482
Rafael Espindola609f5d92013-03-26 18:41:47 +00001483 // Record the NRVO flag for this variable.
John McCall7f416cc2015-09-08 08:05:57 +00001484 NRVOFlags[&D] = NRVOFlag.getPointer();
1485 emission.NRVOFlag = NRVOFlag.getPointer();
Nadav Rotem1da30942013-03-23 06:43:35 +00001486 }
Douglas Gregor290c93e2010-05-15 06:46:45 +00001487 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001488 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001489 CharUnits allocaAlignment;
1490 llvm::Type *allocaTy;
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001491 if (isEscapingByRef) {
John McCall7f416cc2015-09-08 08:05:57 +00001492 auto &byrefInfo = getBlockByrefInfo(&D);
1493 allocaTy = byrefInfo.Type;
1494 allocaAlignment = byrefInfo.ByrefAlignment;
1495 } else {
1496 allocaTy = ConvertTypeForMem(Ty);
1497 allocaAlignment = alignment;
1498 }
Rafael Espindola609f5d92013-03-26 18:41:47 +00001499
John McCall999110f2015-09-08 09:18:30 +00001500 // Create the alloca. Note that we set the name separately from
1501 // building the instruction so that it's there even in no-asserts
1502 // builds.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001503 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName(),
1504 /*ArraySize=*/nullptr, &AllocaAddr);
Rafael Espindola609f5d92013-03-26 18:41:47 +00001505
Reid Kleckner1f88e932015-10-07 21:03:41 +00001506 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1507 // the catch parameter starts in the catchpad instruction, and we can't
1508 // insert code in those basic blocks.
1509 bool IsMSCatchParam =
1510 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1511
Vitaly Buka64c80b42016-10-26 05:42:30 +00001512 // Emit a lifetime intrinsic if meaningful. There's no point in doing this
1513 // if we don't have a valid insertion point (?).
Reid Kleckner1f88e932015-10-07 21:03:41 +00001514 if (HaveInsertPoint() && !IsMSCatchParam) {
Akira Hatanakafdcd18b2017-01-25 22:55:13 +00001515 // If there's a jump into the lifetime of this variable, its lifetime
1516 // gets broken up into several regions in IR, which requires more work
1517 // to handle correctly. For now, just omit the intrinsics; this is a
1518 // rare case, and it's better to just be conservatively correct.
1519 // PR28267.
1520 //
1521 // We have to do this in all language modes if there's a jump past the
1522 // declaration. We also have to do it in C if there's a jump to an
1523 // earlier point in the current block because non-VLA lifetimes begin as
1524 // soon as the containing block is entered, not when its variables
1525 // actually come into scope; suppressing the lifetime annotations
1526 // completely in this case is unnecessarily pessimistic, but again, this
1527 // is rare.
1528 if (!Bypasses.IsBypassed(&D) &&
1529 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) {
Vitaly Buka64c80b42016-10-26 05:42:30 +00001530 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1531 emission.SizeForLifetimeMarkers =
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001532 EmitLifetimeStart(size, AllocaAddr.getPointer());
Vitaly Buka64c80b42016-10-26 05:42:30 +00001533 }
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001534 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001535 assert(!emission.useLifetimeMarkers());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001536 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001537 }
Chris Lattner03df1222007-06-02 04:53:11 +00001538 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001539 EnsureInsertPoint();
1540
Anders Carlsson15949b32009-02-09 20:41:50 +00001541 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +00001542 // Save the stack.
John McCall7f416cc2015-09-08 08:05:57 +00001543 Address Stack =
1544 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +00001545
James Y Knight8799cae2019-02-03 21:53:49 +00001546 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie4ba525b2015-07-14 17:27:39 +00001547 llvm::Value *V = Builder.CreateCall(F);
Anders Carlsson30032882008-12-12 07:38:43 +00001548 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +00001549
1550 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +00001551
John McCalla464ff92010-07-21 06:13:08 +00001552 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +00001553 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001554 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +00001555 }
Mike Stump11289f42009-09-09 15:08:12 +00001556
Sander de Smalen891af03a2018-02-03 13:55:59 +00001557 auto VlaSize = getVLASize(Ty);
1558 llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type);
Anders Carlsson30032882008-12-12 07:38:43 +00001559
1560 // Allocate memory for the array.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001561 address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts,
1562 &AllocaAddr);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001563
1564 // If we have debug info enabled, properly describe the VLA dimensions for
1565 // this type by registering the vla size expression for each of the
1566 // dimensions.
1567 EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo);
Chris Lattner03df1222007-06-02 04:53:11 +00001568 }
Eli Friedmanf4084702008-12-20 23:11:59 +00001569
John McCall7f416cc2015-09-08 08:05:57 +00001570 setAddrOfLocalVar(&D, address);
1571 emission.Addr = address;
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001572 emission.AllocaAddr = AllocaAddr;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001573
1574 // Emit debug info for local var declaration.
Sander de Smalen891af03a2018-02-03 13:55:59 +00001575 if (EmitDebugInfo && HaveInsertPoint()) {
1576 DI->setLocation(D.getLocation());
1577 (void)DI->EmitDeclareOfAutoVariable(&D, address.getPointer(), Builder);
1578 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001579
Volodymyr Sapsai93317d82019-03-01 02:15:39 +00001580 if (D.hasAttr<AnnotateAttr>() && HaveInsertPoint())
John McCall7f416cc2015-09-08 08:05:57 +00001581 EmitVarAnnotations(&D, address.getPointer());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001582
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001583 // Make sure we call @llvm.lifetime.end.
1584 if (emission.useLifetimeMarkers())
1585 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker,
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001586 emission.getOriginalAllocatedAddress(),
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001587 emission.getSizeForLifetimeMarkers());
1588
John McCallc533cb72011-02-22 06:44:22 +00001589 return emission;
1590}
1591
JF Bastien6b239722018-05-19 04:21:26 +00001592static bool isCapturedBy(const VarDecl &, const Expr *);
1593
1594/// Determines whether the given __block variable is potentially
1595/// captured by the given statement.
1596static bool isCapturedBy(const VarDecl &Var, const Stmt *S) {
1597 if (const Expr *E = dyn_cast<Expr>(S))
1598 return isCapturedBy(Var, E);
1599 for (const Stmt *SubStmt : S->children())
1600 if (isCapturedBy(Var, SubStmt))
1601 return true;
1602 return false;
1603}
1604
John McCallc533cb72011-02-22 06:44:22 +00001605/// Determines whether the given __block variable is potentially
1606/// captured by the given expression.
JF Bastien6b239722018-05-19 04:21:26 +00001607static bool isCapturedBy(const VarDecl &Var, const Expr *E) {
John McCallc533cb72011-02-22 06:44:22 +00001608 // Skip the most common kinds of expressions that make
1609 // hierarchy-walking expensive.
JF Bastien6b239722018-05-19 04:21:26 +00001610 E = E->IgnoreParenCasts();
John McCallc533cb72011-02-22 06:44:22 +00001611
JF Bastien6b239722018-05-19 04:21:26 +00001612 if (const BlockExpr *BE = dyn_cast<BlockExpr>(E)) {
1613 const BlockDecl *Block = BE->getBlockDecl();
1614 for (const auto &I : Block->captures()) {
1615 if (I.getVariable() == &Var)
John McCallc533cb72011-02-22 06:44:22 +00001616 return true;
1617 }
1618
1619 // No need to walk into the subexpressions.
1620 return false;
1621 }
1622
JF Bastien6b239722018-05-19 04:21:26 +00001623 if (const StmtExpr *SE = dyn_cast<StmtExpr>(E)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001624 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001625 for (const auto *BI : CS->body())
JF Bastien6b239722018-05-19 04:21:26 +00001626 if (const auto *BIE = dyn_cast<Expr>(BI)) {
1627 if (isCapturedBy(Var, BIE))
1628 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001629 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001630 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001631 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001632 for (const auto *I : DS->decls()) {
1633 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1634 const Expr *Init = VD->getInit();
JF Bastien6b239722018-05-19 04:21:26 +00001635 if (Init && isCapturedBy(Var, Init))
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001636 return true;
1637 }
1638 }
1639 }
1640 else
1641 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1642 // Later, provide code to poke into statements for capture analysis.
1643 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001644 return false;
1645 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001646
JF Bastien6b239722018-05-19 04:21:26 +00001647 for (const Stmt *SubStmt : E->children())
1648 if (isCapturedBy(Var, SubStmt))
John McCallc533cb72011-02-22 06:44:22 +00001649 return true;
1650
1651 return false;
1652}
1653
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001654/// Determine whether the given initializer is trivial in the sense
Douglas Gregor82e1af22011-07-01 21:08:19 +00001655/// that it requires no code to be generated.
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001656bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
Douglas Gregor82e1af22011-07-01 21:08:19 +00001657 if (!Init)
1658 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001659
Douglas Gregor82e1af22011-07-01 21:08:19 +00001660 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1661 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1662 if (Constructor->isTrivial() &&
1663 Constructor->isDefaultConstructor() &&
1664 !Construct->requiresZeroInitialization())
1665 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001666
Douglas Gregor82e1af22011-07-01 21:08:19 +00001667 return false;
1668}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001669
John McCallc533cb72011-02-22 06:44:22 +00001670void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001671 assert(emission.Variable && "emission was not valid!");
1672
John McCallc533cb72011-02-22 06:44:22 +00001673 // If this was emitted as a global constant, we're done.
1674 if (emission.wasEmittedAsGlobal()) return;
1675
John McCall9e2e22f2011-02-22 07:16:58 +00001676 const VarDecl &D = *emission.Variable;
Adrian Prantl95b24e92015-02-03 20:00:54 +00001677 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
John McCallc533cb72011-02-22 06:44:22 +00001678 QualType type = D.getType();
1679
JF Bastien14daa202018-12-18 05:12:21 +00001680 bool isVolatile = type.isVolatileQualified();
1681
Chris Lattner07eb7332007-07-12 00:39:48 +00001682 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001683 const Expr *Init = D.getInit();
1684
1685 // If we are at an unreachable point, we don't need to emit the initializer
1686 // unless it contains a label.
1687 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001688 if (!Init || !ContainsLabel(Init)) return;
1689 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001690 }
1691
John McCall73064872011-03-31 01:59:53 +00001692 // Initialize the structure of a __block variable.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001693 if (emission.IsEscapingByRef)
John McCall73064872011-03-31 01:59:53 +00001694 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001695
Akira Hatanaka7275da02018-02-28 07:15:55 +00001696 // Initialize the variable here if it doesn't have a initializer and it is a
1697 // C struct that is non-trivial to initialize or an array containing such a
1698 // struct.
1699 if (!Init &&
1700 type.isNonTrivialToPrimitiveDefaultInitialize() ==
1701 QualType::PDIK_Struct) {
1702 LValue Dst = MakeAddrLValue(emission.getAllocatedAddress(), type);
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001703 if (emission.IsEscapingByRef)
Akira Hatanaka7275da02018-02-28 07:15:55 +00001704 drillIntoBlockVariable(*this, Dst, &D);
1705 defaultInitNonTrivialCStructVar(Dst);
1706 return;
1707 }
1708
John McCallc533cb72011-02-22 06:44:22 +00001709 // Check whether this is a byref variable that's potentially
1710 // captured and moved by its own initializer. If so, we'll need to
1711 // emit the initializer first, then copy into the variable.
JF Bastien14daa202018-12-18 05:12:21 +00001712 bool capturedByInit =
1713 Init && emission.IsEscapingByRef && isCapturedBy(D, Init);
John McCallc533cb72011-02-22 06:44:22 +00001714
JF Bastien0bae08a2019-02-15 17:26:29 +00001715 bool locIsByrefHeader = !capturedByInit;
1716 const Address Loc =
1717 locIsByrefHeader ? emission.getObjectAddress(*this) : emission.Addr;
JF Bastien14daa202018-12-18 05:12:21 +00001718
1719 // Note: constexpr already initializes everything correctly.
1720 LangOptions::TrivialAutoVarInitKind trivialAutoVarInit =
1721 (D.isConstexpr()
1722 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1723 : (D.getAttr<UninitializedAttr>()
1724 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1725 : getContext().getLangOpts().getTrivialAutoVarInit()));
1726
JF Bastienb347e752019-02-08 01:29:17 +00001727 auto initializeWhatIsTechnicallyUninitialized = [&](Address Loc) {
JF Bastien14daa202018-12-18 05:12:21 +00001728 if (trivialAutoVarInit ==
1729 LangOptions::TrivialAutoVarInitKind::Uninitialized)
1730 return;
1731
JF Bastienb347e752019-02-08 01:29:17 +00001732 // Only initialize a __block's storage: we always initialize the header.
JF Bastien0bae08a2019-02-15 17:26:29 +00001733 if (emission.IsEscapingByRef && !locIsByrefHeader)
JF Bastienb347e752019-02-08 01:29:17 +00001734 Loc = emitBlockByrefAddress(Loc, &D, /*follow=*/false);
1735
JF Bastien14daa202018-12-18 05:12:21 +00001736 CharUnits Size = getContext().getTypeSizeInChars(type);
1737 if (!Size.isZero()) {
1738 switch (trivialAutoVarInit) {
1739 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1740 llvm_unreachable("Uninitialized handled above");
1741 case LangOptions::TrivialAutoVarInitKind::Zero:
1742 emitStoresForZeroInit(CGM, D, Loc, isVolatile, Builder);
1743 break;
1744 case LangOptions::TrivialAutoVarInitKind::Pattern:
1745 emitStoresForPatternInit(CGM, D, Loc, isVolatile, Builder);
1746 break;
1747 }
1748 return;
1749 }
1750
1751 // VLAs look zero-sized to getTypeInfo. We can't emit constant stores to
1752 // them, so emit a memcpy with the VLA size to initialize each element.
1753 // Technically zero-sized or negative-sized VLAs are undefined, and UBSan
1754 // will catch that code, but there exists code which generates zero-sized
1755 // VLAs. Be nice and initialize whatever they requested.
JF Bastienddeb2f22019-02-08 00:51:05 +00001756 const auto *VlaType = getContext().getAsVariableArrayType(type);
JF Bastien14daa202018-12-18 05:12:21 +00001757 if (!VlaType)
1758 return;
1759 auto VlaSize = getVLASize(VlaType);
1760 auto SizeVal = VlaSize.NumElts;
1761 CharUnits EltSize = getContext().getTypeSizeInChars(VlaSize.Type);
1762 switch (trivialAutoVarInit) {
1763 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1764 llvm_unreachable("Uninitialized handled above");
1765
1766 case LangOptions::TrivialAutoVarInitKind::Zero:
1767 if (!EltSize.isOne())
1768 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1769 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1770 isVolatile);
1771 break;
1772
1773 case LangOptions::TrivialAutoVarInitKind::Pattern: {
1774 llvm::Type *ElTy = Loc.getElementType();
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001775 llvm::Constant *Constant =
1776 constWithPadding(CGM, IsPattern::Yes, patternFor(CGM, ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001777 CharUnits ConstantAlign = getContext().getTypeAlignInChars(VlaSize.Type);
1778 llvm::BasicBlock *SetupBB = createBasicBlock("vla-setup.loop");
1779 llvm::BasicBlock *LoopBB = createBasicBlock("vla-init.loop");
1780 llvm::BasicBlock *ContBB = createBasicBlock("vla-init.cont");
1781 llvm::Value *IsZeroSizedVLA = Builder.CreateICmpEQ(
1782 SizeVal, llvm::ConstantInt::get(SizeVal->getType(), 0),
1783 "vla.iszerosized");
1784 Builder.CreateCondBr(IsZeroSizedVLA, ContBB, SetupBB);
1785 EmitBlock(SetupBB);
1786 if (!EltSize.isOne())
1787 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1788 llvm::Value *BaseSizeInChars =
1789 llvm::ConstantInt::get(IntPtrTy, EltSize.getQuantity());
1790 Address Begin = Builder.CreateElementBitCast(Loc, Int8Ty, "vla.begin");
1791 llvm::Value *End =
1792 Builder.CreateInBoundsGEP(Begin.getPointer(), SizeVal, "vla.end");
1793 llvm::BasicBlock *OriginBB = Builder.GetInsertBlock();
1794 EmitBlock(LoopBB);
1795 llvm::PHINode *Cur = Builder.CreatePHI(Begin.getType(), 2, "vla.cur");
1796 Cur->addIncoming(Begin.getPointer(), OriginBB);
1797 CharUnits CurAlign = Loc.getAlignment().alignmentOfArrayElement(EltSize);
1798 Builder.CreateMemCpy(
1799 Address(Cur, CurAlign),
1800 createUnnamedGlobalFrom(CGM, D, Builder, Constant, ConstantAlign),
1801 BaseSizeInChars, isVolatile);
1802 llvm::Value *Next =
1803 Builder.CreateInBoundsGEP(Int8Ty, Cur, BaseSizeInChars, "vla.next");
1804 llvm::Value *Done = Builder.CreateICmpEQ(Next, End, "vla-init.isdone");
1805 Builder.CreateCondBr(Done, ContBB, LoopBB);
1806 Cur->addIncoming(Next, LoopBB);
1807 EmitBlock(ContBB);
1808 } break;
1809 }
1810 };
1811
1812 if (isTrivialInitializer(Init)) {
JF Bastienb347e752019-02-08 01:29:17 +00001813 initializeWhatIsTechnicallyUninitialized(Loc);
JF Bastien14daa202018-12-18 05:12:21 +00001814 return;
1815 }
John McCallc533cb72011-02-22 06:44:22 +00001816
Craig Topper8a13c412014-05-21 05:09:00 +00001817 llvm::Constant *constant = nullptr;
Richard Smith2bcde3a2013-06-02 00:09:52 +00001818 if (emission.IsConstantAggregate || D.isConstexpr()) {
Richard Smithfddd3842011-12-30 21:15:51 +00001819 assert(!capturedByInit && "constant init contains a capturing block?");
John McCallde0fe072017-08-15 21:42:52 +00001820 constant = ConstantEmitter(*this).tryEmitAbstractForInitializer(D);
JF Bastien14daa202018-12-18 05:12:21 +00001821 if (constant && trivialAutoVarInit !=
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001822 LangOptions::TrivialAutoVarInitKind::Uninitialized) {
1823 IsPattern isPattern =
1824 (trivialAutoVarInit == LangOptions::TrivialAutoVarInitKind::Pattern)
1825 ? IsPattern::Yes
1826 : IsPattern::No;
1827 constant = constWithPadding(CGM, isPattern,
1828 replaceUndef(CGM, isPattern, constant));
1829 }
Richard Smithfddd3842011-12-30 21:15:51 +00001830 }
1831
1832 if (!constant) {
JF Bastienb347e752019-02-08 01:29:17 +00001833 initializeWhatIsTechnicallyUninitialized(Loc);
John McCall7f416cc2015-09-08 08:05:57 +00001834 LValue lv = MakeAddrLValue(Loc, type);
John McCall1553b192011-06-16 04:16:24 +00001835 lv.setNonGC(true);
David Blaikie66e41972015-01-14 07:38:27 +00001836 return EmitExprAsInit(Init, &D, lv, capturedByInit);
John McCall1553b192011-06-16 04:16:24 +00001837 }
John McCall91ca10f2011-03-08 09:11:50 +00001838
Richard Smith2bcde3a2013-06-02 00:09:52 +00001839 if (!emission.IsConstantAggregate) {
1840 // For simple scalar/complex initialization, store the value directly.
John McCall7f416cc2015-09-08 08:05:57 +00001841 LValue lv = MakeAddrLValue(Loc, type);
Richard Smith2bcde3a2013-06-02 00:09:52 +00001842 lv.setNonGC(true);
1843 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1844 }
1845
Yaxun Liudaceb1e2018-05-14 19:20:12 +00001846 llvm::Type *BP = CGM.Int8Ty->getPointerTo(Loc.getAddressSpace());
JF Bastien0bae08a2019-02-15 17:26:29 +00001847 emitStoresForConstant(
1848 CGM, D, (Loc.getType() == BP) ? Loc : Builder.CreateBitCast(Loc, BP),
1849 isVolatile, Builder, constant);
John McCall91ca10f2011-03-08 09:11:50 +00001850}
1851
Richard Smithe78fac52018-04-05 20:52:58 +00001852/// Emit an expression as an initializer for an object (variable, field, etc.)
1853/// at the given location. The expression is not necessarily the normal
1854/// initializer for the object, and the address is not necessarily
John McCall91ca10f2011-03-08 09:11:50 +00001855/// its normal location.
1856///
1857/// \param init the initializing expression
Richard Smithe78fac52018-04-05 20:52:58 +00001858/// \param D the object to act as if we're initializing
John McCall91ca10f2011-03-08 09:11:50 +00001859/// \param loc the address to initialize; its type is a pointer
Richard Smithe78fac52018-04-05 20:52:58 +00001860/// to the LLVM mapping of the object's type
John McCall91ca10f2011-03-08 09:11:50 +00001861/// \param alignment the alignment of the address
Richard Smithe78fac52018-04-05 20:52:58 +00001862/// \param capturedByInit true if \p D is a __block variable
John McCall91ca10f2011-03-08 09:11:50 +00001863/// whose address is potentially changed by the initializer
David Blaikie73ca5692014-12-09 00:32:22 +00001864void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +00001865 LValue lvalue, bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001866 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001867
1868 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001869 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001870 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001871 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001872 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001873 return;
1874 }
1875 switch (getEvaluationKind(type)) {
1876 case TEK_Scalar:
David Blaikie66e41972015-01-14 07:38:27 +00001877 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001878 return;
1879 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001880 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001881 if (capturedByInit)
1882 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001883 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
John McCall47fb9502013-03-07 21:37:08 +00001884 return;
1885 }
1886 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001887 if (type->isAtomicType()) {
1888 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1889 } else {
Richard Smithe78fac52018-04-05 20:52:58 +00001890 AggValueSlot::Overlap_t Overlap = AggValueSlot::MayOverlap;
1891 if (isa<VarDecl>(D))
1892 Overlap = AggValueSlot::DoesNotOverlap;
1893 else if (auto *FD = dyn_cast<FieldDecl>(D))
1894 Overlap = overlapForFieldInit(FD);
John McCalla8ec7eb2013-03-07 21:37:17 +00001895 // TODO: how can we delay here if D is captured by its initializer?
1896 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001897 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001898 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001899 AggValueSlot::IsNotAliased,
1900 Overlap));
John McCalla8ec7eb2013-03-07 21:37:17 +00001901 }
John McCall47fb9502013-03-07 21:37:08 +00001902 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001903 }
John McCall47fb9502013-03-07 21:37:08 +00001904 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001905}
John McCallbd309292010-07-06 01:34:17 +00001906
John McCall82fe67b2011-07-09 01:37:26 +00001907/// Enter a destroy cleanup for the given local variable.
1908void CodeGenFunction::emitAutoVarTypeCleanup(
1909 const CodeGenFunction::AutoVarEmission &emission,
1910 QualType::DestructionKind dtorKind) {
1911 assert(dtorKind != QualType::DK_none);
1912
1913 // Note that for __block variables, we want to destroy the
1914 // original stack object, not the possibly forwarded object.
John McCall7f416cc2015-09-08 08:05:57 +00001915 Address addr = emission.getObjectAddress(*this);
John McCall82fe67b2011-07-09 01:37:26 +00001916
1917 const VarDecl *var = emission.Variable;
1918 QualType type = var->getType();
1919
1920 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001921 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001922
1923 switch (dtorKind) {
1924 case QualType::DK_none:
1925 llvm_unreachable("no cleanup for trivially-destructible variable");
1926
1927 case QualType::DK_cxx_destructor:
1928 // If there's an NRVO flag on the emission, we need a different
1929 // cleanup.
1930 if (emission.NRVOFlag) {
1931 assert(!type->isArrayType());
1932 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001933 EHStack.pushCleanup<DestroyNRVOVariableCXX>(cleanupKind, addr, dtor,
1934 emission.NRVOFlag);
John McCall82fe67b2011-07-09 01:37:26 +00001935 return;
1936 }
1937 break;
1938
1939 case QualType::DK_objc_strong_lifetime:
1940 // Suppress cleanups for pseudo-strong variables.
1941 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001942
John McCall82fe67b2011-07-09 01:37:26 +00001943 // Otherwise, consider whether to use an EH cleanup or not.
1944 cleanupKind = getARCCleanupKind();
1945
1946 // Use the imprecise destroyer by default.
1947 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1948 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1949 break;
1950
1951 case QualType::DK_objc_weak_lifetime:
1952 break;
Akira Hatanaka7275da02018-02-28 07:15:55 +00001953
1954 case QualType::DK_nontrivial_c_struct:
1955 destroyer = CodeGenFunction::destroyNonTrivialCStruct;
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001956 if (emission.NRVOFlag) {
1957 assert(!type->isArrayType());
1958 EHStack.pushCleanup<DestroyNRVOVariableC>(cleanupKind, addr,
1959 emission.NRVOFlag, type);
1960 return;
1961 }
Akira Hatanaka7275da02018-02-28 07:15:55 +00001962 break;
John McCall82fe67b2011-07-09 01:37:26 +00001963 }
1964
1965 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001966 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001967
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001968 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001969 // is being pushed as an EH cleanup.
1970 bool useEHCleanup = (cleanupKind & EHCleanup);
1971 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1972 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001973}
1974
John McCallc533cb72011-02-22 06:44:22 +00001975void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001976 assert(emission.Variable && "emission was not valid!");
1977
John McCallc533cb72011-02-22 06:44:22 +00001978 // If this was emitted as a global constant, we're done.
1979 if (emission.wasEmittedAsGlobal()) return;
1980
John McCall8c38d352012-04-13 18:44:05 +00001981 // If we don't have an insertion point, we're done. Sema prevents
1982 // us from jumping into any of these scopes anyway.
1983 if (!HaveInsertPoint()) return;
1984
John McCall9e2e22f2011-02-22 07:16:58 +00001985 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001986
John McCall82fe67b2011-07-09 01:37:26 +00001987 // Check the type for a cleanup.
1988 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1989 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001990
John McCall1bd25562011-06-24 23:21:27 +00001991 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001992 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001993 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1994 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1995 }
1996
John McCallc533cb72011-02-22 06:44:22 +00001997 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001998 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001999 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00002000
John McCallc533cb72011-02-22 06:44:22 +00002001 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002002 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00002003
John McCalla729c622012-02-17 03:33:10 +00002004 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00002005 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002006 }
Mike Stump626aecc2009-03-05 01:23:13 +00002007
John McCallc533cb72011-02-22 06:44:22 +00002008 // If this is a block variable, call _Block_object_destroy
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002009 // (on the unforwarded address). Don't enter this cleanup if we're in pure-GC
2010 // mode.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002011 if (emission.IsEscapingByRef &&
2012 CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002013 BlockFieldFlags Flags = BLOCK_FIELD_IS_BYREF;
2014 if (emission.Variable->getType().isObjCGCWeak())
2015 Flags |= BLOCK_FIELD_IS_WEAK;
2016 enterByrefCleanup(NormalAndEHCleanup, emission.Addr, Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00002017 /*LoadBlockVarAddr*/ false,
2018 cxxDestructorCanThrow(emission.Variable->getType()));
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002019 }
Chris Lattner03df1222007-06-02 04:53:11 +00002020}
Chris Lattner53621a52007-06-13 20:44:40 +00002021
Peter Collingbourne1425b452012-01-26 03:33:36 +00002022CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00002023CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
2024 switch (kind) {
2025 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00002026 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002027 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00002028 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002029 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00002030 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002031 return destroyARCWeak;
Akira Hatanaka7275da02018-02-28 07:15:55 +00002032 case QualType::DK_nontrivial_c_struct:
2033 return destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00002034 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00002035 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00002036}
2037
John McCall12cc42a2013-02-01 05:11:40 +00002038/// pushEHDestroy - Push the standard destructor for the given type as
2039/// an EH-only cleanup.
2040void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002041 Address addr, QualType type) {
John McCall12cc42a2013-02-01 05:11:40 +00002042 assert(dtorKind && "cannot push destructor for trivial type");
2043 assert(needsEHCleanup(dtorKind));
2044
2045 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
2046}
2047
2048/// pushDestroy - Push the standard destructor for the given type as
2049/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00002050void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002051 Address addr, QualType type) {
John McCall4bd0fb12011-07-12 16:41:08 +00002052 assert(dtorKind && "cannot push destructor for trivial type");
2053
2054 CleanupKind cleanupKind = getCleanupKind(dtorKind);
2055 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
2056 cleanupKind & EHCleanup);
2057}
2058
John McCall7f416cc2015-09-08 08:05:57 +00002059void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002060 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002061 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00002062 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
2063 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002064}
2065
John McCall7f416cc2015-09-08 08:05:57 +00002066void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002067 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
2068}
2069
Richard Smith736a9472013-06-12 20:42:33 +00002070void CodeGenFunction::pushLifetimeExtendedDestroy(
John McCall7f416cc2015-09-08 08:05:57 +00002071 CleanupKind cleanupKind, Address addr, QualType type,
Richard Smith736a9472013-06-12 20:42:33 +00002072 Destroyer *destroyer, bool useEHCleanupForArray) {
Richard Smith736a9472013-06-12 20:42:33 +00002073 // Push an EH-only cleanup for the object now.
2074 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
2075 // around in case a temporary's destructor throws an exception.
2076 if (cleanupKind & EHCleanup)
2077 EHStack.pushCleanup<DestroyObject>(
2078 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
2079 destroyer, useEHCleanupForArray);
2080
2081 // Remember that we need to push a full cleanup for the object at the
2082 // end of the full-expression.
2083 pushCleanupAfterFullExpr<DestroyObject>(
2084 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
2085}
2086
John McCall178360e2011-07-11 08:38:19 +00002087/// emitDestroy - Immediately perform the destruction of the given
2088/// object.
2089///
2090/// \param addr - the address of the object; a type*
2091/// \param type - the type of the object; if an array type, all
2092/// objects are destroyed in reverse order
2093/// \param destroyer - the function to call to destroy individual
2094/// elements
2095/// \param useEHCleanupForArray - whether an EH cleanup should be
2096/// used when destroying array elements, in case one of the
2097/// destructions throws an exception
John McCall7f416cc2015-09-08 08:05:57 +00002098void CodeGenFunction::emitDestroy(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002099 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002100 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00002101 const ArrayType *arrayType = getContext().getAsArrayType(type);
2102 if (!arrayType)
2103 return destroyer(*this, addr, type);
2104
John McCall7f416cc2015-09-08 08:05:57 +00002105 llvm::Value *length = emitArrayLength(arrayType, type, addr);
2106
2107 CharUnits elementAlign =
2108 addr.getAlignment()
2109 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
John McCall97eab0a2011-07-13 08:09:46 +00002110
2111 // Normally we have to check whether the array is zero-length.
2112 bool checkZeroLength = true;
2113
2114 // But if the array length is constant, we can suppress that.
2115 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
2116 // ...and if it's constant zero, we can just skip the entire thing.
2117 if (constLength->isZero()) return;
2118 checkZeroLength = false;
2119 }
2120
John McCall7f416cc2015-09-08 08:05:57 +00002121 llvm::Value *begin = addr.getPointer();
John McCall82fe67b2011-07-09 01:37:26 +00002122 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall7f416cc2015-09-08 08:05:57 +00002123 emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002124 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002125}
2126
John McCall178360e2011-07-11 08:38:19 +00002127/// emitArrayDestroy - Destroys all the elements of the given array,
2128/// beginning from last to first. The array cannot be zero-length.
2129///
2130/// \param begin - a type* denoting the first element of the array
2131/// \param end - a type* denoting one past the end of the array
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00002132/// \param elementType - the element type of the array
John McCall178360e2011-07-11 08:38:19 +00002133/// \param destroyer - the function to call to destroy elements
2134/// \param useEHCleanup - whether to push an EH cleanup to destroy
2135/// the remaining elements in case the destruction of a single
2136/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00002137void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
2138 llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002139 QualType elementType,
2140 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002141 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002142 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00002143 bool useEHCleanup) {
John McCall7f416cc2015-09-08 08:05:57 +00002144 assert(!elementType->isArrayType());
John McCall82fe67b2011-07-09 01:37:26 +00002145
2146 // The basic structure here is a do-while loop, because we don't
2147 // need to check for the zero-element case.
2148 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
2149 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
2150
John McCall97eab0a2011-07-13 08:09:46 +00002151 if (checkZeroLength) {
2152 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
2153 "arraydestroy.isempty");
2154 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
2155 }
2156
John McCall82fe67b2011-07-09 01:37:26 +00002157 // Enter the loop body, making that address the current address.
2158 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
2159 EmitBlock(bodyBB);
2160 llvm::PHINode *elementPast =
2161 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
2162 elementPast->addIncoming(end, entryBB);
2163
2164 // Shift the address back by one element.
2165 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
2166 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
2167 "arraydestroy.element");
2168
John McCall178360e2011-07-11 08:38:19 +00002169 if (useEHCleanup)
John McCall7f416cc2015-09-08 08:05:57 +00002170 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
2171 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002172
John McCall82fe67b2011-07-09 01:37:26 +00002173 // Perform the actual destruction there.
John McCall7f416cc2015-09-08 08:05:57 +00002174 destroyer(*this, Address(element, elementAlign), elementType);
John McCall82fe67b2011-07-09 01:37:26 +00002175
John McCall178360e2011-07-11 08:38:19 +00002176 if (useEHCleanup)
2177 PopCleanupBlock();
2178
John McCall82fe67b2011-07-09 01:37:26 +00002179 // Check whether we've reached the end.
2180 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
2181 Builder.CreateCondBr(done, doneBB, bodyBB);
2182 elementPast->addIncoming(element, Builder.GetInsertBlock());
2183
2184 // Done.
2185 EmitBlock(doneBB);
2186}
2187
John McCall178360e2011-07-11 08:38:19 +00002188/// Perform partial array destruction as if in an EH cleanup. Unlike
2189/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00002190static void emitPartialArrayDestroy(CodeGenFunction &CGF,
2191 llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002192 QualType type, CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002193 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00002194 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00002195 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00002196 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
2197 // VLAs don't require a GEP index to walk into.
2198 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00002199 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00002200 type = arrayType->getElementType();
2201 }
John McCall97eab0a2011-07-13 08:09:46 +00002202
2203 if (arrayDepth) {
John McCallf0f0b7a2015-09-14 18:57:08 +00002204 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
John McCall97eab0a2011-07-13 08:09:46 +00002205
John McCallf0f0b7a2015-09-14 18:57:08 +00002206 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
Jay Foad040dd822011-07-22 08:16:57 +00002207 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
2208 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00002209 }
2210
John McCall97eab0a2011-07-13 08:09:46 +00002211 // Destroy the array. We don't ever need an EH cleanup because we
2212 // assume that we're in an EH cleanup ourselves, so a throwing
2213 // destructor causes an immediate terminate.
John McCall7f416cc2015-09-08 08:05:57 +00002214 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002215 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00002216}
2217
John McCall82fe67b2011-07-09 01:37:26 +00002218namespace {
John McCall178360e2011-07-11 08:38:19 +00002219 /// RegularPartialArrayDestroy - a cleanup which performs a partial
2220 /// array destroy where the end pointer is regularly determined and
2221 /// does not need to be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002222 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall178360e2011-07-11 08:38:19 +00002223 llvm::Value *ArrayBegin;
2224 llvm::Value *ArrayEnd;
2225 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002226 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002227 CharUnits ElementAlign;
John McCall178360e2011-07-11 08:38:19 +00002228 public:
2229 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002230 QualType elementType, CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002231 CodeGenFunction::Destroyer *destroyer)
2232 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
John McCall7f416cc2015-09-08 08:05:57 +00002233 ElementType(elementType), Destroyer(destroyer),
2234 ElementAlign(elementAlign) {}
John McCall178360e2011-07-11 08:38:19 +00002235
Craig Topper4f12f102014-03-12 06:41:41 +00002236 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00002237 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002238 ElementType, ElementAlign, Destroyer);
John McCall178360e2011-07-11 08:38:19 +00002239 }
2240 };
2241
2242 /// IrregularPartialArrayDestroy - a cleanup which performs a
2243 /// partial array destroy where the end pointer is irregularly
2244 /// determined and must be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002245 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00002246 llvm::Value *ArrayBegin;
John McCall7f416cc2015-09-08 08:05:57 +00002247 Address ArrayEndPointer;
John McCall82fe67b2011-07-09 01:37:26 +00002248 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002249 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002250 CharUnits ElementAlign;
John McCall82fe67b2011-07-09 01:37:26 +00002251 public:
John McCall178360e2011-07-11 08:38:19 +00002252 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002253 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002254 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002255 CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002256 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00002257 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
John McCall7f416cc2015-09-08 08:05:57 +00002258 ElementType(elementType), Destroyer(destroyer),
2259 ElementAlign(elementAlign) {}
John McCall82fe67b2011-07-09 01:37:26 +00002260
Craig Topper4f12f102014-03-12 06:41:41 +00002261 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00002262 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00002263 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002264 ElementType, ElementAlign, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002265 }
2266 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002267} // end anonymous namespace
John McCall82fe67b2011-07-09 01:37:26 +00002268
John McCall178360e2011-07-11 08:38:19 +00002269/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00002270/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00002271/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002272///
John McCall82fe67b2011-07-09 01:37:26 +00002273/// \param elementType - the immediate element type of the array;
2274/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00002275void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002276 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002277 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002278 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002279 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002280 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
2281 arrayBegin, arrayEndPointer,
John McCall7f416cc2015-09-08 08:05:57 +00002282 elementType, elementAlign,
2283 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002284}
2285
2286/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
2287/// already-constructed elements of the given array. The cleanup
2288/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002289///
John McCall178360e2011-07-11 08:38:19 +00002290/// \param elementType - the immediate element type of the array;
2291/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00002292void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
2293 llvm::Value *arrayEnd,
2294 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002295 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002296 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002297 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00002298 arrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002299 elementType, elementAlign,
2300 destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002301}
2302
Nadav Rotem1da30942013-03-23 06:43:35 +00002303/// Lazily declare the @llvm.lifetime.start intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002304llvm::Function *CodeGenModule::getLLVMLifetimeStartFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002305 if (LifetimeStartFn)
2306 return LifetimeStartFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002307 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002308 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002309 return LifetimeStartFn;
2310}
2311
2312/// Lazily declare the @llvm.lifetime.end intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002313llvm::Function *CodeGenModule::getLLVMLifetimeEndFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002314 if (LifetimeEndFn)
2315 return LifetimeEndFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002316 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002317 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002318 return LifetimeEndFn;
2319}
2320
John McCall31168b02011-06-15 23:02:42 +00002321namespace {
2322 /// A cleanup to perform a release of an object at the end of a
2323 /// function. This is used to balance out the incoming +1 of a
2324 /// ns_consumed argument when we can't reasonably do that just by
2325 /// not doing the initial retain for a __block argument.
David Blaikie7e70d682015-08-18 22:40:54 +00002326 struct ConsumeARCParameter final : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00002327 ConsumeARCParameter(llvm::Value *param,
2328 ARCPreciseLifetime_t precise)
2329 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00002330
2331 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00002332 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00002333
Craig Topper4f12f102014-03-12 06:41:41 +00002334 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00002335 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00002336 }
2337 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002338} // end anonymous namespace
John McCall31168b02011-06-15 23:02:42 +00002339
Mike Stump11289f42009-09-09 15:08:12 +00002340/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00002341/// for the specified parameter and set up LocalDeclMap.
John McCall7f416cc2015-09-08 08:05:57 +00002342void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
2343 unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002344 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00002345 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002346 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00002347
John McCall7f416cc2015-09-08 08:05:57 +00002348 Arg.getAnyValue()->setName(D.getName());
John McCall147d0212011-02-22 22:38:33 +00002349
Adrian Prantl51936dd2013-03-14 17:53:33 +00002350 QualType Ty = D.getType();
2351
John McCall147d0212011-02-22 22:38:33 +00002352 // Use better IR generation for certain implicit parameters.
John McCall7f416cc2015-09-08 08:05:57 +00002353 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
John McCall147d0212011-02-22 22:38:33 +00002354 // The only implicit argument a block has is its literal.
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002355 // This may be passed as an inalloca'ed value on Windows x86.
John McCall147d0212011-02-22 22:38:33 +00002356 if (BlockInfo) {
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002357 llvm::Value *V = Arg.isIndirect()
2358 ? Builder.CreateLoad(Arg.getIndirectAddress())
2359 : Arg.getDirectValue();
2360 setBlockContextParameter(IPD, ArgNo, V);
John McCall147d0212011-02-22 22:38:33 +00002361 return;
2362 }
2363 }
2364
John McCall7f416cc2015-09-08 08:05:57 +00002365 Address DeclPtr = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002366 bool DoStore = false;
2367 bool IsScalar = hasScalarEvaluationKind(Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002368 // If we already have a pointer to the argument, reuse the input pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002369 if (Arg.isIndirect()) {
2370 DeclPtr = Arg.getIndirectAddress();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002371 // If we have a prettier pointer type at this point, bitcast to that.
John McCall7f416cc2015-09-08 08:05:57 +00002372 unsigned AS = DeclPtr.getType()->getAddressSpace();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002373 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
John McCall7f416cc2015-09-08 08:05:57 +00002374 if (DeclPtr.getType() != IRTy)
2375 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
Yaxun Liu5b330e82018-03-15 15:25:19 +00002376 // Indirect argument is in alloca address space, which may be different
2377 // from the default address space.
2378 auto AllocaAS = CGM.getASTAllocaAddressSpace();
2379 auto *V = DeclPtr.getPointer();
2380 auto SrcLangAS = getLangOpts().OpenCL ? LangAS::opencl_private : AllocaAS;
2381 auto DestLangAS =
2382 getLangOpts().OpenCL ? LangAS::opencl_private : LangAS::Default;
2383 if (SrcLangAS != DestLangAS) {
2384 assert(getContext().getTargetAddressSpace(SrcLangAS) ==
2385 CGM.getDataLayout().getAllocaAddrSpace());
2386 auto DestAS = getContext().getTargetAddressSpace(DestLangAS);
2387 auto *T = V->getType()->getPointerElementType()->getPointerTo(DestAS);
2388 DeclPtr = Address(getTargetHooks().performAddrSpaceCast(
2389 *this, V, SrcLangAS, DestLangAS, T, true),
2390 DeclPtr.getAlignment());
2391 }
John McCall7f416cc2015-09-08 08:05:57 +00002392
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002393 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner19819442014-07-25 21:39:46 +00002394 // Don't push a cleanup in a thunk for a method that will also emit a
2395 // cleanup.
Akira Hatanaka85282972018-05-15 21:00:30 +00002396 if (hasAggregateEvaluationKind(Ty) && !CurFuncIsThunk &&
2397 Ty->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Akira Hatanaka7275da02018-02-28 07:15:55 +00002398 if (QualType::DestructionKind DtorKind = Ty.isDestructedType()) {
2399 assert((DtorKind == QualType::DK_cxx_destructor ||
2400 DtorKind == QualType::DK_nontrivial_c_struct) &&
2401 "unexpected destructor type");
2402 pushDestroy(DtorKind, DeclPtr, Ty);
Akira Hatanakaccda3d22018-04-27 06:57:00 +00002403 CalleeDestructedParamCleanups[cast<ParmVarDecl>(&D)] =
2404 EHStack.stable_begin();
Akira Hatanaka7275da02018-02-28 07:15:55 +00002405 }
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002406 }
Chris Lattner53621a52007-06-13 20:44:40 +00002407 } else {
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00002408 // Check if the parameter address is controlled by OpenMP runtime.
2409 Address OpenMPLocalAddr =
2410 getLangOpts().OpenMP
2411 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
2412 : Address::invalid();
2413 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
2414 DeclPtr = OpenMPLocalAddr;
2415 } else {
2416 // Otherwise, create a temporary to hold the value.
2417 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D),
2418 D.getName() + ".addr");
2419 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002420 DoStore = true;
2421 }
Mike Stump11289f42009-09-09 15:08:12 +00002422
John McCall7f416cc2015-09-08 08:05:57 +00002423 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr);
2424
2425 LValue lv = MakeAddrLValue(DeclPtr, Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002426 if (IsScalar) {
John McCall31168b02011-06-15 23:02:42 +00002427 Qualifiers qs = Ty.getQualifiers();
John McCall31168b02011-06-15 23:02:42 +00002428 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
2429 // We honor __attribute__((ns_consumed)) for types with lifetime.
2430 // For __strong, it's handled by just skipping the initial retain;
2431 // otherwise we have to balance out the initial +1 with an extra
2432 // cleanup to do the release at the end of the function.
2433 bool isConsumed = D.hasAttr<NSConsumedAttr>();
2434
Erik Pilkington1e368822019-01-04 18:33:06 +00002435 // If a parameter is pseudo-strong then we can omit the implicit retain.
John McCalld4631322011-06-17 06:42:21 +00002436 if (D.isARCPseudoStrong()) {
Erik Pilkington1e368822019-01-04 18:33:06 +00002437 assert(lt == Qualifiers::OCL_Strong &&
2438 "pseudo-strong variable isn't strong?");
2439 assert(qs.hasConst() && "pseudo-strong variable should be const!");
John McCall31168b02011-06-15 23:02:42 +00002440 lt = Qualifiers::OCL_ExplicitNone;
2441 }
2442
Saleem Abdulrasoolda6784e2017-06-27 18:37:51 +00002443 // Load objects passed indirectly.
2444 if (Arg.isIndirect() && !ArgVal)
2445 ArgVal = Builder.CreateLoad(DeclPtr);
2446
John McCall31168b02011-06-15 23:02:42 +00002447 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002448 if (!isConsumed) {
2449 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2450 // use objc_storeStrong(&dest, value) for retaining the
2451 // object. But first, store a null into 'dest' because
2452 // objc_storeStrong attempts to release its old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002453 llvm::Value *Null = CGM.EmitNullConstant(D.getType());
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002454 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
John McCall7f416cc2015-09-08 08:05:57 +00002455 EmitARCStoreStrongCall(lv.getAddress(), ArgVal, true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002456 DoStore = false;
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002457 }
2458 else
John McCall31168b02011-06-15 23:02:42 +00002459 // Don't use objc_retainBlock for block pointers, because we
2460 // don't want to Block_copy something just because we got it
2461 // as a parameter.
John McCall7f416cc2015-09-08 08:05:57 +00002462 ArgVal = EmitARCRetainNonBlock(ArgVal);
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002463 }
John McCall31168b02011-06-15 23:02:42 +00002464 } else {
2465 // Push the cleanup for a consumed parameter.
John McCallcdda29c2013-03-13 03:10:54 +00002466 if (isConsumed) {
2467 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
2468 ? ARCPreciseLifetime : ARCImpreciseLifetime);
John McCall7f416cc2015-09-08 08:05:57 +00002469 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal,
John McCallcdda29c2013-03-13 03:10:54 +00002470 precise);
2471 }
John McCall31168b02011-06-15 23:02:42 +00002472
2473 if (lt == Qualifiers::OCL_Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00002474 EmitARCInitWeak(DeclPtr, ArgVal);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002475 DoStore = false; // The weak init is a store, no need to do two.
John McCall31168b02011-06-15 23:02:42 +00002476 }
2477 }
2478
2479 // Enter the cleanup scope.
2480 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
2481 }
Chris Lattner53621a52007-06-13 20:44:40 +00002482 }
2483
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002484 // Store the initial value into the alloca.
2485 if (DoStore)
John McCall7f416cc2015-09-08 08:05:57 +00002486 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002487
John McCall7f416cc2015-09-08 08:05:57 +00002488 setAddrOfLocalVar(&D, DeclPtr);
Sanjiv Gupta18de6242008-05-30 10:30:31 +00002489
2490 // Emit debug info for param declaration.
Alexey Samsonov74a38682012-05-04 07:39:27 +00002491 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002492 if (CGM.getCodeGenOpts().getDebugInfo() >=
2493 codegenoptions::LimitedDebugInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00002494 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00002495 }
2496 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002497
2498 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00002499 EmitVarAnnotations(&D, DeclPtr.getPointer());
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002500
2501 // We can only check return value nullability if all arguments to the
2502 // function satisfy their nullability preconditions. This makes it necessary
2503 // to emit null checks for args in the function body itself.
2504 if (requiresReturnValueNullabilityCheck()) {
2505 auto Nullability = Ty->getNullability(getContext());
2506 if (Nullability && *Nullability == NullabilityKind::NonNull) {
2507 SanitizerScope SanScope(this);
2508 RetValNullabilityPrecondition =
2509 Builder.CreateAnd(RetValNullabilityPrecondition,
2510 Builder.CreateIsNotNull(Arg.getAnyValue()));
2511 }
2512 }
Chris Lattner53621a52007-06-13 20:44:40 +00002513}
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00002514
Alexey Bataevc5b1d322016-03-04 09:22:22 +00002515void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
2516 CodeGenFunction *CGF) {
2517 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2518 return;
2519 getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
2520}
Kelvin Li1408f912018-09-26 04:28:39 +00002521
Michael Kruse251e1482019-02-01 20:25:04 +00002522void CodeGenModule::EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D,
2523 CodeGenFunction *CGF) {
2524 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2525 return;
2526 // FIXME: need to implement mapper code generation
2527}
2528
Kelvin Li1408f912018-09-26 04:28:39 +00002529void CodeGenModule::EmitOMPRequiresDecl(const OMPRequiresDecl *D) {
Patrick Lyster8f7f5862018-11-19 15:09:33 +00002530 getOpenMPRuntime().checkArchForUnifiedAddressing(*this, D);
Kelvin Li1408f912018-09-26 04:28:39 +00002531}