blob: 86e02d2d7e4a0d6078ebf9cb6c6406a29ac36e0b [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"
JF Bastienef202c32019-04-12 00:11:27 +000022#include "PatternInit.h"
Yaxun Liu6d96f1632017-05-18 18:51:09 +000023#include "TargetInfo.h"
Daniel Dunbarad319a72008-08-11 05:00:27 +000024#include "clang/AST/ASTContext.h"
Reid Kleckner98031782019-12-09 16:11:56 -080025#include "clang/AST/Attr.h"
Ken Dyck8c89d592009-12-22 14:23:30 +000026#include "clang/AST/CharUnits.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000027#include "clang/AST/Decl.h"
Anders Carlsson4c03d982008-08-25 01:38:19 +000028#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000029#include "clang/AST/DeclOpenMP.h"
Richard Trieu63688182018-12-11 03:18:39 +000030#include "clang/Basic/CodeGenOptions.h"
Nate Begemanfaae0812008-04-19 04:17:09 +000031#include "clang/Basic/SourceManager.h"
Chris Lattnerb781dc792008-05-08 05:58:21 +000032#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000033#include "clang/CodeGen/CGFunctionInfo.h"
JF Bastien2f0582f2018-09-21 13:54:09 +000034#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/GlobalVariable.h"
37#include "llvm/IR/Intrinsics.h"
38#include "llvm/IR/Type.h"
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +000039
Chris Lattner84915fa2007-06-02 04:16:21 +000040using namespace clang;
41using namespace CodeGen;
42
Chris Lattner1ad38f82007-06-09 01:20:56 +000043void CodeGenFunction::EmitDecl(const Decl &D) {
Chris Lattner1ad38f82007-06-09 01:20:56 +000044 switch (D.getKind()) {
David Majnemerd9b1a4f2015-11-04 03:40:30 +000045 case Decl::BuiltinTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000046 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +000047 case Decl::ExternCContext:
Douglas Gregor19043f02010-04-23 02:02:43 +000048 case Decl::Namespace:
49 case Decl::UnresolvedUsingTypename:
50 case Decl::ClassTemplateSpecialization:
51 case Decl::ClassTemplatePartialSpecialization:
Larisse Voufo39a1e502013-08-06 01:03:05 +000052 case Decl::VarTemplateSpecialization:
53 case Decl::VarTemplatePartialSpecialization:
Douglas Gregor19043f02010-04-23 02:02:43 +000054 case Decl::TemplateTypeParm:
55 case Decl::UnresolvedUsingValue:
Alexis Hunted053252010-05-30 07:21:58 +000056 case Decl::NonTypeTemplateParm:
Richard Smithbc491202017-02-17 20:05:37 +000057 case Decl::CXXDeductionGuide:
Douglas Gregor19043f02010-04-23 02:02:43 +000058 case Decl::CXXMethod:
59 case Decl::CXXConstructor:
60 case Decl::CXXDestructor:
61 case Decl::CXXConversion:
62 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +000063 case Decl::MSProperty:
Francois Pichetdf946c32010-11-21 06:49:41 +000064 case Decl::IndirectField:
Douglas Gregor19043f02010-04-23 02:02:43 +000065 case Decl::ObjCIvar:
Eric Christopher31ab1302011-08-23 22:38:00 +000066 case Decl::ObjCAtDefsField:
Chris Lattnerba9dddb2007-10-08 21:37:32 +000067 case Decl::ParmVar:
Douglas Gregor19043f02010-04-23 02:02:43 +000068 case Decl::ImplicitParam:
69 case Decl::ClassTemplate:
Larisse Voufo39a1e502013-08-06 01:03:05 +000070 case Decl::VarTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000071 case Decl::FunctionTemplate:
Richard Smith3f1b5d02011-05-05 21:57:07 +000072 case Decl::TypeAliasTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000073 case Decl::TemplateTemplateParm:
74 case Decl::ObjCMethod:
75 case Decl::ObjCCategory:
76 case Decl::ObjCProtocol:
77 case Decl::ObjCInterface:
78 case Decl::ObjCCategoryImpl:
79 case Decl::ObjCImplementation:
80 case Decl::ObjCProperty:
81 case Decl::ObjCCompatibleAlias:
Nico Weber66220292016-03-02 17:28:48 +000082 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +000083 case Decl::PragmaDetectMismatch:
Abramo Bagnarad7340582010-06-05 05:09:32 +000084 case Decl::AccessSpec:
Douglas Gregor19043f02010-04-23 02:02:43 +000085 case Decl::LinkageSpec:
Richard Smith8df390f2016-09-08 23:14:54 +000086 case Decl::Export:
Douglas Gregor19043f02010-04-23 02:02:43 +000087 case Decl::ObjCPropertyImpl:
Douglas Gregor19043f02010-04-23 02:02:43 +000088 case Decl::FileScopeAsm:
89 case Decl::Friend:
90 case Decl::FriendTemplate:
91 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +000092 case Decl::Captured:
Francois Pichet00c7e6c2011-08-14 03:52:19 +000093 case Decl::ClassScopeFunctionSpecialization:
David Blaikiebd483762013-05-20 04:58:53 +000094 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +000095 case Decl::ConstructorUsingShadow:
Douglas Gregor85f3f952015-07-07 03:57:15 +000096 case Decl::ObjCTypeParam:
Richard Smithda383632016-08-15 01:33:41 +000097 case Decl::Binding:
David Blaikie83d382b2011-09-23 05:06:16 +000098 llvm_unreachable("Declaration should not be in declstmts!");
Amjad Abouddc4531e2016-04-30 01:44:38 +000099 case Decl::Function: // void X();
100 case Decl::Record: // struct/union/class X;
101 case Decl::Enum: // enum X;
102 case Decl::EnumConstant: // enum ? { X = ? }
103 case Decl::CXXRecord: // struct/union/class X; [C++]
Anders Carlssonce2cd012009-12-03 17:26:31 +0000104 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner43e7f312011-02-18 02:08:43 +0000105 case Decl::Label: // __label__ x;
Douglas Gregorba345522011-12-02 23:23:56 +0000106 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +0000107 case Decl::OMPThreadPrivate:
Alexey Bataev25ed0c02019-03-07 17:54:44 +0000108 case Decl::OMPAllocate:
Alexey Bataev4244be22016-02-11 05:35:55 +0000109 case Decl::OMPCapturedExpr:
Kelvin Li1408f912018-09-26 04:28:39 +0000110 case Decl::OMPRequires:
Michael Han84324352013-02-22 17:15:32 +0000111 case Decl::Empty:
Saar Razd7aae332019-07-10 21:25:49 +0000112 case Decl::Concept:
Tykerb0561b32019-11-17 11:41:55 +0100113 case Decl::LifetimeExtendedTemporary:
Chris Lattner84915fa2007-06-02 04:16:21 +0000114 // None of these decls require codegen support.
115 return;
David Blaikieb7d1e1f2013-02-02 00:39:32 +0000116
David Blaikief121b932013-05-20 22:50:41 +0000117 case Decl::NamespaceAlias:
118 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000119 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
David Blaikief121b932013-05-20 22:50:41 +0000120 return;
David Blaikiebd483762013-05-20 04:58:53 +0000121 case Decl::Using: // using X; [C++]
122 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000123 DI->EmitUsingDecl(cast<UsingDecl>(D));
David Blaikiebd483762013-05-20 04:58:53 +0000124 return;
Richard Smith151c4562016-12-20 21:35:28 +0000125 case Decl::UsingPack:
126 for (auto *Using : cast<UsingPackDecl>(D).expansions())
127 EmitDecl(*Using);
128 return;
David Blaikie9f88fe82013-04-22 06:13:21 +0000129 case Decl::UsingDirective: // using namespace X; [C++]
130 if (CGDebugInfo *DI = getDebugInfo())
131 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
132 return;
Richard Smithbdb84f32016-07-22 23:36:59 +0000133 case Decl::Var:
134 case Decl::Decomposition: {
Daniel Dunbara7998072008-08-29 17:28:43 +0000135 const VarDecl &VD = cast<VarDecl>(D);
John McCall1c9c3fd2010-10-15 04:57:14 +0000136 assert(VD.isLocalVarDecl() &&
Daniel Dunbara7998072008-08-29 17:28:43 +0000137 "Should not see file-scope variables inside a function!");
Richard Smithda383632016-08-15 01:33:41 +0000138 EmitVarDecl(VD);
139 if (auto *DD = dyn_cast<DecompositionDecl>(&VD))
140 for (auto *B : DD->bindings())
141 if (auto *HD = B->getHoldingVar())
142 EmitVarDecl(*HD);
143 return;
Chris Lattner84915fa2007-06-02 04:16:21 +0000144 }
Mike Stump11289f42009-09-09 15:08:12 +0000145
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000146 case Decl::OMPDeclareReduction:
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000147 return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this);
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000148
Michael Kruse251e1482019-02-01 20:25:04 +0000149 case Decl::OMPDeclareMapper:
150 return CGM.EmitOMPDeclareMapper(cast<OMPDeclareMapperDecl>(&D), this);
151
Richard Smithdda56e42011-04-15 14:24:37 +0000152 case Decl::Typedef: // typedef int X;
153 case Decl::TypeAlias: { // using X = int; [C++0x]
154 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000155 QualType Ty = TD.getUnderlyingType();
Mike Stump11289f42009-09-09 15:08:12 +0000156
Anders Carlsson5d985f52008-12-20 21:51:53 +0000157 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000158 EmitVariablyModifiedType(Ty);
Hamza Soodd14003d2019-07-05 14:36:08 +0000159
160 return;
Anders Carlsson5d985f52008-12-20 21:51:53 +0000161 }
Daniel Dunbara7998072008-08-29 17:28:43 +0000162 }
Chris Lattner84915fa2007-06-02 04:16:21 +0000163}
Chris Lattner03df1222007-06-02 04:53:11 +0000164
John McCall1c9c3fd2010-10-15 04:57:14 +0000165/// EmitVarDecl - This method handles emission of any variable declaration
Chris Lattner03df1222007-06-02 04:53:11 +0000166/// inside a function, including static vars etc.
John McCall1c9c3fd2010-10-15 04:57:14 +0000167void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Yaxun Liu4f33b3d2017-05-15 14:47:47 +0000168 if (D.hasExternalStorage())
169 // Don't emit it now, allow it to be emitted lazily on its first use.
170 return;
171
172 // Some function-scope variable does not have static storage but still
173 // needs to be emitted like a static variable, e.g. a function-scope
174 // variable in constant address space in OpenCL.
175 if (D.getStorageDuration() != SD_Automatic) {
Alexey Baderbed40092017-11-15 11:38:17 +0000176 // Static sampler variables translated to function calls.
177 if (D.getType()->isSamplerT())
178 return;
179
Eric Christopher31ab1302011-08-23 22:38:00 +0000180 llvm::GlobalValue::LinkageTypes Linkage =
Rui Ueyama49a3ad22019-07-16 04:46:31 +0000181 CGM.getLLVMLinkageVarDefinition(&D, /*IsConstant=*/false);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000182
David Majnemer27d69db2014-04-28 22:17:59 +0000183 // FIXME: We need to force the emission/use of a guard variable for
184 // some variables even if we can constant-evaluate them because
185 // we can't guarantee every translation unit will constant-evaluate them.
Eric Christopher31ab1302011-08-23 22:38:00 +0000186
John McCall1c9c3fd2010-10-15 04:57:14 +0000187 return EmitStaticVarDecl(D, Linkage);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000188 }
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000189
Anastasia Stulovabcea6962015-09-30 14:08:20 +0000190 if (D.getType().getAddressSpace() == LangAS::opencl_local)
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000191 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
192
193 assert(D.hasLocalStorage());
194 return EmitAutoVarDecl(D);
Chris Lattner03df1222007-06-02 04:53:11 +0000195}
196
Reid Kleckner453e0562014-10-08 01:07:54 +0000197static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) {
198 if (CGM.getLangOpts().CPlusPlus)
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000199 return CGM.getMangledName(&D).str();
200
Reid Kleckner453e0562014-10-08 01:07:54 +0000201 // If this isn't C++, we don't need a mangled name, just a pretty one.
202 assert(!D.isExternallyVisible() && "name shouldn't matter");
203 std::string ContextName;
204 const DeclContext *DC = D.getDeclContext();
Alexey Bataev43f74392015-05-07 06:28:46 +0000205 if (auto *CD = dyn_cast<CapturedDecl>(DC))
206 DC = cast<DeclContext>(CD->getNonClosureContext());
Reid Kleckner453e0562014-10-08 01:07:54 +0000207 if (const auto *FD = dyn_cast<FunctionDecl>(DC))
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000208 ContextName = CGM.getMangledName(FD);
Reid Kleckner453e0562014-10-08 01:07:54 +0000209 else if (const auto *BD = dyn_cast<BlockDecl>(DC))
210 ContextName = CGM.getBlockMangledName(GlobalDecl(), BD);
211 else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC))
212 ContextName = OMD->getSelector().getAsString();
Chris Lattnere99c1102009-12-05 08:22:11 +0000213 else
David Blaikie83d382b2011-09-23 05:06:16 +0000214 llvm_unreachable("Unknown context for static var decl");
Eric Christopher31ab1302011-08-23 22:38:00 +0000215
Reid Kleckner453e0562014-10-08 01:07:54 +0000216 ContextName += "." + D.getNameAsString();
217 return ContextName;
Chris Lattnere99c1102009-12-05 08:22:11 +0000218}
219
Reid Kleckner453e0562014-10-08 01:07:54 +0000220llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl(
221 const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) {
222 // In general, we don't always emit static var decls once before we reference
223 // them. It is possible to reference them before emitting the function that
224 // contains them, and it is possible to emit the containing function multiple
225 // times.
226 if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D])
227 return ExistingGV;
228
Chris Lattnerfc4379f2008-04-06 23:10:54 +0000229 QualType Ty = D.getType();
Eli Friedmana682d392008-02-15 12:20:59 +0000230 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begemanfaae0812008-04-19 04:17:09 +0000231
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000232 // Use the label if the variable is renamed with the asm-label extension.
233 std::string Name;
Benjamin Kramer5642e192011-11-21 15:47:23 +0000234 if (D.hasAttr<AsmLabelAttr>())
Reid Kleckner453e0562014-10-08 01:07:54 +0000235 Name = getMangledName(&D);
Benjamin Kramer5642e192011-11-21 15:47:23 +0000236 else
Reid Kleckner453e0562014-10-08 01:07:54 +0000237 Name = getStaticDeclName(*this, D);
Nate Begemanfaae0812008-04-19 04:17:09 +0000238
Reid Kleckner453e0562014-10-08 01:07:54 +0000239 llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty);
Alexander Richardson6d989432017-10-15 18:48:14 +0000240 LangAS AS = GetGlobalVarAddressSpace(&D);
Yaxun Liucbf647c2017-07-08 13:24:52 +0000241 unsigned TargetAS = getContext().getTargetAddressSpace(AS);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000242
Yaxun Liua64a4912018-04-02 17:38:24 +0000243 // OpenCL variables in local address space and CUDA shared
244 // variables cannot have an initializer.
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000245 llvm::Constant *Init = nullptr;
Yaxun Liua64a4912018-04-02 17:38:24 +0000246 if (Ty.getAddressSpace() == LangAS::opencl_local ||
247 D.hasAttr<CUDASharedAttr>())
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000248 Init = llvm::UndefValue::get(LTy);
Yaxun Liua64a4912018-04-02 17:38:24 +0000249 else
250 Init = EmitNullConstant(Ty);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000251
Yaxun Liucbf647c2017-07-08 13:24:52 +0000252 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
253 getModule(), LTy, Ty.isConstant(getContext()), Linkage, Init, Name,
254 nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS);
Guillaume Chateletc79099e2019-10-03 13:00:29 +0000255 GV->setAlignment(getContext().getDeclAlign(&D).getAsAlign());
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000256
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +0000257 if (supportsCOMDAT() && GV->isWeakForLinker())
258 GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000259
Richard Smithfd3834f2013-04-13 02:43:54 +0000260 if (D.getTLSKind())
Reid Kleckner453e0562014-10-08 01:07:54 +0000261 setTLSMode(GV, D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000262
Rafael Espindola922f2aa2018-02-23 19:30:48 +0000263 setGVProperties(GV, &D);
264
Eli Benderskycb399432014-03-24 22:05:38 +0000265 // Make sure the result is of the correct type.
Alexander Richardson6d989432017-10-15 18:48:14 +0000266 LangAS ExpectedAS = Ty.getAddressSpace();
Reid Kleckner453e0562014-10-08 01:07:54 +0000267 llvm::Constant *Addr = GV;
Yaxun Liucbf647c2017-07-08 13:24:52 +0000268 if (AS != ExpectedAS) {
269 Addr = getTargetCodeGenInfo().performAddrSpaceCast(
270 *this, GV, AS, ExpectedAS,
271 LTy->getPointerTo(getContext().getTargetAddressSpace(ExpectedAS)));
Eli Benderskycb399432014-03-24 22:05:38 +0000272 }
273
Reid Kleckner453e0562014-10-08 01:07:54 +0000274 setStaticLocalDeclAddress(&D, Addr);
275
276 // Ensure that the static local gets initialized by making sure the parent
277 // function gets emitted eventually.
278 const Decl *DC = cast<Decl>(D.getDeclContext());
279
280 // We can't name blocks or captured statements directly, so try to emit their
281 // parents.
282 if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) {
283 DC = DC->getNonClosureContext();
284 // FIXME: Ensure that global blocks get emitted.
285 if (!DC)
286 return Addr;
287 }
288
289 GlobalDecl GD;
290 if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC))
291 GD = GlobalDecl(CD, Ctor_Base);
292 else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC))
293 GD = GlobalDecl(DD, Dtor_Base);
294 else if (const auto *FD = dyn_cast<FunctionDecl>(DC))
295 GD = GlobalDecl(FD);
296 else {
297 // Don't do anything for Obj-C method decls or global closures. We should
298 // never defer them.
299 assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl");
300 }
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000301 if (GD.getDecl()) {
302 // Disable emission of the parent function for the OpenMP device codegen.
303 CGOpenMPRuntime::DisableAutoDeclareTargetRAII NoDeclTarget(*this);
Reid Kleckner453e0562014-10-08 01:07:54 +0000304 (void)GetAddrOfGlobal(GD);
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000305 }
Reid Kleckner453e0562014-10-08 01:07:54 +0000306
307 return Addr;
Daniel Dunbar22a87f92009-02-25 19:24:29 +0000308}
309
Chandler Carruth84537952012-03-30 19:44:53 +0000310/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
311/// global variable that has already been created for it. If the initializer
312/// has a different type than GV does, this may free GV and return a different
313/// one. Otherwise it just returns GV.
314llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +0000315CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000316 llvm::GlobalVariable *GV) {
John McCallde0fe072017-08-15 21:42:52 +0000317 ConstantEmitter emitter(*this);
318 llvm::Constant *Init = emitter.tryEmitForInitializer(D);
John McCall70013b62010-07-15 23:40:35 +0000319
Chris Lattnere99c1102009-12-05 08:22:11 +0000320 // If constant emission failed, then this should be a C++ static
321 // initializer.
Chandler Carruth84537952012-03-30 19:44:53 +0000322 if (!Init) {
Richard Smith9c6890a2012-11-01 22:30:59 +0000323 if (!getLangOpts().CPlusPlus)
Chris Lattnere99c1102009-12-05 08:22:11 +0000324 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
Matthias Braun44bfe032017-01-10 17:43:01 +0000325 else if (HaveInsertPoint()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000326 // Since we have a static initializer, this global variable can't
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000327 // be constant.
Chandler Carruth84537952012-03-30 19:44:53 +0000328 GV->setConstant(false);
John McCall68ff0372010-09-08 01:44:27 +0000329
Chandler Carruth84537952012-03-30 19:44:53 +0000330 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000331 }
Chandler Carruth84537952012-03-30 19:44:53 +0000332 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000333 }
John McCall70013b62010-07-15 23:40:35 +0000334
Chris Lattnere99c1102009-12-05 08:22:11 +0000335 // The initializer may differ in type from the global. Rewrite
336 // the global to match the initializer. (We have to do this
337 // because some types, like unions, can't be completely represented
338 // in the LLVM type system.)
Chandler Carruth84537952012-03-30 19:44:53 +0000339 if (GV->getType()->getElementType() != Init->getType()) {
340 llvm::GlobalVariable *OldGV = GV;
341
342 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
343 OldGV->isConstant(),
344 OldGV->getLinkage(), Init, "",
345 /*InsertBefore*/ OldGV,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +0000346 OldGV->getThreadLocalMode(),
Chandler Carruth84537952012-03-30 19:44:53 +0000347 CGM.getContext().getTargetAddressSpace(D.getType()));
348 GV->setVisibility(OldGV->getVisibility());
Rafael Espindola699f5d62018-02-07 22:15:33 +0000349 GV->setDSOLocal(OldGV->isDSOLocal());
Reid Klecknereab97d32015-07-20 20:35:30 +0000350 GV->setComdat(OldGV->getComdat());
Eric Christopher31ab1302011-08-23 22:38:00 +0000351
Chris Lattnere99c1102009-12-05 08:22:11 +0000352 // Steal the name of the old global
Chandler Carruth84537952012-03-30 19:44:53 +0000353 GV->takeName(OldGV);
Eric Christopher31ab1302011-08-23 22:38:00 +0000354
Chris Lattnere99c1102009-12-05 08:22:11 +0000355 // Replace all uses of the old global with the new global
Chandler Carruth84537952012-03-30 19:44:53 +0000356 llvm::Constant *NewPtrForOldDecl =
357 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
358 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christopher31ab1302011-08-23 22:38:00 +0000359
Chris Lattnere99c1102009-12-05 08:22:11 +0000360 // Erase the old global, since it is no longer used.
Chandler Carruth84537952012-03-30 19:44:53 +0000361 OldGV->eraseFromParent();
Chris Lattnere99c1102009-12-05 08:22:11 +0000362 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000363
Chandler Carruth84537952012-03-30 19:44:53 +0000364 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
365 GV->setInitializer(Init);
Richard Smith6331c402012-02-13 22:16:19 +0000366
John McCallde0fe072017-08-15 21:42:52 +0000367 emitter.finalize(GV);
368
Richard Smith7a384682020-01-10 15:16:15 -0800369 if (D.needsDestruction(getContext()) == QualType::DK_cxx_destructor &&
370 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
Guillaume Chateletc79099e2019-10-03 13:00:29 +0000414 var->setAlignment(alignment.getAsAlign());
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());
Dmitry Mikulinf14642f2019-10-15 18:31:10 +0000425 if (auto *SA = D.getAttr<PragmaClangRelroSectionAttr>())
426 var->addAttribute("relro-section", SA->getName());
Javed Absar2a67c9e2017-06-05 10:11:57 +0000427
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000428 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000429 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000430
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000431 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000432 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000433
Chandler Carruth84537952012-03-30 19:44:53 +0000434 // We may have to cast the constant because of the initializer
435 // mismatch above.
436 //
437 // FIXME: It is really dangerous to store this in the map; if anyone
438 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000439 llvm::Constant *castedAddr =
440 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCall7f416cc2015-09-08 08:05:57 +0000441 if (var != castedAddr)
442 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
John McCallb88a5662012-03-30 21:00:39 +0000443 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000444
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000445 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
Alexey Samsonov4f319cc2014-07-02 16:54:41 +0000446
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000447 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000448 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000449 if (DI &&
Benjamin Kramer8c305922016-02-02 11:06:51 +0000450 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000451 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000452 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000453 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000454}
Mike Stump11289f42009-09-09 15:08:12 +0000455
John McCall2b7fc382010-07-13 20:32:21 +0000456namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000457 struct DestroyObject final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000458 DestroyObject(Address addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000459 CodeGenFunction::Destroyer *destroyer,
460 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000461 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000462 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000463
John McCall7f416cc2015-09-08 08:05:57 +0000464 Address addr;
John McCall82fe67b2011-07-09 01:37:26 +0000465 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000466 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000467 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000468
Craig Topper4f12f102014-03-12 06:41:41 +0000469 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000470 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000471 bool useEHCleanupForArray =
472 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000473
474 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000475 }
476 };
477
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000478 template <class Derived>
479 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
Marco Antognini88559632019-07-22 09:39:13 +0000480 DestroyNRVOVariable(Address addr, QualType type, llvm::Value *NRVOFlag)
481 : NRVOFlag(NRVOFlag), Loc(addr), Ty(type) {}
John McCall2b7fc382010-07-13 20:32:21 +0000482
John McCall2b7fc382010-07-13 20:32:21 +0000483 llvm::Value *NRVOFlag;
John McCall7f416cc2015-09-08 08:05:57 +0000484 Address Loc;
Marco Antognini88559632019-07-22 09:39:13 +0000485 QualType Ty;
John McCall2b7fc382010-07-13 20:32:21 +0000486
Craig Topper4f12f102014-03-12 06:41:41 +0000487 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000488 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000489 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000490
Craig Topper8a13c412014-05-21 05:09:00 +0000491 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000492 if (NRVO) {
493 // If we exited via NRVO, we skip the destructor call.
494 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
495 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
John McCall7f416cc2015-09-08 08:05:57 +0000496 llvm::Value *DidNRVO =
497 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
John McCall2b7fc382010-07-13 20:32:21 +0000498 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
499 CGF.EmitBlock(RunDtorBB);
500 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000501
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000502 static_cast<Derived *>(this)->emitDestructorCall(CGF);
John McCall2b7fc382010-07-13 20:32:21 +0000503
504 if (NRVO) CGF.EmitBlock(SkipDtorBB);
505 }
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000506
507 virtual ~DestroyNRVOVariable() = default;
508 };
509
510 struct DestroyNRVOVariableCXX final
511 : DestroyNRVOVariable<DestroyNRVOVariableCXX> {
Marco Antognini88559632019-07-22 09:39:13 +0000512 DestroyNRVOVariableCXX(Address addr, QualType type,
513 const CXXDestructorDecl *Dtor, llvm::Value *NRVOFlag)
514 : DestroyNRVOVariable<DestroyNRVOVariableCXX>(addr, type, NRVOFlag),
515 Dtor(Dtor) {}
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000516
517 const CXXDestructorDecl *Dtor;
518
519 void emitDestructorCall(CodeGenFunction &CGF) {
520 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
521 /*ForVirtualBase=*/false,
Marco Antognini88559632019-07-22 09:39:13 +0000522 /*Delegating=*/false, Loc, Ty);
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000523 }
524 };
525
526 struct DestroyNRVOVariableC final
527 : DestroyNRVOVariable<DestroyNRVOVariableC> {
528 DestroyNRVOVariableC(Address addr, llvm::Value *NRVOFlag, QualType Ty)
Marco Antognini88559632019-07-22 09:39:13 +0000529 : DestroyNRVOVariable<DestroyNRVOVariableC>(addr, Ty, NRVOFlag) {}
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000530
531 void emitDestructorCall(CodeGenFunction &CGF) {
532 CGF.destroyNonTrivialCStruct(CGF, Loc, Ty);
533 }
John McCall2b7fc382010-07-13 20:32:21 +0000534 };
John McCall2b7fc382010-07-13 20:32:21 +0000535
David Blaikie7e70d682015-08-18 22:40:54 +0000536 struct CallStackRestore final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000537 Address Stack;
538 CallStackRestore(Address Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000539 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000540 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
James Y Knight8799cae2019-02-03 21:53:49 +0000541 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
John McCalla464ff92010-07-21 06:13:08 +0000542 CGF.Builder.CreateCall(F, V);
543 }
544 };
545
David Blaikie7e70d682015-08-18 22:40:54 +0000546 struct ExtendGCLifetime final : EHScopeStack::Cleanup {
John McCall1bd25562011-06-24 23:21:27 +0000547 const VarDecl &Var;
548 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
549
Craig Topper4f12f102014-03-12 06:41:41 +0000550 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000551 // Compute the address of the local variable, in case it's a
552 // byref or something.
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000553 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000554 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000555 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
556 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000557 CGF.EmitExtendGCLifetime(value);
558 }
559 };
560
David Blaikie7e70d682015-08-18 22:40:54 +0000561 struct CallCleanupFunction final : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000562 llvm::Constant *CleanupFn;
563 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000564 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000565
John McCalla464ff92010-07-21 06:13:08 +0000566 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000567 const VarDecl *Var)
568 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000569
Craig Topper4f12f102014-03-12 06:41:41 +0000570 void Emit(CodeGenFunction &CGF, Flags flags) override {
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000571 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000572 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000573 // Compute the address of the local variable, in case it's a byref
574 // or something.
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800575 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer(CGF);
John McCallc533cb72011-02-22 06:44:22 +0000576
John McCalla464ff92010-07-21 06:13:08 +0000577 // In some cases, the type of the function argument will be different from
578 // the type of the pointer. An example of this is
579 // void f(void* arg);
580 // __attribute__((cleanup(f))) void *g;
581 //
582 // To fix this we insert a bitcast here.
583 QualType ArgTy = FnInfo.arg_begin()->type;
584 llvm::Value *Arg =
585 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
586
587 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000588 Args.add(RValue::get(Arg),
589 CGF.getContext().getPointerType(Var.getType()));
John McCallb92ab1a2016-10-26 23:46:34 +0000590 auto Callee = CGCallee::forDirect(CleanupFn);
591 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
John McCalla464ff92010-07-21 06:13:08 +0000592 }
593 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000594} // end anonymous namespace
John McCalla464ff92010-07-21 06:13:08 +0000595
John McCall31168b02011-06-15 23:02:42 +0000596/// EmitAutoVarWithLifetime - Does the setup required for an automatic
597/// variable with lifetime.
598static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
John McCall7f416cc2015-09-08 08:05:57 +0000599 Address addr,
John McCall31168b02011-06-15 23:02:42 +0000600 Qualifiers::ObjCLifetime lifetime) {
601 switch (lifetime) {
602 case Qualifiers::OCL_None:
603 llvm_unreachable("present but none");
604
605 case Qualifiers::OCL_ExplicitNone:
606 // nothing to do
607 break;
608
609 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000610 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000611 (var.hasAttr<ObjCPreciseLifetimeAttr>()
612 ? CodeGenFunction::destroyARCStrongPrecise
613 : CodeGenFunction::destroyARCStrongImprecise);
614
615 CleanupKind cleanupKind = CGF.getARCCleanupKind();
616 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
617 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000618 break;
619 }
620 case Qualifiers::OCL_Autoreleasing:
621 // nothing to do
622 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000623
John McCall31168b02011-06-15 23:02:42 +0000624 case Qualifiers::OCL_Weak:
625 // __weak objects always get EH cleanups; otherwise, exceptions
626 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000627 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
628 CodeGenFunction::destroyARCWeak,
629 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000630 break;
631 }
632}
633
634static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
635 if (const Expr *e = dyn_cast<Expr>(s)) {
636 // Skip the most common kinds of expressions that make
637 // hierarchy-walking expensive.
638 s = e = e->IgnoreParenCasts();
639
640 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
641 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000642 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
643 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000644 for (const auto &I : block->captures()) {
645 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000646 return true;
647 }
648 }
John McCall31168b02011-06-15 23:02:42 +0000649 }
650
Benjamin Kramer642f1732015-07-02 21:03:14 +0000651 for (const Stmt *SubStmt : s->children())
652 // SubStmt might be null; as in missing decl or conditional of an if-stmt.
653 if (SubStmt && isAccessedBy(var, SubStmt))
John McCall31168b02011-06-15 23:02:42 +0000654 return true;
655
656 return false;
657}
658
659static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
660 if (!decl) return false;
661 if (!isa<VarDecl>(decl)) return false;
662 const VarDecl *var = cast<VarDecl>(decl);
663 return isAccessedBy(*var, e);
664}
665
John McCallf8a9b662015-10-21 18:06:31 +0000666static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
667 const LValue &destLV, const Expr *init) {
John McCall0204e342015-11-16 22:11:41 +0000668 bool needsCast = false;
669
John McCallf8a9b662015-10-21 18:06:31 +0000670 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
671 switch (castExpr->getCastKind()) {
672 // Look through casts that don't require representation changes.
673 case CK_NoOp:
674 case CK_BitCast:
675 case CK_BlockPointerToObjCPointerCast:
John McCall0204e342015-11-16 22:11:41 +0000676 needsCast = true;
John McCallf8a9b662015-10-21 18:06:31 +0000677 break;
678
679 // If we find an l-value to r-value cast from a __weak variable,
680 // emit this operation as a copy or move.
681 case CK_LValueToRValue: {
682 const Expr *srcExpr = castExpr->getSubExpr();
683 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
684 return false;
685
686 // Emit the source l-value.
687 LValue srcLV = CGF.EmitLValue(srcExpr);
688
John McCall0204e342015-11-16 22:11:41 +0000689 // Handle a formal type change to avoid asserting.
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800690 auto srcAddr = srcLV.getAddress(CGF);
John McCall0204e342015-11-16 22:11:41 +0000691 if (needsCast) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800692 srcAddr = CGF.Builder.CreateElementBitCast(
693 srcAddr, destLV.getAddress(CGF).getElementType());
John McCall0204e342015-11-16 22:11:41 +0000694 }
695
John McCallf8a9b662015-10-21 18:06:31 +0000696 // If it was an l-value, use objc_copyWeak.
697 if (srcExpr->getValueKind() == VK_LValue) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800698 CGF.EmitARCCopyWeak(destLV.getAddress(CGF), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000699 } else {
700 assert(srcExpr->getValueKind() == VK_XValue);
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800701 CGF.EmitARCMoveWeak(destLV.getAddress(CGF), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000702 }
703 return true;
704 }
705
706 // Stop at anything else.
707 default:
708 return false;
709 }
710
711 init = castExpr->getSubExpr();
John McCallf8a9b662015-10-21 18:06:31 +0000712 }
713 return false;
714}
715
John McCall1553b192011-06-16 04:16:24 +0000716static void drillIntoBlockVariable(CodeGenFunction &CGF,
717 LValue &lvalue,
718 const VarDecl *var) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800719 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(CGF), var));
John McCall1553b192011-06-16 04:16:24 +0000720}
721
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000722void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS,
723 SourceLocation Loc) {
724 if (!SanOpts.has(SanitizerKind::NullabilityAssign))
725 return;
726
727 auto Nullability = LHS.getType()->getNullability(getContext());
728 if (!Nullability || *Nullability != NullabilityKind::NonNull)
729 return;
730
731 // Check if the right hand side of the assignment is nonnull, if the left
732 // hand side must be nonnull.
733 SanitizerScope SanScope(this);
734 llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS);
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000735 llvm::Constant *StaticData[] = {
736 EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()),
Simon Pilgrim2df19982017-03-14 21:43:52 +0000737 llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000738 llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)};
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000739 EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}},
740 SanitizerHandler::TypeMismatch, StaticData, RHS);
741}
742
David Blaikie73ca5692014-12-09 00:32:22 +0000743void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +0000744 LValue lvalue, bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000745 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000746 if (!lifetime) {
747 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000748 if (capturedByInit)
749 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000750 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
David Blaikie66e41972015-01-14 07:38:27 +0000751 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000752 return;
753 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000754
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000755 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
756 init = DIE->getExpr();
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000757
John McCall31168b02011-06-15 23:02:42 +0000758 // If we're emitting a value with lifetime, we have to do the
759 // initialization *before* we leave the cleanup scopes.
Bill Wendling7c44da22018-10-31 03:48:47 +0000760 if (const FullExpr *fe = dyn_cast<FullExpr>(init)) {
761 enterFullExpression(fe);
762 init = fe->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000763 }
764 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000765
766 // We have to maintain the illusion that the variable is
767 // zero-initialized. If the variable might be accessed in its
768 // initializer, zero-initialize before running the initializer, then
769 // actually perform the initialization with an assign.
770 bool accessedByInit = false;
771 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000772 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000773 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000774 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000775 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000776 if (capturedByInit) {
777 // We can use a simple GEP for this because it can't have been
778 // moved yet.
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800779 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(*this),
John McCall7f416cc2015-09-08 08:05:57 +0000780 cast<VarDecl>(D),
781 /*follow*/ false));
John McCall31168b02011-06-15 23:02:42 +0000782 }
783
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800784 auto ty =
785 cast<llvm::PointerType>(tempLV.getAddress(*this).getElementType());
Yaxun Liu402804b2016-12-15 08:09:08 +0000786 llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000787
John McCall31168b02011-06-15 23:02:42 +0000788 // If __weak, we want to use a barrier under certain conditions.
789 if (lifetime == Qualifiers::OCL_Weak)
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800790 EmitARCInitWeak(tempLV.getAddress(*this), zero);
John McCall31168b02011-06-15 23:02:42 +0000791
792 // Otherwise just do a simple store.
793 else
David Chisnallfa35df62012-01-16 17:27:18 +0000794 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000795 }
796
797 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000798 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000799
800 switch (lifetime) {
801 case Qualifiers::OCL_None:
802 llvm_unreachable("present but none");
803
Erik Pilkington1e368822019-01-04 18:33:06 +0000804 case Qualifiers::OCL_Strong: {
805 if (!D || !isa<VarDecl>(D) || !cast<VarDecl>(D)->isARCPseudoStrong()) {
806 value = EmitARCRetainScalarExpr(init);
807 break;
808 }
809 // If D is pseudo-strong, treat it like __unsafe_unretained here. This means
810 // that we omit the retain, and causes non-autoreleased return values to be
811 // immediately released.
812 LLVM_FALLTHROUGH;
813 }
814
John McCall31168b02011-06-15 23:02:42 +0000815 case Qualifiers::OCL_ExplicitNone:
John McCalle399e5b2016-01-27 18:32:30 +0000816 value = EmitARCUnsafeUnretainedScalarExpr(init);
John McCall31168b02011-06-15 23:02:42 +0000817 break;
818
John McCall31168b02011-06-15 23:02:42 +0000819 case Qualifiers::OCL_Weak: {
John McCallf8a9b662015-10-21 18:06:31 +0000820 // If it's not accessed by the initializer, try to emit the
821 // initialization with a copy or move.
822 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
823 return;
824 }
825
John McCall31168b02011-06-15 23:02:42 +0000826 // No way to optimize a producing initializer into this. It's not
827 // worth optimizing for, because the value will immediately
828 // disappear in the common case.
829 value = EmitScalarExpr(init);
830
John McCall1553b192011-06-16 04:16:24 +0000831 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000832 if (accessedByInit)
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800833 EmitARCStoreWeak(lvalue.getAddress(*this), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000834 else
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800835 EmitARCInitWeak(lvalue.getAddress(*this), value);
John McCall31168b02011-06-15 23:02:42 +0000836 return;
837 }
838
839 case Qualifiers::OCL_Autoreleasing:
840 value = EmitARCRetainAutoreleaseScalarExpr(init);
841 break;
842 }
843
John McCall1553b192011-06-16 04:16:24 +0000844 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000845
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000846 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
847
John McCall31168b02011-06-15 23:02:42 +0000848 // If the variable might have been accessed by its initializer, we
849 // might have to initialize with a barrier. We have to do this for
850 // both __weak and __strong, but __weak got filtered out above.
851 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000852 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000853 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000854 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000855 return;
856 }
857
David Chisnallfa35df62012-01-16 17:27:18 +0000858 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000859}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000860
JF Bastiened92f602018-07-20 23:37:12 +0000861/// Decide whether we can emit the non-zero parts of the specified initializer
862/// with equal or fewer than NumStores scalar stores.
863static bool canEmitInitWithFewStoresAfterBZero(llvm::Constant *Init,
864 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000865 // Zero and Undef never requires any extra stores.
866 if (isa<llvm::ConstantAggregateZero>(Init) ||
867 isa<llvm::ConstantPointerNull>(Init) ||
868 isa<llvm::UndefValue>(Init))
869 return true;
870 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
871 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
872 isa<llvm::ConstantExpr>(Init))
873 return Init->isNullValue() || NumStores--;
874
875 // See if we can emit each element.
876 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
877 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
878 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
JF Bastiened92f602018-07-20 23:37:12 +0000879 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattnere6af8862010-12-02 01:58:41 +0000880 return false;
881 }
882 return true;
883 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000884
Chris Lattner236b3572012-01-31 04:36:19 +0000885 if (llvm::ConstantDataSequential *CDS =
886 dyn_cast<llvm::ConstantDataSequential>(Init)) {
887 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
888 llvm::Constant *Elt = CDS->getElementAsConstant(i);
JF Bastiened92f602018-07-20 23:37:12 +0000889 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattner236b3572012-01-31 04:36:19 +0000890 return false;
891 }
892 return true;
893 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000894
Chris Lattnerb85025f2010-12-01 02:05:19 +0000895 // Anything else is hard and scary.
896 return false;
897}
898
JF Bastiened92f602018-07-20 23:37:12 +0000899/// For inits that canEmitInitWithFewStoresAfterBZero returned true for, emit
900/// the scalar stores that would be required.
901static void emitStoresForInitAfterBZero(CodeGenModule &CGM,
902 llvm::Constant *Init, Address Loc,
903 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000904 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
JF Bastiened92f602018-07-20 23:37:12 +0000905 "called emitStoresForInitAfterBZero for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000906
Chris Lattnere6af8862010-12-02 01:58:41 +0000907 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
908 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
909 isa<llvm::ConstantExpr>(Init)) {
JF Bastien9aab85a2018-07-13 20:33:23 +0000910 Builder.CreateStore(Init, Loc, isVolatile);
Chris Lattner236b3572012-01-31 04:36:19 +0000911 return;
912 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000913
914 if (llvm::ConstantDataSequential *CDS =
915 dyn_cast<llvm::ConstantDataSequential>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000916 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
917 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000918
919 // If necessary, get a pointer to the element and emit it.
920 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
JF Bastiened92f602018-07-20 23:37:12 +0000921 emitStoresForInitAfterBZero(
James Y Knight751fe282019-02-09 22:22:28 +0000922 CGM, Elt, Builder.CreateConstInBoundsGEP2_32(Loc, 0, i), isVolatile,
923 Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000924 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000925 return;
926 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000927
Chris Lattnere6af8862010-12-02 01:58:41 +0000928 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
929 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000930
Chris Lattnere6af8862010-12-02 01:58:41 +0000931 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
932 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000933
934 // If necessary, get a pointer to the element and emit it.
935 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
James Y Knight751fe282019-02-09 22:22:28 +0000936 emitStoresForInitAfterBZero(CGM, Elt,
937 Builder.CreateConstInBoundsGEP2_32(Loc, 0, i),
938 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000939 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000940}
941
JF Bastiened92f602018-07-20 23:37:12 +0000942/// Decide whether we should use bzero plus some stores to initialize a local
943/// variable instead of using a memcpy from a constant global. It is beneficial
944/// to use bzero if the global is all zeros, or mostly zeros and large.
945static bool shouldUseBZeroPlusStoresToInitialize(llvm::Constant *Init,
946 uint64_t GlobalSize) {
947 // If a global is all zeros, always use a bzero.
Chris Lattnerb85025f2010-12-01 02:05:19 +0000948 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
949
Chris Lattnerb85025f2010-12-01 02:05:19 +0000950 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
951 // do it if it will require 6 or fewer scalar stores.
952 // TODO: Should budget depends on the size? Avoiding a large global warrants
953 // plopping in more stores.
954 unsigned StoreBudget = 6;
955 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000956
957 return GlobalSize > SizeLimit &&
JF Bastiened92f602018-07-20 23:37:12 +0000958 canEmitInitWithFewStoresAfterBZero(Init, StoreBudget);
Chris Lattnerb85025f2010-12-01 02:05:19 +0000959}
960
JF Bastien65089292018-07-25 04:29:03 +0000961/// Decide whether we should use memset to initialize a local variable instead
962/// of using a memcpy from a constant global. Assumes we've already decided to
963/// not user bzero.
964/// FIXME We could be more clever, as we are for bzero above, and generate
965/// memset followed by stores. It's unclear that's worth the effort.
JF Bastien2f0582f2018-09-21 13:54:09 +0000966static llvm::Value *shouldUseMemSetToInitialize(llvm::Constant *Init,
Vitaly Bukad03bd1d2019-07-10 22:53:52 +0000967 uint64_t GlobalSize,
968 const llvm::DataLayout &DL) {
JF Bastien65089292018-07-25 04:29:03 +0000969 uint64_t SizeLimit = 32;
970 if (GlobalSize <= SizeLimit)
JF Bastien2f0582f2018-09-21 13:54:09 +0000971 return nullptr;
Vitaly Bukad03bd1d2019-07-10 22:53:52 +0000972 return llvm::isBytewiseValue(Init, DL);
JF Bastien65089292018-07-25 04:29:03 +0000973}
974
JF Bastienb5e5bc72019-03-08 01:26:49 +0000975/// Decide whether we want to split a constant structure or array store into a
976/// sequence of its fields' stores. This may cost us code size and compilation
977/// speed, but plays better with store optimizations.
978static bool shouldSplitConstantStore(CodeGenModule &CGM,
979 uint64_t GlobalByteSize) {
980 // Don't break things that occupy more than one cacheline.
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +0000981 uint64_t ByteSizeLimit = 64;
982 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
983 return false;
984 if (GlobalByteSize <= ByteSizeLimit)
985 return true;
986 return false;
987}
988
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000989enum class IsPattern { No, Yes };
990
991/// Generate a constant filled with either a pattern or zeroes.
992static llvm::Constant *patternOrZeroFor(CodeGenModule &CGM, IsPattern isPattern,
993 llvm::Type *Ty) {
994 if (isPattern == IsPattern::Yes)
JF Bastienef202c32019-04-12 00:11:27 +0000995 return initializationPatternFor(CGM, Ty);
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000996 else
997 return llvm::Constant::getNullValue(Ty);
998}
999
1000static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1001 llvm::Constant *constant);
1002
1003/// Helper function for constWithPadding() to deal with padding in structures.
1004static llvm::Constant *constStructWithPadding(CodeGenModule &CGM,
1005 IsPattern isPattern,
1006 llvm::StructType *STy,
1007 llvm::Constant *constant) {
1008 const llvm::DataLayout &DL = CGM.getDataLayout();
1009 const llvm::StructLayout *Layout = DL.getStructLayout(STy);
1010 llvm::Type *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext());
1011 unsigned SizeSoFar = 0;
1012 SmallVector<llvm::Constant *, 8> Values;
1013 bool NestedIntact = true;
1014 for (unsigned i = 0, e = STy->getNumElements(); i != e; i++) {
1015 unsigned CurOff = Layout->getElementOffset(i);
1016 if (SizeSoFar < CurOff) {
1017 assert(!STy->isPacked());
1018 auto *PadTy = llvm::ArrayType::get(Int8Ty, CurOff - SizeSoFar);
1019 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1020 }
1021 llvm::Constant *CurOp;
1022 if (constant->isZeroValue())
1023 CurOp = llvm::Constant::getNullValue(STy->getElementType(i));
1024 else
1025 CurOp = cast<llvm::Constant>(constant->getAggregateElement(i));
1026 auto *NewOp = constWithPadding(CGM, isPattern, CurOp);
1027 if (CurOp != NewOp)
1028 NestedIntact = false;
1029 Values.push_back(NewOp);
1030 SizeSoFar = CurOff + DL.getTypeAllocSize(CurOp->getType());
1031 }
1032 unsigned TotalSize = Layout->getSizeInBytes();
1033 if (SizeSoFar < TotalSize) {
1034 auto *PadTy = llvm::ArrayType::get(Int8Ty, TotalSize - SizeSoFar);
1035 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1036 }
1037 if (NestedIntact && Values.size() == STy->getNumElements())
1038 return constant;
Peter Collingbourne68b46732019-03-16 19:25:39 +00001039 return llvm::ConstantStruct::getAnon(Values, STy->isPacked());
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001040}
1041
1042/// Replace all padding bytes in a given constant with either a pattern byte or
1043/// 0x00.
1044static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1045 llvm::Constant *constant) {
1046 llvm::Type *OrigTy = constant->getType();
1047 if (const auto STy = dyn_cast<llvm::StructType>(OrigTy))
1048 return constStructWithPadding(CGM, isPattern, STy, constant);
1049 if (auto *STy = dyn_cast<llvm::SequentialType>(OrigTy)) {
1050 llvm::SmallVector<llvm::Constant *, 8> Values;
1051 unsigned Size = STy->getNumElements();
1052 if (!Size)
1053 return constant;
1054 llvm::Type *ElemTy = STy->getElementType();
1055 bool ZeroInitializer = constant->isZeroValue();
1056 llvm::Constant *OpValue, *PaddedOp;
1057 if (ZeroInitializer) {
1058 OpValue = llvm::Constant::getNullValue(ElemTy);
1059 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1060 }
1061 for (unsigned Op = 0; Op != Size; ++Op) {
1062 if (!ZeroInitializer) {
1063 OpValue = constant->getAggregateElement(Op);
1064 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1065 }
1066 Values.push_back(PaddedOp);
1067 }
1068 auto *NewElemTy = Values[0]->getType();
1069 if (NewElemTy == ElemTy)
1070 return constant;
1071 if (OrigTy->isArrayTy()) {
1072 auto *ArrayTy = llvm::ArrayType::get(NewElemTy, Size);
1073 return llvm::ConstantArray::get(ArrayTy, Values);
1074 } else {
1075 return llvm::ConstantVector::get(Values);
1076 }
1077 }
1078 return constant;
1079}
1080
Richard Smith24cdcad2019-06-14 17:46:37 +00001081Address CodeGenModule::createUnnamedGlobalFrom(const VarDecl &D,
1082 llvm::Constant *Constant,
1083 CharUnits Align) {
JF Bastien3a881e62018-11-15 00:19:18 +00001084 auto FunctionName = [&](const DeclContext *DC) -> std::string {
1085 if (const auto *FD = dyn_cast<FunctionDecl>(DC)) {
1086 if (const auto *CC = dyn_cast<CXXConstructorDecl>(FD))
1087 return CC->getNameAsString();
1088 if (const auto *CD = dyn_cast<CXXDestructorDecl>(FD))
1089 return CD->getNameAsString();
Richard Smith24cdcad2019-06-14 17:46:37 +00001090 return getMangledName(FD);
JF Bastien3a881e62018-11-15 00:19:18 +00001091 } else if (const auto *OM = dyn_cast<ObjCMethodDecl>(DC)) {
1092 return OM->getNameAsString();
Mikael Holmenee846762018-11-15 13:01:54 +00001093 } else if (isa<BlockDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001094 return "<block>";
Mikael Holmenee846762018-11-15 13:01:54 +00001095 } else if (isa<CapturedDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001096 return "<captured>";
1097 } else {
Richard Smith24cdcad2019-06-14 17:46:37 +00001098 llvm_unreachable("expected a function or method");
JF Bastien3a881e62018-11-15 00:19:18 +00001099 }
1100 };
1101
Richard Smith24cdcad2019-06-14 17:46:37 +00001102 // Form a simple per-variable cache of these values in case we find we
1103 // want to reuse them.
1104 llvm::GlobalVariable *&CacheEntry = InitializerConstants[&D];
1105 if (!CacheEntry || CacheEntry->getInitializer() != Constant) {
1106 auto *Ty = Constant->getType();
1107 bool isConstant = true;
1108 llvm::GlobalVariable *InsertBefore = nullptr;
1109 unsigned AS =
1110 getContext().getTargetAddressSpace(getStringLiteralAddressSpace());
1111 std::string Name;
1112 if (D.hasGlobalStorage())
1113 Name = getMangledName(&D).str() + ".const";
1114 else if (const DeclContext *DC = D.getParentFunctionOrMethod())
1115 Name = ("__const." + FunctionName(DC) + "." + D.getName()).str();
1116 else
1117 llvm_unreachable("local variable has no parent function or method");
1118 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
1119 getModule(), Ty, isConstant, llvm::GlobalValue::PrivateLinkage,
1120 Constant, Name, InsertBefore, llvm::GlobalValue::NotThreadLocal, AS);
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001121 GV->setAlignment(Align.getAsAlign());
Richard Smith24cdcad2019-06-14 17:46:37 +00001122 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1123 CacheEntry = GV;
1124 } else if (CacheEntry->getAlignment() < Align.getQuantity()) {
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001125 CacheEntry->setAlignment(Align.getAsAlign());
Richard Smith24cdcad2019-06-14 17:46:37 +00001126 }
JF Bastien3a881e62018-11-15 00:19:18 +00001127
Richard Smith24cdcad2019-06-14 17:46:37 +00001128 return Address(CacheEntry, Align);
1129}
1130
1131static Address createUnnamedGlobalForMemcpyFrom(CodeGenModule &CGM,
1132 const VarDecl &D,
1133 CGBuilderTy &Builder,
1134 llvm::Constant *Constant,
1135 CharUnits Align) {
1136 Address SrcPtr = CGM.createUnnamedGlobalFrom(D, Constant, Align);
1137 llvm::Type *BP = llvm::PointerType::getInt8PtrTy(CGM.getLLVMContext(),
1138 SrcPtr.getAddressSpace());
JF Bastien3a881e62018-11-15 00:19:18 +00001139 if (SrcPtr.getType() != BP)
1140 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
1141 return SrcPtr;
1142}
1143
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001144static void emitStoresForConstant(CodeGenModule &CGM, const VarDecl &D,
1145 Address Loc, bool isVolatile,
1146 CGBuilderTy &Builder,
1147 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001148 auto *Ty = constant->getType();
Vitaly Bukaf35a3452019-06-27 02:08:15 +00001149 uint64_t ConstantSize = CGM.getDataLayout().getTypeAllocSize(Ty);
1150 if (!ConstantSize)
1151 return;
1152
JF Bastienb5e5bc72019-03-08 01:26:49 +00001153 bool canDoSingleStore = Ty->isIntOrIntVectorTy() ||
1154 Ty->isPtrOrPtrVectorTy() || Ty->isFPOrFPVectorTy();
1155 if (canDoSingleStore) {
JF Bastien14daa202018-12-18 05:12:21 +00001156 Builder.CreateStore(constant, Loc, isVolatile);
1157 return;
1158 }
1159
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001160 auto *SizeVal = llvm::ConstantInt::get(CGM.IntPtrTy, ConstantSize);
JF Bastienb5e5bc72019-03-08 01:26:49 +00001161
1162 // If the initializer is all or mostly the same, codegen with bzero / memset
1163 // then do a few stores afterward.
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001164 if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) {
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001165 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, 0), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001166 isVolatile);
1167
1168 bool valueAlreadyCorrect =
1169 constant->isNullValue() || isa<llvm::UndefValue>(constant);
1170 if (!valueAlreadyCorrect) {
JF Bastien14daa202018-12-18 05:12:21 +00001171 Loc = Builder.CreateBitCast(Loc, Ty->getPointerTo(Loc.getAddressSpace()));
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001172 emitStoresForInitAfterBZero(CGM, constant, Loc, isVolatile, Builder);
1173 }
1174 return;
1175 }
1176
JF Bastienb5e5bc72019-03-08 01:26:49 +00001177 // If the initializer is a repeated byte pattern, use memset.
Vitaly Bukad03bd1d2019-07-10 22:53:52 +00001178 llvm::Value *Pattern =
1179 shouldUseMemSetToInitialize(constant, ConstantSize, CGM.getDataLayout());
JF Bastien2f0582f2018-09-21 13:54:09 +00001180 if (Pattern) {
1181 uint64_t Value = 0x00;
1182 if (!isa<llvm::UndefValue>(Pattern)) {
1183 const llvm::APInt &AP = cast<llvm::ConstantInt>(Pattern)->getValue();
1184 assert(AP.getBitWidth() <= 8);
1185 Value = AP.getLimitedValue();
1186 }
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001187 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, Value), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001188 isVolatile);
1189 return;
1190 }
1191
JF Bastienb5e5bc72019-03-08 01:26:49 +00001192 // If the initializer is small, use a handful of stores.
1193 if (shouldSplitConstantStore(CGM, ConstantSize)) {
1194 if (auto *STy = dyn_cast<llvm::StructType>(Ty)) {
1195 // FIXME: handle the case when STy != Loc.getElementType().
1196 if (STy == Loc.getElementType()) {
1197 for (unsigned i = 0; i != constant->getNumOperands(); i++) {
1198 Address EltPtr = Builder.CreateStructGEP(Loc, i);
1199 emitStoresForConstant(
1200 CGM, D, EltPtr, isVolatile, Builder,
1201 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1202 }
1203 return;
1204 }
1205 } else if (auto *ATy = dyn_cast<llvm::ArrayType>(Ty)) {
1206 // FIXME: handle the case when ATy != Loc.getElementType().
1207 if (ATy == Loc.getElementType()) {
1208 for (unsigned i = 0; i != ATy->getNumElements(); i++) {
1209 Address EltPtr = Builder.CreateConstArrayGEP(Loc, i);
1210 emitStoresForConstant(
1211 CGM, D, EltPtr, isVolatile, Builder,
1212 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1213 }
1214 return;
1215 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001216 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001217 }
1218
JF Bastienb5e5bc72019-03-08 01:26:49 +00001219 // Copy from a global.
Richard Smith24cdcad2019-06-14 17:46:37 +00001220 Builder.CreateMemCpy(Loc,
1221 createUnnamedGlobalForMemcpyFrom(
1222 CGM, D, Builder, constant, Loc.getAlignment()),
1223 SizeVal, isVolatile);
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001224}
1225
JF Bastien14daa202018-12-18 05:12:21 +00001226static void emitStoresForZeroInit(CodeGenModule &CGM, const VarDecl &D,
1227 Address Loc, bool isVolatile,
1228 CGBuilderTy &Builder) {
1229 llvm::Type *ElTy = Loc.getElementType();
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001230 llvm::Constant *constant =
1231 constWithPadding(CGM, IsPattern::No, llvm::Constant::getNullValue(ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001232 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1233}
1234
1235static void emitStoresForPatternInit(CodeGenModule &CGM, const VarDecl &D,
1236 Address Loc, bool isVolatile,
1237 CGBuilderTy &Builder) {
1238 llvm::Type *ElTy = Loc.getElementType();
JF Bastienef202c32019-04-12 00:11:27 +00001239 llvm::Constant *constant = constWithPadding(
1240 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001241 assert(!isa<llvm::UndefValue>(constant));
1242 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1243}
1244
1245static bool containsUndef(llvm::Constant *constant) {
1246 auto *Ty = constant->getType();
1247 if (isa<llvm::UndefValue>(constant))
1248 return true;
1249 if (Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy())
1250 for (llvm::Use &Op : constant->operands())
1251 if (containsUndef(cast<llvm::Constant>(Op)))
1252 return true;
1253 return false;
1254}
1255
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001256static llvm::Constant *replaceUndef(CodeGenModule &CGM, IsPattern isPattern,
1257 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001258 auto *Ty = constant->getType();
1259 if (isa<llvm::UndefValue>(constant))
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001260 return patternOrZeroFor(CGM, isPattern, Ty);
JF Bastien14daa202018-12-18 05:12:21 +00001261 if (!(Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()))
1262 return constant;
1263 if (!containsUndef(constant))
1264 return constant;
1265 llvm::SmallVector<llvm::Constant *, 8> Values(constant->getNumOperands());
1266 for (unsigned Op = 0, NumOp = constant->getNumOperands(); Op != NumOp; ++Op) {
1267 auto *OpValue = cast<llvm::Constant>(constant->getOperand(Op));
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001268 Values[Op] = replaceUndef(CGM, isPattern, OpValue);
JF Bastien14daa202018-12-18 05:12:21 +00001269 }
1270 if (Ty->isStructTy())
1271 return llvm::ConstantStruct::get(cast<llvm::StructType>(Ty), Values);
1272 if (Ty->isArrayTy())
1273 return llvm::ConstantArray::get(cast<llvm::ArrayType>(Ty), Values);
1274 assert(Ty->isVectorTy());
1275 return llvm::ConstantVector::get(Values);
1276}
1277
Nick Lewycky8a7d90b2010-12-30 20:21:55 +00001278/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +00001279/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +00001280/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +00001281void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
1282 AutoVarEmission emission = EmitAutoVarAlloca(D);
1283 EmitAutoVarInit(emission);
1284 EmitAutoVarCleanups(emission);
1285}
Chris Lattner03df1222007-06-02 04:53:11 +00001286
David Majnemerdc012fa2015-04-22 21:38:15 +00001287/// Emit a lifetime.begin marker if some criteria are satisfied.
1288/// \return a pointer to the temporary size Value if a marker was emitted, null
1289/// otherwise
1290llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
1291 llvm::Value *Addr) {
Vitaly Buka1c943322016-10-26 01:59:57 +00001292 if (!ShouldEmitLifetimeMarkers)
Reid Kleckner1ef49212015-04-23 18:07:13 +00001293 return nullptr;
1294
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001295 assert(Addr->getType()->getPointerAddressSpace() ==
1296 CGM.getDataLayout().getAllocaAddrSpace() &&
1297 "Pointer should be in alloca address space");
David Majnemerdc012fa2015-04-22 21:38:15 +00001298 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001299 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001300 llvm::CallInst *C =
1301 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001302 C->setDoesNotThrow();
1303 return SizeV;
1304}
1305
1306void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001307 assert(Addr->getType()->getPointerAddressSpace() ==
1308 CGM.getDataLayout().getAllocaAddrSpace() &&
1309 "Pointer should be in alloca address space");
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.getLLVMLifetimeEndFn(), {Size, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001313 C->setDoesNotThrow();
1314}
1315
Sander de Smalen891af03a2018-02-03 13:55:59 +00001316void CodeGenFunction::EmitAndRegisterVariableArrayDimensions(
1317 CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) {
1318 // For each dimension stores its QualType and corresponding
1319 // size-expression Value.
1320 SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions;
Adrian Prantla40cce82018-11-09 19:17:56 +00001321 SmallVector<IdentifierInfo *, 4> VLAExprNames;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001322
1323 // Break down the array into individual dimensions.
1324 QualType Type1D = D.getType();
1325 while (getContext().getAsVariableArrayType(Type1D)) {
1326 auto VlaSize = getVLAElements1D(Type1D);
1327 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1328 Dimensions.emplace_back(C, Type1D.getUnqualifiedType());
1329 else {
Adrian Prantla40cce82018-11-09 19:17:56 +00001330 // Generate a locally unique name for the size expression.
1331 Twine Name = Twine("__vla_expr") + Twine(VLAExprCounter++);
1332 SmallString<12> Buffer;
1333 StringRef NameRef = Name.toStringRef(Buffer);
1334 auto &Ident = getContext().Idents.getOwn(NameRef);
1335 VLAExprNames.push_back(&Ident);
1336 auto SizeExprAddr =
1337 CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), NameRef);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001338 Builder.CreateStore(VlaSize.NumElts, SizeExprAddr);
1339 Dimensions.emplace_back(SizeExprAddr.getPointer(),
1340 Type1D.getUnqualifiedType());
1341 }
1342 Type1D = VlaSize.Type;
1343 }
1344
1345 if (!EmitDebugInfo)
1346 return;
1347
1348 // Register each dimension's size-expression with a DILocalVariable,
1349 // so that it can be used by CGDebugInfo when instantiating a DISubrange
1350 // to describe this array.
Adrian Prantla40cce82018-11-09 19:17:56 +00001351 unsigned NameIdx = 0;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001352 for (auto &VlaSize : Dimensions) {
1353 llvm::Metadata *MD;
1354 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1355 MD = llvm::ConstantAsMetadata::get(C);
1356 else {
1357 // Create an artificial VarDecl to generate debug info for.
Adrian Prantla40cce82018-11-09 19:17:56 +00001358 IdentifierInfo *NameIdent = VLAExprNames[NameIdx++];
Sander de Smalen891af03a2018-02-03 13:55:59 +00001359 auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType();
1360 auto QT = getContext().getIntTypeForBitwidth(
1361 VlaExprTy->getScalarSizeInBits(), false);
1362 auto *ArtificialDecl = VarDecl::Create(
1363 getContext(), const_cast<DeclContext *>(D.getDeclContext()),
Adrian Prantla40cce82018-11-09 19:17:56 +00001364 D.getLocation(), D.getLocation(), NameIdent, QT,
Sander de Smalen891af03a2018-02-03 13:55:59 +00001365 getContext().CreateTypeSourceInfo(QT), SC_Auto);
Sander de Smalen9084a3b2018-02-13 07:49:34 +00001366 ArtificialDecl->setImplicit();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001367
1368 MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts,
1369 Builder);
1370 }
1371 assert(MD && "No Size expression debug node created");
1372 DI->registerVLASizeExpression(VlaSize.Type, MD);
1373 }
1374}
1375
John McCallc533cb72011-02-22 06:44:22 +00001376/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001377/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +00001378CodeGenFunction::AutoVarEmission
1379CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
1380 QualType Ty = D.getType();
Yaxun Liub7318e02017-10-13 03:37:48 +00001381 assert(
1382 Ty.getAddressSpace() == LangAS::Default ||
1383 (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL));
John McCallc533cb72011-02-22 06:44:22 +00001384
1385 AutoVarEmission emission(D);
1386
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001387 bool isEscapingByRef = D.isEscapingByref();
1388 emission.IsEscapingByRef = isEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00001389
1390 CharUnits alignment = getContext().getDeclAlign(&D);
John McCallc533cb72011-02-22 06:44:22 +00001391
John McCall23c29fe2011-06-24 21:55:10 +00001392 // If the type is variably-modified, emit all the VLA sizes for it.
1393 if (Ty->isVariablyModifiedType())
1394 EmitVariablyModifiedType(Ty);
1395
Sander de Smalen891af03a2018-02-03 13:55:59 +00001396 auto *DI = getDebugInfo();
1397 bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >=
1398 codegenoptions::LimitedDebugInfo;
1399
John McCall7f416cc2015-09-08 08:05:57 +00001400 Address address = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001401 Address AllocaAddr = Address::invalid();
Alexey Bataev9c397812019-04-03 17:57:06 +00001402 Address OpenMPLocalAddr =
1403 getLangOpts().OpenMP
1404 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
1405 : Address::invalid();
Amy Huang7fac5c82019-06-20 17:15:21 +00001406 bool NRVO = getLangOpts().ElideConstructors && D.isNRVOVariable();
1407
Alexey Bataev9c397812019-04-03 17:57:06 +00001408 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
1409 address = OpenMPLocalAddr;
1410 } else if (Ty->isConstantSizeType()) {
Richard Smith2bcde3a2013-06-02 00:09:52 +00001411 // If this value is an array or struct with a statically determinable
1412 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +00001413 //
1414 // TODO: We should constant-evaluate the initializer of any variable,
1415 // as long as it is initialized by a constant expression. Currently,
1416 // isConstantInitializer produces wrong answers for structs with
1417 // reference or bitfield members, and a few other cases, and checking
1418 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +00001419 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
1420 (D.isConstexpr() ||
1421 ((Ty.isPODType(getContext()) ||
1422 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
1423 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +00001424
Rafael Espindola609f5d92013-03-26 18:41:47 +00001425 // If the variable's a const type, and it's neither an NRVO
1426 // candidate nor a __block variable and has no mutable members,
1427 // emit it as a global instead.
Anastasia Stulovae4a1c382016-11-29 17:01:19 +00001428 // Exception is if a variable is located in non-constant address space
1429 // in OpenCL.
1430 if ((!getLangOpts().OpenCL ||
1431 Ty.getAddressSpace() == LangAS::opencl_constant) &&
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001432 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO &&
1433 !isEscapingByRef && CGM.isTypeConstant(Ty, true))) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001434 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +00001435
John McCall7f416cc2015-09-08 08:05:57 +00001436 // Signal this condition to later callbacks.
1437 emission.Addr = Address::invalid();
Rafael Espindola609f5d92013-03-26 18:41:47 +00001438 assert(emission.wasEmittedAsGlobal());
1439 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +00001440 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001441
Rafael Espindola609f5d92013-03-26 18:41:47 +00001442 // Otherwise, tell the initialization code that we're in this case.
1443 emission.IsConstantAggregate = true;
1444 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001445
Rafael Espindola609f5d92013-03-26 18:41:47 +00001446 // A normal fixed sized variable becomes an alloca in the entry block,
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001447 // unless:
1448 // - it's an NRVO variable.
1449 // - we are compiling OpenMP and it's an OpenMP local variable.
Alexey Bataev9c397812019-04-03 17:57:06 +00001450 if (NRVO) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001451 // The named return value optimization: allocate this variable in the
1452 // return slot, so that we can elide the copy when returning this
1453 // variable (C++0x [class.copy]p34).
John McCall7f416cc2015-09-08 08:05:57 +00001454 address = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +00001455
Rafael Espindola609f5d92013-03-26 18:41:47 +00001456 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001457 const auto *RD = RecordTy->getDecl();
1458 const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1459 if ((CXXRD && !CXXRD->hasTrivialDestructor()) ||
1460 RD->isNonTrivialToPrimitiveDestroy()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001461 // Create a flag that is used to indicate when the NRVO was applied
1462 // to this variable. Set it to zero to indicate that NRVO was not
1463 // applied.
1464 llvm::Value *Zero = Builder.getFalse();
John McCall7f416cc2015-09-08 08:05:57 +00001465 Address NRVOFlag =
1466 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
Rafael Espindola609f5d92013-03-26 18:41:47 +00001467 EnsureInsertPoint();
1468 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +00001469
Rafael Espindola609f5d92013-03-26 18:41:47 +00001470 // Record the NRVO flag for this variable.
John McCall7f416cc2015-09-08 08:05:57 +00001471 NRVOFlags[&D] = NRVOFlag.getPointer();
1472 emission.NRVOFlag = NRVOFlag.getPointer();
Nadav Rotem1da30942013-03-23 06:43:35 +00001473 }
Douglas Gregor290c93e2010-05-15 06:46:45 +00001474 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001475 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001476 CharUnits allocaAlignment;
1477 llvm::Type *allocaTy;
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001478 if (isEscapingByRef) {
John McCall7f416cc2015-09-08 08:05:57 +00001479 auto &byrefInfo = getBlockByrefInfo(&D);
1480 allocaTy = byrefInfo.Type;
1481 allocaAlignment = byrefInfo.ByrefAlignment;
1482 } else {
1483 allocaTy = ConvertTypeForMem(Ty);
1484 allocaAlignment = alignment;
1485 }
Rafael Espindola609f5d92013-03-26 18:41:47 +00001486
John McCall999110f2015-09-08 09:18:30 +00001487 // Create the alloca. Note that we set the name separately from
1488 // building the instruction so that it's there even in no-asserts
1489 // builds.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001490 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName(),
1491 /*ArraySize=*/nullptr, &AllocaAddr);
Rafael Espindola609f5d92013-03-26 18:41:47 +00001492
Reid Kleckner1f88e932015-10-07 21:03:41 +00001493 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1494 // the catch parameter starts in the catchpad instruction, and we can't
1495 // insert code in those basic blocks.
1496 bool IsMSCatchParam =
1497 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1498
Vitaly Buka64c80b42016-10-26 05:42:30 +00001499 // Emit a lifetime intrinsic if meaningful. There's no point in doing this
1500 // if we don't have a valid insertion point (?).
Reid Kleckner1f88e932015-10-07 21:03:41 +00001501 if (HaveInsertPoint() && !IsMSCatchParam) {
Akira Hatanakafdcd18b2017-01-25 22:55:13 +00001502 // If there's a jump into the lifetime of this variable, its lifetime
1503 // gets broken up into several regions in IR, which requires more work
1504 // to handle correctly. For now, just omit the intrinsics; this is a
1505 // rare case, and it's better to just be conservatively correct.
1506 // PR28267.
1507 //
1508 // We have to do this in all language modes if there's a jump past the
1509 // declaration. We also have to do it in C if there's a jump to an
1510 // earlier point in the current block because non-VLA lifetimes begin as
1511 // soon as the containing block is entered, not when its variables
1512 // actually come into scope; suppressing the lifetime annotations
1513 // completely in this case is unnecessarily pessimistic, but again, this
1514 // is rare.
1515 if (!Bypasses.IsBypassed(&D) &&
1516 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) {
Vitaly Buka64c80b42016-10-26 05:42:30 +00001517 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1518 emission.SizeForLifetimeMarkers =
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001519 EmitLifetimeStart(size, AllocaAddr.getPointer());
Vitaly Buka64c80b42016-10-26 05:42:30 +00001520 }
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001521 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001522 assert(!emission.useLifetimeMarkers());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001523 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001524 }
Chris Lattner03df1222007-06-02 04:53:11 +00001525 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001526 EnsureInsertPoint();
1527
Anders Carlsson15949b32009-02-09 20:41:50 +00001528 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +00001529 // Save the stack.
John McCall7f416cc2015-09-08 08:05:57 +00001530 Address Stack =
1531 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +00001532
James Y Knight8799cae2019-02-03 21:53:49 +00001533 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie4ba525b2015-07-14 17:27:39 +00001534 llvm::Value *V = Builder.CreateCall(F);
Anders Carlsson30032882008-12-12 07:38:43 +00001535 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +00001536
1537 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +00001538
John McCalla464ff92010-07-21 06:13:08 +00001539 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +00001540 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001541 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +00001542 }
Mike Stump11289f42009-09-09 15:08:12 +00001543
Sander de Smalen891af03a2018-02-03 13:55:59 +00001544 auto VlaSize = getVLASize(Ty);
1545 llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type);
Anders Carlsson30032882008-12-12 07:38:43 +00001546
1547 // Allocate memory for the array.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001548 address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts,
1549 &AllocaAddr);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001550
1551 // If we have debug info enabled, properly describe the VLA dimensions for
1552 // this type by registering the vla size expression for each of the
1553 // dimensions.
1554 EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo);
Chris Lattner03df1222007-06-02 04:53:11 +00001555 }
Eli Friedmanf4084702008-12-20 23:11:59 +00001556
John McCall7f416cc2015-09-08 08:05:57 +00001557 setAddrOfLocalVar(&D, address);
1558 emission.Addr = address;
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001559 emission.AllocaAddr = AllocaAddr;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001560
1561 // Emit debug info for local var declaration.
Sander de Smalen891af03a2018-02-03 13:55:59 +00001562 if (EmitDebugInfo && HaveInsertPoint()) {
Amy Huang7fac5c82019-06-20 17:15:21 +00001563 Address DebugAddr = address;
1564 bool UsePointerValue = NRVO && ReturnValuePointer.isValid();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001565 DI->setLocation(D.getLocation());
Amy Huang7fac5c82019-06-20 17:15:21 +00001566
1567 // If NRVO, use a pointer to the return address.
1568 if (UsePointerValue)
1569 DebugAddr = ReturnValuePointer;
1570
1571 (void)DI->EmitDeclareOfAutoVariable(&D, DebugAddr.getPointer(), Builder,
1572 UsePointerValue);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001573 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001574
Volodymyr Sapsai93317d82019-03-01 02:15:39 +00001575 if (D.hasAttr<AnnotateAttr>() && HaveInsertPoint())
John McCall7f416cc2015-09-08 08:05:57 +00001576 EmitVarAnnotations(&D, address.getPointer());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001577
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001578 // Make sure we call @llvm.lifetime.end.
1579 if (emission.useLifetimeMarkers())
1580 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker,
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001581 emission.getOriginalAllocatedAddress(),
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001582 emission.getSizeForLifetimeMarkers());
1583
John McCallc533cb72011-02-22 06:44:22 +00001584 return emission;
1585}
1586
JF Bastien6b239722018-05-19 04:21:26 +00001587static bool isCapturedBy(const VarDecl &, const Expr *);
1588
1589/// Determines whether the given __block variable is potentially
1590/// captured by the given statement.
1591static bool isCapturedBy(const VarDecl &Var, const Stmt *S) {
1592 if (const Expr *E = dyn_cast<Expr>(S))
1593 return isCapturedBy(Var, E);
1594 for (const Stmt *SubStmt : S->children())
1595 if (isCapturedBy(Var, SubStmt))
1596 return true;
1597 return false;
1598}
1599
John McCallc533cb72011-02-22 06:44:22 +00001600/// Determines whether the given __block variable is potentially
1601/// captured by the given expression.
JF Bastien6b239722018-05-19 04:21:26 +00001602static bool isCapturedBy(const VarDecl &Var, const Expr *E) {
John McCallc533cb72011-02-22 06:44:22 +00001603 // Skip the most common kinds of expressions that make
1604 // hierarchy-walking expensive.
JF Bastien6b239722018-05-19 04:21:26 +00001605 E = E->IgnoreParenCasts();
John McCallc533cb72011-02-22 06:44:22 +00001606
JF Bastien6b239722018-05-19 04:21:26 +00001607 if (const BlockExpr *BE = dyn_cast<BlockExpr>(E)) {
1608 const BlockDecl *Block = BE->getBlockDecl();
1609 for (const auto &I : Block->captures()) {
1610 if (I.getVariable() == &Var)
John McCallc533cb72011-02-22 06:44:22 +00001611 return true;
1612 }
1613
1614 // No need to walk into the subexpressions.
1615 return false;
1616 }
1617
JF Bastien6b239722018-05-19 04:21:26 +00001618 if (const StmtExpr *SE = dyn_cast<StmtExpr>(E)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001619 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001620 for (const auto *BI : CS->body())
JF Bastien6b239722018-05-19 04:21:26 +00001621 if (const auto *BIE = dyn_cast<Expr>(BI)) {
1622 if (isCapturedBy(Var, BIE))
1623 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001624 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001625 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001626 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001627 for (const auto *I : DS->decls()) {
1628 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1629 const Expr *Init = VD->getInit();
JF Bastien6b239722018-05-19 04:21:26 +00001630 if (Init && isCapturedBy(Var, Init))
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001631 return true;
1632 }
1633 }
1634 }
1635 else
1636 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1637 // Later, provide code to poke into statements for capture analysis.
1638 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001639 return false;
1640 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001641
JF Bastien6b239722018-05-19 04:21:26 +00001642 for (const Stmt *SubStmt : E->children())
1643 if (isCapturedBy(Var, SubStmt))
John McCallc533cb72011-02-22 06:44:22 +00001644 return true;
1645
1646 return false;
1647}
1648
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001649/// Determine whether the given initializer is trivial in the sense
Douglas Gregor82e1af22011-07-01 21:08:19 +00001650/// that it requires no code to be generated.
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001651bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
Douglas Gregor82e1af22011-07-01 21:08:19 +00001652 if (!Init)
1653 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001654
Douglas Gregor82e1af22011-07-01 21:08:19 +00001655 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1656 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1657 if (Constructor->isTrivial() &&
1658 Constructor->isDefaultConstructor() &&
1659 !Construct->requiresZeroInitialization())
1660 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001661
Douglas Gregor82e1af22011-07-01 21:08:19 +00001662 return false;
1663}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001664
Vitaly Bukae7267662019-07-10 22:53:50 +00001665void CodeGenFunction::emitZeroOrPatternForAutoVarInit(QualType type,
1666 const VarDecl &D,
1667 Address Loc) {
1668 auto trivialAutoVarInit = getContext().getLangOpts().getTrivialAutoVarInit();
1669 CharUnits Size = getContext().getTypeSizeInChars(type);
1670 bool isVolatile = type.isVolatileQualified();
1671 if (!Size.isZero()) {
1672 switch (trivialAutoVarInit) {
1673 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1674 llvm_unreachable("Uninitialized handled by caller");
1675 case LangOptions::TrivialAutoVarInitKind::Zero:
1676 emitStoresForZeroInit(CGM, D, Loc, isVolatile, Builder);
1677 break;
1678 case LangOptions::TrivialAutoVarInitKind::Pattern:
1679 emitStoresForPatternInit(CGM, D, Loc, isVolatile, Builder);
1680 break;
1681 }
1682 return;
1683 }
1684
1685 // VLAs look zero-sized to getTypeInfo. We can't emit constant stores to
1686 // them, so emit a memcpy with the VLA size to initialize each element.
1687 // Technically zero-sized or negative-sized VLAs are undefined, and UBSan
1688 // will catch that code, but there exists code which generates zero-sized
1689 // VLAs. Be nice and initialize whatever they requested.
1690 const auto *VlaType = getContext().getAsVariableArrayType(type);
1691 if (!VlaType)
1692 return;
1693 auto VlaSize = getVLASize(VlaType);
1694 auto SizeVal = VlaSize.NumElts;
1695 CharUnits EltSize = getContext().getTypeSizeInChars(VlaSize.Type);
1696 switch (trivialAutoVarInit) {
1697 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1698 llvm_unreachable("Uninitialized handled by caller");
1699
1700 case LangOptions::TrivialAutoVarInitKind::Zero:
1701 if (!EltSize.isOne())
1702 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1703 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1704 isVolatile);
1705 break;
1706
1707 case LangOptions::TrivialAutoVarInitKind::Pattern: {
1708 llvm::Type *ElTy = Loc.getElementType();
1709 llvm::Constant *Constant = constWithPadding(
1710 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
1711 CharUnits ConstantAlign = getContext().getTypeAlignInChars(VlaSize.Type);
1712 llvm::BasicBlock *SetupBB = createBasicBlock("vla-setup.loop");
1713 llvm::BasicBlock *LoopBB = createBasicBlock("vla-init.loop");
1714 llvm::BasicBlock *ContBB = createBasicBlock("vla-init.cont");
1715 llvm::Value *IsZeroSizedVLA = Builder.CreateICmpEQ(
1716 SizeVal, llvm::ConstantInt::get(SizeVal->getType(), 0),
1717 "vla.iszerosized");
1718 Builder.CreateCondBr(IsZeroSizedVLA, ContBB, SetupBB);
1719 EmitBlock(SetupBB);
1720 if (!EltSize.isOne())
1721 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1722 llvm::Value *BaseSizeInChars =
1723 llvm::ConstantInt::get(IntPtrTy, EltSize.getQuantity());
1724 Address Begin = Builder.CreateElementBitCast(Loc, Int8Ty, "vla.begin");
1725 llvm::Value *End =
1726 Builder.CreateInBoundsGEP(Begin.getPointer(), SizeVal, "vla.end");
1727 llvm::BasicBlock *OriginBB = Builder.GetInsertBlock();
1728 EmitBlock(LoopBB);
1729 llvm::PHINode *Cur = Builder.CreatePHI(Begin.getType(), 2, "vla.cur");
1730 Cur->addIncoming(Begin.getPointer(), OriginBB);
1731 CharUnits CurAlign = Loc.getAlignment().alignmentOfArrayElement(EltSize);
1732 Builder.CreateMemCpy(Address(Cur, CurAlign),
1733 createUnnamedGlobalForMemcpyFrom(
1734 CGM, D, Builder, Constant, ConstantAlign),
1735 BaseSizeInChars, isVolatile);
1736 llvm::Value *Next =
1737 Builder.CreateInBoundsGEP(Int8Ty, Cur, BaseSizeInChars, "vla.next");
1738 llvm::Value *Done = Builder.CreateICmpEQ(Next, End, "vla-init.isdone");
1739 Builder.CreateCondBr(Done, ContBB, LoopBB);
1740 Cur->addIncoming(Next, LoopBB);
1741 EmitBlock(ContBB);
1742 } break;
1743 }
1744}
1745
John McCallc533cb72011-02-22 06:44:22 +00001746void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001747 assert(emission.Variable && "emission was not valid!");
1748
John McCallc533cb72011-02-22 06:44:22 +00001749 // If this was emitted as a global constant, we're done.
1750 if (emission.wasEmittedAsGlobal()) return;
1751
John McCall9e2e22f2011-02-22 07:16:58 +00001752 const VarDecl &D = *emission.Variable;
Adrian Prantl95b24e92015-02-03 20:00:54 +00001753 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
John McCallc533cb72011-02-22 06:44:22 +00001754 QualType type = D.getType();
1755
Chris Lattner07eb7332007-07-12 00:39:48 +00001756 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001757 const Expr *Init = D.getInit();
1758
1759 // If we are at an unreachable point, we don't need to emit the initializer
1760 // unless it contains a label.
1761 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001762 if (!Init || !ContainsLabel(Init)) return;
1763 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001764 }
1765
John McCall73064872011-03-31 01:59:53 +00001766 // Initialize the structure of a __block variable.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001767 if (emission.IsEscapingByRef)
John McCall73064872011-03-31 01:59:53 +00001768 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001769
Akira Hatanaka7275da02018-02-28 07:15:55 +00001770 // Initialize the variable here if it doesn't have a initializer and it is a
1771 // C struct that is non-trivial to initialize or an array containing such a
1772 // struct.
1773 if (!Init &&
1774 type.isNonTrivialToPrimitiveDefaultInitialize() ==
1775 QualType::PDIK_Struct) {
1776 LValue Dst = MakeAddrLValue(emission.getAllocatedAddress(), type);
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001777 if (emission.IsEscapingByRef)
Akira Hatanaka7275da02018-02-28 07:15:55 +00001778 drillIntoBlockVariable(*this, Dst, &D);
1779 defaultInitNonTrivialCStructVar(Dst);
1780 return;
1781 }
1782
John McCallc533cb72011-02-22 06:44:22 +00001783 // Check whether this is a byref variable that's potentially
1784 // captured and moved by its own initializer. If so, we'll need to
1785 // emit the initializer first, then copy into the variable.
JF Bastien14daa202018-12-18 05:12:21 +00001786 bool capturedByInit =
1787 Init && emission.IsEscapingByRef && isCapturedBy(D, Init);
John McCallc533cb72011-02-22 06:44:22 +00001788
JF Bastien0bae08a2019-02-15 17:26:29 +00001789 bool locIsByrefHeader = !capturedByInit;
1790 const Address Loc =
1791 locIsByrefHeader ? emission.getObjectAddress(*this) : emission.Addr;
JF Bastien14daa202018-12-18 05:12:21 +00001792
1793 // Note: constexpr already initializes everything correctly.
1794 LangOptions::TrivialAutoVarInitKind trivialAutoVarInit =
1795 (D.isConstexpr()
1796 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1797 : (D.getAttr<UninitializedAttr>()
1798 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1799 : getContext().getLangOpts().getTrivialAutoVarInit()));
1800
JF Bastienb347e752019-02-08 01:29:17 +00001801 auto initializeWhatIsTechnicallyUninitialized = [&](Address Loc) {
JF Bastien14daa202018-12-18 05:12:21 +00001802 if (trivialAutoVarInit ==
1803 LangOptions::TrivialAutoVarInitKind::Uninitialized)
1804 return;
1805
JF Bastienb347e752019-02-08 01:29:17 +00001806 // Only initialize a __block's storage: we always initialize the header.
JF Bastien0bae08a2019-02-15 17:26:29 +00001807 if (emission.IsEscapingByRef && !locIsByrefHeader)
JF Bastienb347e752019-02-08 01:29:17 +00001808 Loc = emitBlockByrefAddress(Loc, &D, /*follow=*/false);
1809
Vitaly Bukae7267662019-07-10 22:53:50 +00001810 return emitZeroOrPatternForAutoVarInit(type, D, Loc);
JF Bastien14daa202018-12-18 05:12:21 +00001811 };
1812
Vitaly Bukae7267662019-07-10 22:53:50 +00001813 if (isTrivialInitializer(Init))
1814 return initializeWhatIsTechnicallyUninitialized(Loc);
John McCallc533cb72011-02-22 06:44:22 +00001815
Craig Topper8a13c412014-05-21 05:09:00 +00001816 llvm::Constant *constant = nullptr;
Richard Smith715f7a12019-06-11 17:50:32 +00001817 if (emission.IsConstantAggregate ||
1818 D.mightBeUsableInConstantExpressions(getContext())) {
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 Bastiend39fbc72019-04-30 22:56:53 +00001821 if (constant && !constant->isZeroValue() &&
1822 (trivialAutoVarInit !=
1823 LangOptions::TrivialAutoVarInitKind::Uninitialized)) {
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001824 IsPattern isPattern =
1825 (trivialAutoVarInit == LangOptions::TrivialAutoVarInitKind::Pattern)
1826 ? IsPattern::Yes
1827 : IsPattern::No;
JF Bastiend39fbc72019-04-30 22:56:53 +00001828 // C guarantees that brace-init with fewer initializers than members in
1829 // the aggregate will initialize the rest of the aggregate as-if it were
1830 // static initialization. In turn static initialization guarantees that
1831 // padding is initialized to zero bits. We could instead pattern-init if D
1832 // has any ImplicitValueInitExpr, but that seems to be unintuitive
1833 // behavior.
1834 constant = constWithPadding(CGM, IsPattern::No,
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001835 replaceUndef(CGM, isPattern, constant));
1836 }
Richard Smithfddd3842011-12-30 21:15:51 +00001837 }
1838
1839 if (!constant) {
JF Bastienb347e752019-02-08 01:29:17 +00001840 initializeWhatIsTechnicallyUninitialized(Loc);
John McCall7f416cc2015-09-08 08:05:57 +00001841 LValue lv = MakeAddrLValue(Loc, type);
John McCall1553b192011-06-16 04:16:24 +00001842 lv.setNonGC(true);
David Blaikie66e41972015-01-14 07:38:27 +00001843 return EmitExprAsInit(Init, &D, lv, capturedByInit);
John McCall1553b192011-06-16 04:16:24 +00001844 }
John McCall91ca10f2011-03-08 09:11:50 +00001845
Richard Smith2bcde3a2013-06-02 00:09:52 +00001846 if (!emission.IsConstantAggregate) {
1847 // For simple scalar/complex initialization, store the value directly.
John McCall7f416cc2015-09-08 08:05:57 +00001848 LValue lv = MakeAddrLValue(Loc, type);
Richard Smith2bcde3a2013-06-02 00:09:52 +00001849 lv.setNonGC(true);
1850 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1851 }
1852
Yaxun Liudaceb1e2018-05-14 19:20:12 +00001853 llvm::Type *BP = CGM.Int8Ty->getPointerTo(Loc.getAddressSpace());
JF Bastien0bae08a2019-02-15 17:26:29 +00001854 emitStoresForConstant(
1855 CGM, D, (Loc.getType() == BP) ? Loc : Builder.CreateBitCast(Loc, BP),
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001856 type.isVolatileQualified(), Builder, constant);
John McCall91ca10f2011-03-08 09:11:50 +00001857}
1858
Richard Smithe78fac52018-04-05 20:52:58 +00001859/// Emit an expression as an initializer for an object (variable, field, etc.)
1860/// at the given location. The expression is not necessarily the normal
1861/// initializer for the object, and the address is not necessarily
John McCall91ca10f2011-03-08 09:11:50 +00001862/// its normal location.
1863///
1864/// \param init the initializing expression
Richard Smithe78fac52018-04-05 20:52:58 +00001865/// \param D the object to act as if we're initializing
John McCall91ca10f2011-03-08 09:11:50 +00001866/// \param loc the address to initialize; its type is a pointer
Richard Smithe78fac52018-04-05 20:52:58 +00001867/// to the LLVM mapping of the object's type
John McCall91ca10f2011-03-08 09:11:50 +00001868/// \param alignment the alignment of the address
Richard Smithe78fac52018-04-05 20:52:58 +00001869/// \param capturedByInit true if \p D is a __block variable
John McCall91ca10f2011-03-08 09:11:50 +00001870/// whose address is potentially changed by the initializer
David Blaikie73ca5692014-12-09 00:32:22 +00001871void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +00001872 LValue lvalue, bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001873 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001874
1875 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001876 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001877 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001878 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001879 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001880 return;
1881 }
1882 switch (getEvaluationKind(type)) {
1883 case TEK_Scalar:
David Blaikie66e41972015-01-14 07:38:27 +00001884 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001885 return;
1886 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001887 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001888 if (capturedByInit)
1889 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001890 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
John McCall47fb9502013-03-07 21:37:08 +00001891 return;
1892 }
1893 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001894 if (type->isAtomicType()) {
1895 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1896 } else {
Richard Smithe78fac52018-04-05 20:52:58 +00001897 AggValueSlot::Overlap_t Overlap = AggValueSlot::MayOverlap;
1898 if (isa<VarDecl>(D))
1899 Overlap = AggValueSlot::DoesNotOverlap;
1900 else if (auto *FD = dyn_cast<FieldDecl>(D))
Richard Smith8cca3a52019-06-20 20:56:20 +00001901 Overlap = getOverlapForFieldInit(FD);
John McCalla8ec7eb2013-03-07 21:37:17 +00001902 // TODO: how can we delay here if D is captured by its initializer?
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001903 EmitAggExpr(init, AggValueSlot::forLValue(
1904 lvalue, *this, AggValueSlot::IsDestructed,
1905 AggValueSlot::DoesNotNeedGCBarriers,
1906 AggValueSlot::IsNotAliased, Overlap));
John McCalla8ec7eb2013-03-07 21:37:17 +00001907 }
John McCall47fb9502013-03-07 21:37:08 +00001908 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001909 }
John McCall47fb9502013-03-07 21:37:08 +00001910 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001911}
John McCallbd309292010-07-06 01:34:17 +00001912
John McCall82fe67b2011-07-09 01:37:26 +00001913/// Enter a destroy cleanup for the given local variable.
1914void CodeGenFunction::emitAutoVarTypeCleanup(
1915 const CodeGenFunction::AutoVarEmission &emission,
1916 QualType::DestructionKind dtorKind) {
1917 assert(dtorKind != QualType::DK_none);
1918
1919 // Note that for __block variables, we want to destroy the
1920 // original stack object, not the possibly forwarded object.
John McCall7f416cc2015-09-08 08:05:57 +00001921 Address addr = emission.getObjectAddress(*this);
John McCall82fe67b2011-07-09 01:37:26 +00001922
1923 const VarDecl *var = emission.Variable;
1924 QualType type = var->getType();
1925
1926 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001927 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001928
1929 switch (dtorKind) {
1930 case QualType::DK_none:
1931 llvm_unreachable("no cleanup for trivially-destructible variable");
1932
1933 case QualType::DK_cxx_destructor:
1934 // If there's an NRVO flag on the emission, we need a different
1935 // cleanup.
1936 if (emission.NRVOFlag) {
1937 assert(!type->isArrayType());
1938 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
Marco Antognini88559632019-07-22 09:39:13 +00001939 EHStack.pushCleanup<DestroyNRVOVariableCXX>(cleanupKind, addr, type, dtor,
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001940 emission.NRVOFlag);
John McCall82fe67b2011-07-09 01:37:26 +00001941 return;
1942 }
1943 break;
1944
1945 case QualType::DK_objc_strong_lifetime:
1946 // Suppress cleanups for pseudo-strong variables.
1947 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001948
John McCall82fe67b2011-07-09 01:37:26 +00001949 // Otherwise, consider whether to use an EH cleanup or not.
1950 cleanupKind = getARCCleanupKind();
1951
1952 // Use the imprecise destroyer by default.
1953 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1954 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1955 break;
1956
1957 case QualType::DK_objc_weak_lifetime:
1958 break;
Akira Hatanaka7275da02018-02-28 07:15:55 +00001959
1960 case QualType::DK_nontrivial_c_struct:
1961 destroyer = CodeGenFunction::destroyNonTrivialCStruct;
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001962 if (emission.NRVOFlag) {
1963 assert(!type->isArrayType());
1964 EHStack.pushCleanup<DestroyNRVOVariableC>(cleanupKind, addr,
1965 emission.NRVOFlag, type);
1966 return;
1967 }
Akira Hatanaka7275da02018-02-28 07:15:55 +00001968 break;
John McCall82fe67b2011-07-09 01:37:26 +00001969 }
1970
1971 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001972 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001973
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001974 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001975 // is being pushed as an EH cleanup.
1976 bool useEHCleanup = (cleanupKind & EHCleanup);
1977 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1978 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001979}
1980
John McCallc533cb72011-02-22 06:44:22 +00001981void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001982 assert(emission.Variable && "emission was not valid!");
1983
John McCallc533cb72011-02-22 06:44:22 +00001984 // If this was emitted as a global constant, we're done.
1985 if (emission.wasEmittedAsGlobal()) return;
1986
John McCall8c38d352012-04-13 18:44:05 +00001987 // If we don't have an insertion point, we're done. Sema prevents
1988 // us from jumping into any of these scopes anyway.
1989 if (!HaveInsertPoint()) return;
1990
John McCall9e2e22f2011-02-22 07:16:58 +00001991 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001992
John McCall82fe67b2011-07-09 01:37:26 +00001993 // Check the type for a cleanup.
Richard Smith2b4fa532019-09-29 05:08:46 +00001994 if (QualType::DestructionKind dtorKind = D.needsDestruction(getContext()))
John McCall82fe67b2011-07-09 01:37:26 +00001995 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001996
John McCall1bd25562011-06-24 23:21:27 +00001997 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001998 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001999 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
2000 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
2001 }
2002
John McCallc533cb72011-02-22 06:44:22 +00002003 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00002004 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002005 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00002006
John McCallc533cb72011-02-22 06:44:22 +00002007 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002008 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00002009
John McCalla729c622012-02-17 03:33:10 +00002010 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00002011 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002012 }
Mike Stump626aecc2009-03-05 01:23:13 +00002013
John McCallc533cb72011-02-22 06:44:22 +00002014 // If this is a block variable, call _Block_object_destroy
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002015 // (on the unforwarded address). Don't enter this cleanup if we're in pure-GC
2016 // mode.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002017 if (emission.IsEscapingByRef &&
2018 CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002019 BlockFieldFlags Flags = BLOCK_FIELD_IS_BYREF;
2020 if (emission.Variable->getType().isObjCGCWeak())
2021 Flags |= BLOCK_FIELD_IS_WEAK;
2022 enterByrefCleanup(NormalAndEHCleanup, emission.Addr, Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00002023 /*LoadBlockVarAddr*/ false,
2024 cxxDestructorCanThrow(emission.Variable->getType()));
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002025 }
Chris Lattner03df1222007-06-02 04:53:11 +00002026}
Chris Lattner53621a52007-06-13 20:44:40 +00002027
Peter Collingbourne1425b452012-01-26 03:33:36 +00002028CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00002029CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
2030 switch (kind) {
2031 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00002032 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002033 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00002034 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002035 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00002036 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002037 return destroyARCWeak;
Akira Hatanaka7275da02018-02-28 07:15:55 +00002038 case QualType::DK_nontrivial_c_struct:
2039 return destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00002040 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00002041 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00002042}
2043
John McCall12cc42a2013-02-01 05:11:40 +00002044/// pushEHDestroy - Push the standard destructor for the given type as
2045/// an EH-only cleanup.
2046void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002047 Address addr, QualType type) {
John McCall12cc42a2013-02-01 05:11:40 +00002048 assert(dtorKind && "cannot push destructor for trivial type");
2049 assert(needsEHCleanup(dtorKind));
2050
2051 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
2052}
2053
2054/// pushDestroy - Push the standard destructor for the given type as
2055/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00002056void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002057 Address addr, QualType type) {
John McCall4bd0fb12011-07-12 16:41:08 +00002058 assert(dtorKind && "cannot push destructor for trivial type");
2059
2060 CleanupKind cleanupKind = getCleanupKind(dtorKind);
2061 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
2062 cleanupKind & EHCleanup);
2063}
2064
John McCall7f416cc2015-09-08 08:05:57 +00002065void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002066 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002067 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00002068 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
2069 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002070}
2071
John McCall7f416cc2015-09-08 08:05:57 +00002072void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002073 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
2074}
2075
Richard Smith736a9472013-06-12 20:42:33 +00002076void CodeGenFunction::pushLifetimeExtendedDestroy(
John McCall7f416cc2015-09-08 08:05:57 +00002077 CleanupKind cleanupKind, Address addr, QualType type,
Richard Smith736a9472013-06-12 20:42:33 +00002078 Destroyer *destroyer, bool useEHCleanupForArray) {
Richard Smith736a9472013-06-12 20:42:33 +00002079 // Push an EH-only cleanup for the object now.
2080 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
2081 // around in case a temporary's destructor throws an exception.
2082 if (cleanupKind & EHCleanup)
2083 EHStack.pushCleanup<DestroyObject>(
2084 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
2085 destroyer, useEHCleanupForArray);
2086
2087 // Remember that we need to push a full cleanup for the object at the
2088 // end of the full-expression.
2089 pushCleanupAfterFullExpr<DestroyObject>(
2090 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
2091}
2092
John McCall178360e2011-07-11 08:38:19 +00002093/// emitDestroy - Immediately perform the destruction of the given
2094/// object.
2095///
2096/// \param addr - the address of the object; a type*
2097/// \param type - the type of the object; if an array type, all
2098/// objects are destroyed in reverse order
2099/// \param destroyer - the function to call to destroy individual
2100/// elements
2101/// \param useEHCleanupForArray - whether an EH cleanup should be
2102/// used when destroying array elements, in case one of the
2103/// destructions throws an exception
John McCall7f416cc2015-09-08 08:05:57 +00002104void CodeGenFunction::emitDestroy(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002105 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002106 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00002107 const ArrayType *arrayType = getContext().getAsArrayType(type);
2108 if (!arrayType)
2109 return destroyer(*this, addr, type);
2110
John McCall7f416cc2015-09-08 08:05:57 +00002111 llvm::Value *length = emitArrayLength(arrayType, type, addr);
2112
2113 CharUnits elementAlign =
2114 addr.getAlignment()
2115 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
John McCall97eab0a2011-07-13 08:09:46 +00002116
2117 // Normally we have to check whether the array is zero-length.
2118 bool checkZeroLength = true;
2119
2120 // But if the array length is constant, we can suppress that.
2121 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
2122 // ...and if it's constant zero, we can just skip the entire thing.
2123 if (constLength->isZero()) return;
2124 checkZeroLength = false;
2125 }
2126
John McCall7f416cc2015-09-08 08:05:57 +00002127 llvm::Value *begin = addr.getPointer();
John McCall82fe67b2011-07-09 01:37:26 +00002128 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall7f416cc2015-09-08 08:05:57 +00002129 emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002130 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002131}
2132
John McCall178360e2011-07-11 08:38:19 +00002133/// emitArrayDestroy - Destroys all the elements of the given array,
2134/// beginning from last to first. The array cannot be zero-length.
2135///
2136/// \param begin - a type* denoting the first element of the array
2137/// \param end - a type* denoting one past the end of the array
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00002138/// \param elementType - the element type of the array
John McCall178360e2011-07-11 08:38:19 +00002139/// \param destroyer - the function to call to destroy elements
2140/// \param useEHCleanup - whether to push an EH cleanup to destroy
2141/// the remaining elements in case the destruction of a single
2142/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00002143void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
2144 llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002145 QualType elementType,
2146 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002147 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002148 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00002149 bool useEHCleanup) {
John McCall7f416cc2015-09-08 08:05:57 +00002150 assert(!elementType->isArrayType());
John McCall82fe67b2011-07-09 01:37:26 +00002151
2152 // The basic structure here is a do-while loop, because we don't
2153 // need to check for the zero-element case.
2154 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
2155 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
2156
John McCall97eab0a2011-07-13 08:09:46 +00002157 if (checkZeroLength) {
2158 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
2159 "arraydestroy.isempty");
2160 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
2161 }
2162
John McCall82fe67b2011-07-09 01:37:26 +00002163 // Enter the loop body, making that address the current address.
2164 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
2165 EmitBlock(bodyBB);
2166 llvm::PHINode *elementPast =
2167 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
2168 elementPast->addIncoming(end, entryBB);
2169
2170 // Shift the address back by one element.
2171 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
2172 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
2173 "arraydestroy.element");
2174
John McCall178360e2011-07-11 08:38:19 +00002175 if (useEHCleanup)
John McCall7f416cc2015-09-08 08:05:57 +00002176 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
2177 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002178
John McCall82fe67b2011-07-09 01:37:26 +00002179 // Perform the actual destruction there.
John McCall7f416cc2015-09-08 08:05:57 +00002180 destroyer(*this, Address(element, elementAlign), elementType);
John McCall82fe67b2011-07-09 01:37:26 +00002181
John McCall178360e2011-07-11 08:38:19 +00002182 if (useEHCleanup)
2183 PopCleanupBlock();
2184
John McCall82fe67b2011-07-09 01:37:26 +00002185 // Check whether we've reached the end.
2186 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
2187 Builder.CreateCondBr(done, doneBB, bodyBB);
2188 elementPast->addIncoming(element, Builder.GetInsertBlock());
2189
2190 // Done.
2191 EmitBlock(doneBB);
2192}
2193
John McCall178360e2011-07-11 08:38:19 +00002194/// Perform partial array destruction as if in an EH cleanup. Unlike
2195/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00002196static void emitPartialArrayDestroy(CodeGenFunction &CGF,
2197 llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002198 QualType type, CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002199 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00002200 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00002201 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00002202 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
2203 // VLAs don't require a GEP index to walk into.
2204 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00002205 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00002206 type = arrayType->getElementType();
2207 }
John McCall97eab0a2011-07-13 08:09:46 +00002208
2209 if (arrayDepth) {
John McCallf0f0b7a2015-09-14 18:57:08 +00002210 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
John McCall97eab0a2011-07-13 08:09:46 +00002211
John McCallf0f0b7a2015-09-14 18:57:08 +00002212 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
Jay Foad040dd822011-07-22 08:16:57 +00002213 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
2214 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00002215 }
2216
John McCall97eab0a2011-07-13 08:09:46 +00002217 // Destroy the array. We don't ever need an EH cleanup because we
2218 // assume that we're in an EH cleanup ourselves, so a throwing
2219 // destructor causes an immediate terminate.
John McCall7f416cc2015-09-08 08:05:57 +00002220 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002221 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00002222}
2223
John McCall82fe67b2011-07-09 01:37:26 +00002224namespace {
John McCall178360e2011-07-11 08:38:19 +00002225 /// RegularPartialArrayDestroy - a cleanup which performs a partial
2226 /// array destroy where the end pointer is regularly determined and
2227 /// does not need to be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002228 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall178360e2011-07-11 08:38:19 +00002229 llvm::Value *ArrayBegin;
2230 llvm::Value *ArrayEnd;
2231 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002232 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002233 CharUnits ElementAlign;
John McCall178360e2011-07-11 08:38:19 +00002234 public:
2235 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002236 QualType elementType, CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002237 CodeGenFunction::Destroyer *destroyer)
2238 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
John McCall7f416cc2015-09-08 08:05:57 +00002239 ElementType(elementType), Destroyer(destroyer),
2240 ElementAlign(elementAlign) {}
John McCall178360e2011-07-11 08:38:19 +00002241
Craig Topper4f12f102014-03-12 06:41:41 +00002242 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00002243 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002244 ElementType, ElementAlign, Destroyer);
John McCall178360e2011-07-11 08:38:19 +00002245 }
2246 };
2247
2248 /// IrregularPartialArrayDestroy - a cleanup which performs a
2249 /// partial array destroy where the end pointer is irregularly
2250 /// determined and must be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002251 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00002252 llvm::Value *ArrayBegin;
John McCall7f416cc2015-09-08 08:05:57 +00002253 Address ArrayEndPointer;
John McCall82fe67b2011-07-09 01:37:26 +00002254 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002255 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002256 CharUnits ElementAlign;
John McCall82fe67b2011-07-09 01:37:26 +00002257 public:
John McCall178360e2011-07-11 08:38:19 +00002258 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002259 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002260 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002261 CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002262 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00002263 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
John McCall7f416cc2015-09-08 08:05:57 +00002264 ElementType(elementType), Destroyer(destroyer),
2265 ElementAlign(elementAlign) {}
John McCall82fe67b2011-07-09 01:37:26 +00002266
Craig Topper4f12f102014-03-12 06:41:41 +00002267 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00002268 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00002269 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002270 ElementType, ElementAlign, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002271 }
2272 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002273} // end anonymous namespace
John McCall82fe67b2011-07-09 01:37:26 +00002274
John McCall178360e2011-07-11 08:38:19 +00002275/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00002276/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00002277/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002278///
John McCall82fe67b2011-07-09 01:37:26 +00002279/// \param elementType - the immediate element type of the array;
2280/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00002281void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002282 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002283 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002284 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002285 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002286 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
2287 arrayBegin, arrayEndPointer,
John McCall7f416cc2015-09-08 08:05:57 +00002288 elementType, elementAlign,
2289 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002290}
2291
2292/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
2293/// already-constructed elements of the given array. The cleanup
2294/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002295///
John McCall178360e2011-07-11 08:38:19 +00002296/// \param elementType - the immediate element type of the array;
2297/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00002298void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
2299 llvm::Value *arrayEnd,
2300 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002301 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002302 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002303 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00002304 arrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002305 elementType, elementAlign,
2306 destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002307}
2308
Nadav Rotem1da30942013-03-23 06:43:35 +00002309/// Lazily declare the @llvm.lifetime.start intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002310llvm::Function *CodeGenModule::getLLVMLifetimeStartFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002311 if (LifetimeStartFn)
2312 return LifetimeStartFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002313 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002314 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002315 return LifetimeStartFn;
2316}
2317
2318/// Lazily declare the @llvm.lifetime.end intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002319llvm::Function *CodeGenModule::getLLVMLifetimeEndFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002320 if (LifetimeEndFn)
2321 return LifetimeEndFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002322 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002323 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002324 return LifetimeEndFn;
2325}
2326
John McCall31168b02011-06-15 23:02:42 +00002327namespace {
2328 /// A cleanup to perform a release of an object at the end of a
2329 /// function. This is used to balance out the incoming +1 of a
2330 /// ns_consumed argument when we can't reasonably do that just by
2331 /// not doing the initial retain for a __block argument.
David Blaikie7e70d682015-08-18 22:40:54 +00002332 struct ConsumeARCParameter final : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00002333 ConsumeARCParameter(llvm::Value *param,
2334 ARCPreciseLifetime_t precise)
2335 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00002336
2337 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00002338 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00002339
Craig Topper4f12f102014-03-12 06:41:41 +00002340 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00002341 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00002342 }
2343 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002344} // end anonymous namespace
John McCall31168b02011-06-15 23:02:42 +00002345
Mike Stump11289f42009-09-09 15:08:12 +00002346/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00002347/// for the specified parameter and set up LocalDeclMap.
John McCall7f416cc2015-09-08 08:05:57 +00002348void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
2349 unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002350 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00002351 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002352 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00002353
John McCall7f416cc2015-09-08 08:05:57 +00002354 Arg.getAnyValue()->setName(D.getName());
John McCall147d0212011-02-22 22:38:33 +00002355
Adrian Prantl51936dd2013-03-14 17:53:33 +00002356 QualType Ty = D.getType();
2357
John McCall147d0212011-02-22 22:38:33 +00002358 // Use better IR generation for certain implicit parameters.
John McCall7f416cc2015-09-08 08:05:57 +00002359 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
John McCall147d0212011-02-22 22:38:33 +00002360 // The only implicit argument a block has is its literal.
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002361 // This may be passed as an inalloca'ed value on Windows x86.
John McCall147d0212011-02-22 22:38:33 +00002362 if (BlockInfo) {
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002363 llvm::Value *V = Arg.isIndirect()
2364 ? Builder.CreateLoad(Arg.getIndirectAddress())
2365 : Arg.getDirectValue();
2366 setBlockContextParameter(IPD, ArgNo, V);
John McCall147d0212011-02-22 22:38:33 +00002367 return;
2368 }
2369 }
2370
John McCall7f416cc2015-09-08 08:05:57 +00002371 Address DeclPtr = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002372 bool DoStore = false;
2373 bool IsScalar = hasScalarEvaluationKind(Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002374 // If we already have a pointer to the argument, reuse the input pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002375 if (Arg.isIndirect()) {
2376 DeclPtr = Arg.getIndirectAddress();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002377 // If we have a prettier pointer type at this point, bitcast to that.
John McCall7f416cc2015-09-08 08:05:57 +00002378 unsigned AS = DeclPtr.getType()->getAddressSpace();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002379 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
John McCall7f416cc2015-09-08 08:05:57 +00002380 if (DeclPtr.getType() != IRTy)
2381 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
Yaxun Liu5b330e82018-03-15 15:25:19 +00002382 // Indirect argument is in alloca address space, which may be different
2383 // from the default address space.
2384 auto AllocaAS = CGM.getASTAllocaAddressSpace();
2385 auto *V = DeclPtr.getPointer();
2386 auto SrcLangAS = getLangOpts().OpenCL ? LangAS::opencl_private : AllocaAS;
2387 auto DestLangAS =
2388 getLangOpts().OpenCL ? LangAS::opencl_private : LangAS::Default;
2389 if (SrcLangAS != DestLangAS) {
2390 assert(getContext().getTargetAddressSpace(SrcLangAS) ==
2391 CGM.getDataLayout().getAllocaAddrSpace());
2392 auto DestAS = getContext().getTargetAddressSpace(DestLangAS);
2393 auto *T = V->getType()->getPointerElementType()->getPointerTo(DestAS);
2394 DeclPtr = Address(getTargetHooks().performAddrSpaceCast(
2395 *this, V, SrcLangAS, DestLangAS, T, true),
2396 DeclPtr.getAlignment());
2397 }
John McCall7f416cc2015-09-08 08:05:57 +00002398
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002399 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner19819442014-07-25 21:39:46 +00002400 // Don't push a cleanup in a thunk for a method that will also emit a
2401 // cleanup.
Akira Hatanaka85282972018-05-15 21:00:30 +00002402 if (hasAggregateEvaluationKind(Ty) && !CurFuncIsThunk &&
Simon Pilgrim1cd399c2019-10-03 11:22:48 +00002403 Ty->castAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Richard Smith2b4fa532019-09-29 05:08:46 +00002404 if (QualType::DestructionKind DtorKind =
2405 D.needsDestruction(getContext())) {
Akira Hatanaka7275da02018-02-28 07:15:55 +00002406 assert((DtorKind == QualType::DK_cxx_destructor ||
2407 DtorKind == QualType::DK_nontrivial_c_struct) &&
2408 "unexpected destructor type");
2409 pushDestroy(DtorKind, DeclPtr, Ty);
Akira Hatanakaccda3d22018-04-27 06:57:00 +00002410 CalleeDestructedParamCleanups[cast<ParmVarDecl>(&D)] =
2411 EHStack.stable_begin();
Akira Hatanaka7275da02018-02-28 07:15:55 +00002412 }
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002413 }
Chris Lattner53621a52007-06-13 20:44:40 +00002414 } else {
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00002415 // Check if the parameter address is controlled by OpenMP runtime.
2416 Address OpenMPLocalAddr =
2417 getLangOpts().OpenMP
2418 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
2419 : Address::invalid();
2420 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
2421 DeclPtr = OpenMPLocalAddr;
2422 } else {
2423 // Otherwise, create a temporary to hold the value.
2424 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D),
2425 D.getName() + ".addr");
2426 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002427 DoStore = true;
2428 }
Mike Stump11289f42009-09-09 15:08:12 +00002429
John McCall7f416cc2015-09-08 08:05:57 +00002430 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr);
2431
2432 LValue lv = MakeAddrLValue(DeclPtr, Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002433 if (IsScalar) {
John McCall31168b02011-06-15 23:02:42 +00002434 Qualifiers qs = Ty.getQualifiers();
John McCall31168b02011-06-15 23:02:42 +00002435 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
2436 // We honor __attribute__((ns_consumed)) for types with lifetime.
2437 // For __strong, it's handled by just skipping the initial retain;
2438 // otherwise we have to balance out the initial +1 with an extra
2439 // cleanup to do the release at the end of the function.
2440 bool isConsumed = D.hasAttr<NSConsumedAttr>();
2441
Erik Pilkington1e368822019-01-04 18:33:06 +00002442 // If a parameter is pseudo-strong then we can omit the implicit retain.
John McCalld4631322011-06-17 06:42:21 +00002443 if (D.isARCPseudoStrong()) {
Erik Pilkington1e368822019-01-04 18:33:06 +00002444 assert(lt == Qualifiers::OCL_Strong &&
2445 "pseudo-strong variable isn't strong?");
2446 assert(qs.hasConst() && "pseudo-strong variable should be const!");
John McCall31168b02011-06-15 23:02:42 +00002447 lt = Qualifiers::OCL_ExplicitNone;
2448 }
2449
Saleem Abdulrasoolda6784e2017-06-27 18:37:51 +00002450 // Load objects passed indirectly.
2451 if (Arg.isIndirect() && !ArgVal)
2452 ArgVal = Builder.CreateLoad(DeclPtr);
2453
John McCall31168b02011-06-15 23:02:42 +00002454 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002455 if (!isConsumed) {
2456 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2457 // use objc_storeStrong(&dest, value) for retaining the
2458 // object. But first, store a null into 'dest' because
2459 // objc_storeStrong attempts to release its old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002460 llvm::Value *Null = CGM.EmitNullConstant(D.getType());
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002461 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002462 EmitARCStoreStrongCall(lv.getAddress(*this), ArgVal, true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002463 DoStore = false;
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002464 }
2465 else
John McCall31168b02011-06-15 23:02:42 +00002466 // Don't use objc_retainBlock for block pointers, because we
2467 // don't want to Block_copy something just because we got it
2468 // as a parameter.
John McCall7f416cc2015-09-08 08:05:57 +00002469 ArgVal = EmitARCRetainNonBlock(ArgVal);
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002470 }
John McCall31168b02011-06-15 23:02:42 +00002471 } else {
2472 // Push the cleanup for a consumed parameter.
John McCallcdda29c2013-03-13 03:10:54 +00002473 if (isConsumed) {
2474 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
2475 ? ARCPreciseLifetime : ARCImpreciseLifetime);
John McCall7f416cc2015-09-08 08:05:57 +00002476 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal,
John McCallcdda29c2013-03-13 03:10:54 +00002477 precise);
2478 }
John McCall31168b02011-06-15 23:02:42 +00002479
2480 if (lt == Qualifiers::OCL_Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00002481 EmitARCInitWeak(DeclPtr, ArgVal);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002482 DoStore = false; // The weak init is a store, no need to do two.
John McCall31168b02011-06-15 23:02:42 +00002483 }
2484 }
2485
2486 // Enter the cleanup scope.
2487 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
2488 }
Chris Lattner53621a52007-06-13 20:44:40 +00002489 }
2490
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002491 // Store the initial value into the alloca.
2492 if (DoStore)
John McCall7f416cc2015-09-08 08:05:57 +00002493 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002494
John McCall7f416cc2015-09-08 08:05:57 +00002495 setAddrOfLocalVar(&D, DeclPtr);
Sanjiv Gupta18de6242008-05-30 10:30:31 +00002496
Vedant Kumar04818d82019-07-29 22:49:55 +00002497 // Emit debug info for param declarations in non-thunk functions.
Alexey Samsonov74a38682012-05-04 07:39:27 +00002498 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002499 if (CGM.getCodeGenOpts().getDebugInfo() >=
Vedant Kumar04818d82019-07-29 22:49:55 +00002500 codegenoptions::LimitedDebugInfo &&
2501 !CurFuncIsThunk) {
John McCall7f416cc2015-09-08 08:05:57 +00002502 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00002503 }
2504 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002505
2506 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00002507 EmitVarAnnotations(&D, DeclPtr.getPointer());
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002508
2509 // We can only check return value nullability if all arguments to the
2510 // function satisfy their nullability preconditions. This makes it necessary
2511 // to emit null checks for args in the function body itself.
2512 if (requiresReturnValueNullabilityCheck()) {
2513 auto Nullability = Ty->getNullability(getContext());
2514 if (Nullability && *Nullability == NullabilityKind::NonNull) {
2515 SanitizerScope SanScope(this);
2516 RetValNullabilityPrecondition =
2517 Builder.CreateAnd(RetValNullabilityPrecondition,
2518 Builder.CreateIsNotNull(Arg.getAnyValue()));
2519 }
2520 }
Chris Lattner53621a52007-06-13 20:44:40 +00002521}
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00002522
Alexey Bataevc5b1d322016-03-04 09:22:22 +00002523void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
2524 CodeGenFunction *CGF) {
2525 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2526 return;
2527 getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
2528}
Kelvin Li1408f912018-09-26 04:28:39 +00002529
Michael Kruse251e1482019-02-01 20:25:04 +00002530void CodeGenModule::EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D,
Michael Krused47b9432019-08-05 18:43:21 +00002531 CodeGenFunction *CGF) {
2532 if (!LangOpts.OpenMP || LangOpts.OpenMPSimd ||
2533 (!LangOpts.EmitAllDecls && !D->isUsed()))
Michael Kruse251e1482019-02-01 20:25:04 +00002534 return;
Michael Krused47b9432019-08-05 18:43:21 +00002535 getOpenMPRuntime().emitUserDefinedMapper(D, CGF);
Michael Kruse251e1482019-02-01 20:25:04 +00002536}
2537
Kelvin Li1408f912018-09-26 04:28:39 +00002538void CodeGenModule::EmitOMPRequiresDecl(const OMPRequiresDecl *D) {
Alexey Bataev982a35e2019-03-19 17:09:52 +00002539 getOpenMPRuntime().checkArchForUnifiedAddressing(D);
Kelvin Li1408f912018-09-26 04:28:39 +00002540}