blob: e40e96868a862a8557e81d436dafd49934c0b6e2 [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"
Ken Dyck8c89d592009-12-22 14:23:30 +000025#include "clang/AST/CharUnits.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000026#include "clang/AST/Decl.h"
Anders Carlsson4c03d982008-08-25 01:38:19 +000027#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000028#include "clang/AST/DeclOpenMP.h"
Richard Trieu63688182018-12-11 03:18:39 +000029#include "clang/Basic/CodeGenOptions.h"
Nate Begemanfaae0812008-04-19 04:17:09 +000030#include "clang/Basic/SourceManager.h"
Chris Lattnerb781dc792008-05-08 05:58:21 +000031#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000032#include "clang/CodeGen/CGFunctionInfo.h"
JF Bastien2f0582f2018-09-21 13:54:09 +000033#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000034#include "llvm/IR/DataLayout.h"
35#include "llvm/IR/GlobalVariable.h"
36#include "llvm/IR/Intrinsics.h"
37#include "llvm/IR/Type.h"
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +000038
Chris Lattner84915fa2007-06-02 04:16:21 +000039using namespace clang;
40using namespace CodeGen;
41
Chris Lattner1ad38f82007-06-09 01:20:56 +000042void CodeGenFunction::EmitDecl(const Decl &D) {
Chris Lattner1ad38f82007-06-09 01:20:56 +000043 switch (D.getKind()) {
David Majnemerd9b1a4f2015-11-04 03:40:30 +000044 case Decl::BuiltinTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000045 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +000046 case Decl::ExternCContext:
Douglas Gregor19043f02010-04-23 02:02:43 +000047 case Decl::Namespace:
48 case Decl::UnresolvedUsingTypename:
49 case Decl::ClassTemplateSpecialization:
50 case Decl::ClassTemplatePartialSpecialization:
Larisse Voufo39a1e502013-08-06 01:03:05 +000051 case Decl::VarTemplateSpecialization:
52 case Decl::VarTemplatePartialSpecialization:
Douglas Gregor19043f02010-04-23 02:02:43 +000053 case Decl::TemplateTypeParm:
54 case Decl::UnresolvedUsingValue:
Alexis Hunted053252010-05-30 07:21:58 +000055 case Decl::NonTypeTemplateParm:
Richard Smithbc491202017-02-17 20:05:37 +000056 case Decl::CXXDeductionGuide:
Douglas Gregor19043f02010-04-23 02:02:43 +000057 case Decl::CXXMethod:
58 case Decl::CXXConstructor:
59 case Decl::CXXDestructor:
60 case Decl::CXXConversion:
61 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +000062 case Decl::MSProperty:
Francois Pichetdf946c32010-11-21 06:49:41 +000063 case Decl::IndirectField:
Douglas Gregor19043f02010-04-23 02:02:43 +000064 case Decl::ObjCIvar:
Eric Christopher31ab1302011-08-23 22:38:00 +000065 case Decl::ObjCAtDefsField:
Chris Lattnerba9dddb2007-10-08 21:37:32 +000066 case Decl::ParmVar:
Douglas Gregor19043f02010-04-23 02:02:43 +000067 case Decl::ImplicitParam:
68 case Decl::ClassTemplate:
Larisse Voufo39a1e502013-08-06 01:03:05 +000069 case Decl::VarTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000070 case Decl::FunctionTemplate:
Richard Smith3f1b5d02011-05-05 21:57:07 +000071 case Decl::TypeAliasTemplate:
Douglas Gregor19043f02010-04-23 02:02:43 +000072 case Decl::TemplateTemplateParm:
73 case Decl::ObjCMethod:
74 case Decl::ObjCCategory:
75 case Decl::ObjCProtocol:
76 case Decl::ObjCInterface:
77 case Decl::ObjCCategoryImpl:
78 case Decl::ObjCImplementation:
79 case Decl::ObjCProperty:
80 case Decl::ObjCCompatibleAlias:
Nico Weber66220292016-03-02 17:28:48 +000081 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +000082 case Decl::PragmaDetectMismatch:
Abramo Bagnarad7340582010-06-05 05:09:32 +000083 case Decl::AccessSpec:
Douglas Gregor19043f02010-04-23 02:02:43 +000084 case Decl::LinkageSpec:
Richard Smith8df390f2016-09-08 23:14:54 +000085 case Decl::Export:
Douglas Gregor19043f02010-04-23 02:02:43 +000086 case Decl::ObjCPropertyImpl:
Douglas Gregor19043f02010-04-23 02:02:43 +000087 case Decl::FileScopeAsm:
88 case Decl::Friend:
89 case Decl::FriendTemplate:
90 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +000091 case Decl::Captured:
Francois Pichet00c7e6c2011-08-14 03:52:19 +000092 case Decl::ClassScopeFunctionSpecialization:
David Blaikiebd483762013-05-20 04:58:53 +000093 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +000094 case Decl::ConstructorUsingShadow:
Douglas Gregor85f3f952015-07-07 03:57:15 +000095 case Decl::ObjCTypeParam:
Richard Smithda383632016-08-15 01:33:41 +000096 case Decl::Binding:
David Blaikie83d382b2011-09-23 05:06:16 +000097 llvm_unreachable("Declaration should not be in declstmts!");
Amjad Abouddc4531e2016-04-30 01:44:38 +000098 case Decl::Function: // void X();
99 case Decl::Record: // struct/union/class X;
100 case Decl::Enum: // enum X;
101 case Decl::EnumConstant: // enum ? { X = ? }
102 case Decl::CXXRecord: // struct/union/class X; [C++]
Anders Carlssonce2cd012009-12-03 17:26:31 +0000103 case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
Chris Lattner43e7f312011-02-18 02:08:43 +0000104 case Decl::Label: // __label__ x;
Douglas Gregorba345522011-12-02 23:23:56 +0000105 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +0000106 case Decl::OMPThreadPrivate:
Alexey Bataev25ed0c02019-03-07 17:54:44 +0000107 case Decl::OMPAllocate:
Alexey Bataev4244be22016-02-11 05:35:55 +0000108 case Decl::OMPCapturedExpr:
Kelvin Li1408f912018-09-26 04:28:39 +0000109 case Decl::OMPRequires:
Michael Han84324352013-02-22 17:15:32 +0000110 case Decl::Empty:
Saar Razd7aae332019-07-10 21:25:49 +0000111 case Decl::Concept:
Chris Lattner84915fa2007-06-02 04:16:21 +0000112 // None of these decls require codegen support.
113 return;
David Blaikieb7d1e1f2013-02-02 00:39:32 +0000114
David Blaikief121b932013-05-20 22:50:41 +0000115 case Decl::NamespaceAlias:
116 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000117 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
David Blaikief121b932013-05-20 22:50:41 +0000118 return;
David Blaikiebd483762013-05-20 04:58:53 +0000119 case Decl::Using: // using X; [C++]
120 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000121 DI->EmitUsingDecl(cast<UsingDecl>(D));
David Blaikiebd483762013-05-20 04:58:53 +0000122 return;
Richard Smith151c4562016-12-20 21:35:28 +0000123 case Decl::UsingPack:
124 for (auto *Using : cast<UsingPackDecl>(D).expansions())
125 EmitDecl(*Using);
126 return;
David Blaikie9f88fe82013-04-22 06:13:21 +0000127 case Decl::UsingDirective: // using namespace X; [C++]
128 if (CGDebugInfo *DI = getDebugInfo())
129 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
130 return;
Richard Smithbdb84f32016-07-22 23:36:59 +0000131 case Decl::Var:
132 case Decl::Decomposition: {
Daniel Dunbara7998072008-08-29 17:28:43 +0000133 const VarDecl &VD = cast<VarDecl>(D);
John McCall1c9c3fd2010-10-15 04:57:14 +0000134 assert(VD.isLocalVarDecl() &&
Daniel Dunbara7998072008-08-29 17:28:43 +0000135 "Should not see file-scope variables inside a function!");
Richard Smithda383632016-08-15 01:33:41 +0000136 EmitVarDecl(VD);
137 if (auto *DD = dyn_cast<DecompositionDecl>(&VD))
138 for (auto *B : DD->bindings())
139 if (auto *HD = B->getHoldingVar())
140 EmitVarDecl(*HD);
141 return;
Chris Lattner84915fa2007-06-02 04:16:21 +0000142 }
Mike Stump11289f42009-09-09 15:08:12 +0000143
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000144 case Decl::OMPDeclareReduction:
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000145 return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this);
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000146
Michael Kruse251e1482019-02-01 20:25:04 +0000147 case Decl::OMPDeclareMapper:
148 return CGM.EmitOMPDeclareMapper(cast<OMPDeclareMapperDecl>(&D), this);
149
Richard Smithdda56e42011-04-15 14:24:37 +0000150 case Decl::Typedef: // typedef int X;
151 case Decl::TypeAlias: { // using X = int; [C++0x]
152 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000153 QualType Ty = TD.getUnderlyingType();
Mike Stump11289f42009-09-09 15:08:12 +0000154
Anders Carlsson5d985f52008-12-20 21:51:53 +0000155 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000156 EmitVariablyModifiedType(Ty);
Hamza Soodd14003d2019-07-05 14:36:08 +0000157
158 return;
Anders Carlsson5d985f52008-12-20 21:51:53 +0000159 }
Daniel Dunbara7998072008-08-29 17:28:43 +0000160 }
Chris Lattner84915fa2007-06-02 04:16:21 +0000161}
Chris Lattner03df1222007-06-02 04:53:11 +0000162
John McCall1c9c3fd2010-10-15 04:57:14 +0000163/// EmitVarDecl - This method handles emission of any variable declaration
Chris Lattner03df1222007-06-02 04:53:11 +0000164/// inside a function, including static vars etc.
John McCall1c9c3fd2010-10-15 04:57:14 +0000165void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Yaxun Liu4f33b3d2017-05-15 14:47:47 +0000166 if (D.hasExternalStorage())
167 // Don't emit it now, allow it to be emitted lazily on its first use.
168 return;
169
170 // Some function-scope variable does not have static storage but still
171 // needs to be emitted like a static variable, e.g. a function-scope
172 // variable in constant address space in OpenCL.
173 if (D.getStorageDuration() != SD_Automatic) {
Alexey Baderbed40092017-11-15 11:38:17 +0000174 // Static sampler variables translated to function calls.
175 if (D.getType()->isSamplerT())
176 return;
177
Eric Christopher31ab1302011-08-23 22:38:00 +0000178 llvm::GlobalValue::LinkageTypes Linkage =
Rui Ueyama49a3ad22019-07-16 04:46:31 +0000179 CGM.getLLVMLinkageVarDefinition(&D, /*IsConstant=*/false);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000180
David Majnemer27d69db2014-04-28 22:17:59 +0000181 // FIXME: We need to force the emission/use of a guard variable for
182 // some variables even if we can constant-evaluate them because
183 // we can't guarantee every translation unit will constant-evaluate them.
Eric Christopher31ab1302011-08-23 22:38:00 +0000184
John McCall1c9c3fd2010-10-15 04:57:14 +0000185 return EmitStaticVarDecl(D, Linkage);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000186 }
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000187
Anastasia Stulovabcea6962015-09-30 14:08:20 +0000188 if (D.getType().getAddressSpace() == LangAS::opencl_local)
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000189 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
190
191 assert(D.hasLocalStorage());
192 return EmitAutoVarDecl(D);
Chris Lattner03df1222007-06-02 04:53:11 +0000193}
194
Reid Kleckner453e0562014-10-08 01:07:54 +0000195static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) {
196 if (CGM.getLangOpts().CPlusPlus)
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000197 return CGM.getMangledName(&D).str();
198
Reid Kleckner453e0562014-10-08 01:07:54 +0000199 // If this isn't C++, we don't need a mangled name, just a pretty one.
200 assert(!D.isExternallyVisible() && "name shouldn't matter");
201 std::string ContextName;
202 const DeclContext *DC = D.getDeclContext();
Alexey Bataev43f74392015-05-07 06:28:46 +0000203 if (auto *CD = dyn_cast<CapturedDecl>(DC))
204 DC = cast<DeclContext>(CD->getNonClosureContext());
Reid Kleckner453e0562014-10-08 01:07:54 +0000205 if (const auto *FD = dyn_cast<FunctionDecl>(DC))
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000206 ContextName = CGM.getMangledName(FD);
Reid Kleckner453e0562014-10-08 01:07:54 +0000207 else if (const auto *BD = dyn_cast<BlockDecl>(DC))
208 ContextName = CGM.getBlockMangledName(GlobalDecl(), BD);
209 else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC))
210 ContextName = OMD->getSelector().getAsString();
Chris Lattnere99c1102009-12-05 08:22:11 +0000211 else
David Blaikie83d382b2011-09-23 05:06:16 +0000212 llvm_unreachable("Unknown context for static var decl");
Eric Christopher31ab1302011-08-23 22:38:00 +0000213
Reid Kleckner453e0562014-10-08 01:07:54 +0000214 ContextName += "." + D.getNameAsString();
215 return ContextName;
Chris Lattnere99c1102009-12-05 08:22:11 +0000216}
217
Reid Kleckner453e0562014-10-08 01:07:54 +0000218llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl(
219 const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) {
220 // In general, we don't always emit static var decls once before we reference
221 // them. It is possible to reference them before emitting the function that
222 // contains them, and it is possible to emit the containing function multiple
223 // times.
224 if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D])
225 return ExistingGV;
226
Chris Lattnerfc4379f2008-04-06 23:10:54 +0000227 QualType Ty = D.getType();
Eli Friedmana682d392008-02-15 12:20:59 +0000228 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begemanfaae0812008-04-19 04:17:09 +0000229
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000230 // Use the label if the variable is renamed with the asm-label extension.
231 std::string Name;
Benjamin Kramer5642e192011-11-21 15:47:23 +0000232 if (D.hasAttr<AsmLabelAttr>())
Reid Kleckner453e0562014-10-08 01:07:54 +0000233 Name = getMangledName(&D);
Benjamin Kramer5642e192011-11-21 15:47:23 +0000234 else
Reid Kleckner453e0562014-10-08 01:07:54 +0000235 Name = getStaticDeclName(*this, D);
Nate Begemanfaae0812008-04-19 04:17:09 +0000236
Reid Kleckner453e0562014-10-08 01:07:54 +0000237 llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty);
Alexander Richardson6d989432017-10-15 18:48:14 +0000238 LangAS AS = GetGlobalVarAddressSpace(&D);
Yaxun Liucbf647c2017-07-08 13:24:52 +0000239 unsigned TargetAS = getContext().getTargetAddressSpace(AS);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000240
Yaxun Liua64a4912018-04-02 17:38:24 +0000241 // OpenCL variables in local address space and CUDA shared
242 // variables cannot have an initializer.
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000243 llvm::Constant *Init = nullptr;
Yaxun Liua64a4912018-04-02 17:38:24 +0000244 if (Ty.getAddressSpace() == LangAS::opencl_local ||
245 D.hasAttr<CUDASharedAttr>())
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000246 Init = llvm::UndefValue::get(LTy);
Yaxun Liua64a4912018-04-02 17:38:24 +0000247 else
248 Init = EmitNullConstant(Ty);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000249
Yaxun Liucbf647c2017-07-08 13:24:52 +0000250 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
251 getModule(), LTy, Ty.isConstant(getContext()), Linkage, Init, Name,
252 nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS);
Ken Dyck160146e2010-01-27 17:10:57 +0000253 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000254
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +0000255 if (supportsCOMDAT() && GV->isWeakForLinker())
256 GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000257
Richard Smithfd3834f2013-04-13 02:43:54 +0000258 if (D.getTLSKind())
Reid Kleckner453e0562014-10-08 01:07:54 +0000259 setTLSMode(GV, D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000260
Rafael Espindola922f2aa2018-02-23 19:30:48 +0000261 setGVProperties(GV, &D);
262
Eli Benderskycb399432014-03-24 22:05:38 +0000263 // Make sure the result is of the correct type.
Alexander Richardson6d989432017-10-15 18:48:14 +0000264 LangAS ExpectedAS = Ty.getAddressSpace();
Reid Kleckner453e0562014-10-08 01:07:54 +0000265 llvm::Constant *Addr = GV;
Yaxun Liucbf647c2017-07-08 13:24:52 +0000266 if (AS != ExpectedAS) {
267 Addr = getTargetCodeGenInfo().performAddrSpaceCast(
268 *this, GV, AS, ExpectedAS,
269 LTy->getPointerTo(getContext().getTargetAddressSpace(ExpectedAS)));
Eli Benderskycb399432014-03-24 22:05:38 +0000270 }
271
Reid Kleckner453e0562014-10-08 01:07:54 +0000272 setStaticLocalDeclAddress(&D, Addr);
273
274 // Ensure that the static local gets initialized by making sure the parent
275 // function gets emitted eventually.
276 const Decl *DC = cast<Decl>(D.getDeclContext());
277
278 // We can't name blocks or captured statements directly, so try to emit their
279 // parents.
280 if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) {
281 DC = DC->getNonClosureContext();
282 // FIXME: Ensure that global blocks get emitted.
283 if (!DC)
284 return Addr;
285 }
286
287 GlobalDecl GD;
288 if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC))
289 GD = GlobalDecl(CD, Ctor_Base);
290 else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC))
291 GD = GlobalDecl(DD, Dtor_Base);
292 else if (const auto *FD = dyn_cast<FunctionDecl>(DC))
293 GD = GlobalDecl(FD);
294 else {
295 // Don't do anything for Obj-C method decls or global closures. We should
296 // never defer them.
297 assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl");
298 }
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000299 if (GD.getDecl()) {
300 // Disable emission of the parent function for the OpenMP device codegen.
301 CGOpenMPRuntime::DisableAutoDeclareTargetRAII NoDeclTarget(*this);
Reid Kleckner453e0562014-10-08 01:07:54 +0000302 (void)GetAddrOfGlobal(GD);
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000303 }
Reid Kleckner453e0562014-10-08 01:07:54 +0000304
305 return Addr;
Daniel Dunbar22a87f92009-02-25 19:24:29 +0000306}
307
Chandler Carruth84537952012-03-30 19:44:53 +0000308/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
309/// global variable that has already been created for it. If the initializer
310/// has a different type than GV does, this may free GV and return a different
311/// one. Otherwise it just returns GV.
312llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +0000313CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000314 llvm::GlobalVariable *GV) {
John McCallde0fe072017-08-15 21:42:52 +0000315 ConstantEmitter emitter(*this);
316 llvm::Constant *Init = emitter.tryEmitForInitializer(D);
John McCall70013b62010-07-15 23:40:35 +0000317
Chris Lattnere99c1102009-12-05 08:22:11 +0000318 // If constant emission failed, then this should be a C++ static
319 // initializer.
Chandler Carruth84537952012-03-30 19:44:53 +0000320 if (!Init) {
Richard Smith9c6890a2012-11-01 22:30:59 +0000321 if (!getLangOpts().CPlusPlus)
Chris Lattnere99c1102009-12-05 08:22:11 +0000322 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
Matthias Braun44bfe032017-01-10 17:43:01 +0000323 else if (HaveInsertPoint()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000324 // Since we have a static initializer, this global variable can't
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000325 // be constant.
Chandler Carruth84537952012-03-30 19:44:53 +0000326 GV->setConstant(false);
John McCall68ff0372010-09-08 01:44:27 +0000327
Chandler Carruth84537952012-03-30 19:44:53 +0000328 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000329 }
Chandler Carruth84537952012-03-30 19:44:53 +0000330 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000331 }
John McCall70013b62010-07-15 23:40:35 +0000332
Chris Lattnere99c1102009-12-05 08:22:11 +0000333 // The initializer may differ in type from the global. Rewrite
334 // the global to match the initializer. (We have to do this
335 // because some types, like unions, can't be completely represented
336 // in the LLVM type system.)
Chandler Carruth84537952012-03-30 19:44:53 +0000337 if (GV->getType()->getElementType() != Init->getType()) {
338 llvm::GlobalVariable *OldGV = GV;
339
340 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
341 OldGV->isConstant(),
342 OldGV->getLinkage(), Init, "",
343 /*InsertBefore*/ OldGV,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +0000344 OldGV->getThreadLocalMode(),
Chandler Carruth84537952012-03-30 19:44:53 +0000345 CGM.getContext().getTargetAddressSpace(D.getType()));
346 GV->setVisibility(OldGV->getVisibility());
Rafael Espindola699f5d62018-02-07 22:15:33 +0000347 GV->setDSOLocal(OldGV->isDSOLocal());
Reid Klecknereab97d32015-07-20 20:35:30 +0000348 GV->setComdat(OldGV->getComdat());
Eric Christopher31ab1302011-08-23 22:38:00 +0000349
Chris Lattnere99c1102009-12-05 08:22:11 +0000350 // Steal the name of the old global
Chandler Carruth84537952012-03-30 19:44:53 +0000351 GV->takeName(OldGV);
Eric Christopher31ab1302011-08-23 22:38:00 +0000352
Chris Lattnere99c1102009-12-05 08:22:11 +0000353 // Replace all uses of the old global with the new global
Chandler Carruth84537952012-03-30 19:44:53 +0000354 llvm::Constant *NewPtrForOldDecl =
355 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
356 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christopher31ab1302011-08-23 22:38:00 +0000357
Chris Lattnere99c1102009-12-05 08:22:11 +0000358 // Erase the old global, since it is no longer used.
Chandler Carruth84537952012-03-30 19:44:53 +0000359 OldGV->eraseFromParent();
Chris Lattnere99c1102009-12-05 08:22:11 +0000360 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000361
Chandler Carruth84537952012-03-30 19:44:53 +0000362 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
363 GV->setInitializer(Init);
Richard Smith6331c402012-02-13 22:16:19 +0000364
John McCallde0fe072017-08-15 21:42:52 +0000365 emitter.finalize(GV);
366
Richard Smith2b4fa532019-09-29 05:08:46 +0000367 if (D.needsDestruction(getContext()) && HaveInsertPoint()) {
Richard Smith6331c402012-02-13 22:16:19 +0000368 // We have a constant initializer, but a nontrivial destructor. We still
369 // need to perform a guarded "initialization" in order to register the
Richard Smithe070fd22012-02-17 06:48:11 +0000370 // destructor.
Chandler Carruth84537952012-03-30 19:44:53 +0000371 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith6331c402012-02-13 22:16:19 +0000372 }
373
Chandler Carruth84537952012-03-30 19:44:53 +0000374 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000375}
376
John McCall1c9c3fd2010-10-15 04:57:14 +0000377void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000378 llvm::GlobalValue::LinkageTypes Linkage) {
John McCallb88a5662012-03-30 21:00:39 +0000379 // Check to see if we already have a global variable for this
380 // declaration. This can happen when double-emitting function
381 // bodies, e.g. with complete and base constructors.
Reid Kleckner453e0562014-10-08 01:07:54 +0000382 llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage);
John McCall7f416cc2015-09-08 08:05:57 +0000383 CharUnits alignment = getContext().getDeclAlign(&D);
Daniel Dunbara374e602009-02-25 19:45:19 +0000384
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000385 // Store into LocalDeclMap before generating initializer to handle
386 // circular references.
John McCall7f416cc2015-09-08 08:05:57 +0000387 setAddrOfLocalVar(&D, Address(addr, alignment));
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000388
John McCall4a39ab82010-05-04 20:45:42 +0000389 // We can't have a VLA here, but we can have a pointer to a VLA,
390 // even though that doesn't really make any sense.
Eli Friedmanbc633be2009-04-20 03:54:15 +0000391 // Make sure to evaluate VLA bounds now so that we have them for later.
392 if (D.getType()->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000393 EmitVariablyModifiedType(D.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000394
John McCallb88a5662012-03-30 21:00:39 +0000395 // Save the type in case adding the initializer forces a type change.
396 llvm::Type *expectedType = addr->getType();
Eli Friedmanbc633be2009-04-20 03:54:15 +0000397
Eli Benderskycb399432014-03-24 22:05:38 +0000398 llvm::GlobalVariable *var =
399 cast<llvm::GlobalVariable>(addr->stripPointerCasts());
Artem Belevich4d430ba2016-05-09 22:09:56 +0000400
401 // CUDA's local and local static __shared__ variables should not
402 // have any non-empty initializers. This is ensured by Sema.
403 // Whatever initializer such variable may have when it gets here is
404 // a no-op and should not be emitted.
405 bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
406 D.hasAttr<CUDASharedAttr>();
Chris Lattnere99c1102009-12-05 08:22:11 +0000407 // If this value has an initializer, emit it.
Artem Belevich4d430ba2016-05-09 22:09:56 +0000408 if (D.getInit() && !isCudaSharedVar)
John McCallb88a5662012-03-30 21:00:39 +0000409 var = AddInitializerToStaticVarDecl(D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000410
John McCall7f416cc2015-09-08 08:05:57 +0000411 var->setAlignment(alignment.getQuantity());
Chris Lattner4d941092010-03-10 23:59:59 +0000412
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000413 if (D.hasAttr<AnnotateAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000414 CGM.AddGlobalAnnotations(&D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000415
Javed Absar2a67c9e2017-06-05 10:11:57 +0000416 if (auto *SA = D.getAttr<PragmaClangBSSSectionAttr>())
417 var->addAttribute("bss-section", SA->getName());
418 if (auto *SA = D.getAttr<PragmaClangDataSectionAttr>())
419 var->addAttribute("data-section", SA->getName());
420 if (auto *SA = D.getAttr<PragmaClangRodataSectionAttr>())
421 var->addAttribute("rodata-section", SA->getName());
422
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000423 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000424 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000425
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000426 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000427 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000428
Chandler Carruth84537952012-03-30 19:44:53 +0000429 // We may have to cast the constant because of the initializer
430 // mismatch above.
431 //
432 // FIXME: It is really dangerous to store this in the map; if anyone
433 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000434 llvm::Constant *castedAddr =
435 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCall7f416cc2015-09-08 08:05:57 +0000436 if (var != castedAddr)
437 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
John McCallb88a5662012-03-30 21:00:39 +0000438 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000439
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000440 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
Alexey Samsonov4f319cc2014-07-02 16:54:41 +0000441
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000442 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000443 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000444 if (DI &&
Benjamin Kramer8c305922016-02-02 11:06:51 +0000445 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000446 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000447 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000448 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000449}
Mike Stump11289f42009-09-09 15:08:12 +0000450
John McCall2b7fc382010-07-13 20:32:21 +0000451namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000452 struct DestroyObject final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000453 DestroyObject(Address addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000454 CodeGenFunction::Destroyer *destroyer,
455 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000456 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000457 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000458
John McCall7f416cc2015-09-08 08:05:57 +0000459 Address addr;
John McCall82fe67b2011-07-09 01:37:26 +0000460 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000461 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000462 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000463
Craig Topper4f12f102014-03-12 06:41:41 +0000464 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000465 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000466 bool useEHCleanupForArray =
467 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000468
469 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000470 }
471 };
472
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000473 template <class Derived>
474 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
Marco Antognini88559632019-07-22 09:39:13 +0000475 DestroyNRVOVariable(Address addr, QualType type, llvm::Value *NRVOFlag)
476 : NRVOFlag(NRVOFlag), Loc(addr), Ty(type) {}
John McCall2b7fc382010-07-13 20:32:21 +0000477
John McCall2b7fc382010-07-13 20:32:21 +0000478 llvm::Value *NRVOFlag;
John McCall7f416cc2015-09-08 08:05:57 +0000479 Address Loc;
Marco Antognini88559632019-07-22 09:39:13 +0000480 QualType Ty;
John McCall2b7fc382010-07-13 20:32:21 +0000481
Craig Topper4f12f102014-03-12 06:41:41 +0000482 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000483 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000484 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000485
Craig Topper8a13c412014-05-21 05:09:00 +0000486 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000487 if (NRVO) {
488 // If we exited via NRVO, we skip the destructor call.
489 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
490 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
John McCall7f416cc2015-09-08 08:05:57 +0000491 llvm::Value *DidNRVO =
492 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
John McCall2b7fc382010-07-13 20:32:21 +0000493 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
494 CGF.EmitBlock(RunDtorBB);
495 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000496
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000497 static_cast<Derived *>(this)->emitDestructorCall(CGF);
John McCall2b7fc382010-07-13 20:32:21 +0000498
499 if (NRVO) CGF.EmitBlock(SkipDtorBB);
500 }
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000501
502 virtual ~DestroyNRVOVariable() = default;
503 };
504
505 struct DestroyNRVOVariableCXX final
506 : DestroyNRVOVariable<DestroyNRVOVariableCXX> {
Marco Antognini88559632019-07-22 09:39:13 +0000507 DestroyNRVOVariableCXX(Address addr, QualType type,
508 const CXXDestructorDecl *Dtor, llvm::Value *NRVOFlag)
509 : DestroyNRVOVariable<DestroyNRVOVariableCXX>(addr, type, NRVOFlag),
510 Dtor(Dtor) {}
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000511
512 const CXXDestructorDecl *Dtor;
513
514 void emitDestructorCall(CodeGenFunction &CGF) {
515 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
516 /*ForVirtualBase=*/false,
Marco Antognini88559632019-07-22 09:39:13 +0000517 /*Delegating=*/false, Loc, Ty);
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000518 }
519 };
520
521 struct DestroyNRVOVariableC final
522 : DestroyNRVOVariable<DestroyNRVOVariableC> {
523 DestroyNRVOVariableC(Address addr, llvm::Value *NRVOFlag, QualType Ty)
Marco Antognini88559632019-07-22 09:39:13 +0000524 : DestroyNRVOVariable<DestroyNRVOVariableC>(addr, Ty, NRVOFlag) {}
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000525
526 void emitDestructorCall(CodeGenFunction &CGF) {
527 CGF.destroyNonTrivialCStruct(CGF, Loc, Ty);
528 }
John McCall2b7fc382010-07-13 20:32:21 +0000529 };
John McCall2b7fc382010-07-13 20:32:21 +0000530
David Blaikie7e70d682015-08-18 22:40:54 +0000531 struct CallStackRestore final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000532 Address Stack;
533 CallStackRestore(Address Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000534 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000535 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
James Y Knight8799cae2019-02-03 21:53:49 +0000536 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
John McCalla464ff92010-07-21 06:13:08 +0000537 CGF.Builder.CreateCall(F, V);
538 }
539 };
540
David Blaikie7e70d682015-08-18 22:40:54 +0000541 struct ExtendGCLifetime final : EHScopeStack::Cleanup {
John McCall1bd25562011-06-24 23:21:27 +0000542 const VarDecl &Var;
543 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
544
Craig Topper4f12f102014-03-12 06:41:41 +0000545 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000546 // Compute the address of the local variable, in case it's a
547 // byref or something.
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000548 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000549 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000550 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
551 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000552 CGF.EmitExtendGCLifetime(value);
553 }
554 };
555
David Blaikie7e70d682015-08-18 22:40:54 +0000556 struct CallCleanupFunction final : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000557 llvm::Constant *CleanupFn;
558 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000559 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000560
John McCalla464ff92010-07-21 06:13:08 +0000561 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000562 const VarDecl *Var)
563 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000564
Craig Topper4f12f102014-03-12 06:41:41 +0000565 void Emit(CodeGenFunction &CGF, Flags flags) override {
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000566 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000567 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000568 // Compute the address of the local variable, in case it's a byref
569 // or something.
John McCall7f416cc2015-09-08 08:05:57 +0000570 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer();
John McCallc533cb72011-02-22 06:44:22 +0000571
John McCalla464ff92010-07-21 06:13:08 +0000572 // In some cases, the type of the function argument will be different from
573 // the type of the pointer. An example of this is
574 // void f(void* arg);
575 // __attribute__((cleanup(f))) void *g;
576 //
577 // To fix this we insert a bitcast here.
578 QualType ArgTy = FnInfo.arg_begin()->type;
579 llvm::Value *Arg =
580 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
581
582 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000583 Args.add(RValue::get(Arg),
584 CGF.getContext().getPointerType(Var.getType()));
John McCallb92ab1a2016-10-26 23:46:34 +0000585 auto Callee = CGCallee::forDirect(CleanupFn);
586 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
John McCalla464ff92010-07-21 06:13:08 +0000587 }
588 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000589} // end anonymous namespace
John McCalla464ff92010-07-21 06:13:08 +0000590
John McCall31168b02011-06-15 23:02:42 +0000591/// EmitAutoVarWithLifetime - Does the setup required for an automatic
592/// variable with lifetime.
593static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
John McCall7f416cc2015-09-08 08:05:57 +0000594 Address addr,
John McCall31168b02011-06-15 23:02:42 +0000595 Qualifiers::ObjCLifetime lifetime) {
596 switch (lifetime) {
597 case Qualifiers::OCL_None:
598 llvm_unreachable("present but none");
599
600 case Qualifiers::OCL_ExplicitNone:
601 // nothing to do
602 break;
603
604 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000605 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000606 (var.hasAttr<ObjCPreciseLifetimeAttr>()
607 ? CodeGenFunction::destroyARCStrongPrecise
608 : CodeGenFunction::destroyARCStrongImprecise);
609
610 CleanupKind cleanupKind = CGF.getARCCleanupKind();
611 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
612 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000613 break;
614 }
615 case Qualifiers::OCL_Autoreleasing:
616 // nothing to do
617 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000618
John McCall31168b02011-06-15 23:02:42 +0000619 case Qualifiers::OCL_Weak:
620 // __weak objects always get EH cleanups; otherwise, exceptions
621 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000622 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
623 CodeGenFunction::destroyARCWeak,
624 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000625 break;
626 }
627}
628
629static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
630 if (const Expr *e = dyn_cast<Expr>(s)) {
631 // Skip the most common kinds of expressions that make
632 // hierarchy-walking expensive.
633 s = e = e->IgnoreParenCasts();
634
635 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
636 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000637 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
638 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000639 for (const auto &I : block->captures()) {
640 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000641 return true;
642 }
643 }
John McCall31168b02011-06-15 23:02:42 +0000644 }
645
Benjamin Kramer642f1732015-07-02 21:03:14 +0000646 for (const Stmt *SubStmt : s->children())
647 // SubStmt might be null; as in missing decl or conditional of an if-stmt.
648 if (SubStmt && isAccessedBy(var, SubStmt))
John McCall31168b02011-06-15 23:02:42 +0000649 return true;
650
651 return false;
652}
653
654static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
655 if (!decl) return false;
656 if (!isa<VarDecl>(decl)) return false;
657 const VarDecl *var = cast<VarDecl>(decl);
658 return isAccessedBy(*var, e);
659}
660
John McCallf8a9b662015-10-21 18:06:31 +0000661static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
662 const LValue &destLV, const Expr *init) {
John McCall0204e342015-11-16 22:11:41 +0000663 bool needsCast = false;
664
John McCallf8a9b662015-10-21 18:06:31 +0000665 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
666 switch (castExpr->getCastKind()) {
667 // Look through casts that don't require representation changes.
668 case CK_NoOp:
669 case CK_BitCast:
670 case CK_BlockPointerToObjCPointerCast:
John McCall0204e342015-11-16 22:11:41 +0000671 needsCast = true;
John McCallf8a9b662015-10-21 18:06:31 +0000672 break;
673
674 // If we find an l-value to r-value cast from a __weak variable,
675 // emit this operation as a copy or move.
676 case CK_LValueToRValue: {
677 const Expr *srcExpr = castExpr->getSubExpr();
678 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
679 return false;
680
681 // Emit the source l-value.
682 LValue srcLV = CGF.EmitLValue(srcExpr);
683
John McCall0204e342015-11-16 22:11:41 +0000684 // Handle a formal type change to avoid asserting.
685 auto srcAddr = srcLV.getAddress();
686 if (needsCast) {
687 srcAddr = CGF.Builder.CreateElementBitCast(srcAddr,
688 destLV.getAddress().getElementType());
689 }
690
John McCallf8a9b662015-10-21 18:06:31 +0000691 // If it was an l-value, use objc_copyWeak.
692 if (srcExpr->getValueKind() == VK_LValue) {
John McCall0204e342015-11-16 22:11:41 +0000693 CGF.EmitARCCopyWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000694 } else {
695 assert(srcExpr->getValueKind() == VK_XValue);
John McCall0204e342015-11-16 22:11:41 +0000696 CGF.EmitARCMoveWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000697 }
698 return true;
699 }
700
701 // Stop at anything else.
702 default:
703 return false;
704 }
705
706 init = castExpr->getSubExpr();
John McCallf8a9b662015-10-21 18:06:31 +0000707 }
708 return false;
709}
710
John McCall1553b192011-06-16 04:16:24 +0000711static void drillIntoBlockVariable(CodeGenFunction &CGF,
712 LValue &lvalue,
713 const VarDecl *var) {
John McCall7f416cc2015-09-08 08:05:57 +0000714 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(), var));
John McCall1553b192011-06-16 04:16:24 +0000715}
716
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000717void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS,
718 SourceLocation Loc) {
719 if (!SanOpts.has(SanitizerKind::NullabilityAssign))
720 return;
721
722 auto Nullability = LHS.getType()->getNullability(getContext());
723 if (!Nullability || *Nullability != NullabilityKind::NonNull)
724 return;
725
726 // Check if the right hand side of the assignment is nonnull, if the left
727 // hand side must be nonnull.
728 SanitizerScope SanScope(this);
729 llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS);
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000730 llvm::Constant *StaticData[] = {
731 EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()),
Simon Pilgrim2df19982017-03-14 21:43:52 +0000732 llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000733 llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)};
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000734 EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}},
735 SanitizerHandler::TypeMismatch, StaticData, RHS);
736}
737
David Blaikie73ca5692014-12-09 00:32:22 +0000738void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +0000739 LValue lvalue, bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000740 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000741 if (!lifetime) {
742 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000743 if (capturedByInit)
744 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000745 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
David Blaikie66e41972015-01-14 07:38:27 +0000746 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000747 return;
748 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000749
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000750 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
751 init = DIE->getExpr();
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000752
John McCall31168b02011-06-15 23:02:42 +0000753 // If we're emitting a value with lifetime, we have to do the
754 // initialization *before* we leave the cleanup scopes.
Bill Wendling7c44da22018-10-31 03:48:47 +0000755 if (const FullExpr *fe = dyn_cast<FullExpr>(init)) {
756 enterFullExpression(fe);
757 init = fe->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000758 }
759 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000760
761 // We have to maintain the illusion that the variable is
762 // zero-initialized. If the variable might be accessed in its
763 // initializer, zero-initialize before running the initializer, then
764 // actually perform the initialization with an assign.
765 bool accessedByInit = false;
766 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000767 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000768 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000769 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000770 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000771 if (capturedByInit) {
772 // We can use a simple GEP for this because it can't have been
773 // moved yet.
John McCall7f416cc2015-09-08 08:05:57 +0000774 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(),
775 cast<VarDecl>(D),
776 /*follow*/ false));
John McCall31168b02011-06-15 23:02:42 +0000777 }
778
John McCall7f416cc2015-09-08 08:05:57 +0000779 auto ty = cast<llvm::PointerType>(tempLV.getAddress().getElementType());
Yaxun Liu402804b2016-12-15 08:09:08 +0000780 llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000781
John McCall31168b02011-06-15 23:02:42 +0000782 // If __weak, we want to use a barrier under certain conditions.
783 if (lifetime == Qualifiers::OCL_Weak)
John McCall1553b192011-06-16 04:16:24 +0000784 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCall31168b02011-06-15 23:02:42 +0000785
786 // Otherwise just do a simple store.
787 else
David Chisnallfa35df62012-01-16 17:27:18 +0000788 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000789 }
790
791 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000792 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000793
794 switch (lifetime) {
795 case Qualifiers::OCL_None:
796 llvm_unreachable("present but none");
797
Erik Pilkington1e368822019-01-04 18:33:06 +0000798 case Qualifiers::OCL_Strong: {
799 if (!D || !isa<VarDecl>(D) || !cast<VarDecl>(D)->isARCPseudoStrong()) {
800 value = EmitARCRetainScalarExpr(init);
801 break;
802 }
803 // If D is pseudo-strong, treat it like __unsafe_unretained here. This means
804 // that we omit the retain, and causes non-autoreleased return values to be
805 // immediately released.
806 LLVM_FALLTHROUGH;
807 }
808
John McCall31168b02011-06-15 23:02:42 +0000809 case Qualifiers::OCL_ExplicitNone:
John McCalle399e5b2016-01-27 18:32:30 +0000810 value = EmitARCUnsafeUnretainedScalarExpr(init);
John McCall31168b02011-06-15 23:02:42 +0000811 break;
812
John McCall31168b02011-06-15 23:02:42 +0000813 case Qualifiers::OCL_Weak: {
John McCallf8a9b662015-10-21 18:06:31 +0000814 // If it's not accessed by the initializer, try to emit the
815 // initialization with a copy or move.
816 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
817 return;
818 }
819
John McCall31168b02011-06-15 23:02:42 +0000820 // No way to optimize a producing initializer into this. It's not
821 // worth optimizing for, because the value will immediately
822 // disappear in the common case.
823 value = EmitScalarExpr(init);
824
John McCall1553b192011-06-16 04:16:24 +0000825 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000826 if (accessedByInit)
John McCall1553b192011-06-16 04:16:24 +0000827 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000828 else
John McCall1553b192011-06-16 04:16:24 +0000829 EmitARCInitWeak(lvalue.getAddress(), value);
John McCall31168b02011-06-15 23:02:42 +0000830 return;
831 }
832
833 case Qualifiers::OCL_Autoreleasing:
834 value = EmitARCRetainAutoreleaseScalarExpr(init);
835 break;
836 }
837
John McCall1553b192011-06-16 04:16:24 +0000838 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000839
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000840 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
841
John McCall31168b02011-06-15 23:02:42 +0000842 // If the variable might have been accessed by its initializer, we
843 // might have to initialize with a barrier. We have to do this for
844 // both __weak and __strong, but __weak got filtered out above.
845 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000846 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000847 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000848 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000849 return;
850 }
851
David Chisnallfa35df62012-01-16 17:27:18 +0000852 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000853}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000854
JF Bastiened92f602018-07-20 23:37:12 +0000855/// Decide whether we can emit the non-zero parts of the specified initializer
856/// with equal or fewer than NumStores scalar stores.
857static bool canEmitInitWithFewStoresAfterBZero(llvm::Constant *Init,
858 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000859 // Zero and Undef never requires any extra stores.
860 if (isa<llvm::ConstantAggregateZero>(Init) ||
861 isa<llvm::ConstantPointerNull>(Init) ||
862 isa<llvm::UndefValue>(Init))
863 return true;
864 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
865 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
866 isa<llvm::ConstantExpr>(Init))
867 return Init->isNullValue() || NumStores--;
868
869 // See if we can emit each element.
870 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
871 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
872 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
JF Bastiened92f602018-07-20 23:37:12 +0000873 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattnere6af8862010-12-02 01:58:41 +0000874 return false;
875 }
876 return true;
877 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000878
Chris Lattner236b3572012-01-31 04:36:19 +0000879 if (llvm::ConstantDataSequential *CDS =
880 dyn_cast<llvm::ConstantDataSequential>(Init)) {
881 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
882 llvm::Constant *Elt = CDS->getElementAsConstant(i);
JF Bastiened92f602018-07-20 23:37:12 +0000883 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattner236b3572012-01-31 04:36:19 +0000884 return false;
885 }
886 return true;
887 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000888
Chris Lattnerb85025f2010-12-01 02:05:19 +0000889 // Anything else is hard and scary.
890 return false;
891}
892
JF Bastiened92f602018-07-20 23:37:12 +0000893/// For inits that canEmitInitWithFewStoresAfterBZero returned true for, emit
894/// the scalar stores that would be required.
895static void emitStoresForInitAfterBZero(CodeGenModule &CGM,
896 llvm::Constant *Init, Address Loc,
897 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000898 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
JF Bastiened92f602018-07-20 23:37:12 +0000899 "called emitStoresForInitAfterBZero for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000900
Chris Lattnere6af8862010-12-02 01:58:41 +0000901 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
902 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
903 isa<llvm::ConstantExpr>(Init)) {
JF Bastien9aab85a2018-07-13 20:33:23 +0000904 Builder.CreateStore(Init, Loc, isVolatile);
Chris Lattner236b3572012-01-31 04:36:19 +0000905 return;
906 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000907
908 if (llvm::ConstantDataSequential *CDS =
909 dyn_cast<llvm::ConstantDataSequential>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000910 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
911 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000912
913 // If necessary, get a pointer to the element and emit it.
914 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
JF Bastiened92f602018-07-20 23:37:12 +0000915 emitStoresForInitAfterBZero(
James Y Knight751fe282019-02-09 22:22:28 +0000916 CGM, Elt, Builder.CreateConstInBoundsGEP2_32(Loc, 0, i), isVolatile,
917 Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000918 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000919 return;
920 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000921
Chris Lattnere6af8862010-12-02 01:58:41 +0000922 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
923 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000924
Chris Lattnere6af8862010-12-02 01:58:41 +0000925 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
926 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000927
928 // If necessary, get a pointer to the element and emit it.
929 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
James Y Knight751fe282019-02-09 22:22:28 +0000930 emitStoresForInitAfterBZero(CGM, Elt,
931 Builder.CreateConstInBoundsGEP2_32(Loc, 0, i),
932 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000933 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000934}
935
JF Bastiened92f602018-07-20 23:37:12 +0000936/// Decide whether we should use bzero plus some stores to initialize a local
937/// variable instead of using a memcpy from a constant global. It is beneficial
938/// to use bzero if the global is all zeros, or mostly zeros and large.
939static bool shouldUseBZeroPlusStoresToInitialize(llvm::Constant *Init,
940 uint64_t GlobalSize) {
941 // If a global is all zeros, always use a bzero.
Chris Lattnerb85025f2010-12-01 02:05:19 +0000942 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
943
Chris Lattnerb85025f2010-12-01 02:05:19 +0000944 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
945 // do it if it will require 6 or fewer scalar stores.
946 // TODO: Should budget depends on the size? Avoiding a large global warrants
947 // plopping in more stores.
948 unsigned StoreBudget = 6;
949 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000950
951 return GlobalSize > SizeLimit &&
JF Bastiened92f602018-07-20 23:37:12 +0000952 canEmitInitWithFewStoresAfterBZero(Init, StoreBudget);
Chris Lattnerb85025f2010-12-01 02:05:19 +0000953}
954
JF Bastien65089292018-07-25 04:29:03 +0000955/// Decide whether we should use memset to initialize a local variable instead
956/// of using a memcpy from a constant global. Assumes we've already decided to
957/// not user bzero.
958/// FIXME We could be more clever, as we are for bzero above, and generate
959/// memset followed by stores. It's unclear that's worth the effort.
JF Bastien2f0582f2018-09-21 13:54:09 +0000960static llvm::Value *shouldUseMemSetToInitialize(llvm::Constant *Init,
Vitaly Bukad03bd1d2019-07-10 22:53:52 +0000961 uint64_t GlobalSize,
962 const llvm::DataLayout &DL) {
JF Bastien65089292018-07-25 04:29:03 +0000963 uint64_t SizeLimit = 32;
964 if (GlobalSize <= SizeLimit)
JF Bastien2f0582f2018-09-21 13:54:09 +0000965 return nullptr;
Vitaly Bukad03bd1d2019-07-10 22:53:52 +0000966 return llvm::isBytewiseValue(Init, DL);
JF Bastien65089292018-07-25 04:29:03 +0000967}
968
JF Bastienb5e5bc72019-03-08 01:26:49 +0000969/// Decide whether we want to split a constant structure or array store into a
970/// sequence of its fields' stores. This may cost us code size and compilation
971/// speed, but plays better with store optimizations.
972static bool shouldSplitConstantStore(CodeGenModule &CGM,
973 uint64_t GlobalByteSize) {
974 // Don't break things that occupy more than one cacheline.
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +0000975 uint64_t ByteSizeLimit = 64;
976 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
977 return false;
978 if (GlobalByteSize <= ByteSizeLimit)
979 return true;
980 return false;
981}
982
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000983enum class IsPattern { No, Yes };
984
985/// Generate a constant filled with either a pattern or zeroes.
986static llvm::Constant *patternOrZeroFor(CodeGenModule &CGM, IsPattern isPattern,
987 llvm::Type *Ty) {
988 if (isPattern == IsPattern::Yes)
JF Bastienef202c32019-04-12 00:11:27 +0000989 return initializationPatternFor(CGM, Ty);
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000990 else
991 return llvm::Constant::getNullValue(Ty);
992}
993
994static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
995 llvm::Constant *constant);
996
997/// Helper function for constWithPadding() to deal with padding in structures.
998static llvm::Constant *constStructWithPadding(CodeGenModule &CGM,
999 IsPattern isPattern,
1000 llvm::StructType *STy,
1001 llvm::Constant *constant) {
1002 const llvm::DataLayout &DL = CGM.getDataLayout();
1003 const llvm::StructLayout *Layout = DL.getStructLayout(STy);
1004 llvm::Type *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext());
1005 unsigned SizeSoFar = 0;
1006 SmallVector<llvm::Constant *, 8> Values;
1007 bool NestedIntact = true;
1008 for (unsigned i = 0, e = STy->getNumElements(); i != e; i++) {
1009 unsigned CurOff = Layout->getElementOffset(i);
1010 if (SizeSoFar < CurOff) {
1011 assert(!STy->isPacked());
1012 auto *PadTy = llvm::ArrayType::get(Int8Ty, CurOff - SizeSoFar);
1013 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1014 }
1015 llvm::Constant *CurOp;
1016 if (constant->isZeroValue())
1017 CurOp = llvm::Constant::getNullValue(STy->getElementType(i));
1018 else
1019 CurOp = cast<llvm::Constant>(constant->getAggregateElement(i));
1020 auto *NewOp = constWithPadding(CGM, isPattern, CurOp);
1021 if (CurOp != NewOp)
1022 NestedIntact = false;
1023 Values.push_back(NewOp);
1024 SizeSoFar = CurOff + DL.getTypeAllocSize(CurOp->getType());
1025 }
1026 unsigned TotalSize = Layout->getSizeInBytes();
1027 if (SizeSoFar < TotalSize) {
1028 auto *PadTy = llvm::ArrayType::get(Int8Ty, TotalSize - SizeSoFar);
1029 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1030 }
1031 if (NestedIntact && Values.size() == STy->getNumElements())
1032 return constant;
Peter Collingbourne68b46732019-03-16 19:25:39 +00001033 return llvm::ConstantStruct::getAnon(Values, STy->isPacked());
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001034}
1035
1036/// Replace all padding bytes in a given constant with either a pattern byte or
1037/// 0x00.
1038static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1039 llvm::Constant *constant) {
1040 llvm::Type *OrigTy = constant->getType();
1041 if (const auto STy = dyn_cast<llvm::StructType>(OrigTy))
1042 return constStructWithPadding(CGM, isPattern, STy, constant);
1043 if (auto *STy = dyn_cast<llvm::SequentialType>(OrigTy)) {
1044 llvm::SmallVector<llvm::Constant *, 8> Values;
1045 unsigned Size = STy->getNumElements();
1046 if (!Size)
1047 return constant;
1048 llvm::Type *ElemTy = STy->getElementType();
1049 bool ZeroInitializer = constant->isZeroValue();
1050 llvm::Constant *OpValue, *PaddedOp;
1051 if (ZeroInitializer) {
1052 OpValue = llvm::Constant::getNullValue(ElemTy);
1053 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1054 }
1055 for (unsigned Op = 0; Op != Size; ++Op) {
1056 if (!ZeroInitializer) {
1057 OpValue = constant->getAggregateElement(Op);
1058 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1059 }
1060 Values.push_back(PaddedOp);
1061 }
1062 auto *NewElemTy = Values[0]->getType();
1063 if (NewElemTy == ElemTy)
1064 return constant;
1065 if (OrigTy->isArrayTy()) {
1066 auto *ArrayTy = llvm::ArrayType::get(NewElemTy, Size);
1067 return llvm::ConstantArray::get(ArrayTy, Values);
1068 } else {
1069 return llvm::ConstantVector::get(Values);
1070 }
1071 }
1072 return constant;
1073}
1074
Richard Smith24cdcad2019-06-14 17:46:37 +00001075Address CodeGenModule::createUnnamedGlobalFrom(const VarDecl &D,
1076 llvm::Constant *Constant,
1077 CharUnits Align) {
JF Bastien3a881e62018-11-15 00:19:18 +00001078 auto FunctionName = [&](const DeclContext *DC) -> std::string {
1079 if (const auto *FD = dyn_cast<FunctionDecl>(DC)) {
1080 if (const auto *CC = dyn_cast<CXXConstructorDecl>(FD))
1081 return CC->getNameAsString();
1082 if (const auto *CD = dyn_cast<CXXDestructorDecl>(FD))
1083 return CD->getNameAsString();
Richard Smith24cdcad2019-06-14 17:46:37 +00001084 return getMangledName(FD);
JF Bastien3a881e62018-11-15 00:19:18 +00001085 } else if (const auto *OM = dyn_cast<ObjCMethodDecl>(DC)) {
1086 return OM->getNameAsString();
Mikael Holmenee846762018-11-15 13:01:54 +00001087 } else if (isa<BlockDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001088 return "<block>";
Mikael Holmenee846762018-11-15 13:01:54 +00001089 } else if (isa<CapturedDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001090 return "<captured>";
1091 } else {
Richard Smith24cdcad2019-06-14 17:46:37 +00001092 llvm_unreachable("expected a function or method");
JF Bastien3a881e62018-11-15 00:19:18 +00001093 }
1094 };
1095
Richard Smith24cdcad2019-06-14 17:46:37 +00001096 // Form a simple per-variable cache of these values in case we find we
1097 // want to reuse them.
1098 llvm::GlobalVariable *&CacheEntry = InitializerConstants[&D];
1099 if (!CacheEntry || CacheEntry->getInitializer() != Constant) {
1100 auto *Ty = Constant->getType();
1101 bool isConstant = true;
1102 llvm::GlobalVariable *InsertBefore = nullptr;
1103 unsigned AS =
1104 getContext().getTargetAddressSpace(getStringLiteralAddressSpace());
1105 std::string Name;
1106 if (D.hasGlobalStorage())
1107 Name = getMangledName(&D).str() + ".const";
1108 else if (const DeclContext *DC = D.getParentFunctionOrMethod())
1109 Name = ("__const." + FunctionName(DC) + "." + D.getName()).str();
1110 else
1111 llvm_unreachable("local variable has no parent function or method");
1112 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
1113 getModule(), Ty, isConstant, llvm::GlobalValue::PrivateLinkage,
1114 Constant, Name, InsertBefore, llvm::GlobalValue::NotThreadLocal, AS);
1115 GV->setAlignment(Align.getQuantity());
1116 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1117 CacheEntry = GV;
1118 } else if (CacheEntry->getAlignment() < Align.getQuantity()) {
1119 CacheEntry->setAlignment(Align.getQuantity());
1120 }
JF Bastien3a881e62018-11-15 00:19:18 +00001121
Richard Smith24cdcad2019-06-14 17:46:37 +00001122 return Address(CacheEntry, Align);
1123}
1124
1125static Address createUnnamedGlobalForMemcpyFrom(CodeGenModule &CGM,
1126 const VarDecl &D,
1127 CGBuilderTy &Builder,
1128 llvm::Constant *Constant,
1129 CharUnits Align) {
1130 Address SrcPtr = CGM.createUnnamedGlobalFrom(D, Constant, Align);
1131 llvm::Type *BP = llvm::PointerType::getInt8PtrTy(CGM.getLLVMContext(),
1132 SrcPtr.getAddressSpace());
JF Bastien3a881e62018-11-15 00:19:18 +00001133 if (SrcPtr.getType() != BP)
1134 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
1135 return SrcPtr;
1136}
1137
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001138static void emitStoresForConstant(CodeGenModule &CGM, const VarDecl &D,
1139 Address Loc, bool isVolatile,
1140 CGBuilderTy &Builder,
1141 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001142 auto *Ty = constant->getType();
Vitaly Bukaf35a3452019-06-27 02:08:15 +00001143 uint64_t ConstantSize = CGM.getDataLayout().getTypeAllocSize(Ty);
1144 if (!ConstantSize)
1145 return;
1146
JF Bastienb5e5bc72019-03-08 01:26:49 +00001147 bool canDoSingleStore = Ty->isIntOrIntVectorTy() ||
1148 Ty->isPtrOrPtrVectorTy() || Ty->isFPOrFPVectorTy();
1149 if (canDoSingleStore) {
JF Bastien14daa202018-12-18 05:12:21 +00001150 Builder.CreateStore(constant, Loc, isVolatile);
1151 return;
1152 }
1153
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001154 auto *SizeVal = llvm::ConstantInt::get(CGM.IntPtrTy, ConstantSize);
JF Bastienb5e5bc72019-03-08 01:26:49 +00001155
1156 // If the initializer is all or mostly the same, codegen with bzero / memset
1157 // then do a few stores afterward.
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001158 if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) {
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001159 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, 0), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001160 isVolatile);
1161
1162 bool valueAlreadyCorrect =
1163 constant->isNullValue() || isa<llvm::UndefValue>(constant);
1164 if (!valueAlreadyCorrect) {
JF Bastien14daa202018-12-18 05:12:21 +00001165 Loc = Builder.CreateBitCast(Loc, Ty->getPointerTo(Loc.getAddressSpace()));
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001166 emitStoresForInitAfterBZero(CGM, constant, Loc, isVolatile, Builder);
1167 }
1168 return;
1169 }
1170
JF Bastienb5e5bc72019-03-08 01:26:49 +00001171 // If the initializer is a repeated byte pattern, use memset.
Vitaly Bukad03bd1d2019-07-10 22:53:52 +00001172 llvm::Value *Pattern =
1173 shouldUseMemSetToInitialize(constant, ConstantSize, CGM.getDataLayout());
JF Bastien2f0582f2018-09-21 13:54:09 +00001174 if (Pattern) {
1175 uint64_t Value = 0x00;
1176 if (!isa<llvm::UndefValue>(Pattern)) {
1177 const llvm::APInt &AP = cast<llvm::ConstantInt>(Pattern)->getValue();
1178 assert(AP.getBitWidth() <= 8);
1179 Value = AP.getLimitedValue();
1180 }
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001181 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, Value), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001182 isVolatile);
1183 return;
1184 }
1185
JF Bastienb5e5bc72019-03-08 01:26:49 +00001186 // If the initializer is small, use a handful of stores.
1187 if (shouldSplitConstantStore(CGM, ConstantSize)) {
1188 if (auto *STy = dyn_cast<llvm::StructType>(Ty)) {
1189 // FIXME: handle the case when STy != Loc.getElementType().
1190 if (STy == Loc.getElementType()) {
1191 for (unsigned i = 0; i != constant->getNumOperands(); i++) {
1192 Address EltPtr = Builder.CreateStructGEP(Loc, i);
1193 emitStoresForConstant(
1194 CGM, D, EltPtr, isVolatile, Builder,
1195 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1196 }
1197 return;
1198 }
1199 } else if (auto *ATy = dyn_cast<llvm::ArrayType>(Ty)) {
1200 // FIXME: handle the case when ATy != Loc.getElementType().
1201 if (ATy == Loc.getElementType()) {
1202 for (unsigned i = 0; i != ATy->getNumElements(); i++) {
1203 Address EltPtr = Builder.CreateConstArrayGEP(Loc, i);
1204 emitStoresForConstant(
1205 CGM, D, EltPtr, isVolatile, Builder,
1206 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1207 }
1208 return;
1209 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001210 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001211 }
1212
JF Bastienb5e5bc72019-03-08 01:26:49 +00001213 // Copy from a global.
Richard Smith24cdcad2019-06-14 17:46:37 +00001214 Builder.CreateMemCpy(Loc,
1215 createUnnamedGlobalForMemcpyFrom(
1216 CGM, D, Builder, constant, Loc.getAlignment()),
1217 SizeVal, isVolatile);
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001218}
1219
JF Bastien14daa202018-12-18 05:12:21 +00001220static void emitStoresForZeroInit(CodeGenModule &CGM, const VarDecl &D,
1221 Address Loc, bool isVolatile,
1222 CGBuilderTy &Builder) {
1223 llvm::Type *ElTy = Loc.getElementType();
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001224 llvm::Constant *constant =
1225 constWithPadding(CGM, IsPattern::No, llvm::Constant::getNullValue(ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001226 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1227}
1228
1229static void emitStoresForPatternInit(CodeGenModule &CGM, const VarDecl &D,
1230 Address Loc, bool isVolatile,
1231 CGBuilderTy &Builder) {
1232 llvm::Type *ElTy = Loc.getElementType();
JF Bastienef202c32019-04-12 00:11:27 +00001233 llvm::Constant *constant = constWithPadding(
1234 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001235 assert(!isa<llvm::UndefValue>(constant));
1236 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1237}
1238
1239static bool containsUndef(llvm::Constant *constant) {
1240 auto *Ty = constant->getType();
1241 if (isa<llvm::UndefValue>(constant))
1242 return true;
1243 if (Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy())
1244 for (llvm::Use &Op : constant->operands())
1245 if (containsUndef(cast<llvm::Constant>(Op)))
1246 return true;
1247 return false;
1248}
1249
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001250static llvm::Constant *replaceUndef(CodeGenModule &CGM, IsPattern isPattern,
1251 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001252 auto *Ty = constant->getType();
1253 if (isa<llvm::UndefValue>(constant))
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001254 return patternOrZeroFor(CGM, isPattern, Ty);
JF Bastien14daa202018-12-18 05:12:21 +00001255 if (!(Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()))
1256 return constant;
1257 if (!containsUndef(constant))
1258 return constant;
1259 llvm::SmallVector<llvm::Constant *, 8> Values(constant->getNumOperands());
1260 for (unsigned Op = 0, NumOp = constant->getNumOperands(); Op != NumOp; ++Op) {
1261 auto *OpValue = cast<llvm::Constant>(constant->getOperand(Op));
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001262 Values[Op] = replaceUndef(CGM, isPattern, OpValue);
JF Bastien14daa202018-12-18 05:12:21 +00001263 }
1264 if (Ty->isStructTy())
1265 return llvm::ConstantStruct::get(cast<llvm::StructType>(Ty), Values);
1266 if (Ty->isArrayTy())
1267 return llvm::ConstantArray::get(cast<llvm::ArrayType>(Ty), Values);
1268 assert(Ty->isVectorTy());
1269 return llvm::ConstantVector::get(Values);
1270}
1271
Nick Lewycky8a7d90b2010-12-30 20:21:55 +00001272/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +00001273/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +00001274/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +00001275void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
1276 AutoVarEmission emission = EmitAutoVarAlloca(D);
1277 EmitAutoVarInit(emission);
1278 EmitAutoVarCleanups(emission);
1279}
Chris Lattner03df1222007-06-02 04:53:11 +00001280
David Majnemerdc012fa2015-04-22 21:38:15 +00001281/// Emit a lifetime.begin marker if some criteria are satisfied.
1282/// \return a pointer to the temporary size Value if a marker was emitted, null
1283/// otherwise
1284llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
1285 llvm::Value *Addr) {
Vitaly Buka1c943322016-10-26 01:59:57 +00001286 if (!ShouldEmitLifetimeMarkers)
Reid Kleckner1ef49212015-04-23 18:07:13 +00001287 return nullptr;
1288
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001289 assert(Addr->getType()->getPointerAddressSpace() ==
1290 CGM.getDataLayout().getAllocaAddrSpace() &&
1291 "Pointer should be in alloca address space");
David Majnemerdc012fa2015-04-22 21:38:15 +00001292 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001293 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001294 llvm::CallInst *C =
1295 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001296 C->setDoesNotThrow();
1297 return SizeV;
1298}
1299
1300void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001301 assert(Addr->getType()->getPointerAddressSpace() ==
1302 CGM.getDataLayout().getAllocaAddrSpace() &&
1303 "Pointer should be in alloca address space");
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001304 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001305 llvm::CallInst *C =
1306 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001307 C->setDoesNotThrow();
1308}
1309
Sander de Smalen891af03a2018-02-03 13:55:59 +00001310void CodeGenFunction::EmitAndRegisterVariableArrayDimensions(
1311 CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) {
1312 // For each dimension stores its QualType and corresponding
1313 // size-expression Value.
1314 SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions;
Adrian Prantla40cce82018-11-09 19:17:56 +00001315 SmallVector<IdentifierInfo *, 4> VLAExprNames;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001316
1317 // Break down the array into individual dimensions.
1318 QualType Type1D = D.getType();
1319 while (getContext().getAsVariableArrayType(Type1D)) {
1320 auto VlaSize = getVLAElements1D(Type1D);
1321 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1322 Dimensions.emplace_back(C, Type1D.getUnqualifiedType());
1323 else {
Adrian Prantla40cce82018-11-09 19:17:56 +00001324 // Generate a locally unique name for the size expression.
1325 Twine Name = Twine("__vla_expr") + Twine(VLAExprCounter++);
1326 SmallString<12> Buffer;
1327 StringRef NameRef = Name.toStringRef(Buffer);
1328 auto &Ident = getContext().Idents.getOwn(NameRef);
1329 VLAExprNames.push_back(&Ident);
1330 auto SizeExprAddr =
1331 CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), NameRef);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001332 Builder.CreateStore(VlaSize.NumElts, SizeExprAddr);
1333 Dimensions.emplace_back(SizeExprAddr.getPointer(),
1334 Type1D.getUnqualifiedType());
1335 }
1336 Type1D = VlaSize.Type;
1337 }
1338
1339 if (!EmitDebugInfo)
1340 return;
1341
1342 // Register each dimension's size-expression with a DILocalVariable,
1343 // so that it can be used by CGDebugInfo when instantiating a DISubrange
1344 // to describe this array.
Adrian Prantla40cce82018-11-09 19:17:56 +00001345 unsigned NameIdx = 0;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001346 for (auto &VlaSize : Dimensions) {
1347 llvm::Metadata *MD;
1348 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1349 MD = llvm::ConstantAsMetadata::get(C);
1350 else {
1351 // Create an artificial VarDecl to generate debug info for.
Adrian Prantla40cce82018-11-09 19:17:56 +00001352 IdentifierInfo *NameIdent = VLAExprNames[NameIdx++];
Sander de Smalen891af03a2018-02-03 13:55:59 +00001353 auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType();
1354 auto QT = getContext().getIntTypeForBitwidth(
1355 VlaExprTy->getScalarSizeInBits(), false);
1356 auto *ArtificialDecl = VarDecl::Create(
1357 getContext(), const_cast<DeclContext *>(D.getDeclContext()),
Adrian Prantla40cce82018-11-09 19:17:56 +00001358 D.getLocation(), D.getLocation(), NameIdent, QT,
Sander de Smalen891af03a2018-02-03 13:55:59 +00001359 getContext().CreateTypeSourceInfo(QT), SC_Auto);
Sander de Smalen9084a3b2018-02-13 07:49:34 +00001360 ArtificialDecl->setImplicit();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001361
1362 MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts,
1363 Builder);
1364 }
1365 assert(MD && "No Size expression debug node created");
1366 DI->registerVLASizeExpression(VlaSize.Type, MD);
1367 }
1368}
1369
John McCallc533cb72011-02-22 06:44:22 +00001370/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001371/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +00001372CodeGenFunction::AutoVarEmission
1373CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
1374 QualType Ty = D.getType();
Yaxun Liub7318e02017-10-13 03:37:48 +00001375 assert(
1376 Ty.getAddressSpace() == LangAS::Default ||
1377 (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL));
John McCallc533cb72011-02-22 06:44:22 +00001378
1379 AutoVarEmission emission(D);
1380
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001381 bool isEscapingByRef = D.isEscapingByref();
1382 emission.IsEscapingByRef = isEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00001383
1384 CharUnits alignment = getContext().getDeclAlign(&D);
John McCallc533cb72011-02-22 06:44:22 +00001385
John McCall23c29fe2011-06-24 21:55:10 +00001386 // If the type is variably-modified, emit all the VLA sizes for it.
1387 if (Ty->isVariablyModifiedType())
1388 EmitVariablyModifiedType(Ty);
1389
Sander de Smalen891af03a2018-02-03 13:55:59 +00001390 auto *DI = getDebugInfo();
1391 bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >=
1392 codegenoptions::LimitedDebugInfo;
1393
John McCall7f416cc2015-09-08 08:05:57 +00001394 Address address = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001395 Address AllocaAddr = Address::invalid();
Alexey Bataev9c397812019-04-03 17:57:06 +00001396 Address OpenMPLocalAddr =
1397 getLangOpts().OpenMP
1398 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
1399 : Address::invalid();
Amy Huang7fac5c82019-06-20 17:15:21 +00001400 bool NRVO = getLangOpts().ElideConstructors && D.isNRVOVariable();
1401
Alexey Bataev9c397812019-04-03 17:57:06 +00001402 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
1403 address = OpenMPLocalAddr;
1404 } else if (Ty->isConstantSizeType()) {
Richard Smith2bcde3a2013-06-02 00:09:52 +00001405 // If this value is an array or struct with a statically determinable
1406 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +00001407 //
1408 // TODO: We should constant-evaluate the initializer of any variable,
1409 // as long as it is initialized by a constant expression. Currently,
1410 // isConstantInitializer produces wrong answers for structs with
1411 // reference or bitfield members, and a few other cases, and checking
1412 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +00001413 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
1414 (D.isConstexpr() ||
1415 ((Ty.isPODType(getContext()) ||
1416 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
1417 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +00001418
Rafael Espindola609f5d92013-03-26 18:41:47 +00001419 // If the variable's a const type, and it's neither an NRVO
1420 // candidate nor a __block variable and has no mutable members,
1421 // emit it as a global instead.
Anastasia Stulovae4a1c382016-11-29 17:01:19 +00001422 // Exception is if a variable is located in non-constant address space
1423 // in OpenCL.
1424 if ((!getLangOpts().OpenCL ||
1425 Ty.getAddressSpace() == LangAS::opencl_constant) &&
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001426 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO &&
1427 !isEscapingByRef && CGM.isTypeConstant(Ty, true))) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001428 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +00001429
John McCall7f416cc2015-09-08 08:05:57 +00001430 // Signal this condition to later callbacks.
1431 emission.Addr = Address::invalid();
Rafael Espindola609f5d92013-03-26 18:41:47 +00001432 assert(emission.wasEmittedAsGlobal());
1433 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +00001434 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001435
Rafael Espindola609f5d92013-03-26 18:41:47 +00001436 // Otherwise, tell the initialization code that we're in this case.
1437 emission.IsConstantAggregate = true;
1438 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001439
Rafael Espindola609f5d92013-03-26 18:41:47 +00001440 // A normal fixed sized variable becomes an alloca in the entry block,
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001441 // unless:
1442 // - it's an NRVO variable.
1443 // - we are compiling OpenMP and it's an OpenMP local variable.
Alexey Bataev9c397812019-04-03 17:57:06 +00001444 if (NRVO) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001445 // The named return value optimization: allocate this variable in the
1446 // return slot, so that we can elide the copy when returning this
1447 // variable (C++0x [class.copy]p34).
John McCall7f416cc2015-09-08 08:05:57 +00001448 address = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +00001449
Rafael Espindola609f5d92013-03-26 18:41:47 +00001450 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001451 const auto *RD = RecordTy->getDecl();
1452 const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1453 if ((CXXRD && !CXXRD->hasTrivialDestructor()) ||
1454 RD->isNonTrivialToPrimitiveDestroy()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001455 // Create a flag that is used to indicate when the NRVO was applied
1456 // to this variable. Set it to zero to indicate that NRVO was not
1457 // applied.
1458 llvm::Value *Zero = Builder.getFalse();
John McCall7f416cc2015-09-08 08:05:57 +00001459 Address NRVOFlag =
1460 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
Rafael Espindola609f5d92013-03-26 18:41:47 +00001461 EnsureInsertPoint();
1462 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +00001463
Rafael Espindola609f5d92013-03-26 18:41:47 +00001464 // Record the NRVO flag for this variable.
John McCall7f416cc2015-09-08 08:05:57 +00001465 NRVOFlags[&D] = NRVOFlag.getPointer();
1466 emission.NRVOFlag = NRVOFlag.getPointer();
Nadav Rotem1da30942013-03-23 06:43:35 +00001467 }
Douglas Gregor290c93e2010-05-15 06:46:45 +00001468 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001469 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001470 CharUnits allocaAlignment;
1471 llvm::Type *allocaTy;
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001472 if (isEscapingByRef) {
John McCall7f416cc2015-09-08 08:05:57 +00001473 auto &byrefInfo = getBlockByrefInfo(&D);
1474 allocaTy = byrefInfo.Type;
1475 allocaAlignment = byrefInfo.ByrefAlignment;
1476 } else {
1477 allocaTy = ConvertTypeForMem(Ty);
1478 allocaAlignment = alignment;
1479 }
Rafael Espindola609f5d92013-03-26 18:41:47 +00001480
John McCall999110f2015-09-08 09:18:30 +00001481 // Create the alloca. Note that we set the name separately from
1482 // building the instruction so that it's there even in no-asserts
1483 // builds.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001484 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName(),
1485 /*ArraySize=*/nullptr, &AllocaAddr);
Rafael Espindola609f5d92013-03-26 18:41:47 +00001486
Reid Kleckner1f88e932015-10-07 21:03:41 +00001487 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1488 // the catch parameter starts in the catchpad instruction, and we can't
1489 // insert code in those basic blocks.
1490 bool IsMSCatchParam =
1491 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1492
Vitaly Buka64c80b42016-10-26 05:42:30 +00001493 // Emit a lifetime intrinsic if meaningful. There's no point in doing this
1494 // if we don't have a valid insertion point (?).
Reid Kleckner1f88e932015-10-07 21:03:41 +00001495 if (HaveInsertPoint() && !IsMSCatchParam) {
Akira Hatanakafdcd18b2017-01-25 22:55:13 +00001496 // If there's a jump into the lifetime of this variable, its lifetime
1497 // gets broken up into several regions in IR, which requires more work
1498 // to handle correctly. For now, just omit the intrinsics; this is a
1499 // rare case, and it's better to just be conservatively correct.
1500 // PR28267.
1501 //
1502 // We have to do this in all language modes if there's a jump past the
1503 // declaration. We also have to do it in C if there's a jump to an
1504 // earlier point in the current block because non-VLA lifetimes begin as
1505 // soon as the containing block is entered, not when its variables
1506 // actually come into scope; suppressing the lifetime annotations
1507 // completely in this case is unnecessarily pessimistic, but again, this
1508 // is rare.
1509 if (!Bypasses.IsBypassed(&D) &&
1510 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) {
Vitaly Buka64c80b42016-10-26 05:42:30 +00001511 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1512 emission.SizeForLifetimeMarkers =
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001513 EmitLifetimeStart(size, AllocaAddr.getPointer());
Vitaly Buka64c80b42016-10-26 05:42:30 +00001514 }
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001515 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001516 assert(!emission.useLifetimeMarkers());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001517 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001518 }
Chris Lattner03df1222007-06-02 04:53:11 +00001519 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001520 EnsureInsertPoint();
1521
Anders Carlsson15949b32009-02-09 20:41:50 +00001522 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +00001523 // Save the stack.
John McCall7f416cc2015-09-08 08:05:57 +00001524 Address Stack =
1525 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +00001526
James Y Knight8799cae2019-02-03 21:53:49 +00001527 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie4ba525b2015-07-14 17:27:39 +00001528 llvm::Value *V = Builder.CreateCall(F);
Anders Carlsson30032882008-12-12 07:38:43 +00001529 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +00001530
1531 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +00001532
John McCalla464ff92010-07-21 06:13:08 +00001533 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +00001534 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001535 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +00001536 }
Mike Stump11289f42009-09-09 15:08:12 +00001537
Sander de Smalen891af03a2018-02-03 13:55:59 +00001538 auto VlaSize = getVLASize(Ty);
1539 llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type);
Anders Carlsson30032882008-12-12 07:38:43 +00001540
1541 // Allocate memory for the array.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001542 address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts,
1543 &AllocaAddr);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001544
1545 // If we have debug info enabled, properly describe the VLA dimensions for
1546 // this type by registering the vla size expression for each of the
1547 // dimensions.
1548 EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo);
Chris Lattner03df1222007-06-02 04:53:11 +00001549 }
Eli Friedmanf4084702008-12-20 23:11:59 +00001550
John McCall7f416cc2015-09-08 08:05:57 +00001551 setAddrOfLocalVar(&D, address);
1552 emission.Addr = address;
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001553 emission.AllocaAddr = AllocaAddr;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001554
1555 // Emit debug info for local var declaration.
Sander de Smalen891af03a2018-02-03 13:55:59 +00001556 if (EmitDebugInfo && HaveInsertPoint()) {
Amy Huang7fac5c82019-06-20 17:15:21 +00001557 Address DebugAddr = address;
1558 bool UsePointerValue = NRVO && ReturnValuePointer.isValid();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001559 DI->setLocation(D.getLocation());
Amy Huang7fac5c82019-06-20 17:15:21 +00001560
1561 // If NRVO, use a pointer to the return address.
1562 if (UsePointerValue)
1563 DebugAddr = ReturnValuePointer;
1564
1565 (void)DI->EmitDeclareOfAutoVariable(&D, DebugAddr.getPointer(), Builder,
1566 UsePointerValue);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001567 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001568
Volodymyr Sapsai93317d82019-03-01 02:15:39 +00001569 if (D.hasAttr<AnnotateAttr>() && HaveInsertPoint())
John McCall7f416cc2015-09-08 08:05:57 +00001570 EmitVarAnnotations(&D, address.getPointer());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001571
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001572 // Make sure we call @llvm.lifetime.end.
1573 if (emission.useLifetimeMarkers())
1574 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker,
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001575 emission.getOriginalAllocatedAddress(),
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001576 emission.getSizeForLifetimeMarkers());
1577
John McCallc533cb72011-02-22 06:44:22 +00001578 return emission;
1579}
1580
JF Bastien6b239722018-05-19 04:21:26 +00001581static bool isCapturedBy(const VarDecl &, const Expr *);
1582
1583/// Determines whether the given __block variable is potentially
1584/// captured by the given statement.
1585static bool isCapturedBy(const VarDecl &Var, const Stmt *S) {
1586 if (const Expr *E = dyn_cast<Expr>(S))
1587 return isCapturedBy(Var, E);
1588 for (const Stmt *SubStmt : S->children())
1589 if (isCapturedBy(Var, SubStmt))
1590 return true;
1591 return false;
1592}
1593
John McCallc533cb72011-02-22 06:44:22 +00001594/// Determines whether the given __block variable is potentially
1595/// captured by the given expression.
JF Bastien6b239722018-05-19 04:21:26 +00001596static bool isCapturedBy(const VarDecl &Var, const Expr *E) {
John McCallc533cb72011-02-22 06:44:22 +00001597 // Skip the most common kinds of expressions that make
1598 // hierarchy-walking expensive.
JF Bastien6b239722018-05-19 04:21:26 +00001599 E = E->IgnoreParenCasts();
John McCallc533cb72011-02-22 06:44:22 +00001600
JF Bastien6b239722018-05-19 04:21:26 +00001601 if (const BlockExpr *BE = dyn_cast<BlockExpr>(E)) {
1602 const BlockDecl *Block = BE->getBlockDecl();
1603 for (const auto &I : Block->captures()) {
1604 if (I.getVariable() == &Var)
John McCallc533cb72011-02-22 06:44:22 +00001605 return true;
1606 }
1607
1608 // No need to walk into the subexpressions.
1609 return false;
1610 }
1611
JF Bastien6b239722018-05-19 04:21:26 +00001612 if (const StmtExpr *SE = dyn_cast<StmtExpr>(E)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001613 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001614 for (const auto *BI : CS->body())
JF Bastien6b239722018-05-19 04:21:26 +00001615 if (const auto *BIE = dyn_cast<Expr>(BI)) {
1616 if (isCapturedBy(Var, BIE))
1617 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001618 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001619 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001620 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001621 for (const auto *I : DS->decls()) {
1622 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1623 const Expr *Init = VD->getInit();
JF Bastien6b239722018-05-19 04:21:26 +00001624 if (Init && isCapturedBy(Var, Init))
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001625 return true;
1626 }
1627 }
1628 }
1629 else
1630 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1631 // Later, provide code to poke into statements for capture analysis.
1632 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001633 return false;
1634 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001635
JF Bastien6b239722018-05-19 04:21:26 +00001636 for (const Stmt *SubStmt : E->children())
1637 if (isCapturedBy(Var, SubStmt))
John McCallc533cb72011-02-22 06:44:22 +00001638 return true;
1639
1640 return false;
1641}
1642
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001643/// Determine whether the given initializer is trivial in the sense
Douglas Gregor82e1af22011-07-01 21:08:19 +00001644/// that it requires no code to be generated.
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001645bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
Douglas Gregor82e1af22011-07-01 21:08:19 +00001646 if (!Init)
1647 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001648
Douglas Gregor82e1af22011-07-01 21:08:19 +00001649 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1650 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1651 if (Constructor->isTrivial() &&
1652 Constructor->isDefaultConstructor() &&
1653 !Construct->requiresZeroInitialization())
1654 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001655
Douglas Gregor82e1af22011-07-01 21:08:19 +00001656 return false;
1657}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001658
Vitaly Bukae7267662019-07-10 22:53:50 +00001659void CodeGenFunction::emitZeroOrPatternForAutoVarInit(QualType type,
1660 const VarDecl &D,
1661 Address Loc) {
1662 auto trivialAutoVarInit = getContext().getLangOpts().getTrivialAutoVarInit();
1663 CharUnits Size = getContext().getTypeSizeInChars(type);
1664 bool isVolatile = type.isVolatileQualified();
1665 if (!Size.isZero()) {
1666 switch (trivialAutoVarInit) {
1667 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1668 llvm_unreachable("Uninitialized handled by caller");
1669 case LangOptions::TrivialAutoVarInitKind::Zero:
1670 emitStoresForZeroInit(CGM, D, Loc, isVolatile, Builder);
1671 break;
1672 case LangOptions::TrivialAutoVarInitKind::Pattern:
1673 emitStoresForPatternInit(CGM, D, Loc, isVolatile, Builder);
1674 break;
1675 }
1676 return;
1677 }
1678
1679 // VLAs look zero-sized to getTypeInfo. We can't emit constant stores to
1680 // them, so emit a memcpy with the VLA size to initialize each element.
1681 // Technically zero-sized or negative-sized VLAs are undefined, and UBSan
1682 // will catch that code, but there exists code which generates zero-sized
1683 // VLAs. Be nice and initialize whatever they requested.
1684 const auto *VlaType = getContext().getAsVariableArrayType(type);
1685 if (!VlaType)
1686 return;
1687 auto VlaSize = getVLASize(VlaType);
1688 auto SizeVal = VlaSize.NumElts;
1689 CharUnits EltSize = getContext().getTypeSizeInChars(VlaSize.Type);
1690 switch (trivialAutoVarInit) {
1691 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1692 llvm_unreachable("Uninitialized handled by caller");
1693
1694 case LangOptions::TrivialAutoVarInitKind::Zero:
1695 if (!EltSize.isOne())
1696 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1697 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1698 isVolatile);
1699 break;
1700
1701 case LangOptions::TrivialAutoVarInitKind::Pattern: {
1702 llvm::Type *ElTy = Loc.getElementType();
1703 llvm::Constant *Constant = constWithPadding(
1704 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
1705 CharUnits ConstantAlign = getContext().getTypeAlignInChars(VlaSize.Type);
1706 llvm::BasicBlock *SetupBB = createBasicBlock("vla-setup.loop");
1707 llvm::BasicBlock *LoopBB = createBasicBlock("vla-init.loop");
1708 llvm::BasicBlock *ContBB = createBasicBlock("vla-init.cont");
1709 llvm::Value *IsZeroSizedVLA = Builder.CreateICmpEQ(
1710 SizeVal, llvm::ConstantInt::get(SizeVal->getType(), 0),
1711 "vla.iszerosized");
1712 Builder.CreateCondBr(IsZeroSizedVLA, ContBB, SetupBB);
1713 EmitBlock(SetupBB);
1714 if (!EltSize.isOne())
1715 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1716 llvm::Value *BaseSizeInChars =
1717 llvm::ConstantInt::get(IntPtrTy, EltSize.getQuantity());
1718 Address Begin = Builder.CreateElementBitCast(Loc, Int8Ty, "vla.begin");
1719 llvm::Value *End =
1720 Builder.CreateInBoundsGEP(Begin.getPointer(), SizeVal, "vla.end");
1721 llvm::BasicBlock *OriginBB = Builder.GetInsertBlock();
1722 EmitBlock(LoopBB);
1723 llvm::PHINode *Cur = Builder.CreatePHI(Begin.getType(), 2, "vla.cur");
1724 Cur->addIncoming(Begin.getPointer(), OriginBB);
1725 CharUnits CurAlign = Loc.getAlignment().alignmentOfArrayElement(EltSize);
1726 Builder.CreateMemCpy(Address(Cur, CurAlign),
1727 createUnnamedGlobalForMemcpyFrom(
1728 CGM, D, Builder, Constant, ConstantAlign),
1729 BaseSizeInChars, isVolatile);
1730 llvm::Value *Next =
1731 Builder.CreateInBoundsGEP(Int8Ty, Cur, BaseSizeInChars, "vla.next");
1732 llvm::Value *Done = Builder.CreateICmpEQ(Next, End, "vla-init.isdone");
1733 Builder.CreateCondBr(Done, ContBB, LoopBB);
1734 Cur->addIncoming(Next, LoopBB);
1735 EmitBlock(ContBB);
1736 } break;
1737 }
1738}
1739
John McCallc533cb72011-02-22 06:44:22 +00001740void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001741 assert(emission.Variable && "emission was not valid!");
1742
John McCallc533cb72011-02-22 06:44:22 +00001743 // If this was emitted as a global constant, we're done.
1744 if (emission.wasEmittedAsGlobal()) return;
1745
John McCall9e2e22f2011-02-22 07:16:58 +00001746 const VarDecl &D = *emission.Variable;
Adrian Prantl95b24e92015-02-03 20:00:54 +00001747 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
John McCallc533cb72011-02-22 06:44:22 +00001748 QualType type = D.getType();
1749
Chris Lattner07eb7332007-07-12 00:39:48 +00001750 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001751 const Expr *Init = D.getInit();
1752
1753 // If we are at an unreachable point, we don't need to emit the initializer
1754 // unless it contains a label.
1755 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001756 if (!Init || !ContainsLabel(Init)) return;
1757 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001758 }
1759
John McCall73064872011-03-31 01:59:53 +00001760 // Initialize the structure of a __block variable.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001761 if (emission.IsEscapingByRef)
John McCall73064872011-03-31 01:59:53 +00001762 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001763
Akira Hatanaka7275da02018-02-28 07:15:55 +00001764 // Initialize the variable here if it doesn't have a initializer and it is a
1765 // C struct that is non-trivial to initialize or an array containing such a
1766 // struct.
1767 if (!Init &&
1768 type.isNonTrivialToPrimitiveDefaultInitialize() ==
1769 QualType::PDIK_Struct) {
1770 LValue Dst = MakeAddrLValue(emission.getAllocatedAddress(), type);
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001771 if (emission.IsEscapingByRef)
Akira Hatanaka7275da02018-02-28 07:15:55 +00001772 drillIntoBlockVariable(*this, Dst, &D);
1773 defaultInitNonTrivialCStructVar(Dst);
1774 return;
1775 }
1776
John McCallc533cb72011-02-22 06:44:22 +00001777 // Check whether this is a byref variable that's potentially
1778 // captured and moved by its own initializer. If so, we'll need to
1779 // emit the initializer first, then copy into the variable.
JF Bastien14daa202018-12-18 05:12:21 +00001780 bool capturedByInit =
1781 Init && emission.IsEscapingByRef && isCapturedBy(D, Init);
John McCallc533cb72011-02-22 06:44:22 +00001782
JF Bastien0bae08a2019-02-15 17:26:29 +00001783 bool locIsByrefHeader = !capturedByInit;
1784 const Address Loc =
1785 locIsByrefHeader ? emission.getObjectAddress(*this) : emission.Addr;
JF Bastien14daa202018-12-18 05:12:21 +00001786
1787 // Note: constexpr already initializes everything correctly.
1788 LangOptions::TrivialAutoVarInitKind trivialAutoVarInit =
1789 (D.isConstexpr()
1790 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1791 : (D.getAttr<UninitializedAttr>()
1792 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1793 : getContext().getLangOpts().getTrivialAutoVarInit()));
1794
JF Bastienb347e752019-02-08 01:29:17 +00001795 auto initializeWhatIsTechnicallyUninitialized = [&](Address Loc) {
JF Bastien14daa202018-12-18 05:12:21 +00001796 if (trivialAutoVarInit ==
1797 LangOptions::TrivialAutoVarInitKind::Uninitialized)
1798 return;
1799
JF Bastienb347e752019-02-08 01:29:17 +00001800 // Only initialize a __block's storage: we always initialize the header.
JF Bastien0bae08a2019-02-15 17:26:29 +00001801 if (emission.IsEscapingByRef && !locIsByrefHeader)
JF Bastienb347e752019-02-08 01:29:17 +00001802 Loc = emitBlockByrefAddress(Loc, &D, /*follow=*/false);
1803
Vitaly Bukae7267662019-07-10 22:53:50 +00001804 return emitZeroOrPatternForAutoVarInit(type, D, Loc);
JF Bastien14daa202018-12-18 05:12:21 +00001805 };
1806
Vitaly Bukae7267662019-07-10 22:53:50 +00001807 if (isTrivialInitializer(Init))
1808 return initializeWhatIsTechnicallyUninitialized(Loc);
John McCallc533cb72011-02-22 06:44:22 +00001809
Craig Topper8a13c412014-05-21 05:09:00 +00001810 llvm::Constant *constant = nullptr;
Richard Smith715f7a12019-06-11 17:50:32 +00001811 if (emission.IsConstantAggregate ||
1812 D.mightBeUsableInConstantExpressions(getContext())) {
Richard Smithfddd3842011-12-30 21:15:51 +00001813 assert(!capturedByInit && "constant init contains a capturing block?");
John McCallde0fe072017-08-15 21:42:52 +00001814 constant = ConstantEmitter(*this).tryEmitAbstractForInitializer(D);
JF Bastiend39fbc72019-04-30 22:56:53 +00001815 if (constant && !constant->isZeroValue() &&
1816 (trivialAutoVarInit !=
1817 LangOptions::TrivialAutoVarInitKind::Uninitialized)) {
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001818 IsPattern isPattern =
1819 (trivialAutoVarInit == LangOptions::TrivialAutoVarInitKind::Pattern)
1820 ? IsPattern::Yes
1821 : IsPattern::No;
JF Bastiend39fbc72019-04-30 22:56:53 +00001822 // C guarantees that brace-init with fewer initializers than members in
1823 // the aggregate will initialize the rest of the aggregate as-if it were
1824 // static initialization. In turn static initialization guarantees that
1825 // padding is initialized to zero bits. We could instead pattern-init if D
1826 // has any ImplicitValueInitExpr, but that seems to be unintuitive
1827 // behavior.
1828 constant = constWithPadding(CGM, IsPattern::No,
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001829 replaceUndef(CGM, isPattern, constant));
1830 }
Richard Smithfddd3842011-12-30 21:15:51 +00001831 }
1832
1833 if (!constant) {
JF Bastienb347e752019-02-08 01:29:17 +00001834 initializeWhatIsTechnicallyUninitialized(Loc);
John McCall7f416cc2015-09-08 08:05:57 +00001835 LValue lv = MakeAddrLValue(Loc, type);
John McCall1553b192011-06-16 04:16:24 +00001836 lv.setNonGC(true);
David Blaikie66e41972015-01-14 07:38:27 +00001837 return EmitExprAsInit(Init, &D, lv, capturedByInit);
John McCall1553b192011-06-16 04:16:24 +00001838 }
John McCall91ca10f2011-03-08 09:11:50 +00001839
Richard Smith2bcde3a2013-06-02 00:09:52 +00001840 if (!emission.IsConstantAggregate) {
1841 // For simple scalar/complex initialization, store the value directly.
John McCall7f416cc2015-09-08 08:05:57 +00001842 LValue lv = MakeAddrLValue(Loc, type);
Richard Smith2bcde3a2013-06-02 00:09:52 +00001843 lv.setNonGC(true);
1844 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1845 }
1846
Yaxun Liudaceb1e2018-05-14 19:20:12 +00001847 llvm::Type *BP = CGM.Int8Ty->getPointerTo(Loc.getAddressSpace());
JF Bastien0bae08a2019-02-15 17:26:29 +00001848 emitStoresForConstant(
1849 CGM, D, (Loc.getType() == BP) ? Loc : Builder.CreateBitCast(Loc, BP),
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001850 type.isVolatileQualified(), Builder, constant);
John McCall91ca10f2011-03-08 09:11:50 +00001851}
1852
Richard Smithe78fac52018-04-05 20:52:58 +00001853/// Emit an expression as an initializer for an object (variable, field, etc.)
1854/// at the given location. The expression is not necessarily the normal
1855/// initializer for the object, and the address is not necessarily
John McCall91ca10f2011-03-08 09:11:50 +00001856/// its normal location.
1857///
1858/// \param init the initializing expression
Richard Smithe78fac52018-04-05 20:52:58 +00001859/// \param D the object to act as if we're initializing
John McCall91ca10f2011-03-08 09:11:50 +00001860/// \param loc the address to initialize; its type is a pointer
Richard Smithe78fac52018-04-05 20:52:58 +00001861/// to the LLVM mapping of the object's type
John McCall91ca10f2011-03-08 09:11:50 +00001862/// \param alignment the alignment of the address
Richard Smithe78fac52018-04-05 20:52:58 +00001863/// \param capturedByInit true if \p D is a __block variable
John McCall91ca10f2011-03-08 09:11:50 +00001864/// whose address is potentially changed by the initializer
David Blaikie73ca5692014-12-09 00:32:22 +00001865void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +00001866 LValue lvalue, bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001867 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001868
1869 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001870 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001871 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001872 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001873 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001874 return;
1875 }
1876 switch (getEvaluationKind(type)) {
1877 case TEK_Scalar:
David Blaikie66e41972015-01-14 07:38:27 +00001878 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001879 return;
1880 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001881 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001882 if (capturedByInit)
1883 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001884 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
John McCall47fb9502013-03-07 21:37:08 +00001885 return;
1886 }
1887 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001888 if (type->isAtomicType()) {
1889 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1890 } else {
Richard Smithe78fac52018-04-05 20:52:58 +00001891 AggValueSlot::Overlap_t Overlap = AggValueSlot::MayOverlap;
1892 if (isa<VarDecl>(D))
1893 Overlap = AggValueSlot::DoesNotOverlap;
1894 else if (auto *FD = dyn_cast<FieldDecl>(D))
Richard Smith8cca3a52019-06-20 20:56:20 +00001895 Overlap = getOverlapForFieldInit(FD);
John McCalla8ec7eb2013-03-07 21:37:17 +00001896 // TODO: how can we delay here if D is captured by its initializer?
1897 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001898 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001899 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001900 AggValueSlot::IsNotAliased,
1901 Overlap));
John McCalla8ec7eb2013-03-07 21:37:17 +00001902 }
John McCall47fb9502013-03-07 21:37:08 +00001903 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001904 }
John McCall47fb9502013-03-07 21:37:08 +00001905 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001906}
John McCallbd309292010-07-06 01:34:17 +00001907
John McCall82fe67b2011-07-09 01:37:26 +00001908/// Enter a destroy cleanup for the given local variable.
1909void CodeGenFunction::emitAutoVarTypeCleanup(
1910 const CodeGenFunction::AutoVarEmission &emission,
1911 QualType::DestructionKind dtorKind) {
1912 assert(dtorKind != QualType::DK_none);
1913
1914 // Note that for __block variables, we want to destroy the
1915 // original stack object, not the possibly forwarded object.
John McCall7f416cc2015-09-08 08:05:57 +00001916 Address addr = emission.getObjectAddress(*this);
John McCall82fe67b2011-07-09 01:37:26 +00001917
1918 const VarDecl *var = emission.Variable;
1919 QualType type = var->getType();
1920
1921 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001922 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001923
1924 switch (dtorKind) {
1925 case QualType::DK_none:
1926 llvm_unreachable("no cleanup for trivially-destructible variable");
1927
1928 case QualType::DK_cxx_destructor:
1929 // If there's an NRVO flag on the emission, we need a different
1930 // cleanup.
1931 if (emission.NRVOFlag) {
1932 assert(!type->isArrayType());
1933 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
Marco Antognini88559632019-07-22 09:39:13 +00001934 EHStack.pushCleanup<DestroyNRVOVariableCXX>(cleanupKind, addr, type, dtor,
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001935 emission.NRVOFlag);
John McCall82fe67b2011-07-09 01:37:26 +00001936 return;
1937 }
1938 break;
1939
1940 case QualType::DK_objc_strong_lifetime:
1941 // Suppress cleanups for pseudo-strong variables.
1942 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001943
John McCall82fe67b2011-07-09 01:37:26 +00001944 // Otherwise, consider whether to use an EH cleanup or not.
1945 cleanupKind = getARCCleanupKind();
1946
1947 // Use the imprecise destroyer by default.
1948 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1949 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1950 break;
1951
1952 case QualType::DK_objc_weak_lifetime:
1953 break;
Akira Hatanaka7275da02018-02-28 07:15:55 +00001954
1955 case QualType::DK_nontrivial_c_struct:
1956 destroyer = CodeGenFunction::destroyNonTrivialCStruct;
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001957 if (emission.NRVOFlag) {
1958 assert(!type->isArrayType());
1959 EHStack.pushCleanup<DestroyNRVOVariableC>(cleanupKind, addr,
1960 emission.NRVOFlag, type);
1961 return;
1962 }
Akira Hatanaka7275da02018-02-28 07:15:55 +00001963 break;
John McCall82fe67b2011-07-09 01:37:26 +00001964 }
1965
1966 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001967 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001968
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001969 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001970 // is being pushed as an EH cleanup.
1971 bool useEHCleanup = (cleanupKind & EHCleanup);
1972 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1973 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001974}
1975
John McCallc533cb72011-02-22 06:44:22 +00001976void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001977 assert(emission.Variable && "emission was not valid!");
1978
John McCallc533cb72011-02-22 06:44:22 +00001979 // If this was emitted as a global constant, we're done.
1980 if (emission.wasEmittedAsGlobal()) return;
1981
John McCall8c38d352012-04-13 18:44:05 +00001982 // If we don't have an insertion point, we're done. Sema prevents
1983 // us from jumping into any of these scopes anyway.
1984 if (!HaveInsertPoint()) return;
1985
John McCall9e2e22f2011-02-22 07:16:58 +00001986 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001987
John McCall82fe67b2011-07-09 01:37:26 +00001988 // Check the type for a cleanup.
Richard Smith2b4fa532019-09-29 05:08:46 +00001989 if (QualType::DestructionKind dtorKind = D.needsDestruction(getContext()))
John McCall82fe67b2011-07-09 01:37:26 +00001990 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001991
John McCall1bd25562011-06-24 23:21:27 +00001992 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001993 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001994 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1995 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1996 }
1997
John McCallc533cb72011-02-22 06:44:22 +00001998 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001999 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002000 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00002001
John McCallc533cb72011-02-22 06:44:22 +00002002 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002003 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00002004
John McCalla729c622012-02-17 03:33:10 +00002005 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00002006 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002007 }
Mike Stump626aecc2009-03-05 01:23:13 +00002008
John McCallc533cb72011-02-22 06:44:22 +00002009 // If this is a block variable, call _Block_object_destroy
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002010 // (on the unforwarded address). Don't enter this cleanup if we're in pure-GC
2011 // mode.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002012 if (emission.IsEscapingByRef &&
2013 CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002014 BlockFieldFlags Flags = BLOCK_FIELD_IS_BYREF;
2015 if (emission.Variable->getType().isObjCGCWeak())
2016 Flags |= BLOCK_FIELD_IS_WEAK;
2017 enterByrefCleanup(NormalAndEHCleanup, emission.Addr, Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00002018 /*LoadBlockVarAddr*/ false,
2019 cxxDestructorCanThrow(emission.Variable->getType()));
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002020 }
Chris Lattner03df1222007-06-02 04:53:11 +00002021}
Chris Lattner53621a52007-06-13 20:44:40 +00002022
Peter Collingbourne1425b452012-01-26 03:33:36 +00002023CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00002024CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
2025 switch (kind) {
2026 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00002027 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002028 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00002029 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002030 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00002031 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002032 return destroyARCWeak;
Akira Hatanaka7275da02018-02-28 07:15:55 +00002033 case QualType::DK_nontrivial_c_struct:
2034 return destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00002035 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00002036 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00002037}
2038
John McCall12cc42a2013-02-01 05:11:40 +00002039/// pushEHDestroy - Push the standard destructor for the given type as
2040/// an EH-only cleanup.
2041void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002042 Address addr, QualType type) {
John McCall12cc42a2013-02-01 05:11:40 +00002043 assert(dtorKind && "cannot push destructor for trivial type");
2044 assert(needsEHCleanup(dtorKind));
2045
2046 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
2047}
2048
2049/// pushDestroy - Push the standard destructor for the given type as
2050/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00002051void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002052 Address addr, QualType type) {
John McCall4bd0fb12011-07-12 16:41:08 +00002053 assert(dtorKind && "cannot push destructor for trivial type");
2054
2055 CleanupKind cleanupKind = getCleanupKind(dtorKind);
2056 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
2057 cleanupKind & EHCleanup);
2058}
2059
John McCall7f416cc2015-09-08 08:05:57 +00002060void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002061 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002062 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00002063 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
2064 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002065}
2066
John McCall7f416cc2015-09-08 08:05:57 +00002067void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002068 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
2069}
2070
Richard Smith736a9472013-06-12 20:42:33 +00002071void CodeGenFunction::pushLifetimeExtendedDestroy(
John McCall7f416cc2015-09-08 08:05:57 +00002072 CleanupKind cleanupKind, Address addr, QualType type,
Richard Smith736a9472013-06-12 20:42:33 +00002073 Destroyer *destroyer, bool useEHCleanupForArray) {
Richard Smith736a9472013-06-12 20:42:33 +00002074 // Push an EH-only cleanup for the object now.
2075 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
2076 // around in case a temporary's destructor throws an exception.
2077 if (cleanupKind & EHCleanup)
2078 EHStack.pushCleanup<DestroyObject>(
2079 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
2080 destroyer, useEHCleanupForArray);
2081
2082 // Remember that we need to push a full cleanup for the object at the
2083 // end of the full-expression.
2084 pushCleanupAfterFullExpr<DestroyObject>(
2085 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
2086}
2087
John McCall178360e2011-07-11 08:38:19 +00002088/// emitDestroy - Immediately perform the destruction of the given
2089/// object.
2090///
2091/// \param addr - the address of the object; a type*
2092/// \param type - the type of the object; if an array type, all
2093/// objects are destroyed in reverse order
2094/// \param destroyer - the function to call to destroy individual
2095/// elements
2096/// \param useEHCleanupForArray - whether an EH cleanup should be
2097/// used when destroying array elements, in case one of the
2098/// destructions throws an exception
John McCall7f416cc2015-09-08 08:05:57 +00002099void CodeGenFunction::emitDestroy(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002100 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002101 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00002102 const ArrayType *arrayType = getContext().getAsArrayType(type);
2103 if (!arrayType)
2104 return destroyer(*this, addr, type);
2105
John McCall7f416cc2015-09-08 08:05:57 +00002106 llvm::Value *length = emitArrayLength(arrayType, type, addr);
2107
2108 CharUnits elementAlign =
2109 addr.getAlignment()
2110 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
John McCall97eab0a2011-07-13 08:09:46 +00002111
2112 // Normally we have to check whether the array is zero-length.
2113 bool checkZeroLength = true;
2114
2115 // But if the array length is constant, we can suppress that.
2116 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
2117 // ...and if it's constant zero, we can just skip the entire thing.
2118 if (constLength->isZero()) return;
2119 checkZeroLength = false;
2120 }
2121
John McCall7f416cc2015-09-08 08:05:57 +00002122 llvm::Value *begin = addr.getPointer();
John McCall82fe67b2011-07-09 01:37:26 +00002123 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall7f416cc2015-09-08 08:05:57 +00002124 emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002125 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002126}
2127
John McCall178360e2011-07-11 08:38:19 +00002128/// emitArrayDestroy - Destroys all the elements of the given array,
2129/// beginning from last to first. The array cannot be zero-length.
2130///
2131/// \param begin - a type* denoting the first element of the array
2132/// \param end - a type* denoting one past the end of the array
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00002133/// \param elementType - the element type of the array
John McCall178360e2011-07-11 08:38:19 +00002134/// \param destroyer - the function to call to destroy elements
2135/// \param useEHCleanup - whether to push an EH cleanup to destroy
2136/// the remaining elements in case the destruction of a single
2137/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00002138void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
2139 llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002140 QualType elementType,
2141 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002142 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002143 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00002144 bool useEHCleanup) {
John McCall7f416cc2015-09-08 08:05:57 +00002145 assert(!elementType->isArrayType());
John McCall82fe67b2011-07-09 01:37:26 +00002146
2147 // The basic structure here is a do-while loop, because we don't
2148 // need to check for the zero-element case.
2149 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
2150 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
2151
John McCall97eab0a2011-07-13 08:09:46 +00002152 if (checkZeroLength) {
2153 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
2154 "arraydestroy.isempty");
2155 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
2156 }
2157
John McCall82fe67b2011-07-09 01:37:26 +00002158 // Enter the loop body, making that address the current address.
2159 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
2160 EmitBlock(bodyBB);
2161 llvm::PHINode *elementPast =
2162 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
2163 elementPast->addIncoming(end, entryBB);
2164
2165 // Shift the address back by one element.
2166 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
2167 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
2168 "arraydestroy.element");
2169
John McCall178360e2011-07-11 08:38:19 +00002170 if (useEHCleanup)
John McCall7f416cc2015-09-08 08:05:57 +00002171 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
2172 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002173
John McCall82fe67b2011-07-09 01:37:26 +00002174 // Perform the actual destruction there.
John McCall7f416cc2015-09-08 08:05:57 +00002175 destroyer(*this, Address(element, elementAlign), elementType);
John McCall82fe67b2011-07-09 01:37:26 +00002176
John McCall178360e2011-07-11 08:38:19 +00002177 if (useEHCleanup)
2178 PopCleanupBlock();
2179
John McCall82fe67b2011-07-09 01:37:26 +00002180 // Check whether we've reached the end.
2181 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
2182 Builder.CreateCondBr(done, doneBB, bodyBB);
2183 elementPast->addIncoming(element, Builder.GetInsertBlock());
2184
2185 // Done.
2186 EmitBlock(doneBB);
2187}
2188
John McCall178360e2011-07-11 08:38:19 +00002189/// Perform partial array destruction as if in an EH cleanup. Unlike
2190/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00002191static void emitPartialArrayDestroy(CodeGenFunction &CGF,
2192 llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002193 QualType type, CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002194 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00002195 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00002196 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00002197 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
2198 // VLAs don't require a GEP index to walk into.
2199 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00002200 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00002201 type = arrayType->getElementType();
2202 }
John McCall97eab0a2011-07-13 08:09:46 +00002203
2204 if (arrayDepth) {
John McCallf0f0b7a2015-09-14 18:57:08 +00002205 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
John McCall97eab0a2011-07-13 08:09:46 +00002206
John McCallf0f0b7a2015-09-14 18:57:08 +00002207 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
Jay Foad040dd822011-07-22 08:16:57 +00002208 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
2209 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00002210 }
2211
John McCall97eab0a2011-07-13 08:09:46 +00002212 // Destroy the array. We don't ever need an EH cleanup because we
2213 // assume that we're in an EH cleanup ourselves, so a throwing
2214 // destructor causes an immediate terminate.
John McCall7f416cc2015-09-08 08:05:57 +00002215 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002216 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00002217}
2218
John McCall82fe67b2011-07-09 01:37:26 +00002219namespace {
John McCall178360e2011-07-11 08:38:19 +00002220 /// RegularPartialArrayDestroy - a cleanup which performs a partial
2221 /// array destroy where the end pointer is regularly determined and
2222 /// does not need to be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002223 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall178360e2011-07-11 08:38:19 +00002224 llvm::Value *ArrayBegin;
2225 llvm::Value *ArrayEnd;
2226 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002227 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002228 CharUnits ElementAlign;
John McCall178360e2011-07-11 08:38:19 +00002229 public:
2230 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002231 QualType elementType, CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002232 CodeGenFunction::Destroyer *destroyer)
2233 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
John McCall7f416cc2015-09-08 08:05:57 +00002234 ElementType(elementType), Destroyer(destroyer),
2235 ElementAlign(elementAlign) {}
John McCall178360e2011-07-11 08:38:19 +00002236
Craig Topper4f12f102014-03-12 06:41:41 +00002237 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00002238 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002239 ElementType, ElementAlign, Destroyer);
John McCall178360e2011-07-11 08:38:19 +00002240 }
2241 };
2242
2243 /// IrregularPartialArrayDestroy - a cleanup which performs a
2244 /// partial array destroy where the end pointer is irregularly
2245 /// determined and must be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002246 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00002247 llvm::Value *ArrayBegin;
John McCall7f416cc2015-09-08 08:05:57 +00002248 Address ArrayEndPointer;
John McCall82fe67b2011-07-09 01:37:26 +00002249 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002250 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002251 CharUnits ElementAlign;
John McCall82fe67b2011-07-09 01:37:26 +00002252 public:
John McCall178360e2011-07-11 08:38:19 +00002253 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002254 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002255 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002256 CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002257 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00002258 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
John McCall7f416cc2015-09-08 08:05:57 +00002259 ElementType(elementType), Destroyer(destroyer),
2260 ElementAlign(elementAlign) {}
John McCall82fe67b2011-07-09 01:37:26 +00002261
Craig Topper4f12f102014-03-12 06:41:41 +00002262 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00002263 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00002264 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002265 ElementType, ElementAlign, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002266 }
2267 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002268} // end anonymous namespace
John McCall82fe67b2011-07-09 01:37:26 +00002269
John McCall178360e2011-07-11 08:38:19 +00002270/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00002271/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00002272/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002273///
John McCall82fe67b2011-07-09 01:37:26 +00002274/// \param elementType - the immediate element type of the array;
2275/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00002276void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002277 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002278 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002279 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002280 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002281 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
2282 arrayBegin, arrayEndPointer,
John McCall7f416cc2015-09-08 08:05:57 +00002283 elementType, elementAlign,
2284 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002285}
2286
2287/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
2288/// already-constructed elements of the given array. The cleanup
2289/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002290///
John McCall178360e2011-07-11 08:38:19 +00002291/// \param elementType - the immediate element type of the array;
2292/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00002293void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
2294 llvm::Value *arrayEnd,
2295 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002296 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002297 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002298 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00002299 arrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002300 elementType, elementAlign,
2301 destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002302}
2303
Nadav Rotem1da30942013-03-23 06:43:35 +00002304/// Lazily declare the @llvm.lifetime.start intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002305llvm::Function *CodeGenModule::getLLVMLifetimeStartFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002306 if (LifetimeStartFn)
2307 return LifetimeStartFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002308 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002309 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002310 return LifetimeStartFn;
2311}
2312
2313/// Lazily declare the @llvm.lifetime.end intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002314llvm::Function *CodeGenModule::getLLVMLifetimeEndFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002315 if (LifetimeEndFn)
2316 return LifetimeEndFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002317 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002318 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002319 return LifetimeEndFn;
2320}
2321
John McCall31168b02011-06-15 23:02:42 +00002322namespace {
2323 /// A cleanup to perform a release of an object at the end of a
2324 /// function. This is used to balance out the incoming +1 of a
2325 /// ns_consumed argument when we can't reasonably do that just by
2326 /// not doing the initial retain for a __block argument.
David Blaikie7e70d682015-08-18 22:40:54 +00002327 struct ConsumeARCParameter final : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00002328 ConsumeARCParameter(llvm::Value *param,
2329 ARCPreciseLifetime_t precise)
2330 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00002331
2332 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00002333 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00002334
Craig Topper4f12f102014-03-12 06:41:41 +00002335 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00002336 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00002337 }
2338 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002339} // end anonymous namespace
John McCall31168b02011-06-15 23:02:42 +00002340
Mike Stump11289f42009-09-09 15:08:12 +00002341/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00002342/// for the specified parameter and set up LocalDeclMap.
John McCall7f416cc2015-09-08 08:05:57 +00002343void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
2344 unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002345 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00002346 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002347 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00002348
John McCall7f416cc2015-09-08 08:05:57 +00002349 Arg.getAnyValue()->setName(D.getName());
John McCall147d0212011-02-22 22:38:33 +00002350
Adrian Prantl51936dd2013-03-14 17:53:33 +00002351 QualType Ty = D.getType();
2352
John McCall147d0212011-02-22 22:38:33 +00002353 // Use better IR generation for certain implicit parameters.
John McCall7f416cc2015-09-08 08:05:57 +00002354 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
John McCall147d0212011-02-22 22:38:33 +00002355 // The only implicit argument a block has is its literal.
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002356 // This may be passed as an inalloca'ed value on Windows x86.
John McCall147d0212011-02-22 22:38:33 +00002357 if (BlockInfo) {
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002358 llvm::Value *V = Arg.isIndirect()
2359 ? Builder.CreateLoad(Arg.getIndirectAddress())
2360 : Arg.getDirectValue();
2361 setBlockContextParameter(IPD, ArgNo, V);
John McCall147d0212011-02-22 22:38:33 +00002362 return;
2363 }
2364 }
2365
John McCall7f416cc2015-09-08 08:05:57 +00002366 Address DeclPtr = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002367 bool DoStore = false;
2368 bool IsScalar = hasScalarEvaluationKind(Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002369 // If we already have a pointer to the argument, reuse the input pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002370 if (Arg.isIndirect()) {
2371 DeclPtr = Arg.getIndirectAddress();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002372 // If we have a prettier pointer type at this point, bitcast to that.
John McCall7f416cc2015-09-08 08:05:57 +00002373 unsigned AS = DeclPtr.getType()->getAddressSpace();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002374 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
John McCall7f416cc2015-09-08 08:05:57 +00002375 if (DeclPtr.getType() != IRTy)
2376 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
Yaxun Liu5b330e82018-03-15 15:25:19 +00002377 // Indirect argument is in alloca address space, which may be different
2378 // from the default address space.
2379 auto AllocaAS = CGM.getASTAllocaAddressSpace();
2380 auto *V = DeclPtr.getPointer();
2381 auto SrcLangAS = getLangOpts().OpenCL ? LangAS::opencl_private : AllocaAS;
2382 auto DestLangAS =
2383 getLangOpts().OpenCL ? LangAS::opencl_private : LangAS::Default;
2384 if (SrcLangAS != DestLangAS) {
2385 assert(getContext().getTargetAddressSpace(SrcLangAS) ==
2386 CGM.getDataLayout().getAllocaAddrSpace());
2387 auto DestAS = getContext().getTargetAddressSpace(DestLangAS);
2388 auto *T = V->getType()->getPointerElementType()->getPointerTo(DestAS);
2389 DeclPtr = Address(getTargetHooks().performAddrSpaceCast(
2390 *this, V, SrcLangAS, DestLangAS, T, true),
2391 DeclPtr.getAlignment());
2392 }
John McCall7f416cc2015-09-08 08:05:57 +00002393
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002394 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner19819442014-07-25 21:39:46 +00002395 // Don't push a cleanup in a thunk for a method that will also emit a
2396 // cleanup.
Akira Hatanaka85282972018-05-15 21:00:30 +00002397 if (hasAggregateEvaluationKind(Ty) && !CurFuncIsThunk &&
Simon Pilgrim1cd399c2019-10-03 11:22:48 +00002398 Ty->castAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Richard Smith2b4fa532019-09-29 05:08:46 +00002399 if (QualType::DestructionKind DtorKind =
2400 D.needsDestruction(getContext())) {
Akira Hatanaka7275da02018-02-28 07:15:55 +00002401 assert((DtorKind == QualType::DK_cxx_destructor ||
2402 DtorKind == QualType::DK_nontrivial_c_struct) &&
2403 "unexpected destructor type");
2404 pushDestroy(DtorKind, DeclPtr, Ty);
Akira Hatanakaccda3d22018-04-27 06:57:00 +00002405 CalleeDestructedParamCleanups[cast<ParmVarDecl>(&D)] =
2406 EHStack.stable_begin();
Akira Hatanaka7275da02018-02-28 07:15:55 +00002407 }
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002408 }
Chris Lattner53621a52007-06-13 20:44:40 +00002409 } else {
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00002410 // Check if the parameter address is controlled by OpenMP runtime.
2411 Address OpenMPLocalAddr =
2412 getLangOpts().OpenMP
2413 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
2414 : Address::invalid();
2415 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
2416 DeclPtr = OpenMPLocalAddr;
2417 } else {
2418 // Otherwise, create a temporary to hold the value.
2419 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D),
2420 D.getName() + ".addr");
2421 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002422 DoStore = true;
2423 }
Mike Stump11289f42009-09-09 15:08:12 +00002424
John McCall7f416cc2015-09-08 08:05:57 +00002425 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr);
2426
2427 LValue lv = MakeAddrLValue(DeclPtr, Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002428 if (IsScalar) {
John McCall31168b02011-06-15 23:02:42 +00002429 Qualifiers qs = Ty.getQualifiers();
John McCall31168b02011-06-15 23:02:42 +00002430 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
2431 // We honor __attribute__((ns_consumed)) for types with lifetime.
2432 // For __strong, it's handled by just skipping the initial retain;
2433 // otherwise we have to balance out the initial +1 with an extra
2434 // cleanup to do the release at the end of the function.
2435 bool isConsumed = D.hasAttr<NSConsumedAttr>();
2436
Erik Pilkington1e368822019-01-04 18:33:06 +00002437 // If a parameter is pseudo-strong then we can omit the implicit retain.
John McCalld4631322011-06-17 06:42:21 +00002438 if (D.isARCPseudoStrong()) {
Erik Pilkington1e368822019-01-04 18:33:06 +00002439 assert(lt == Qualifiers::OCL_Strong &&
2440 "pseudo-strong variable isn't strong?");
2441 assert(qs.hasConst() && "pseudo-strong variable should be const!");
John McCall31168b02011-06-15 23:02:42 +00002442 lt = Qualifiers::OCL_ExplicitNone;
2443 }
2444
Saleem Abdulrasoolda6784e2017-06-27 18:37:51 +00002445 // Load objects passed indirectly.
2446 if (Arg.isIndirect() && !ArgVal)
2447 ArgVal = Builder.CreateLoad(DeclPtr);
2448
John McCall31168b02011-06-15 23:02:42 +00002449 if (lt == Qualifiers::OCL_Strong) {
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002450 if (!isConsumed) {
2451 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2452 // use objc_storeStrong(&dest, value) for retaining the
2453 // object. But first, store a null into 'dest' because
2454 // objc_storeStrong attempts to release its old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002455 llvm::Value *Null = CGM.EmitNullConstant(D.getType());
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002456 EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
John McCall7f416cc2015-09-08 08:05:57 +00002457 EmitARCStoreStrongCall(lv.getAddress(), ArgVal, true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002458 DoStore = false;
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002459 }
2460 else
John McCall31168b02011-06-15 23:02:42 +00002461 // Don't use objc_retainBlock for block pointers, because we
2462 // don't want to Block_copy something just because we got it
2463 // as a parameter.
John McCall7f416cc2015-09-08 08:05:57 +00002464 ArgVal = EmitARCRetainNonBlock(ArgVal);
Fariborz Jahanian134cec62013-02-21 00:40:10 +00002465 }
John McCall31168b02011-06-15 23:02:42 +00002466 } else {
2467 // Push the cleanup for a consumed parameter.
John McCallcdda29c2013-03-13 03:10:54 +00002468 if (isConsumed) {
2469 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
2470 ? ARCPreciseLifetime : ARCImpreciseLifetime);
John McCall7f416cc2015-09-08 08:05:57 +00002471 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal,
John McCallcdda29c2013-03-13 03:10:54 +00002472 precise);
2473 }
John McCall31168b02011-06-15 23:02:42 +00002474
2475 if (lt == Qualifiers::OCL_Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00002476 EmitARCInitWeak(DeclPtr, ArgVal);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002477 DoStore = false; // The weak init is a store, no need to do two.
John McCall31168b02011-06-15 23:02:42 +00002478 }
2479 }
2480
2481 // Enter the cleanup scope.
2482 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
2483 }
Chris Lattner53621a52007-06-13 20:44:40 +00002484 }
2485
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002486 // Store the initial value into the alloca.
2487 if (DoStore)
John McCall7f416cc2015-09-08 08:05:57 +00002488 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002489
John McCall7f416cc2015-09-08 08:05:57 +00002490 setAddrOfLocalVar(&D, DeclPtr);
Sanjiv Gupta18de6242008-05-30 10:30:31 +00002491
Vedant Kumar04818d82019-07-29 22:49:55 +00002492 // Emit debug info for param declarations in non-thunk functions.
Alexey Samsonov74a38682012-05-04 07:39:27 +00002493 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002494 if (CGM.getCodeGenOpts().getDebugInfo() >=
Vedant Kumar04818d82019-07-29 22:49:55 +00002495 codegenoptions::LimitedDebugInfo &&
2496 !CurFuncIsThunk) {
John McCall7f416cc2015-09-08 08:05:57 +00002497 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00002498 }
2499 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002500
2501 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00002502 EmitVarAnnotations(&D, DeclPtr.getPointer());
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002503
2504 // We can only check return value nullability if all arguments to the
2505 // function satisfy their nullability preconditions. This makes it necessary
2506 // to emit null checks for args in the function body itself.
2507 if (requiresReturnValueNullabilityCheck()) {
2508 auto Nullability = Ty->getNullability(getContext());
2509 if (Nullability && *Nullability == NullabilityKind::NonNull) {
2510 SanitizerScope SanScope(this);
2511 RetValNullabilityPrecondition =
2512 Builder.CreateAnd(RetValNullabilityPrecondition,
2513 Builder.CreateIsNotNull(Arg.getAnyValue()));
2514 }
2515 }
Chris Lattner53621a52007-06-13 20:44:40 +00002516}
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00002517
Alexey Bataevc5b1d322016-03-04 09:22:22 +00002518void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
2519 CodeGenFunction *CGF) {
2520 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2521 return;
2522 getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
2523}
Kelvin Li1408f912018-09-26 04:28:39 +00002524
Michael Kruse251e1482019-02-01 20:25:04 +00002525void CodeGenModule::EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D,
Michael Krused47b9432019-08-05 18:43:21 +00002526 CodeGenFunction *CGF) {
2527 if (!LangOpts.OpenMP || LangOpts.OpenMPSimd ||
2528 (!LangOpts.EmitAllDecls && !D->isUsed()))
Michael Kruse251e1482019-02-01 20:25:04 +00002529 return;
Michael Krused47b9432019-08-05 18:43:21 +00002530 getOpenMPRuntime().emitUserDefinedMapper(D, CGF);
Michael Kruse251e1482019-02-01 20:25:04 +00002531}
2532
Kelvin Li1408f912018-09-26 04:28:39 +00002533void CodeGenModule::EmitOMPRequiresDecl(const OMPRequiresDecl *D) {
Alexey Bataev982a35e2019-03-19 17:09:52 +00002534 getOpenMPRuntime().checkArchForUnifiedAddressing(D);
Kelvin Li1408f912018-09-26 04:28:39 +00002535}