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 bool canDoSingleStore = Ty->isIntOrIntVectorTy() || 1149 Ty->isPtrOrPtrVectorTy() || Ty->isFPOrFPVectorTy(); 1150 if (canDoSingleStore) { 1151 Builder.CreateStore(constant, Loc, isVolatile); 1152 return; 1153 } 1154 1155 auto *Int8Ty = llvm::IntegerType::getInt8Ty(CGM.getLLVMContext()); 1156 auto *IntPtrTy = CGM.getDataLayout().getIntPtrType(CGM.getLLVMContext()); 1157 1158 uint64_t ConstantSize = CGM.getDataLayout().getTypeAllocSize(Ty); 1159 if (!ConstantSize) 1160 return; 1161 auto *SizeVal = llvm::ConstantInt::get(IntPtrTy, ConstantSize); 1162 1163 // If the initializer is all or mostly the same, codegen with bzero / memset 1164 // then do a few stores afterward. 1165 if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) { 1166 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal, 1167 isVolatile); 1168 1169 bool valueAlreadyCorrect = 1170 constant->isNullValue() || isa<llvm::UndefValue>(constant); 1171 if (!valueAlreadyCorrect) { 1172 Loc = Builder.CreateBitCast(Loc, Ty->getPointerTo(Loc.getAddressSpace())); 1173 emitStoresForInitAfterBZero(CGM, constant, Loc, isVolatile, Builder); 1174 } 1175 return; 1176 } 1177 1178 // If the initializer is a repeated byte pattern, use memset. 1179 llvm::Value *Pattern = shouldUseMemSetToInitialize(constant, ConstantSize); 1180 if (Pattern) { 1181 uint64_t Value = 0x00; 1182 if (!isa<llvm::UndefValue>(Pattern)) { 1183 const llvm::APInt &AP = cast<llvm::ConstantInt>(Pattern)->getValue(); 1184 assert(AP.getBitWidth() <= 8); 1185 Value = AP.getLimitedValue(); 1186 } 1187 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, Value), SizeVal, 1188 isVolatile); 1189 return; 1190 } 1191 1192 // If the initializer is small, use a handful of stores. 1193 if (shouldSplitConstantStore(CGM, ConstantSize)) { 1194 if (auto *STy = dyn_cast<llvm::StructType>(Ty)) { 1195 // FIXME: handle the case when STy != Loc.getElementType(). 1196 if (STy == Loc.getElementType()) { 1197 for (unsigned i = 0; i != constant->getNumOperands(); i++) { 1198 Address EltPtr = Builder.CreateStructGEP(Loc, i); 1199 emitStoresForConstant( 1200 CGM, D, EltPtr, isVolatile, Builder, 1201 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i))); 1202 } 1203 return; 1204 } 1205 } else if (auto *ATy = dyn_cast<llvm::ArrayType>(Ty)) { 1206 // FIXME: handle the case when ATy != Loc.getElementType(). 1207 if (ATy == Loc.getElementType()) { 1208 for (unsigned i = 0; i != ATy->getNumElements(); i++) { 1209 Address EltPtr = Builder.CreateConstArrayGEP(Loc, i); 1210 emitStoresForConstant( 1211 CGM, D, EltPtr, isVolatile, Builder, 1212 cast<llvm::Constant>(Builder.CreateExtractValue(constant, i))); 1213 } 1214 return; 1215 } 1216 } 1217 } 1218 1219 // Copy from a global. 1220 Builder.CreateMemCpy(Loc, 1221 createUnnamedGlobalForMemcpyFrom( 1222 CGM, D, Builder, constant, Loc.getAlignment()), 1223 SizeVal, isVolatile); 1224 } 1225 1226 static void emitStoresForZeroInit(CodeGenModule &CGM, const VarDecl &D, 1227 Address Loc, bool isVolatile, 1228 CGBuilderTy &Builder) { 1229 llvm::Type *ElTy = Loc.getElementType(); 1230 llvm::Constant *constant = 1231 constWithPadding(CGM, IsPattern::No, llvm::Constant::getNullValue(ElTy)); 1232 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant); 1233 } 1234 1235 static void emitStoresForPatternInit(CodeGenModule &CGM, const VarDecl &D, 1236 Address Loc, bool isVolatile, 1237 CGBuilderTy &Builder) { 1238 llvm::Type *ElTy = Loc.getElementType(); 1239 llvm::Constant *constant = constWithPadding( 1240 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy)); 1241 assert(!isa<llvm::UndefValue>(constant)); 1242 emitStoresForConstant(CGM, D, Loc, isVolatile, Builder, constant); 1243 } 1244 1245 static bool containsUndef(llvm::Constant *constant) { 1246 auto *Ty = constant->getType(); 1247 if (isa<llvm::UndefValue>(constant)) 1248 return true; 1249 if (Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()) 1250 for (llvm::Use &Op : constant->operands()) 1251 if (containsUndef(cast<llvm::Constant>(Op))) 1252 return true; 1253 return false; 1254 } 1255 1256 static llvm::Constant *replaceUndef(CodeGenModule &CGM, IsPattern isPattern, 1257 llvm::Constant *constant) { 1258 auto *Ty = constant->getType(); 1259 if (isa<llvm::UndefValue>(constant)) 1260 return patternOrZeroFor(CGM, isPattern, Ty); 1261 if (!(Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy())) 1262 return constant; 1263 if (!containsUndef(constant)) 1264 return constant; 1265 llvm::SmallVector<llvm::Constant *, 8> Values(constant->getNumOperands()); 1266 for (unsigned Op = 0, NumOp = constant->getNumOperands(); Op != NumOp; ++Op) { 1267 auto *OpValue = cast<llvm::Constant>(constant->getOperand(Op)); 1268 Values[Op] = replaceUndef(CGM, isPattern, OpValue); 1269 } 1270 if (Ty->isStructTy()) 1271 return llvm::ConstantStruct::get(cast<llvm::StructType>(Ty), Values); 1272 if (Ty->isArrayTy()) 1273 return llvm::ConstantArray::get(cast<llvm::ArrayType>(Ty), Values); 1274 assert(Ty->isVectorTy()); 1275 return llvm::ConstantVector::get(Values); 1276 } 1277 1278 /// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a 1279 /// variable declaration with auto, register, or no storage class specifier. 1280 /// These turn into simple stack objects, or GlobalValues depending on target. 1281 void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) { 1282 AutoVarEmission emission = EmitAutoVarAlloca(D); 1283 EmitAutoVarInit(emission); 1284 EmitAutoVarCleanups(emission); 1285 } 1286 1287 /// Emit a lifetime.begin marker if some criteria are satisfied. 1288 /// \return a pointer to the temporary size Value if a marker was emitted, null 1289 /// otherwise 1290 llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size, 1291 llvm::Value *Addr) { 1292 if (!ShouldEmitLifetimeMarkers) 1293 return nullptr; 1294 1295 assert(Addr->getType()->getPointerAddressSpace() == 1296 CGM.getDataLayout().getAllocaAddrSpace() && 1297 "Pointer should be in alloca address space"); 1298 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size); 1299 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy); 1300 llvm::CallInst *C = 1301 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr}); 1302 C->setDoesNotThrow(); 1303 return SizeV; 1304 } 1305 1306 void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) { 1307 assert(Addr->getType()->getPointerAddressSpace() == 1308 CGM.getDataLayout().getAllocaAddrSpace() && 1309 "Pointer should be in alloca address space"); 1310 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy); 1311 llvm::CallInst *C = 1312 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr}); 1313 C->setDoesNotThrow(); 1314 } 1315 1316 void CodeGenFunction::EmitAndRegisterVariableArrayDimensions( 1317 CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) { 1318 // For each dimension stores its QualType and corresponding 1319 // size-expression Value. 1320 SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions; 1321 SmallVector<IdentifierInfo *, 4> VLAExprNames; 1322 1323 // Break down the array into individual dimensions. 1324 QualType Type1D = D.getType(); 1325 while (getContext().getAsVariableArrayType(Type1D)) { 1326 auto VlaSize = getVLAElements1D(Type1D); 1327 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts)) 1328 Dimensions.emplace_back(C, Type1D.getUnqualifiedType()); 1329 else { 1330 // Generate a locally unique name for the size expression. 1331 Twine Name = Twine("__vla_expr") + Twine(VLAExprCounter++); 1332 SmallString<12> Buffer; 1333 StringRef NameRef = Name.toStringRef(Buffer); 1334 auto &Ident = getContext().Idents.getOwn(NameRef); 1335 VLAExprNames.push_back(&Ident); 1336 auto SizeExprAddr = 1337 CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), NameRef); 1338 Builder.CreateStore(VlaSize.NumElts, SizeExprAddr); 1339 Dimensions.emplace_back(SizeExprAddr.getPointer(), 1340 Type1D.getUnqualifiedType()); 1341 } 1342 Type1D = VlaSize.Type; 1343 } 1344 1345 if (!EmitDebugInfo) 1346 return; 1347 1348 // Register each dimension's size-expression with a DILocalVariable, 1349 // so that it can be used by CGDebugInfo when instantiating a DISubrange 1350 // to describe this array. 1351 unsigned NameIdx = 0; 1352 for (auto &VlaSize : Dimensions) { 1353 llvm::Metadata *MD; 1354 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts)) 1355 MD = llvm::ConstantAsMetadata::get(C); 1356 else { 1357 // Create an artificial VarDecl to generate debug info for. 1358 IdentifierInfo *NameIdent = VLAExprNames[NameIdx++]; 1359 auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType(); 1360 auto QT = getContext().getIntTypeForBitwidth( 1361 VlaExprTy->getScalarSizeInBits(), false); 1362 auto *ArtificialDecl = VarDecl::Create( 1363 getContext(), const_cast<DeclContext *>(D.getDeclContext()), 1364 D.getLocation(), D.getLocation(), NameIdent, QT, 1365 getContext().CreateTypeSourceInfo(QT), SC_Auto); 1366 ArtificialDecl->setImplicit(); 1367 1368 MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts, 1369 Builder); 1370 } 1371 assert(MD && "No Size expression debug node created"); 1372 DI->registerVLASizeExpression(VlaSize.Type, MD); 1373 } 1374 } 1375 1376 /// EmitAutoVarAlloca - Emit the alloca and debug information for a 1377 /// local variable. Does not emit initialization or destruction. 1378 CodeGenFunction::AutoVarEmission 1379 CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) { 1380 QualType Ty = D.getType(); 1381 assert( 1382 Ty.getAddressSpace() == LangAS::Default || 1383 (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL)); 1384 1385 AutoVarEmission emission(D); 1386 1387 bool isEscapingByRef = D.isEscapingByref(); 1388 emission.IsEscapingByRef = isEscapingByRef; 1389 1390 CharUnits alignment = getContext().getDeclAlign(&D); 1391 1392 // If the type is variably-modified, emit all the VLA sizes for it. 1393 if (Ty->isVariablyModifiedType()) 1394 EmitVariablyModifiedType(Ty); 1395 1396 auto *DI = getDebugInfo(); 1397 bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >= 1398 codegenoptions::LimitedDebugInfo; 1399 1400 Address address = Address::invalid(); 1401 Address AllocaAddr = Address::invalid(); 1402 Address OpenMPLocalAddr = 1403 getLangOpts().OpenMP 1404 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D) 1405 : Address::invalid(); 1406 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) { 1407 address = OpenMPLocalAddr; 1408 } else if (Ty->isConstantSizeType()) { 1409 bool NRVO = getLangOpts().ElideConstructors && 1410 D.isNRVOVariable(); 1411 1412 // If this value is an array or struct with a statically determinable 1413 // constant initializer, there are optimizations we can do. 1414 // 1415 // TODO: We should constant-evaluate the initializer of any variable, 1416 // as long as it is initialized by a constant expression. Currently, 1417 // isConstantInitializer produces wrong answers for structs with 1418 // reference or bitfield members, and a few other cases, and checking 1419 // for POD-ness protects us from some of these. 1420 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) && 1421 (D.isConstexpr() || 1422 ((Ty.isPODType(getContext()) || 1423 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) && 1424 D.getInit()->isConstantInitializer(getContext(), false)))) { 1425 1426 // If the variable's a const type, and it's neither an NRVO 1427 // candidate nor a __block variable and has no mutable members, 1428 // emit it as a global instead. 1429 // Exception is if a variable is located in non-constant address space 1430 // in OpenCL. 1431 if ((!getLangOpts().OpenCL || 1432 Ty.getAddressSpace() == LangAS::opencl_constant) && 1433 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO && 1434 !isEscapingByRef && CGM.isTypeConstant(Ty, true))) { 1435 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage); 1436 1437 // Signal this condition to later callbacks. 1438 emission.Addr = Address::invalid(); 1439 assert(emission.wasEmittedAsGlobal()); 1440 return emission; 1441 } 1442 1443 // Otherwise, tell the initialization code that we're in this case. 1444 emission.IsConstantAggregate = true; 1445 } 1446 1447 // A normal fixed sized variable becomes an alloca in the entry block, 1448 // unless: 1449 // - it's an NRVO variable. 1450 // - we are compiling OpenMP and it's an OpenMP local variable. 1451 if (NRVO) { 1452 // The named return value optimization: allocate this variable in the 1453 // return slot, so that we can elide the copy when returning this 1454 // variable (C++0x [class.copy]p34). 1455 address = ReturnValue; 1456 1457 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) { 1458 const auto *RD = RecordTy->getDecl(); 1459 const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD); 1460 if ((CXXRD && !CXXRD->hasTrivialDestructor()) || 1461 RD->isNonTrivialToPrimitiveDestroy()) { 1462 // Create a flag that is used to indicate when the NRVO was applied 1463 // to this variable. Set it to zero to indicate that NRVO was not 1464 // applied. 1465 llvm::Value *Zero = Builder.getFalse(); 1466 Address NRVOFlag = 1467 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo"); 1468 EnsureInsertPoint(); 1469 Builder.CreateStore(Zero, NRVOFlag); 1470 1471 // Record the NRVO flag for this variable. 1472 NRVOFlags[&D] = NRVOFlag.getPointer(); 1473 emission.NRVOFlag = NRVOFlag.getPointer(); 1474 } 1475 } 1476 } else { 1477 CharUnits allocaAlignment; 1478 llvm::Type *allocaTy; 1479 if (isEscapingByRef) { 1480 auto &byrefInfo = getBlockByrefInfo(&D); 1481 allocaTy = byrefInfo.Type; 1482 allocaAlignment = byrefInfo.ByrefAlignment; 1483 } else { 1484 allocaTy = ConvertTypeForMem(Ty); 1485 allocaAlignment = alignment; 1486 } 1487 1488 // Create the alloca. Note that we set the name separately from 1489 // building the instruction so that it's there even in no-asserts 1490 // builds. 1491 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName(), 1492 /*ArraySize=*/nullptr, &AllocaAddr); 1493 1494 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of 1495 // the catch parameter starts in the catchpad instruction, and we can't 1496 // insert code in those basic blocks. 1497 bool IsMSCatchParam = 1498 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft(); 1499 1500 // Emit a lifetime intrinsic if meaningful. There's no point in doing this 1501 // if we don't have a valid insertion point (?). 1502 if (HaveInsertPoint() && !IsMSCatchParam) { 1503 // If there's a jump into the lifetime of this variable, its lifetime 1504 // gets broken up into several regions in IR, which requires more work 1505 // to handle correctly. For now, just omit the intrinsics; this is a 1506 // rare case, and it's better to just be conservatively correct. 1507 // PR28267. 1508 // 1509 // We have to do this in all language modes if there's a jump past the 1510 // declaration. We also have to do it in C if there's a jump to an 1511 // earlier point in the current block because non-VLA lifetimes begin as 1512 // soon as the containing block is entered, not when its variables 1513 // actually come into scope; suppressing the lifetime annotations 1514 // completely in this case is unnecessarily pessimistic, but again, this 1515 // is rare. 1516 if (!Bypasses.IsBypassed(&D) && 1517 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) { 1518 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy); 1519 emission.SizeForLifetimeMarkers = 1520 EmitLifetimeStart(size, AllocaAddr.getPointer()); 1521 } 1522 } else { 1523 assert(!emission.useLifetimeMarkers()); 1524 } 1525 } 1526 } else { 1527 EnsureInsertPoint(); 1528 1529 if (!DidCallStackSave) { 1530 // Save the stack. 1531 Address Stack = 1532 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack"); 1533 1534 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave); 1535 llvm::Value *V = Builder.CreateCall(F); 1536 Builder.CreateStore(V, Stack); 1537 1538 DidCallStackSave = true; 1539 1540 // Push a cleanup block and restore the stack there. 1541 // FIXME: in general circumstances, this should be an EH cleanup. 1542 pushStackRestore(NormalCleanup, Stack); 1543 } 1544 1545 auto VlaSize = getVLASize(Ty); 1546 llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type); 1547 1548 // Allocate memory for the array. 1549 address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts, 1550 &AllocaAddr); 1551 1552 // If we have debug info enabled, properly describe the VLA dimensions for 1553 // this type by registering the vla size expression for each of the 1554 // dimensions. 1555 EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo); 1556 } 1557 1558 setAddrOfLocalVar(&D, address); 1559 emission.Addr = address; 1560 emission.AllocaAddr = AllocaAddr; 1561 1562 // Emit debug info for local var declaration. 1563 if (EmitDebugInfo && HaveInsertPoint()) { 1564 DI->setLocation(D.getLocation()); 1565 (void)DI->EmitDeclareOfAutoVariable(&D, address.getPointer(), Builder); 1566 } 1567 1568 if (D.hasAttr<AnnotateAttr>() && HaveInsertPoint()) 1569 EmitVarAnnotations(&D, address.getPointer()); 1570 1571 // Make sure we call @llvm.lifetime.end. 1572 if (emission.useLifetimeMarkers()) 1573 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, 1574 emission.getOriginalAllocatedAddress(), 1575 emission.getSizeForLifetimeMarkers()); 1576 1577 return emission; 1578 } 1579 1580 static bool isCapturedBy(const VarDecl &, const Expr *); 1581 1582 /// Determines whether the given __block variable is potentially 1583 /// captured by the given statement. 1584 static bool isCapturedBy(const VarDecl &Var, const Stmt *S) { 1585 if (const Expr *E = dyn_cast<Expr>(S)) 1586 return isCapturedBy(Var, E); 1587 for (const Stmt *SubStmt : S->children()) 1588 if (isCapturedBy(Var, SubStmt)) 1589 return true; 1590 return false; 1591 } 1592 1593 /// Determines whether the given __block variable is potentially 1594 /// captured by the given expression. 1595 static bool isCapturedBy(const VarDecl &Var, const Expr *E) { 1596 // Skip the most common kinds of expressions that make 1597 // hierarchy-walking expensive. 1598 E = E->IgnoreParenCasts(); 1599 1600 if (const BlockExpr *BE = dyn_cast<BlockExpr>(E)) { 1601 const BlockDecl *Block = BE->getBlockDecl(); 1602 for (const auto &I : Block->captures()) { 1603 if (I.getVariable() == &Var) 1604 return true; 1605 } 1606 1607 // No need to walk into the subexpressions. 1608 return false; 1609 } 1610 1611 if (const StmtExpr *SE = dyn_cast<StmtExpr>(E)) { 1612 const CompoundStmt *CS = SE->getSubStmt(); 1613 for (const auto *BI : CS->body()) 1614 if (const auto *BIE = dyn_cast<Expr>(BI)) { 1615 if (isCapturedBy(Var, BIE)) 1616 return true; 1617 } 1618 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) { 1619 // special case declarations 1620 for (const auto *I : DS->decls()) { 1621 if (const auto *VD = dyn_cast<VarDecl>((I))) { 1622 const Expr *Init = VD->getInit(); 1623 if (Init && isCapturedBy(Var, Init)) 1624 return true; 1625 } 1626 } 1627 } 1628 else 1629 // FIXME. Make safe assumption assuming arbitrary statements cause capturing. 1630 // Later, provide code to poke into statements for capture analysis. 1631 return true; 1632 return false; 1633 } 1634 1635 for (const Stmt *SubStmt : E->children()) 1636 if (isCapturedBy(Var, SubStmt)) 1637 return true; 1638 1639 return false; 1640 } 1641 1642 /// Determine whether the given initializer is trivial in the sense 1643 /// that it requires no code to be generated. 1644 bool CodeGenFunction::isTrivialInitializer(const Expr *Init) { 1645 if (!Init) 1646 return true; 1647 1648 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init)) 1649 if (CXXConstructorDecl *Constructor = Construct->getConstructor()) 1650 if (Constructor->isTrivial() && 1651 Constructor->isDefaultConstructor() && 1652 !Construct->requiresZeroInitialization()) 1653 return true; 1654 1655 return false; 1656 } 1657 1658 void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) { 1659 assert(emission.Variable && "emission was not valid!"); 1660 1661 // If this was emitted as a global constant, we're done. 1662 if (emission.wasEmittedAsGlobal()) return; 1663 1664 const VarDecl &D = *emission.Variable; 1665 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation()); 1666 QualType type = D.getType(); 1667 1668 bool isVolatile = type.isVolatileQualified(); 1669 1670 // If this local has an initializer, emit it now. 1671 const Expr *Init = D.getInit(); 1672 1673 // If we are at an unreachable point, we don't need to emit the initializer 1674 // unless it contains a label. 1675 if (!HaveInsertPoint()) { 1676 if (!Init || !ContainsLabel(Init)) return; 1677 EnsureInsertPoint(); 1678 } 1679 1680 // Initialize the structure of a __block variable. 1681 if (emission.IsEscapingByRef) 1682 emitByrefStructureInit(emission); 1683 1684 // Initialize the variable here if it doesn't have a initializer and it is a 1685 // C struct that is non-trivial to initialize or an array containing such a 1686 // struct. 1687 if (!Init && 1688 type.isNonTrivialToPrimitiveDefaultInitialize() == 1689 QualType::PDIK_Struct) { 1690 LValue Dst = MakeAddrLValue(emission.getAllocatedAddress(), type); 1691 if (emission.IsEscapingByRef) 1692 drillIntoBlockVariable(*this, Dst, &D); 1693 defaultInitNonTrivialCStructVar(Dst); 1694 return; 1695 } 1696 1697 // Check whether this is a byref variable that's potentially 1698 // captured and moved by its own initializer. If so, we'll need to 1699 // emit the initializer first, then copy into the variable. 1700 bool capturedByInit = 1701 Init && emission.IsEscapingByRef && isCapturedBy(D, Init); 1702 1703 bool locIsByrefHeader = !capturedByInit; 1704 const Address Loc = 1705 locIsByrefHeader ? emission.getObjectAddress(*this) : emission.Addr; 1706 1707 // Note: constexpr already initializes everything correctly. 1708 LangOptions::TrivialAutoVarInitKind trivialAutoVarInit = 1709 (D.isConstexpr() 1710 ? LangOptions::TrivialAutoVarInitKind::Uninitialized 1711 : (D.getAttr<UninitializedAttr>() 1712 ? LangOptions::TrivialAutoVarInitKind::Uninitialized 1713 : getContext().getLangOpts().getTrivialAutoVarInit())); 1714 1715 auto initializeWhatIsTechnicallyUninitialized = [&](Address Loc) { 1716 if (trivialAutoVarInit == 1717 LangOptions::TrivialAutoVarInitKind::Uninitialized) 1718 return; 1719 1720 // Only initialize a __block's storage: we always initialize the header. 1721 if (emission.IsEscapingByRef && !locIsByrefHeader) 1722 Loc = emitBlockByrefAddress(Loc, &D, /*follow=*/false); 1723 1724 CharUnits Size = getContext().getTypeSizeInChars(type); 1725 if (!Size.isZero()) { 1726 switch (trivialAutoVarInit) { 1727 case LangOptions::TrivialAutoVarInitKind::Uninitialized: 1728 llvm_unreachable("Uninitialized handled above"); 1729 case LangOptions::TrivialAutoVarInitKind::Zero: 1730 emitStoresForZeroInit(CGM, D, Loc, isVolatile, Builder); 1731 break; 1732 case LangOptions::TrivialAutoVarInitKind::Pattern: 1733 emitStoresForPatternInit(CGM, D, Loc, isVolatile, Builder); 1734 break; 1735 } 1736 return; 1737 } 1738 1739 // VLAs look zero-sized to getTypeInfo. We can't emit constant stores to 1740 // them, so emit a memcpy with the VLA size to initialize each element. 1741 // Technically zero-sized or negative-sized VLAs are undefined, and UBSan 1742 // will catch that code, but there exists code which generates zero-sized 1743 // VLAs. Be nice and initialize whatever they requested. 1744 const auto *VlaType = getContext().getAsVariableArrayType(type); 1745 if (!VlaType) 1746 return; 1747 auto VlaSize = getVLASize(VlaType); 1748 auto SizeVal = VlaSize.NumElts; 1749 CharUnits EltSize = getContext().getTypeSizeInChars(VlaSize.Type); 1750 switch (trivialAutoVarInit) { 1751 case LangOptions::TrivialAutoVarInitKind::Uninitialized: 1752 llvm_unreachable("Uninitialized handled above"); 1753 1754 case LangOptions::TrivialAutoVarInitKind::Zero: 1755 if (!EltSize.isOne()) 1756 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize)); 1757 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal, 1758 isVolatile); 1759 break; 1760 1761 case LangOptions::TrivialAutoVarInitKind::Pattern: { 1762 llvm::Type *ElTy = Loc.getElementType(); 1763 llvm::Constant *Constant = constWithPadding( 1764 CGM, IsPattern::Yes, initializationPatternFor(CGM, ElTy)); 1765 CharUnits ConstantAlign = getContext().getTypeAlignInChars(VlaSize.Type); 1766 llvm::BasicBlock *SetupBB = createBasicBlock("vla-setup.loop"); 1767 llvm::BasicBlock *LoopBB = createBasicBlock("vla-init.loop"); 1768 llvm::BasicBlock *ContBB = createBasicBlock("vla-init.cont"); 1769 llvm::Value *IsZeroSizedVLA = Builder.CreateICmpEQ( 1770 SizeVal, llvm::ConstantInt::get(SizeVal->getType(), 0), 1771 "vla.iszerosized"); 1772 Builder.CreateCondBr(IsZeroSizedVLA, ContBB, SetupBB); 1773 EmitBlock(SetupBB); 1774 if (!EltSize.isOne()) 1775 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(EltSize)); 1776 llvm::Value *BaseSizeInChars = 1777 llvm::ConstantInt::get(IntPtrTy, EltSize.getQuantity()); 1778 Address Begin = Builder.CreateElementBitCast(Loc, Int8Ty, "vla.begin"); 1779 llvm::Value *End = 1780 Builder.CreateInBoundsGEP(Begin.getPointer(), SizeVal, "vla.end"); 1781 llvm::BasicBlock *OriginBB = Builder.GetInsertBlock(); 1782 EmitBlock(LoopBB); 1783 llvm::PHINode *Cur = Builder.CreatePHI(Begin.getType(), 2, "vla.cur"); 1784 Cur->addIncoming(Begin.getPointer(), OriginBB); 1785 CharUnits CurAlign = Loc.getAlignment().alignmentOfArrayElement(EltSize); 1786 Builder.CreateMemCpy(Address(Cur, CurAlign), 1787 createUnnamedGlobalForMemcpyFrom( 1788 CGM, D, Builder, Constant, ConstantAlign), 1789 BaseSizeInChars, isVolatile); 1790 llvm::Value *Next = 1791 Builder.CreateInBoundsGEP(Int8Ty, Cur, BaseSizeInChars, "vla.next"); 1792 llvm::Value *Done = Builder.CreateICmpEQ(Next, End, "vla-init.isdone"); 1793 Builder.CreateCondBr(Done, ContBB, LoopBB); 1794 Cur->addIncoming(Next, LoopBB); 1795 EmitBlock(ContBB); 1796 } break; 1797 } 1798 }; 1799 1800 if (isTrivialInitializer(Init)) { 1801 initializeWhatIsTechnicallyUninitialized(Loc); 1802 return; 1803 } 1804 1805 llvm::Constant *constant = nullptr; 1806 if (emission.IsConstantAggregate || 1807 D.mightBeUsableInConstantExpressions(getContext())) { 1808 assert(!capturedByInit && "constant init contains a capturing block?"); 1809 constant = ConstantEmitter(*this).tryEmitAbstractForInitializer(D); 1810 if (constant && !constant->isZeroValue() && 1811 (trivialAutoVarInit != 1812 LangOptions::TrivialAutoVarInitKind::Uninitialized)) { 1813 IsPattern isPattern = 1814 (trivialAutoVarInit == LangOptions::TrivialAutoVarInitKind::Pattern) 1815 ? IsPattern::Yes 1816 : IsPattern::No; 1817 // C guarantees that brace-init with fewer initializers than members in 1818 // the aggregate will initialize the rest of the aggregate as-if it were 1819 // static initialization. In turn static initialization guarantees that 1820 // padding is initialized to zero bits. We could instead pattern-init if D 1821 // has any ImplicitValueInitExpr, but that seems to be unintuitive 1822 // behavior. 1823 constant = constWithPadding(CGM, IsPattern::No, 1824 replaceUndef(CGM, isPattern, constant)); 1825 } 1826 } 1827 1828 if (!constant) { 1829 initializeWhatIsTechnicallyUninitialized(Loc); 1830 LValue lv = MakeAddrLValue(Loc, type); 1831 lv.setNonGC(true); 1832 return EmitExprAsInit(Init, &D, lv, capturedByInit); 1833 } 1834 1835 if (!emission.IsConstantAggregate) { 1836 // For simple scalar/complex initialization, store the value directly. 1837 LValue lv = MakeAddrLValue(Loc, type); 1838 lv.setNonGC(true); 1839 return EmitStoreThroughLValue(RValue::get(constant), lv, true); 1840 } 1841 1842 llvm::Type *BP = CGM.Int8Ty->getPointerTo(Loc.getAddressSpace()); 1843 emitStoresForConstant( 1844 CGM, D, (Loc.getType() == BP) ? Loc : Builder.CreateBitCast(Loc, BP), 1845 isVolatile, Builder, constant); 1846 } 1847 1848 /// Emit an expression as an initializer for an object (variable, field, etc.) 1849 /// at the given location. The expression is not necessarily the normal 1850 /// initializer for the object, and the address is not necessarily 1851 /// its normal location. 1852 /// 1853 /// \param init the initializing expression 1854 /// \param D the object to act as if we're initializing 1855 /// \param loc the address to initialize; its type is a pointer 1856 /// to the LLVM mapping of the object's type 1857 /// \param alignment the alignment of the address 1858 /// \param capturedByInit true if \p D is a __block variable 1859 /// whose address is potentially changed by the initializer 1860 void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D, 1861 LValue lvalue, bool capturedByInit) { 1862 QualType type = D->getType(); 1863 1864 if (type->isReferenceType()) { 1865 RValue rvalue = EmitReferenceBindingToExpr(init); 1866 if (capturedByInit) 1867 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D)); 1868 EmitStoreThroughLValue(rvalue, lvalue, true); 1869 return; 1870 } 1871 switch (getEvaluationKind(type)) { 1872 case TEK_Scalar: 1873 EmitScalarInit(init, D, lvalue, capturedByInit); 1874 return; 1875 case TEK_Complex: { 1876 ComplexPairTy complex = EmitComplexExpr(init); 1877 if (capturedByInit) 1878 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D)); 1879 EmitStoreOfComplex(complex, lvalue, /*init*/ true); 1880 return; 1881 } 1882 case TEK_Aggregate: 1883 if (type->isAtomicType()) { 1884 EmitAtomicInit(const_cast<Expr*>(init), lvalue); 1885 } else { 1886 AggValueSlot::Overlap_t Overlap = AggValueSlot::MayOverlap; 1887 if (isa<VarDecl>(D)) 1888 Overlap = AggValueSlot::DoesNotOverlap; 1889 else if (auto *FD = dyn_cast<FieldDecl>(D)) 1890 Overlap = overlapForFieldInit(FD); 1891 // TODO: how can we delay here if D is captured by its initializer? 1892 EmitAggExpr(init, AggValueSlot::forLValue(lvalue, 1893 AggValueSlot::IsDestructed, 1894 AggValueSlot::DoesNotNeedGCBarriers, 1895 AggValueSlot::IsNotAliased, 1896 Overlap)); 1897 } 1898 return; 1899 } 1900 llvm_unreachable("bad evaluation kind"); 1901 } 1902 1903 /// Enter a destroy cleanup for the given local variable. 1904 void CodeGenFunction::emitAutoVarTypeCleanup( 1905 const CodeGenFunction::AutoVarEmission &emission, 1906 QualType::DestructionKind dtorKind) { 1907 assert(dtorKind != QualType::DK_none); 1908 1909 // Note that for __block variables, we want to destroy the 1910 // original stack object, not the possibly forwarded object. 1911 Address addr = emission.getObjectAddress(*this); 1912 1913 const VarDecl *var = emission.Variable; 1914 QualType type = var->getType(); 1915 1916 CleanupKind cleanupKind = NormalAndEHCleanup; 1917 CodeGenFunction::Destroyer *destroyer = nullptr; 1918 1919 switch (dtorKind) { 1920 case QualType::DK_none: 1921 llvm_unreachable("no cleanup for trivially-destructible variable"); 1922 1923 case QualType::DK_cxx_destructor: 1924 // If there's an NRVO flag on the emission, we need a different 1925 // cleanup. 1926 if (emission.NRVOFlag) { 1927 assert(!type->isArrayType()); 1928 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor(); 1929 EHStack.pushCleanup<DestroyNRVOVariableCXX>(cleanupKind, addr, dtor, 1930 emission.NRVOFlag); 1931 return; 1932 } 1933 break; 1934 1935 case QualType::DK_objc_strong_lifetime: 1936 // Suppress cleanups for pseudo-strong variables. 1937 if (var->isARCPseudoStrong()) return; 1938 1939 // Otherwise, consider whether to use an EH cleanup or not. 1940 cleanupKind = getARCCleanupKind(); 1941 1942 // Use the imprecise destroyer by default. 1943 if (!var->hasAttr<ObjCPreciseLifetimeAttr>()) 1944 destroyer = CodeGenFunction::destroyARCStrongImprecise; 1945 break; 1946 1947 case QualType::DK_objc_weak_lifetime: 1948 break; 1949 1950 case QualType::DK_nontrivial_c_struct: 1951 destroyer = CodeGenFunction::destroyNonTrivialCStruct; 1952 if (emission.NRVOFlag) { 1953 assert(!type->isArrayType()); 1954 EHStack.pushCleanup<DestroyNRVOVariableC>(cleanupKind, addr, 1955 emission.NRVOFlag, type); 1956 return; 1957 } 1958 break; 1959 } 1960 1961 // If we haven't chosen a more specific destroyer, use the default. 1962 if (!destroyer) destroyer = getDestroyer(dtorKind); 1963 1964 // Use an EH cleanup in array destructors iff the destructor itself 1965 // is being pushed as an EH cleanup. 1966 bool useEHCleanup = (cleanupKind & EHCleanup); 1967 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer, 1968 useEHCleanup); 1969 } 1970 1971 void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) { 1972 assert(emission.Variable && "emission was not valid!"); 1973 1974 // If this was emitted as a global constant, we're done. 1975 if (emission.wasEmittedAsGlobal()) return; 1976 1977 // If we don't have an insertion point, we're done. Sema prevents 1978 // us from jumping into any of these scopes anyway. 1979 if (!HaveInsertPoint()) return; 1980 1981 const VarDecl &D = *emission.Variable; 1982 1983 // Check the type for a cleanup. 1984 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType()) 1985 emitAutoVarTypeCleanup(emission, dtorKind); 1986 1987 // In GC mode, honor objc_precise_lifetime. 1988 if (getLangOpts().getGC() != LangOptions::NonGC && 1989 D.hasAttr<ObjCPreciseLifetimeAttr>()) { 1990 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D); 1991 } 1992 1993 // Handle the cleanup attribute. 1994 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) { 1995 const FunctionDecl *FD = CA->getFunctionDecl(); 1996 1997 llvm::Constant *F = CGM.GetAddrOfFunction(FD); 1998 assert(F && "Could not find function!"); 1999 2000 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD); 2001 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D); 2002 } 2003 2004 // If this is a block variable, call _Block_object_destroy 2005 // (on the unforwarded address). Don't enter this cleanup if we're in pure-GC 2006 // mode. 2007 if (emission.IsEscapingByRef && 2008 CGM.getLangOpts().getGC() != LangOptions::GCOnly) { 2009 BlockFieldFlags Flags = BLOCK_FIELD_IS_BYREF; 2010 if (emission.Variable->getType().isObjCGCWeak()) 2011 Flags |= BLOCK_FIELD_IS_WEAK; 2012 enterByrefCleanup(NormalAndEHCleanup, emission.Addr, Flags, 2013 /*LoadBlockVarAddr*/ false, 2014 cxxDestructorCanThrow(emission.Variable->getType())); 2015 } 2016 } 2017 2018 CodeGenFunction::Destroyer * 2019 CodeGenFunction::getDestroyer(QualType::DestructionKind kind) { 2020 switch (kind) { 2021 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor"); 2022 case QualType::DK_cxx_destructor: 2023 return destroyCXXObject; 2024 case QualType::DK_objc_strong_lifetime: 2025 return destroyARCStrongPrecise; 2026 case QualType::DK_objc_weak_lifetime: 2027 return destroyARCWeak; 2028 case QualType::DK_nontrivial_c_struct: 2029 return destroyNonTrivialCStruct; 2030 } 2031 llvm_unreachable("Unknown DestructionKind"); 2032 } 2033 2034 /// pushEHDestroy - Push the standard destructor for the given type as 2035 /// an EH-only cleanup. 2036 void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind, 2037 Address addr, QualType type) { 2038 assert(dtorKind && "cannot push destructor for trivial type"); 2039 assert(needsEHCleanup(dtorKind)); 2040 2041 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true); 2042 } 2043 2044 /// pushDestroy - Push the standard destructor for the given type as 2045 /// at least a normal cleanup. 2046 void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind, 2047 Address addr, QualType type) { 2048 assert(dtorKind && "cannot push destructor for trivial type"); 2049 2050 CleanupKind cleanupKind = getCleanupKind(dtorKind); 2051 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind), 2052 cleanupKind & EHCleanup); 2053 } 2054 2055 void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr, 2056 QualType type, Destroyer *destroyer, 2057 bool useEHCleanupForArray) { 2058 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type, 2059 destroyer, useEHCleanupForArray); 2060 } 2061 2062 void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) { 2063 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem); 2064 } 2065 2066 void CodeGenFunction::pushLifetimeExtendedDestroy( 2067 CleanupKind cleanupKind, Address addr, QualType type, 2068 Destroyer *destroyer, bool useEHCleanupForArray) { 2069 // Push an EH-only cleanup for the object now. 2070 // FIXME: When popping normal cleanups, we need to keep this EH cleanup 2071 // around in case a temporary's destructor throws an exception. 2072 if (cleanupKind & EHCleanup) 2073 EHStack.pushCleanup<DestroyObject>( 2074 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type, 2075 destroyer, useEHCleanupForArray); 2076 2077 // Remember that we need to push a full cleanup for the object at the 2078 // end of the full-expression. 2079 pushCleanupAfterFullExpr<DestroyObject>( 2080 cleanupKind, addr, type, destroyer, useEHCleanupForArray); 2081 } 2082 2083 /// emitDestroy - Immediately perform the destruction of the given 2084 /// object. 2085 /// 2086 /// \param addr - the address of the object; a type* 2087 /// \param type - the type of the object; if an array type, all 2088 /// objects are destroyed in reverse order 2089 /// \param destroyer - the function to call to destroy individual 2090 /// elements 2091 /// \param useEHCleanupForArray - whether an EH cleanup should be 2092 /// used when destroying array elements, in case one of the 2093 /// destructions throws an exception 2094 void CodeGenFunction::emitDestroy(Address addr, QualType type, 2095 Destroyer *destroyer, 2096 bool useEHCleanupForArray) { 2097 const ArrayType *arrayType = getContext().getAsArrayType(type); 2098 if (!arrayType) 2099 return destroyer(*this, addr, type); 2100 2101 llvm::Value *length = emitArrayLength(arrayType, type, addr); 2102 2103 CharUnits elementAlign = 2104 addr.getAlignment() 2105 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type)); 2106 2107 // Normally we have to check whether the array is zero-length. 2108 bool checkZeroLength = true; 2109 2110 // But if the array length is constant, we can suppress that. 2111 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) { 2112 // ...and if it's constant zero, we can just skip the entire thing. 2113 if (constLength->isZero()) return; 2114 checkZeroLength = false; 2115 } 2116 2117 llvm::Value *begin = addr.getPointer(); 2118 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length); 2119 emitArrayDestroy(begin, end, type, elementAlign, destroyer, 2120 checkZeroLength, useEHCleanupForArray); 2121 } 2122 2123 /// emitArrayDestroy - Destroys all the elements of the given array, 2124 /// beginning from last to first. The array cannot be zero-length. 2125 /// 2126 /// \param begin - a type* denoting the first element of the array 2127 /// \param end - a type* denoting one past the end of the array 2128 /// \param elementType - the element type of the array 2129 /// \param destroyer - the function to call to destroy elements 2130 /// \param useEHCleanup - whether to push an EH cleanup to destroy 2131 /// the remaining elements in case the destruction of a single 2132 /// element throws 2133 void CodeGenFunction::emitArrayDestroy(llvm::Value *begin, 2134 llvm::Value *end, 2135 QualType elementType, 2136 CharUnits elementAlign, 2137 Destroyer *destroyer, 2138 bool checkZeroLength, 2139 bool useEHCleanup) { 2140 assert(!elementType->isArrayType()); 2141 2142 // The basic structure here is a do-while loop, because we don't 2143 // need to check for the zero-element case. 2144 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body"); 2145 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done"); 2146 2147 if (checkZeroLength) { 2148 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end, 2149 "arraydestroy.isempty"); 2150 Builder.CreateCondBr(isEmpty, doneBB, bodyBB); 2151 } 2152 2153 // Enter the loop body, making that address the current address. 2154 llvm::BasicBlock *entryBB = Builder.GetInsertBlock(); 2155 EmitBlock(bodyBB); 2156 llvm::PHINode *elementPast = 2157 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast"); 2158 elementPast->addIncoming(end, entryBB); 2159 2160 // Shift the address back by one element. 2161 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true); 2162 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne, 2163 "arraydestroy.element"); 2164 2165 if (useEHCleanup) 2166 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign, 2167 destroyer); 2168 2169 // Perform the actual destruction there. 2170 destroyer(*this, Address(element, elementAlign), elementType); 2171 2172 if (useEHCleanup) 2173 PopCleanupBlock(); 2174 2175 // Check whether we've reached the end. 2176 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done"); 2177 Builder.CreateCondBr(done, doneBB, bodyBB); 2178 elementPast->addIncoming(element, Builder.GetInsertBlock()); 2179 2180 // Done. 2181 EmitBlock(doneBB); 2182 } 2183 2184 /// Perform partial array destruction as if in an EH cleanup. Unlike 2185 /// emitArrayDestroy, the element type here may still be an array type. 2186 static void emitPartialArrayDestroy(CodeGenFunction &CGF, 2187 llvm::Value *begin, llvm::Value *end, 2188 QualType type, CharUnits elementAlign, 2189 CodeGenFunction::Destroyer *destroyer) { 2190 // If the element type is itself an array, drill down. 2191 unsigned arrayDepth = 0; 2192 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) { 2193 // VLAs don't require a GEP index to walk into. 2194 if (!isa<VariableArrayType>(arrayType)) 2195 arrayDepth++; 2196 type = arrayType->getElementType(); 2197 } 2198 2199 if (arrayDepth) { 2200 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0); 2201 2202 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero); 2203 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin"); 2204 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend"); 2205 } 2206 2207 // Destroy the array. We don't ever need an EH cleanup because we 2208 // assume that we're in an EH cleanup ourselves, so a throwing 2209 // destructor causes an immediate terminate. 2210 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer, 2211 /*checkZeroLength*/ true, /*useEHCleanup*/ false); 2212 } 2213 2214 namespace { 2215 /// RegularPartialArrayDestroy - a cleanup which performs a partial 2216 /// array destroy where the end pointer is regularly determined and 2217 /// does not need to be loaded from a local. 2218 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup { 2219 llvm::Value *ArrayBegin; 2220 llvm::Value *ArrayEnd; 2221 QualType ElementType; 2222 CodeGenFunction::Destroyer *Destroyer; 2223 CharUnits ElementAlign; 2224 public: 2225 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd, 2226 QualType elementType, CharUnits elementAlign, 2227 CodeGenFunction::Destroyer *destroyer) 2228 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd), 2229 ElementType(elementType), Destroyer(destroyer), 2230 ElementAlign(elementAlign) {} 2231 2232 void Emit(CodeGenFunction &CGF, Flags flags) override { 2233 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd, 2234 ElementType, ElementAlign, Destroyer); 2235 } 2236 }; 2237 2238 /// IrregularPartialArrayDestroy - a cleanup which performs a 2239 /// partial array destroy where the end pointer is irregularly 2240 /// determined and must be loaded from a local. 2241 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup { 2242 llvm::Value *ArrayBegin; 2243 Address ArrayEndPointer; 2244 QualType ElementType; 2245 CodeGenFunction::Destroyer *Destroyer; 2246 CharUnits ElementAlign; 2247 public: 2248 IrregularPartialArrayDestroy(llvm::Value *arrayBegin, 2249 Address arrayEndPointer, 2250 QualType elementType, 2251 CharUnits elementAlign, 2252 CodeGenFunction::Destroyer *destroyer) 2253 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer), 2254 ElementType(elementType), Destroyer(destroyer), 2255 ElementAlign(elementAlign) {} 2256 2257 void Emit(CodeGenFunction &CGF, Flags flags) override { 2258 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer); 2259 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd, 2260 ElementType, ElementAlign, Destroyer); 2261 } 2262 }; 2263 } // end anonymous namespace 2264 2265 /// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy 2266 /// already-constructed elements of the given array. The cleanup 2267 /// may be popped with DeactivateCleanupBlock or PopCleanupBlock. 2268 /// 2269 /// \param elementType - the immediate element type of the array; 2270 /// possibly still an array type 2271 void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin, 2272 Address arrayEndPointer, 2273 QualType elementType, 2274 CharUnits elementAlign, 2275 Destroyer *destroyer) { 2276 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup, 2277 arrayBegin, arrayEndPointer, 2278 elementType, elementAlign, 2279 destroyer); 2280 } 2281 2282 /// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy 2283 /// already-constructed elements of the given array. The cleanup 2284 /// may be popped with DeactivateCleanupBlock or PopCleanupBlock. 2285 /// 2286 /// \param elementType - the immediate element type of the array; 2287 /// possibly still an array type 2288 void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin, 2289 llvm::Value *arrayEnd, 2290 QualType elementType, 2291 CharUnits elementAlign, 2292 Destroyer *destroyer) { 2293 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup, 2294 arrayBegin, arrayEnd, 2295 elementType, elementAlign, 2296 destroyer); 2297 } 2298 2299 /// Lazily declare the @llvm.lifetime.start intrinsic. 2300 llvm::Function *CodeGenModule::getLLVMLifetimeStartFn() { 2301 if (LifetimeStartFn) 2302 return LifetimeStartFn; 2303 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(), 2304 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy); 2305 return LifetimeStartFn; 2306 } 2307 2308 /// Lazily declare the @llvm.lifetime.end intrinsic. 2309 llvm::Function *CodeGenModule::getLLVMLifetimeEndFn() { 2310 if (LifetimeEndFn) 2311 return LifetimeEndFn; 2312 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(), 2313 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy); 2314 return LifetimeEndFn; 2315 } 2316 2317 namespace { 2318 /// A cleanup to perform a release of an object at the end of a 2319 /// function. This is used to balance out the incoming +1 of a 2320 /// ns_consumed argument when we can't reasonably do that just by 2321 /// not doing the initial retain for a __block argument. 2322 struct ConsumeARCParameter final : EHScopeStack::Cleanup { 2323 ConsumeARCParameter(llvm::Value *param, 2324 ARCPreciseLifetime_t precise) 2325 : Param(param), Precise(precise) {} 2326 2327 llvm::Value *Param; 2328 ARCPreciseLifetime_t Precise; 2329 2330 void Emit(CodeGenFunction &CGF, Flags flags) override { 2331 CGF.EmitARCRelease(Param, Precise); 2332 } 2333 }; 2334 } // end anonymous namespace 2335 2336 /// Emit an alloca (or GlobalValue depending on target) 2337 /// for the specified parameter and set up LocalDeclMap. 2338 void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg, 2339 unsigned ArgNo) { 2340 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl? 2341 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) && 2342 "Invalid argument to EmitParmDecl"); 2343 2344 Arg.getAnyValue()->setName(D.getName()); 2345 2346 QualType Ty = D.getType(); 2347 2348 // Use better IR generation for certain implicit parameters. 2349 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) { 2350 // The only implicit argument a block has is its literal. 2351 // This may be passed as an inalloca'ed value on Windows x86. 2352 if (BlockInfo) { 2353 llvm::Value *V = Arg.isIndirect() 2354 ? Builder.CreateLoad(Arg.getIndirectAddress()) 2355 : Arg.getDirectValue(); 2356 setBlockContextParameter(IPD, ArgNo, V); 2357 return; 2358 } 2359 } 2360 2361 Address DeclPtr = Address::invalid(); 2362 bool DoStore = false; 2363 bool IsScalar = hasScalarEvaluationKind(Ty); 2364 // If we already have a pointer to the argument, reuse the input pointer. 2365 if (Arg.isIndirect()) { 2366 DeclPtr = Arg.getIndirectAddress(); 2367 // If we have a prettier pointer type at this point, bitcast to that. 2368 unsigned AS = DeclPtr.getType()->getAddressSpace(); 2369 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS); 2370 if (DeclPtr.getType() != IRTy) 2371 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName()); 2372 // Indirect argument is in alloca address space, which may be different 2373 // from the default address space. 2374 auto AllocaAS = CGM.getASTAllocaAddressSpace(); 2375 auto *V = DeclPtr.getPointer(); 2376 auto SrcLangAS = getLangOpts().OpenCL ? LangAS::opencl_private : AllocaAS; 2377 auto DestLangAS = 2378 getLangOpts().OpenCL ? LangAS::opencl_private : LangAS::Default; 2379 if (SrcLangAS != DestLangAS) { 2380 assert(getContext().getTargetAddressSpace(SrcLangAS) == 2381 CGM.getDataLayout().getAllocaAddrSpace()); 2382 auto DestAS = getContext().getTargetAddressSpace(DestLangAS); 2383 auto *T = V->getType()->getPointerElementType()->getPointerTo(DestAS); 2384 DeclPtr = Address(getTargetHooks().performAddrSpaceCast( 2385 *this, V, SrcLangAS, DestLangAS, T, true), 2386 DeclPtr.getAlignment()); 2387 } 2388 2389 // Push a destructor cleanup for this parameter if the ABI requires it. 2390 // Don't push a cleanup in a thunk for a method that will also emit a 2391 // cleanup. 2392 if (hasAggregateEvaluationKind(Ty) && !CurFuncIsThunk && 2393 Ty->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) { 2394 if (QualType::DestructionKind DtorKind = Ty.isDestructedType()) { 2395 assert((DtorKind == QualType::DK_cxx_destructor || 2396 DtorKind == QualType::DK_nontrivial_c_struct) && 2397 "unexpected destructor type"); 2398 pushDestroy(DtorKind, DeclPtr, Ty); 2399 CalleeDestructedParamCleanups[cast<ParmVarDecl>(&D)] = 2400 EHStack.stable_begin(); 2401 } 2402 } 2403 } else { 2404 // Check if the parameter address is controlled by OpenMP runtime. 2405 Address OpenMPLocalAddr = 2406 getLangOpts().OpenMP 2407 ? CGM.getOpenMPRuntime().getAddressOfLocalVariable(*this, &D) 2408 : Address::invalid(); 2409 if (getLangOpts().OpenMP && OpenMPLocalAddr.isValid()) { 2410 DeclPtr = OpenMPLocalAddr; 2411 } else { 2412 // Otherwise, create a temporary to hold the value. 2413 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D), 2414 D.getName() + ".addr"); 2415 } 2416 DoStore = true; 2417 } 2418 2419 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr); 2420 2421 LValue lv = MakeAddrLValue(DeclPtr, Ty); 2422 if (IsScalar) { 2423 Qualifiers qs = Ty.getQualifiers(); 2424 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) { 2425 // We honor __attribute__((ns_consumed)) for types with lifetime. 2426 // For __strong, it's handled by just skipping the initial retain; 2427 // otherwise we have to balance out the initial +1 with an extra 2428 // cleanup to do the release at the end of the function. 2429 bool isConsumed = D.hasAttr<NSConsumedAttr>(); 2430 2431 // If a parameter is pseudo-strong then we can omit the implicit retain. 2432 if (D.isARCPseudoStrong()) { 2433 assert(lt == Qualifiers::OCL_Strong && 2434 "pseudo-strong variable isn't strong?"); 2435 assert(qs.hasConst() && "pseudo-strong variable should be const!"); 2436 lt = Qualifiers::OCL_ExplicitNone; 2437 } 2438 2439 // Load objects passed indirectly. 2440 if (Arg.isIndirect() && !ArgVal) 2441 ArgVal = Builder.CreateLoad(DeclPtr); 2442 2443 if (lt == Qualifiers::OCL_Strong) { 2444 if (!isConsumed) { 2445 if (CGM.getCodeGenOpts().OptimizationLevel == 0) { 2446 // use objc_storeStrong(&dest, value) for retaining the 2447 // object. But first, store a null into 'dest' because 2448 // objc_storeStrong attempts to release its old value. 2449 llvm::Value *Null = CGM.EmitNullConstant(D.getType()); 2450 EmitStoreOfScalar(Null, lv, /* isInitialization */ true); 2451 EmitARCStoreStrongCall(lv.getAddress(), ArgVal, true); 2452 DoStore = false; 2453 } 2454 else 2455 // Don't use objc_retainBlock for block pointers, because we 2456 // don't want to Block_copy something just because we got it 2457 // as a parameter. 2458 ArgVal = EmitARCRetainNonBlock(ArgVal); 2459 } 2460 } else { 2461 // Push the cleanup for a consumed parameter. 2462 if (isConsumed) { 2463 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>() 2464 ? ARCPreciseLifetime : ARCImpreciseLifetime); 2465 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal, 2466 precise); 2467 } 2468 2469 if (lt == Qualifiers::OCL_Weak) { 2470 EmitARCInitWeak(DeclPtr, ArgVal); 2471 DoStore = false; // The weak init is a store, no need to do two. 2472 } 2473 } 2474 2475 // Enter the cleanup scope. 2476 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt); 2477 } 2478 } 2479 2480 // Store the initial value into the alloca. 2481 if (DoStore) 2482 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true); 2483 2484 setAddrOfLocalVar(&D, DeclPtr); 2485 2486 // Emit debug info for param declaration. 2487 if (CGDebugInfo *DI = getDebugInfo()) { 2488 if (CGM.getCodeGenOpts().getDebugInfo() >= 2489 codegenoptions::LimitedDebugInfo) { 2490 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder); 2491 } 2492 } 2493 2494 if (D.hasAttr<AnnotateAttr>()) 2495 EmitVarAnnotations(&D, DeclPtr.getPointer()); 2496 2497 // We can only check return value nullability if all arguments to the 2498 // function satisfy their nullability preconditions. This makes it necessary 2499 // to emit null checks for args in the function body itself. 2500 if (requiresReturnValueNullabilityCheck()) { 2501 auto Nullability = Ty->getNullability(getContext()); 2502 if (Nullability && *Nullability == NullabilityKind::NonNull) { 2503 SanitizerScope SanScope(this); 2504 RetValNullabilityPrecondition = 2505 Builder.CreateAnd(RetValNullabilityPrecondition, 2506 Builder.CreateIsNotNull(Arg.getAnyValue())); 2507 } 2508 } 2509 } 2510 2511 void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D, 2512 CodeGenFunction *CGF) { 2513 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed())) 2514 return; 2515 getOpenMPRuntime().emitUserDefinedReduction(CGF, D); 2516 } 2517 2518 void CodeGenModule::EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D, 2519 CodeGenFunction *CGF) { 2520 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed())) 2521 return; 2522 // FIXME: need to implement mapper code generation 2523 } 2524 2525 void CodeGenModule::EmitOMPRequiresDecl(const OMPRequiresDecl *D) { 2526 getOpenMPRuntime().checkArchForUnifiedAddressing(D); 2527 } 2528