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