1 //===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===//
2 //
3 // 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
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This contains code to emit Decl nodes as LLVM code.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "CGBlocks.h"
14 #include "CGCXXABI.h"
15 #include "CGCleanup.h"
16 #include "CGDebugInfo.h"
17 #include "CGOpenCLRuntime.h"
18 #include "CGOpenMPRuntime.h"
19 #include "CodeGenFunction.h"
20 #include "CodeGenModule.h"
21 #include "ConstantEmitter.h"
22 #include "PatternInit.h"
23 #include "TargetInfo.h"
24 #include "clang/AST/ASTContext.h"
25 #include "clang/AST/CharUnits.h"
26 #include "clang/AST/Decl.h"
27 #include "clang/AST/DeclObjC.h"
28 #include "clang/AST/DeclOpenMP.h"
29 #include "clang/Basic/CodeGenOptions.h"
30 #include "clang/Basic/SourceManager.h"
31 #include "clang/Basic/TargetInfo.h"
32 #include "clang/CodeGen/CGFunctionInfo.h"
33 #include "llvm/Analysis/ValueTracking.h"
34 #include "llvm/IR/DataLayout.h"
35 #include "llvm/IR/GlobalVariable.h"
36 #include "llvm/IR/Intrinsics.h"
37 #include "llvm/IR/Type.h"
38 
39 using namespace clang;
40 using namespace CodeGen;
41 
42 void CodeGenFunction::EmitDecl(const Decl &D) {
43   switch (D.getKind()) {
44   case Decl::BuiltinTemplate:
45   case Decl::TranslationUnit:
46   case Decl::ExternCContext:
47   case Decl::Namespace:
48   case Decl::UnresolvedUsingTypename:
49   case Decl::ClassTemplateSpecialization:
50   case Decl::ClassTemplatePartialSpecialization:
51   case Decl::VarTemplateSpecialization:
52   case Decl::VarTemplatePartialSpecialization:
53   case Decl::TemplateTypeParm:
54   case Decl::UnresolvedUsingValue:
55   case Decl::NonTypeTemplateParm:
56   case Decl::CXXDeductionGuide:
57   case Decl::CXXMethod:
58   case Decl::CXXConstructor:
59   case Decl::CXXDestructor:
60   case Decl::CXXConversion:
61   case Decl::Field:
62   case Decl::MSProperty:
63   case Decl::IndirectField:
64   case Decl::ObjCIvar:
65   case Decl::ObjCAtDefsField:
66   case Decl::ParmVar:
67   case Decl::ImplicitParam:
68   case Decl::ClassTemplate:
69   case Decl::VarTemplate:
70   case Decl::FunctionTemplate:
71   case Decl::TypeAliasTemplate:
72   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:
81   case Decl::PragmaComment:
82   case Decl::PragmaDetectMismatch:
83   case Decl::AccessSpec:
84   case Decl::LinkageSpec:
85   case Decl::Export:
86   case Decl::ObjCPropertyImpl:
87   case Decl::FileScopeAsm:
88   case Decl::Friend:
89   case Decl::FriendTemplate:
90   case Decl::Block:
91   case Decl::Captured:
92   case Decl::ClassScopeFunctionSpecialization:
93   case Decl::UsingShadow:
94   case Decl::ConstructorUsingShadow:
95   case Decl::ObjCTypeParam:
96   case Decl::Binding:
97     llvm_unreachable("Declaration should not be in declstmts!");
98   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++]
103   case Decl::StaticAssert: // static_assert(X, ""); [C++0x]
104   case Decl::Label:        // __label__ x;
105   case Decl::Import:
106   case Decl::OMPThreadPrivate:
107   case Decl::OMPAllocate:
108   case Decl::OMPCapturedExpr:
109   case Decl::OMPRequires:
110   case Decl::Empty:
111     // None of these decls require codegen support.
112     return;
113 
114   case Decl::NamespaceAlias:
115     if (CGDebugInfo *DI = getDebugInfo())
116         DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D));
117     return;
118   case Decl::Using:          // using X; [C++]
119     if (CGDebugInfo *DI = getDebugInfo())
120         DI->EmitUsingDecl(cast<UsingDecl>(D));
121     return;
122   case Decl::UsingPack:
123     for (auto *Using : cast<UsingPackDecl>(D).expansions())
124       EmitDecl(*Using);
125     return;
126   case Decl::UsingDirective: // using namespace X; [C++]
127     if (CGDebugInfo *DI = getDebugInfo())
128       DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D));
129     return;
130   case Decl::Var:
131   case Decl::Decomposition: {
132     const VarDecl &VD = cast<VarDecl>(D);
133     assert(VD.isLocalVarDecl() &&
134            "Should not see file-scope variables inside a function!");
135     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;
141   }
142 
143   case Decl::OMPDeclareReduction:
144     return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this);
145 
146   case Decl::OMPDeclareMapper:
147     return CGM.EmitOMPDeclareMapper(cast<OMPDeclareMapperDecl>(&D), this);
148 
149   case Decl::Typedef:      // typedef int X;
150   case Decl::TypeAlias: {  // using X = int; [C++0x]
151     const TypedefNameDecl &TD = cast<TypedefNameDecl>(D);
152     QualType Ty = TD.getUnderlyingType();
153 
154     if (Ty->isVariablyModifiedType())
155       EmitVariablyModifiedType(Ty);
156   }
157   }
158 }
159 
160 /// EmitVarDecl - This method handles emission of any variable declaration
161 /// inside a function, including static vars etc.
162 void CodeGenFunction::EmitVarDecl(const VarDecl &D) {
163   if (D.hasExternalStorage())
164     // Don't emit it now, allow it to be emitted lazily on its first use.
165     return;
166 
167   // Some function-scope variable does not have static storage but still
168   // needs to be emitted like a static variable, e.g. a function-scope
169   // variable in constant address space in OpenCL.
170   if (D.getStorageDuration() != SD_Automatic) {
171     // Static sampler variables translated to function calls.
172     if (D.getType()->isSamplerT())
173       return;
174 
175     llvm::GlobalValue::LinkageTypes Linkage =
176         CGM.getLLVMLinkageVarDefinition(&D, /*isConstant=*/false);
177 
178     // FIXME: We need to force the emission/use of a guard variable for
179     // some variables even if we can constant-evaluate them because
180     // we can't guarantee every translation unit will constant-evaluate them.
181 
182     return EmitStaticVarDecl(D, Linkage);
183   }
184 
185   if (D.getType().getAddressSpace() == LangAS::opencl_local)
186     return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D);
187 
188   assert(D.hasLocalStorage());
189   return EmitAutoVarDecl(D);
190 }
191 
192 static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) {
193   if (CGM.getLangOpts().CPlusPlus)
194     return CGM.getMangledName(&D).str();
195 
196   // If this isn't C++, we don't need a mangled name, just a pretty one.
197   assert(!D.isExternallyVisible() && "name shouldn't matter");
198   std::string ContextName;
199   const DeclContext *DC = D.getDeclContext();
200   if (auto *CD = dyn_cast<CapturedDecl>(DC))
201     DC = cast<DeclContext>(CD->getNonClosureContext());
202   if (const auto *FD = dyn_cast<FunctionDecl>(DC))
203     ContextName = CGM.getMangledName(FD);
204   else if (const auto *BD = dyn_cast<BlockDecl>(DC))
205     ContextName = CGM.getBlockMangledName(GlobalDecl(), BD);
206   else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC))
207     ContextName = OMD->getSelector().getAsString();
208   else
209     llvm_unreachable("Unknown context for static var decl");
210 
211   ContextName += "." + D.getNameAsString();
212   return ContextName;
213 }
214 
215 llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl(
216     const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) {
217   // In general, we don't always emit static var decls once before we reference
218   // them. It is possible to reference them before emitting the function that
219   // contains them, and it is possible to emit the containing function multiple
220   // times.
221   if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D])
222     return ExistingGV;
223 
224   QualType Ty = D.getType();
225   assert(Ty->isConstantSizeType() && "VLAs can't be static");
226 
227   // Use the label if the variable is renamed with the asm-label extension.
228   std::string Name;
229   if (D.hasAttr<AsmLabelAttr>())
230     Name = getMangledName(&D);
231   else
232     Name = getStaticDeclName(*this, D);
233 
234   llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty);
235   LangAS AS = GetGlobalVarAddressSpace(&D);
236   unsigned TargetAS = getContext().getTargetAddressSpace(AS);
237 
238   // OpenCL variables in local address space and CUDA shared
239   // variables cannot have an initializer.
240   llvm::Constant *Init = nullptr;
241   if (Ty.getAddressSpace() == LangAS::opencl_local ||
242       D.hasAttr<CUDASharedAttr>())
243     Init = llvm::UndefValue::get(LTy);
244   else
245     Init = EmitNullConstant(Ty);
246 
247   llvm::GlobalVariable *GV = new llvm::GlobalVariable(
248       getModule(), LTy, Ty.isConstant(getContext()), Linkage, Init, Name,
249       nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS);
250   GV->setAlignment(getContext().getDeclAlign(&D).getQuantity());
251 
252   if (supportsCOMDAT() && GV->isWeakForLinker())
253     GV->setComdat(TheModule.getOrInsertComdat(GV->getName()));
254 
255   if (D.getTLSKind())
256     setTLSMode(GV, D);
257 
258   setGVProperties(GV, &D);
259 
260   // Make sure the result is of the correct type.
261   LangAS ExpectedAS = Ty.getAddressSpace();
262   llvm::Constant *Addr = GV;
263   if (AS != ExpectedAS) {
264     Addr = getTargetCodeGenInfo().performAddrSpaceCast(
265         *this, GV, AS, ExpectedAS,
266         LTy->getPointerTo(getContext().getTargetAddressSpace(ExpectedAS)));
267   }
268 
269   setStaticLocalDeclAddress(&D, Addr);
270 
271   // Ensure that the static local gets initialized by making sure the parent
272   // function gets emitted eventually.
273   const Decl *DC = cast<Decl>(D.getDeclContext());
274 
275   // We can't name blocks or captured statements directly, so try to emit their
276   // parents.
277   if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) {
278     DC = DC->getNonClosureContext();
279     // FIXME: Ensure that global blocks get emitted.
280     if (!DC)
281       return Addr;
282   }
283 
284   GlobalDecl GD;
285   if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC))
286     GD = GlobalDecl(CD, Ctor_Base);
287   else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC))
288     GD = GlobalDecl(DD, Dtor_Base);
289   else if (const auto *FD = dyn_cast<FunctionDecl>(DC))
290     GD = GlobalDecl(FD);
291   else {
292     // Don't do anything for Obj-C method decls or global closures. We should
293     // never defer them.
294     assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl");
295   }
296   if (GD.getDecl()) {
297     // Disable emission of the parent function for the OpenMP device codegen.
298     CGOpenMPRuntime::DisableAutoDeclareTargetRAII NoDeclTarget(*this);
299     (void)GetAddrOfGlobal(GD);
300   }
301 
302   return Addr;
303 }
304 
305 /// hasNontrivialDestruction - Determine whether a type's destruction is
306 /// non-trivial. If so, and the variable uses static initialization, we must
307 /// register its destructor to run on exit.
308 static bool hasNontrivialDestruction(QualType T) {
309   CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
310   return RD && !RD->hasTrivialDestructor();
311 }
312 
313 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
314 /// global variable that has already been created for it.  If the initializer
315 /// has a different type than GV does, this may free GV and return a different
316 /// one.  Otherwise it just returns GV.
317 llvm::GlobalVariable *
318 CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D,
319                                                llvm::GlobalVariable *GV) {
320   ConstantEmitter emitter(*this);
321   llvm::Constant *Init = emitter.tryEmitForInitializer(D);
322 
323   // If constant emission failed, then this should be a C++ static
324   // initializer.
325   if (!Init) {
326     if (!getLangOpts().CPlusPlus)
327       CGM.ErrorUnsupported(D.getInit(), "constant l-value expression");
328     else if (HaveInsertPoint()) {
329       // Since we have a static initializer, this global variable can't
330       // be constant.
331       GV->setConstant(false);
332 
333       EmitCXXGuardedInit(D, GV, /*PerformInit*/true);
334     }
335     return GV;
336   }
337 
338   // The initializer may differ in type from the global. Rewrite
339   // the global to match the initializer.  (We have to do this
340   // because some types, like unions, can't be completely represented
341   // in the LLVM type system.)
342   if (GV->getType()->getElementType() != Init->getType()) {
343     llvm::GlobalVariable *OldGV = GV;
344 
345     GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
346                                   OldGV->isConstant(),
347                                   OldGV->getLinkage(), Init, "",
348                                   /*InsertBefore*/ OldGV,
349                                   OldGV->getThreadLocalMode(),
350                            CGM.getContext().getTargetAddressSpace(D.getType()));
351     GV->setVisibility(OldGV->getVisibility());
352     GV->setDSOLocal(OldGV->isDSOLocal());
353     GV->setComdat(OldGV->getComdat());
354 
355     // Steal the name of the old global
356     GV->takeName(OldGV);
357 
358     // Replace all uses of the old global with the new global
359     llvm::Constant *NewPtrForOldDecl =
360     llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
361     OldGV->replaceAllUsesWith(NewPtrForOldDecl);
362 
363     // Erase the old global, since it is no longer used.
364     OldGV->eraseFromParent();
365   }
366 
367   GV->setConstant(CGM.isTypeConstant(D.getType(), true));
368   GV->setInitializer(Init);
369 
370   emitter.finalize(GV);
371 
372   if (hasNontrivialDestruction(D.getType()) && HaveInsertPoint()) {
373     // We have a constant initializer, but a nontrivial destructor. We still
374     // need to perform a guarded "initialization" in order to register the
375     // destructor.
376     EmitCXXGuardedInit(D, GV, /*PerformInit*/false);
377   }
378 
379   return GV;
380 }
381 
382 void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D,
383                                       llvm::GlobalValue::LinkageTypes Linkage) {
384   // Check to see if we already have a global variable for this
385   // declaration.  This can happen when double-emitting function
386   // bodies, e.g. with complete and base constructors.
387   llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage);
388   CharUnits alignment = getContext().getDeclAlign(&D);
389 
390   // Store into LocalDeclMap before generating initializer to handle
391   // circular references.
392   setAddrOfLocalVar(&D, Address(addr, alignment));
393 
394   // We can't have a VLA here, but we can have a pointer to a VLA,
395   // even though that doesn't really make any sense.
396   // Make sure to evaluate VLA bounds now so that we have them for later.
397   if (D.getType()->isVariablyModifiedType())
398     EmitVariablyModifiedType(D.getType());
399 
400   // Save the type in case adding the initializer forces a type change.
401   llvm::Type *expectedType = addr->getType();
402 
403   llvm::GlobalVariable *var =
404     cast<llvm::GlobalVariable>(addr->stripPointerCasts());
405 
406   // CUDA's local and local static __shared__ variables should not
407   // have any non-empty initializers. This is ensured by Sema.
408   // Whatever initializer such variable may have when it gets here is
409   // a no-op and should not be emitted.
410   bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice &&
411                          D.hasAttr<CUDASharedAttr>();
412   // If this value has an initializer, emit it.
413   if (D.getInit() && !isCudaSharedVar)
414     var = AddInitializerToStaticVarDecl(D, var);
415 
416   var->setAlignment(alignment.getQuantity());
417 
418   if (D.hasAttr<AnnotateAttr>())
419     CGM.AddGlobalAnnotations(&D, var);
420 
421   if (auto *SA = D.getAttr<PragmaClangBSSSectionAttr>())
422     var->addAttribute("bss-section", SA->getName());
423   if (auto *SA = D.getAttr<PragmaClangDataSectionAttr>())
424     var->addAttribute("data-section", SA->getName());
425   if (auto *SA = D.getAttr<PragmaClangRodataSectionAttr>())
426     var->addAttribute("rodata-section", SA->getName());
427 
428   if (const SectionAttr *SA = D.getAttr<SectionAttr>())
429     var->setSection(SA->getName());
430 
431   if (D.hasAttr<UsedAttr>())
432     CGM.addUsedGlobal(var);
433 
434   // We may have to cast the constant because of the initializer
435   // mismatch above.
436   //
437   // FIXME: It is really dangerous to store this in the map; if anyone
438   // RAUW's the GV uses of this constant will be invalid.
439   llvm::Constant *castedAddr =
440     llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType);
441   if (var != castedAddr)
442     LocalDeclMap.find(&D)->second = Address(castedAddr, alignment);
443   CGM.setStaticLocalDeclAddress(&D, castedAddr);
444 
445   CGM.getSanitizerMetadata()->reportGlobalToASan(var, D);
446 
447   // Emit global variable debug descriptor for static vars.
448   CGDebugInfo *DI = getDebugInfo();
449   if (DI &&
450       CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) {
451     DI->setLocation(D.getLocation());
452     DI->EmitGlobalVariable(var, &D);
453   }
454 }
455 
456 namespace {
457   struct DestroyObject final : EHScopeStack::Cleanup {
458     DestroyObject(Address addr, QualType type,
459                   CodeGenFunction::Destroyer *destroyer,
460                   bool useEHCleanupForArray)
461       : addr(addr), type(type), destroyer(destroyer),
462         useEHCleanupForArray(useEHCleanupForArray) {}
463 
464     Address addr;
465     QualType type;
466     CodeGenFunction::Destroyer *destroyer;
467     bool useEHCleanupForArray;
468 
469     void Emit(CodeGenFunction &CGF, Flags flags) override {
470       // Don't use an EH cleanup recursively from an EH cleanup.
471       bool useEHCleanupForArray =
472         flags.isForNormalCleanup() && this->useEHCleanupForArray;
473 
474       CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray);
475     }
476   };
477 
478   template <class Derived>
479   struct DestroyNRVOVariable : EHScopeStack::Cleanup {
480     DestroyNRVOVariable(Address addr, llvm::Value *NRVOFlag)
481         : NRVOFlag(NRVOFlag), Loc(addr) {}
482 
483     llvm::Value *NRVOFlag;
484     Address Loc;
485 
486     void Emit(CodeGenFunction &CGF, Flags flags) override {
487       // Along the exceptions path we always execute the dtor.
488       bool NRVO = flags.isForNormalCleanup() && NRVOFlag;
489 
490       llvm::BasicBlock *SkipDtorBB = nullptr;
491       if (NRVO) {
492         // If we exited via NRVO, we skip the destructor call.
493         llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused");
494         SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor");
495         llvm::Value *DidNRVO =
496           CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val");
497         CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB);
498         CGF.EmitBlock(RunDtorBB);
499       }
500 
501       static_cast<Derived *>(this)->emitDestructorCall(CGF);
502 
503       if (NRVO) CGF.EmitBlock(SkipDtorBB);
504     }
505 
506     virtual ~DestroyNRVOVariable() = default;
507   };
508 
509   struct DestroyNRVOVariableCXX final
510       : DestroyNRVOVariable<DestroyNRVOVariableCXX> {
511     DestroyNRVOVariableCXX(Address addr, const CXXDestructorDecl *Dtor,
512                            llvm::Value *NRVOFlag)
513       : DestroyNRVOVariable<DestroyNRVOVariableCXX>(addr, NRVOFlag),
514         Dtor(Dtor) {}
515 
516     const CXXDestructorDecl *Dtor;
517 
518     void emitDestructorCall(CodeGenFunction &CGF) {
519       CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
520                                 /*ForVirtualBase=*/false,
521                                 /*Delegating=*/false, Loc);
522     }
523   };
524 
525   struct DestroyNRVOVariableC final
526       : DestroyNRVOVariable<DestroyNRVOVariableC> {
527     DestroyNRVOVariableC(Address addr, llvm::Value *NRVOFlag, QualType Ty)
528         : DestroyNRVOVariable<DestroyNRVOVariableC>(addr, NRVOFlag), Ty(Ty) {}
529 
530     QualType Ty;
531 
532     void emitDestructorCall(CodeGenFunction &CGF) {
533       CGF.destroyNonTrivialCStruct(CGF, Loc, Ty);
534     }
535   };
536 
537   struct CallStackRestore final : EHScopeStack::Cleanup {
538     Address Stack;
539     CallStackRestore(Address Stack) : Stack(Stack) {}
540     void Emit(CodeGenFunction &CGF, Flags flags) override {
541       llvm::Value *V = CGF.Builder.CreateLoad(Stack);
542       llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
543       CGF.Builder.CreateCall(F, V);
544     }
545   };
546 
547   struct ExtendGCLifetime final : EHScopeStack::Cleanup {
548     const VarDecl &Var;
549     ExtendGCLifetime(const VarDecl *var) : Var(*var) {}
550 
551     void Emit(CodeGenFunction &CGF, Flags flags) override {
552       // Compute the address of the local variable, in case it's a
553       // byref or something.
554       DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
555                       Var.getType(), VK_LValue, SourceLocation());
556       llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE),
557                                                 SourceLocation());
558       CGF.EmitExtendGCLifetime(value);
559     }
560   };
561 
562   struct CallCleanupFunction final : EHScopeStack::Cleanup {
563     llvm::Constant *CleanupFn;
564     const CGFunctionInfo &FnInfo;
565     const VarDecl &Var;
566 
567     CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info,
568                         const VarDecl *Var)
569       : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {}
570 
571     void Emit(CodeGenFunction &CGF, Flags flags) override {
572       DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(&Var), false,
573                       Var.getType(), VK_LValue, SourceLocation());
574       // Compute the address of the local variable, in case it's a byref
575       // or something.
576       llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer();
577 
578       // In some cases, the type of the function argument will be different from
579       // the type of the pointer. An example of this is
580       // void f(void* arg);
581       // __attribute__((cleanup(f))) void *g;
582       //
583       // To fix this we insert a bitcast here.
584       QualType ArgTy = FnInfo.arg_begin()->type;
585       llvm::Value *Arg =
586         CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy));
587 
588       CallArgList Args;
589       Args.add(RValue::get(Arg),
590                CGF.getContext().getPointerType(Var.getType()));
591       auto Callee = CGCallee::forDirect(CleanupFn);
592       CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
593     }
594   };
595 } // end anonymous namespace
596 
597 /// EmitAutoVarWithLifetime - Does the setup required for an automatic
598 /// variable with lifetime.
599 static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var,
600                                     Address addr,
601                                     Qualifiers::ObjCLifetime lifetime) {
602   switch (lifetime) {
603   case Qualifiers::OCL_None:
604     llvm_unreachable("present but none");
605 
606   case Qualifiers::OCL_ExplicitNone:
607     // nothing to do
608     break;
609 
610   case Qualifiers::OCL_Strong: {
611     CodeGenFunction::Destroyer *destroyer =
612       (var.hasAttr<ObjCPreciseLifetimeAttr>()
613        ? CodeGenFunction::destroyARCStrongPrecise
614        : CodeGenFunction::destroyARCStrongImprecise);
615 
616     CleanupKind cleanupKind = CGF.getARCCleanupKind();
617     CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer,
618                     cleanupKind & EHCleanup);
619     break;
620   }
621   case Qualifiers::OCL_Autoreleasing:
622     // nothing to do
623     break;
624 
625   case Qualifiers::OCL_Weak:
626     // __weak objects always get EH cleanups; otherwise, exceptions
627     // could cause really nasty crashes instead of mere leaks.
628     CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(),
629                     CodeGenFunction::destroyARCWeak,
630                     /*useEHCleanup*/ true);
631     break;
632   }
633 }
634 
635 static bool isAccessedBy(const VarDecl &var, const Stmt *s) {
636   if (const Expr *e = dyn_cast<Expr>(s)) {
637     // Skip the most common kinds of expressions that make
638     // hierarchy-walking expensive.
639     s = e = e->IgnoreParenCasts();
640 
641     if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e))
642       return (ref->getDecl() == &var);
643     if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) {
644       const BlockDecl *block = be->getBlockDecl();
645       for (const auto &I : block->captures()) {
646         if (I.getVariable() == &var)
647           return true;
648       }
649     }
650   }
651 
652   for (const Stmt *SubStmt : s->children())
653     // SubStmt might be null; as in missing decl or conditional of an if-stmt.
654     if (SubStmt && isAccessedBy(var, SubStmt))
655       return true;
656 
657   return false;
658 }
659 
660 static bool isAccessedBy(const ValueDecl *decl, const Expr *e) {
661   if (!decl) return false;
662   if (!isa<VarDecl>(decl)) return false;
663   const VarDecl *var = cast<VarDecl>(decl);
664   return isAccessedBy(*var, e);
665 }
666 
667 static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF,
668                                    const LValue &destLV, const Expr *init) {
669   bool needsCast = false;
670 
671   while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) {
672     switch (castExpr->getCastKind()) {
673     // Look through casts that don't require representation changes.
674     case CK_NoOp:
675     case CK_BitCast:
676     case CK_BlockPointerToObjCPointerCast:
677       needsCast = true;
678       break;
679 
680     // If we find an l-value to r-value cast from a __weak variable,
681     // emit this operation as a copy or move.
682     case CK_LValueToRValue: {
683       const Expr *srcExpr = castExpr->getSubExpr();
684       if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak)
685         return false;
686 
687       // Emit the source l-value.
688       LValue srcLV = CGF.EmitLValue(srcExpr);
689 
690       // Handle a formal type change to avoid asserting.
691       auto srcAddr = srcLV.getAddress();
692       if (needsCast) {
693         srcAddr = CGF.Builder.CreateElementBitCast(srcAddr,
694                                          destLV.getAddress().getElementType());
695       }
696 
697       // If it was an l-value, use objc_copyWeak.
698       if (srcExpr->getValueKind() == VK_LValue) {
699         CGF.EmitARCCopyWeak(destLV.getAddress(), srcAddr);
700       } else {
701         assert(srcExpr->getValueKind() == VK_XValue);
702         CGF.EmitARCMoveWeak(destLV.getAddress(), srcAddr);
703       }
704       return true;
705     }
706 
707     // Stop at anything else.
708     default:
709       return false;
710     }
711 
712     init = castExpr->getSubExpr();
713   }
714   return false;
715 }
716 
717 static void drillIntoBlockVariable(CodeGenFunction &CGF,
718                                    LValue &lvalue,
719                                    const VarDecl *var) {
720   lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(), var));
721 }
722 
723 void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS,
724                                            SourceLocation Loc) {
725   if (!SanOpts.has(SanitizerKind::NullabilityAssign))
726     return;
727 
728   auto Nullability = LHS.getType()->getNullability(getContext());
729   if (!Nullability || *Nullability != NullabilityKind::NonNull)
730     return;
731 
732   // Check if the right hand side of the assignment is nonnull, if the left
733   // hand side must be nonnull.
734   SanitizerScope SanScope(this);
735   llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS);
736   llvm::Constant *StaticData[] = {
737       EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()),
738       llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused.
739       llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)};
740   EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}},
741             SanitizerHandler::TypeMismatch, StaticData, RHS);
742 }
743 
744 void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D,
745                                      LValue lvalue, bool capturedByInit) {
746   Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime();
747   if (!lifetime) {
748     llvm::Value *value = EmitScalarExpr(init);
749     if (capturedByInit)
750       drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
751     EmitNullabilityCheck(lvalue, value, init->getExprLoc());
752     EmitStoreThroughLValue(RValue::get(value), lvalue, true);
753     return;
754   }
755 
756   if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init))
757     init = DIE->getExpr();
758 
759   // If we're emitting a value with lifetime, we have to do the
760   // initialization *before* we leave the cleanup scopes.
761   if (const FullExpr *fe = dyn_cast<FullExpr>(init)) {
762     enterFullExpression(fe);
763     init = fe->getSubExpr();
764   }
765   CodeGenFunction::RunCleanupsScope Scope(*this);
766 
767   // We have to maintain the illusion that the variable is
768   // zero-initialized.  If the variable might be accessed in its
769   // initializer, zero-initialize before running the initializer, then
770   // actually perform the initialization with an assign.
771   bool accessedByInit = false;
772   if (lifetime != Qualifiers::OCL_ExplicitNone)
773     accessedByInit = (capturedByInit || isAccessedBy(D, init));
774   if (accessedByInit) {
775     LValue tempLV = lvalue;
776     // Drill down to the __block object if necessary.
777     if (capturedByInit) {
778       // We can use a simple GEP for this because it can't have been
779       // moved yet.
780       tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(),
781                                               cast<VarDecl>(D),
782                                               /*follow*/ false));
783     }
784 
785     auto ty = cast<llvm::PointerType>(tempLV.getAddress().getElementType());
786     llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType());
787 
788     // If __weak, we want to use a barrier under certain conditions.
789     if (lifetime == Qualifiers::OCL_Weak)
790       EmitARCInitWeak(tempLV.getAddress(), zero);
791 
792     // Otherwise just do a simple store.
793     else
794       EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true);
795   }
796 
797   // Emit the initializer.
798   llvm::Value *value = nullptr;
799 
800   switch (lifetime) {
801   case Qualifiers::OCL_None:
802     llvm_unreachable("present but none");
803 
804   case Qualifiers::OCL_Strong: {
805     if (!D || !isa<VarDecl>(D) || !cast<VarDecl>(D)->isARCPseudoStrong()) {
806       value = EmitARCRetainScalarExpr(init);
807       break;
808     }
809     // If D is pseudo-strong, treat it like __unsafe_unretained here. This means
810     // that we omit the retain, and causes non-autoreleased return values to be
811     // immediately released.
812     LLVM_FALLTHROUGH;
813   }
814 
815   case Qualifiers::OCL_ExplicitNone:
816     value = EmitARCUnsafeUnretainedScalarExpr(init);
817     break;
818 
819   case Qualifiers::OCL_Weak: {
820     // If it's not accessed by the initializer, try to emit the
821     // initialization with a copy or move.
822     if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) {
823       return;
824     }
825 
826     // No way to optimize a producing initializer into this.  It's not
827     // worth optimizing for, because the value will immediately
828     // disappear in the common case.
829     value = EmitScalarExpr(init);
830 
831     if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
832     if (accessedByInit)
833       EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true);
834     else
835       EmitARCInitWeak(lvalue.getAddress(), value);
836     return;
837   }
838 
839   case Qualifiers::OCL_Autoreleasing:
840     value = EmitARCRetainAutoreleaseScalarExpr(init);
841     break;
842   }
843 
844   if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
845 
846   EmitNullabilityCheck(lvalue, value, init->getExprLoc());
847 
848   // If the variable might have been accessed by its initializer, we
849   // might have to initialize with a barrier.  We have to do this for
850   // both __weak and __strong, but __weak got filtered out above.
851   if (accessedByInit && lifetime == Qualifiers::OCL_Strong) {
852     llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc());
853     EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
854     EmitARCRelease(oldValue, ARCImpreciseLifetime);
855     return;
856   }
857 
858   EmitStoreOfScalar(value, lvalue, /* isInitialization */ true);
859 }
860 
861 /// Decide whether we can emit the non-zero parts of the specified initializer
862 /// with equal or fewer than NumStores scalar stores.
863 static bool canEmitInitWithFewStoresAfterBZero(llvm::Constant *Init,
864                                                unsigned &NumStores) {
865   // Zero and Undef never requires any extra stores.
866   if (isa<llvm::ConstantAggregateZero>(Init) ||
867       isa<llvm::ConstantPointerNull>(Init) ||
868       isa<llvm::UndefValue>(Init))
869     return true;
870   if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
871       isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
872       isa<llvm::ConstantExpr>(Init))
873     return Init->isNullValue() || NumStores--;
874 
875   // See if we can emit each element.
876   if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) {
877     for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
878       llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
879       if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
880         return false;
881     }
882     return true;
883   }
884 
885   if (llvm::ConstantDataSequential *CDS =
886         dyn_cast<llvm::ConstantDataSequential>(Init)) {
887     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
888       llvm::Constant *Elt = CDS->getElementAsConstant(i);
889       if (!canEmitInitWithFewStoresAfterBZero(Elt, NumStores))
890         return false;
891     }
892     return true;
893   }
894 
895   // Anything else is hard and scary.
896   return false;
897 }
898 
899 /// For inits that canEmitInitWithFewStoresAfterBZero returned true for, emit
900 /// the scalar stores that would be required.
901 static void emitStoresForInitAfterBZero(CodeGenModule &CGM,
902                                         llvm::Constant *Init, Address Loc,
903                                         bool isVolatile, CGBuilderTy &Builder) {
904   assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) &&
905          "called emitStoresForInitAfterBZero for zero or undef value.");
906 
907   if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) ||
908       isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) ||
909       isa<llvm::ConstantExpr>(Init)) {
910     Builder.CreateStore(Init, Loc, isVolatile);
911     return;
912   }
913 
914   if (llvm::ConstantDataSequential *CDS =
915           dyn_cast<llvm::ConstantDataSequential>(Init)) {
916     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
917       llvm::Constant *Elt = CDS->getElementAsConstant(i);
918 
919       // If necessary, get a pointer to the element and emit it.
920       if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
921         emitStoresForInitAfterBZero(
922             CGM, Elt, Builder.CreateConstInBoundsGEP2_32(Loc, 0, i), isVolatile,
923             Builder);
924     }
925     return;
926   }
927 
928   assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) &&
929          "Unknown value type!");
930 
931   for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) {
932     llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i));
933 
934     // If necessary, get a pointer to the element and emit it.
935     if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt))
936       emitStoresForInitAfterBZero(CGM, Elt,
937                                   Builder.CreateConstInBoundsGEP2_32(Loc, 0, i),
938                                   isVolatile, Builder);
939   }
940 }
941 
942 /// Decide whether we should use bzero plus some stores to initialize a local
943 /// variable instead of using a memcpy from a constant global.  It is beneficial
944 /// to use bzero if the global is all zeros, or mostly zeros and large.
945 static bool shouldUseBZeroPlusStoresToInitialize(llvm::Constant *Init,
946                                                  uint64_t GlobalSize) {
947   // If a global is all zeros, always use a bzero.
948   if (isa<llvm::ConstantAggregateZero>(Init)) return true;
949 
950   // If a non-zero global is <= 32 bytes, always use a memcpy.  If it is large,
951   // do it if it will require 6 or fewer scalar stores.
952   // TODO: Should budget depends on the size?  Avoiding a large global warrants
953   // plopping in more stores.
954   unsigned StoreBudget = 6;
955   uint64_t SizeLimit = 32;
956 
957   return GlobalSize > SizeLimit &&
958          canEmitInitWithFewStoresAfterBZero(Init, StoreBudget);
959 }
960 
961 /// Decide whether we should use memset to initialize a local variable instead
962 /// of using a memcpy from a constant global. Assumes we've already decided to
963 /// not user bzero.
964 /// FIXME We could be more clever, as we are for bzero above, and generate
965 ///       memset followed by stores. It's unclear that's worth the effort.
966 static llvm::Value *shouldUseMemSetToInitialize(llvm::Constant *Init,
967                                                 uint64_t GlobalSize) {
968   uint64_t SizeLimit = 32;
969   if (GlobalSize <= SizeLimit)
970     return nullptr;
971   return llvm::isBytewiseValue(Init);
972 }
973 
974 /// Decide whether we want to split a constant structure or array store into a
975 /// sequence of its fields' stores. This may cost us code size and compilation
976 /// speed, but plays better with store optimizations.
977 static bool shouldSplitConstantStore(CodeGenModule &CGM,
978                                      uint64_t GlobalByteSize) {
979   // Don't break things that occupy more than one cacheline.
980   uint64_t ByteSizeLimit = 64;
981   if (CGM.getCodeGenOpts().OptimizationLevel == 0)
982     return false;
983   if (GlobalByteSize <= ByteSizeLimit)
984     return true;
985   return false;
986 }
987 
988 enum class IsPattern { No, Yes };
989 
990 /// Generate a constant filled with either a pattern or zeroes.
991 static llvm::Constant *patternOrZeroFor(CodeGenModule &CGM, IsPattern isPattern,
992                                         llvm::Type *Ty) {
993   if (isPattern == IsPattern::Yes)
994     return initializationPatternFor(CGM, Ty);
995   else
996     return llvm::Constant::getNullValue(Ty);
997 }
998 
999 static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1000                                         llvm::Constant *constant);
1001 
1002 /// Helper function for constWithPadding() to deal with padding in structures.
1003 static llvm::Constant *constStructWithPadding(CodeGenModule &CGM,
1004                                               IsPattern isPattern,
1005                                               llvm::StructType *STy,
1006                                               llvm::Constant *constant) {
1007   const llvm::DataLayout &DL = CGM.getDataLayout();
1008   const llvm::StructLayout *Layout = DL.getStructLayout(STy);
1009   llvm::Type *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext());
1010   unsigned SizeSoFar = 0;
1011   SmallVector<llvm::Constant *, 8> Values;
1012   bool NestedIntact = true;
1013   for (unsigned i = 0, e = STy->getNumElements(); i != e; i++) {
1014     unsigned CurOff = Layout->getElementOffset(i);
1015     if (SizeSoFar < CurOff) {
1016       assert(!STy->isPacked());
1017       auto *PadTy = llvm::ArrayType::get(Int8Ty, CurOff - SizeSoFar);
1018       Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1019     }
1020     llvm::Constant *CurOp;
1021     if (constant->isZeroValue())
1022       CurOp = llvm::Constant::getNullValue(STy->getElementType(i));
1023     else
1024       CurOp = cast<llvm::Constant>(constant->getAggregateElement(i));
1025     auto *NewOp = constWithPadding(CGM, isPattern, CurOp);
1026     if (CurOp != NewOp)
1027       NestedIntact = false;
1028     Values.push_back(NewOp);
1029     SizeSoFar = CurOff + DL.getTypeAllocSize(CurOp->getType());
1030   }
1031   unsigned TotalSize = Layout->getSizeInBytes();
1032   if (SizeSoFar < TotalSize) {
1033     auto *PadTy = llvm::ArrayType::get(Int8Ty, TotalSize - SizeSoFar);
1034     Values.push_back(patternOrZeroFor(CGM, isPattern, PadTy));
1035   }
1036   if (NestedIntact && Values.size() == STy->getNumElements())
1037     return constant;
1038   return llvm::ConstantStruct::getAnon(Values, STy->isPacked());
1039 }
1040 
1041 /// Replace all padding bytes in a given constant with either a pattern byte or
1042 /// 0x00.
1043 static llvm::Constant *constWithPadding(CodeGenModule &CGM, IsPattern isPattern,
1044                                         llvm::Constant *constant) {
1045   llvm::Type *OrigTy = constant->getType();
1046   if (const auto STy = dyn_cast<llvm::StructType>(OrigTy))
1047     return constStructWithPadding(CGM, isPattern, STy, constant);
1048   if (auto *STy = dyn_cast<llvm::SequentialType>(OrigTy)) {
1049     llvm::SmallVector<llvm::Constant *, 8> Values;
1050     unsigned Size = STy->getNumElements();
1051     if (!Size)
1052       return constant;
1053     llvm::Type *ElemTy = STy->getElementType();
1054     bool ZeroInitializer = constant->isZeroValue();
1055     llvm::Constant *OpValue, *PaddedOp;
1056     if (ZeroInitializer) {
1057       OpValue = llvm::Constant::getNullValue(ElemTy);
1058       PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1059     }
1060     for (unsigned Op = 0; Op != Size; ++Op) {
1061       if (!ZeroInitializer) {
1062         OpValue = constant->getAggregateElement(Op);
1063         PaddedOp = constWithPadding(CGM, isPattern, OpValue);
1064       }
1065       Values.push_back(PaddedOp);
1066     }
1067     auto *NewElemTy = Values[0]->getType();
1068     if (NewElemTy == ElemTy)
1069       return constant;
1070     if (OrigTy->isArrayTy()) {
1071       auto *ArrayTy = llvm::ArrayType::get(NewElemTy, Size);
1072       return llvm::ConstantArray::get(ArrayTy, Values);
1073     } else {
1074       return llvm::ConstantVector::get(Values);
1075     }
1076   }
1077   return constant;
1078 }
1079 
1080 Address CodeGenModule::createUnnamedGlobalFrom(const VarDecl &D,
1081                                                llvm::Constant *Constant,
1082                                                CharUnits Align) {
1083   auto FunctionName = [&](const DeclContext *DC) -> std::string {
1084     if (const auto *FD = dyn_cast<FunctionDecl>(DC)) {
1085       if (const auto *CC = dyn_cast<CXXConstructorDecl>(FD))
1086         return CC->getNameAsString();
1087       if (const auto *CD = dyn_cast<CXXDestructorDecl>(FD))
1088         return CD->getNameAsString();
1089       return getMangledName(FD);
1090     } else if (const auto *OM = dyn_cast<ObjCMethodDecl>(DC)) {
1091       return OM->getNameAsString();
1092     } else if (isa<BlockDecl>(DC)) {
1093       return "<block>";
1094     } else if (isa<CapturedDecl>(DC)) {
1095       return "<captured>";
1096     } else {
1097       llvm_unreachable("expected a function or method");
1098     }
1099   };
1100 
1101   // Form a simple per-variable cache of these values in case we find we
1102   // want to reuse them.
1103   llvm::GlobalVariable *&CacheEntry = InitializerConstants[&D];
1104   if (!CacheEntry || CacheEntry->getInitializer() != Constant) {
1105     auto *Ty = Constant->getType();
1106     bool isConstant = true;
1107     llvm::GlobalVariable *InsertBefore = nullptr;
1108     unsigned AS =
1109         getContext().getTargetAddressSpace(getStringLiteralAddressSpace());
1110     std::string Name;
1111     if (D.hasGlobalStorage())
1112       Name = getMangledName(&D).str() + ".const";
1113     else if (const DeclContext *DC = D.getParentFunctionOrMethod())
1114       Name = ("__const." + FunctionName(DC) + "." + D.getName()).str();
1115     else
1116       llvm_unreachable("local variable has no parent function or method");
1117     llvm::GlobalVariable *GV = new llvm::GlobalVariable(
1118         getModule(), Ty, isConstant, llvm::GlobalValue::PrivateLinkage,
1119         Constant, Name, InsertBefore, llvm::GlobalValue::NotThreadLocal, AS);
1120     GV->setAlignment(Align.getQuantity());
1121     GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1122     CacheEntry = GV;
1123   } else if (CacheEntry->getAlignment() < Align.getQuantity()) {
1124     CacheEntry->setAlignment(Align.getQuantity());
1125   }
1126 
1127   return Address(CacheEntry, Align);
1128 }
1129 
1130 static Address createUnnamedGlobalForMemcpyFrom(CodeGenModule &CGM,
1131                                                 const VarDecl &D,
1132                                                 CGBuilderTy &Builder,
1133                                                 llvm::Constant *Constant,
1134                                                 CharUnits Align) {
1135   Address SrcPtr = CGM.createUnnamedGlobalFrom(D, Constant, Align);
1136   llvm::Type *BP = llvm::PointerType::getInt8PtrTy(CGM.getLLVMContext(),
1137                                                    SrcPtr.getAddressSpace());
1138   if (SrcPtr.getType() != BP)
1139     SrcPtr = Builder.CreateBitCast(SrcPtr, BP);
1140   return SrcPtr;
1141 }
1142 
1143 static void emitStoresForConstant(CodeGenModule &CGM, const VarDecl &D,
1144                                   Address Loc, bool isVolatile,
1145                                   CGBuilderTy &Builder,
1146                                   llvm::Constant *constant) {
1147   auto *Ty = constant->getType();
1148   uint64_t ConstantSize = CGM.getDataLayout().getTypeAllocSize(Ty);
1149   if (!ConstantSize)
1150     return;
1151 
1152   bool canDoSingleStore = Ty->isIntOrIntVectorTy() ||
1153                           Ty->isPtrOrPtrVectorTy() || Ty->isFPOrFPVectorTy();
1154   if (canDoSingleStore) {
1155     Builder.CreateStore(constant, Loc, isVolatile);
1156     return;
1157   }
1158 
1159   auto *SizeVal = llvm::ConstantInt::get(CGM.IntPtrTy, ConstantSize);
1160 
1161   // If the initializer is all or mostly the same, codegen with bzero / memset
1162   // then do a few stores afterward.
1163   if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) {
1164     Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, 0), SizeVal,
1165                          isVolatile);
1166 
1167     bool valueAlreadyCorrect =
1168         constant->isNullValue() || isa<llvm::UndefValue>(constant);
1169     if (!valueAlreadyCorrect) {
1170       Loc = Builder.CreateBitCast(Loc, Ty->getPointerTo(Loc.getAddressSpace()));
1171       emitStoresForInitAfterBZero(CGM, constant, Loc, isVolatile, Builder);
1172     }
1173     return;
1174   }
1175 
1176   // If the initializer is a repeated byte pattern, use memset.
1177   llvm::Value *Pattern = shouldUseMemSetToInitialize(constant, ConstantSize);
1178   if (Pattern) {
1179     uint64_t Value = 0x00;
1180     if (!isa<llvm::UndefValue>(Pattern)) {
1181       const llvm::APInt &AP = cast<llvm::ConstantInt>(Pattern)->getValue();
1182       assert(AP.getBitWidth() <= 8);
1183       Value = AP.getLimitedValue();
1184     }
1185     Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, Value), SizeVal,
1186                          isVolatile);
1187     return;
1188   }
1189 
1190   // If the initializer is small, use a handful of stores.
1191   if (shouldSplitConstantStore(CGM, ConstantSize)) {
1192     if (auto *STy = dyn_cast<llvm::StructType>(Ty)) {
1193       // FIXME: handle the case when STy != Loc.getElementType().
1194       if (STy == Loc.getElementType()) {
1195         for (unsigned i = 0; i != constant->getNumOperands(); i++) {
1196           Address EltPtr = Builder.CreateStructGEP(Loc, i);
1197           emitStoresForConstant(
1198               CGM, D, EltPtr, isVolatile, Builder,
1199               cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1200         }
1201         return;
1202       }
1203     } else if (auto *ATy = dyn_cast<llvm::ArrayType>(Ty)) {
1204       // FIXME: handle the case when ATy != Loc.getElementType().
1205       if (ATy == Loc.getElementType()) {
1206         for (unsigned i = 0; i != ATy->getNumElements(); i++) {
1207           Address EltPtr = Builder.CreateConstArrayGEP(Loc, i);
1208           emitStoresForConstant(
1209               CGM, D, EltPtr, isVolatile, Builder,
1210               cast<llvm::Constant>(Builder.CreateExtractValue(constant, i)));
1211         }
1212         return;
1213       }
1214     }
1215   }
1216 
1217   // Copy from a global.
1218   Builder.CreateMemCpy(Loc,
1219                        createUnnamedGlobalForMemcpyFrom(
1220                            CGM, D, Builder, constant, Loc.getAlignment()),
1221                        SizeVal, isVolatile);
1222 }
1223 
1224 static void emitStoresForZeroInit(CodeGenModule &CGM, const VarDecl &D,
1225                                   Address Loc, bool isVolatile,
1226                                   CGBuilderTy &Builder) {
1227   llvm::Type *ElTy = Loc.getElementType();
1228   llvm::Constant *constant =
1229       constWithPadding(CGM, IsPattern::No, llvm::Constant::getNullValue(ElTy));
1230   emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1231 }
1232 
1233 static void emitStoresForPatternInit(CodeGenModule &CGM, const VarDecl &D,
1234                                      Address Loc, bool isVolatile,
1235                                      CGBuilderTy &Builder) {
1236   llvm::Type *ElTy = Loc.getElementType();
1237   llvm::Constant *constant = constWithPadding(
1238       CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
1239   assert(!isa<llvm::UndefValue>(constant));
1240   emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant);
1241 }
1242 
1243 static bool containsUndef(llvm::Constant *constant) {
1244   auto *Ty = constant->getType();
1245   if (isa<llvm::UndefValue>(constant))
1246     return true;
1247   if (Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy())
1248     for (llvm::Use &Op : constant->operands())
1249       if (containsUndef(cast<llvm::Constant>(Op)))
1250         return true;
1251   return false;
1252 }
1253 
1254 static llvm::Constant *replaceUndef(CodeGenModule &CGM, IsPattern isPattern,
1255                                     llvm::Constant *constant) {
1256   auto *Ty = constant->getType();
1257   if (isa<llvm::UndefValue>(constant))
1258     return patternOrZeroFor(CGM, isPattern, Ty);
1259   if (!(Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()))
1260     return constant;
1261   if (!containsUndef(constant))
1262     return constant;
1263   llvm::SmallVector<llvm::Constant *, 8> Values(constant->getNumOperands());
1264   for (unsigned Op = 0, NumOp = constant->getNumOperands(); Op != NumOp; ++Op) {
1265     auto *OpValue = cast<llvm::Constant>(constant->getOperand(Op));
1266     Values[Op] = replaceUndef(CGM, isPattern, OpValue);
1267   }
1268   if (Ty->isStructTy())
1269     return llvm::ConstantStruct::get(cast<llvm::StructType>(Ty), Values);
1270   if (Ty->isArrayTy())
1271     return llvm::ConstantArray::get(cast<llvm::ArrayType>(Ty), Values);
1272   assert(Ty->isVectorTy());
1273   return llvm::ConstantVector::get(Values);
1274 }
1275 
1276 /// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a
1277 /// variable declaration with auto, register, or no storage class specifier.
1278 /// These turn into simple stack objects, or GlobalValues depending on target.
1279 void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) {
1280   AutoVarEmission emission = EmitAutoVarAlloca(D);
1281   EmitAutoVarInit(emission);
1282   EmitAutoVarCleanups(emission);
1283 }
1284 
1285 /// Emit a lifetime.begin marker if some criteria are satisfied.
1286 /// \return a pointer to the temporary size Value if a marker was emitted, null
1287 /// otherwise
1288 llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size,
1289                                                 llvm::Value *Addr) {
1290   if (!ShouldEmitLifetimeMarkers)
1291     return nullptr;
1292 
1293   assert(Addr->getType()->getPointerAddressSpace() ==
1294              CGM.getDataLayout().getAllocaAddrSpace() &&
1295          "Pointer should be in alloca address space");
1296   llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size);
1297   Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
1298   llvm::CallInst *C =
1299       Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr});
1300   C->setDoesNotThrow();
1301   return SizeV;
1302 }
1303 
1304 void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) {
1305   assert(Addr->getType()->getPointerAddressSpace() ==
1306              CGM.getDataLayout().getAllocaAddrSpace() &&
1307          "Pointer should be in alloca address space");
1308   Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy);
1309   llvm::CallInst *C =
1310       Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr});
1311   C->setDoesNotThrow();
1312 }
1313 
1314 void CodeGenFunction::EmitAndRegisterVariableArrayDimensions(
1315     CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) {
1316   // For each dimension stores its QualType and corresponding
1317   // size-expression Value.
1318   SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions;
1319   SmallVector<IdentifierInfo *, 4> VLAExprNames;
1320 
1321   // Break down the array into individual dimensions.
1322   QualType Type1D = D.getType();
1323   while (getContext().getAsVariableArrayType(Type1D)) {
1324     auto VlaSize = getVLAElements1D(Type1D);
1325     if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1326       Dimensions.emplace_back(C, Type1D.getUnqualifiedType());
1327     else {
1328       // Generate a locally unique name for the size expression.
1329       Twine Name = Twine("__vla_expr") + Twine(VLAExprCounter++);
1330       SmallString<12> Buffer;
1331       StringRef NameRef = Name.toStringRef(Buffer);
1332       auto &Ident = getContext().Idents.getOwn(NameRef);
1333       VLAExprNames.push_back(&Ident);
1334       auto SizeExprAddr =
1335           CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), NameRef);
1336       Builder.CreateStore(VlaSize.NumElts, SizeExprAddr);
1337       Dimensions.emplace_back(SizeExprAddr.getPointer(),
1338                               Type1D.getUnqualifiedType());
1339     }
1340     Type1D = VlaSize.Type;
1341   }
1342 
1343   if (!EmitDebugInfo)
1344     return;
1345 
1346   // Register each dimension's size-expression with a DILocalVariable,
1347   // so that it can be used by CGDebugInfo when instantiating a DISubrange
1348   // to describe this array.
1349   unsigned NameIdx = 0;
1350   for (auto &VlaSize : Dimensions) {
1351     llvm::Metadata *MD;
1352     if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts))
1353       MD = llvm::ConstantAsMetadata::get(C);
1354     else {
1355       // Create an artificial VarDecl to generate debug info for.
1356       IdentifierInfo *NameIdent = VLAExprNames[NameIdx++];
1357       auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType();
1358       auto QT = getContext().getIntTypeForBitwidth(
1359           VlaExprTy->getScalarSizeInBits(), false);
1360       auto *ArtificialDecl = VarDecl::Create(
1361           getContext(), const_cast<DeclContext *>(D.getDeclContext()),
1362           D.getLocation(), D.getLocation(), NameIdent, QT,
1363           getContext().CreateTypeSourceInfo(QT), SC_Auto);
1364       ArtificialDecl->setImplicit();
1365 
1366       MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts,
1367                                          Builder);
1368     }
1369     assert(MD && "No Size expression debug node created");
1370     DI->registerVLASizeExpression(VlaSize.Type, MD);
1371   }
1372 }
1373 
1374 /// EmitAutoVarAlloca - Emit the alloca and debug information for a
1375 /// local variable.  Does not emit initialization or destruction.
1376 CodeGenFunction::AutoVarEmission
1377 CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) {
1378   QualType Ty = D.getType();
1379   assert(
1380       Ty.getAddressSpace() == LangAS::Default ||
1381       (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL));
1382 
1383   AutoVarEmission emission(D);
1384 
1385   bool isEscapingByRef = D.isEscapingByref();
1386   emission.IsEscapingByRef = isEscapingByRef;
1387 
1388   CharUnits alignment = getContext().getDeclAlign(&D);
1389 
1390   // If the type is variably-modified, emit all the VLA sizes for it.
1391   if (Ty->isVariablyModifiedType())
1392     EmitVariablyModifiedType(Ty);
1393 
1394   auto *DI = getDebugInfo();
1395   bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >=
1396                                  codegenoptions::LimitedDebugInfo;
1397 
1398   Address address = Address::invalid();
1399   Address AllocaAddr = Address::invalid();
1400   Address OpenMPLocalAddr =
1401       getLangOpts().OpenMP
1402           ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
1403           : Address::invalid();
1404   bool NRVO = getLangOpts().ElideConstructors && D.isNRVOVariable();
1405 
1406   if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
1407     address = OpenMPLocalAddr;
1408   } else if (Ty->isConstantSizeType()) {
1409     // If this value is an array or struct with a statically determinable
1410     // constant initializer, there are optimizations we can do.
1411     //
1412     // TODO: We should constant-evaluate the initializer of any variable,
1413     // as long as it is initialized by a constant expression. Currently,
1414     // isConstantInitializer produces wrong answers for structs with
1415     // reference or bitfield members, and a few other cases, and checking
1416     // for POD-ness protects us from some of these.
1417     if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) &&
1418         (D.isConstexpr() ||
1419          ((Ty.isPODType(getContext()) ||
1420            getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) &&
1421           D.getInit()->isConstantInitializer(getContext(), false)))) {
1422 
1423       // If the variable's a const type, and it's neither an NRVO
1424       // candidate nor a __block variable and has no mutable members,
1425       // emit it as a global instead.
1426       // Exception is if a variable is located in non-constant address space
1427       // in OpenCL.
1428       if ((!getLangOpts().OpenCL ||
1429            Ty.getAddressSpace() == LangAS::opencl_constant) &&
1430           (CGM.getCodeGenOpts().MergeAllConstants && !NRVO &&
1431            !isEscapingByRef && CGM.isTypeConstant(Ty, true))) {
1432         EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
1433 
1434         // Signal this condition to later callbacks.
1435         emission.Addr = Address::invalid();
1436         assert(emission.wasEmittedAsGlobal());
1437         return emission;
1438       }
1439 
1440       // Otherwise, tell the initialization code that we're in this case.
1441       emission.IsConstantAggregate = true;
1442     }
1443 
1444     // A normal fixed sized variable becomes an alloca in the entry block,
1445     // unless:
1446     // - it's an NRVO variable.
1447     // - we are compiling OpenMP and it's an OpenMP local variable.
1448     if (NRVO) {
1449       // The named return value optimization: allocate this variable in the
1450       // return slot, so that we can elide the copy when returning this
1451       // variable (C++0x [class.copy]p34).
1452       address = ReturnValue;
1453 
1454       if (const RecordType *RecordTy = Ty->getAs<RecordType>()) {
1455         const auto *RD = RecordTy->getDecl();
1456         const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1457         if ((CXXRD && !CXXRD->hasTrivialDestructor()) ||
1458             RD->isNonTrivialToPrimitiveDestroy()) {
1459           // Create a flag that is used to indicate when the NRVO was applied
1460           // to this variable. Set it to zero to indicate that NRVO was not
1461           // applied.
1462           llvm::Value *Zero = Builder.getFalse();
1463           Address NRVOFlag =
1464             CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo");
1465           EnsureInsertPoint();
1466           Builder.CreateStore(Zero, NRVOFlag);
1467 
1468           // Record the NRVO flag for this variable.
1469           NRVOFlags[&D] = NRVOFlag.getPointer();
1470           emission.NRVOFlag = NRVOFlag.getPointer();
1471         }
1472       }
1473     } else {
1474       CharUnits allocaAlignment;
1475       llvm::Type *allocaTy;
1476       if (isEscapingByRef) {
1477         auto &byrefInfo = getBlockByrefInfo(&D);
1478         allocaTy = byrefInfo.Type;
1479         allocaAlignment = byrefInfo.ByrefAlignment;
1480       } else {
1481         allocaTy = ConvertTypeForMem(Ty);
1482         allocaAlignment = alignment;
1483       }
1484 
1485       // Create the alloca.  Note that we set the name separately from
1486       // building the instruction so that it's there even in no-asserts
1487       // builds.
1488       address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName(),
1489                                  /*ArraySize=*/nullptr, &AllocaAddr);
1490 
1491       // Don't emit lifetime markers for MSVC catch parameters. The lifetime of
1492       // the catch parameter starts in the catchpad instruction, and we can't
1493       // insert code in those basic blocks.
1494       bool IsMSCatchParam =
1495           D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft();
1496 
1497       // Emit a lifetime intrinsic if meaningful. There's no point in doing this
1498       // if we don't have a valid insertion point (?).
1499       if (HaveInsertPoint() && !IsMSCatchParam) {
1500         // If there's a jump into the lifetime of this variable, its lifetime
1501         // gets broken up into several regions in IR, which requires more work
1502         // to handle correctly. For now, just omit the intrinsics; this is a
1503         // rare case, and it's better to just be conservatively correct.
1504         // PR28267.
1505         //
1506         // We have to do this in all language modes if there's a jump past the
1507         // declaration. We also have to do it in C if there's a jump to an
1508         // earlier point in the current block because non-VLA lifetimes begin as
1509         // soon as the containing block is entered, not when its variables
1510         // actually come into scope; suppressing the lifetime annotations
1511         // completely in this case is unnecessarily pessimistic, but again, this
1512         // is rare.
1513         if (!Bypasses.IsBypassed(&D) &&
1514             !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) {
1515           uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy);
1516           emission.SizeForLifetimeMarkers =
1517               EmitLifetimeStart(size, AllocaAddr.getPointer());
1518         }
1519       } else {
1520         assert(!emission.useLifetimeMarkers());
1521       }
1522     }
1523   } else {
1524     EnsureInsertPoint();
1525 
1526     if (!DidCallStackSave) {
1527       // Save the stack.
1528       Address Stack =
1529         CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack");
1530 
1531       llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave);
1532       llvm::Value *V = Builder.CreateCall(F);
1533       Builder.CreateStore(V, Stack);
1534 
1535       DidCallStackSave = true;
1536 
1537       // Push a cleanup block and restore the stack there.
1538       // FIXME: in general circumstances, this should be an EH cleanup.
1539       pushStackRestore(NormalCleanup, Stack);
1540     }
1541 
1542     auto VlaSize = getVLASize(Ty);
1543     llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type);
1544 
1545     // Allocate memory for the array.
1546     address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts,
1547                                &AllocaAddr);
1548 
1549     // If we have debug info enabled, properly describe the VLA dimensions for
1550     // this type by registering the vla size expression for each of the
1551     // dimensions.
1552     EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo);
1553   }
1554 
1555   setAddrOfLocalVar(&D, address);
1556   emission.Addr = address;
1557   emission.AllocaAddr = AllocaAddr;
1558 
1559   // Emit debug info for local var declaration.
1560   if (EmitDebugInfo && HaveInsertPoint()) {
1561     Address DebugAddr = address;
1562     bool UsePointerValue = NRVO && ReturnValuePointer.isValid();
1563     DI->setLocation(D.getLocation());
1564 
1565     // If NRVO, use a pointer to the return address.
1566     if (UsePointerValue)
1567       DebugAddr = ReturnValuePointer;
1568 
1569     (void)DI->EmitDeclareOfAutoVariable(&D, DebugAddr.getPointer(), Builder,
1570                                         UsePointerValue);
1571   }
1572 
1573   if (D.hasAttr<AnnotateAttr>() && HaveInsertPoint())
1574     EmitVarAnnotations(&D, address.getPointer());
1575 
1576   // Make sure we call @llvm.lifetime.end.
1577   if (emission.useLifetimeMarkers())
1578     EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker,
1579                                          emission.getOriginalAllocatedAddress(),
1580                                          emission.getSizeForLifetimeMarkers());
1581 
1582   return emission;
1583 }
1584 
1585 static bool isCapturedBy(const VarDecl &, const Expr *);
1586 
1587 /// Determines whether the given __block variable is potentially
1588 /// captured by the given statement.
1589 static bool isCapturedBy(const VarDecl &Var, const Stmt *S) {
1590   if (const Expr *E = dyn_cast<Expr>(S))
1591     return isCapturedBy(Var, E);
1592   for (const Stmt *SubStmt : S->children())
1593     if (isCapturedBy(Var, SubStmt))
1594       return true;
1595   return false;
1596 }
1597 
1598 /// Determines whether the given __block variable is potentially
1599 /// captured by the given expression.
1600 static bool isCapturedBy(const VarDecl &Var, const Expr *E) {
1601   // Skip the most common kinds of expressions that make
1602   // hierarchy-walking expensive.
1603   E = E->IgnoreParenCasts();
1604 
1605   if (const BlockExpr *BE = dyn_cast<BlockExpr>(E)) {
1606     const BlockDecl *Block = BE->getBlockDecl();
1607     for (const auto &I : Block->captures()) {
1608       if (I.getVariable() == &Var)
1609         return true;
1610     }
1611 
1612     // No need to walk into the subexpressions.
1613     return false;
1614   }
1615 
1616   if (const StmtExpr *SE = dyn_cast<StmtExpr>(E)) {
1617     const CompoundStmt *CS = SE->getSubStmt();
1618     for (const auto *BI : CS->body())
1619       if (const auto *BIE = dyn_cast<Expr>(BI)) {
1620         if (isCapturedBy(Var, BIE))
1621           return true;
1622       }
1623       else if (const auto *DS = dyn_cast<DeclStmt>(BI)) {
1624           // special case declarations
1625           for (const auto *I : DS->decls()) {
1626               if (const auto *VD = dyn_cast<VarDecl>((I))) {
1627                 const Expr *Init = VD->getInit();
1628                 if (Init && isCapturedBy(Var, Init))
1629                   return true;
1630               }
1631           }
1632       }
1633       else
1634         // FIXME. Make safe assumption assuming arbitrary statements cause capturing.
1635         // Later, provide code to poke into statements for capture analysis.
1636         return true;
1637     return false;
1638   }
1639 
1640   for (const Stmt *SubStmt : E->children())
1641     if (isCapturedBy(Var, SubStmt))
1642       return true;
1643 
1644   return false;
1645 }
1646 
1647 /// Determine whether the given initializer is trivial in the sense
1648 /// that it requires no code to be generated.
1649 bool CodeGenFunction::isTrivialInitializer(const Expr *Init) {
1650   if (!Init)
1651     return true;
1652 
1653   if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init))
1654     if (CXXConstructorDecl *Constructor = Construct->getConstructor())
1655       if (Constructor->isTrivial() &&
1656           Constructor->isDefaultConstructor() &&
1657           !Construct->requiresZeroInitialization())
1658         return true;
1659 
1660   return false;
1661 }
1662 
1663 void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) {
1664   assert(emission.Variable && "emission was not valid!");
1665 
1666   // If this was emitted as a global constant, we're done.
1667   if (emission.wasEmittedAsGlobal()) return;
1668 
1669   const VarDecl &D = *emission.Variable;
1670   auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation());
1671   QualType type = D.getType();
1672 
1673   // If this local has an initializer, emit it now.
1674   const Expr *Init = D.getInit();
1675 
1676   // If we are at an unreachable point, we don't need to emit the initializer
1677   // unless it contains a label.
1678   if (!HaveInsertPoint()) {
1679     if (!Init || !ContainsLabel(Init)) return;
1680     EnsureInsertPoint();
1681   }
1682 
1683   // Initialize the structure of a __block variable.
1684   if (emission.IsEscapingByRef)
1685     emitByrefStructureInit(emission);
1686 
1687   // Initialize the variable here if it doesn't have a initializer and it is a
1688   // C struct that is non-trivial to initialize or an array containing such a
1689   // struct.
1690   if (!Init &&
1691       type.isNonTrivialToPrimitiveDefaultInitialize() ==
1692           QualType::PDIK_Struct) {
1693     LValue Dst = MakeAddrLValue(emission.getAllocatedAddress(), type);
1694     if (emission.IsEscapingByRef)
1695       drillIntoBlockVariable(*this, Dst, &D);
1696     defaultInitNonTrivialCStructVar(Dst);
1697     return;
1698   }
1699 
1700   // Check whether this is a byref variable that's potentially
1701   // captured and moved by its own initializer.  If so, we'll need to
1702   // emit the initializer first, then copy into the variable.
1703   bool capturedByInit =
1704       Init && emission.IsEscapingByRef && isCapturedBy(D, Init);
1705 
1706   bool locIsByrefHeader = !capturedByInit;
1707   const Address Loc =
1708       locIsByrefHeader ? emission.getObjectAddress(*this) : emission.Addr;
1709 
1710   // Note: constexpr already initializes everything correctly.
1711   LangOptions::TrivialAutoVarInitKind trivialAutoVarInit =
1712       (D.isConstexpr()
1713            ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1714            : (D.getAttr<UninitializedAttr>()
1715                   ? LangOptions::TrivialAutoVarInitKind::Uninitialized
1716                   : getContext().getLangOpts().getTrivialAutoVarInit()));
1717 
1718   auto initializeWhatIsTechnicallyUninitialized = [&](Address Loc) {
1719     if (trivialAutoVarInit ==
1720         LangOptions::TrivialAutoVarInitKind::Uninitialized)
1721       return;
1722 
1723     // Only initialize a __block's storage: we always initialize the header.
1724     if (emission.IsEscapingByRef && !locIsByrefHeader)
1725       Loc = emitBlockByrefAddress(Loc, &D, /*follow=*/false);
1726 
1727     bool isVolatile = type.isVolatileQualified();
1728     CharUnits Size = getContext().getTypeSizeInChars(type);
1729     if (!Size.isZero()) {
1730       switch (trivialAutoVarInit) {
1731       case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1732         llvm_unreachable("Uninitialized handled above");
1733       case LangOptions::TrivialAutoVarInitKind::Zero:
1734         emitStoresForZeroInit(CGM, D, Loc, isVolatile, Builder);
1735         break;
1736       case LangOptions::TrivialAutoVarInitKind::Pattern:
1737         emitStoresForPatternInit(CGM, D, Loc, isVolatile, Builder);
1738         break;
1739       }
1740       return;
1741     }
1742 
1743     // VLAs look zero-sized to getTypeInfo. We can't emit constant stores to
1744     // them, so emit a memcpy with the VLA size to initialize each element.
1745     // Technically zero-sized or negative-sized VLAs are undefined, and UBSan
1746     // will catch that code, but there exists code which generates zero-sized
1747     // VLAs. Be nice and initialize whatever they requested.
1748     const auto *VlaType = getContext().getAsVariableArrayType(type);
1749     if (!VlaType)
1750       return;
1751     auto VlaSize = getVLASize(VlaType);
1752     auto SizeVal = VlaSize.NumElts;
1753     CharUnits EltSize = getContext().getTypeSizeInChars(VlaSize.Type);
1754     switch (trivialAutoVarInit) {
1755     case LangOptions::TrivialAutoVarInitKind::Uninitialized:
1756       llvm_unreachable("Uninitialized handled above");
1757 
1758     case LangOptions::TrivialAutoVarInitKind::Zero:
1759       if (!EltSize.isOne())
1760         SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1761       Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal,
1762                            isVolatile);
1763       break;
1764 
1765     case LangOptions::TrivialAutoVarInitKind::Pattern: {
1766       llvm::Type *ElTy = Loc.getElementType();
1767       llvm::Constant *Constant = constWithPadding(
1768           CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy));
1769       CharUnits ConstantAlign = getContext().getTypeAlignInChars(VlaSize.Type);
1770       llvm::BasicBlock *SetupBB = createBasicBlock("vla-setup.loop");
1771       llvm::BasicBlock *LoopBB = createBasicBlock("vla-init.loop");
1772       llvm::BasicBlock *ContBB = createBasicBlock("vla-init.cont");
1773       llvm::Value *IsZeroSizedVLA = Builder.CreateICmpEQ(
1774           SizeVal, llvm::ConstantInt::get(SizeVal->getType(), 0),
1775           "vla.iszerosized");
1776       Builder.CreateCondBr(IsZeroSizedVLA, ContBB, SetupBB);
1777       EmitBlock(SetupBB);
1778       if (!EltSize.isOne())
1779         SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize));
1780       llvm::Value *BaseSizeInChars =
1781           llvm::ConstantInt::get(IntPtrTy, EltSize.getQuantity());
1782       Address Begin = Builder.CreateElementBitCast(Loc, Int8Ty, "vla.begin");
1783       llvm::Value *End =
1784           Builder.CreateInBoundsGEP(Begin.getPointer(), SizeVal, "vla.end");
1785       llvm::BasicBlock *OriginBB = Builder.GetInsertBlock();
1786       EmitBlock(LoopBB);
1787       llvm::PHINode *Cur = Builder.CreatePHI(Begin.getType(), 2, "vla.cur");
1788       Cur->addIncoming(Begin.getPointer(), OriginBB);
1789       CharUnits CurAlign = Loc.getAlignment().alignmentOfArrayElement(EltSize);
1790       Builder.CreateMemCpy(Address(Cur, CurAlign),
1791                            createUnnamedGlobalForMemcpyFrom(
1792                                CGM, D, Builder, Constant, ConstantAlign),
1793                            BaseSizeInChars, isVolatile);
1794       llvm::Value *Next =
1795           Builder.CreateInBoundsGEP(Int8Ty, Cur, BaseSizeInChars, "vla.next");
1796       llvm::Value *Done = Builder.CreateICmpEQ(Next, End, "vla-init.isdone");
1797       Builder.CreateCondBr(Done, ContBB, LoopBB);
1798       Cur->addIncoming(Next, LoopBB);
1799       EmitBlock(ContBB);
1800     } break;
1801     }
1802   };
1803 
1804   if (isTrivialInitializer(Init)) {
1805     initializeWhatIsTechnicallyUninitialized(Loc);
1806     return;
1807   }
1808 
1809   llvm::Constant *constant = nullptr;
1810   if (emission.IsConstantAggregate ||
1811       D.mightBeUsableInConstantExpressions(getContext())) {
1812     assert(!capturedByInit && "constant init contains a capturing block?");
1813     constant = ConstantEmitter(*this).tryEmitAbstractForInitializer(D);
1814     if (constant && !constant->isZeroValue() &&
1815         (trivialAutoVarInit !=
1816          LangOptions::TrivialAutoVarInitKind::Uninitialized)) {
1817       IsPattern isPattern =
1818           (trivialAutoVarInit == LangOptions::TrivialAutoVarInitKind::Pattern)
1819               ? IsPattern::Yes
1820               : IsPattern::No;
1821       // C guarantees that brace-init with fewer initializers than members in
1822       // the aggregate will initialize the rest of the aggregate as-if it were
1823       // static initialization. In turn static initialization guarantees that
1824       // padding is initialized to zero bits. We could instead pattern-init if D
1825       // has any ImplicitValueInitExpr, but that seems to be unintuitive
1826       // behavior.
1827       constant = constWithPadding(CGM, IsPattern::No,
1828                                   replaceUndef(CGM, isPattern, constant));
1829     }
1830   }
1831 
1832   if (!constant) {
1833     initializeWhatIsTechnicallyUninitialized(Loc);
1834     LValue lv = MakeAddrLValue(Loc, type);
1835     lv.setNonGC(true);
1836     return EmitExprAsInit(Init, &D, lv, capturedByInit);
1837   }
1838 
1839   if (!emission.IsConstantAggregate) {
1840     // For simple scalar/complex initialization, store the value directly.
1841     LValue lv = MakeAddrLValue(Loc, type);
1842     lv.setNonGC(true);
1843     return EmitStoreThroughLValue(RValue::get(constant), lv, true);
1844   }
1845 
1846   llvm::Type *BP = CGM.Int8Ty->getPointerTo(Loc.getAddressSpace());
1847   emitStoresForConstant(
1848       CGM, D, (Loc.getType() == BP) ? Loc : Builder.CreateBitCast(Loc, BP),
1849       type.isVolatileQualified(), Builder, constant);
1850 }
1851 
1852 /// Emit an expression as an initializer for an object (variable, field, etc.)
1853 /// at the given location.  The expression is not necessarily the normal
1854 /// initializer for the object, and the address is not necessarily
1855 /// its normal location.
1856 ///
1857 /// \param init the initializing expression
1858 /// \param D the object to act as if we're initializing
1859 /// \param loc the address to initialize; its type is a pointer
1860 ///   to the LLVM mapping of the object's type
1861 /// \param alignment the alignment of the address
1862 /// \param capturedByInit true if \p D is a __block variable
1863 ///   whose address is potentially changed by the initializer
1864 void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D,
1865                                      LValue lvalue, bool capturedByInit) {
1866   QualType type = D->getType();
1867 
1868   if (type->isReferenceType()) {
1869     RValue rvalue = EmitReferenceBindingToExpr(init);
1870     if (capturedByInit)
1871       drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
1872     EmitStoreThroughLValue(rvalue, lvalue, true);
1873     return;
1874   }
1875   switch (getEvaluationKind(type)) {
1876   case TEK_Scalar:
1877     EmitScalarInit(init, D, lvalue, capturedByInit);
1878     return;
1879   case TEK_Complex: {
1880     ComplexPairTy complex = EmitComplexExpr(init);
1881     if (capturedByInit)
1882       drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D));
1883     EmitStoreOfComplex(complex, lvalue, /*init*/ true);
1884     return;
1885   }
1886   case TEK_Aggregate:
1887     if (type->isAtomicType()) {
1888       EmitAtomicInit(const_cast<Expr*>(init), lvalue);
1889     } else {
1890       AggValueSlot::Overlap_t Overlap = AggValueSlot::MayOverlap;
1891       if (isa<VarDecl>(D))
1892         Overlap = AggValueSlot::DoesNotOverlap;
1893       else if (auto *FD = dyn_cast<FieldDecl>(D))
1894         Overlap = getOverlapForFieldInit(FD);
1895       // TODO: how can we delay here if D is captured by its initializer?
1896       EmitAggExpr(init, AggValueSlot::forLValue(lvalue,
1897                                               AggValueSlot::IsDestructed,
1898                                          AggValueSlot::DoesNotNeedGCBarriers,
1899                                               AggValueSlot::IsNotAliased,
1900                                               Overlap));
1901     }
1902     return;
1903   }
1904   llvm_unreachable("bad evaluation kind");
1905 }
1906 
1907 /// Enter a destroy cleanup for the given local variable.
1908 void CodeGenFunction::emitAutoVarTypeCleanup(
1909                             const CodeGenFunction::AutoVarEmission &emission,
1910                             QualType::DestructionKind dtorKind) {
1911   assert(dtorKind != QualType::DK_none);
1912 
1913   // Note that for __block variables, we want to destroy the
1914   // original stack object, not the possibly forwarded object.
1915   Address addr = emission.getObjectAddress(*this);
1916 
1917   const VarDecl *var = emission.Variable;
1918   QualType type = var->getType();
1919 
1920   CleanupKind cleanupKind = NormalAndEHCleanup;
1921   CodeGenFunction::Destroyer *destroyer = nullptr;
1922 
1923   switch (dtorKind) {
1924   case QualType::DK_none:
1925     llvm_unreachable("no cleanup for trivially-destructible variable");
1926 
1927   case QualType::DK_cxx_destructor:
1928     // If there's an NRVO flag on the emission, we need a different
1929     // cleanup.
1930     if (emission.NRVOFlag) {
1931       assert(!type->isArrayType());
1932       CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor();
1933       EHStack.pushCleanup<DestroyNRVOVariableCXX>(cleanupKind, addr, dtor,
1934                                                   emission.NRVOFlag);
1935       return;
1936     }
1937     break;
1938 
1939   case QualType::DK_objc_strong_lifetime:
1940     // Suppress cleanups for pseudo-strong variables.
1941     if (var->isARCPseudoStrong()) return;
1942 
1943     // Otherwise, consider whether to use an EH cleanup or not.
1944     cleanupKind = getARCCleanupKind();
1945 
1946     // Use the imprecise destroyer by default.
1947     if (!var->hasAttr<ObjCPreciseLifetimeAttr>())
1948       destroyer = CodeGenFunction::destroyARCStrongImprecise;
1949     break;
1950 
1951   case QualType::DK_objc_weak_lifetime:
1952     break;
1953 
1954   case QualType::DK_nontrivial_c_struct:
1955     destroyer = CodeGenFunction::destroyNonTrivialCStruct;
1956     if (emission.NRVOFlag) {
1957       assert(!type->isArrayType());
1958       EHStack.pushCleanup<DestroyNRVOVariableC>(cleanupKind, addr,
1959                                                 emission.NRVOFlag, type);
1960       return;
1961     }
1962     break;
1963   }
1964 
1965   // If we haven't chosen a more specific destroyer, use the default.
1966   if (!destroyer) destroyer = getDestroyer(dtorKind);
1967 
1968   // Use an EH cleanup in array destructors iff the destructor itself
1969   // is being pushed as an EH cleanup.
1970   bool useEHCleanup = (cleanupKind & EHCleanup);
1971   EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer,
1972                                      useEHCleanup);
1973 }
1974 
1975 void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) {
1976   assert(emission.Variable && "emission was not valid!");
1977 
1978   // If this was emitted as a global constant, we're done.
1979   if (emission.wasEmittedAsGlobal()) return;
1980 
1981   // If we don't have an insertion point, we're done.  Sema prevents
1982   // us from jumping into any of these scopes anyway.
1983   if (!HaveInsertPoint()) return;
1984 
1985   const VarDecl &D = *emission.Variable;
1986 
1987   // Check the type for a cleanup.
1988   if (QualType::DestructionKind dtorKind = D.getType().isDestructedType())
1989     emitAutoVarTypeCleanup(emission, dtorKind);
1990 
1991   // In GC mode, honor objc_precise_lifetime.
1992   if (getLangOpts().getGC() != LangOptions::NonGC &&
1993       D.hasAttr<ObjCPreciseLifetimeAttr>()) {
1994     EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D);
1995   }
1996 
1997   // Handle the cleanup attribute.
1998   if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) {
1999     const FunctionDecl *FD = CA->getFunctionDecl();
2000 
2001     llvm::Constant *F = CGM.GetAddrOfFunction(FD);
2002     assert(F && "Could not find function!");
2003 
2004     const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD);
2005     EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D);
2006   }
2007 
2008   // If this is a block variable, call _Block_object_destroy
2009   // (on the unforwarded address). Don't enter this cleanup if we're in pure-GC
2010   // mode.
2011   if (emission.IsEscapingByRef &&
2012       CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
2013     BlockFieldFlags Flags = BLOCK_FIELD_IS_BYREF;
2014     if (emission.Variable->getType().isObjCGCWeak())
2015       Flags |= BLOCK_FIELD_IS_WEAK;
2016     enterByrefCleanup(NormalAndEHCleanup, emission.Addr, Flags,
2017                       /*LoadBlockVarAddr*/ false,
2018                       cxxDestructorCanThrow(emission.Variable->getType()));
2019   }
2020 }
2021 
2022 CodeGenFunction::Destroyer *
2023 CodeGenFunction::getDestroyer(QualType::DestructionKind kind) {
2024   switch (kind) {
2025   case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor");
2026   case QualType::DK_cxx_destructor:
2027     return destroyCXXObject;
2028   case QualType::DK_objc_strong_lifetime:
2029     return destroyARCStrongPrecise;
2030   case QualType::DK_objc_weak_lifetime:
2031     return destroyARCWeak;
2032   case QualType::DK_nontrivial_c_struct:
2033     return destroyNonTrivialCStruct;
2034   }
2035   llvm_unreachable("Unknown DestructionKind");
2036 }
2037 
2038 /// pushEHDestroy - Push the standard destructor for the given type as
2039 /// an EH-only cleanup.
2040 void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind,
2041                                     Address addr, QualType type) {
2042   assert(dtorKind && "cannot push destructor for trivial type");
2043   assert(needsEHCleanup(dtorKind));
2044 
2045   pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true);
2046 }
2047 
2048 /// pushDestroy - Push the standard destructor for the given type as
2049 /// at least a normal cleanup.
2050 void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind,
2051                                   Address addr, QualType type) {
2052   assert(dtorKind && "cannot push destructor for trivial type");
2053 
2054   CleanupKind cleanupKind = getCleanupKind(dtorKind);
2055   pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind),
2056               cleanupKind & EHCleanup);
2057 }
2058 
2059 void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr,
2060                                   QualType type, Destroyer *destroyer,
2061                                   bool useEHCleanupForArray) {
2062   pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type,
2063                                      destroyer, useEHCleanupForArray);
2064 }
2065 
2066 void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) {
2067   EHStack.pushCleanup<CallStackRestore>(Kind, SPMem);
2068 }
2069 
2070 void CodeGenFunction::pushLifetimeExtendedDestroy(
2071     CleanupKind cleanupKind, Address addr, QualType type,
2072     Destroyer *destroyer, bool useEHCleanupForArray) {
2073   // Push an EH-only cleanup for the object now.
2074   // FIXME: When popping normal cleanups, we need to keep this EH cleanup
2075   // around in case a temporary's destructor throws an exception.
2076   if (cleanupKind & EHCleanup)
2077     EHStack.pushCleanup<DestroyObject>(
2078         static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type,
2079         destroyer, useEHCleanupForArray);
2080 
2081   // Remember that we need to push a full cleanup for the object at the
2082   // end of the full-expression.
2083   pushCleanupAfterFullExpr<DestroyObject>(
2084       cleanupKind, addr, type, destroyer, useEHCleanupForArray);
2085 }
2086 
2087 /// emitDestroy - Immediately perform the destruction of the given
2088 /// object.
2089 ///
2090 /// \param addr - the address of the object; a type*
2091 /// \param type - the type of the object; if an array type, all
2092 ///   objects are destroyed in reverse order
2093 /// \param destroyer - the function to call to destroy individual
2094 ///   elements
2095 /// \param useEHCleanupForArray - whether an EH cleanup should be
2096 ///   used when destroying array elements, in case one of the
2097 ///   destructions throws an exception
2098 void CodeGenFunction::emitDestroy(Address addr, QualType type,
2099                                   Destroyer *destroyer,
2100                                   bool useEHCleanupForArray) {
2101   const ArrayType *arrayType = getContext().getAsArrayType(type);
2102   if (!arrayType)
2103     return destroyer(*this, addr, type);
2104 
2105   llvm::Value *length = emitArrayLength(arrayType, type, addr);
2106 
2107   CharUnits elementAlign =
2108     addr.getAlignment()
2109         .alignmentOfArrayElement(getContext().getTypeSizeInChars(type));
2110 
2111   // Normally we have to check whether the array is zero-length.
2112   bool checkZeroLength = true;
2113 
2114   // But if the array length is constant, we can suppress that.
2115   if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) {
2116     // ...and if it's constant zero, we can just skip the entire thing.
2117     if (constLength->isZero()) return;
2118     checkZeroLength = false;
2119   }
2120 
2121   llvm::Value *begin = addr.getPointer();
2122   llvm::Value *end = Builder.CreateInBoundsGEP(begin, length);
2123   emitArrayDestroy(begin, end, type, elementAlign, destroyer,
2124                    checkZeroLength, useEHCleanupForArray);
2125 }
2126 
2127 /// emitArrayDestroy - Destroys all the elements of the given array,
2128 /// beginning from last to first.  The array cannot be zero-length.
2129 ///
2130 /// \param begin - a type* denoting the first element of the array
2131 /// \param end - a type* denoting one past the end of the array
2132 /// \param elementType - the element type of the array
2133 /// \param destroyer - the function to call to destroy elements
2134 /// \param useEHCleanup - whether to push an EH cleanup to destroy
2135 ///   the remaining elements in case the destruction of a single
2136 ///   element throws
2137 void CodeGenFunction::emitArrayDestroy(llvm::Value *begin,
2138                                        llvm::Value *end,
2139                                        QualType elementType,
2140                                        CharUnits elementAlign,
2141                                        Destroyer *destroyer,
2142                                        bool checkZeroLength,
2143                                        bool useEHCleanup) {
2144   assert(!elementType->isArrayType());
2145 
2146   // The basic structure here is a do-while loop, because we don't
2147   // need to check for the zero-element case.
2148   llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body");
2149   llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done");
2150 
2151   if (checkZeroLength) {
2152     llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end,
2153                                                 "arraydestroy.isempty");
2154     Builder.CreateCondBr(isEmpty, doneBB, bodyBB);
2155   }
2156 
2157   // Enter the loop body, making that address the current address.
2158   llvm::BasicBlock *entryBB = Builder.GetInsertBlock();
2159   EmitBlock(bodyBB);
2160   llvm::PHINode *elementPast =
2161     Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast");
2162   elementPast->addIncoming(end, entryBB);
2163 
2164   // Shift the address back by one element.
2165   llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true);
2166   llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne,
2167                                                    "arraydestroy.element");
2168 
2169   if (useEHCleanup)
2170     pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign,
2171                                    destroyer);
2172 
2173   // Perform the actual destruction there.
2174   destroyer(*this, Address(element, elementAlign), elementType);
2175 
2176   if (useEHCleanup)
2177     PopCleanupBlock();
2178 
2179   // Check whether we've reached the end.
2180   llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done");
2181   Builder.CreateCondBr(done, doneBB, bodyBB);
2182   elementPast->addIncoming(element, Builder.GetInsertBlock());
2183 
2184   // Done.
2185   EmitBlock(doneBB);
2186 }
2187 
2188 /// Perform partial array destruction as if in an EH cleanup.  Unlike
2189 /// emitArrayDestroy, the element type here may still be an array type.
2190 static void emitPartialArrayDestroy(CodeGenFunction &CGF,
2191                                     llvm::Value *begin, llvm::Value *end,
2192                                     QualType type, CharUnits elementAlign,
2193                                     CodeGenFunction::Destroyer *destroyer) {
2194   // If the element type is itself an array, drill down.
2195   unsigned arrayDepth = 0;
2196   while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) {
2197     // VLAs don't require a GEP index to walk into.
2198     if (!isa<VariableArrayType>(arrayType))
2199       arrayDepth++;
2200     type = arrayType->getElementType();
2201   }
2202 
2203   if (arrayDepth) {
2204     llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0);
2205 
2206     SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero);
2207     begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin");
2208     end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend");
2209   }
2210 
2211   // Destroy the array.  We don't ever need an EH cleanup because we
2212   // assume that we're in an EH cleanup ourselves, so a throwing
2213   // destructor causes an immediate terminate.
2214   CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer,
2215                        /*checkZeroLength*/ true, /*useEHCleanup*/ false);
2216 }
2217 
2218 namespace {
2219   /// RegularPartialArrayDestroy - a cleanup which performs a partial
2220   /// array destroy where the end pointer is regularly determined and
2221   /// does not need to be loaded from a local.
2222   class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup {
2223     llvm::Value *ArrayBegin;
2224     llvm::Value *ArrayEnd;
2225     QualType ElementType;
2226     CodeGenFunction::Destroyer *Destroyer;
2227     CharUnits ElementAlign;
2228   public:
2229     RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd,
2230                                QualType elementType, CharUnits elementAlign,
2231                                CodeGenFunction::Destroyer *destroyer)
2232       : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd),
2233         ElementType(elementType), Destroyer(destroyer),
2234         ElementAlign(elementAlign) {}
2235 
2236     void Emit(CodeGenFunction &CGF, Flags flags) override {
2237       emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd,
2238                               ElementType, ElementAlign, Destroyer);
2239     }
2240   };
2241 
2242   /// IrregularPartialArrayDestroy - a cleanup which performs a
2243   /// partial array destroy where the end pointer is irregularly
2244   /// determined and must be loaded from a local.
2245   class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup {
2246     llvm::Value *ArrayBegin;
2247     Address ArrayEndPointer;
2248     QualType ElementType;
2249     CodeGenFunction::Destroyer *Destroyer;
2250     CharUnits ElementAlign;
2251   public:
2252     IrregularPartialArrayDestroy(llvm::Value *arrayBegin,
2253                                  Address arrayEndPointer,
2254                                  QualType elementType,
2255                                  CharUnits elementAlign,
2256                                  CodeGenFunction::Destroyer *destroyer)
2257       : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer),
2258         ElementType(elementType), Destroyer(destroyer),
2259         ElementAlign(elementAlign) {}
2260 
2261     void Emit(CodeGenFunction &CGF, Flags flags) override {
2262       llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer);
2263       emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd,
2264                               ElementType, ElementAlign, Destroyer);
2265     }
2266   };
2267 } // end anonymous namespace
2268 
2269 /// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy
2270 /// already-constructed elements of the given array.  The cleanup
2271 /// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
2272 ///
2273 /// \param elementType - the immediate element type of the array;
2274 ///   possibly still an array type
2275 void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
2276                                                        Address arrayEndPointer,
2277                                                        QualType elementType,
2278                                                        CharUnits elementAlign,
2279                                                        Destroyer *destroyer) {
2280   pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup,
2281                                                     arrayBegin, arrayEndPointer,
2282                                                     elementType, elementAlign,
2283                                                     destroyer);
2284 }
2285 
2286 /// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy
2287 /// already-constructed elements of the given array.  The cleanup
2288 /// may be popped with DeactivateCleanupBlock or PopCleanupBlock.
2289 ///
2290 /// \param elementType - the immediate element type of the array;
2291 ///   possibly still an array type
2292 void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
2293                                                      llvm::Value *arrayEnd,
2294                                                      QualType elementType,
2295                                                      CharUnits elementAlign,
2296                                                      Destroyer *destroyer) {
2297   pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup,
2298                                                   arrayBegin, arrayEnd,
2299                                                   elementType, elementAlign,
2300                                                   destroyer);
2301 }
2302 
2303 /// Lazily declare the @llvm.lifetime.start intrinsic.
2304 llvm::Function *CodeGenModule::getLLVMLifetimeStartFn() {
2305   if (LifetimeStartFn)
2306     return LifetimeStartFn;
2307   LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(),
2308     llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy);
2309   return LifetimeStartFn;
2310 }
2311 
2312 /// Lazily declare the @llvm.lifetime.end intrinsic.
2313 llvm::Function *CodeGenModule::getLLVMLifetimeEndFn() {
2314   if (LifetimeEndFn)
2315     return LifetimeEndFn;
2316   LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(),
2317     llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy);
2318   return LifetimeEndFn;
2319 }
2320 
2321 namespace {
2322   /// A cleanup to perform a release of an object at the end of a
2323   /// function.  This is used to balance out the incoming +1 of a
2324   /// ns_consumed argument when we can't reasonably do that just by
2325   /// not doing the initial retain for a __block argument.
2326   struct ConsumeARCParameter final : EHScopeStack::Cleanup {
2327     ConsumeARCParameter(llvm::Value *param,
2328                         ARCPreciseLifetime_t precise)
2329       : Param(param), Precise(precise) {}
2330 
2331     llvm::Value *Param;
2332     ARCPreciseLifetime_t Precise;
2333 
2334     void Emit(CodeGenFunction &CGF, Flags flags) override {
2335       CGF.EmitARCRelease(Param, Precise);
2336     }
2337   };
2338 } // end anonymous namespace
2339 
2340 /// Emit an alloca (or GlobalValue depending on target)
2341 /// for the specified parameter and set up LocalDeclMap.
2342 void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg,
2343                                    unsigned ArgNo) {
2344   // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl?
2345   assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) &&
2346          "Invalid argument to EmitParmDecl");
2347 
2348   Arg.getAnyValue()->setName(D.getName());
2349 
2350   QualType Ty = D.getType();
2351 
2352   // Use better IR generation for certain implicit parameters.
2353   if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) {
2354     // The only implicit argument a block has is its literal.
2355     // This may be passed as an inalloca'ed value on Windows x86.
2356     if (BlockInfo) {
2357       llvm::Value *V = Arg.isIndirect()
2358                            ? Builder.CreateLoad(Arg.getIndirectAddress())
2359                            : Arg.getDirectValue();
2360       setBlockContextParameter(IPD, ArgNo, V);
2361       return;
2362     }
2363   }
2364 
2365   Address DeclPtr = Address::invalid();
2366   bool DoStore = false;
2367   bool IsScalar = hasScalarEvaluationKind(Ty);
2368   // If we already have a pointer to the argument, reuse the input pointer.
2369   if (Arg.isIndirect()) {
2370     DeclPtr = Arg.getIndirectAddress();
2371     // If we have a prettier pointer type at this point, bitcast to that.
2372     unsigned AS = DeclPtr.getType()->getAddressSpace();
2373     llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS);
2374     if (DeclPtr.getType() != IRTy)
2375       DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName());
2376     // Indirect argument is in alloca address space, which may be different
2377     // from the default address space.
2378     auto AllocaAS = CGM.getASTAllocaAddressSpace();
2379     auto *V = DeclPtr.getPointer();
2380     auto SrcLangAS = getLangOpts().OpenCL ? LangAS::opencl_private : AllocaAS;
2381     auto DestLangAS =
2382         getLangOpts().OpenCL ? LangAS::opencl_private : LangAS::Default;
2383     if (SrcLangAS != DestLangAS) {
2384       assert(getContext().getTargetAddressSpace(SrcLangAS) ==
2385              CGM.getDataLayout().getAllocaAddrSpace());
2386       auto DestAS = getContext().getTargetAddressSpace(DestLangAS);
2387       auto *T = V->getType()->getPointerElementType()->getPointerTo(DestAS);
2388       DeclPtr = Address(getTargetHooks().performAddrSpaceCast(
2389                             *this, V, SrcLangAS, DestLangAS, T, true),
2390                         DeclPtr.getAlignment());
2391     }
2392 
2393     // Push a destructor cleanup for this parameter if the ABI requires it.
2394     // Don't push a cleanup in a thunk for a method that will also emit a
2395     // cleanup.
2396     if (hasAggregateEvaluationKind(Ty) && !CurFuncIsThunk &&
2397         Ty->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
2398       if (QualType::DestructionKind DtorKind = Ty.isDestructedType()) {
2399         assert((DtorKind == QualType::DK_cxx_destructor ||
2400                 DtorKind == QualType::DK_nontrivial_c_struct) &&
2401                "unexpected destructor type");
2402         pushDestroy(DtorKind, DeclPtr, Ty);
2403         CalleeDestructedParamCleanups[cast<ParmVarDecl>(&D)] =
2404             EHStack.stable_begin();
2405       }
2406     }
2407   } else {
2408     // Check if the parameter address is controlled by OpenMP runtime.
2409     Address OpenMPLocalAddr =
2410         getLangOpts().OpenMP
2411             ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D)
2412             : Address::invalid();
2413     if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) {
2414       DeclPtr = OpenMPLocalAddr;
2415     } else {
2416       // Otherwise, create a temporary to hold the value.
2417       DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D),
2418                               D.getName() + ".addr");
2419     }
2420     DoStore = true;
2421   }
2422 
2423   llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr);
2424 
2425   LValue lv = MakeAddrLValue(DeclPtr, Ty);
2426   if (IsScalar) {
2427     Qualifiers qs = Ty.getQualifiers();
2428     if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) {
2429       // We honor __attribute__((ns_consumed)) for types with lifetime.
2430       // For __strong, it's handled by just skipping the initial retain;
2431       // otherwise we have to balance out the initial +1 with an extra
2432       // cleanup to do the release at the end of the function.
2433       bool isConsumed = D.hasAttr<NSConsumedAttr>();
2434 
2435       // If a parameter is pseudo-strong then we can omit the implicit retain.
2436       if (D.isARCPseudoStrong()) {
2437         assert(lt == Qualifiers::OCL_Strong &&
2438                "pseudo-strong variable isn't strong?");
2439         assert(qs.hasConst() && "pseudo-strong variable should be const!");
2440         lt = Qualifiers::OCL_ExplicitNone;
2441       }
2442 
2443       // Load objects passed indirectly.
2444       if (Arg.isIndirect() && !ArgVal)
2445         ArgVal = Builder.CreateLoad(DeclPtr);
2446 
2447       if (lt == Qualifiers::OCL_Strong) {
2448         if (!isConsumed) {
2449           if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2450             // use objc_storeStrong(&dest, value) for retaining the
2451             // object. But first, store a null into 'dest' because
2452             // objc_storeStrong attempts to release its old value.
2453             llvm::Value *Null = CGM.EmitNullConstant(D.getType());
2454             EmitStoreOfScalar(Null, lv, /* isInitialization */ true);
2455             EmitARCStoreStrongCall(lv.getAddress(), ArgVal, true);
2456             DoStore = false;
2457           }
2458           else
2459           // Don't use objc_retainBlock for block pointers, because we
2460           // don't want to Block_copy something just because we got it
2461           // as a parameter.
2462             ArgVal = EmitARCRetainNonBlock(ArgVal);
2463         }
2464       } else {
2465         // Push the cleanup for a consumed parameter.
2466         if (isConsumed) {
2467           ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>()
2468                                 ? ARCPreciseLifetime : ARCImpreciseLifetime);
2469           EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal,
2470                                                    precise);
2471         }
2472 
2473         if (lt == Qualifiers::OCL_Weak) {
2474           EmitARCInitWeak(DeclPtr, ArgVal);
2475           DoStore = false; // The weak init is a store, no need to do two.
2476         }
2477       }
2478 
2479       // Enter the cleanup scope.
2480       EmitAutoVarWithLifetime(*this, D, DeclPtr, lt);
2481     }
2482   }
2483 
2484   // Store the initial value into the alloca.
2485   if (DoStore)
2486     EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true);
2487 
2488   setAddrOfLocalVar(&D, DeclPtr);
2489 
2490   // Emit debug info for param declaration.
2491   if (CGDebugInfo *DI = getDebugInfo()) {
2492     if (CGM.getCodeGenOpts().getDebugInfo() >=
2493         codegenoptions::LimitedDebugInfo) {
2494       DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder);
2495     }
2496   }
2497 
2498   if (D.hasAttr<AnnotateAttr>())
2499     EmitVarAnnotations(&D, DeclPtr.getPointer());
2500 
2501   // We can only check return value nullability if all arguments to the
2502   // function satisfy their nullability preconditions. This makes it necessary
2503   // to emit null checks for args in the function body itself.
2504   if (requiresReturnValueNullabilityCheck()) {
2505     auto Nullability = Ty->getNullability(getContext());
2506     if (Nullability && *Nullability == NullabilityKind::NonNull) {
2507       SanitizerScope SanScope(this);
2508       RetValNullabilityPrecondition =
2509           Builder.CreateAnd(RetValNullabilityPrecondition,
2510                             Builder.CreateIsNotNull(Arg.getAnyValue()));
2511     }
2512   }
2513 }
2514 
2515 void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
2516                                             CodeGenFunction *CGF) {
2517   if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2518     return;
2519   getOpenMPRuntime().emitUserDefinedReduction(CGF, D);
2520 }
2521 
2522 void CodeGenModule::EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D,
2523                                             CodeGenFunction *CGF) {
2524   if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed()))
2525     return;
2526   // FIXME: need to implement mapper code generation
2527 }
2528 
2529 void CodeGenModule::EmitOMPRequiresDecl(const OMPRequiresDecl *D) {
2530   getOpenMPRuntime().checkArchForUnifiedAddressing(D);
2531 }
2532