blob: 61fb8fa384cf32aec56d0e8942b59a300151e933 [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 Smith2b4fa532019-09-29 05:08:46 +0000369 if (D.needsDestruction(getContext()) && HaveInsertPoint()) {
Richard Smith6331c402012-02-13 22:16:19 +0000370 // We have a constant initializer, but a nontrivial destructor. We still
371 // need to perform a guarded "initialization" in order to register the
Richard Smithe070fd22012-02-17 06:48:11 +0000372 // destructor.
Chandler Carruth84537952012-03-30 19:44:53 +0000373 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith6331c402012-02-13 22:16:19 +0000374 }
375
Chandler Carruth84537952012-03-30 19:44:53 +0000376 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000377}
378
John McCall1c9c3fd2010-10-15 04:57:14 +0000379void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000380 llvm::GlobalValue::LinkageTypes Linkage) {
John McCallb88a5662012-03-30 21:00:39 +0000381 // Check to see if we already have a global variable for this
382 // declaration. This can happen when double-emitting function
383 // bodies, e.g. with complete and base constructors.
Reid Kleckner453e0562014-10-08 01:07:54 +0000384 llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage);
John McCall7f416cc2015-09-08 08:05:57 +0000385 CharUnits alignment = getContext().getDeclAlign(&D);
Daniel Dunbara374e602009-02-25 19:45:19 +0000386
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000387 // Store into LocalDeclMap before generating initializer to handle
388 // circular references.
John McCall7f416cc2015-09-08 08:05:57 +0000389 setAddrOfLocalVar(&D, Address(addr, alignment));
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000390
John McCall4a39ab82010-05-04 20:45:42 +0000391 // We can't have a VLA here, but we can have a pointer to a VLA,
392 // even though that doesn't really make any sense.
Eli Friedmanbc633be2009-04-20 03:54:15 +0000393 // Make sure to evaluate VLA bounds now so that we have them for later.
394 if (D.getType()->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000395 EmitVariablyModifiedType(D.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000396
John McCallb88a5662012-03-30 21:00:39 +0000397 // Save the type in case adding the initializer forces a type change.
398 llvm::Type *expectedType = addr->getType();
Eli Friedmanbc633be2009-04-20 03:54:15 +0000399
Eli Benderskycb399432014-03-24 22:05:38 +0000400 llvm::GlobalVariable *var =
401 cast<llvm::GlobalVariable>(addr->stripPointerCasts());
Artem Belevich4d430ba2016-05-09 22:09:56 +0000402
403 // CUDA's local and local static __shared__ variables should not
404 // have any non-empty initializers. This is ensured by Sema.
405 // Whatever initializer such variable may have when it gets here is
406 // a no-op and should not be emitted.
407 bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
408 D.hasAttr<CUDASharedAttr>();
Chris Lattnere99c1102009-12-05 08:22:11 +0000409 // If this value has an initializer, emit it.
Artem Belevich4d430ba2016-05-09 22:09:56 +0000410 if (D.getInit() && !isCudaSharedVar)
John McCallb88a5662012-03-30 21:00:39 +0000411 var = AddInitializerToStaticVarDecl(D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000412
Guillaume Chateletc79099e2019-10-03 13:00:29 +0000413 var->setAlignment(alignment.getAsAlign());
Chris Lattner4d941092010-03-10 23:59:59 +0000414
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000415 if (D.hasAttr<AnnotateAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000416 CGM.AddGlobalAnnotations(&D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000417
Javed Absar2a67c9e2017-06-05 10:11:57 +0000418 if (auto *SA = D.getAttr<PragmaClangBSSSectionAttr>())
419 var->addAttribute("bss-section", SA->getName());
420 if (auto *SA = D.getAttr<PragmaClangDataSectionAttr>())
421 var->addAttribute("data-section", SA->getName());
422 if (auto *SA = D.getAttr<PragmaClangRodataSectionAttr>())
423 var->addAttribute("rodata-section", SA->getName());
Dmitry Mikulinf14642f2019-10-15 18:31:10 +0000424 if (auto *SA = D.getAttr<PragmaClangRelroSectionAttr>())
425 var->addAttribute("relro-section", SA->getName());
Javed Absar2a67c9e2017-06-05 10:11:57 +0000426
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000427 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000428 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000429
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000430 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000431 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000432
Chandler Carruth84537952012-03-30 19:44:53 +0000433 // We may have to cast the constant because of the initializer
434 // mismatch above.
435 //
436 // FIXME: It is really dangerous to store this in the map; if anyone
437 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000438 llvm::Constant *castedAddr =
439 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCall7f416cc2015-09-08 08:05:57 +0000440 if (var != castedAddr)
441 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
John McCallb88a5662012-03-30 21:00:39 +0000442 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000443
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000444 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
Alexey Samsonov4f319cc2014-07-02 16:54:41 +0000445
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000446 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000447 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000448 if (DI &&
Benjamin Kramer8c305922016-02-02 11:06:51 +0000449 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000450 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000451 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000452 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000453}
Mike Stump11289f42009-09-09 15:08:12 +0000454
John McCall2b7fc382010-07-13 20:32:21 +0000455namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000456 struct DestroyObject final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000457 DestroyObject(Address addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000458 CodeGenFunction::Destroyer *destroyer,
459 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000460 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000461 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000462
John McCall7f416cc2015-09-08 08:05:57 +0000463 Address addr;
John McCall82fe67b2011-07-09 01:37:26 +0000464 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000465 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000466 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000467
Craig Topper4f12f102014-03-12 06:41:41 +0000468 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000469 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000470 bool useEHCleanupForArray =
471 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000472
473 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000474 }
475 };
476
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000477 template <class Derived>
478 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
Marco Antognini88559632019-07-22 09:39:13 +0000479 DestroyNRVOVariable(Address addr, QualType type, llvm::Value *NRVOFlag)
480 : NRVOFlag(NRVOFlag), Loc(addr), Ty(type) {}
John McCall2b7fc382010-07-13 20:32:21 +0000481
John McCall2b7fc382010-07-13 20:32:21 +0000482 llvm::Value *NRVOFlag;
John McCall7f416cc2015-09-08 08:05:57 +0000483 Address Loc;
Marco Antognini88559632019-07-22 09:39:13 +0000484 QualType Ty;
John McCall2b7fc382010-07-13 20:32:21 +0000485
Craig Topper4f12f102014-03-12 06:41:41 +0000486 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000487 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000488 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000489
Craig Topper8a13c412014-05-21 05:09:00 +0000490 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000491 if (NRVO) {
492 // If we exited via NRVO, we skip the destructor call.
493 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
494 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
John McCall7f416cc2015-09-08 08:05:57 +0000495 llvm::Value *DidNRVO =
496 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
John McCall2b7fc382010-07-13 20:32:21 +0000497 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
498 CGF.EmitBlock(RunDtorBB);
499 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000500
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000501 static_cast<Derived *>(this)->emitDestructorCall(CGF);
John McCall2b7fc382010-07-13 20:32:21 +0000502
503 if (NRVO) CGF.EmitBlock(SkipDtorBB);
504 }
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000505
506 virtual ~DestroyNRVOVariable() = default;
507 };
508
509 struct DestroyNRVOVariableCXX final
510 : DestroyNRVOVariable<DestroyNRVOVariableCXX> {
Marco Antognini88559632019-07-22 09:39:13 +0000511 DestroyNRVOVariableCXX(Address addr, QualType type,
512 const CXXDestructorDecl *Dtor, llvm::Value *NRVOFlag)
513 : DestroyNRVOVariable<DestroyNRVOVariableCXX>(addr, type, NRVOFlag),
514 Dtor(Dtor) {}
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000515
516 const CXXDestructorDecl *Dtor;
517
518 void emitDestructorCall(CodeGenFunction &CGF) {
519 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
520 /*ForVirtualBase=*/false,
Marco Antognini88559632019-07-22 09:39:13 +0000521 /*Delegating=*/false, Loc, Ty);
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000522 }
523 };
524
525 struct DestroyNRVOVariableC final
526 : DestroyNRVOVariable<DestroyNRVOVariableC> {
527 DestroyNRVOVariableC(Address addr, llvm::Value *NRVOFlag, QualType Ty)
Marco Antognini88559632019-07-22 09:39:13 +0000528 : DestroyNRVOVariable<DestroyNRVOVariableC>(addr, Ty, NRVOFlag) {}
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000529
530 void emitDestructorCall(CodeGenFunction &CGF) {
531 CGF.destroyNonTrivialCStruct(CGF, Loc, Ty);
532 }
John McCall2b7fc382010-07-13 20:32:21 +0000533 };
John McCall2b7fc382010-07-13 20:32:21 +0000534
David Blaikie7e70d682015-08-18 22:40:54 +0000535 struct CallStackRestore final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000536 Address Stack;
537 CallStackRestore(Address Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000538 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000539 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
James Y Knight8799cae2019-02-03 21:53:49 +0000540 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
John McCalla464ff92010-07-21 06:13:08 +0000541 CGF.Builder.CreateCall(F, V);
542 }
543 };
544
David Blaikie7e70d682015-08-18 22:40:54 +0000545 struct ExtendGCLifetime final : EHScopeStack::Cleanup {
John McCall1bd25562011-06-24 23:21:27 +0000546 const VarDecl &Var;
547 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
548
Craig Topper4f12f102014-03-12 06:41:41 +0000549 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000550 // Compute the address of the local variable, in case it's a
551 // byref or something.
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000552 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000553 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000554 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
555 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000556 CGF.EmitExtendGCLifetime(value);
557 }
558 };
559
David Blaikie7e70d682015-08-18 22:40:54 +0000560 struct CallCleanupFunction final : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000561 llvm::Constant *CleanupFn;
562 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000563 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000564
John McCalla464ff92010-07-21 06:13:08 +0000565 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000566 const VarDecl *Var)
567 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000568
Craig Topper4f12f102014-03-12 06:41:41 +0000569 void Emit(CodeGenFunction &CGF, Flags flags) override {
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000570 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000571 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000572 // Compute the address of the local variable, in case it's a byref
573 // or something.
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800574 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer(CGF);
John McCallc533cb72011-02-22 06:44:22 +0000575
John McCalla464ff92010-07-21 06:13:08 +0000576 // In some cases, the type of the function argument will be different from
577 // the type of the pointer. An example of this is
578 // void f(void* arg);
579 // __attribute__((cleanup(f))) void *g;
580 //
581 // To fix this we insert a bitcast here.
582 QualType ArgTy = FnInfo.arg_begin()->type;
583 llvm::Value *Arg =
584 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
585
586 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000587 Args.add(RValue::get(Arg),
588 CGF.getContext().getPointerType(Var.getType()));
John McCallb92ab1a2016-10-26 23:46:34 +0000589 auto Callee = CGCallee::forDirect(CleanupFn);
590 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
John McCalla464ff92010-07-21 06:13:08 +0000591 }
592 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000593} // end anonymous namespace
John McCalla464ff92010-07-21 06:13:08 +0000594
John McCall31168b02011-06-15 23:02:42 +0000595/// EmitAutoVarWithLifetime - Does the setup required for an automatic
596/// variable with lifetime.
597static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
John McCall7f416cc2015-09-08 08:05:57 +0000598 Address addr,
John McCall31168b02011-06-15 23:02:42 +0000599 Qualifiers::ObjCLifetime lifetime) {
600 switch (lifetime) {
601 case Qualifiers::OCL_None:
602 llvm_unreachable("present but none");
603
604 case Qualifiers::OCL_ExplicitNone:
605 // nothing to do
606 break;
607
608 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000609 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000610 (var.hasAttr<ObjCPreciseLifetimeAttr>()
611 ? CodeGenFunction::destroyARCStrongPrecise
612 : CodeGenFunction::destroyARCStrongImprecise);
613
614 CleanupKind cleanupKind = CGF.getARCCleanupKind();
615 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
616 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000617 break;
618 }
619 case Qualifiers::OCL_Autoreleasing:
620 // nothing to do
621 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000622
John McCall31168b02011-06-15 23:02:42 +0000623 case Qualifiers::OCL_Weak:
624 // __weak objects always get EH cleanups; otherwise, exceptions
625 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000626 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
627 CodeGenFunction::destroyARCWeak,
628 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000629 break;
630 }
631}
632
633static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
634 if (const Expr *e = dyn_cast<Expr>(s)) {
635 // Skip the most common kinds of expressions that make
636 // hierarchy-walking expensive.
637 s = e = e->IgnoreParenCasts();
638
639 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
640 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000641 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
642 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000643 for (const auto &I : block->captures()) {
644 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000645 return true;
646 }
647 }
John McCall31168b02011-06-15 23:02:42 +0000648 }
649
Benjamin Kramer642f1732015-07-02 21:03:14 +0000650 for (const Stmt *SubStmt : s->children())
651 // SubStmt might be null; as in missing decl or conditional of an if-stmt.
652 if (SubStmt && isAccessedBy(var, SubStmt))
John McCall31168b02011-06-15 23:02:42 +0000653 return true;
654
655 return false;
656}
657
658static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
659 if (!decl) return false;
660 if (!isa<VarDecl>(decl)) return false;
661 const VarDecl *var = cast<VarDecl>(decl);
662 return isAccessedBy(*var, e);
663}
664
John McCallf8a9b662015-10-21 18:06:31 +0000665static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
666 const LValue &destLV, const Expr *init) {
John McCall0204e342015-11-16 22:11:41 +0000667 bool needsCast = false;
668
John McCallf8a9b662015-10-21 18:06:31 +0000669 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
670 switch (castExpr->getCastKind()) {
671 // Look through casts that don't require representation changes.
672 case CK_NoOp:
673 case CK_BitCast:
674 case CK_BlockPointerToObjCPointerCast:
John McCall0204e342015-11-16 22:11:41 +0000675 needsCast = true;
John McCallf8a9b662015-10-21 18:06:31 +0000676 break;
677
678 // If we find an l-value to r-value cast from a __weak variable,
679 // emit this operation as a copy or move.
680 case CK_LValueToRValue: {
681 const Expr *srcExpr = castExpr->getSubExpr();
682 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
683 return false;
684
685 // Emit the source l-value.
686 LValue srcLV = CGF.EmitLValue(srcExpr);
687
John McCall0204e342015-11-16 22:11:41 +0000688 // Handle a formal type change to avoid asserting.
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800689 auto srcAddr = srcLV.getAddress(CGF);
John McCall0204e342015-11-16 22:11:41 +0000690 if (needsCast) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800691 srcAddr = CGF.Builder.CreateElementBitCast(
692 srcAddr, destLV.getAddress(CGF).getElementType());
John McCall0204e342015-11-16 22:11:41 +0000693 }
694
John McCallf8a9b662015-10-21 18:06:31 +0000695 // If it was an l-value, use objc_copyWeak.
696 if (srcExpr->getValueKind() == VK_LValue) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800697 CGF.EmitARCCopyWeak(destLV.getAddress(CGF), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000698 } else {
699 assert(srcExpr->getValueKind() == VK_XValue);
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800700 CGF.EmitARCMoveWeak(destLV.getAddress(CGF), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000701 }
702 return true;
703 }
704
705 // Stop at anything else.
706 default:
707 return false;
708 }
709
710 init = castExpr->getSubExpr();
John McCallf8a9b662015-10-21 18:06:31 +0000711 }
712 return false;
713}
714
John McCall1553b192011-06-16 04:16:24 +0000715static void drillIntoBlockVariable(CodeGenFunction &CGF,
716 LValue &lvalue,
717 const VarDecl *var) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800718 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(CGF), var));
John McCall1553b192011-06-16 04:16:24 +0000719}
720
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000721void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS,
722 SourceLocation Loc) {
723 if (!SanOpts.has(SanitizerKind::NullabilityAssign))
724 return;
725
726 auto Nullability = LHS.getType()->getNullability(getContext());
727 if (!Nullability || *Nullability != NullabilityKind::NonNull)
728 return;
729
730 // Check if the right hand side of the assignment is nonnull, if the left
731 // hand side must be nonnull.
732 SanitizerScope SanScope(this);
733 llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS);
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000734 llvm::Constant *StaticData[] = {
735 EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()),
Simon Pilgrim2df19982017-03-14 21:43:52 +0000736 llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000737 llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)};
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000738 EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}},
739 SanitizerHandler::TypeMismatch, StaticData, RHS);
740}
741
David Blaikie73ca5692014-12-09 00:32:22 +0000742void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +0000743 LValue lvalue, bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000744 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000745 if (!lifetime) {
746 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000747 if (capturedByInit)
748 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000749 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
David Blaikie66e41972015-01-14 07:38:27 +0000750 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000751 return;
752 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000753
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000754 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
755 init = DIE->getExpr();
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000756
John McCall31168b02011-06-15 23:02:42 +0000757 // If we're emitting a value with lifetime, we have to do the
758 // initialization *before* we leave the cleanup scopes.
Bill Wendling7c44da22018-10-31 03:48:47 +0000759 if (const FullExpr *fe = dyn_cast<FullExpr>(init)) {
760 enterFullExpression(fe);
761 init = fe->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000762 }
763 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000764
765 // We have to maintain the illusion that the variable is
766 // zero-initialized. If the variable might be accessed in its
767 // initializer, zero-initialize before running the initializer, then
768 // actually perform the initialization with an assign.
769 bool accessedByInit = false;
770 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000771 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000772 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000773 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000774 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000775 if (capturedByInit) {
776 // We can use a simple GEP for this because it can't have been
777 // moved yet.
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800778 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(*this),
John McCall7f416cc2015-09-08 08:05:57 +0000779 cast<VarDecl>(D),
780 /*follow*/ false));
John McCall31168b02011-06-15 23:02:42 +0000781 }
782
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800783 auto ty =
784 cast<llvm::PointerType>(tempLV.getAddress(*this).getElementType());
Yaxun Liu402804b2016-12-15 08:09:08 +0000785 llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000786
John McCall31168b02011-06-15 23:02:42 +0000787 // If __weak, we want to use a barrier under certain conditions.
788 if (lifetime == Qualifiers::OCL_Weak)
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800789 EmitARCInitWeak(tempLV.getAddress(*this), zero);
John McCall31168b02011-06-15 23:02:42 +0000790
791 // Otherwise just do a simple store.
792 else
David Chisnallfa35df62012-01-16 17:27:18 +0000793 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000794 }
795
796 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000797 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000798
799 switch (lifetime) {
800 case Qualifiers::OCL_None:
801 llvm_unreachable("present but none");
802
Erik Pilkington1e368822019-01-04 18:33:06 +0000803 case Qualifiers::OCL_Strong: {
804 if (!D || !isa<VarDecl>(D) || !cast<VarDecl>(D)->isARCPseudoStrong()) {
805 value = EmitARCRetainScalarExpr(init);
806 break;
807 }
808 // If D is pseudo-strong, treat it like __unsafe_unretained here. This means
809 // that we omit the retain, and causes non-autoreleased return values to be
810 // immediately released.
811 LLVM_FALLTHROUGH;
812 }
813
John McCall31168b02011-06-15 23:02:42 +0000814 case Qualifiers::OCL_ExplicitNone:
John McCalle399e5b2016-01-27 18:32:30 +0000815 value = EmitARCUnsafeUnretainedScalarExpr(init);
John McCall31168b02011-06-15 23:02:42 +0000816 break;
817
John McCall31168b02011-06-15 23:02:42 +0000818 case Qualifiers::OCL_Weak: {
John McCallf8a9b662015-10-21 18:06:31 +0000819 // If it's not accessed by the initializer, try to emit the
820 // initialization with a copy or move.
821 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
822 return;
823 }
824
John McCall31168b02011-06-15 23:02:42 +0000825 // No way to optimize a producing initializer into this. It's not
826 // worth optimizing for, because the value will immediately
827 // disappear in the common case.
828 value = EmitScalarExpr(init);
829
John McCall1553b192011-06-16 04:16:24 +0000830 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000831 if (accessedByInit)
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800832 EmitARCStoreWeak(lvalue.getAddress(*this), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000833 else
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800834 EmitARCInitWeak(lvalue.getAddress(*this), value);
John McCall31168b02011-06-15 23:02:42 +0000835 return;
836 }
837
838 case Qualifiers::OCL_Autoreleasing:
839 value = EmitARCRetainAutoreleaseScalarExpr(init);
840 break;
841 }
842
John McCall1553b192011-06-16 04:16:24 +0000843 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000844
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000845 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
846
John McCall31168b02011-06-15 23:02:42 +0000847 // If the variable might have been accessed by its initializer, we
848 // might have to initialize with a barrier. We have to do this for
849 // both __weak and __strong, but __weak got filtered out above.
850 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000851 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000852 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000853 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000854 return;
855 }
856
David Chisnallfa35df62012-01-16 17:27:18 +0000857 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000858}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000859
JF Bastiened92f602018-07-20 23:37:12 +0000860/// Decide whether we can emit the non-zero parts of the specified initializer
861/// with equal or fewer than NumStores scalar stores.
862static bool canEmitInitWithFewStoresAfterBZero(llvm::Constant *Init,
863 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000864 // Zero and Undef never requires any extra stores.
865 if (isa<llvm::ConstantAggregateZero>(Init) ||
866 isa<llvm::ConstantPointerNull>(Init) ||
867 isa<llvm::UndefValue>(Init))
868 return true;
869 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
870 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
871 isa<llvm::ConstantExpr>(Init))
872 return Init->isNullValue() || NumStores--;
873
874 // See if we can emit each element.
875 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
876 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
877 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
JF Bastiened92f602018-07-20 23:37:12 +0000878 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattnere6af8862010-12-02 01:58:41 +0000879 return false;
880 }
881 return true;
882 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000883
Chris Lattner236b3572012-01-31 04:36:19 +0000884 if (llvm::ConstantDataSequential *CDS =
885 dyn_cast<llvm::ConstantDataSequential>(Init)) {
886 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
887 llvm::Constant *Elt = CDS->getElementAsConstant(i);
JF Bastiened92f602018-07-20 23:37:12 +0000888 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattner236b3572012-01-31 04:36:19 +0000889 return false;
890 }
891 return true;
892 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000893
Chris Lattnerb85025f2010-12-01 02:05:19 +0000894 // Anything else is hard and scary.
895 return false;
896}
897
JF Bastiened92f602018-07-20 23:37:12 +0000898/// For inits that canEmitInitWithFewStoresAfterBZero returned true for, emit
899/// the scalar stores that would be required.
900static void emitStoresForInitAfterBZero(CodeGenModule &CGM,
901 llvm::Constant *Init, Address Loc,
902 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000903 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
JF Bastiened92f602018-07-20 23:37:12 +0000904 "called emitStoresForInitAfterBZero for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000905
Chris Lattnere6af8862010-12-02 01:58:41 +0000906 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
907 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
908 isa<llvm::ConstantExpr>(Init)) {
JF Bastien9aab85a2018-07-13 20:33:23 +0000909 Builder.CreateStore(Init, Loc, isVolatile);
Chris Lattner236b3572012-01-31 04:36:19 +0000910 return;
911 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000912
913 if (llvm::ConstantDataSequential *CDS =
914 dyn_cast<llvm::ConstantDataSequential>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000915 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
916 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000917
918 // If necessary, get a pointer to the element and emit it.
919 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
JF Bastiened92f602018-07-20 23:37:12 +0000920 emitStoresForInitAfterBZero(
James Y Knight751fe282019-02-09 22:22:28 +0000921 CGM, Elt, Builder.CreateConstInBoundsGEP2_32(Loc, 0, i), isVolatile,
922 Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000923 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000924 return;
925 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000926
Chris Lattnere6af8862010-12-02 01:58:41 +0000927 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
928 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000929
Chris Lattnere6af8862010-12-02 01:58:41 +0000930 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
931 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000932
933 // If necessary, get a pointer to the element and emit it.
934 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
James Y Knight751fe282019-02-09 22:22:28 +0000935 emitStoresForInitAfterBZero(CGM, Elt,
936 Builder.CreateConstInBoundsGEP2_32(Loc, 0, i),
937 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000938 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000939}
940
JF Bastiened92f602018-07-20 23:37:12 +0000941/// Decide whether we should use bzero plus some stores to initialize a local
942/// variable instead of using a memcpy from a constant global. It is beneficial
943/// to use bzero if the global is all zeros, or mostly zeros and large.
944static bool shouldUseBZeroPlusStoresToInitialize(llvm::Constant *Init,
945 uint64_t GlobalSize) {
946 // If a global is all zeros, always use a bzero.
Chris Lattnerb85025f2010-12-01 02:05:19 +0000947 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
948
Chris Lattnerb85025f2010-12-01 02:05:19 +0000949 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
950 // do it if it will require 6 or fewer scalar stores.
951 // TODO: Should budget depends on the size? Avoiding a large global warrants
952 // plopping in more stores.
953 unsigned StoreBudget = 6;
954 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000955
956 return GlobalSize > SizeLimit &&
JF Bastiened92f602018-07-20 23:37:12 +0000957 canEmitInitWithFewStoresAfterBZero(Init, StoreBudget);
Chris Lattnerb85025f2010-12-01 02:05:19 +0000958}
959
JF Bastien65089292018-07-25 04:29:03 +0000960/// Decide whether we should use memset to initialize a local variable instead
961/// of using a memcpy from a constant global. Assumes we've already decided to
962/// not user bzero.
963/// FIXME We could be more clever, as we are for bzero above, and generate
964/// memset followed by stores. It's unclear that's worth the effort.
JF Bastien2f0582f2018-09-21 13:54:09 +0000965static llvm::Value *shouldUseMemSetToInitialize(llvm::Constant *Init,
Vitaly Bukad03bd1d2019-07-10 22:53:52 +0000966 uint64_t GlobalSize,
967 const llvm::DataLayout &DL) {
JF Bastien65089292018-07-25 04:29:03 +0000968 uint64_t SizeLimit = 32;
969 if (GlobalSize <= SizeLimit)
JF Bastien2f0582f2018-09-21 13:54:09 +0000970 return nullptr;
Vitaly Bukad03bd1d2019-07-10 22:53:52 +0000971 return llvm::isBytewiseValue(Init, DL);
JF Bastien65089292018-07-25 04:29:03 +0000972}
973
JF Bastienb5e5bc72019-03-08 01:26:49 +0000974/// Decide whether we want to split a constant structure or array store into a
975/// sequence of its fields' stores. This may cost us code size and compilation
976/// speed, but plays better with store optimizations.
977static bool shouldSplitConstantStore(CodeGenModule &CGM,
978 uint64_t GlobalByteSize) {
979 // Don't break things that occupy more than one cacheline.
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +0000980 uint64_t ByteSizeLimit = 64;
981 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
982 return false;
983 if (GlobalByteSize <= ByteSizeLimit)
984 return true;
985 return false;
986}
987
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000988enum class IsPattern { No, Yes };
989
990/// Generate a constant filled with either a pattern or zeroes.
991static llvm::Constant *patternOrZeroFor(CodeGenModule &CGM, IsPattern isPattern,
992 llvm::Type *Ty) {
993 if (isPattern == IsPattern::Yes)
JF Bastienef202c32019-04-12 00:11:27 +0000994 return initializationPatternFor(CGM, Ty);
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000995 else
996 return llvm::Constant::getNullValue(Ty);
997}
998
999static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1000 llvm::Constant *constant);
1001
1002/// Helper function for constWithPadding() to deal with padding in structures.
1003static llvm::Constant *constStructWithPadding(CodeGenModule &CGM,
1004 IsPattern isPattern,
1005 llvm::StructType *STy,
1006 llvm::Constant *constant) {
1007 const llvm::DataLayout &DL = CGM.getDataLayout();
1008 const llvm::StructLayout *Layout = DL.getStructLayout(STy);
1009 llvm::Type *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext());
1010 unsigned SizeSoFar = 0;
1011 SmallVector<llvm::Constant *, 8> Values;
1012 bool NestedIntact = true;
1013 for (unsigned i = 0, e = STy->getNumElements(); i != e; i++) {
1014 unsigned CurOff = Layout->getElementOffset(i);
1015 if (SizeSoFar < CurOff) {
1016 assert(!STy->isPacked());
1017 auto *PadTy = llvm::ArrayType::get(Int8Ty, CurOff - SizeSoFar);
1018 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1019 }
1020 llvm::Constant *CurOp;
1021 if (constant->isZeroValue())
1022 CurOp = llvm::Constant::getNullValue(STy->getElementType(i));
1023 else
1024 CurOp = cast<llvm::Constant>(constant->getAggregateElement(i));
1025 auto *NewOp = constWithPadding(CGM, isPattern, CurOp);
1026 if (CurOp != NewOp)
1027 NestedIntact = false;
1028 Values.push_back(NewOp);
1029 SizeSoFar = CurOff + DL.getTypeAllocSize(CurOp->getType());
1030 }
1031 unsigned TotalSize = Layout->getSizeInBytes();
1032 if (SizeSoFar < TotalSize) {
1033 auto *PadTy = llvm::ArrayType::get(Int8Ty, TotalSize - SizeSoFar);
1034 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1035 }
1036 if (NestedIntact && Values.size() == STy->getNumElements())
1037 return constant;
Peter Collingbourne68b46732019-03-16 19:25:39 +00001038 return llvm::ConstantStruct::getAnon(Values, STy->isPacked());
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001039}
1040
1041/// Replace all padding bytes in a given constant with either a pattern byte or
1042/// 0x00.
1043static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1044 llvm::Constant *constant) {
1045 llvm::Type *OrigTy = constant->getType();
1046 if (const auto STy = dyn_cast<llvm::StructType>(OrigTy))
1047 return constStructWithPadding(CGM, isPattern, STy, constant);
1048 if (auto *STy = dyn_cast<llvm::SequentialType>(OrigTy)) {
1049 llvm::SmallVector<llvm::Constant *, 8> Values;
1050 unsigned Size = STy->getNumElements();
1051 if (!Size)
1052 return constant;
1053 llvm::Type *ElemTy = STy->getElementType();
1054 bool ZeroInitializer = constant->isZeroValue();
1055 llvm::Constant *OpValue, *PaddedOp;
1056 if (ZeroInitializer) {
1057 OpValue = llvm::Constant::getNullValue(ElemTy);
1058 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1059 }
1060 for (unsigned Op = 0; Op != Size; ++Op) {
1061 if (!ZeroInitializer) {
1062 OpValue = constant->getAggregateElement(Op);
1063 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1064 }
1065 Values.push_back(PaddedOp);
1066 }
1067 auto *NewElemTy = Values[0]->getType();
1068 if (NewElemTy == ElemTy)
1069 return constant;
1070 if (OrigTy->isArrayTy()) {
1071 auto *ArrayTy = llvm::ArrayType::get(NewElemTy, Size);
1072 return llvm::ConstantArray::get(ArrayTy, Values);
1073 } else {
1074 return llvm::ConstantVector::get(Values);
1075 }
1076 }
1077 return constant;
1078}
1079
Richard Smith24cdcad2019-06-14 17:46:37 +00001080Address CodeGenModule::createUnnamedGlobalFrom(const VarDecl &D,
1081 llvm::Constant *Constant,
1082 CharUnits Align) {
JF Bastien3a881e62018-11-15 00:19:18 +00001083 auto FunctionName = [&](const DeclContext *DC) -> std::string {
1084 if (const auto *FD = dyn_cast<FunctionDecl>(DC)) {
1085 if (const auto *CC = dyn_cast<CXXConstructorDecl>(FD))
1086 return CC->getNameAsString();
1087 if (const auto *CD = dyn_cast<CXXDestructorDecl>(FD))
1088 return CD->getNameAsString();
Richard Smith24cdcad2019-06-14 17:46:37 +00001089 return getMangledName(FD);
JF Bastien3a881e62018-11-15 00:19:18 +00001090 } else if (const auto *OM = dyn_cast<ObjCMethodDecl>(DC)) {
1091 return OM->getNameAsString();
Mikael Holmenee846762018-11-15 13:01:54 +00001092 } else if (isa<BlockDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001093 return "<block>";
Mikael Holmenee846762018-11-15 13:01:54 +00001094 } else if (isa<CapturedDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001095 return "<captured>";
1096 } else {
Richard Smith24cdcad2019-06-14 17:46:37 +00001097 llvm_unreachable("expected a function or method");
JF Bastien3a881e62018-11-15 00:19:18 +00001098 }
1099 };
1100
Richard Smith24cdcad2019-06-14 17:46:37 +00001101 // Form a simple per-variable cache of these values in case we find we
1102 // want to reuse them.
1103 llvm::GlobalVariable *&CacheEntry = InitializerConstants[&D];
1104 if (!CacheEntry || CacheEntry->getInitializer() != Constant) {
1105 auto *Ty = Constant->getType();
1106 bool isConstant = true;
1107 llvm::GlobalVariable *InsertBefore = nullptr;
1108 unsigned AS =
1109 getContext().getTargetAddressSpace(getStringLiteralAddressSpace());
1110 std::string Name;
1111 if (D.hasGlobalStorage())
1112 Name = getMangledName(&D).str() + ".const";
1113 else if (const DeclContext *DC = D.getParentFunctionOrMethod())
1114 Name = ("__const." + FunctionName(DC) + "." + D.getName()).str();
1115 else
1116 llvm_unreachable("local variable has no parent function or method");
1117 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
1118 getModule(), Ty, isConstant, llvm::GlobalValue::PrivateLinkage,
1119 Constant, Name, InsertBefore, llvm::GlobalValue::NotThreadLocal, AS);
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001120 GV->setAlignment(Align.getAsAlign());
Richard Smith24cdcad2019-06-14 17:46:37 +00001121 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1122 CacheEntry = GV;
1123 } else if (CacheEntry->getAlignment() < Align.getQuantity()) {
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001124 CacheEntry->setAlignment(Align.getAsAlign());
Richard Smith24cdcad2019-06-14 17:46:37 +00001125 }
JF Bastien3a881e62018-11-15 00:19:18 +00001126
Richard Smith24cdcad2019-06-14 17:46:37 +00001127 return Address(CacheEntry, Align);
1128}
1129
1130static Address createUnnamedGlobalForMemcpyFrom(CodeGenModule &CGM,
1131 const VarDecl &D,
1132 CGBuilderTy &Builder,
1133 llvm::Constant *Constant,
1134 CharUnits Align) {
1135 Address SrcPtr = CGM.createUnnamedGlobalFrom(D, Constant, Align);
1136 llvm::Type *BP = llvm::PointerType::getInt8PtrTy(CGM.getLLVMContext(),
1137 SrcPtr.getAddressSpace());
JF Bastien3a881e62018-11-15 00:19:18 +00001138 if (SrcPtr.getType() != BP)
1139 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
1140 return SrcPtr;
1141}
1142
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001143static void emitStoresForConstant(CodeGenModule &CGM, const VarDecl &D,
1144 Address Loc, bool isVolatile,
1145 CGBuilderTy &Builder,
1146 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001147 auto *Ty = constant->getType();
Vitaly Bukaf35a3452019-06-27 02:08:15 +00001148 uint64_t ConstantSize = CGM.getDataLayout().getTypeAllocSize(Ty);
1149 if (!ConstantSize)
1150 return;
1151
JF Bastienb5e5bc72019-03-08 01:26:49 +00001152 bool canDoSingleStore = Ty->isIntOrIntVectorTy() ||
1153 Ty->isPtrOrPtrVectorTy() || Ty->isFPOrFPVectorTy();
1154 if (canDoSingleStore) {
JF Bastien14daa202018-12-18 05:12:21 +00001155 Builder.CreateStore(constant, Loc, isVolatile);
1156 return;
1157 }
1158
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001159 auto *SizeVal = llvm::ConstantInt::get(CGM.IntPtrTy, ConstantSize);
JF Bastienb5e5bc72019-03-08 01:26:49 +00001160
1161 // If the initializer is all or mostly the same, codegen with bzero / memset
1162 // then do a few stores afterward.
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001163 if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) {
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001164 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, 0), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001165 isVolatile);
1166
1167 bool valueAlreadyCorrect =
1168 constant->isNullValue() || isa<llvm::UndefValue>(constant);
1169 if (!valueAlreadyCorrect) {
JF Bastien14daa202018-12-18 05:12:21 +00001170 Loc = Builder.CreateBitCast(Loc, Ty->getPointerTo(Loc.getAddressSpace()));
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001171 emitStoresForInitAfterBZero(CGM, constant, Loc, isVolatile, Builder);
1172 }
1173 return;
1174 }
1175
JF Bastienb5e5bc72019-03-08 01:26:49 +00001176 // If the initializer is a repeated byte pattern, use memset.
Vitaly Bukad03bd1d2019-07-10 22:53:52 +00001177 llvm::Value *Pattern =
1178 shouldUseMemSetToInitialize(constant, ConstantSize, CGM.getDataLayout());
JF Bastien2f0582f2018-09-21 13:54:09 +00001179 if (Pattern) {
1180 uint64_t Value = 0x00;
1181 if (!isa<llvm::UndefValue>(Pattern)) {
1182 const llvm::APInt &AP = cast<llvm::ConstantInt>(Pattern)->getValue();
1183 assert(AP.getBitWidth() <= 8);
1184 Value = AP.getLimitedValue();
1185 }
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001186 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, Value), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001187 isVolatile);
1188 return;
1189 }
1190
JF Bastienb5e5bc72019-03-08 01:26:49 +00001191 // If the initializer is small, use a handful of stores.
1192 if (shouldSplitConstantStore(CGM, ConstantSize)) {
1193 if (auto *STy = dyn_cast<llvm::StructType>(Ty)) {
1194 // FIXME: handle the case when STy != Loc.getElementType().
1195 if (STy == Loc.getElementType()) {
1196 for (unsigned i = 0; i != constant->getNumOperands(); i++) {
1197 Address EltPtr = Builder.CreateStructGEP(Loc, i);
1198 emitStoresForConstant(
1199 CGM, D, EltPtr, isVolatile, Builder,
1200 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1201 }
1202 return;
1203 }
1204 } else if (auto *ATy = dyn_cast<llvm::ArrayType>(Ty)) {
1205 // FIXME: handle the case when ATy != Loc.getElementType().
1206 if (ATy == Loc.getElementType()) {
1207 for (unsigned i = 0; i != ATy->getNumElements(); i++) {
1208 Address EltPtr = Builder.CreateConstArrayGEP(Loc, i);
1209 emitStoresForConstant(
1210 CGM, D, EltPtr, isVolatile, Builder,
1211 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1212 }
1213 return;
1214 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001215 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001216 }
1217
JF Bastienb5e5bc72019-03-08 01:26:49 +00001218 // Copy from a global.
Richard Smith24cdcad2019-06-14 17:46:37 +00001219 Builder.CreateMemCpy(Loc,
1220 createUnnamedGlobalForMemcpyFrom(
1221 CGM, D, Builder, constant, Loc.getAlignment()),
1222 SizeVal, isVolatile);
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001223}
1224
JF Bastien14daa202018-12-18 05:12:21 +00001225static void emitStoresForZeroInit(CodeGenModule &CGM, const VarDecl &D,
1226 Address Loc, bool isVolatile,
1227 CGBuilderTy &Builder) {
1228 llvm::Type *ElTy = Loc.getElementType();
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001229 llvm::Constant *constant =
1230 constWithPadding(CGM, IsPattern::No, llvm::Constant::getNullValue(ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001231 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1232}
1233
1234static void emitStoresForPatternInit(CodeGenModule &CGM, const VarDecl &D,
1235 Address Loc, bool isVolatile,
1236 CGBuilderTy &Builder) {
1237 llvm::Type *ElTy = Loc.getElementType();
JF Bastienef202c32019-04-12 00:11:27 +00001238 llvm::Constant *constant = constWithPadding(
1239 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001240 assert(!isa<llvm::UndefValue>(constant));
1241 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1242}
1243
1244static bool containsUndef(llvm::Constant *constant) {
1245 auto *Ty = constant->getType();
1246 if (isa<llvm::UndefValue>(constant))
1247 return true;
1248 if (Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy())
1249 for (llvm::Use &Op : constant->operands())
1250 if (containsUndef(cast<llvm::Constant>(Op)))
1251 return true;
1252 return false;
1253}
1254
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001255static llvm::Constant *replaceUndef(CodeGenModule &CGM, IsPattern isPattern,
1256 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001257 auto *Ty = constant->getType();
1258 if (isa<llvm::UndefValue>(constant))
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001259 return patternOrZeroFor(CGM, isPattern, Ty);
JF Bastien14daa202018-12-18 05:12:21 +00001260 if (!(Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()))
1261 return constant;
1262 if (!containsUndef(constant))
1263 return constant;
1264 llvm::SmallVector<llvm::Constant *, 8> Values(constant->getNumOperands());
1265 for (unsigned Op = 0, NumOp = constant->getNumOperands(); Op != NumOp; ++Op) {
1266 auto *OpValue = cast<llvm::Constant>(constant->getOperand(Op));
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001267 Values[Op] = replaceUndef(CGM, isPattern, OpValue);
JF Bastien14daa202018-12-18 05:12:21 +00001268 }
1269 if (Ty->isStructTy())
1270 return llvm::ConstantStruct::get(cast<llvm::StructType>(Ty), Values);
1271 if (Ty->isArrayTy())
1272 return llvm::ConstantArray::get(cast<llvm::ArrayType>(Ty), Values);
1273 assert(Ty->isVectorTy());
1274 return llvm::ConstantVector::get(Values);
1275}
1276
Nick Lewycky8a7d90b2010-12-30 20:21:55 +00001277/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +00001278/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +00001279/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +00001280void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
1281 AutoVarEmission emission = EmitAutoVarAlloca(D);
1282 EmitAutoVarInit(emission);
1283 EmitAutoVarCleanups(emission);
1284}
Chris Lattner03df1222007-06-02 04:53:11 +00001285
David Majnemerdc012fa2015-04-22 21:38:15 +00001286/// Emit a lifetime.begin marker if some criteria are satisfied.
1287/// \return a pointer to the temporary size Value if a marker was emitted, null
1288/// otherwise
1289llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
1290 llvm::Value *Addr) {
Vitaly Buka1c943322016-10-26 01:59:57 +00001291 if (!ShouldEmitLifetimeMarkers)
Reid Kleckner1ef49212015-04-23 18:07:13 +00001292 return nullptr;
1293
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001294 assert(Addr->getType()->getPointerAddressSpace() ==
1295 CGM.getDataLayout().getAllocaAddrSpace() &&
1296 "Pointer should be in alloca address space");
David Majnemerdc012fa2015-04-22 21:38:15 +00001297 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001298 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001299 llvm::CallInst *C =
1300 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001301 C->setDoesNotThrow();
1302 return SizeV;
1303}
1304
1305void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001306 assert(Addr->getType()->getPointerAddressSpace() ==
1307 CGM.getDataLayout().getAllocaAddrSpace() &&
1308 "Pointer should be in alloca address space");
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001309 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001310 llvm::CallInst *C =
1311 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001312 C->setDoesNotThrow();
1313}
1314
Sander de Smalen891af03a2018-02-03 13:55:59 +00001315void CodeGenFunction::EmitAndRegisterVariableArrayDimensions(
1316 CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) {
1317 // For each dimension stores its QualType and corresponding
1318 // size-expression Value.
1319 SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions;
Adrian Prantla40cce82018-11-09 19:17:56 +00001320 SmallVector<IdentifierInfo *, 4> VLAExprNames;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001321
1322 // Break down the array into individual dimensions.
1323 QualType Type1D = D.getType();
1324 while (getContext().getAsVariableArrayType(Type1D)) {
1325 auto VlaSize = getVLAElements1D(Type1D);
1326 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1327 Dimensions.emplace_back(C, Type1D.getUnqualifiedType());
1328 else {
Adrian Prantla40cce82018-11-09 19:17:56 +00001329 // Generate a locally unique name for the size expression.
1330 Twine Name = Twine("__vla_expr") + Twine(VLAExprCounter++);
1331 SmallString<12> Buffer;
1332 StringRef NameRef = Name.toStringRef(Buffer);
1333 auto &Ident = getContext().Idents.getOwn(NameRef);
1334 VLAExprNames.push_back(&Ident);
1335 auto SizeExprAddr =
1336 CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), NameRef);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001337 Builder.CreateStore(VlaSize.NumElts, SizeExprAddr);
1338 Dimensions.emplace_back(SizeExprAddr.getPointer(),
1339 Type1D.getUnqualifiedType());
1340 }
1341 Type1D = VlaSize.Type;
1342 }
1343
1344 if (!EmitDebugInfo)
1345 return;
1346
1347 // Register each dimension's size-expression with a DILocalVariable,
1348 // so that it can be used by CGDebugInfo when instantiating a DISubrange
1349 // to describe this array.
Adrian Prantla40cce82018-11-09 19:17:56 +00001350 unsigned NameIdx = 0;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001351 for (auto &VlaSize : Dimensions) {
1352 llvm::Metadata *MD;
1353 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1354 MD = llvm::ConstantAsMetadata::get(C);
1355 else {
1356 // Create an artificial VarDecl to generate debug info for.
Adrian Prantla40cce82018-11-09 19:17:56 +00001357 IdentifierInfo *NameIdent = VLAExprNames[NameIdx++];
Sander de Smalen891af03a2018-02-03 13:55:59 +00001358 auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType();
1359 auto QT = getContext().getIntTypeForBitwidth(
1360 VlaExprTy->getScalarSizeInBits(), false);
1361 auto *ArtificialDecl = VarDecl::Create(
1362 getContext(), const_cast<DeclContext *>(D.getDeclContext()),
Adrian Prantla40cce82018-11-09 19:17:56 +00001363 D.getLocation(), D.getLocation(), NameIdent, QT,
Sander de Smalen891af03a2018-02-03 13:55:59 +00001364 getContext().CreateTypeSourceInfo(QT), SC_Auto);
Sander de Smalen9084a3b2018-02-13 07:49:34 +00001365 ArtificialDecl->setImplicit();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001366
1367 MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts,
1368 Builder);
1369 }
1370 assert(MD && "No Size expression debug node created");
1371 DI->registerVLASizeExpression(VlaSize.Type, MD);
1372 }
1373}
1374
John McCallc533cb72011-02-22 06:44:22 +00001375/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001376/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +00001377CodeGenFunction::AutoVarEmission
1378CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
1379 QualType Ty = D.getType();
Yaxun Liub7318e02017-10-13 03:37:48 +00001380 assert(
1381 Ty.getAddressSpace() == LangAS::Default ||
1382 (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL));
John McCallc533cb72011-02-22 06:44:22 +00001383
1384 AutoVarEmission emission(D);
1385
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001386 bool isEscapingByRef = D.isEscapingByref();
1387 emission.IsEscapingByRef = isEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00001388
1389 CharUnits alignment = getContext().getDeclAlign(&D);
John McCallc533cb72011-02-22 06:44:22 +00001390
John McCall23c29fe2011-06-24 21:55:10 +00001391 // If the type is variably-modified, emit all the VLA sizes for it.
1392 if (Ty->isVariablyModifiedType())
1393 EmitVariablyModifiedType(Ty);
1394
Sander de Smalen891af03a2018-02-03 13:55:59 +00001395 auto *DI = getDebugInfo();
1396 bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >=
1397 codegenoptions::LimitedDebugInfo;
1398
John McCall7f416cc2015-09-08 08:05:57 +00001399 Address address = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001400 Address AllocaAddr = Address::invalid();
Alexey Bataev9c397812019-04-03 17:57:06 +00001401 Address OpenMPLocalAddr =
1402 getLangOpts().OpenMP
1403 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
1404 : Address::invalid();
Amy Huang7fac5c82019-06-20 17:15:21 +00001405 bool NRVO = getLangOpts().ElideConstructors && D.isNRVOVariable();
1406
Alexey Bataev9c397812019-04-03 17:57:06 +00001407 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
1408 address = OpenMPLocalAddr;
1409 } else if (Ty->isConstantSizeType()) {
Richard Smith2bcde3a2013-06-02 00:09:52 +00001410 // If this value is an array or struct with a statically determinable
1411 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +00001412 //
1413 // TODO: We should constant-evaluate the initializer of any variable,
1414 // as long as it is initialized by a constant expression. Currently,
1415 // isConstantInitializer produces wrong answers for structs with
1416 // reference or bitfield members, and a few other cases, and checking
1417 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +00001418 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
1419 (D.isConstexpr() ||
1420 ((Ty.isPODType(getContext()) ||
1421 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
1422 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +00001423
Rafael Espindola609f5d92013-03-26 18:41:47 +00001424 // If the variable's a const type, and it's neither an NRVO
1425 // candidate nor a __block variable and has no mutable members,
1426 // emit it as a global instead.
Anastasia Stulovae4a1c382016-11-29 17:01:19 +00001427 // Exception is if a variable is located in non-constant address space
1428 // in OpenCL.
1429 if ((!getLangOpts().OpenCL ||
1430 Ty.getAddressSpace() == LangAS::opencl_constant) &&
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001431 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO &&
1432 !isEscapingByRef && CGM.isTypeConstant(Ty, true))) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001433 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +00001434
John McCall7f416cc2015-09-08 08:05:57 +00001435 // Signal this condition to later callbacks.
1436 emission.Addr = Address::invalid();
Rafael Espindola609f5d92013-03-26 18:41:47 +00001437 assert(emission.wasEmittedAsGlobal());
1438 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +00001439 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001440
Rafael Espindola609f5d92013-03-26 18:41:47 +00001441 // Otherwise, tell the initialization code that we're in this case.
1442 emission.IsConstantAggregate = true;
1443 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001444
Rafael Espindola609f5d92013-03-26 18:41:47 +00001445 // A normal fixed sized variable becomes an alloca in the entry block,
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001446 // unless:
1447 // - it's an NRVO variable.
1448 // - we are compiling OpenMP and it's an OpenMP local variable.
Alexey Bataev9c397812019-04-03 17:57:06 +00001449 if (NRVO) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001450 // The named return value optimization: allocate this variable in the
1451 // return slot, so that we can elide the copy when returning this
1452 // variable (C++0x [class.copy]p34).
John McCall7f416cc2015-09-08 08:05:57 +00001453 address = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +00001454
Rafael Espindola609f5d92013-03-26 18:41:47 +00001455 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001456 const auto *RD = RecordTy->getDecl();
1457 const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1458 if ((CXXRD && !CXXRD->hasTrivialDestructor()) ||
1459 RD->isNonTrivialToPrimitiveDestroy()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001460 // Create a flag that is used to indicate when the NRVO was applied
1461 // to this variable. Set it to zero to indicate that NRVO was not
1462 // applied.
1463 llvm::Value *Zero = Builder.getFalse();
John McCall7f416cc2015-09-08 08:05:57 +00001464 Address NRVOFlag =
1465 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
Rafael Espindola609f5d92013-03-26 18:41:47 +00001466 EnsureInsertPoint();
1467 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +00001468
Rafael Espindola609f5d92013-03-26 18:41:47 +00001469 // Record the NRVO flag for this variable.
John McCall7f416cc2015-09-08 08:05:57 +00001470 NRVOFlags[&D] = NRVOFlag.getPointer();
1471 emission.NRVOFlag = NRVOFlag.getPointer();
Nadav Rotem1da30942013-03-23 06:43:35 +00001472 }
Douglas Gregor290c93e2010-05-15 06:46:45 +00001473 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001474 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001475 CharUnits allocaAlignment;
1476 llvm::Type *allocaTy;
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001477 if (isEscapingByRef) {
John McCall7f416cc2015-09-08 08:05:57 +00001478 auto &byrefInfo = getBlockByrefInfo(&D);
1479 allocaTy = byrefInfo.Type;
1480 allocaAlignment = byrefInfo.ByrefAlignment;
1481 } else {
1482 allocaTy = ConvertTypeForMem(Ty);
1483 allocaAlignment = alignment;
1484 }
Rafael Espindola609f5d92013-03-26 18:41:47 +00001485
John McCall999110f2015-09-08 09:18:30 +00001486 // Create the alloca. Note that we set the name separately from
1487 // building the instruction so that it's there even in no-asserts
1488 // builds.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001489 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName(),
1490 /*ArraySize=*/nullptr, &AllocaAddr);
Rafael Espindola609f5d92013-03-26 18:41:47 +00001491
Reid Kleckner1f88e932015-10-07 21:03:41 +00001492 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1493 // the catch parameter starts in the catchpad instruction, and we can't
1494 // insert code in those basic blocks.
1495 bool IsMSCatchParam =
1496 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1497
Vitaly Buka64c80b42016-10-26 05:42:30 +00001498 // Emit a lifetime intrinsic if meaningful. There's no point in doing this
1499 // if we don't have a valid insertion point (?).
Reid Kleckner1f88e932015-10-07 21:03:41 +00001500 if (HaveInsertPoint() && !IsMSCatchParam) {
Akira Hatanakafdcd18b2017-01-25 22:55:13 +00001501 // If there's a jump into the lifetime of this variable, its lifetime
1502 // gets broken up into several regions in IR, which requires more work
1503 // to handle correctly. For now, just omit the intrinsics; this is a
1504 // rare case, and it's better to just be conservatively correct.
1505 // PR28267.
1506 //
1507 // We have to do this in all language modes if there's a jump past the
1508 // declaration. We also have to do it in C if there's a jump to an
1509 // earlier point in the current block because non-VLA lifetimes begin as
1510 // soon as the containing block is entered, not when its variables
1511 // actually come into scope; suppressing the lifetime annotations
1512 // completely in this case is unnecessarily pessimistic, but again, this
1513 // is rare.
1514 if (!Bypasses.IsBypassed(&D) &&
1515 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) {
Vitaly Buka64c80b42016-10-26 05:42:30 +00001516 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1517 emission.SizeForLifetimeMarkers =
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001518 EmitLifetimeStart(size, AllocaAddr.getPointer());
Vitaly Buka64c80b42016-10-26 05:42:30 +00001519 }
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001520 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001521 assert(!emission.useLifetimeMarkers());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001522 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001523 }
Chris Lattner03df1222007-06-02 04:53:11 +00001524 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001525 EnsureInsertPoint();
1526
Anders Carlsson15949b32009-02-09 20:41:50 +00001527 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +00001528 // Save the stack.
John McCall7f416cc2015-09-08 08:05:57 +00001529 Address Stack =
1530 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +00001531
James Y Knight8799cae2019-02-03 21:53:49 +00001532 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie4ba525b2015-07-14 17:27:39 +00001533 llvm::Value *V = Builder.CreateCall(F);
Anders Carlsson30032882008-12-12 07:38:43 +00001534 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +00001535
1536 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +00001537
John McCalla464ff92010-07-21 06:13:08 +00001538 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +00001539 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001540 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +00001541 }
Mike Stump11289f42009-09-09 15:08:12 +00001542
Sander de Smalen891af03a2018-02-03 13:55:59 +00001543 auto VlaSize = getVLASize(Ty);
1544 llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type);
Anders Carlsson30032882008-12-12 07:38:43 +00001545
1546 // Allocate memory for the array.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001547 address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts,
1548 &AllocaAddr);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001549
1550 // If we have debug info enabled, properly describe the VLA dimensions for
1551 // this type by registering the vla size expression for each of the
1552 // dimensions.
1553 EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo);
Chris Lattner03df1222007-06-02 04:53:11 +00001554 }
Eli Friedmanf4084702008-12-20 23:11:59 +00001555
John McCall7f416cc2015-09-08 08:05:57 +00001556 setAddrOfLocalVar(&D, address);
1557 emission.Addr = address;
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001558 emission.AllocaAddr = AllocaAddr;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001559
1560 // Emit debug info for local var declaration.
Sander de Smalen891af03a2018-02-03 13:55:59 +00001561 if (EmitDebugInfo && HaveInsertPoint()) {
Amy Huang7fac5c82019-06-20 17:15:21 +00001562 Address DebugAddr = address;
1563 bool UsePointerValue = NRVO && ReturnValuePointer.isValid();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001564 DI->setLocation(D.getLocation());
Amy Huang7fac5c82019-06-20 17:15:21 +00001565
1566 // If NRVO, use a pointer to the return address.
1567 if (UsePointerValue)
1568 DebugAddr = ReturnValuePointer;
1569
1570 (void)DI->EmitDeclareOfAutoVariable(&D, DebugAddr.getPointer(), Builder,
1571 UsePointerValue);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001572 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001573
Volodymyr Sapsai93317d82019-03-01 02:15:39 +00001574 if (D.hasAttr<AnnotateAttr>() && HaveInsertPoint())
John McCall7f416cc2015-09-08 08:05:57 +00001575 EmitVarAnnotations(&D, address.getPointer());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001576
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001577 // Make sure we call @llvm.lifetime.end.
1578 if (emission.useLifetimeMarkers())
1579 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker,
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001580 emission.getOriginalAllocatedAddress(),
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001581 emission.getSizeForLifetimeMarkers());
1582
John McCallc533cb72011-02-22 06:44:22 +00001583 return emission;
1584}
1585
JF Bastien6b239722018-05-19 04:21:26 +00001586static bool isCapturedBy(const VarDecl &, const Expr *);
1587
1588/// Determines whether the given __block variable is potentially
1589/// captured by the given statement.
1590static bool isCapturedBy(const VarDecl &Var, const Stmt *S) {
1591 if (const Expr *E = dyn_cast<Expr>(S))
1592 return isCapturedBy(Var, E);
1593 for (const Stmt *SubStmt : S->children())
1594 if (isCapturedBy(Var, SubStmt))
1595 return true;
1596 return false;
1597}
1598
John McCallc533cb72011-02-22 06:44:22 +00001599/// Determines whether the given __block variable is potentially
1600/// captured by the given expression.
JF Bastien6b239722018-05-19 04:21:26 +00001601static bool isCapturedBy(const VarDecl &Var, const Expr *E) {
John McCallc533cb72011-02-22 06:44:22 +00001602 // Skip the most common kinds of expressions that make
1603 // hierarchy-walking expensive.
JF Bastien6b239722018-05-19 04:21:26 +00001604 E = E->IgnoreParenCasts();
John McCallc533cb72011-02-22 06:44:22 +00001605
JF Bastien6b239722018-05-19 04:21:26 +00001606 if (const BlockExpr *BE = dyn_cast<BlockExpr>(E)) {
1607 const BlockDecl *Block = BE->getBlockDecl();
1608 for (const auto &I : Block->captures()) {
1609 if (I.getVariable() == &Var)
John McCallc533cb72011-02-22 06:44:22 +00001610 return true;
1611 }
1612
1613 // No need to walk into the subexpressions.
1614 return false;
1615 }
1616
JF Bastien6b239722018-05-19 04:21:26 +00001617 if (const StmtExpr *SE = dyn_cast<StmtExpr>(E)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001618 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001619 for (const auto *BI : CS->body())
JF Bastien6b239722018-05-19 04:21:26 +00001620 if (const auto *BIE = dyn_cast<Expr>(BI)) {
1621 if (isCapturedBy(Var, BIE))
1622 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001623 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001624 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001625 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001626 for (const auto *I : DS->decls()) {
1627 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1628 const Expr *Init = VD->getInit();
JF Bastien6b239722018-05-19 04:21:26 +00001629 if (Init && isCapturedBy(Var, Init))
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001630 return true;
1631 }
1632 }
1633 }
1634 else
1635 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1636 // Later, provide code to poke into statements for capture analysis.
1637 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001638 return false;
1639 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001640
JF Bastien6b239722018-05-19 04:21:26 +00001641 for (const Stmt *SubStmt : E->children())
1642 if (isCapturedBy(Var, SubStmt))
John McCallc533cb72011-02-22 06:44:22 +00001643 return true;
1644
1645 return false;
1646}
1647
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001648/// Determine whether the given initializer is trivial in the sense
Douglas Gregor82e1af22011-07-01 21:08:19 +00001649/// that it requires no code to be generated.
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001650bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
Douglas Gregor82e1af22011-07-01 21:08:19 +00001651 if (!Init)
1652 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001653
Douglas Gregor82e1af22011-07-01 21:08:19 +00001654 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1655 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1656 if (Constructor->isTrivial() &&
1657 Constructor->isDefaultConstructor() &&
1658 !Construct->requiresZeroInitialization())
1659 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001660
Douglas Gregor82e1af22011-07-01 21:08:19 +00001661 return false;
1662}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001663
Vitaly Bukae7267662019-07-10 22:53:50 +00001664void CodeGenFunction::emitZeroOrPatternForAutoVarInit(QualType type,
1665 const VarDecl &D,
1666 Address Loc) {
1667 auto trivialAutoVarInit = getContext().getLangOpts().getTrivialAutoVarInit();
1668 CharUnits Size = getContext().getTypeSizeInChars(type);
1669 bool isVolatile = type.isVolatileQualified();
1670 if (!Size.isZero()) {
1671 switch (trivialAutoVarInit) {
1672 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1673 llvm_unreachable("Uninitialized handled by caller");
1674 case LangOptions::TrivialAutoVarInitKind::Zero:
1675 emitStoresForZeroInit(CGM, D, Loc, isVolatile, Builder);
1676 break;
1677 case LangOptions::TrivialAutoVarInitKind::Pattern:
1678 emitStoresForPatternInit(CGM, D, Loc, isVolatile, Builder);
1679 break;
1680 }
1681 return;
1682 }
1683
1684 // VLAs look zero-sized to getTypeInfo. We can't emit constant stores to
1685 // them, so emit a memcpy with the VLA size to initialize each element.
1686 // Technically zero-sized or negative-sized VLAs are undefined, and UBSan
1687 // will catch that code, but there exists code which generates zero-sized
1688 // VLAs. Be nice and initialize whatever they requested.
1689 const auto *VlaType = getContext().getAsVariableArrayType(type);
1690 if (!VlaType)
1691 return;
1692 auto VlaSize = getVLASize(VlaType);
1693 auto SizeVal = VlaSize.NumElts;
1694 CharUnits EltSize = getContext().getTypeSizeInChars(VlaSize.Type);
1695 switch (trivialAutoVarInit) {
1696 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1697 llvm_unreachable("Uninitialized handled by caller");
1698
1699 case LangOptions::TrivialAutoVarInitKind::Zero:
1700 if (!EltSize.isOne())
1701 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1702 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1703 isVolatile);
1704 break;
1705
1706 case LangOptions::TrivialAutoVarInitKind::Pattern: {
1707 llvm::Type *ElTy = Loc.getElementType();
1708 llvm::Constant *Constant = constWithPadding(
1709 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
1710 CharUnits ConstantAlign = getContext().getTypeAlignInChars(VlaSize.Type);
1711 llvm::BasicBlock *SetupBB = createBasicBlock("vla-setup.loop");
1712 llvm::BasicBlock *LoopBB = createBasicBlock("vla-init.loop");
1713 llvm::BasicBlock *ContBB = createBasicBlock("vla-init.cont");
1714 llvm::Value *IsZeroSizedVLA = Builder.CreateICmpEQ(
1715 SizeVal, llvm::ConstantInt::get(SizeVal->getType(), 0),
1716 "vla.iszerosized");
1717 Builder.CreateCondBr(IsZeroSizedVLA, ContBB, SetupBB);
1718 EmitBlock(SetupBB);
1719 if (!EltSize.isOne())
1720 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1721 llvm::Value *BaseSizeInChars =
1722 llvm::ConstantInt::get(IntPtrTy, EltSize.getQuantity());
1723 Address Begin = Builder.CreateElementBitCast(Loc, Int8Ty, "vla.begin");
1724 llvm::Value *End =
1725 Builder.CreateInBoundsGEP(Begin.getPointer(), SizeVal, "vla.end");
1726 llvm::BasicBlock *OriginBB = Builder.GetInsertBlock();
1727 EmitBlock(LoopBB);
1728 llvm::PHINode *Cur = Builder.CreatePHI(Begin.getType(), 2, "vla.cur");
1729 Cur->addIncoming(Begin.getPointer(), OriginBB);
1730 CharUnits CurAlign = Loc.getAlignment().alignmentOfArrayElement(EltSize);
1731 Builder.CreateMemCpy(Address(Cur, CurAlign),
1732 createUnnamedGlobalForMemcpyFrom(
1733 CGM, D, Builder, Constant, ConstantAlign),
1734 BaseSizeInChars, isVolatile);
1735 llvm::Value *Next =
1736 Builder.CreateInBoundsGEP(Int8Ty, Cur, BaseSizeInChars, "vla.next");
1737 llvm::Value *Done = Builder.CreateICmpEQ(Next, End, "vla-init.isdone");
1738 Builder.CreateCondBr(Done, ContBB, LoopBB);
1739 Cur->addIncoming(Next, LoopBB);
1740 EmitBlock(ContBB);
1741 } break;
1742 }
1743}
1744
John McCallc533cb72011-02-22 06:44:22 +00001745void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001746 assert(emission.Variable && "emission was not valid!");
1747
John McCallc533cb72011-02-22 06:44:22 +00001748 // If this was emitted as a global constant, we're done.
1749 if (emission.wasEmittedAsGlobal()) return;
1750
John McCall9e2e22f2011-02-22 07:16:58 +00001751 const VarDecl &D = *emission.Variable;
Adrian Prantl95b24e92015-02-03 20:00:54 +00001752 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
John McCallc533cb72011-02-22 06:44:22 +00001753 QualType type = D.getType();
1754
Chris Lattner07eb7332007-07-12 00:39:48 +00001755 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001756 const Expr *Init = D.getInit();
1757
1758 // If we are at an unreachable point, we don't need to emit the initializer
1759 // unless it contains a label.
1760 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001761 if (!Init || !ContainsLabel(Init)) return;
1762 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001763 }
1764
John McCall73064872011-03-31 01:59:53 +00001765 // Initialize the structure of a __block variable.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001766 if (emission.IsEscapingByRef)
John McCall73064872011-03-31 01:59:53 +00001767 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001768
Akira Hatanaka7275da02018-02-28 07:15:55 +00001769 // Initialize the variable here if it doesn't have a initializer and it is a
1770 // C struct that is non-trivial to initialize or an array containing such a
1771 // struct.
1772 if (!Init &&
1773 type.isNonTrivialToPrimitiveDefaultInitialize() ==
1774 QualType::PDIK_Struct) {
1775 LValue Dst = MakeAddrLValue(emission.getAllocatedAddress(), type);
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001776 if (emission.IsEscapingByRef)
Akira Hatanaka7275da02018-02-28 07:15:55 +00001777 drillIntoBlockVariable(*this, Dst, &D);
1778 defaultInitNonTrivialCStructVar(Dst);
1779 return;
1780 }
1781
John McCallc533cb72011-02-22 06:44:22 +00001782 // Check whether this is a byref variable that's potentially
1783 // captured and moved by its own initializer. If so, we'll need to
1784 // emit the initializer first, then copy into the variable.
JF Bastien14daa202018-12-18 05:12:21 +00001785 bool capturedByInit =
1786 Init && emission.IsEscapingByRef && isCapturedBy(D, Init);
John McCallc533cb72011-02-22 06:44:22 +00001787
JF Bastien0bae08a2019-02-15 17:26:29 +00001788 bool locIsByrefHeader = !capturedByInit;
1789 const Address Loc =
1790 locIsByrefHeader ? emission.getObjectAddress(*this) : emission.Addr;
JF Bastien14daa202018-12-18 05:12:21 +00001791
1792 // Note: constexpr already initializes everything correctly.
1793 LangOptions::TrivialAutoVarInitKind trivialAutoVarInit =
1794 (D.isConstexpr()
1795 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1796 : (D.getAttr<UninitializedAttr>()
1797 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1798 : getContext().getLangOpts().getTrivialAutoVarInit()));
1799
JF Bastienb347e752019-02-08 01:29:17 +00001800 auto initializeWhatIsTechnicallyUninitialized = [&](Address Loc) {
JF Bastien14daa202018-12-18 05:12:21 +00001801 if (trivialAutoVarInit ==
1802 LangOptions::TrivialAutoVarInitKind::Uninitialized)
1803 return;
1804
JF Bastienb347e752019-02-08 01:29:17 +00001805 // Only initialize a __block's storage: we always initialize the header.
JF Bastien0bae08a2019-02-15 17:26:29 +00001806 if (emission.IsEscapingByRef && !locIsByrefHeader)
JF Bastienb347e752019-02-08 01:29:17 +00001807 Loc = emitBlockByrefAddress(Loc, &D, /*follow=*/false);
1808
Vitaly Bukae7267662019-07-10 22:53:50 +00001809 return emitZeroOrPatternForAutoVarInit(type, D, Loc);
JF Bastien14daa202018-12-18 05:12:21 +00001810 };
1811
Vitaly Bukae7267662019-07-10 22:53:50 +00001812 if (isTrivialInitializer(Init))
1813 return initializeWhatIsTechnicallyUninitialized(Loc);
John McCallc533cb72011-02-22 06:44:22 +00001814
Craig Topper8a13c412014-05-21 05:09:00 +00001815 llvm::Constant *constant = nullptr;
Richard Smith715f7a12019-06-11 17:50:32 +00001816 if (emission.IsConstantAggregate ||
1817 D.mightBeUsableInConstantExpressions(getContext())) {
Richard Smithfddd3842011-12-30 21:15:51 +00001818 assert(!capturedByInit && "constant init contains a capturing block?");
John McCallde0fe072017-08-15 21:42:52 +00001819 constant = ConstantEmitter(*this).tryEmitAbstractForInitializer(D);
JF Bastiend39fbc72019-04-30 22:56:53 +00001820 if (constant && !constant->isZeroValue() &&
1821 (trivialAutoVarInit !=
1822 LangOptions::TrivialAutoVarInitKind::Uninitialized)) {
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001823 IsPattern isPattern =
1824 (trivialAutoVarInit == LangOptions::TrivialAutoVarInitKind::Pattern)
1825 ? IsPattern::Yes
1826 : IsPattern::No;
JF Bastiend39fbc72019-04-30 22:56:53 +00001827 // C guarantees that brace-init with fewer initializers than members in
1828 // the aggregate will initialize the rest of the aggregate as-if it were
1829 // static initialization. In turn static initialization guarantees that
1830 // padding is initialized to zero bits. We could instead pattern-init if D
1831 // has any ImplicitValueInitExpr, but that seems to be unintuitive
1832 // behavior.
1833 constant = constWithPadding(CGM, IsPattern::No,
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001834 replaceUndef(CGM, isPattern, constant));
1835 }
Richard Smithfddd3842011-12-30 21:15:51 +00001836 }
1837
1838 if (!constant) {
JF Bastienb347e752019-02-08 01:29:17 +00001839 initializeWhatIsTechnicallyUninitialized(Loc);
John McCall7f416cc2015-09-08 08:05:57 +00001840 LValue lv = MakeAddrLValue(Loc, type);
John McCall1553b192011-06-16 04:16:24 +00001841 lv.setNonGC(true);
David Blaikie66e41972015-01-14 07:38:27 +00001842 return EmitExprAsInit(Init, &D, lv, capturedByInit);
John McCall1553b192011-06-16 04:16:24 +00001843 }
John McCall91ca10f2011-03-08 09:11:50 +00001844
Richard Smith2bcde3a2013-06-02 00:09:52 +00001845 if (!emission.IsConstantAggregate) {
1846 // For simple scalar/complex initialization, store the value directly.
John McCall7f416cc2015-09-08 08:05:57 +00001847 LValue lv = MakeAddrLValue(Loc, type);
Richard Smith2bcde3a2013-06-02 00:09:52 +00001848 lv.setNonGC(true);
1849 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1850 }
1851
Yaxun Liudaceb1e2018-05-14 19:20:12 +00001852 llvm::Type *BP = CGM.Int8Ty->getPointerTo(Loc.getAddressSpace());
JF Bastien0bae08a2019-02-15 17:26:29 +00001853 emitStoresForConstant(
1854 CGM, D, (Loc.getType() == BP) ? Loc : Builder.CreateBitCast(Loc, BP),
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001855 type.isVolatileQualified(), Builder, constant);
John McCall91ca10f2011-03-08 09:11:50 +00001856}
1857
Richard Smithe78fac52018-04-05 20:52:58 +00001858/// Emit an expression as an initializer for an object (variable, field, etc.)
1859/// at the given location. The expression is not necessarily the normal
1860/// initializer for the object, and the address is not necessarily
John McCall91ca10f2011-03-08 09:11:50 +00001861/// its normal location.
1862///
1863/// \param init the initializing expression
Richard Smithe78fac52018-04-05 20:52:58 +00001864/// \param D the object to act as if we're initializing
John McCall91ca10f2011-03-08 09:11:50 +00001865/// \param loc the address to initialize; its type is a pointer
Richard Smithe78fac52018-04-05 20:52:58 +00001866/// to the LLVM mapping of the object's type
John McCall91ca10f2011-03-08 09:11:50 +00001867/// \param alignment the alignment of the address
Richard Smithe78fac52018-04-05 20:52:58 +00001868/// \param capturedByInit true if \p D is a __block variable
John McCall91ca10f2011-03-08 09:11:50 +00001869/// whose address is potentially changed by the initializer
David Blaikie73ca5692014-12-09 00:32:22 +00001870void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +00001871 LValue lvalue, bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001872 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001873
1874 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001875 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001876 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001877 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001878 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001879 return;
1880 }
1881 switch (getEvaluationKind(type)) {
1882 case TEK_Scalar:
David Blaikie66e41972015-01-14 07:38:27 +00001883 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001884 return;
1885 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001886 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001887 if (capturedByInit)
1888 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001889 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
John McCall47fb9502013-03-07 21:37:08 +00001890 return;
1891 }
1892 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001893 if (type->isAtomicType()) {
1894 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1895 } else {
Richard Smithe78fac52018-04-05 20:52:58 +00001896 AggValueSlot::Overlap_t Overlap = AggValueSlot::MayOverlap;
1897 if (isa<VarDecl>(D))
1898 Overlap = AggValueSlot::DoesNotOverlap;
1899 else if (auto *FD = dyn_cast<FieldDecl>(D))
Richard Smith8cca3a52019-06-20 20:56:20 +00001900 Overlap = getOverlapForFieldInit(FD);
John McCalla8ec7eb2013-03-07 21:37:17 +00001901 // TODO: how can we delay here if D is captured by its initializer?
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001902 EmitAggExpr(init, AggValueSlot::forLValue(
1903 lvalue, *this, AggValueSlot::IsDestructed,
1904 AggValueSlot::DoesNotNeedGCBarriers,
1905 AggValueSlot::IsNotAliased, Overlap));
John McCalla8ec7eb2013-03-07 21:37:17 +00001906 }
John McCall47fb9502013-03-07 21:37:08 +00001907 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001908 }
John McCall47fb9502013-03-07 21:37:08 +00001909 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001910}
John McCallbd309292010-07-06 01:34:17 +00001911
John McCall82fe67b2011-07-09 01:37:26 +00001912/// Enter a destroy cleanup for the given local variable.
1913void CodeGenFunction::emitAutoVarTypeCleanup(
1914 const CodeGenFunction::AutoVarEmission &emission,
1915 QualType::DestructionKind dtorKind) {
1916 assert(dtorKind != QualType::DK_none);
1917
1918 // Note that for __block variables, we want to destroy the
1919 // original stack object, not the possibly forwarded object.
John McCall7f416cc2015-09-08 08:05:57 +00001920 Address addr = emission.getObjectAddress(*this);
John McCall82fe67b2011-07-09 01:37:26 +00001921
1922 const VarDecl *var = emission.Variable;
1923 QualType type = var->getType();
1924
1925 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001926 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001927
1928 switch (dtorKind) {
1929 case QualType::DK_none:
1930 llvm_unreachable("no cleanup for trivially-destructible variable");
1931
1932 case QualType::DK_cxx_destructor:
1933 // If there's an NRVO flag on the emission, we need a different
1934 // cleanup.
1935 if (emission.NRVOFlag) {
1936 assert(!type->isArrayType());
1937 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
Marco Antognini88559632019-07-22 09:39:13 +00001938 EHStack.pushCleanup<DestroyNRVOVariableCXX>(cleanupKind, addr, type, dtor,
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001939 emission.NRVOFlag);
John McCall82fe67b2011-07-09 01:37:26 +00001940 return;
1941 }
1942 break;
1943
1944 case QualType::DK_objc_strong_lifetime:
1945 // Suppress cleanups for pseudo-strong variables.
1946 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001947
John McCall82fe67b2011-07-09 01:37:26 +00001948 // Otherwise, consider whether to use an EH cleanup or not.
1949 cleanupKind = getARCCleanupKind();
1950
1951 // Use the imprecise destroyer by default.
1952 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1953 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1954 break;
1955
1956 case QualType::DK_objc_weak_lifetime:
1957 break;
Akira Hatanaka7275da02018-02-28 07:15:55 +00001958
1959 case QualType::DK_nontrivial_c_struct:
1960 destroyer = CodeGenFunction::destroyNonTrivialCStruct;
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001961 if (emission.NRVOFlag) {
1962 assert(!type->isArrayType());
1963 EHStack.pushCleanup<DestroyNRVOVariableC>(cleanupKind, addr,
1964 emission.NRVOFlag, type);
1965 return;
1966 }
Akira Hatanaka7275da02018-02-28 07:15:55 +00001967 break;
John McCall82fe67b2011-07-09 01:37:26 +00001968 }
1969
1970 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001971 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001972
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001973 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001974 // is being pushed as an EH cleanup.
1975 bool useEHCleanup = (cleanupKind & EHCleanup);
1976 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1977 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001978}
1979
John McCallc533cb72011-02-22 06:44:22 +00001980void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001981 assert(emission.Variable && "emission was not valid!");
1982
John McCallc533cb72011-02-22 06:44:22 +00001983 // If this was emitted as a global constant, we're done.
1984 if (emission.wasEmittedAsGlobal()) return;
1985
John McCall8c38d352012-04-13 18:44:05 +00001986 // If we don't have an insertion point, we're done. Sema prevents
1987 // us from jumping into any of these scopes anyway.
1988 if (!HaveInsertPoint()) return;
1989
John McCall9e2e22f2011-02-22 07:16:58 +00001990 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001991
John McCall82fe67b2011-07-09 01:37:26 +00001992 // Check the type for a cleanup.
Richard Smith2b4fa532019-09-29 05:08:46 +00001993 if (QualType::DestructionKind dtorKind = D.needsDestruction(getContext()))
John McCall82fe67b2011-07-09 01:37:26 +00001994 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001995
John McCall1bd25562011-06-24 23:21:27 +00001996 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001997 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001998 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1999 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
2000 }
2001
John McCallc533cb72011-02-22 06:44:22 +00002002 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00002003 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002004 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00002005
John McCallc533cb72011-02-22 06:44:22 +00002006 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002007 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00002008
John McCalla729c622012-02-17 03:33:10 +00002009 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00002010 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002011 }
Mike Stump626aecc2009-03-05 01:23:13 +00002012
John McCallc533cb72011-02-22 06:44:22 +00002013 // If this is a block variable, call _Block_object_destroy
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002014 // (on the unforwarded address). Don't enter this cleanup if we're in pure-GC
2015 // mode.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002016 if (emission.IsEscapingByRef &&
2017 CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002018 BlockFieldFlags Flags = BLOCK_FIELD_IS_BYREF;
2019 if (emission.Variable->getType().isObjCGCWeak())
2020 Flags |= BLOCK_FIELD_IS_WEAK;
2021 enterByrefCleanup(NormalAndEHCleanup, emission.Addr, Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00002022 /*LoadBlockVarAddr*/ false,
2023 cxxDestructorCanThrow(emission.Variable->getType()));
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002024 }
Chris Lattner03df1222007-06-02 04:53:11 +00002025}
Chris Lattner53621a52007-06-13 20:44:40 +00002026
Peter Collingbourne1425b452012-01-26 03:33:36 +00002027CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00002028CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
2029 switch (kind) {
2030 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00002031 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002032 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00002033 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002034 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00002035 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002036 return destroyARCWeak;
Akira Hatanaka7275da02018-02-28 07:15:55 +00002037 case QualType::DK_nontrivial_c_struct:
2038 return destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00002039 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00002040 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00002041}
2042
John McCall12cc42a2013-02-01 05:11:40 +00002043/// pushEHDestroy - Push the standard destructor for the given type as
2044/// an EH-only cleanup.
2045void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002046 Address addr, QualType type) {
John McCall12cc42a2013-02-01 05:11:40 +00002047 assert(dtorKind && "cannot push destructor for trivial type");
2048 assert(needsEHCleanup(dtorKind));
2049
2050 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
2051}
2052
2053/// pushDestroy - Push the standard destructor for the given type as
2054/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00002055void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002056 Address addr, QualType type) {
John McCall4bd0fb12011-07-12 16:41:08 +00002057 assert(dtorKind && "cannot push destructor for trivial type");
2058
2059 CleanupKind cleanupKind = getCleanupKind(dtorKind);
2060 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
2061 cleanupKind & EHCleanup);
2062}
2063
John McCall7f416cc2015-09-08 08:05:57 +00002064void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002065 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002066 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00002067 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
2068 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002069}
2070
John McCall7f416cc2015-09-08 08:05:57 +00002071void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002072 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
2073}
2074
Richard Smith736a9472013-06-12 20:42:33 +00002075void CodeGenFunction::pushLifetimeExtendedDestroy(
John McCall7f416cc2015-09-08 08:05:57 +00002076 CleanupKind cleanupKind, Address addr, QualType type,
Richard Smith736a9472013-06-12 20:42:33 +00002077 Destroyer *destroyer, bool useEHCleanupForArray) {
Richard Smith736a9472013-06-12 20:42:33 +00002078 // Push an EH-only cleanup for the object now.
2079 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
2080 // around in case a temporary's destructor throws an exception.
2081 if (cleanupKind & EHCleanup)
2082 EHStack.pushCleanup<DestroyObject>(
2083 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
2084 destroyer, useEHCleanupForArray);
2085
2086 // Remember that we need to push a full cleanup for the object at the
2087 // end of the full-expression.
2088 pushCleanupAfterFullExpr<DestroyObject>(
2089 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
2090}
2091
John McCall178360e2011-07-11 08:38:19 +00002092/// emitDestroy - Immediately perform the destruction of the given
2093/// object.
2094///
2095/// \param addr - the address of the object; a type*
2096/// \param type - the type of the object; if an array type, all
2097/// objects are destroyed in reverse order
2098/// \param destroyer - the function to call to destroy individual
2099/// elements
2100/// \param useEHCleanupForArray - whether an EH cleanup should be
2101/// used when destroying array elements, in case one of the
2102/// destructions throws an exception
John McCall7f416cc2015-09-08 08:05:57 +00002103void CodeGenFunction::emitDestroy(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002104 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002105 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00002106 const ArrayType *arrayType = getContext().getAsArrayType(type);
2107 if (!arrayType)
2108 return destroyer(*this, addr, type);
2109
John McCall7f416cc2015-09-08 08:05:57 +00002110 llvm::Value *length = emitArrayLength(arrayType, type, addr);
2111
2112 CharUnits elementAlign =
2113 addr.getAlignment()
2114 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
John McCall97eab0a2011-07-13 08:09:46 +00002115
2116 // Normally we have to check whether the array is zero-length.
2117 bool checkZeroLength = true;
2118
2119 // But if the array length is constant, we can suppress that.
2120 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
2121 // ...and if it's constant zero, we can just skip the entire thing.
2122 if (constLength->isZero()) return;
2123 checkZeroLength = false;
2124 }
2125
John McCall7f416cc2015-09-08 08:05:57 +00002126 llvm::Value *begin = addr.getPointer();
John McCall82fe67b2011-07-09 01:37:26 +00002127 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall7f416cc2015-09-08 08:05:57 +00002128 emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002129 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002130}
2131
John McCall178360e2011-07-11 08:38:19 +00002132/// emitArrayDestroy - Destroys all the elements of the given array,
2133/// beginning from last to first. The array cannot be zero-length.
2134///
2135/// \param begin - a type* denoting the first element of the array
2136/// \param end - a type* denoting one past the end of the array
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00002137/// \param elementType - the element type of the array
John McCall178360e2011-07-11 08:38:19 +00002138/// \param destroyer - the function to call to destroy elements
2139/// \param useEHCleanup - whether to push an EH cleanup to destroy
2140/// the remaining elements in case the destruction of a single
2141/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00002142void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
2143 llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002144 QualType elementType,
2145 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002146 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002147 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00002148 bool useEHCleanup) {
John McCall7f416cc2015-09-08 08:05:57 +00002149 assert(!elementType->isArrayType());
John McCall82fe67b2011-07-09 01:37:26 +00002150
2151 // The basic structure here is a do-while loop, because we don't
2152 // need to check for the zero-element case.
2153 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
2154 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
2155
John McCall97eab0a2011-07-13 08:09:46 +00002156 if (checkZeroLength) {
2157 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
2158 "arraydestroy.isempty");
2159 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
2160 }
2161
John McCall82fe67b2011-07-09 01:37:26 +00002162 // Enter the loop body, making that address the current address.
2163 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
2164 EmitBlock(bodyBB);
2165 llvm::PHINode *elementPast =
2166 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
2167 elementPast->addIncoming(end, entryBB);
2168
2169 // Shift the address back by one element.
2170 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
2171 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
2172 "arraydestroy.element");
2173
John McCall178360e2011-07-11 08:38:19 +00002174 if (useEHCleanup)
John McCall7f416cc2015-09-08 08:05:57 +00002175 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
2176 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002177
John McCall82fe67b2011-07-09 01:37:26 +00002178 // Perform the actual destruction there.
John McCall7f416cc2015-09-08 08:05:57 +00002179 destroyer(*this, Address(element, elementAlign), elementType);
John McCall82fe67b2011-07-09 01:37:26 +00002180
John McCall178360e2011-07-11 08:38:19 +00002181 if (useEHCleanup)
2182 PopCleanupBlock();
2183
John McCall82fe67b2011-07-09 01:37:26 +00002184 // Check whether we've reached the end.
2185 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
2186 Builder.CreateCondBr(done, doneBB, bodyBB);
2187 elementPast->addIncoming(element, Builder.GetInsertBlock());
2188
2189 // Done.
2190 EmitBlock(doneBB);
2191}
2192
John McCall178360e2011-07-11 08:38:19 +00002193/// Perform partial array destruction as if in an EH cleanup. Unlike
2194/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00002195static void emitPartialArrayDestroy(CodeGenFunction &CGF,
2196 llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002197 QualType type, CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002198 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00002199 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00002200 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00002201 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
2202 // VLAs don't require a GEP index to walk into.
2203 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00002204 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00002205 type = arrayType->getElementType();
2206 }
John McCall97eab0a2011-07-13 08:09:46 +00002207
2208 if (arrayDepth) {
John McCallf0f0b7a2015-09-14 18:57:08 +00002209 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
John McCall97eab0a2011-07-13 08:09:46 +00002210
John McCallf0f0b7a2015-09-14 18:57:08 +00002211 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
Jay Foad040dd822011-07-22 08:16:57 +00002212 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
2213 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00002214 }
2215
John McCall97eab0a2011-07-13 08:09:46 +00002216 // Destroy the array. We don't ever need an EH cleanup because we
2217 // assume that we're in an EH cleanup ourselves, so a throwing
2218 // destructor causes an immediate terminate.
John McCall7f416cc2015-09-08 08:05:57 +00002219 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002220 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00002221}
2222
John McCall82fe67b2011-07-09 01:37:26 +00002223namespace {
John McCall178360e2011-07-11 08:38:19 +00002224 /// RegularPartialArrayDestroy - a cleanup which performs a partial
2225 /// array destroy where the end pointer is regularly determined and
2226 /// does not need to be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002227 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall178360e2011-07-11 08:38:19 +00002228 llvm::Value *ArrayBegin;
2229 llvm::Value *ArrayEnd;
2230 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002231 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002232 CharUnits ElementAlign;
John McCall178360e2011-07-11 08:38:19 +00002233 public:
2234 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002235 QualType elementType, CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002236 CodeGenFunction::Destroyer *destroyer)
2237 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
John McCall7f416cc2015-09-08 08:05:57 +00002238 ElementType(elementType), Destroyer(destroyer),
2239 ElementAlign(elementAlign) {}
John McCall178360e2011-07-11 08:38:19 +00002240
Craig Topper4f12f102014-03-12 06:41:41 +00002241 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00002242 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002243 ElementType, ElementAlign, Destroyer);
John McCall178360e2011-07-11 08:38:19 +00002244 }
2245 };
2246
2247 /// IrregularPartialArrayDestroy - a cleanup which performs a
2248 /// partial array destroy where the end pointer is irregularly
2249 /// determined and must be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002250 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00002251 llvm::Value *ArrayBegin;
John McCall7f416cc2015-09-08 08:05:57 +00002252 Address ArrayEndPointer;
John McCall82fe67b2011-07-09 01:37:26 +00002253 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002254 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002255 CharUnits ElementAlign;
John McCall82fe67b2011-07-09 01:37:26 +00002256 public:
John McCall178360e2011-07-11 08:38:19 +00002257 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002258 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002259 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002260 CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002261 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00002262 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
John McCall7f416cc2015-09-08 08:05:57 +00002263 ElementType(elementType), Destroyer(destroyer),
2264 ElementAlign(elementAlign) {}
John McCall82fe67b2011-07-09 01:37:26 +00002265
Craig Topper4f12f102014-03-12 06:41:41 +00002266 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00002267 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00002268 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002269 ElementType, ElementAlign, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002270 }
2271 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002272} // end anonymous namespace
John McCall82fe67b2011-07-09 01:37:26 +00002273
John McCall178360e2011-07-11 08:38:19 +00002274/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00002275/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00002276/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002277///
John McCall82fe67b2011-07-09 01:37:26 +00002278/// \param elementType - the immediate element type of the array;
2279/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00002280void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002281 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002282 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002283 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002284 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002285 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
2286 arrayBegin, arrayEndPointer,
John McCall7f416cc2015-09-08 08:05:57 +00002287 elementType, elementAlign,
2288 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002289}
2290
2291/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
2292/// already-constructed elements of the given array. The cleanup
2293/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002294///
John McCall178360e2011-07-11 08:38:19 +00002295/// \param elementType - the immediate element type of the array;
2296/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00002297void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
2298 llvm::Value *arrayEnd,
2299 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002300 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002301 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002302 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00002303 arrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002304 elementType, elementAlign,
2305 destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002306}
2307
Nadav Rotem1da30942013-03-23 06:43:35 +00002308/// Lazily declare the @llvm.lifetime.start intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002309llvm::Function *CodeGenModule::getLLVMLifetimeStartFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002310 if (LifetimeStartFn)
2311 return LifetimeStartFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002312 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002313 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002314 return LifetimeStartFn;
2315}
2316
2317/// Lazily declare the @llvm.lifetime.end intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002318llvm::Function *CodeGenModule::getLLVMLifetimeEndFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002319 if (LifetimeEndFn)
2320 return LifetimeEndFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002321 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002322 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002323 return LifetimeEndFn;
2324}
2325
John McCall31168b02011-06-15 23:02:42 +00002326namespace {
2327 /// A cleanup to perform a release of an object at the end of a
2328 /// function. This is used to balance out the incoming +1 of a
2329 /// ns_consumed argument when we can't reasonably do that just by
2330 /// not doing the initial retain for a __block argument.
David Blaikie7e70d682015-08-18 22:40:54 +00002331 struct ConsumeARCParameter final : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00002332 ConsumeARCParameter(llvm::Value *param,
2333 ARCPreciseLifetime_t precise)
2334 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00002335
2336 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00002337 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00002338
Craig Topper4f12f102014-03-12 06:41:41 +00002339 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00002340 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00002341 }
2342 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002343} // end anonymous namespace
John McCall31168b02011-06-15 23:02:42 +00002344
Mike Stump11289f42009-09-09 15:08:12 +00002345/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00002346/// for the specified parameter and set up LocalDeclMap.
John McCall7f416cc2015-09-08 08:05:57 +00002347void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
2348 unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002349 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00002350 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002351 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00002352
John McCall7f416cc2015-09-08 08:05:57 +00002353 Arg.getAnyValue()->setName(D.getName());
John McCall147d0212011-02-22 22:38:33 +00002354
Adrian Prantl51936dd2013-03-14 17:53:33 +00002355 QualType Ty = D.getType();
2356
John McCall147d0212011-02-22 22:38:33 +00002357 // Use better IR generation for certain implicit parameters.
John McCall7f416cc2015-09-08 08:05:57 +00002358 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
John McCall147d0212011-02-22 22:38:33 +00002359 // The only implicit argument a block has is its literal.
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002360 // This may be passed as an inalloca'ed value on Windows x86.
John McCall147d0212011-02-22 22:38:33 +00002361 if (BlockInfo) {
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002362 llvm::Value *V = Arg.isIndirect()
2363 ? Builder.CreateLoad(Arg.getIndirectAddress())
2364 : Arg.getDirectValue();
2365 setBlockContextParameter(IPD, ArgNo, V);
John McCall147d0212011-02-22 22:38:33 +00002366 return;
2367 }
2368 }
2369
John McCall7f416cc2015-09-08 08:05:57 +00002370 Address DeclPtr = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002371 bool DoStore = false;
2372 bool IsScalar = hasScalarEvaluationKind(Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002373 // If we already have a pointer to the argument, reuse the input pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002374 if (Arg.isIndirect()) {
2375 DeclPtr = Arg.getIndirectAddress();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002376 // If we have a prettier pointer type at this point, bitcast to that.
John McCall7f416cc2015-09-08 08:05:57 +00002377 unsigned AS = DeclPtr.getType()->getAddressSpace();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002378 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
John McCall7f416cc2015-09-08 08:05:57 +00002379 if (DeclPtr.getType() != IRTy)
2380 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
Yaxun Liu5b330e82018-03-15 15:25:19 +00002381 // Indirect argument is in alloca address space, which may be different
2382 // from the default address space.
2383 auto AllocaAS = CGM.getASTAllocaAddressSpace();
2384 auto *V = DeclPtr.getPointer();
2385 auto SrcLangAS = getLangOpts().OpenCL ? LangAS::opencl_private : AllocaAS;
2386 auto DestLangAS =
2387 getLangOpts().OpenCL ? LangAS::opencl_private : LangAS::Default;
2388 if (SrcLangAS != DestLangAS) {
2389 assert(getContext().getTargetAddressSpace(SrcLangAS) ==
2390 CGM.getDataLayout().getAllocaAddrSpace());
2391 auto DestAS = getContext().getTargetAddressSpace(DestLangAS);
2392 auto *T = V->getType()->getPointerElementType()->getPointerTo(DestAS);
2393 DeclPtr = Address(getTargetHooks().performAddrSpaceCast(
2394 *this, V, SrcLangAS, DestLangAS, T, true),
2395 DeclPtr.getAlignment());
2396 }
John McCall7f416cc2015-09-08 08:05:57 +00002397
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002398 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner19819442014-07-25 21:39:46 +00002399 // Don't push a cleanup in a thunk for a method that will also emit a
2400 // cleanup.
Akira Hatanaka85282972018-05-15 21:00:30 +00002401 if (hasAggregateEvaluationKind(Ty) && !CurFuncIsThunk &&
Simon Pilgrim1cd399c2019-10-03 11:22:48 +00002402 Ty->castAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Richard Smith2b4fa532019-09-29 05:08:46 +00002403 if (QualType::DestructionKind DtorKind =
2404 D.needsDestruction(getContext())) {
Akira Hatanaka7275da02018-02-28 07:15:55 +00002405 assert((DtorKind == QualType::DK_cxx_destructor ||
2406 DtorKind == QualType::DK_nontrivial_c_struct) &&
2407 "unexpected destructor type");
2408 pushDestroy(DtorKind, DeclPtr, Ty);
Akira Hatanakaccda3d22018-04-27 06:57:00 +00002409 CalleeDestructedParamCleanups[cast<ParmVarDecl>(&D)] =
2410 EHStack.stable_begin();
Akira Hatanaka7275da02018-02-28 07:15:55 +00002411 }
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002412 }
Chris Lattner53621a52007-06-13 20:44:40 +00002413 } else {
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00002414 // Check if the parameter address is controlled by OpenMP runtime.
2415 Address OpenMPLocalAddr =
2416 getLangOpts().OpenMP
2417 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
2418 : Address::invalid();
2419 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
2420 DeclPtr = OpenMPLocalAddr;
2421 } else {
2422 // Otherwise, create a temporary to hold the value.
2423 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D),
2424 D.getName() + ".addr");
2425 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002426 DoStore = true;
2427 }
Mike Stump11289f42009-09-09 15:08:12 +00002428
John McCall7f416cc2015-09-08 08:05:57 +00002429 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr);
2430
2431 LValue lv = MakeAddrLValue(DeclPtr, Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002432 if (IsScalar) {
John McCall31168b02011-06-15 23:02:42 +00002433 Qualifiers qs = Ty.getQualifiers();
John McCall31168b02011-06-15 23:02:42 +00002434 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
2435 // We honor __attribute__((ns_consumed)) for types with lifetime.
2436 // For __strong, it's handled by just skipping the initial retain;
2437 // otherwise we have to balance out the initial +1 with an extra
2438 // cleanup to do the release at the end of the function.
2439 bool isConsumed = D.hasAttr<NSConsumedAttr>();
2440
Erik Pilkington1e368822019-01-04 18:33:06 +00002441 // If a parameter is pseudo-strong then we can omit the implicit retain.
John McCalld4631322011-06-17 06:42:21 +00002442 if (D.isARCPseudoStrong()) {
Erik Pilkington1e368822019-01-04 18:33:06 +00002443 assert(lt == Qualifiers::OCL_Strong &&
2444 "pseudo-strong variable isn't strong?");
2445 assert(qs.hasConst() && "pseudo-strong variable should be const!");
John McCall31168b02011-06-15 23:02:42 +00002446 lt = Qualifiers::OCL_ExplicitNone;
2447 }
2448
Saleem Abdulrasoolda6784e2017-06-27 18:37:51 +00002449 // Load objects passed indirectly.
2450 if (Arg.isIndirect() && !ArgVal)
2451 ArgVal = Builder.CreateLoad(DeclPtr);
2452
John McCall31168b02011-06-15 23:02:42 +00002453 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002454 if (!isConsumed) {
2455 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2456 // use objc_storeStrong(&dest, value) for retaining the
2457 // object. But first, store a null into 'dest' because
2458 // objc_storeStrong attempts to release its old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002459 llvm::Value *Null = CGM.EmitNullConstant(D.getType());
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002460 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002461 EmitARCStoreStrongCall(lv.getAddress(*this), ArgVal, true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002462 DoStore = false;
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002463 }
2464 else
John McCall31168b02011-06-15 23:02:42 +00002465 // Don't use objc_retainBlock for block pointers, because we
2466 // don't want to Block_copy something just because we got it
2467 // as a parameter.
John McCall7f416cc2015-09-08 08:05:57 +00002468 ArgVal = EmitARCRetainNonBlock(ArgVal);
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002469 }
John McCall31168b02011-06-15 23:02:42 +00002470 } else {
2471 // Push the cleanup for a consumed parameter.
John McCallcdda29c2013-03-13 03:10:54 +00002472 if (isConsumed) {
2473 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
2474 ? ARCPreciseLifetime : ARCImpreciseLifetime);
John McCall7f416cc2015-09-08 08:05:57 +00002475 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal,
John McCallcdda29c2013-03-13 03:10:54 +00002476 precise);
2477 }
John McCall31168b02011-06-15 23:02:42 +00002478
2479 if (lt == Qualifiers::OCL_Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00002480 EmitARCInitWeak(DeclPtr, ArgVal);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002481 DoStore = false; // The weak init is a store, no need to do two.
John McCall31168b02011-06-15 23:02:42 +00002482 }
2483 }
2484
2485 // Enter the cleanup scope.
2486 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
2487 }
Chris Lattner53621a52007-06-13 20:44:40 +00002488 }
2489
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002490 // Store the initial value into the alloca.
2491 if (DoStore)
John McCall7f416cc2015-09-08 08:05:57 +00002492 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002493
John McCall7f416cc2015-09-08 08:05:57 +00002494 setAddrOfLocalVar(&D, DeclPtr);
Sanjiv Gupta18de6242008-05-30 10:30:31 +00002495
Vedant Kumar04818d82019-07-29 22:49:55 +00002496 // Emit debug info for param declarations in non-thunk functions.
Alexey Samsonov74a38682012-05-04 07:39:27 +00002497 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002498 if (CGM.getCodeGenOpts().getDebugInfo() >=
Vedant Kumar04818d82019-07-29 22:49:55 +00002499 codegenoptions::LimitedDebugInfo &&
2500 !CurFuncIsThunk) {
John McCall7f416cc2015-09-08 08:05:57 +00002501 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00002502 }
2503 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002504
2505 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00002506 EmitVarAnnotations(&D, DeclPtr.getPointer());
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002507
2508 // We can only check return value nullability if all arguments to the
2509 // function satisfy their nullability preconditions. This makes it necessary
2510 // to emit null checks for args in the function body itself.
2511 if (requiresReturnValueNullabilityCheck()) {
2512 auto Nullability = Ty->getNullability(getContext());
2513 if (Nullability && *Nullability == NullabilityKind::NonNull) {
2514 SanitizerScope SanScope(this);
2515 RetValNullabilityPrecondition =
2516 Builder.CreateAnd(RetValNullabilityPrecondition,
2517 Builder.CreateIsNotNull(Arg.getAnyValue()));
2518 }
2519 }
Chris Lattner53621a52007-06-13 20:44:40 +00002520}
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00002521
Alexey Bataevc5b1d322016-03-04 09:22:22 +00002522void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
2523 CodeGenFunction *CGF) {
2524 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2525 return;
2526 getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
2527}
Kelvin Li1408f912018-09-26 04:28:39 +00002528
Michael Kruse251e1482019-02-01 20:25:04 +00002529void CodeGenModule::EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D,
Michael Krused47b9432019-08-05 18:43:21 +00002530 CodeGenFunction *CGF) {
2531 if (!LangOpts.OpenMP || LangOpts.OpenMPSimd ||
2532 (!LangOpts.EmitAllDecls && !D->isUsed()))
Michael Kruse251e1482019-02-01 20:25:04 +00002533 return;
Michael Krused47b9432019-08-05 18:43:21 +00002534 getOpenMPRuntime().emitUserDefinedMapper(D, CGF);
Michael Kruse251e1482019-02-01 20:25:04 +00002535}
2536
Kelvin Li1408f912018-09-26 04:28:39 +00002537void CodeGenModule::EmitOMPRequiresDecl(const OMPRequiresDecl *D) {
Alexey Bataev982a35e2019-03-19 17:09:52 +00002538 getOpenMPRuntime().checkArchForUnifiedAddressing(D);
Kelvin Li1408f912018-09-26 04:28:39 +00002539}