blob: 758737e86c29c14c2302759007d4362aa94a04f4 [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:
Chris Lattner84915fa2007-06-02 04:16:21 +0000111 // None of these decls require codegen support.
112 return;
David Blaikieb7d1e1f2013-02-02 00:39:32 +0000113
David Blaikief121b932013-05-20 22:50:41 +0000114 case Decl::NamespaceAlias:
115 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000116 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
David Blaikief121b932013-05-20 22:50:41 +0000117 return;
David Blaikiebd483762013-05-20 04:58:53 +0000118 case Decl::Using: // using X; [C++]
119 if (CGDebugInfo *DI = getDebugInfo())
Amjad Abouddc4531e2016-04-30 01:44:38 +0000120 DI->EmitUsingDecl(cast<UsingDecl>(D));
David Blaikiebd483762013-05-20 04:58:53 +0000121 return;
Richard Smith151c4562016-12-20 21:35:28 +0000122 case Decl::UsingPack:
123 for (auto *Using : cast<UsingPackDecl>(D).expansions())
124 EmitDecl(*Using);
125 return;
David Blaikie9f88fe82013-04-22 06:13:21 +0000126 case Decl::UsingDirective: // using namespace X; [C++]
127 if (CGDebugInfo *DI = getDebugInfo())
128 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
129 return;
Richard Smithbdb84f32016-07-22 23:36:59 +0000130 case Decl::Var:
131 case Decl::Decomposition: {
Daniel Dunbara7998072008-08-29 17:28:43 +0000132 const VarDecl &VD = cast<VarDecl>(D);
John McCall1c9c3fd2010-10-15 04:57:14 +0000133 assert(VD.isLocalVarDecl() &&
Daniel Dunbara7998072008-08-29 17:28:43 +0000134 "Should not see file-scope variables inside a function!");
Richard Smithda383632016-08-15 01:33:41 +0000135 EmitVarDecl(VD);
136 if (auto *DD = dyn_cast<DecompositionDecl>(&VD))
137 for (auto *B : DD->bindings())
138 if (auto *HD = B->getHoldingVar())
139 EmitVarDecl(*HD);
140 return;
Chris Lattner84915fa2007-06-02 04:16:21 +0000141 }
Mike Stump11289f42009-09-09 15:08:12 +0000142
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000143 case Decl::OMPDeclareReduction:
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000144 return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this);
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000145
Michael Kruse251e1482019-02-01 20:25:04 +0000146 case Decl::OMPDeclareMapper:
147 return CGM.EmitOMPDeclareMapper(cast<OMPDeclareMapperDecl>(&D), this);
148
Richard Smithdda56e42011-04-15 14:24:37 +0000149 case Decl::Typedef: // typedef int X;
150 case Decl::TypeAlias: { // using X = int; [C++0x]
151 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
Anders Carlsson5d985f52008-12-20 21:51:53 +0000152 QualType Ty = TD.getUnderlyingType();
Mike Stump11289f42009-09-09 15:08:12 +0000153
Anders Carlsson5d985f52008-12-20 21:51:53 +0000154 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000155 EmitVariablyModifiedType(Ty);
Hamza Soodd14003d2019-07-05 14:36:08 +0000156
157 return;
Anders Carlsson5d985f52008-12-20 21:51:53 +0000158 }
Daniel Dunbara7998072008-08-29 17:28:43 +0000159 }
Chris Lattner84915fa2007-06-02 04:16:21 +0000160}
Chris Lattner03df1222007-06-02 04:53:11 +0000161
John McCall1c9c3fd2010-10-15 04:57:14 +0000162/// EmitVarDecl - This method handles emission of any variable declaration
Chris Lattner03df1222007-06-02 04:53:11 +0000163/// inside a function, including static vars etc.
John McCall1c9c3fd2010-10-15 04:57:14 +0000164void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
Yaxun Liu4f33b3d2017-05-15 14:47:47 +0000165 if (D.hasExternalStorage())
166 // Don't emit it now, allow it to be emitted lazily on its first use.
167 return;
168
169 // Some function-scope variable does not have static storage but still
170 // needs to be emitted like a static variable, e.g. a function-scope
171 // variable in constant address space in OpenCL.
172 if (D.getStorageDuration() != SD_Automatic) {
Alexey Baderbed40092017-11-15 11:38:17 +0000173 // Static sampler variables translated to function calls.
174 if (D.getType()->isSamplerT())
175 return;
176
Eric Christopher31ab1302011-08-23 22:38:00 +0000177 llvm::GlobalValue::LinkageTypes Linkage =
David Majnemer27d69db2014-04-28 22:17:59 +0000178 CGM.getLLVMLinkageVarDefinition(&D, /*isConstant=*/false);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000179
David Majnemer27d69db2014-04-28 22:17:59 +0000180 // FIXME: We need to force the emission/use of a guard variable for
181 // some variables even if we can constant-evaluate them because
182 // we can't guarantee every translation unit will constant-evaluate them.
Eric Christopher31ab1302011-08-23 22:38:00 +0000183
John McCall1c9c3fd2010-10-15 04:57:14 +0000184 return EmitStaticVarDecl(D, Linkage);
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000185 }
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000186
Anastasia Stulovabcea6962015-09-30 14:08:20 +0000187 if (D.getType().getAddressSpace() == LangAS::opencl_local)
Enea Zaffanellacf51a8a2013-05-16 11:27:56 +0000188 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
189
190 assert(D.hasLocalStorage());
191 return EmitAutoVarDecl(D);
Chris Lattner03df1222007-06-02 04:53:11 +0000192}
193
Reid Kleckner453e0562014-10-08 01:07:54 +0000194static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) {
195 if (CGM.getLangOpts().CPlusPlus)
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000196 return CGM.getMangledName(&D).str();
197
Reid Kleckner453e0562014-10-08 01:07:54 +0000198 // If this isn't C++, we don't need a mangled name, just a pretty one.
199 assert(!D.isExternallyVisible() && "name shouldn't matter");
200 std::string ContextName;
201 const DeclContext *DC = D.getDeclContext();
Alexey Bataev43f74392015-05-07 06:28:46 +0000202 if (auto *CD = dyn_cast<CapturedDecl>(DC))
203 DC = cast<DeclContext>(CD->getNonClosureContext());
Reid Kleckner453e0562014-10-08 01:07:54 +0000204 if (const auto *FD = dyn_cast<FunctionDecl>(DC))
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000205 ContextName = CGM.getMangledName(FD);
Reid Kleckner453e0562014-10-08 01:07:54 +0000206 else if (const auto *BD = dyn_cast<BlockDecl>(DC))
207 ContextName = CGM.getBlockMangledName(GlobalDecl(), BD);
208 else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC))
209 ContextName = OMD->getSelector().getAsString();
Chris Lattnere99c1102009-12-05 08:22:11 +0000210 else
David Blaikie83d382b2011-09-23 05:06:16 +0000211 llvm_unreachable("Unknown context for static var decl");
Eric Christopher31ab1302011-08-23 22:38:00 +0000212
Reid Kleckner453e0562014-10-08 01:07:54 +0000213 ContextName += "." + D.getNameAsString();
214 return ContextName;
Chris Lattnere99c1102009-12-05 08:22:11 +0000215}
216
Reid Kleckner453e0562014-10-08 01:07:54 +0000217llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl(
218 const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) {
219 // In general, we don't always emit static var decls once before we reference
220 // them. It is possible to reference them before emitting the function that
221 // contains them, and it is possible to emit the containing function multiple
222 // times.
223 if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D])
224 return ExistingGV;
225
Chris Lattnerfc4379f2008-04-06 23:10:54 +0000226 QualType Ty = D.getType();
Eli Friedmana682d392008-02-15 12:20:59 +0000227 assert(Ty->isConstantSizeType() && "VLAs can't be static");
Nate Begemanfaae0812008-04-19 04:17:09 +0000228
Benjamin Kramerddbb2b82011-11-20 21:05:04 +0000229 // Use the label if the variable is renamed with the asm-label extension.
230 std::string Name;
Benjamin Kramer5642e192011-11-21 15:47:23 +0000231 if (D.hasAttr<AsmLabelAttr>())
Reid Kleckner453e0562014-10-08 01:07:54 +0000232 Name = getMangledName(&D);
Benjamin Kramer5642e192011-11-21 15:47:23 +0000233 else
Reid Kleckner453e0562014-10-08 01:07:54 +0000234 Name = getStaticDeclName(*this, D);
Nate Begemanfaae0812008-04-19 04:17:09 +0000235
Reid Kleckner453e0562014-10-08 01:07:54 +0000236 llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty);
Alexander Richardson6d989432017-10-15 18:48:14 +0000237 LangAS AS = GetGlobalVarAddressSpace(&D);
Yaxun Liucbf647c2017-07-08 13:24:52 +0000238 unsigned TargetAS = getContext().getTargetAddressSpace(AS);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000239
Yaxun Liua64a4912018-04-02 17:38:24 +0000240 // OpenCL variables in local address space and CUDA shared
241 // variables cannot have an initializer.
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000242 llvm::Constant *Init = nullptr;
Yaxun Liua64a4912018-04-02 17:38:24 +0000243 if (Ty.getAddressSpace() == LangAS::opencl_local ||
244 D.hasAttr<CUDASharedAttr>())
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000245 Init = llvm::UndefValue::get(LTy);
Yaxun Liua64a4912018-04-02 17:38:24 +0000246 else
247 Init = EmitNullConstant(Ty);
Matt Arsenault3f6469b2014-11-03 16:51:53 +0000248
Yaxun Liucbf647c2017-07-08 13:24:52 +0000249 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
250 getModule(), LTy, Ty.isConstant(getContext()), Linkage, Init, Name,
251 nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS);
Ken Dyck160146e2010-01-27 17:10:57 +0000252 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000253
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +0000254 if (supportsCOMDAT() && GV->isWeakForLinker())
255 GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
Rafael Espindola0d4fb982015-01-12 22:13:53 +0000256
Richard Smithfd3834f2013-04-13 02:43:54 +0000257 if (D.getTLSKind())
Reid Kleckner453e0562014-10-08 01:07:54 +0000258 setTLSMode(GV, D);
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000259
Rafael Espindola922f2aa2018-02-23 19:30:48 +0000260 setGVProperties(GV, &D);
261
Eli Benderskycb399432014-03-24 22:05:38 +0000262 // Make sure the result is of the correct type.
Alexander Richardson6d989432017-10-15 18:48:14 +0000263 LangAS ExpectedAS = Ty.getAddressSpace();
Reid Kleckner453e0562014-10-08 01:07:54 +0000264 llvm::Constant *Addr = GV;
Yaxun Liucbf647c2017-07-08 13:24:52 +0000265 if (AS != ExpectedAS) {
266 Addr = getTargetCodeGenInfo().performAddrSpaceCast(
267 *this, GV, AS, ExpectedAS,
268 LTy->getPointerTo(getContext().getTargetAddressSpace(ExpectedAS)));
Eli Benderskycb399432014-03-24 22:05:38 +0000269 }
270
Reid Kleckner453e0562014-10-08 01:07:54 +0000271 setStaticLocalDeclAddress(&D, Addr);
272
273 // Ensure that the static local gets initialized by making sure the parent
274 // function gets emitted eventually.
275 const Decl *DC = cast<Decl>(D.getDeclContext());
276
277 // We can't name blocks or captured statements directly, so try to emit their
278 // parents.
279 if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) {
280 DC = DC->getNonClosureContext();
281 // FIXME: Ensure that global blocks get emitted.
282 if (!DC)
283 return Addr;
284 }
285
286 GlobalDecl GD;
287 if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC))
288 GD = GlobalDecl(CD, Ctor_Base);
289 else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC))
290 GD = GlobalDecl(DD, Dtor_Base);
291 else if (const auto *FD = dyn_cast<FunctionDecl>(DC))
292 GD = GlobalDecl(FD);
293 else {
294 // Don't do anything for Obj-C method decls or global closures. We should
295 // never defer them.
296 assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl");
297 }
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000298 if (GD.getDecl()) {
299 // Disable emission of the parent function for the OpenMP device codegen.
300 CGOpenMPRuntime::DisableAutoDeclareTargetRAII NoDeclTarget(*this);
Reid Kleckner453e0562014-10-08 01:07:54 +0000301 (void)GetAddrOfGlobal(GD);
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000302 }
Reid Kleckner453e0562014-10-08 01:07:54 +0000303
304 return Addr;
Daniel Dunbar22a87f92009-02-25 19:24:29 +0000305}
306
Richard Smith6331c402012-02-13 22:16:19 +0000307/// hasNontrivialDestruction - Determine whether a type's destruction is
308/// non-trivial. If so, and the variable uses static initialization, we must
309/// register its destructor to run on exit.
310static bool hasNontrivialDestruction(QualType T) {
311 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
312 return RD && !RD->hasTrivialDestructor();
313}
314
Chandler Carruth84537952012-03-30 19:44:53 +0000315/// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
316/// global variable that has already been created for it. If the initializer
317/// has a different type than GV does, this may free GV and return a different
318/// one. Otherwise it just returns GV.
319llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +0000320CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
Chandler Carruth84537952012-03-30 19:44:53 +0000321 llvm::GlobalVariable *GV) {
John McCallde0fe072017-08-15 21:42:52 +0000322 ConstantEmitter emitter(*this);
323 llvm::Constant *Init = emitter.tryEmitForInitializer(D);
John McCall70013b62010-07-15 23:40:35 +0000324
Chris Lattnere99c1102009-12-05 08:22:11 +0000325 // If constant emission failed, then this should be a C++ static
326 // initializer.
Chandler Carruth84537952012-03-30 19:44:53 +0000327 if (!Init) {
Richard Smith9c6890a2012-11-01 22:30:59 +0000328 if (!getLangOpts().CPlusPlus)
Chris Lattnere99c1102009-12-05 08:22:11 +0000329 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
Matthias Braun44bfe032017-01-10 17:43:01 +0000330 else if (HaveInsertPoint()) {
Eric Christopher31ab1302011-08-23 22:38:00 +0000331 // Since we have a static initializer, this global variable can't
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000332 // be constant.
Chandler Carruth84537952012-03-30 19:44:53 +0000333 GV->setConstant(false);
John McCall68ff0372010-09-08 01:44:27 +0000334
Chandler Carruth84537952012-03-30 19:44:53 +0000335 EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
Anders Carlsson20bbbd42010-01-26 04:02:23 +0000336 }
Chandler Carruth84537952012-03-30 19:44:53 +0000337 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000338 }
John McCall70013b62010-07-15 23:40:35 +0000339
Chris Lattnere99c1102009-12-05 08:22:11 +0000340 // The initializer may differ in type from the global. Rewrite
341 // the global to match the initializer. (We have to do this
342 // because some types, like unions, can't be completely represented
343 // in the LLVM type system.)
Chandler Carruth84537952012-03-30 19:44:53 +0000344 if (GV->getType()->getElementType() != Init->getType()) {
345 llvm::GlobalVariable *OldGV = GV;
346
347 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
348 OldGV->isConstant(),
349 OldGV->getLinkage(), Init, "",
350 /*InsertBefore*/ OldGV,
Hans Wennborgd3b01bc2012-06-23 11:51:46 +0000351 OldGV->getThreadLocalMode(),
Chandler Carruth84537952012-03-30 19:44:53 +0000352 CGM.getContext().getTargetAddressSpace(D.getType()));
353 GV->setVisibility(OldGV->getVisibility());
Rafael Espindola699f5d62018-02-07 22:15:33 +0000354 GV->setDSOLocal(OldGV->isDSOLocal());
Reid Klecknereab97d32015-07-20 20:35:30 +0000355 GV->setComdat(OldGV->getComdat());
Eric Christopher31ab1302011-08-23 22:38:00 +0000356
Chris Lattnere99c1102009-12-05 08:22:11 +0000357 // Steal the name of the old global
Chandler Carruth84537952012-03-30 19:44:53 +0000358 GV->takeName(OldGV);
Eric Christopher31ab1302011-08-23 22:38:00 +0000359
Chris Lattnere99c1102009-12-05 08:22:11 +0000360 // Replace all uses of the old global with the new global
Chandler Carruth84537952012-03-30 19:44:53 +0000361 llvm::Constant *NewPtrForOldDecl =
362 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
363 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
Eric Christopher31ab1302011-08-23 22:38:00 +0000364
Chris Lattnere99c1102009-12-05 08:22:11 +0000365 // Erase the old global, since it is no longer used.
Chandler Carruth84537952012-03-30 19:44:53 +0000366 OldGV->eraseFromParent();
Chris Lattnere99c1102009-12-05 08:22:11 +0000367 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000368
Chandler Carruth84537952012-03-30 19:44:53 +0000369 GV->setConstant(CGM.isTypeConstant(D.getType(), true));
370 GV->setInitializer(Init);
Richard Smith6331c402012-02-13 22:16:19 +0000371
John McCallde0fe072017-08-15 21:42:52 +0000372 emitter.finalize(GV);
373
Matthias Braun44bfe032017-01-10 17:43:01 +0000374 if (hasNontrivialDestruction(D.getType()) && HaveInsertPoint()) {
Richard Smith6331c402012-02-13 22:16:19 +0000375 // We have a constant initializer, but a nontrivial destructor. We still
376 // need to perform a guarded "initialization" in order to register the
Richard Smithe070fd22012-02-17 06:48:11 +0000377 // destructor.
Chandler Carruth84537952012-03-30 19:44:53 +0000378 EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
Richard Smith6331c402012-02-13 22:16:19 +0000379 }
380
Chandler Carruth84537952012-03-30 19:44:53 +0000381 return GV;
Chris Lattnere99c1102009-12-05 08:22:11 +0000382}
383
John McCall1c9c3fd2010-10-15 04:57:14 +0000384void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
Anders Carlssoncee2d2f2010-02-07 02:03:08 +0000385 llvm::GlobalValue::LinkageTypes Linkage) {
John McCallb88a5662012-03-30 21:00:39 +0000386 // Check to see if we already have a global variable for this
387 // declaration. This can happen when double-emitting function
388 // bodies, e.g. with complete and base constructors.
Reid Kleckner453e0562014-10-08 01:07:54 +0000389 llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage);
John McCall7f416cc2015-09-08 08:05:57 +0000390 CharUnits alignment = getContext().getDeclAlign(&D);
Daniel Dunbara374e602009-02-25 19:45:19 +0000391
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000392 // Store into LocalDeclMap before generating initializer to handle
393 // circular references.
John McCall7f416cc2015-09-08 08:05:57 +0000394 setAddrOfLocalVar(&D, Address(addr, alignment));
Daniel Dunbar1cdbc542009-02-25 20:08:33 +0000395
John McCall4a39ab82010-05-04 20:45:42 +0000396 // We can't have a VLA here, but we can have a pointer to a VLA,
397 // even though that doesn't really make any sense.
Eli Friedmanbc633be2009-04-20 03:54:15 +0000398 // Make sure to evaluate VLA bounds now so that we have them for later.
399 if (D.getType()->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000400 EmitVariablyModifiedType(D.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000401
John McCallb88a5662012-03-30 21:00:39 +0000402 // Save the type in case adding the initializer forces a type change.
403 llvm::Type *expectedType = addr->getType();
Eli Friedmanbc633be2009-04-20 03:54:15 +0000404
Eli Benderskycb399432014-03-24 22:05:38 +0000405 llvm::GlobalVariable *var =
406 cast<llvm::GlobalVariable>(addr->stripPointerCasts());
Artem Belevich4d430ba2016-05-09 22:09:56 +0000407
408 // CUDA's local and local static __shared__ variables should not
409 // have any non-empty initializers. This is ensured by Sema.
410 // Whatever initializer such variable may have when it gets here is
411 // a no-op and should not be emitted.
412 bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
413 D.hasAttr<CUDASharedAttr>();
Chris Lattnere99c1102009-12-05 08:22:11 +0000414 // If this value has an initializer, emit it.
Artem Belevich4d430ba2016-05-09 22:09:56 +0000415 if (D.getInit() && !isCudaSharedVar)
John McCallb88a5662012-03-30 21:00:39 +0000416 var = AddInitializerToStaticVarDecl(D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000417
John McCall7f416cc2015-09-08 08:05:57 +0000418 var->setAlignment(alignment.getQuantity());
Chris Lattner4d941092010-03-10 23:59:59 +0000419
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000420 if (D.hasAttr<AnnotateAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000421 CGM.AddGlobalAnnotations(&D, var);
Nate Begemanfaae0812008-04-19 04:17:09 +0000422
Javed Absar2a67c9e2017-06-05 10:11:57 +0000423 if (auto *SA = D.getAttr<PragmaClangBSSSectionAttr>())
424 var->addAttribute("bss-section", SA->getName());
425 if (auto *SA = D.getAttr<PragmaClangDataSectionAttr>())
426 var->addAttribute("data-section", SA->getName());
427 if (auto *SA = D.getAttr<PragmaClangRodataSectionAttr>())
428 var->addAttribute("rodata-section", SA->getName());
429
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000430 if (const SectionAttr *SA = D.getAttr<SectionAttr>())
John McCallb88a5662012-03-30 21:00:39 +0000431 var->setSection(SA->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000432
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +0000433 if (D.hasAttr<UsedAttr>())
Rafael Espindola060062a2014-03-06 22:15:10 +0000434 CGM.addUsedGlobal(var);
Daniel Dunbar128a1382009-02-13 22:08:43 +0000435
Chandler Carruth84537952012-03-30 19:44:53 +0000436 // We may have to cast the constant because of the initializer
437 // mismatch above.
438 //
439 // FIXME: It is really dangerous to store this in the map; if anyone
440 // RAUW's the GV uses of this constant will be invalid.
Eli Benderskycb399432014-03-24 22:05:38 +0000441 llvm::Constant *castedAddr =
442 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
John McCall7f416cc2015-09-08 08:05:57 +0000443 if (var != castedAddr)
444 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
John McCallb88a5662012-03-30 21:00:39 +0000445 CGM.setStaticLocalDeclAddress(&D, castedAddr);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000446
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000447 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
Alexey Samsonov4f319cc2014-07-02 16:54:41 +0000448
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000449 // Emit global variable debug descriptor for static vars.
Anders Carlsson63784f42009-02-13 08:11:52 +0000450 CGDebugInfo *DI = getDebugInfo();
Alexey Samsonov74a38682012-05-04 07:39:27 +0000451 if (DI &&
Benjamin Kramer8c305922016-02-02 11:06:51 +0000452 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
Daniel Dunbarb9fd9022008-10-17 16:15:48 +0000453 DI->setLocation(D.getLocation());
John McCallb88a5662012-03-30 21:00:39 +0000454 DI->EmitGlobalVariable(var, &D);
Sanjiv Gupta158143a2008-06-05 08:59:10 +0000455 }
Anders Carlssonf94cd1f2007-10-17 00:52:43 +0000456}
Mike Stump11289f42009-09-09 15:08:12 +0000457
John McCall2b7fc382010-07-13 20:32:21 +0000458namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000459 struct DestroyObject final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000460 DestroyObject(Address addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +0000461 CodeGenFunction::Destroyer *destroyer,
462 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +0000463 : addr(addr), type(type), destroyer(destroyer),
John McCall178360e2011-07-11 08:38:19 +0000464 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall2b7fc382010-07-13 20:32:21 +0000465
John McCall7f416cc2015-09-08 08:05:57 +0000466 Address addr;
John McCall82fe67b2011-07-09 01:37:26 +0000467 QualType type;
Peter Collingbourne1425b452012-01-26 03:33:36 +0000468 CodeGenFunction::Destroyer *destroyer;
John McCall178360e2011-07-11 08:38:19 +0000469 bool useEHCleanupForArray;
John McCall2b7fc382010-07-13 20:32:21 +0000470
Craig Topper4f12f102014-03-12 06:41:41 +0000471 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +0000472 // Don't use an EH cleanup recursively from an EH cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000473 bool useEHCleanupForArray =
474 flags.isForNormalCleanup() && this->useEHCleanupForArray;
John McCall178360e2011-07-11 08:38:19 +0000475
476 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
John McCall2b7fc382010-07-13 20:32:21 +0000477 }
478 };
479
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000480 template <class Derived>
481 struct DestroyNRVOVariable : EHScopeStack::Cleanup {
482 DestroyNRVOVariable(Address addr, llvm::Value *NRVOFlag)
483 : NRVOFlag(NRVOFlag), Loc(addr) {}
John McCall2b7fc382010-07-13 20:32:21 +0000484
John McCall2b7fc382010-07-13 20:32:21 +0000485 llvm::Value *NRVOFlag;
John McCall7f416cc2015-09-08 08:05:57 +0000486 Address Loc;
John McCall2b7fc382010-07-13 20:32:21 +0000487
Craig Topper4f12f102014-03-12 06:41:41 +0000488 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall2b7fc382010-07-13 20:32:21 +0000489 // Along the exceptions path we always execute the dtor.
John McCall30317fd2011-07-12 20:27:29 +0000490 bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
John McCall2b7fc382010-07-13 20:32:21 +0000491
Craig Topper8a13c412014-05-21 05:09:00 +0000492 llvm::BasicBlock *SkipDtorBB = nullptr;
John McCall2b7fc382010-07-13 20:32:21 +0000493 if (NRVO) {
494 // If we exited via NRVO, we skip the destructor call.
495 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
496 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
John McCall7f416cc2015-09-08 08:05:57 +0000497 llvm::Value *DidNRVO =
498 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
John McCall2b7fc382010-07-13 20:32:21 +0000499 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
500 CGF.EmitBlock(RunDtorBB);
501 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000502
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000503 static_cast<Derived *>(this)->emitDestructorCall(CGF);
John McCall2b7fc382010-07-13 20:32:21 +0000504
505 if (NRVO) CGF.EmitBlock(SkipDtorBB);
506 }
Akira Hatanaka673af7a2018-03-29 17:56:24 +0000507
508 virtual ~DestroyNRVOVariable() = default;
509 };
510
511 struct DestroyNRVOVariableCXX final
512 : DestroyNRVOVariable<DestroyNRVOVariableCXX> {
513 DestroyNRVOVariableCXX(Address addr, const CXXDestructorDecl *Dtor,
514 llvm::Value *NRVOFlag)
515 : DestroyNRVOVariable<DestroyNRVOVariableCXX>(addr, NRVOFlag),
516 Dtor(Dtor) {}
517
518 const CXXDestructorDecl *Dtor;
519
520 void emitDestructorCall(CodeGenFunction &CGF) {
521 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
522 /*ForVirtualBase=*/false,
523 /*Delegating=*/false, Loc);
524 }
525 };
526
527 struct DestroyNRVOVariableC final
528 : DestroyNRVOVariable<DestroyNRVOVariableC> {
529 DestroyNRVOVariableC(Address addr, llvm::Value *NRVOFlag, QualType Ty)
530 : DestroyNRVOVariable<DestroyNRVOVariableC>(addr, NRVOFlag), Ty(Ty) {}
531
532 QualType Ty;
533
534 void emitDestructorCall(CodeGenFunction &CGF) {
535 CGF.destroyNonTrivialCStruct(CGF, Loc, Ty);
536 }
John McCall2b7fc382010-07-13 20:32:21 +0000537 };
John McCall2b7fc382010-07-13 20:32:21 +0000538
David Blaikie7e70d682015-08-18 22:40:54 +0000539 struct CallStackRestore final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +0000540 Address Stack;
541 CallStackRestore(Address Stack) : Stack(Stack) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000542 void Emit(CodeGenFunction &CGF, Flags flags) override {
Benjamin Kramer76399eb2011-09-27 21:06:10 +0000543 llvm::Value *V = CGF.Builder.CreateLoad(Stack);
James Y Knight8799cae2019-02-03 21:53:49 +0000544 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
John McCalla464ff92010-07-21 06:13:08 +0000545 CGF.Builder.CreateCall(F, V);
546 }
547 };
548
David Blaikie7e70d682015-08-18 22:40:54 +0000549 struct ExtendGCLifetime final : EHScopeStack::Cleanup {
John McCall1bd25562011-06-24 23:21:27 +0000550 const VarDecl &Var;
551 ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
552
Craig Topper4f12f102014-03-12 06:41:41 +0000553 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1bd25562011-06-24 23:21:27 +0000554 // Compute the address of the local variable, in case it's a
555 // byref or something.
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000556 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000557 Var.getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +0000558 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
559 SourceLocation());
John McCall1bd25562011-06-24 23:21:27 +0000560 CGF.EmitExtendGCLifetime(value);
561 }
562 };
563
David Blaikie7e70d682015-08-18 22:40:54 +0000564 struct CallCleanupFunction final : EHScopeStack::Cleanup {
John McCalla464ff92010-07-21 06:13:08 +0000565 llvm::Constant *CleanupFn;
566 const CGFunctionInfo &FnInfo;
John McCalla464ff92010-07-21 06:13:08 +0000567 const VarDecl &Var;
Eric Christopher31ab1302011-08-23 22:38:00 +0000568
John McCalla464ff92010-07-21 06:13:08 +0000569 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
John McCallc533cb72011-02-22 06:44:22 +0000570 const VarDecl *Var)
571 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
John McCalla464ff92010-07-21 06:13:08 +0000572
Craig Topper4f12f102014-03-12 06:41:41 +0000573 void Emit(CodeGenFunction &CGF, Flags flags) override {
Bruno Ricci5fc4db72018-12-21 14:10:18 +0000574 DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
John McCall113bee02012-03-10 09:33:50 +0000575 Var.getType(), VK_LValue, SourceLocation());
John McCallc533cb72011-02-22 06:44:22 +0000576 // Compute the address of the local variable, in case it's a byref
577 // or something.
John McCall7f416cc2015-09-08 08:05:57 +0000578 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer();
John McCallc533cb72011-02-22 06:44:22 +0000579
John McCalla464ff92010-07-21 06:13:08 +0000580 // In some cases, the type of the function argument will be different from
581 // the type of the pointer. An example of this is
582 // void f(void* arg);
583 // __attribute__((cleanup(f))) void *g;
584 //
585 // To fix this we insert a bitcast here.
586 QualType ArgTy = FnInfo.arg_begin()->type;
587 llvm::Value *Arg =
588 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
589
590 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +0000591 Args.add(RValue::get(Arg),
592 CGF.getContext().getPointerType(Var.getType()));
John McCallb92ab1a2016-10-26 23:46:34 +0000593 auto Callee = CGCallee::forDirect(CleanupFn);
594 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
John McCalla464ff92010-07-21 06:13:08 +0000595 }
596 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000597} // end anonymous namespace
John McCalla464ff92010-07-21 06:13:08 +0000598
John McCall31168b02011-06-15 23:02:42 +0000599/// EmitAutoVarWithLifetime - Does the setup required for an automatic
600/// variable with lifetime.
601static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
John McCall7f416cc2015-09-08 08:05:57 +0000602 Address addr,
John McCall31168b02011-06-15 23:02:42 +0000603 Qualifiers::ObjCLifetime lifetime) {
604 switch (lifetime) {
605 case Qualifiers::OCL_None:
606 llvm_unreachable("present but none");
607
608 case Qualifiers::OCL_ExplicitNone:
609 // nothing to do
610 break;
611
612 case Qualifiers::OCL_Strong: {
Peter Collingbourne1425b452012-01-26 03:33:36 +0000613 CodeGenFunction::Destroyer *destroyer =
John McCall4bd0fb12011-07-12 16:41:08 +0000614 (var.hasAttr<ObjCPreciseLifetimeAttr>()
615 ? CodeGenFunction::destroyARCStrongPrecise
616 : CodeGenFunction::destroyARCStrongImprecise);
617
618 CleanupKind cleanupKind = CGF.getARCCleanupKind();
619 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
620 cleanupKind & EHCleanup);
John McCall31168b02011-06-15 23:02:42 +0000621 break;
622 }
623 case Qualifiers::OCL_Autoreleasing:
624 // nothing to do
625 break;
Eric Christopher31ab1302011-08-23 22:38:00 +0000626
John McCall31168b02011-06-15 23:02:42 +0000627 case Qualifiers::OCL_Weak:
628 // __weak objects always get EH cleanups; otherwise, exceptions
629 // could cause really nasty crashes instead of mere leaks.
John McCall4bd0fb12011-07-12 16:41:08 +0000630 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
631 CodeGenFunction::destroyARCWeak,
632 /*useEHCleanup*/ true);
John McCall31168b02011-06-15 23:02:42 +0000633 break;
634 }
635}
636
637static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
638 if (const Expr *e = dyn_cast<Expr>(s)) {
639 // Skip the most common kinds of expressions that make
640 // hierarchy-walking expensive.
641 s = e = e->IgnoreParenCasts();
642
643 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
644 return (ref->getDecl() == &var);
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000645 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
646 const BlockDecl *block = be->getBlockDecl();
Aaron Ballman9371dd22014-03-14 18:34:04 +0000647 for (const auto &I : block->captures()) {
648 if (I.getVariable() == &var)
Fariborz Jahaniana36cbeb2012-06-19 20:53:26 +0000649 return true;
650 }
651 }
John McCall31168b02011-06-15 23:02:42 +0000652 }
653
Benjamin Kramer642f1732015-07-02 21:03:14 +0000654 for (const Stmt *SubStmt : s->children())
655 // SubStmt might be null; as in missing decl or conditional of an if-stmt.
656 if (SubStmt && isAccessedBy(var, SubStmt))
John McCall31168b02011-06-15 23:02:42 +0000657 return true;
658
659 return false;
660}
661
662static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
663 if (!decl) return false;
664 if (!isa<VarDecl>(decl)) return false;
665 const VarDecl *var = cast<VarDecl>(decl);
666 return isAccessedBy(*var, e);
667}
668
John McCallf8a9b662015-10-21 18:06:31 +0000669static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
670 const LValue &destLV, const Expr *init) {
John McCall0204e342015-11-16 22:11:41 +0000671 bool needsCast = false;
672
John McCallf8a9b662015-10-21 18:06:31 +0000673 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
674 switch (castExpr->getCastKind()) {
675 // Look through casts that don't require representation changes.
676 case CK_NoOp:
677 case CK_BitCast:
678 case CK_BlockPointerToObjCPointerCast:
John McCall0204e342015-11-16 22:11:41 +0000679 needsCast = true;
John McCallf8a9b662015-10-21 18:06:31 +0000680 break;
681
682 // If we find an l-value to r-value cast from a __weak variable,
683 // emit this operation as a copy or move.
684 case CK_LValueToRValue: {
685 const Expr *srcExpr = castExpr->getSubExpr();
686 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
687 return false;
688
689 // Emit the source l-value.
690 LValue srcLV = CGF.EmitLValue(srcExpr);
691
John McCall0204e342015-11-16 22:11:41 +0000692 // Handle a formal type change to avoid asserting.
693 auto srcAddr = srcLV.getAddress();
694 if (needsCast) {
695 srcAddr = CGF.Builder.CreateElementBitCast(srcAddr,
696 destLV.getAddress().getElementType());
697 }
698
John McCallf8a9b662015-10-21 18:06:31 +0000699 // If it was an l-value, use objc_copyWeak.
700 if (srcExpr->getValueKind() == VK_LValue) {
John McCall0204e342015-11-16 22:11:41 +0000701 CGF.EmitARCCopyWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000702 } else {
703 assert(srcExpr->getValueKind() == VK_XValue);
John McCall0204e342015-11-16 22:11:41 +0000704 CGF.EmitARCMoveWeak(destLV.getAddress(), srcAddr);
John McCallf8a9b662015-10-21 18:06:31 +0000705 }
706 return true;
707 }
708
709 // Stop at anything else.
710 default:
711 return false;
712 }
713
714 init = castExpr->getSubExpr();
John McCallf8a9b662015-10-21 18:06:31 +0000715 }
716 return false;
717}
718
John McCall1553b192011-06-16 04:16:24 +0000719static void drillIntoBlockVariable(CodeGenFunction &CGF,
720 LValue &lvalue,
721 const VarDecl *var) {
John McCall7f416cc2015-09-08 08:05:57 +0000722 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(), var));
John McCall1553b192011-06-16 04:16:24 +0000723}
724
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000725void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS,
726 SourceLocation Loc) {
727 if (!SanOpts.has(SanitizerKind::NullabilityAssign))
728 return;
729
730 auto Nullability = LHS.getType()->getNullability(getContext());
731 if (!Nullability || *Nullability != NullabilityKind::NonNull)
732 return;
733
734 // Check if the right hand side of the assignment is nonnull, if the left
735 // hand side must be nonnull.
736 SanitizerScope SanScope(this);
737 llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS);
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000738 llvm::Constant *StaticData[] = {
739 EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()),
Simon Pilgrim2df19982017-03-14 21:43:52 +0000740 llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused.
Vedant Kumar2b9f48a2017-03-14 16:48:29 +0000741 llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)};
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000742 EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}},
743 SanitizerHandler::TypeMismatch, StaticData, RHS);
744}
745
David Blaikie73ca5692014-12-09 00:32:22 +0000746void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +0000747 LValue lvalue, bool capturedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000748 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
John McCall31168b02011-06-15 23:02:42 +0000749 if (!lifetime) {
750 llvm::Value *value = EmitScalarExpr(init);
John McCall1553b192011-06-16 04:16:24 +0000751 if (capturedByInit)
752 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000753 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
David Blaikie66e41972015-01-14 07:38:27 +0000754 EmitStoreThroughLValue(RValue::get(value), lvalue, true);
John McCall31168b02011-06-15 23:02:42 +0000755 return;
756 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000757
Fariborz Jahaniana5a469e2014-03-14 15:40:54 +0000758 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
759 init = DIE->getExpr();
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000760
John McCall31168b02011-06-15 23:02:42 +0000761 // If we're emitting a value with lifetime, we have to do the
762 // initialization *before* we leave the cleanup scopes.
Bill Wendling7c44da22018-10-31 03:48:47 +0000763 if (const FullExpr *fe = dyn_cast<FullExpr>(init)) {
764 enterFullExpression(fe);
765 init = fe->getSubExpr();
John McCall08ef4662011-11-10 08:15:53 +0000766 }
767 CodeGenFunction::RunCleanupsScope Scope(*this);
John McCall31168b02011-06-15 23:02:42 +0000768
769 // We have to maintain the illusion that the variable is
770 // zero-initialized. If the variable might be accessed in its
771 // initializer, zero-initialize before running the initializer, then
772 // actually perform the initialization with an assign.
773 bool accessedByInit = false;
774 if (lifetime != Qualifiers::OCL_ExplicitNone)
John McCallb726a552011-07-28 07:23:35 +0000775 accessedByInit = (capturedByInit || isAccessedBy(D, init));
John McCall31168b02011-06-15 23:02:42 +0000776 if (accessedByInit) {
John McCall1553b192011-06-16 04:16:24 +0000777 LValue tempLV = lvalue;
John McCall31168b02011-06-15 23:02:42 +0000778 // Drill down to the __block object if necessary.
John McCall31168b02011-06-15 23:02:42 +0000779 if (capturedByInit) {
780 // We can use a simple GEP for this because it can't have been
781 // moved yet.
John McCall7f416cc2015-09-08 08:05:57 +0000782 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(),
783 cast<VarDecl>(D),
784 /*follow*/ false));
John McCall31168b02011-06-15 23:02:42 +0000785 }
786
John McCall7f416cc2015-09-08 08:05:57 +0000787 auto ty = cast<llvm::PointerType>(tempLV.getAddress().getElementType());
Yaxun Liu402804b2016-12-15 08:09:08 +0000788 llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType());
Eric Christopher31ab1302011-08-23 22:38:00 +0000789
John McCall31168b02011-06-15 23:02:42 +0000790 // If __weak, we want to use a barrier under certain conditions.
791 if (lifetime == Qualifiers::OCL_Weak)
John McCall1553b192011-06-16 04:16:24 +0000792 EmitARCInitWeak(tempLV.getAddress(), zero);
John McCall31168b02011-06-15 23:02:42 +0000793
794 // Otherwise just do a simple store.
795 else
David Chisnallfa35df62012-01-16 17:27:18 +0000796 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000797 }
798
799 // Emit the initializer.
Craig Topper8a13c412014-05-21 05:09:00 +0000800 llvm::Value *value = nullptr;
John McCall31168b02011-06-15 23:02:42 +0000801
802 switch (lifetime) {
803 case Qualifiers::OCL_None:
804 llvm_unreachable("present but none");
805
Erik Pilkington1e368822019-01-04 18:33:06 +0000806 case Qualifiers::OCL_Strong: {
807 if (!D || !isa<VarDecl>(D) || !cast<VarDecl>(D)->isARCPseudoStrong()) {
808 value = EmitARCRetainScalarExpr(init);
809 break;
810 }
811 // If D is pseudo-strong, treat it like __unsafe_unretained here. This means
812 // that we omit the retain, and causes non-autoreleased return values to be
813 // immediately released.
814 LLVM_FALLTHROUGH;
815 }
816
John McCall31168b02011-06-15 23:02:42 +0000817 case Qualifiers::OCL_ExplicitNone:
John McCalle399e5b2016-01-27 18:32:30 +0000818 value = EmitARCUnsafeUnretainedScalarExpr(init);
John McCall31168b02011-06-15 23:02:42 +0000819 break;
820
John McCall31168b02011-06-15 23:02:42 +0000821 case Qualifiers::OCL_Weak: {
John McCallf8a9b662015-10-21 18:06:31 +0000822 // If it's not accessed by the initializer, try to emit the
823 // initialization with a copy or move.
824 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
825 return;
826 }
827
John McCall31168b02011-06-15 23:02:42 +0000828 // No way to optimize a producing initializer into this. It's not
829 // worth optimizing for, because the value will immediately
830 // disappear in the common case.
831 value = EmitScalarExpr(init);
832
John McCall1553b192011-06-16 04:16:24 +0000833 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000834 if (accessedByInit)
John McCall1553b192011-06-16 04:16:24 +0000835 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +0000836 else
John McCall1553b192011-06-16 04:16:24 +0000837 EmitARCInitWeak(lvalue.getAddress(), value);
John McCall31168b02011-06-15 23:02:42 +0000838 return;
839 }
840
841 case Qualifiers::OCL_Autoreleasing:
842 value = EmitARCRetainAutoreleaseScalarExpr(init);
843 break;
844 }
845
John McCall1553b192011-06-16 04:16:24 +0000846 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
John McCall31168b02011-06-15 23:02:42 +0000847
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000848 EmitNullabilityCheck(lvalue, value, init->getExprLoc());
849
John McCall31168b02011-06-15 23:02:42 +0000850 // If the variable might have been accessed by its initializer, we
851 // might have to initialize with a barrier. We have to do this for
852 // both __weak and __strong, but __weak got filtered out above.
853 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000854 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
David Chisnallfa35df62012-01-16 17:27:18 +0000855 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCallcdda29c2013-03-13 03:10:54 +0000856 EmitARCRelease(oldValue, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +0000857 return;
858 }
859
David Chisnallfa35df62012-01-16 17:27:18 +0000860 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
John McCall31168b02011-06-15 23:02:42 +0000861}
Chris Lattnerb85025f2010-12-01 02:05:19 +0000862
JF Bastiened92f602018-07-20 23:37:12 +0000863/// Decide whether we can emit the non-zero parts of the specified initializer
864/// with equal or fewer than NumStores scalar stores.
865static bool canEmitInitWithFewStoresAfterBZero(llvm::Constant *Init,
866 unsigned &NumStores) {
Chris Lattnere6af8862010-12-02 01:58:41 +0000867 // Zero and Undef never requires any extra stores.
868 if (isa<llvm::ConstantAggregateZero>(Init) ||
869 isa<llvm::ConstantPointerNull>(Init) ||
870 isa<llvm::UndefValue>(Init))
871 return true;
872 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
873 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
874 isa<llvm::ConstantExpr>(Init))
875 return Init->isNullValue() || NumStores--;
876
877 // See if we can emit each element.
878 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
879 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
880 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
JF Bastiened92f602018-07-20 23:37:12 +0000881 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattnere6af8862010-12-02 01:58:41 +0000882 return false;
883 }
884 return true;
885 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000886
Chris Lattner236b3572012-01-31 04:36:19 +0000887 if (llvm::ConstantDataSequential *CDS =
888 dyn_cast<llvm::ConstantDataSequential>(Init)) {
889 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
890 llvm::Constant *Elt = CDS->getElementAsConstant(i);
JF Bastiened92f602018-07-20 23:37:12 +0000891 if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
Chris Lattner236b3572012-01-31 04:36:19 +0000892 return false;
893 }
894 return true;
895 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000896
Chris Lattnerb85025f2010-12-01 02:05:19 +0000897 // Anything else is hard and scary.
898 return false;
899}
900
JF Bastiened92f602018-07-20 23:37:12 +0000901/// For inits that canEmitInitWithFewStoresAfterBZero returned true for, emit
902/// the scalar stores that would be required.
903static void emitStoresForInitAfterBZero(CodeGenModule &CGM,
904 llvm::Constant *Init, Address Loc,
905 bool isVolatile, CGBuilderTy &Builder) {
Benjamin Kramer29f9a002012-08-27 22:07:02 +0000906 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
JF Bastiened92f602018-07-20 23:37:12 +0000907 "called emitStoresForInitAfterBZero for zero or undef value.");
Eric Christopher31ab1302011-08-23 22:38:00 +0000908
Chris Lattnere6af8862010-12-02 01:58:41 +0000909 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
910 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
911 isa<llvm::ConstantExpr>(Init)) {
JF Bastien9aab85a2018-07-13 20:33:23 +0000912 Builder.CreateStore(Init, Loc, isVolatile);
Chris Lattner236b3572012-01-31 04:36:19 +0000913 return;
914 }
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000915
916 if (llvm::ConstantDataSequential *CDS =
917 dyn_cast<llvm::ConstantDataSequential>(Init)) {
Chris Lattner236b3572012-01-31 04:36:19 +0000918 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
919 llvm::Constant *Elt = CDS->getElementAsConstant(i);
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000920
921 // If necessary, get a pointer to the element and emit it.
922 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
JF Bastiened92f602018-07-20 23:37:12 +0000923 emitStoresForInitAfterBZero(
James Y Knight751fe282019-02-09 22:22:28 +0000924 CGM, Elt, Builder.CreateConstInBoundsGEP2_32(Loc, 0, i), isVolatile,
925 Builder);
Chris Lattner236b3572012-01-31 04:36:19 +0000926 }
Chris Lattnere6af8862010-12-02 01:58:41 +0000927 return;
928 }
Eric Christopher31ab1302011-08-23 22:38:00 +0000929
Chris Lattnere6af8862010-12-02 01:58:41 +0000930 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
931 "Unknown value type!");
Eric Christopher31ab1302011-08-23 22:38:00 +0000932
Chris Lattnere6af8862010-12-02 01:58:41 +0000933 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
934 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
Benjamin Kramer46cbe772012-08-27 21:35:58 +0000935
936 // If necessary, get a pointer to the element and emit it.
937 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
James Y Knight751fe282019-02-09 22:22:28 +0000938 emitStoresForInitAfterBZero(CGM, Elt,
939 Builder.CreateConstInBoundsGEP2_32(Loc, 0, i),
940 isVolatile, Builder);
Chris Lattnere6af8862010-12-02 01:58:41 +0000941 }
Chris Lattnerb85025f2010-12-01 02:05:19 +0000942}
943
JF Bastiened92f602018-07-20 23:37:12 +0000944/// Decide whether we should use bzero plus some stores to initialize a local
945/// variable instead of using a memcpy from a constant global. It is beneficial
946/// to use bzero if the global is all zeros, or mostly zeros and large.
947static bool shouldUseBZeroPlusStoresToInitialize(llvm::Constant *Init,
948 uint64_t GlobalSize) {
949 // If a global is all zeros, always use a bzero.
Chris Lattnerb85025f2010-12-01 02:05:19 +0000950 if (isa<llvm::ConstantAggregateZero>(Init)) return true;
951
Chris Lattnerb85025f2010-12-01 02:05:19 +0000952 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large,
953 // do it if it will require 6 or fewer scalar stores.
954 // TODO: Should budget depends on the size? Avoiding a large global warrants
955 // plopping in more stores.
956 unsigned StoreBudget = 6;
957 uint64_t SizeLimit = 32;
Eric Christopher31ab1302011-08-23 22:38:00 +0000958
959 return GlobalSize > SizeLimit &&
JF Bastiened92f602018-07-20 23:37:12 +0000960 canEmitInitWithFewStoresAfterBZero(Init, StoreBudget);
Chris Lattnerb85025f2010-12-01 02:05:19 +0000961}
962
JF Bastien65089292018-07-25 04:29:03 +0000963/// Decide whether we should use memset to initialize a local variable instead
964/// of using a memcpy from a constant global. Assumes we've already decided to
965/// not user bzero.
966/// FIXME We could be more clever, as we are for bzero above, and generate
967/// memset followed by stores. It's unclear that's worth the effort.
JF Bastien2f0582f2018-09-21 13:54:09 +0000968static llvm::Value *shouldUseMemSetToInitialize(llvm::Constant *Init,
969 uint64_t GlobalSize) {
JF Bastien65089292018-07-25 04:29:03 +0000970 uint64_t SizeLimit = 32;
971 if (GlobalSize <= SizeLimit)
JF Bastien2f0582f2018-09-21 13:54:09 +0000972 return nullptr;
973 return llvm::isBytewiseValue(Init);
JF Bastien65089292018-07-25 04:29:03 +0000974}
975
JF Bastienb5e5bc72019-03-08 01:26:49 +0000976/// Decide whether we want to split a constant structure or array store into a
977/// sequence of its fields' stores. This may cost us code size and compilation
978/// speed, but plays better with store optimizations.
979static bool shouldSplitConstantStore(CodeGenModule &CGM,
980 uint64_t GlobalByteSize) {
981 // Don't break things that occupy more than one cacheline.
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +0000982 uint64_t ByteSizeLimit = 64;
983 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
984 return false;
985 if (GlobalByteSize <= ByteSizeLimit)
986 return true;
987 return false;
988}
989
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000990enum class IsPattern { No, Yes };
991
992/// Generate a constant filled with either a pattern or zeroes.
993static llvm::Constant *patternOrZeroFor(CodeGenModule &CGM, IsPattern isPattern,
994 llvm::Type *Ty) {
995 if (isPattern == IsPattern::Yes)
JF Bastienef202c32019-04-12 00:11:27 +0000996 return initializationPatternFor(CGM, Ty);
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +0000997 else
998 return llvm::Constant::getNullValue(Ty);
999}
1000
1001static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1002 llvm::Constant *constant);
1003
1004/// Helper function for constWithPadding() to deal with padding in structures.
1005static llvm::Constant *constStructWithPadding(CodeGenModule &CGM,
1006 IsPattern isPattern,
1007 llvm::StructType *STy,
1008 llvm::Constant *constant) {
1009 const llvm::DataLayout &DL = CGM.getDataLayout();
1010 const llvm::StructLayout *Layout = DL.getStructLayout(STy);
1011 llvm::Type *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext());
1012 unsigned SizeSoFar = 0;
1013 SmallVector<llvm::Constant *, 8> Values;
1014 bool NestedIntact = true;
1015 for (unsigned i = 0, e = STy->getNumElements(); i != e; i++) {
1016 unsigned CurOff = Layout->getElementOffset(i);
1017 if (SizeSoFar < CurOff) {
1018 assert(!STy->isPacked());
1019 auto *PadTy = llvm::ArrayType::get(Int8Ty, CurOff - SizeSoFar);
1020 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1021 }
1022 llvm::Constant *CurOp;
1023 if (constant->isZeroValue())
1024 CurOp = llvm::Constant::getNullValue(STy->getElementType(i));
1025 else
1026 CurOp = cast<llvm::Constant>(constant->getAggregateElement(i));
1027 auto *NewOp = constWithPadding(CGM, isPattern, CurOp);
1028 if (CurOp != NewOp)
1029 NestedIntact = false;
1030 Values.push_back(NewOp);
1031 SizeSoFar = CurOff + DL.getTypeAllocSize(CurOp->getType());
1032 }
1033 unsigned TotalSize = Layout->getSizeInBytes();
1034 if (SizeSoFar < TotalSize) {
1035 auto *PadTy = llvm::ArrayType::get(Int8Ty, TotalSize - SizeSoFar);
1036 Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1037 }
1038 if (NestedIntact && Values.size() == STy->getNumElements())
1039 return constant;
Peter Collingbourne68b46732019-03-16 19:25:39 +00001040 return llvm::ConstantStruct::getAnon(Values, STy->isPacked());
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001041}
1042
1043/// Replace all padding bytes in a given constant with either a pattern byte or
1044/// 0x00.
1045static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1046 llvm::Constant *constant) {
1047 llvm::Type *OrigTy = constant->getType();
1048 if (const auto STy = dyn_cast<llvm::StructType>(OrigTy))
1049 return constStructWithPadding(CGM, isPattern, STy, constant);
1050 if (auto *STy = dyn_cast<llvm::SequentialType>(OrigTy)) {
1051 llvm::SmallVector<llvm::Constant *, 8> Values;
1052 unsigned Size = STy->getNumElements();
1053 if (!Size)
1054 return constant;
1055 llvm::Type *ElemTy = STy->getElementType();
1056 bool ZeroInitializer = constant->isZeroValue();
1057 llvm::Constant *OpValue, *PaddedOp;
1058 if (ZeroInitializer) {
1059 OpValue = llvm::Constant::getNullValue(ElemTy);
1060 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1061 }
1062 for (unsigned Op = 0; Op != Size; ++Op) {
1063 if (!ZeroInitializer) {
1064 OpValue = constant->getAggregateElement(Op);
1065 PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1066 }
1067 Values.push_back(PaddedOp);
1068 }
1069 auto *NewElemTy = Values[0]->getType();
1070 if (NewElemTy == ElemTy)
1071 return constant;
1072 if (OrigTy->isArrayTy()) {
1073 auto *ArrayTy = llvm::ArrayType::get(NewElemTy, Size);
1074 return llvm::ConstantArray::get(ArrayTy, Values);
1075 } else {
1076 return llvm::ConstantVector::get(Values);
1077 }
1078 }
1079 return constant;
1080}
1081
Richard Smith24cdcad2019-06-14 17:46:37 +00001082Address CodeGenModule::createUnnamedGlobalFrom(const VarDecl &D,
1083 llvm::Constant *Constant,
1084 CharUnits Align) {
JF Bastien3a881e62018-11-15 00:19:18 +00001085 auto FunctionName = [&](const DeclContext *DC) -> std::string {
1086 if (const auto *FD = dyn_cast<FunctionDecl>(DC)) {
1087 if (const auto *CC = dyn_cast<CXXConstructorDecl>(FD))
1088 return CC->getNameAsString();
1089 if (const auto *CD = dyn_cast<CXXDestructorDecl>(FD))
1090 return CD->getNameAsString();
Richard Smith24cdcad2019-06-14 17:46:37 +00001091 return getMangledName(FD);
JF Bastien3a881e62018-11-15 00:19:18 +00001092 } else if (const auto *OM = dyn_cast<ObjCMethodDecl>(DC)) {
1093 return OM->getNameAsString();
Mikael Holmenee846762018-11-15 13:01:54 +00001094 } else if (isa<BlockDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001095 return "<block>";
Mikael Holmenee846762018-11-15 13:01:54 +00001096 } else if (isa<CapturedDecl>(DC)) {
JF Bastien3a881e62018-11-15 00:19:18 +00001097 return "<captured>";
1098 } else {
Richard Smith24cdcad2019-06-14 17:46:37 +00001099 llvm_unreachable("expected a function or method");
JF Bastien3a881e62018-11-15 00:19:18 +00001100 }
1101 };
1102
Richard Smith24cdcad2019-06-14 17:46:37 +00001103 // Form a simple per-variable cache of these values in case we find we
1104 // want to reuse them.
1105 llvm::GlobalVariable *&CacheEntry = InitializerConstants[&D];
1106 if (!CacheEntry || CacheEntry->getInitializer() != Constant) {
1107 auto *Ty = Constant->getType();
1108 bool isConstant = true;
1109 llvm::GlobalVariable *InsertBefore = nullptr;
1110 unsigned AS =
1111 getContext().getTargetAddressSpace(getStringLiteralAddressSpace());
1112 std::string Name;
1113 if (D.hasGlobalStorage())
1114 Name = getMangledName(&D).str() + ".const";
1115 else if (const DeclContext *DC = D.getParentFunctionOrMethod())
1116 Name = ("__const." + FunctionName(DC) + "." + D.getName()).str();
1117 else
1118 llvm_unreachable("local variable has no parent function or method");
1119 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
1120 getModule(), Ty, isConstant, llvm::GlobalValue::PrivateLinkage,
1121 Constant, Name, InsertBefore, llvm::GlobalValue::NotThreadLocal, AS);
1122 GV->setAlignment(Align.getQuantity());
1123 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1124 CacheEntry = GV;
1125 } else if (CacheEntry->getAlignment() < Align.getQuantity()) {
1126 CacheEntry->setAlignment(Align.getQuantity());
1127 }
JF Bastien3a881e62018-11-15 00:19:18 +00001128
Richard Smith24cdcad2019-06-14 17:46:37 +00001129 return Address(CacheEntry, Align);
1130}
1131
1132static Address createUnnamedGlobalForMemcpyFrom(CodeGenModule &CGM,
1133 const VarDecl &D,
1134 CGBuilderTy &Builder,
1135 llvm::Constant *Constant,
1136 CharUnits Align) {
1137 Address SrcPtr = CGM.createUnnamedGlobalFrom(D, Constant, Align);
1138 llvm::Type *BP = llvm::PointerType::getInt8PtrTy(CGM.getLLVMContext(),
1139 SrcPtr.getAddressSpace());
JF Bastien3a881e62018-11-15 00:19:18 +00001140 if (SrcPtr.getType() != BP)
1141 SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
1142 return SrcPtr;
1143}
1144
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001145static void emitStoresForConstant(CodeGenModule &CGM, const VarDecl &D,
1146 Address Loc, bool isVolatile,
1147 CGBuilderTy &Builder,
1148 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001149 auto *Ty = constant->getType();
Vitaly Bukaf35a3452019-06-27 02:08:15 +00001150 uint64_t ConstantSize = CGM.getDataLayout().getTypeAllocSize(Ty);
1151 if (!ConstantSize)
1152 return;
1153
JF Bastienb5e5bc72019-03-08 01:26:49 +00001154 bool canDoSingleStore = Ty->isIntOrIntVectorTy() ||
1155 Ty->isPtrOrPtrVectorTy() || Ty->isFPOrFPVectorTy();
1156 if (canDoSingleStore) {
JF Bastien14daa202018-12-18 05:12:21 +00001157 Builder.CreateStore(constant, Loc, isVolatile);
1158 return;
1159 }
1160
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001161 auto *SizeVal = llvm::ConstantInt::get(CGM.IntPtrTy, ConstantSize);
JF Bastienb5e5bc72019-03-08 01:26:49 +00001162
1163 // If the initializer is all or mostly the same, codegen with bzero / memset
1164 // then do a few stores afterward.
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001165 if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) {
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001166 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, 0), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001167 isVolatile);
1168
1169 bool valueAlreadyCorrect =
1170 constant->isNullValue() || isa<llvm::UndefValue>(constant);
1171 if (!valueAlreadyCorrect) {
JF Bastien14daa202018-12-18 05:12:21 +00001172 Loc = Builder.CreateBitCast(Loc, Ty->getPointerTo(Loc.getAddressSpace()));
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001173 emitStoresForInitAfterBZero(CGM, constant, Loc, isVolatile, Builder);
1174 }
1175 return;
1176 }
1177
JF Bastienb5e5bc72019-03-08 01:26:49 +00001178 // If the initializer is a repeated byte pattern, use memset.
JF Bastien2f0582f2018-09-21 13:54:09 +00001179 llvm::Value *Pattern = shouldUseMemSetToInitialize(constant, ConstantSize);
1180 if (Pattern) {
1181 uint64_t Value = 0x00;
1182 if (!isa<llvm::UndefValue>(Pattern)) {
1183 const llvm::APInt &AP = cast<llvm::ConstantInt>(Pattern)->getValue();
1184 assert(AP.getBitWidth() <= 8);
1185 Value = AP.getLimitedValue();
1186 }
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001187 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, Value), SizeVal,
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001188 isVolatile);
1189 return;
1190 }
1191
JF Bastienb5e5bc72019-03-08 01:26:49 +00001192 // If the initializer is small, use a handful of stores.
1193 if (shouldSplitConstantStore(CGM, ConstantSize)) {
1194 if (auto *STy = dyn_cast<llvm::StructType>(Ty)) {
1195 // FIXME: handle the case when STy != Loc.getElementType().
1196 if (STy == Loc.getElementType()) {
1197 for (unsigned i = 0; i != constant->getNumOperands(); i++) {
1198 Address EltPtr = Builder.CreateStructGEP(Loc, i);
1199 emitStoresForConstant(
1200 CGM, D, EltPtr, isVolatile, Builder,
1201 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1202 }
1203 return;
1204 }
1205 } else if (auto *ATy = dyn_cast<llvm::ArrayType>(Ty)) {
1206 // FIXME: handle the case when ATy != Loc.getElementType().
1207 if (ATy == Loc.getElementType()) {
1208 for (unsigned i = 0; i != ATy->getNumElements(); i++) {
1209 Address EltPtr = Builder.CreateConstArrayGEP(Loc, i);
1210 emitStoresForConstant(
1211 CGM, D, EltPtr, isVolatile, Builder,
1212 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1213 }
1214 return;
1215 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001216 }
Alexander Potapenkofa61ddd2019-03-01 09:00:41 +00001217 }
1218
JF Bastienb5e5bc72019-03-08 01:26:49 +00001219 // Copy from a global.
Richard Smith24cdcad2019-06-14 17:46:37 +00001220 Builder.CreateMemCpy(Loc,
1221 createUnnamedGlobalForMemcpyFrom(
1222 CGM, D, Builder, constant, Loc.getAlignment()),
1223 SizeVal, isVolatile);
JF Bastienb9cc1fc2018-08-07 21:55:13 +00001224}
1225
JF Bastien14daa202018-12-18 05:12:21 +00001226static void emitStoresForZeroInit(CodeGenModule &CGM, const VarDecl &D,
1227 Address Loc, bool isVolatile,
1228 CGBuilderTy &Builder) {
1229 llvm::Type *ElTy = Loc.getElementType();
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001230 llvm::Constant *constant =
1231 constWithPadding(CGM, IsPattern::No, llvm::Constant::getNullValue(ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001232 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1233}
1234
1235static void emitStoresForPatternInit(CodeGenModule &CGM, const VarDecl &D,
1236 Address Loc, bool isVolatile,
1237 CGBuilderTy &Builder) {
1238 llvm::Type *ElTy = Loc.getElementType();
JF Bastienef202c32019-04-12 00:11:27 +00001239 llvm::Constant *constant = constWithPadding(
1240 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001241 assert(!isa<llvm::UndefValue>(constant));
1242 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1243}
1244
1245static bool containsUndef(llvm::Constant *constant) {
1246 auto *Ty = constant->getType();
1247 if (isa<llvm::UndefValue>(constant))
1248 return true;
1249 if (Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy())
1250 for (llvm::Use &Op : constant->operands())
1251 if (containsUndef(cast<llvm::Constant>(Op)))
1252 return true;
1253 return false;
1254}
1255
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001256static llvm::Constant *replaceUndef(CodeGenModule &CGM, IsPattern isPattern,
1257 llvm::Constant *constant) {
JF Bastien14daa202018-12-18 05:12:21 +00001258 auto *Ty = constant->getType();
1259 if (isa<llvm::UndefValue>(constant))
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001260 return patternOrZeroFor(CGM, isPattern, Ty);
JF Bastien14daa202018-12-18 05:12:21 +00001261 if (!(Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()))
1262 return constant;
1263 if (!containsUndef(constant))
1264 return constant;
1265 llvm::SmallVector<llvm::Constant *, 8> Values(constant->getNumOperands());
1266 for (unsigned Op = 0, NumOp = constant->getNumOperands(); Op != NumOp; ++Op) {
1267 auto *OpValue = cast<llvm::Constant>(constant->getOperand(Op));
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001268 Values[Op] = replaceUndef(CGM, isPattern, OpValue);
JF Bastien14daa202018-12-18 05:12:21 +00001269 }
1270 if (Ty->isStructTy())
1271 return llvm::ConstantStruct::get(cast<llvm::StructType>(Ty), Values);
1272 if (Ty->isArrayTy())
1273 return llvm::ConstantArray::get(cast<llvm::ArrayType>(Ty), Values);
1274 assert(Ty->isVectorTy());
1275 return llvm::ConstantVector::get(Values);
1276}
1277
Nick Lewycky8a7d90b2010-12-30 20:21:55 +00001278/// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
Chris Lattner03df1222007-06-02 04:53:11 +00001279/// variable declaration with auto, register, or no storage class specifier.
Chris Lattnerb781dc792008-05-08 05:58:21 +00001280/// These turn into simple stack objects, or GlobalValues depending on target.
John McCallc533cb72011-02-22 06:44:22 +00001281void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
1282 AutoVarEmission emission = EmitAutoVarAlloca(D);
1283 EmitAutoVarInit(emission);
1284 EmitAutoVarCleanups(emission);
1285}
Chris Lattner03df1222007-06-02 04:53:11 +00001286
David Majnemerdc012fa2015-04-22 21:38:15 +00001287/// Emit a lifetime.begin marker if some criteria are satisfied.
1288/// \return a pointer to the temporary size Value if a marker was emitted, null
1289/// otherwise
1290llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
1291 llvm::Value *Addr) {
Vitaly Buka1c943322016-10-26 01:59:57 +00001292 if (!ShouldEmitLifetimeMarkers)
Reid Kleckner1ef49212015-04-23 18:07:13 +00001293 return nullptr;
1294
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001295 assert(Addr->getType()->getPointerAddressSpace() ==
1296 CGM.getDataLayout().getAllocaAddrSpace() &&
1297 "Pointer should be in alloca address space");
David Majnemerdc012fa2015-04-22 21:38:15 +00001298 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001299 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001300 llvm::CallInst *C =
1301 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001302 C->setDoesNotThrow();
1303 return SizeV;
1304}
1305
1306void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001307 assert(Addr->getType()->getPointerAddressSpace() ==
1308 CGM.getDataLayout().getAllocaAddrSpace() &&
1309 "Pointer should be in alloca address space");
Yaxun Liu7f7f3232017-04-17 20:03:11 +00001310 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
Alexey Samsonovd918ff62015-06-12 22:31:32 +00001311 llvm::CallInst *C =
1312 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr});
David Majnemerdc012fa2015-04-22 21:38:15 +00001313 C->setDoesNotThrow();
1314}
1315
Sander de Smalen891af03a2018-02-03 13:55:59 +00001316void CodeGenFunction::EmitAndRegisterVariableArrayDimensions(
1317 CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) {
1318 // For each dimension stores its QualType and corresponding
1319 // size-expression Value.
1320 SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions;
Adrian Prantla40cce82018-11-09 19:17:56 +00001321 SmallVector<IdentifierInfo *, 4> VLAExprNames;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001322
1323 // Break down the array into individual dimensions.
1324 QualType Type1D = D.getType();
1325 while (getContext().getAsVariableArrayType(Type1D)) {
1326 auto VlaSize = getVLAElements1D(Type1D);
1327 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1328 Dimensions.emplace_back(C, Type1D.getUnqualifiedType());
1329 else {
Adrian Prantla40cce82018-11-09 19:17:56 +00001330 // Generate a locally unique name for the size expression.
1331 Twine Name = Twine("__vla_expr") + Twine(VLAExprCounter++);
1332 SmallString<12> Buffer;
1333 StringRef NameRef = Name.toStringRef(Buffer);
1334 auto &Ident = getContext().Idents.getOwn(NameRef);
1335 VLAExprNames.push_back(&Ident);
1336 auto SizeExprAddr =
1337 CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), NameRef);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001338 Builder.CreateStore(VlaSize.NumElts, SizeExprAddr);
1339 Dimensions.emplace_back(SizeExprAddr.getPointer(),
1340 Type1D.getUnqualifiedType());
1341 }
1342 Type1D = VlaSize.Type;
1343 }
1344
1345 if (!EmitDebugInfo)
1346 return;
1347
1348 // Register each dimension's size-expression with a DILocalVariable,
1349 // so that it can be used by CGDebugInfo when instantiating a DISubrange
1350 // to describe this array.
Adrian Prantla40cce82018-11-09 19:17:56 +00001351 unsigned NameIdx = 0;
Sander de Smalen891af03a2018-02-03 13:55:59 +00001352 for (auto &VlaSize : Dimensions) {
1353 llvm::Metadata *MD;
1354 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1355 MD = llvm::ConstantAsMetadata::get(C);
1356 else {
1357 // Create an artificial VarDecl to generate debug info for.
Adrian Prantla40cce82018-11-09 19:17:56 +00001358 IdentifierInfo *NameIdent = VLAExprNames[NameIdx++];
Sander de Smalen891af03a2018-02-03 13:55:59 +00001359 auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType();
1360 auto QT = getContext().getIntTypeForBitwidth(
1361 VlaExprTy->getScalarSizeInBits(), false);
1362 auto *ArtificialDecl = VarDecl::Create(
1363 getContext(), const_cast<DeclContext *>(D.getDeclContext()),
Adrian Prantla40cce82018-11-09 19:17:56 +00001364 D.getLocation(), D.getLocation(), NameIdent, QT,
Sander de Smalen891af03a2018-02-03 13:55:59 +00001365 getContext().CreateTypeSourceInfo(QT), SC_Auto);
Sander de Smalen9084a3b2018-02-13 07:49:34 +00001366 ArtificialDecl->setImplicit();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001367
1368 MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts,
1369 Builder);
1370 }
1371 assert(MD && "No Size expression debug node created");
1372 DI->registerVLASizeExpression(VlaSize.Type, MD);
1373 }
1374}
1375
John McCallc533cb72011-02-22 06:44:22 +00001376/// EmitAutoVarAlloca - Emit the alloca and debug information for a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001377/// local variable. Does not emit initialization or destruction.
John McCallc533cb72011-02-22 06:44:22 +00001378CodeGenFunction::AutoVarEmission
1379CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
1380 QualType Ty = D.getType();
Yaxun Liub7318e02017-10-13 03:37:48 +00001381 assert(
1382 Ty.getAddressSpace() == LangAS::Default ||
1383 (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL));
John McCallc533cb72011-02-22 06:44:22 +00001384
1385 AutoVarEmission emission(D);
1386
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001387 bool isEscapingByRef = D.isEscapingByref();
1388 emission.IsEscapingByRef = isEscapingByRef;
John McCallc533cb72011-02-22 06:44:22 +00001389
1390 CharUnits alignment = getContext().getDeclAlign(&D);
John McCallc533cb72011-02-22 06:44:22 +00001391
John McCall23c29fe2011-06-24 21:55:10 +00001392 // If the type is variably-modified, emit all the VLA sizes for it.
1393 if (Ty->isVariablyModifiedType())
1394 EmitVariablyModifiedType(Ty);
1395
Sander de Smalen891af03a2018-02-03 13:55:59 +00001396 auto *DI = getDebugInfo();
1397 bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >=
1398 codegenoptions::LimitedDebugInfo;
1399
John McCall7f416cc2015-09-08 08:05:57 +00001400 Address address = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001401 Address AllocaAddr = Address::invalid();
Alexey Bataev9c397812019-04-03 17:57:06 +00001402 Address OpenMPLocalAddr =
1403 getLangOpts().OpenMP
1404 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
1405 : Address::invalid();
Amy Huang7fac5c82019-06-20 17:15:21 +00001406 bool NRVO = getLangOpts().ElideConstructors && D.isNRVOVariable();
1407
Alexey Bataev9c397812019-04-03 17:57:06 +00001408 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
1409 address = OpenMPLocalAddr;
1410 } else if (Ty->isConstantSizeType()) {
Richard Smith2bcde3a2013-06-02 00:09:52 +00001411 // If this value is an array or struct with a statically determinable
1412 // constant initializer, there are optimizations we can do.
Rafael Espindola609f5d92013-03-26 18:41:47 +00001413 //
1414 // TODO: We should constant-evaluate the initializer of any variable,
1415 // as long as it is initialized by a constant expression. Currently,
1416 // isConstantInitializer produces wrong answers for structs with
1417 // reference or bitfield members, and a few other cases, and checking
1418 // for POD-ness protects us from some of these.
Richard Smith2bcde3a2013-06-02 00:09:52 +00001419 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
1420 (D.isConstexpr() ||
1421 ((Ty.isPODType(getContext()) ||
1422 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
1423 D.getInit()->isConstantInitializer(getContext(), false)))) {
John McCallc533cb72011-02-22 06:44:22 +00001424
Rafael Espindola609f5d92013-03-26 18:41:47 +00001425 // If the variable's a const type, and it's neither an NRVO
1426 // candidate nor a __block variable and has no mutable members,
1427 // emit it as a global instead.
Anastasia Stulovae4a1c382016-11-29 17:01:19 +00001428 // Exception is if a variable is located in non-constant address space
1429 // in OpenCL.
1430 if ((!getLangOpts().OpenCL ||
1431 Ty.getAddressSpace() == LangAS::opencl_constant) &&
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001432 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO &&
1433 !isEscapingByRef && CGM.isTypeConstant(Ty, true))) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001434 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
John McCallc533cb72011-02-22 06:44:22 +00001435
John McCall7f416cc2015-09-08 08:05:57 +00001436 // Signal this condition to later callbacks.
1437 emission.Addr = Address::invalid();
Rafael Espindola609f5d92013-03-26 18:41:47 +00001438 assert(emission.wasEmittedAsGlobal());
1439 return emission;
Tanya Lattnerf9d41df2009-11-04 01:18:09 +00001440 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001441
Rafael Espindola609f5d92013-03-26 18:41:47 +00001442 // Otherwise, tell the initialization code that we're in this case.
1443 emission.IsConstantAggregate = true;
1444 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001445
Rafael Espindola609f5d92013-03-26 18:41:47 +00001446 // A normal fixed sized variable becomes an alloca in the entry block,
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001447 // unless:
1448 // - it's an NRVO variable.
1449 // - we are compiling OpenMP and it's an OpenMP local variable.
Alexey Bataev9c397812019-04-03 17:57:06 +00001450 if (NRVO) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001451 // The named return value optimization: allocate this variable in the
1452 // return slot, so that we can elide the copy when returning this
1453 // variable (C++0x [class.copy]p34).
John McCall7f416cc2015-09-08 08:05:57 +00001454 address = ReturnValue;
Eric Christopher31ab1302011-08-23 22:38:00 +00001455
Rafael Espindola609f5d92013-03-26 18:41:47 +00001456 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001457 const auto *RD = RecordTy->getDecl();
1458 const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1459 if ((CXXRD && !CXXRD->hasTrivialDestructor()) ||
1460 RD->isNonTrivialToPrimitiveDestroy()) {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001461 // Create a flag that is used to indicate when the NRVO was applied
1462 // to this variable. Set it to zero to indicate that NRVO was not
1463 // applied.
1464 llvm::Value *Zero = Builder.getFalse();
John McCall7f416cc2015-09-08 08:05:57 +00001465 Address NRVOFlag =
1466 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
Rafael Espindola609f5d92013-03-26 18:41:47 +00001467 EnsureInsertPoint();
1468 Builder.CreateStore(Zero, NRVOFlag);
Eric Christopher31ab1302011-08-23 22:38:00 +00001469
Rafael Espindola609f5d92013-03-26 18:41:47 +00001470 // Record the NRVO flag for this variable.
John McCall7f416cc2015-09-08 08:05:57 +00001471 NRVOFlags[&D] = NRVOFlag.getPointer();
1472 emission.NRVOFlag = NRVOFlag.getPointer();
Nadav Rotem1da30942013-03-23 06:43:35 +00001473 }
Douglas Gregor290c93e2010-05-15 06:46:45 +00001474 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001475 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001476 CharUnits allocaAlignment;
1477 llvm::Type *allocaTy;
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001478 if (isEscapingByRef) {
John McCall7f416cc2015-09-08 08:05:57 +00001479 auto &byrefInfo = getBlockByrefInfo(&D);
1480 allocaTy = byrefInfo.Type;
1481 allocaAlignment = byrefInfo.ByrefAlignment;
1482 } else {
1483 allocaTy = ConvertTypeForMem(Ty);
1484 allocaAlignment = alignment;
1485 }
Rafael Espindola609f5d92013-03-26 18:41:47 +00001486
John McCall999110f2015-09-08 09:18:30 +00001487 // Create the alloca. Note that we set the name separately from
1488 // building the instruction so that it's there even in no-asserts
1489 // builds.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001490 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName(),
1491 /*ArraySize=*/nullptr, &AllocaAddr);
Rafael Espindola609f5d92013-03-26 18:41:47 +00001492
Reid Kleckner1f88e932015-10-07 21:03:41 +00001493 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1494 // the catch parameter starts in the catchpad instruction, and we can't
1495 // insert code in those basic blocks.
1496 bool IsMSCatchParam =
1497 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1498
Vitaly Buka64c80b42016-10-26 05:42:30 +00001499 // Emit a lifetime intrinsic if meaningful. There's no point in doing this
1500 // if we don't have a valid insertion point (?).
Reid Kleckner1f88e932015-10-07 21:03:41 +00001501 if (HaveInsertPoint() && !IsMSCatchParam) {
Akira Hatanakafdcd18b2017-01-25 22:55:13 +00001502 // If there's a jump into the lifetime of this variable, its lifetime
1503 // gets broken up into several regions in IR, which requires more work
1504 // to handle correctly. For now, just omit the intrinsics; this is a
1505 // rare case, and it's better to just be conservatively correct.
1506 // PR28267.
1507 //
1508 // We have to do this in all language modes if there's a jump past the
1509 // declaration. We also have to do it in C if there's a jump to an
1510 // earlier point in the current block because non-VLA lifetimes begin as
1511 // soon as the containing block is entered, not when its variables
1512 // actually come into scope; suppressing the lifetime annotations
1513 // completely in this case is unnecessarily pessimistic, but again, this
1514 // is rare.
1515 if (!Bypasses.IsBypassed(&D) &&
1516 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) {
Vitaly Buka64c80b42016-10-26 05:42:30 +00001517 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1518 emission.SizeForLifetimeMarkers =
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001519 EmitLifetimeStart(size, AllocaAddr.getPointer());
Vitaly Buka64c80b42016-10-26 05:42:30 +00001520 }
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001521 } else {
Rafael Espindola609f5d92013-03-26 18:41:47 +00001522 assert(!emission.useLifetimeMarkers());
Arnaud A. de Grandmaisone69ec552014-10-08 14:04:26 +00001523 }
Chris Lattnerb781dc792008-05-08 05:58:21 +00001524 }
Chris Lattner03df1222007-06-02 04:53:11 +00001525 } else {
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001526 EnsureInsertPoint();
1527
Anders Carlsson15949b32009-02-09 20:41:50 +00001528 if (!DidCallStackSave) {
Anders Carlsson30032882008-12-12 07:38:43 +00001529 // Save the stack.
John McCall7f416cc2015-09-08 08:05:57 +00001530 Address Stack =
1531 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
Mike Stump11289f42009-09-09 15:08:12 +00001532
James Y Knight8799cae2019-02-03 21:53:49 +00001533 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie4ba525b2015-07-14 17:27:39 +00001534 llvm::Value *V = Builder.CreateCall(F);
Anders Carlsson30032882008-12-12 07:38:43 +00001535 Builder.CreateStore(V, Stack);
Anders Carlsson15949b32009-02-09 20:41:50 +00001536
1537 DidCallStackSave = true;
Mike Stump11289f42009-09-09 15:08:12 +00001538
John McCalla464ff92010-07-21 06:13:08 +00001539 // Push a cleanup block and restore the stack there.
John McCalle4df6c82011-01-28 08:37:24 +00001540 // FIXME: in general circumstances, this should be an EH cleanup.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001541 pushStackRestore(NormalCleanup, Stack);
Anders Carlsson30032882008-12-12 07:38:43 +00001542 }
Mike Stump11289f42009-09-09 15:08:12 +00001543
Sander de Smalen891af03a2018-02-03 13:55:59 +00001544 auto VlaSize = getVLASize(Ty);
1545 llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type);
Anders Carlsson30032882008-12-12 07:38:43 +00001546
1547 // Allocate memory for the array.
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001548 address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts,
1549 &AllocaAddr);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001550
1551 // If we have debug info enabled, properly describe the VLA dimensions for
1552 // this type by registering the vla size expression for each of the
1553 // dimensions.
1554 EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo);
Chris Lattner03df1222007-06-02 04:53:11 +00001555 }
Eli Friedmanf4084702008-12-20 23:11:59 +00001556
John McCall7f416cc2015-09-08 08:05:57 +00001557 setAddrOfLocalVar(&D, address);
1558 emission.Addr = address;
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001559 emission.AllocaAddr = AllocaAddr;
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001560
1561 // Emit debug info for local var declaration.
Sander de Smalen891af03a2018-02-03 13:55:59 +00001562 if (EmitDebugInfo && HaveInsertPoint()) {
Amy Huang7fac5c82019-06-20 17:15:21 +00001563 Address DebugAddr = address;
1564 bool UsePointerValue = NRVO && ReturnValuePointer.isValid();
Sander de Smalen891af03a2018-02-03 13:55:59 +00001565 DI->setLocation(D.getLocation());
Amy Huang7fac5c82019-06-20 17:15:21 +00001566
1567 // If NRVO, use a pointer to the return address.
1568 if (UsePointerValue)
1569 DebugAddr = ReturnValuePointer;
1570
1571 (void)DI->EmitDeclareOfAutoVariable(&D, DebugAddr.getPointer(), Builder,
1572 UsePointerValue);
Sander de Smalen891af03a2018-02-03 13:55:59 +00001573 }
Sanjiv Gupta18de6242008-05-30 10:30:31 +00001574
Volodymyr Sapsai93317d82019-03-01 02:15:39 +00001575 if (D.hasAttr<AnnotateAttr>() && HaveInsertPoint())
John McCall7f416cc2015-09-08 08:05:57 +00001576 EmitVarAnnotations(&D, address.getPointer());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001577
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001578 // Make sure we call @llvm.lifetime.end.
1579 if (emission.useLifetimeMarkers())
1580 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker,
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00001581 emission.getOriginalAllocatedAddress(),
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001582 emission.getSizeForLifetimeMarkers());
1583
John McCallc533cb72011-02-22 06:44:22 +00001584 return emission;
1585}
1586
JF Bastien6b239722018-05-19 04:21:26 +00001587static bool isCapturedBy(const VarDecl &, const Expr *);
1588
1589/// Determines whether the given __block variable is potentially
1590/// captured by the given statement.
1591static bool isCapturedBy(const VarDecl &Var, const Stmt *S) {
1592 if (const Expr *E = dyn_cast<Expr>(S))
1593 return isCapturedBy(Var, E);
1594 for (const Stmt *SubStmt : S->children())
1595 if (isCapturedBy(Var, SubStmt))
1596 return true;
1597 return false;
1598}
1599
John McCallc533cb72011-02-22 06:44:22 +00001600/// Determines whether the given __block variable is potentially
1601/// captured by the given expression.
JF Bastien6b239722018-05-19 04:21:26 +00001602static bool isCapturedBy(const VarDecl &Var, const Expr *E) {
John McCallc533cb72011-02-22 06:44:22 +00001603 // Skip the most common kinds of expressions that make
1604 // hierarchy-walking expensive.
JF Bastien6b239722018-05-19 04:21:26 +00001605 E = E->IgnoreParenCasts();
John McCallc533cb72011-02-22 06:44:22 +00001606
JF Bastien6b239722018-05-19 04:21:26 +00001607 if (const BlockExpr *BE = dyn_cast<BlockExpr>(E)) {
1608 const BlockDecl *Block = BE->getBlockDecl();
1609 for (const auto &I : Block->captures()) {
1610 if (I.getVariable() == &Var)
John McCallc533cb72011-02-22 06:44:22 +00001611 return true;
1612 }
1613
1614 // No need to walk into the subexpressions.
1615 return false;
1616 }
1617
JF Bastien6b239722018-05-19 04:21:26 +00001618 if (const StmtExpr *SE = dyn_cast<StmtExpr>(E)) {
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001619 const CompoundStmt *CS = SE->getSubStmt();
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001620 for (const auto *BI : CS->body())
JF Bastien6b239722018-05-19 04:21:26 +00001621 if (const auto *BIE = dyn_cast<Expr>(BI)) {
1622 if (isCapturedBy(Var, BIE))
1623 return true;
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001624 }
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001625 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001626 // special case declarations
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001627 for (const auto *I : DS->decls()) {
1628 if (const auto *VD = dyn_cast<VarDecl>((I))) {
1629 const Expr *Init = VD->getInit();
JF Bastien6b239722018-05-19 04:21:26 +00001630 if (Init && isCapturedBy(Var, Init))
Fariborz Jahanian5c4b2ca2011-08-25 00:06:26 +00001631 return true;
1632 }
1633 }
1634 }
1635 else
1636 // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1637 // Later, provide code to poke into statements for capture analysis.
1638 return true;
Fariborz Jahanian797f1e22011-08-23 16:47:15 +00001639 return false;
1640 }
Eric Christopher31ab1302011-08-23 22:38:00 +00001641
JF Bastien6b239722018-05-19 04:21:26 +00001642 for (const Stmt *SubStmt : E->children())
1643 if (isCapturedBy(Var, SubStmt))
John McCallc533cb72011-02-22 06:44:22 +00001644 return true;
1645
1646 return false;
1647}
1648
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001649/// Determine whether the given initializer is trivial in the sense
Douglas Gregor82e1af22011-07-01 21:08:19 +00001650/// that it requires no code to be generated.
Alexey Bataev4a5bb772014-10-08 14:01:46 +00001651bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
Douglas Gregor82e1af22011-07-01 21:08:19 +00001652 if (!Init)
1653 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001654
Douglas Gregor82e1af22011-07-01 21:08:19 +00001655 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1656 if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1657 if (Constructor->isTrivial() &&
1658 Constructor->isDefaultConstructor() &&
1659 !Construct->requiresZeroInitialization())
1660 return true;
Eric Christopher31ab1302011-08-23 22:38:00 +00001661
Douglas Gregor82e1af22011-07-01 21:08:19 +00001662 return false;
1663}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001664
John McCallc533cb72011-02-22 06:44:22 +00001665void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001666 assert(emission.Variable && "emission was not valid!");
1667
John McCallc533cb72011-02-22 06:44:22 +00001668 // If this was emitted as a global constant, we're done.
1669 if (emission.wasEmittedAsGlobal()) return;
1670
John McCall9e2e22f2011-02-22 07:16:58 +00001671 const VarDecl &D = *emission.Variable;
Adrian Prantl95b24e92015-02-03 20:00:54 +00001672 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
John McCallc533cb72011-02-22 06:44:22 +00001673 QualType type = D.getType();
1674
Chris Lattner07eb7332007-07-12 00:39:48 +00001675 // If this local has an initializer, emit it now.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001676 const Expr *Init = D.getInit();
1677
1678 // If we are at an unreachable point, we don't need to emit the initializer
1679 // unless it contains a label.
1680 if (!HaveInsertPoint()) {
John McCallc533cb72011-02-22 06:44:22 +00001681 if (!Init || !ContainsLabel(Init)) return;
1682 EnsureInsertPoint();
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001683 }
1684
John McCall73064872011-03-31 01:59:53 +00001685 // Initialize the structure of a __block variable.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001686 if (emission.IsEscapingByRef)
John McCall73064872011-03-31 01:59:53 +00001687 emitByrefStructureInit(emission);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00001688
Akira Hatanaka7275da02018-02-28 07:15:55 +00001689 // Initialize the variable here if it doesn't have a initializer and it is a
1690 // C struct that is non-trivial to initialize or an array containing such a
1691 // struct.
1692 if (!Init &&
1693 type.isNonTrivialToPrimitiveDefaultInitialize() ==
1694 QualType::PDIK_Struct) {
1695 LValue Dst = MakeAddrLValue(emission.getAllocatedAddress(), type);
Akira Hatanaka8e57b072018-10-01 21:51:28 +00001696 if (emission.IsEscapingByRef)
Akira Hatanaka7275da02018-02-28 07:15:55 +00001697 drillIntoBlockVariable(*this, Dst, &D);
1698 defaultInitNonTrivialCStructVar(Dst);
1699 return;
1700 }
1701
John McCallc533cb72011-02-22 06:44:22 +00001702 // Check whether this is a byref variable that's potentially
1703 // captured and moved by its own initializer. If so, we'll need to
1704 // emit the initializer first, then copy into the variable.
JF Bastien14daa202018-12-18 05:12:21 +00001705 bool capturedByInit =
1706 Init && emission.IsEscapingByRef && isCapturedBy(D, Init);
John McCallc533cb72011-02-22 06:44:22 +00001707
JF Bastien0bae08a2019-02-15 17:26:29 +00001708 bool locIsByrefHeader = !capturedByInit;
1709 const Address Loc =
1710 locIsByrefHeader ? emission.getObjectAddress(*this) : emission.Addr;
JF Bastien14daa202018-12-18 05:12:21 +00001711
1712 // Note: constexpr already initializes everything correctly.
1713 LangOptions::TrivialAutoVarInitKind trivialAutoVarInit =
1714 (D.isConstexpr()
1715 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1716 : (D.getAttr<UninitializedAttr>()
1717 ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1718 : getContext().getLangOpts().getTrivialAutoVarInit()));
1719
JF Bastienb347e752019-02-08 01:29:17 +00001720 auto initializeWhatIsTechnicallyUninitialized = [&](Address Loc) {
JF Bastien14daa202018-12-18 05:12:21 +00001721 if (trivialAutoVarInit ==
1722 LangOptions::TrivialAutoVarInitKind::Uninitialized)
1723 return;
1724
JF Bastienb347e752019-02-08 01:29:17 +00001725 // Only initialize a __block's storage: we always initialize the header.
JF Bastien0bae08a2019-02-15 17:26:29 +00001726 if (emission.IsEscapingByRef && !locIsByrefHeader)
JF Bastienb347e752019-02-08 01:29:17 +00001727 Loc = emitBlockByrefAddress(Loc, &D, /*follow=*/false);
1728
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001729 bool isVolatile = type.isVolatileQualified();
JF Bastien14daa202018-12-18 05:12:21 +00001730 CharUnits Size = getContext().getTypeSizeInChars(type);
1731 if (!Size.isZero()) {
1732 switch (trivialAutoVarInit) {
1733 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1734 llvm_unreachable("Uninitialized handled above");
1735 case LangOptions::TrivialAutoVarInitKind::Zero:
1736 emitStoresForZeroInit(CGM, D, Loc, isVolatile, Builder);
1737 break;
1738 case LangOptions::TrivialAutoVarInitKind::Pattern:
1739 emitStoresForPatternInit(CGM, D, Loc, isVolatile, Builder);
1740 break;
1741 }
1742 return;
1743 }
1744
1745 // VLAs look zero-sized to getTypeInfo. We can't emit constant stores to
1746 // them, so emit a memcpy with the VLA size to initialize each element.
1747 // Technically zero-sized or negative-sized VLAs are undefined, and UBSan
1748 // will catch that code, but there exists code which generates zero-sized
1749 // VLAs. Be nice and initialize whatever they requested.
JF Bastienddeb2f22019-02-08 00:51:05 +00001750 const auto *VlaType = getContext().getAsVariableArrayType(type);
JF Bastien14daa202018-12-18 05:12:21 +00001751 if (!VlaType)
1752 return;
1753 auto VlaSize = getVLASize(VlaType);
1754 auto SizeVal = VlaSize.NumElts;
1755 CharUnits EltSize = getContext().getTypeSizeInChars(VlaSize.Type);
1756 switch (trivialAutoVarInit) {
1757 case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1758 llvm_unreachable("Uninitialized handled above");
1759
1760 case LangOptions::TrivialAutoVarInitKind::Zero:
1761 if (!EltSize.isOne())
1762 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1763 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1764 isVolatile);
1765 break;
1766
1767 case LangOptions::TrivialAutoVarInitKind::Pattern: {
1768 llvm::Type *ElTy = Loc.getElementType();
JF Bastienef202c32019-04-12 00:11:27 +00001769 llvm::Constant *Constant = constWithPadding(
1770 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
JF Bastien14daa202018-12-18 05:12:21 +00001771 CharUnits ConstantAlign = getContext().getTypeAlignInChars(VlaSize.Type);
1772 llvm::BasicBlock *SetupBB = createBasicBlock("vla-setup.loop");
1773 llvm::BasicBlock *LoopBB = createBasicBlock("vla-init.loop");
1774 llvm::BasicBlock *ContBB = createBasicBlock("vla-init.cont");
1775 llvm::Value *IsZeroSizedVLA = Builder.CreateICmpEQ(
1776 SizeVal, llvm::ConstantInt::get(SizeVal->getType(), 0),
1777 "vla.iszerosized");
1778 Builder.CreateCondBr(IsZeroSizedVLA, ContBB, SetupBB);
1779 EmitBlock(SetupBB);
1780 if (!EltSize.isOne())
1781 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1782 llvm::Value *BaseSizeInChars =
1783 llvm::ConstantInt::get(IntPtrTy, EltSize.getQuantity());
1784 Address Begin = Builder.CreateElementBitCast(Loc, Int8Ty, "vla.begin");
1785 llvm::Value *End =
1786 Builder.CreateInBoundsGEP(Begin.getPointer(), SizeVal, "vla.end");
1787 llvm::BasicBlock *OriginBB = Builder.GetInsertBlock();
1788 EmitBlock(LoopBB);
1789 llvm::PHINode *Cur = Builder.CreatePHI(Begin.getType(), 2, "vla.cur");
1790 Cur->addIncoming(Begin.getPointer(), OriginBB);
1791 CharUnits CurAlign = Loc.getAlignment().alignmentOfArrayElement(EltSize);
Richard Smith24cdcad2019-06-14 17:46:37 +00001792 Builder.CreateMemCpy(Address(Cur, CurAlign),
1793 createUnnamedGlobalForMemcpyFrom(
1794 CGM, D, Builder, Constant, ConstantAlign),
1795 BaseSizeInChars, isVolatile);
JF Bastien14daa202018-12-18 05:12:21 +00001796 llvm::Value *Next =
1797 Builder.CreateInBoundsGEP(Int8Ty, Cur, BaseSizeInChars, "vla.next");
1798 llvm::Value *Done = Builder.CreateICmpEQ(Next, End, "vla-init.isdone");
1799 Builder.CreateCondBr(Done, ContBB, LoopBB);
1800 Cur->addIncoming(Next, LoopBB);
1801 EmitBlock(ContBB);
1802 } break;
1803 }
1804 };
1805
1806 if (isTrivialInitializer(Init)) {
JF Bastienb347e752019-02-08 01:29:17 +00001807 initializeWhatIsTechnicallyUninitialized(Loc);
JF Bastien14daa202018-12-18 05:12:21 +00001808 return;
1809 }
John McCallc533cb72011-02-22 06:44:22 +00001810
Craig Topper8a13c412014-05-21 05:09:00 +00001811 llvm::Constant *constant = nullptr;
Richard Smith715f7a12019-06-11 17:50:32 +00001812 if (emission.IsConstantAggregate ||
1813 D.mightBeUsableInConstantExpressions(getContext())) {
Richard Smithfddd3842011-12-30 21:15:51 +00001814 assert(!capturedByInit && "constant init contains a capturing block?");
John McCallde0fe072017-08-15 21:42:52 +00001815 constant = ConstantEmitter(*this).tryEmitAbstractForInitializer(D);
JF Bastiend39fbc72019-04-30 22:56:53 +00001816 if (constant && !constant->isZeroValue() &&
1817 (trivialAutoVarInit !=
1818 LangOptions::TrivialAutoVarInitKind::Uninitialized)) {
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001819 IsPattern isPattern =
1820 (trivialAutoVarInit == LangOptions::TrivialAutoVarInitKind::Pattern)
1821 ? IsPattern::Yes
1822 : IsPattern::No;
JF Bastiend39fbc72019-04-30 22:56:53 +00001823 // C guarantees that brace-init with fewer initializers than members in
1824 // the aggregate will initialize the rest of the aggregate as-if it were
1825 // static initialization. In turn static initialization guarantees that
1826 // padding is initialized to zero bits. We could instead pattern-init if D
1827 // has any ImplicitValueInitExpr, but that seems to be unintuitive
1828 // behavior.
1829 constant = constWithPadding(CGM, IsPattern::No,
Alexander Potapenko4f7bc0e2019-02-26 10:46:21 +00001830 replaceUndef(CGM, isPattern, constant));
1831 }
Richard Smithfddd3842011-12-30 21:15:51 +00001832 }
1833
1834 if (!constant) {
JF Bastienb347e752019-02-08 01:29:17 +00001835 initializeWhatIsTechnicallyUninitialized(Loc);
John McCall7f416cc2015-09-08 08:05:57 +00001836 LValue lv = MakeAddrLValue(Loc, type);
John McCall1553b192011-06-16 04:16:24 +00001837 lv.setNonGC(true);
David Blaikie66e41972015-01-14 07:38:27 +00001838 return EmitExprAsInit(Init, &D, lv, capturedByInit);
John McCall1553b192011-06-16 04:16:24 +00001839 }
John McCall91ca10f2011-03-08 09:11:50 +00001840
Richard Smith2bcde3a2013-06-02 00:09:52 +00001841 if (!emission.IsConstantAggregate) {
1842 // For simple scalar/complex initialization, store the value directly.
John McCall7f416cc2015-09-08 08:05:57 +00001843 LValue lv = MakeAddrLValue(Loc, type);
Richard Smith2bcde3a2013-06-02 00:09:52 +00001844 lv.setNonGC(true);
1845 return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1846 }
1847
Yaxun Liudaceb1e2018-05-14 19:20:12 +00001848 llvm::Type *BP = CGM.Int8Ty->getPointerTo(Loc.getAddressSpace());
JF Bastien0bae08a2019-02-15 17:26:29 +00001849 emitStoresForConstant(
1850 CGM, D, (Loc.getType() == BP) ? Loc : Builder.CreateBitCast(Loc, BP),
Vitaly Buka96ff25a2019-06-27 01:34:21 +00001851 type.isVolatileQualified(), Builder, constant);
John McCall91ca10f2011-03-08 09:11:50 +00001852}
1853
Richard Smithe78fac52018-04-05 20:52:58 +00001854/// Emit an expression as an initializer for an object (variable, field, etc.)
1855/// at the given location. The expression is not necessarily the normal
1856/// initializer for the object, and the address is not necessarily
John McCall91ca10f2011-03-08 09:11:50 +00001857/// its normal location.
1858///
1859/// \param init the initializing expression
Richard Smithe78fac52018-04-05 20:52:58 +00001860/// \param D the object to act as if we're initializing
John McCall91ca10f2011-03-08 09:11:50 +00001861/// \param loc the address to initialize; its type is a pointer
Richard Smithe78fac52018-04-05 20:52:58 +00001862/// to the LLVM mapping of the object's type
John McCall91ca10f2011-03-08 09:11:50 +00001863/// \param alignment the alignment of the address
Richard Smithe78fac52018-04-05 20:52:58 +00001864/// \param capturedByInit true if \p D is a __block variable
John McCall91ca10f2011-03-08 09:11:50 +00001865/// whose address is potentially changed by the initializer
David Blaikie73ca5692014-12-09 00:32:22 +00001866void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
David Blaikie66e41972015-01-14 07:38:27 +00001867 LValue lvalue, bool capturedByInit) {
John McCall31168b02011-06-15 23:02:42 +00001868 QualType type = D->getType();
John McCall91ca10f2011-03-08 09:11:50 +00001869
1870 if (type->isReferenceType()) {
Richard Smitha1c9d4d2013-06-12 23:38:09 +00001871 RValue rvalue = EmitReferenceBindingToExpr(init);
Eric Christopher31ab1302011-08-23 22:38:00 +00001872 if (capturedByInit)
John McCall1553b192011-06-16 04:16:24 +00001873 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001874 EmitStoreThroughLValue(rvalue, lvalue, true);
John McCall47fb9502013-03-07 21:37:08 +00001875 return;
1876 }
1877 switch (getEvaluationKind(type)) {
1878 case TEK_Scalar:
David Blaikie66e41972015-01-14 07:38:27 +00001879 EmitScalarInit(init, D, lvalue, capturedByInit);
John McCall47fb9502013-03-07 21:37:08 +00001880 return;
1881 case TEK_Complex: {
John McCall91ca10f2011-03-08 09:11:50 +00001882 ComplexPairTy complex = EmitComplexExpr(init);
John McCall1553b192011-06-16 04:16:24 +00001883 if (capturedByInit)
1884 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
David Blaikie66e41972015-01-14 07:38:27 +00001885 EmitStoreOfComplex(complex, lvalue, /*init*/ true);
John McCall47fb9502013-03-07 21:37:08 +00001886 return;
1887 }
1888 case TEK_Aggregate:
John McCalla8ec7eb2013-03-07 21:37:17 +00001889 if (type->isAtomicType()) {
1890 EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1891 } else {
Richard Smithe78fac52018-04-05 20:52:58 +00001892 AggValueSlot::Overlap_t Overlap = AggValueSlot::MayOverlap;
1893 if (isa<VarDecl>(D))
1894 Overlap = AggValueSlot::DoesNotOverlap;
1895 else if (auto *FD = dyn_cast<FieldDecl>(D))
Richard Smith8cca3a52019-06-20 20:56:20 +00001896 Overlap = getOverlapForFieldInit(FD);
John McCalla8ec7eb2013-03-07 21:37:17 +00001897 // TODO: how can we delay here if D is captured by its initializer?
1898 EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001899 AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001900 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001901 AggValueSlot::IsNotAliased,
1902 Overlap));
John McCalla8ec7eb2013-03-07 21:37:17 +00001903 }
John McCall47fb9502013-03-07 21:37:08 +00001904 return;
Fariborz Jahanianc6140732010-03-12 21:40:43 +00001905 }
John McCall47fb9502013-03-07 21:37:08 +00001906 llvm_unreachable("bad evaluation kind");
John McCallc533cb72011-02-22 06:44:22 +00001907}
John McCallbd309292010-07-06 01:34:17 +00001908
John McCall82fe67b2011-07-09 01:37:26 +00001909/// Enter a destroy cleanup for the given local variable.
1910void CodeGenFunction::emitAutoVarTypeCleanup(
1911 const CodeGenFunction::AutoVarEmission &emission,
1912 QualType::DestructionKind dtorKind) {
1913 assert(dtorKind != QualType::DK_none);
1914
1915 // Note that for __block variables, we want to destroy the
1916 // original stack object, not the possibly forwarded object.
John McCall7f416cc2015-09-08 08:05:57 +00001917 Address addr = emission.getObjectAddress(*this);
John McCall82fe67b2011-07-09 01:37:26 +00001918
1919 const VarDecl *var = emission.Variable;
1920 QualType type = var->getType();
1921
1922 CleanupKind cleanupKind = NormalAndEHCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001923 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001924
1925 switch (dtorKind) {
1926 case QualType::DK_none:
1927 llvm_unreachable("no cleanup for trivially-destructible variable");
1928
1929 case QualType::DK_cxx_destructor:
1930 // If there's an NRVO flag on the emission, we need a different
1931 // cleanup.
1932 if (emission.NRVOFlag) {
1933 assert(!type->isArrayType());
1934 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001935 EHStack.pushCleanup<DestroyNRVOVariableCXX>(cleanupKind, addr, dtor,
1936 emission.NRVOFlag);
John McCall82fe67b2011-07-09 01:37:26 +00001937 return;
1938 }
1939 break;
1940
1941 case QualType::DK_objc_strong_lifetime:
1942 // Suppress cleanups for pseudo-strong variables.
1943 if (var->isARCPseudoStrong()) return;
Eric Christopher31ab1302011-08-23 22:38:00 +00001944
John McCall82fe67b2011-07-09 01:37:26 +00001945 // Otherwise, consider whether to use an EH cleanup or not.
1946 cleanupKind = getARCCleanupKind();
1947
1948 // Use the imprecise destroyer by default.
1949 if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1950 destroyer = CodeGenFunction::destroyARCStrongImprecise;
1951 break;
1952
1953 case QualType::DK_objc_weak_lifetime:
1954 break;
Akira Hatanaka7275da02018-02-28 07:15:55 +00001955
1956 case QualType::DK_nontrivial_c_struct:
1957 destroyer = CodeGenFunction::destroyNonTrivialCStruct;
Akira Hatanaka673af7a2018-03-29 17:56:24 +00001958 if (emission.NRVOFlag) {
1959 assert(!type->isArrayType());
1960 EHStack.pushCleanup<DestroyNRVOVariableC>(cleanupKind, addr,
1961 emission.NRVOFlag, type);
1962 return;
1963 }
Akira Hatanaka7275da02018-02-28 07:15:55 +00001964 break;
John McCall82fe67b2011-07-09 01:37:26 +00001965 }
1966
1967 // If we haven't chosen a more specific destroyer, use the default.
Peter Collingbourne1425b452012-01-26 03:33:36 +00001968 if (!destroyer) destroyer = getDestroyer(dtorKind);
John McCall178360e2011-07-11 08:38:19 +00001969
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001970 // Use an EH cleanup in array destructors iff the destructor itself
John McCall178360e2011-07-11 08:38:19 +00001971 // is being pushed as an EH cleanup.
1972 bool useEHCleanup = (cleanupKind & EHCleanup);
1973 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1974 useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001975}
1976
John McCallc533cb72011-02-22 06:44:22 +00001977void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
John McCall9e2e22f2011-02-22 07:16:58 +00001978 assert(emission.Variable && "emission was not valid!");
1979
John McCallc533cb72011-02-22 06:44:22 +00001980 // If this was emitted as a global constant, we're done.
1981 if (emission.wasEmittedAsGlobal()) return;
1982
John McCall8c38d352012-04-13 18:44:05 +00001983 // If we don't have an insertion point, we're done. Sema prevents
1984 // us from jumping into any of these scopes anyway.
1985 if (!HaveInsertPoint()) return;
1986
John McCall9e2e22f2011-02-22 07:16:58 +00001987 const VarDecl &D = *emission.Variable;
John McCallc533cb72011-02-22 06:44:22 +00001988
John McCall82fe67b2011-07-09 01:37:26 +00001989 // Check the type for a cleanup.
1990 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1991 emitAutoVarTypeCleanup(emission, dtorKind);
John McCall31168b02011-06-15 23:02:42 +00001992
John McCall1bd25562011-06-24 23:21:27 +00001993 // In GC mode, honor objc_precise_lifetime.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001994 if (getLangOpts().getGC() != LangOptions::NonGC &&
John McCall1bd25562011-06-24 23:21:27 +00001995 D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1996 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1997 }
1998
John McCallc533cb72011-02-22 06:44:22 +00001999 // Handle the cleanup attribute.
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00002000 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002001 const FunctionDecl *FD = CA->getFunctionDecl();
Mike Stump11289f42009-09-09 15:08:12 +00002002
John McCallc533cb72011-02-22 06:44:22 +00002003 llvm::Constant *F = CGM.GetAddrOfFunction(FD);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002004 assert(F && "Could not find function!");
Mike Stump11289f42009-09-09 15:08:12 +00002005
John McCalla729c622012-02-17 03:33:10 +00002006 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
John McCallc533cb72011-02-22 06:44:22 +00002007 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
Anders Carlssoncadb9a62009-02-07 23:51:38 +00002008 }
Mike Stump626aecc2009-03-05 01:23:13 +00002009
John McCallc533cb72011-02-22 06:44:22 +00002010 // If this is a block variable, call _Block_object_destroy
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002011 // (on the unforwarded address). Don't enter this cleanup if we're in pure-GC
2012 // mode.
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002013 if (emission.IsEscapingByRef &&
2014 CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002015 BlockFieldFlags Flags = BLOCK_FIELD_IS_BYREF;
2016 if (emission.Variable->getType().isObjCGCWeak())
2017 Flags |= BLOCK_FIELD_IS_WEAK;
2018 enterByrefCleanup(NormalAndEHCleanup, emission.Addr, Flags,
Akira Hatanaka9978da32018-08-10 15:09:24 +00002019 /*LoadBlockVarAddr*/ false,
2020 cxxDestructorCanThrow(emission.Variable->getType()));
Akira Hatanakacb6a9332018-07-26 16:51:21 +00002021 }
Chris Lattner03df1222007-06-02 04:53:11 +00002022}
Chris Lattner53621a52007-06-13 20:44:40 +00002023
Peter Collingbourne1425b452012-01-26 03:33:36 +00002024CodeGenFunction::Destroyer *
John McCall82fe67b2011-07-09 01:37:26 +00002025CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
2026 switch (kind) {
2027 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
John McCallc2f00012011-07-09 09:09:00 +00002028 case QualType::DK_cxx_destructor:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002029 return destroyCXXObject;
John McCallc2f00012011-07-09 09:09:00 +00002030 case QualType::DK_objc_strong_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002031 return destroyARCStrongPrecise;
John McCallc2f00012011-07-09 09:09:00 +00002032 case QualType::DK_objc_weak_lifetime:
Peter Collingbourne1425b452012-01-26 03:33:36 +00002033 return destroyARCWeak;
Akira Hatanaka7275da02018-02-28 07:15:55 +00002034 case QualType::DK_nontrivial_c_struct:
2035 return destroyNonTrivialCStruct;
John McCall82fe67b2011-07-09 01:37:26 +00002036 }
Matt Beaumont-Gay934bbf52012-01-27 00:46:27 +00002037 llvm_unreachable("Unknown DestructionKind");
John McCall82fe67b2011-07-09 01:37:26 +00002038}
2039
John McCall12cc42a2013-02-01 05:11:40 +00002040/// pushEHDestroy - Push the standard destructor for the given type as
2041/// an EH-only cleanup.
2042void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002043 Address addr, QualType type) {
John McCall12cc42a2013-02-01 05:11:40 +00002044 assert(dtorKind && "cannot push destructor for trivial type");
2045 assert(needsEHCleanup(dtorKind));
2046
2047 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
2048}
2049
2050/// pushDestroy - Push the standard destructor for the given type as
2051/// at least a normal cleanup.
John McCall4bd0fb12011-07-12 16:41:08 +00002052void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
John McCall7f416cc2015-09-08 08:05:57 +00002053 Address addr, QualType type) {
John McCall4bd0fb12011-07-12 16:41:08 +00002054 assert(dtorKind && "cannot push destructor for trivial type");
2055
2056 CleanupKind cleanupKind = getCleanupKind(dtorKind);
2057 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
2058 cleanupKind & EHCleanup);
2059}
2060
John McCall7f416cc2015-09-08 08:05:57 +00002061void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002062 QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002063 bool useEHCleanupForArray) {
John McCall4bd0fb12011-07-12 16:41:08 +00002064 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
2065 destroyer, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002066}
2067
John McCall7f416cc2015-09-08 08:05:57 +00002068void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002069 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
2070}
2071
Richard Smith736a9472013-06-12 20:42:33 +00002072void CodeGenFunction::pushLifetimeExtendedDestroy(
John McCall7f416cc2015-09-08 08:05:57 +00002073 CleanupKind cleanupKind, Address addr, QualType type,
Richard Smith736a9472013-06-12 20:42:33 +00002074 Destroyer *destroyer, bool useEHCleanupForArray) {
Richard Smith736a9472013-06-12 20:42:33 +00002075 // Push an EH-only cleanup for the object now.
2076 // FIXME: When popping normal cleanups, we need to keep this EH cleanup
2077 // around in case a temporary's destructor throws an exception.
2078 if (cleanupKind & EHCleanup)
2079 EHStack.pushCleanup<DestroyObject>(
2080 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
2081 destroyer, useEHCleanupForArray);
2082
2083 // Remember that we need to push a full cleanup for the object at the
2084 // end of the full-expression.
2085 pushCleanupAfterFullExpr<DestroyObject>(
2086 cleanupKind, addr, type, destroyer, useEHCleanupForArray);
2087}
2088
John McCall178360e2011-07-11 08:38:19 +00002089/// emitDestroy - Immediately perform the destruction of the given
2090/// object.
2091///
2092/// \param addr - the address of the object; a type*
2093/// \param type - the type of the object; if an array type, all
2094/// objects are destroyed in reverse order
2095/// \param destroyer - the function to call to destroy individual
2096/// elements
2097/// \param useEHCleanupForArray - whether an EH cleanup should be
2098/// used when destroying array elements, in case one of the
2099/// destructions throws an exception
John McCall7f416cc2015-09-08 08:05:57 +00002100void CodeGenFunction::emitDestroy(Address addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002101 Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00002102 bool useEHCleanupForArray) {
John McCall82fe67b2011-07-09 01:37:26 +00002103 const ArrayType *arrayType = getContext().getAsArrayType(type);
2104 if (!arrayType)
2105 return destroyer(*this, addr, type);
2106
John McCall7f416cc2015-09-08 08:05:57 +00002107 llvm::Value *length = emitArrayLength(arrayType, type, addr);
2108
2109 CharUnits elementAlign =
2110 addr.getAlignment()
2111 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
John McCall97eab0a2011-07-13 08:09:46 +00002112
2113 // Normally we have to check whether the array is zero-length.
2114 bool checkZeroLength = true;
2115
2116 // But if the array length is constant, we can suppress that.
2117 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
2118 // ...and if it's constant zero, we can just skip the entire thing.
2119 if (constLength->isZero()) return;
2120 checkZeroLength = false;
2121 }
2122
John McCall7f416cc2015-09-08 08:05:57 +00002123 llvm::Value *begin = addr.getPointer();
John McCall82fe67b2011-07-09 01:37:26 +00002124 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
John McCall7f416cc2015-09-08 08:05:57 +00002125 emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002126 checkZeroLength, useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00002127}
2128
John McCall178360e2011-07-11 08:38:19 +00002129/// emitArrayDestroy - Destroys all the elements of the given array,
2130/// beginning from last to first. The array cannot be zero-length.
2131///
2132/// \param begin - a type* denoting the first element of the array
2133/// \param end - a type* denoting one past the end of the array
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +00002134/// \param elementType - the element type of the array
John McCall178360e2011-07-11 08:38:19 +00002135/// \param destroyer - the function to call to destroy elements
2136/// \param useEHCleanup - whether to push an EH cleanup to destroy
2137/// the remaining elements in case the destruction of a single
2138/// element throws
John McCall82fe67b2011-07-09 01:37:26 +00002139void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
2140 llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002141 QualType elementType,
2142 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002143 Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002144 bool checkZeroLength,
John McCall178360e2011-07-11 08:38:19 +00002145 bool useEHCleanup) {
John McCall7f416cc2015-09-08 08:05:57 +00002146 assert(!elementType->isArrayType());
John McCall82fe67b2011-07-09 01:37:26 +00002147
2148 // The basic structure here is a do-while loop, because we don't
2149 // need to check for the zero-element case.
2150 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
2151 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
2152
John McCall97eab0a2011-07-13 08:09:46 +00002153 if (checkZeroLength) {
2154 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
2155 "arraydestroy.isempty");
2156 Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
2157 }
2158
John McCall82fe67b2011-07-09 01:37:26 +00002159 // Enter the loop body, making that address the current address.
2160 llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
2161 EmitBlock(bodyBB);
2162 llvm::PHINode *elementPast =
2163 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
2164 elementPast->addIncoming(end, entryBB);
2165
2166 // Shift the address back by one element.
2167 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
2168 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
2169 "arraydestroy.element");
2170
John McCall178360e2011-07-11 08:38:19 +00002171 if (useEHCleanup)
John McCall7f416cc2015-09-08 08:05:57 +00002172 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
2173 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002174
John McCall82fe67b2011-07-09 01:37:26 +00002175 // Perform the actual destruction there.
John McCall7f416cc2015-09-08 08:05:57 +00002176 destroyer(*this, Address(element, elementAlign), elementType);
John McCall82fe67b2011-07-09 01:37:26 +00002177
John McCall178360e2011-07-11 08:38:19 +00002178 if (useEHCleanup)
2179 PopCleanupBlock();
2180
John McCall82fe67b2011-07-09 01:37:26 +00002181 // Check whether we've reached the end.
2182 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
2183 Builder.CreateCondBr(done, doneBB, bodyBB);
2184 elementPast->addIncoming(element, Builder.GetInsertBlock());
2185
2186 // Done.
2187 EmitBlock(doneBB);
2188}
2189
John McCall178360e2011-07-11 08:38:19 +00002190/// Perform partial array destruction as if in an EH cleanup. Unlike
2191/// emitArrayDestroy, the element type here may still be an array type.
John McCall178360e2011-07-11 08:38:19 +00002192static void emitPartialArrayDestroy(CodeGenFunction &CGF,
2193 llvm::Value *begin, llvm::Value *end,
John McCall7f416cc2015-09-08 08:05:57 +00002194 QualType type, CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002195 CodeGenFunction::Destroyer *destroyer) {
John McCall178360e2011-07-11 08:38:19 +00002196 // If the element type is itself an array, drill down.
John McCall97eab0a2011-07-13 08:09:46 +00002197 unsigned arrayDepth = 0;
John McCall178360e2011-07-11 08:38:19 +00002198 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
2199 // VLAs don't require a GEP index to walk into.
2200 if (!isa<VariableArrayType>(arrayType))
John McCall97eab0a2011-07-13 08:09:46 +00002201 arrayDepth++;
John McCall178360e2011-07-11 08:38:19 +00002202 type = arrayType->getElementType();
2203 }
John McCall97eab0a2011-07-13 08:09:46 +00002204
2205 if (arrayDepth) {
John McCallf0f0b7a2015-09-14 18:57:08 +00002206 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
John McCall97eab0a2011-07-13 08:09:46 +00002207
John McCallf0f0b7a2015-09-14 18:57:08 +00002208 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
Jay Foad040dd822011-07-22 08:16:57 +00002209 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
2210 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
John McCall178360e2011-07-11 08:38:19 +00002211 }
2212
John McCall97eab0a2011-07-13 08:09:46 +00002213 // Destroy the array. We don't ever need an EH cleanup because we
2214 // assume that we're in an EH cleanup ourselves, so a throwing
2215 // destructor causes an immediate terminate.
John McCall7f416cc2015-09-08 08:05:57 +00002216 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00002217 /*checkZeroLength*/ true, /*useEHCleanup*/ false);
John McCall178360e2011-07-11 08:38:19 +00002218}
2219
John McCall82fe67b2011-07-09 01:37:26 +00002220namespace {
John McCall178360e2011-07-11 08:38:19 +00002221 /// RegularPartialArrayDestroy - a cleanup which performs a partial
2222 /// array destroy where the end pointer is regularly determined and
2223 /// does not need to be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002224 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall178360e2011-07-11 08:38:19 +00002225 llvm::Value *ArrayBegin;
2226 llvm::Value *ArrayEnd;
2227 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002228 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002229 CharUnits ElementAlign;
John McCall178360e2011-07-11 08:38:19 +00002230 public:
2231 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002232 QualType elementType, CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002233 CodeGenFunction::Destroyer *destroyer)
2234 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
John McCall7f416cc2015-09-08 08:05:57 +00002235 ElementType(elementType), Destroyer(destroyer),
2236 ElementAlign(elementAlign) {}
John McCall178360e2011-07-11 08:38:19 +00002237
Craig Topper4f12f102014-03-12 06:41:41 +00002238 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall178360e2011-07-11 08:38:19 +00002239 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002240 ElementType, ElementAlign, Destroyer);
John McCall178360e2011-07-11 08:38:19 +00002241 }
2242 };
2243
2244 /// IrregularPartialArrayDestroy - a cleanup which performs a
2245 /// partial array destroy where the end pointer is irregularly
2246 /// determined and must be loaded from a local.
David Blaikie7e70d682015-08-18 22:40:54 +00002247 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
John McCall82fe67b2011-07-09 01:37:26 +00002248 llvm::Value *ArrayBegin;
John McCall7f416cc2015-09-08 08:05:57 +00002249 Address ArrayEndPointer;
John McCall82fe67b2011-07-09 01:37:26 +00002250 QualType ElementType;
Peter Collingbourne1425b452012-01-26 03:33:36 +00002251 CodeGenFunction::Destroyer *Destroyer;
John McCall7f416cc2015-09-08 08:05:57 +00002252 CharUnits ElementAlign;
John McCall82fe67b2011-07-09 01:37:26 +00002253 public:
John McCall178360e2011-07-11 08:38:19 +00002254 IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002255 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002256 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002257 CharUnits elementAlign,
John McCall178360e2011-07-11 08:38:19 +00002258 CodeGenFunction::Destroyer *destroyer)
John McCall82fe67b2011-07-09 01:37:26 +00002259 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
John McCall7f416cc2015-09-08 08:05:57 +00002260 ElementType(elementType), Destroyer(destroyer),
2261 ElementAlign(elementAlign) {}
John McCall82fe67b2011-07-09 01:37:26 +00002262
Craig Topper4f12f102014-03-12 06:41:41 +00002263 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall82fe67b2011-07-09 01:37:26 +00002264 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
John McCall178360e2011-07-11 08:38:19 +00002265 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002266 ElementType, ElementAlign, Destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002267 }
2268 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002269} // end anonymous namespace
John McCall82fe67b2011-07-09 01:37:26 +00002270
John McCall178360e2011-07-11 08:38:19 +00002271/// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
John McCall82fe67b2011-07-09 01:37:26 +00002272/// already-constructed elements of the given array. The cleanup
John McCall178360e2011-07-11 08:38:19 +00002273/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002274///
John McCall82fe67b2011-07-09 01:37:26 +00002275/// \param elementType - the immediate element type of the array;
2276/// possibly still an array type
John McCall4bd0fb12011-07-12 16:41:08 +00002277void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
John McCall7f416cc2015-09-08 08:05:57 +00002278 Address arrayEndPointer,
John McCall178360e2011-07-11 08:38:19 +00002279 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002280 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002281 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002282 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
2283 arrayBegin, arrayEndPointer,
John McCall7f416cc2015-09-08 08:05:57 +00002284 elementType, elementAlign,
2285 destroyer);
John McCall178360e2011-07-11 08:38:19 +00002286}
2287
2288/// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
2289/// already-constructed elements of the given array. The cleanup
2290/// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
Eric Christopher31ab1302011-08-23 22:38:00 +00002291///
John McCall178360e2011-07-11 08:38:19 +00002292/// \param elementType - the immediate element type of the array;
2293/// possibly still an array type
John McCall178360e2011-07-11 08:38:19 +00002294void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
2295 llvm::Value *arrayEnd,
2296 QualType elementType,
John McCall7f416cc2015-09-08 08:05:57 +00002297 CharUnits elementAlign,
Peter Collingbourne1425b452012-01-26 03:33:36 +00002298 Destroyer *destroyer) {
John McCall4bd0fb12011-07-12 16:41:08 +00002299 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
John McCall178360e2011-07-11 08:38:19 +00002300 arrayBegin, arrayEnd,
John McCall7f416cc2015-09-08 08:05:57 +00002301 elementType, elementAlign,
2302 destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00002303}
2304
Nadav Rotem1da30942013-03-23 06:43:35 +00002305/// Lazily declare the @llvm.lifetime.start intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002306llvm::Function *CodeGenModule::getLLVMLifetimeStartFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002307 if (LifetimeStartFn)
2308 return LifetimeStartFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002309 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002310 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002311 return LifetimeStartFn;
2312}
2313
2314/// Lazily declare the @llvm.lifetime.end intrinsic.
James Y Knight76f78742019-02-05 19:17:50 +00002315llvm::Function *CodeGenModule::getLLVMLifetimeEndFn() {
Matt Arsenaultd9729492017-04-10 20:18:45 +00002316 if (LifetimeEndFn)
2317 return LifetimeEndFn;
Nadav Rotem1da30942013-03-23 06:43:35 +00002318 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
Yaxun Liu7f7f3232017-04-17 20:03:11 +00002319 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy);
Nadav Rotem1da30942013-03-23 06:43:35 +00002320 return LifetimeEndFn;
2321}
2322
John McCall31168b02011-06-15 23:02:42 +00002323namespace {
2324 /// A cleanup to perform a release of an object at the end of a
2325 /// function. This is used to balance out the incoming +1 of a
2326 /// ns_consumed argument when we can't reasonably do that just by
2327 /// not doing the initial retain for a __block argument.
David Blaikie7e70d682015-08-18 22:40:54 +00002328 struct ConsumeARCParameter final : EHScopeStack::Cleanup {
John McCallcdda29c2013-03-13 03:10:54 +00002329 ConsumeARCParameter(llvm::Value *param,
2330 ARCPreciseLifetime_t precise)
2331 : Param(param), Precise(precise) {}
John McCall31168b02011-06-15 23:02:42 +00002332
2333 llvm::Value *Param;
John McCallcdda29c2013-03-13 03:10:54 +00002334 ARCPreciseLifetime_t Precise;
John McCall31168b02011-06-15 23:02:42 +00002335
Craig Topper4f12f102014-03-12 06:41:41 +00002336 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00002337 CGF.EmitARCRelease(Param, Precise);
John McCall31168b02011-06-15 23:02:42 +00002338 }
2339 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002340} // end anonymous namespace
John McCall31168b02011-06-15 23:02:42 +00002341
Mike Stump11289f42009-09-09 15:08:12 +00002342/// Emit an alloca (or GlobalValue depending on target)
Chris Lattnerb781dc792008-05-08 05:58:21 +00002343/// for the specified parameter and set up LocalDeclMap.
John McCall7f416cc2015-09-08 08:05:57 +00002344void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
2345 unsigned ArgNo) {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002346 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
Sanjiv Guptad7959242008-10-31 09:52:39 +00002347 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002348 "Invalid argument to EmitParmDecl");
John McCall147d0212011-02-22 22:38:33 +00002349
John McCall7f416cc2015-09-08 08:05:57 +00002350 Arg.getAnyValue()->setName(D.getName());
John McCall147d0212011-02-22 22:38:33 +00002351
Adrian Prantl51936dd2013-03-14 17:53:33 +00002352 QualType Ty = D.getType();
2353
John McCall147d0212011-02-22 22:38:33 +00002354 // Use better IR generation for certain implicit parameters.
John McCall7f416cc2015-09-08 08:05:57 +00002355 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
John McCall147d0212011-02-22 22:38:33 +00002356 // The only implicit argument a block has is its literal.
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002357 // This may be passed as an inalloca'ed value on Windows x86.
John McCall147d0212011-02-22 22:38:33 +00002358 if (BlockInfo) {
Saleem Abdulrasoolc1b46382018-02-21 21:47:51 +00002359 llvm::Value *V = Arg.isIndirect()
2360 ? Builder.CreateLoad(Arg.getIndirectAddress())
2361 : Arg.getDirectValue();
2362 setBlockContextParameter(IPD, ArgNo, V);
John McCall147d0212011-02-22 22:38:33 +00002363 return;
2364 }
2365 }
2366
John McCall7f416cc2015-09-08 08:05:57 +00002367 Address DeclPtr = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002368 bool DoStore = false;
2369 bool IsScalar = hasScalarEvaluationKind(Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002370 // If we already have a pointer to the argument, reuse the input pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002371 if (Arg.isIndirect()) {
2372 DeclPtr = Arg.getIndirectAddress();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002373 // If we have a prettier pointer type at this point, bitcast to that.
John McCall7f416cc2015-09-08 08:05:57 +00002374 unsigned AS = DeclPtr.getType()->getAddressSpace();
Reid Kleckner5e8edba2014-04-02 00:16:53 +00002375 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
John McCall7f416cc2015-09-08 08:05:57 +00002376 if (DeclPtr.getType() != IRTy)
2377 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
Yaxun Liu5b330e82018-03-15 15:25:19 +00002378 // Indirect argument is in alloca address space, which may be different
2379 // from the default address space.
2380 auto AllocaAS = CGM.getASTAllocaAddressSpace();
2381 auto *V = DeclPtr.getPointer();
2382 auto SrcLangAS = getLangOpts().OpenCL ? LangAS::opencl_private : AllocaAS;
2383 auto DestLangAS =
2384 getLangOpts().OpenCL ? LangAS::opencl_private : LangAS::Default;
2385 if (SrcLangAS != DestLangAS) {
2386 assert(getContext().getTargetAddressSpace(SrcLangAS) ==
2387 CGM.getDataLayout().getAllocaAddrSpace());
2388 auto DestAS = getContext().getTargetAddressSpace(DestLangAS);
2389 auto *T = V->getType()->getPointerElementType()->getPointerTo(DestAS);
2390 DeclPtr = Address(getTargetHooks().performAddrSpaceCast(
2391 *this, V, SrcLangAS, DestLangAS, T, true),
2392 DeclPtr.getAlignment());
2393 }
John McCall7f416cc2015-09-08 08:05:57 +00002394
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00002395 // Push a destructor cleanup for this parameter if the ABI requires it.
Reid Kleckner19819442014-07-25 21:39:46 +00002396 // Don't push a cleanup in a thunk for a method that will also emit a
2397 // cleanup.
Akira Hatanaka85282972018-05-15 21:00:30 +00002398 if (hasAggregateEvaluationKind(Ty) && !CurFuncIsThunk &&
2399 Ty->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Akira Hatanaka7275da02018-02-28 07:15:55 +00002400 if (QualType::DestructionKind DtorKind = Ty.isDestructedType()) {
2401 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
2492 // Emit debug info for param declaration.
Alexey Samsonov74a38682012-05-04 07:39:27 +00002493 if (CGDebugInfo *DI = getDebugInfo()) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002494 if (CGM.getCodeGenOpts().getDebugInfo() >=
2495 codegenoptions::LimitedDebugInfo) {
John McCall7f416cc2015-09-08 08:05:57 +00002496 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
Alexey Samsonov74a38682012-05-04 07:39:27 +00002497 }
2498 }
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002499
2500 if (D.hasAttr<AnnotateAttr>())
John McCall7f416cc2015-09-08 08:05:57 +00002501 EmitVarAnnotations(&D, DeclPtr.getPointer());
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002502
2503 // We can only check return value nullability if all arguments to the
2504 // function satisfy their nullability preconditions. This makes it necessary
2505 // to emit null checks for args in the function body itself.
2506 if (requiresReturnValueNullabilityCheck()) {
2507 auto Nullability = Ty->getNullability(getContext());
2508 if (Nullability && *Nullability == NullabilityKind::NonNull) {
2509 SanitizerScope SanScope(this);
2510 RetValNullabilityPrecondition =
2511 Builder.CreateAnd(RetValNullabilityPrecondition,
2512 Builder.CreateIsNotNull(Arg.getAnyValue()));
2513 }
2514 }
Chris Lattner53621a52007-06-13 20:44:40 +00002515}
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00002516
Alexey Bataevc5b1d322016-03-04 09:22:22 +00002517void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
2518 CodeGenFunction *CGF) {
2519 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2520 return;
2521 getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
2522}
Kelvin Li1408f912018-09-26 04:28:39 +00002523
Michael Kruse251e1482019-02-01 20:25:04 +00002524void CodeGenModule::EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D,
2525 CodeGenFunction *CGF) {
2526 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2527 return;
2528 // FIXME: need to implement mapper code generation
2529}
2530
Kelvin Li1408f912018-09-26 04:28:39 +00002531void CodeGenModule::EmitOMPRequiresDecl(const OMPRequiresDecl *D) {
Alexey Bataev982a35e2019-03-19 17:09:52 +00002532 getOpenMPRuntime().checkArchForUnifiedAddressing(D);
Kelvin Li1408f912018-09-26 04:28:39 +00002533}