1 //===--- CGDecl.cpp - Emit LLVM Code for declarations ---------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This contains code to emit Decl nodes as LLVM code. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "CGBlocks.h" 15 #include "CGCXXABI.h" 16 #include "CGCleanup.h" 17 #include "CGDebugInfo.h" 18 #include "CGOpenCLRuntime.h" 19 #include "CGOpenMPRuntime.h" 20 #include "CodeGenFunction.h" 21 #include "CodeGenModule.h" 22 #include "ConstantEmitter.h" 23 #include "TargetInfo.h" 24 #include "clang/AST/ASTContext.h" 25 #include "clang/AST/CharUnits.h" 26 #include "clang/AST/Decl.h" 27 #include "clang/AST/DeclObjC.h" 28 #include "clang/AST/DeclOpenMP.h" 29 #include "clang/Basic/SourceManager.h" 30 #include "clang/Basic/TargetInfo.h" 31 #include "clang/CodeGen/CGFunctionInfo.h" 32 #include "clang/Frontend/CodeGenOptions.h" 33 #include "llvm/IR/DataLayout.h" 34 #include "llvm/IR/GlobalVariable.h" 35 #include "llvm/IR/Intrinsics.h" 36 #include "llvm/IR/Type.h" 37 38 using namespace clang; 39 using namespace CodeGen; 40 41 void CodeGenFunction::EmitDecl(const Decl &D) { 42 switch (D.getKind()) { 43 case Decl::BuiltinTemplate: 44 case Decl::TranslationUnit: 45 case Decl::ExternCContext: 46 case Decl::Namespace: 47 case Decl::UnresolvedUsingTypename: 48 case Decl::ClassTemplateSpecialization: 49 case Decl::ClassTemplatePartialSpecialization: 50 case Decl::VarTemplateSpecialization: 51 case Decl::VarTemplatePartialSpecialization: 52 case Decl::TemplateTypeParm: 53 case Decl::UnresolvedUsingValue: 54 case Decl::NonTypeTemplateParm: 55 case Decl::CXXDeductionGuide: 56 case Decl::CXXMethod: 57 case Decl::CXXConstructor: 58 case Decl::CXXDestructor: 59 case Decl::CXXConversion: 60 case Decl::Field: 61 case Decl::MSProperty: 62 case Decl::IndirectField: 63 case Decl::ObjCIvar: 64 case Decl::ObjCAtDefsField: 65 case Decl::ParmVar: 66 case Decl::ImplicitParam: 67 case Decl::ClassTemplate: 68 case Decl::VarTemplate: 69 case Decl::FunctionTemplate: 70 case Decl::TypeAliasTemplate: 71 case Decl::TemplateTemplateParm: 72 case Decl::ObjCMethod: 73 case Decl::ObjCCategory: 74 case Decl::ObjCProtocol: 75 case Decl::ObjCInterface: 76 case Decl::ObjCCategoryImpl: 77 case Decl::ObjCImplementation: 78 case Decl::ObjCProperty: 79 case Decl::ObjCCompatibleAlias: 80 case Decl::PragmaComment: 81 case Decl::PragmaDetectMismatch: 82 case Decl::AccessSpec: 83 case Decl::LinkageSpec: 84 case Decl::Export: 85 case Decl::ObjCPropertyImpl: 86 case Decl::FileScopeAsm: 87 case Decl::Friend: 88 case Decl::FriendTemplate: 89 case Decl::Block: 90 case Decl::Captured: 91 case Decl::ClassScopeFunctionSpecialization: 92 case Decl::UsingShadow: 93 case Decl::ConstructorUsingShadow: 94 case Decl::ObjCTypeParam: 95 case Decl::Binding: 96 llvm_unreachable("Declaration should not be in declstmts!"); 97 case Decl::Function: // void X(); 98 case Decl::Record: // struct/union/class X; 99 case Decl::Enum: // enum X; 100 case Decl::EnumConstant: // enum ? { X = ? } 101 case Decl::CXXRecord: // struct/union/class X; [C++] 102 case Decl::StaticAssert: // static_assert(X, ""); [C++0x] 103 case Decl::Label: // __label__ x; 104 case Decl::Import: 105 case Decl::OMPThreadPrivate: 106 case Decl::OMPCapturedExpr: 107 case Decl::Empty: 108 // None of these decls require codegen support. 109 return; 110 111 case Decl::NamespaceAlias: 112 if (CGDebugInfo *DI = getDebugInfo()) 113 DI->EmitNamespaceAlias(cast<NamespaceAliasDecl>(D)); 114 return; 115 case Decl::Using: // using X; [C++] 116 if (CGDebugInfo *DI = getDebugInfo()) 117 DI->EmitUsingDecl(cast<UsingDecl>(D)); 118 return; 119 case Decl::UsingPack: 120 for (auto *Using : cast<UsingPackDecl>(D).expansions()) 121 EmitDecl(*Using); 122 return; 123 case Decl::UsingDirective: // using namespace X; [C++] 124 if (CGDebugInfo *DI = getDebugInfo()) 125 DI->EmitUsingDirective(cast<UsingDirectiveDecl>(D)); 126 return; 127 case Decl::Var: 128 case Decl::Decomposition: { 129 const VarDecl &VD = cast<VarDecl>(D); 130 assert(VD.isLocalVarDecl() && 131 "Should not see file-scope variables inside a function!"); 132 EmitVarDecl(VD); 133 if (auto *DD = dyn_cast<DecompositionDecl>(&VD)) 134 for (auto *B : DD->bindings()) 135 if (auto *HD = B->getHoldingVar()) 136 EmitVarDecl(*HD); 137 return; 138 } 139 140 case Decl::OMPDeclareReduction: 141 return CGM.EmitOMPDeclareReduction(cast<OMPDeclareReductionDecl>(&D), this); 142 143 case Decl::Typedef: // typedef int X; 144 case Decl::TypeAlias: { // using X = int; [C++0x] 145 const TypedefNameDecl &TD = cast<TypedefNameDecl>(D); 146 QualType Ty = TD.getUnderlyingType(); 147 148 if (Ty->isVariablyModifiedType()) 149 EmitVariablyModifiedType(Ty); 150 } 151 } 152 } 153 154 /// EmitVarDecl - This method handles emission of any variable declaration 155 /// inside a function, including static vars etc. 156 void CodeGenFunction::EmitVarDecl(const VarDecl &D) { 157 if (D.hasExternalStorage()) 158 // Don't emit it now, allow it to be emitted lazily on its first use. 159 return; 160 161 // Some function-scope variable does not have static storage but still 162 // needs to be emitted like a static variable, e.g. a function-scope 163 // variable in constant address space in OpenCL. 164 if (D.getStorageDuration() != SD_Automatic) { 165 // Static sampler variables translated to function calls. 166 if (D.getType()->isSamplerT()) 167 return; 168 169 llvm::GlobalValue::LinkageTypes Linkage = 170 CGM.getLLVMLinkageVarDefinition(&D, /*isConstant=*/false); 171 172 // FIXME: We need to force the emission/use of a guard variable for 173 // some variables even if we can constant-evaluate them because 174 // we can't guarantee every translation unit will constant-evaluate them. 175 176 return EmitStaticVarDecl(D, Linkage); 177 } 178 179 if (D.getType().getAddressSpace() == LangAS::opencl_local) 180 return CGM.getOpenCLRuntime().EmitWorkGroupLocalVarDecl(*this, D); 181 182 assert(D.hasLocalStorage()); 183 return EmitAutoVarDecl(D); 184 } 185 186 static std::string getStaticDeclName(CodeGenModule &CGM, const VarDecl &D) { 187 if (CGM.getLangOpts().CPlusPlus) 188 return CGM.getMangledName(&D).str(); 189 190 // If this isn't C++, we don't need a mangled name, just a pretty one. 191 assert(!D.isExternallyVisible() && "name shouldn't matter"); 192 std::string ContextName; 193 const DeclContext *DC = D.getDeclContext(); 194 if (auto *CD = dyn_cast<CapturedDecl>(DC)) 195 DC = cast<DeclContext>(CD->getNonClosureContext()); 196 if (const auto *FD = dyn_cast<FunctionDecl>(DC)) 197 ContextName = CGM.getMangledName(FD); 198 else if (const auto *BD = dyn_cast<BlockDecl>(DC)) 199 ContextName = CGM.getBlockMangledName(GlobalDecl(), BD); 200 else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(DC)) 201 ContextName = OMD->getSelector().getAsString(); 202 else 203 llvm_unreachable("Unknown context for static var decl"); 204 205 ContextName += "." + D.getNameAsString(); 206 return ContextName; 207 } 208 209 llvm::Constant *CodeGenModule::getOrCreateStaticVarDecl( 210 const VarDecl &D, llvm::GlobalValue::LinkageTypes Linkage) { 211 // In general, we don't always emit static var decls once before we reference 212 // them. It is possible to reference them before emitting the function that 213 // contains them, and it is possible to emit the containing function multiple 214 // times. 215 if (llvm::Constant *ExistingGV = StaticLocalDeclMap[&D]) 216 return ExistingGV; 217 218 QualType Ty = D.getType(); 219 assert(Ty->isConstantSizeType() && "VLAs can't be static"); 220 221 // Use the label if the variable is renamed with the asm-label extension. 222 std::string Name; 223 if (D.hasAttr<AsmLabelAttr>()) 224 Name = getMangledName(&D); 225 else 226 Name = getStaticDeclName(*this, D); 227 228 llvm::Type *LTy = getTypes().ConvertTypeForMem(Ty); 229 LangAS AS = GetGlobalVarAddressSpace(&D); 230 unsigned TargetAS = getContext().getTargetAddressSpace(AS); 231 232 // Local address space cannot have an initializer. 233 llvm::Constant *Init = nullptr; 234 if (Ty.getAddressSpace() != LangAS::opencl_local) 235 Init = EmitNullConstant(Ty); 236 else 237 Init = llvm::UndefValue::get(LTy); 238 239 llvm::GlobalVariable *GV = new llvm::GlobalVariable( 240 getModule(), LTy, Ty.isConstant(getContext()), Linkage, Init, Name, 241 nullptr, llvm::GlobalVariable::NotThreadLocal, TargetAS); 242 GV->setAlignment(getContext().getDeclAlign(&D).getQuantity()); 243 setGlobalVisibility(GV, &D, ForDefinition); 244 245 if (supportsCOMDAT() && GV->isWeakForLinker()) 246 GV->setComdat(TheModule.getOrInsertComdat(GV->getName())); 247 248 if (D.getTLSKind()) 249 setTLSMode(GV, D); 250 251 if (D.isExternallyVisible()) { 252 if (D.hasAttr<DLLImportAttr>()) 253 GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass); 254 else if (D.hasAttr<DLLExportAttr>()) 255 GV->setDLLStorageClass(llvm::GlobalVariable::DLLExportStorageClass); 256 } 257 258 // Make sure the result is of the correct type. 259 LangAS ExpectedAS = Ty.getAddressSpace(); 260 llvm::Constant *Addr = GV; 261 if (AS != ExpectedAS) { 262 Addr = getTargetCodeGenInfo().performAddrSpaceCast( 263 *this, GV, AS, ExpectedAS, 264 LTy->getPointerTo(getContext().getTargetAddressSpace(ExpectedAS))); 265 } 266 267 setStaticLocalDeclAddress(&D, Addr); 268 269 // Ensure that the static local gets initialized by making sure the parent 270 // function gets emitted eventually. 271 const Decl *DC = cast<Decl>(D.getDeclContext()); 272 273 // We can't name blocks or captured statements directly, so try to emit their 274 // parents. 275 if (isa<BlockDecl>(DC) || isa<CapturedDecl>(DC)) { 276 DC = DC->getNonClosureContext(); 277 // FIXME: Ensure that global blocks get emitted. 278 if (!DC) 279 return Addr; 280 } 281 282 GlobalDecl GD; 283 if (const auto *CD = dyn_cast<CXXConstructorDecl>(DC)) 284 GD = GlobalDecl(CD, Ctor_Base); 285 else if (const auto *DD = dyn_cast<CXXDestructorDecl>(DC)) 286 GD = GlobalDecl(DD, Dtor_Base); 287 else if (const auto *FD = dyn_cast<FunctionDecl>(DC)) 288 GD = GlobalDecl(FD); 289 else { 290 // Don't do anything for Obj-C method decls or global closures. We should 291 // never defer them. 292 assert(isa<ObjCMethodDecl>(DC) && "unexpected parent code decl"); 293 } 294 if (GD.getDecl()) 295 (void)GetAddrOfGlobal(GD); 296 297 return Addr; 298 } 299 300 /// hasNontrivialDestruction - Determine whether a type's destruction is 301 /// non-trivial. If so, and the variable uses static initialization, we must 302 /// register its destructor to run on exit. 303 static bool hasNontrivialDestruction(QualType T) { 304 CXXRecordDecl *RD = T->getBaseElementTypeUnsafe()->getAsCXXRecordDecl(); 305 return RD && !RD->hasTrivialDestructor(); 306 } 307 308 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the 309 /// global variable that has already been created for it. If the initializer 310 /// has a different type than GV does, this may free GV and return a different 311 /// one. Otherwise it just returns GV. 312 llvm::GlobalVariable * 313 CodeGenFunction::AddInitializerToStaticVarDecl(const VarDecl &D, 314 llvm::GlobalVariable *GV) { 315 ConstantEmitter emitter(*this); 316 llvm::Constant *Init = emitter.tryEmitForInitializer(D); 317 318 // If constant emission failed, then this should be a C++ static 319 // initializer. 320 if (!Init) { 321 if (!getLangOpts().CPlusPlus) 322 CGM.ErrorUnsupported(D.getInit(), "constant l-value expression"); 323 else if (HaveInsertPoint()) { 324 // Since we have a static initializer, this global variable can't 325 // be constant. 326 GV->setConstant(false); 327 328 EmitCXXGuardedInit(D, GV, /*PerformInit*/true); 329 } 330 return GV; 331 } 332 333 // The initializer may differ in type from the global. Rewrite 334 // the global to match the initializer. (We have to do this 335 // because some types, like unions, can't be completely represented 336 // in the LLVM type system.) 337 if (GV->getType()->getElementType() != Init->getType()) { 338 llvm::GlobalVariable *OldGV = GV; 339 340 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), 341 OldGV->isConstant(), 342 OldGV->getLinkage(), Init, "", 343 /*InsertBefore*/ OldGV, 344 OldGV->getThreadLocalMode(), 345 CGM.getContext().getTargetAddressSpace(D.getType())); 346 GV->setVisibility(OldGV->getVisibility()); 347 GV->setComdat(OldGV->getComdat()); 348 349 // Steal the name of the old global 350 GV->takeName(OldGV); 351 352 // Replace all uses of the old global with the new global 353 llvm::Constant *NewPtrForOldDecl = 354 llvm::ConstantExpr::getBitCast(GV, OldGV->getType()); 355 OldGV->replaceAllUsesWith(NewPtrForOldDecl); 356 357 // Erase the old global, since it is no longer used. 358 OldGV->eraseFromParent(); 359 } 360 361 GV->setConstant(CGM.isTypeConstant(D.getType(), true)); 362 GV->setInitializer(Init); 363 364 emitter.finalize(GV); 365 366 if (hasNontrivialDestruction(D.getType()) && HaveInsertPoint()) { 367 // We have a constant initializer, but a nontrivial destructor. We still 368 // need to perform a guarded "initialization" in order to register the 369 // destructor. 370 EmitCXXGuardedInit(D, GV, /*PerformInit*/false); 371 } 372 373 return GV; 374 } 375 376 void CodeGenFunction::EmitStaticVarDecl(const VarDecl &D, 377 llvm::GlobalValue::LinkageTypes Linkage) { 378 // Check to see if we already have a global variable for this 379 // declaration. This can happen when double-emitting function 380 // bodies, e.g. with complete and base constructors. 381 llvm::Constant *addr = CGM.getOrCreateStaticVarDecl(D, Linkage); 382 CharUnits alignment = getContext().getDeclAlign(&D); 383 384 // Store into LocalDeclMap before generating initializer to handle 385 // circular references. 386 setAddrOfLocalVar(&D, Address(addr, alignment)); 387 388 // We can't have a VLA here, but we can have a pointer to a VLA, 389 // even though that doesn't really make any sense. 390 // Make sure to evaluate VLA bounds now so that we have them for later. 391 if (D.getType()->isVariablyModifiedType()) 392 EmitVariablyModifiedType(D.getType()); 393 394 // Save the type in case adding the initializer forces a type change. 395 llvm::Type *expectedType = addr->getType(); 396 397 llvm::GlobalVariable *var = 398 cast<llvm::GlobalVariable>(addr->stripPointerCasts()); 399 400 // CUDA's local and local static __shared__ variables should not 401 // have any non-empty initializers. This is ensured by Sema. 402 // Whatever initializer such variable may have when it gets here is 403 // a no-op and should not be emitted. 404 bool isCudaSharedVar = getLangOpts().CUDA && getLangOpts().CUDAIsDevice && 405 D.hasAttr<CUDASharedAttr>(); 406 // If this value has an initializer, emit it. 407 if (D.getInit() && !isCudaSharedVar) 408 var = AddInitializerToStaticVarDecl(D, var); 409 410 var->setAlignment(alignment.getQuantity()); 411 412 if (D.hasAttr<AnnotateAttr>()) 413 CGM.AddGlobalAnnotations(&D, var); 414 415 if (auto *SA = D.getAttr<PragmaClangBSSSectionAttr>()) 416 var->addAttribute("bss-section", SA->getName()); 417 if (auto *SA = D.getAttr<PragmaClangDataSectionAttr>()) 418 var->addAttribute("data-section", SA->getName()); 419 if (auto *SA = D.getAttr<PragmaClangRodataSectionAttr>()) 420 var->addAttribute("rodata-section", SA->getName()); 421 422 if (const SectionAttr *SA = D.getAttr<SectionAttr>()) 423 var->setSection(SA->getName()); 424 425 if (D.hasAttr<UsedAttr>()) 426 CGM.addUsedGlobal(var); 427 428 // We may have to cast the constant because of the initializer 429 // mismatch above. 430 // 431 // FIXME: It is really dangerous to store this in the map; if anyone 432 // RAUW's the GV uses of this constant will be invalid. 433 llvm::Constant *castedAddr = 434 llvm::ConstantExpr::getPointerBitCastOrAddrSpaceCast(var, expectedType); 435 if (var != castedAddr) 436 LocalDeclMap.find(&D)->second = Address(castedAddr, alignment); 437 CGM.setStaticLocalDeclAddress(&D, castedAddr); 438 439 CGM.getSanitizerMetadata()->reportGlobalToASan(var, D); 440 441 // Emit global variable debug descriptor for static vars. 442 CGDebugInfo *DI = getDebugInfo(); 443 if (DI && 444 CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo) { 445 DI->setLocation(D.getLocation()); 446 DI->EmitGlobalVariable(var, &D); 447 } 448 } 449 450 namespace { 451 struct DestroyObject final : EHScopeStack::Cleanup { 452 DestroyObject(Address addr, QualType type, 453 CodeGenFunction::Destroyer *destroyer, 454 bool useEHCleanupForArray) 455 : addr(addr), type(type), destroyer(destroyer), 456 useEHCleanupForArray(useEHCleanupForArray) {} 457 458 Address addr; 459 QualType type; 460 CodeGenFunction::Destroyer *destroyer; 461 bool useEHCleanupForArray; 462 463 void Emit(CodeGenFunction &CGF, Flags flags) override { 464 // Don't use an EH cleanup recursively from an EH cleanup. 465 bool useEHCleanupForArray = 466 flags.isForNormalCleanup() && this->useEHCleanupForArray; 467 468 CGF.emitDestroy(addr, type, destroyer, useEHCleanupForArray); 469 } 470 }; 471 472 struct DestroyNRVOVariable final : EHScopeStack::Cleanup { 473 DestroyNRVOVariable(Address addr, 474 const CXXDestructorDecl *Dtor, 475 llvm::Value *NRVOFlag) 476 : Dtor(Dtor), NRVOFlag(NRVOFlag), Loc(addr) {} 477 478 const CXXDestructorDecl *Dtor; 479 llvm::Value *NRVOFlag; 480 Address Loc; 481 482 void Emit(CodeGenFunction &CGF, Flags flags) override { 483 // Along the exceptions path we always execute the dtor. 484 bool NRVO = flags.isForNormalCleanup() && NRVOFlag; 485 486 llvm::BasicBlock *SkipDtorBB = nullptr; 487 if (NRVO) { 488 // If we exited via NRVO, we skip the destructor call. 489 llvm::BasicBlock *RunDtorBB = CGF.createBasicBlock("nrvo.unused"); 490 SkipDtorBB = CGF.createBasicBlock("nrvo.skipdtor"); 491 llvm::Value *DidNRVO = 492 CGF.Builder.CreateFlagLoad(NRVOFlag, "nrvo.val"); 493 CGF.Builder.CreateCondBr(DidNRVO, SkipDtorBB, RunDtorBB); 494 CGF.EmitBlock(RunDtorBB); 495 } 496 497 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, 498 /*ForVirtualBase=*/false, 499 /*Delegating=*/false, 500 Loc); 501 502 if (NRVO) CGF.EmitBlock(SkipDtorBB); 503 } 504 }; 505 506 struct CallStackRestore final : EHScopeStack::Cleanup { 507 Address Stack; 508 CallStackRestore(Address Stack) : Stack(Stack) {} 509 void Emit(CodeGenFunction &CGF, Flags flags) override { 510 llvm::Value *V = CGF.Builder.CreateLoad(Stack); 511 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore); 512 CGF.Builder.CreateCall(F, V); 513 } 514 }; 515 516 struct ExtendGCLifetime final : EHScopeStack::Cleanup { 517 const VarDecl &Var; 518 ExtendGCLifetime(const VarDecl *var) : Var(*var) {} 519 520 void Emit(CodeGenFunction &CGF, Flags flags) override { 521 // Compute the address of the local variable, in case it's a 522 // byref or something. 523 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false, 524 Var.getType(), VK_LValue, SourceLocation()); 525 llvm::Value *value = CGF.EmitLoadOfScalar(CGF.EmitDeclRefLValue(&DRE), 526 SourceLocation()); 527 CGF.EmitExtendGCLifetime(value); 528 } 529 }; 530 531 struct CallCleanupFunction final : EHScopeStack::Cleanup { 532 llvm::Constant *CleanupFn; 533 const CGFunctionInfo &FnInfo; 534 const VarDecl &Var; 535 536 CallCleanupFunction(llvm::Constant *CleanupFn, const CGFunctionInfo *Info, 537 const VarDecl *Var) 538 : CleanupFn(CleanupFn), FnInfo(*Info), Var(*Var) {} 539 540 void Emit(CodeGenFunction &CGF, Flags flags) override { 541 DeclRefExpr DRE(const_cast<VarDecl*>(&Var), false, 542 Var.getType(), VK_LValue, SourceLocation()); 543 // Compute the address of the local variable, in case it's a byref 544 // or something. 545 llvm::Value *Addr = CGF.EmitDeclRefLValue(&DRE).getPointer(); 546 547 // In some cases, the type of the function argument will be different from 548 // the type of the pointer. An example of this is 549 // void f(void* arg); 550 // __attribute__((cleanup(f))) void *g; 551 // 552 // To fix this we insert a bitcast here. 553 QualType ArgTy = FnInfo.arg_begin()->type; 554 llvm::Value *Arg = 555 CGF.Builder.CreateBitCast(Addr, CGF.ConvertType(ArgTy)); 556 557 CallArgList Args; 558 Args.add(RValue::get(Arg), 559 CGF.getContext().getPointerType(Var.getType())); 560 auto Callee = CGCallee::forDirect(CleanupFn); 561 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args); 562 } 563 }; 564 } // end anonymous namespace 565 566 /// EmitAutoVarWithLifetime - Does the setup required for an automatic 567 /// variable with lifetime. 568 static void EmitAutoVarWithLifetime(CodeGenFunction &CGF, const VarDecl &var, 569 Address addr, 570 Qualifiers::ObjCLifetime lifetime) { 571 switch (lifetime) { 572 case Qualifiers::OCL_None: 573 llvm_unreachable("present but none"); 574 575 case Qualifiers::OCL_ExplicitNone: 576 // nothing to do 577 break; 578 579 case Qualifiers::OCL_Strong: { 580 CodeGenFunction::Destroyer *destroyer = 581 (var.hasAttr<ObjCPreciseLifetimeAttr>() 582 ? CodeGenFunction::destroyARCStrongPrecise 583 : CodeGenFunction::destroyARCStrongImprecise); 584 585 CleanupKind cleanupKind = CGF.getARCCleanupKind(); 586 CGF.pushDestroy(cleanupKind, addr, var.getType(), destroyer, 587 cleanupKind & EHCleanup); 588 break; 589 } 590 case Qualifiers::OCL_Autoreleasing: 591 // nothing to do 592 break; 593 594 case Qualifiers::OCL_Weak: 595 // __weak objects always get EH cleanups; otherwise, exceptions 596 // could cause really nasty crashes instead of mere leaks. 597 CGF.pushDestroy(NormalAndEHCleanup, addr, var.getType(), 598 CodeGenFunction::destroyARCWeak, 599 /*useEHCleanup*/ true); 600 break; 601 } 602 } 603 604 static bool isAccessedBy(const VarDecl &var, const Stmt *s) { 605 if (const Expr *e = dyn_cast<Expr>(s)) { 606 // Skip the most common kinds of expressions that make 607 // hierarchy-walking expensive. 608 s = e = e->IgnoreParenCasts(); 609 610 if (const DeclRefExpr *ref = dyn_cast<DeclRefExpr>(e)) 611 return (ref->getDecl() == &var); 612 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) { 613 const BlockDecl *block = be->getBlockDecl(); 614 for (const auto &I : block->captures()) { 615 if (I.getVariable() == &var) 616 return true; 617 } 618 } 619 } 620 621 for (const Stmt *SubStmt : s->children()) 622 // SubStmt might be null; as in missing decl or conditional of an if-stmt. 623 if (SubStmt && isAccessedBy(var, SubStmt)) 624 return true; 625 626 return false; 627 } 628 629 static bool isAccessedBy(const ValueDecl *decl, const Expr *e) { 630 if (!decl) return false; 631 if (!isa<VarDecl>(decl)) return false; 632 const VarDecl *var = cast<VarDecl>(decl); 633 return isAccessedBy(*var, e); 634 } 635 636 static bool tryEmitARCCopyWeakInit(CodeGenFunction &CGF, 637 const LValue &destLV, const Expr *init) { 638 bool needsCast = false; 639 640 while (auto castExpr = dyn_cast<CastExpr>(init->IgnoreParens())) { 641 switch (castExpr->getCastKind()) { 642 // Look through casts that don't require representation changes. 643 case CK_NoOp: 644 case CK_BitCast: 645 case CK_BlockPointerToObjCPointerCast: 646 needsCast = true; 647 break; 648 649 // If we find an l-value to r-value cast from a __weak variable, 650 // emit this operation as a copy or move. 651 case CK_LValueToRValue: { 652 const Expr *srcExpr = castExpr->getSubExpr(); 653 if (srcExpr->getType().getObjCLifetime() != Qualifiers::OCL_Weak) 654 return false; 655 656 // Emit the source l-value. 657 LValue srcLV = CGF.EmitLValue(srcExpr); 658 659 // Handle a formal type change to avoid asserting. 660 auto srcAddr = srcLV.getAddress(); 661 if (needsCast) { 662 srcAddr = CGF.Builder.CreateElementBitCast(srcAddr, 663 destLV.getAddress().getElementType()); 664 } 665 666 // If it was an l-value, use objc_copyWeak. 667 if (srcExpr->getValueKind() == VK_LValue) { 668 CGF.EmitARCCopyWeak(destLV.getAddress(), srcAddr); 669 } else { 670 assert(srcExpr->getValueKind() == VK_XValue); 671 CGF.EmitARCMoveWeak(destLV.getAddress(), srcAddr); 672 } 673 return true; 674 } 675 676 // Stop at anything else. 677 default: 678 return false; 679 } 680 681 init = castExpr->getSubExpr(); 682 } 683 return false; 684 } 685 686 static void drillIntoBlockVariable(CodeGenFunction &CGF, 687 LValue &lvalue, 688 const VarDecl *var) { 689 lvalue.setAddress(CGF.emitBlockByrefAddress(lvalue.getAddress(), var)); 690 } 691 692 void CodeGenFunction::EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, 693 SourceLocation Loc) { 694 if (!SanOpts.has(SanitizerKind::NullabilityAssign)) 695 return; 696 697 auto Nullability = LHS.getType()->getNullability(getContext()); 698 if (!Nullability || *Nullability != NullabilityKind::NonNull) 699 return; 700 701 // Check if the right hand side of the assignment is nonnull, if the left 702 // hand side must be nonnull. 703 SanitizerScope SanScope(this); 704 llvm::Value *IsNotNull = Builder.CreateIsNotNull(RHS); 705 llvm::Constant *StaticData[] = { 706 EmitCheckSourceLocation(Loc), EmitCheckTypeDescriptor(LHS.getType()), 707 llvm::ConstantInt::get(Int8Ty, 0), // The LogAlignment info is unused. 708 llvm::ConstantInt::get(Int8Ty, TCK_NonnullAssign)}; 709 EmitCheck({{IsNotNull, SanitizerKind::NullabilityAssign}}, 710 SanitizerHandler::TypeMismatch, StaticData, RHS); 711 } 712 713 void CodeGenFunction::EmitScalarInit(const Expr *init, const ValueDecl *D, 714 LValue lvalue, bool capturedByInit) { 715 Qualifiers::ObjCLifetime lifetime = lvalue.getObjCLifetime(); 716 if (!lifetime) { 717 llvm::Value *value = EmitScalarExpr(init); 718 if (capturedByInit) 719 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D)); 720 EmitNullabilityCheck(lvalue, value, init->getExprLoc()); 721 EmitStoreThroughLValue(RValue::get(value), lvalue, true); 722 return; 723 } 724 725 if (const CXXDefaultInitExpr *DIE = dyn_cast<CXXDefaultInitExpr>(init)) 726 init = DIE->getExpr(); 727 728 // If we're emitting a value with lifetime, we have to do the 729 // initialization *before* we leave the cleanup scopes. 730 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(init)) { 731 enterFullExpression(ewc); 732 init = ewc->getSubExpr(); 733 } 734 CodeGenFunction::RunCleanupsScope Scope(*this); 735 736 // We have to maintain the illusion that the variable is 737 // zero-initialized. If the variable might be accessed in its 738 // initializer, zero-initialize before running the initializer, then 739 // actually perform the initialization with an assign. 740 bool accessedByInit = false; 741 if (lifetime != Qualifiers::OCL_ExplicitNone) 742 accessedByInit = (capturedByInit || isAccessedBy(D, init)); 743 if (accessedByInit) { 744 LValue tempLV = lvalue; 745 // Drill down to the __block object if necessary. 746 if (capturedByInit) { 747 // We can use a simple GEP for this because it can't have been 748 // moved yet. 749 tempLV.setAddress(emitBlockByrefAddress(tempLV.getAddress(), 750 cast<VarDecl>(D), 751 /*follow*/ false)); 752 } 753 754 auto ty = cast<llvm::PointerType>(tempLV.getAddress().getElementType()); 755 llvm::Value *zero = CGM.getNullPointer(ty, tempLV.getType()); 756 757 // If __weak, we want to use a barrier under certain conditions. 758 if (lifetime == Qualifiers::OCL_Weak) 759 EmitARCInitWeak(tempLV.getAddress(), zero); 760 761 // Otherwise just do a simple store. 762 else 763 EmitStoreOfScalar(zero, tempLV, /* isInitialization */ true); 764 } 765 766 // Emit the initializer. 767 llvm::Value *value = nullptr; 768 769 switch (lifetime) { 770 case Qualifiers::OCL_None: 771 llvm_unreachable("present but none"); 772 773 case Qualifiers::OCL_ExplicitNone: 774 value = EmitARCUnsafeUnretainedScalarExpr(init); 775 break; 776 777 case Qualifiers::OCL_Strong: { 778 value = EmitARCRetainScalarExpr(init); 779 break; 780 } 781 782 case Qualifiers::OCL_Weak: { 783 // If it's not accessed by the initializer, try to emit the 784 // initialization with a copy or move. 785 if (!accessedByInit && tryEmitARCCopyWeakInit(*this, lvalue, init)) { 786 return; 787 } 788 789 // No way to optimize a producing initializer into this. It's not 790 // worth optimizing for, because the value will immediately 791 // disappear in the common case. 792 value = EmitScalarExpr(init); 793 794 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D)); 795 if (accessedByInit) 796 EmitARCStoreWeak(lvalue.getAddress(), value, /*ignored*/ true); 797 else 798 EmitARCInitWeak(lvalue.getAddress(), value); 799 return; 800 } 801 802 case Qualifiers::OCL_Autoreleasing: 803 value = EmitARCRetainAutoreleaseScalarExpr(init); 804 break; 805 } 806 807 if (capturedByInit) drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D)); 808 809 EmitNullabilityCheck(lvalue, value, init->getExprLoc()); 810 811 // If the variable might have been accessed by its initializer, we 812 // might have to initialize with a barrier. We have to do this for 813 // both __weak and __strong, but __weak got filtered out above. 814 if (accessedByInit && lifetime == Qualifiers::OCL_Strong) { 815 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, init->getExprLoc()); 816 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true); 817 EmitARCRelease(oldValue, ARCImpreciseLifetime); 818 return; 819 } 820 821 EmitStoreOfScalar(value, lvalue, /* isInitialization */ true); 822 } 823 824 /// canEmitInitWithFewStoresAfterMemset - Decide whether we can emit the 825 /// non-zero parts of the specified initializer with equal or fewer than 826 /// NumStores scalar stores. 827 static bool canEmitInitWithFewStoresAfterMemset(llvm::Constant *Init, 828 unsigned &NumStores) { 829 // Zero and Undef never requires any extra stores. 830 if (isa<llvm::ConstantAggregateZero>(Init) || 831 isa<llvm::ConstantPointerNull>(Init) || 832 isa<llvm::UndefValue>(Init)) 833 return true; 834 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) || 835 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) || 836 isa<llvm::ConstantExpr>(Init)) 837 return Init->isNullValue() || NumStores--; 838 839 // See if we can emit each element. 840 if (isa<llvm::ConstantArray>(Init) || isa<llvm::ConstantStruct>(Init)) { 841 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) { 842 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i)); 843 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores)) 844 return false; 845 } 846 return true; 847 } 848 849 if (llvm::ConstantDataSequential *CDS = 850 dyn_cast<llvm::ConstantDataSequential>(Init)) { 851 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) { 852 llvm::Constant *Elt = CDS->getElementAsConstant(i); 853 if (!canEmitInitWithFewStoresAfterMemset(Elt, NumStores)) 854 return false; 855 } 856 return true; 857 } 858 859 // Anything else is hard and scary. 860 return false; 861 } 862 863 /// emitStoresForInitAfterMemset - For inits that 864 /// canEmitInitWithFewStoresAfterMemset returned true for, emit the scalar 865 /// stores that would be required. 866 static void emitStoresForInitAfterMemset(llvm::Constant *Init, llvm::Value *Loc, 867 bool isVolatile, CGBuilderTy &Builder) { 868 assert(!Init->isNullValue() && !isa<llvm::UndefValue>(Init) && 869 "called emitStoresForInitAfterMemset for zero or undef value."); 870 871 if (isa<llvm::ConstantInt>(Init) || isa<llvm::ConstantFP>(Init) || 872 isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) || 873 isa<llvm::ConstantExpr>(Init)) { 874 Builder.CreateDefaultAlignedStore(Init, Loc, isVolatile); 875 return; 876 } 877 878 if (llvm::ConstantDataSequential *CDS = 879 dyn_cast<llvm::ConstantDataSequential>(Init)) { 880 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) { 881 llvm::Constant *Elt = CDS->getElementAsConstant(i); 882 883 // If necessary, get a pointer to the element and emit it. 884 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt)) 885 emitStoresForInitAfterMemset( 886 Elt, Builder.CreateConstGEP2_32(Init->getType(), Loc, 0, i), 887 isVolatile, Builder); 888 } 889 return; 890 } 891 892 assert((isa<llvm::ConstantStruct>(Init) || isa<llvm::ConstantArray>(Init)) && 893 "Unknown value type!"); 894 895 for (unsigned i = 0, e = Init->getNumOperands(); i != e; ++i) { 896 llvm::Constant *Elt = cast<llvm::Constant>(Init->getOperand(i)); 897 898 // If necessary, get a pointer to the element and emit it. 899 if (!Elt->isNullValue() && !isa<llvm::UndefValue>(Elt)) 900 emitStoresForInitAfterMemset( 901 Elt, Builder.CreateConstGEP2_32(Init->getType(), Loc, 0, i), 902 isVolatile, Builder); 903 } 904 } 905 906 /// shouldUseMemSetPlusStoresToInitialize - Decide whether we should use memset 907 /// plus some stores to initialize a local variable instead of using a memcpy 908 /// from a constant global. It is beneficial to use memset if the global is all 909 /// zeros, or mostly zeros and large. 910 static bool shouldUseMemSetPlusStoresToInitialize(llvm::Constant *Init, 911 uint64_t GlobalSize) { 912 // If a global is all zeros, always use a memset. 913 if (isa<llvm::ConstantAggregateZero>(Init)) return true; 914 915 // If a non-zero global is <= 32 bytes, always use a memcpy. If it is large, 916 // do it if it will require 6 or fewer scalar stores. 917 // TODO: Should budget depends on the size? Avoiding a large global warrants 918 // plopping in more stores. 919 unsigned StoreBudget = 6; 920 uint64_t SizeLimit = 32; 921 922 return GlobalSize > SizeLimit && 923 canEmitInitWithFewStoresAfterMemset(Init, StoreBudget); 924 } 925 926 /// EmitAutoVarDecl - Emit code and set up an entry in LocalDeclMap for a 927 /// variable declaration with auto, register, or no storage class specifier. 928 /// These turn into simple stack objects, or GlobalValues depending on target. 929 void CodeGenFunction::EmitAutoVarDecl(const VarDecl &D) { 930 AutoVarEmission emission = EmitAutoVarAlloca(D); 931 EmitAutoVarInit(emission); 932 EmitAutoVarCleanups(emission); 933 } 934 935 /// Emit a lifetime.begin marker if some criteria are satisfied. 936 /// \return a pointer to the temporary size Value if a marker was emitted, null 937 /// otherwise 938 llvm::Value *CodeGenFunction::EmitLifetimeStart(uint64_t Size, 939 llvm::Value *Addr) { 940 if (!ShouldEmitLifetimeMarkers) 941 return nullptr; 942 943 llvm::Value *SizeV = llvm::ConstantInt::get(Int64Ty, Size); 944 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy); 945 llvm::CallInst *C = 946 Builder.CreateCall(CGM.getLLVMLifetimeStartFn(), {SizeV, Addr}); 947 C->setDoesNotThrow(); 948 return SizeV; 949 } 950 951 void CodeGenFunction::EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr) { 952 Addr = Builder.CreateBitCast(Addr, AllocaInt8PtrTy); 953 llvm::CallInst *C = 954 Builder.CreateCall(CGM.getLLVMLifetimeEndFn(), {Size, Addr}); 955 C->setDoesNotThrow(); 956 } 957 958 void CodeGenFunction::EmitAndRegisterVariableArrayDimensions( 959 CGDebugInfo *DI, const VarDecl &D, bool EmitDebugInfo) { 960 // For each dimension stores its QualType and corresponding 961 // size-expression Value. 962 SmallVector<CodeGenFunction::VlaSizePair, 4> Dimensions; 963 964 // Break down the array into individual dimensions. 965 QualType Type1D = D.getType(); 966 while (getContext().getAsVariableArrayType(Type1D)) { 967 auto VlaSize = getVLAElements1D(Type1D); 968 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts)) 969 Dimensions.emplace_back(C, Type1D.getUnqualifiedType()); 970 else { 971 auto SizeExprAddr = 972 CreateDefaultAlignTempAlloca(VlaSize.NumElts->getType(), "vla_expr"); 973 Builder.CreateStore(VlaSize.NumElts, SizeExprAddr); 974 Dimensions.emplace_back(SizeExprAddr.getPointer(), 975 Type1D.getUnqualifiedType()); 976 } 977 Type1D = VlaSize.Type; 978 } 979 980 if (!EmitDebugInfo) 981 return; 982 983 // Register each dimension's size-expression with a DILocalVariable, 984 // so that it can be used by CGDebugInfo when instantiating a DISubrange 985 // to describe this array. 986 for (auto &VlaSize : Dimensions) { 987 llvm::Metadata *MD; 988 if (auto *C = dyn_cast<llvm::ConstantInt>(VlaSize.NumElts)) 989 MD = llvm::ConstantAsMetadata::get(C); 990 else { 991 // Create an artificial VarDecl to generate debug info for. 992 IdentifierInfo &NameIdent = getContext().Idents.getOwn( 993 cast<llvm::AllocaInst>(VlaSize.NumElts)->getName()); 994 auto VlaExprTy = VlaSize.NumElts->getType()->getPointerElementType(); 995 auto QT = getContext().getIntTypeForBitwidth( 996 VlaExprTy->getScalarSizeInBits(), false); 997 auto *ArtificialDecl = VarDecl::Create( 998 getContext(), const_cast<DeclContext *>(D.getDeclContext()), 999 D.getLocation(), D.getLocation(), &NameIdent, QT, 1000 getContext().CreateTypeSourceInfo(QT), SC_Auto); 1001 1002 MD = DI->EmitDeclareOfAutoVariable(ArtificialDecl, VlaSize.NumElts, 1003 Builder); 1004 } 1005 assert(MD && "No Size expression debug node created"); 1006 DI->registerVLASizeExpression(VlaSize.Type, MD); 1007 } 1008 } 1009 1010 /// EmitAutoVarAlloca - Emit the alloca and debug information for a 1011 /// local variable. Does not emit initialization or destruction. 1012 CodeGenFunction::AutoVarEmission 1013 CodeGenFunction::EmitAutoVarAlloca(const VarDecl &D) { 1014 QualType Ty = D.getType(); 1015 assert( 1016 Ty.getAddressSpace() == LangAS::Default || 1017 (Ty.getAddressSpace() == LangAS::opencl_private && getLangOpts().OpenCL)); 1018 1019 AutoVarEmission emission(D); 1020 1021 bool isByRef = D.hasAttr<BlocksAttr>(); 1022 emission.IsByRef = isByRef; 1023 1024 CharUnits alignment = getContext().getDeclAlign(&D); 1025 1026 // If the type is variably-modified, emit all the VLA sizes for it. 1027 if (Ty->isVariablyModifiedType()) 1028 EmitVariablyModifiedType(Ty); 1029 1030 auto *DI = getDebugInfo(); 1031 bool EmitDebugInfo = DI && CGM.getCodeGenOpts().getDebugInfo() >= 1032 codegenoptions::LimitedDebugInfo; 1033 1034 Address address = Address::invalid(); 1035 if (Ty->isConstantSizeType()) { 1036 bool NRVO = getLangOpts().ElideConstructors && 1037 D.isNRVOVariable(); 1038 1039 // If this value is an array or struct with a statically determinable 1040 // constant initializer, there are optimizations we can do. 1041 // 1042 // TODO: We should constant-evaluate the initializer of any variable, 1043 // as long as it is initialized by a constant expression. Currently, 1044 // isConstantInitializer produces wrong answers for structs with 1045 // reference or bitfield members, and a few other cases, and checking 1046 // for POD-ness protects us from some of these. 1047 if (D.getInit() && (Ty->isArrayType() || Ty->isRecordType()) && 1048 (D.isConstexpr() || 1049 ((Ty.isPODType(getContext()) || 1050 getContext().getBaseElementType(Ty)->isObjCObjectPointerType()) && 1051 D.getInit()->isConstantInitializer(getContext(), false)))) { 1052 1053 // If the variable's a const type, and it's neither an NRVO 1054 // candidate nor a __block variable and has no mutable members, 1055 // emit it as a global instead. 1056 // Exception is if a variable is located in non-constant address space 1057 // in OpenCL. 1058 if ((!getLangOpts().OpenCL || 1059 Ty.getAddressSpace() == LangAS::opencl_constant) && 1060 (CGM.getCodeGenOpts().MergeAllConstants && !NRVO && !isByRef && 1061 CGM.isTypeConstant(Ty, true))) { 1062 EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage); 1063 1064 // Signal this condition to later callbacks. 1065 emission.Addr = Address::invalid(); 1066 assert(emission.wasEmittedAsGlobal()); 1067 return emission; 1068 } 1069 1070 // Otherwise, tell the initialization code that we're in this case. 1071 emission.IsConstantAggregate = true; 1072 } 1073 1074 // A normal fixed sized variable becomes an alloca in the entry block, 1075 // unless it's an NRVO variable. 1076 1077 if (NRVO) { 1078 // The named return value optimization: allocate this variable in the 1079 // return slot, so that we can elide the copy when returning this 1080 // variable (C++0x [class.copy]p34). 1081 address = ReturnValue; 1082 1083 if (const RecordType *RecordTy = Ty->getAs<RecordType>()) { 1084 if (!cast<CXXRecordDecl>(RecordTy->getDecl())->hasTrivialDestructor()) { 1085 // Create a flag that is used to indicate when the NRVO was applied 1086 // to this variable. Set it to zero to indicate that NRVO was not 1087 // applied. 1088 llvm::Value *Zero = Builder.getFalse(); 1089 Address NRVOFlag = 1090 CreateTempAlloca(Zero->getType(), CharUnits::One(), "nrvo"); 1091 EnsureInsertPoint(); 1092 Builder.CreateStore(Zero, NRVOFlag); 1093 1094 // Record the NRVO flag for this variable. 1095 NRVOFlags[&D] = NRVOFlag.getPointer(); 1096 emission.NRVOFlag = NRVOFlag.getPointer(); 1097 } 1098 } 1099 } else { 1100 CharUnits allocaAlignment; 1101 llvm::Type *allocaTy; 1102 if (isByRef) { 1103 auto &byrefInfo = getBlockByrefInfo(&D); 1104 allocaTy = byrefInfo.Type; 1105 allocaAlignment = byrefInfo.ByrefAlignment; 1106 } else { 1107 allocaTy = ConvertTypeForMem(Ty); 1108 allocaAlignment = alignment; 1109 } 1110 1111 // Create the alloca. Note that we set the name separately from 1112 // building the instruction so that it's there even in no-asserts 1113 // builds. 1114 address = CreateTempAlloca(allocaTy, allocaAlignment, D.getName()); 1115 1116 // Don't emit lifetime markers for MSVC catch parameters. The lifetime of 1117 // the catch parameter starts in the catchpad instruction, and we can't 1118 // insert code in those basic blocks. 1119 bool IsMSCatchParam = 1120 D.isExceptionVariable() && getTarget().getCXXABI().isMicrosoft(); 1121 1122 // Emit a lifetime intrinsic if meaningful. There's no point in doing this 1123 // if we don't have a valid insertion point (?). 1124 if (HaveInsertPoint() && !IsMSCatchParam) { 1125 // If there's a jump into the lifetime of this variable, its lifetime 1126 // gets broken up into several regions in IR, which requires more work 1127 // to handle correctly. For now, just omit the intrinsics; this is a 1128 // rare case, and it's better to just be conservatively correct. 1129 // PR28267. 1130 // 1131 // We have to do this in all language modes if there's a jump past the 1132 // declaration. We also have to do it in C if there's a jump to an 1133 // earlier point in the current block because non-VLA lifetimes begin as 1134 // soon as the containing block is entered, not when its variables 1135 // actually come into scope; suppressing the lifetime annotations 1136 // completely in this case is unnecessarily pessimistic, but again, this 1137 // is rare. 1138 if (!Bypasses.IsBypassed(&D) && 1139 !(!getLangOpts().CPlusPlus && hasLabelBeenSeenInCurrentScope())) { 1140 uint64_t size = CGM.getDataLayout().getTypeAllocSize(allocaTy); 1141 emission.SizeForLifetimeMarkers = 1142 EmitLifetimeStart(size, address.getPointer()); 1143 } 1144 } else { 1145 assert(!emission.useLifetimeMarkers()); 1146 } 1147 } 1148 } else { 1149 EnsureInsertPoint(); 1150 1151 if (!DidCallStackSave) { 1152 // Save the stack. 1153 Address Stack = 1154 CreateTempAlloca(Int8PtrTy, getPointerAlign(), "saved_stack"); 1155 1156 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::stacksave); 1157 llvm::Value *V = Builder.CreateCall(F); 1158 Builder.CreateStore(V, Stack); 1159 1160 DidCallStackSave = true; 1161 1162 // Push a cleanup block and restore the stack there. 1163 // FIXME: in general circumstances, this should be an EH cleanup. 1164 pushStackRestore(NormalCleanup, Stack); 1165 } 1166 1167 auto VlaSize = getVLASize(Ty); 1168 llvm::Type *llvmTy = ConvertTypeForMem(VlaSize.Type); 1169 1170 // Allocate memory for the array. 1171 address = CreateTempAlloca(llvmTy, alignment, "vla", VlaSize.NumElts); 1172 1173 // If we have debug info enabled, properly describe the VLA dimensions for 1174 // this type by registering the vla size expression for each of the 1175 // dimensions. 1176 EmitAndRegisterVariableArrayDimensions(DI, D, EmitDebugInfo); 1177 } 1178 1179 setAddrOfLocalVar(&D, address); 1180 emission.Addr = address; 1181 1182 // Emit debug info for local var declaration. 1183 if (EmitDebugInfo && HaveInsertPoint()) { 1184 DI->setLocation(D.getLocation()); 1185 (void)DI->EmitDeclareOfAutoVariable(&D, address.getPointer(), Builder); 1186 } 1187 1188 if (D.hasAttr<AnnotateAttr>()) 1189 EmitVarAnnotations(&D, address.getPointer()); 1190 1191 // Make sure we call @llvm.lifetime.end. 1192 if (emission.useLifetimeMarkers()) 1193 EHStack.pushCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, 1194 emission.getAllocatedAddress(), 1195 emission.getSizeForLifetimeMarkers()); 1196 1197 return emission; 1198 } 1199 1200 /// Determines whether the given __block variable is potentially 1201 /// captured by the given expression. 1202 static bool isCapturedBy(const VarDecl &var, const Expr *e) { 1203 // Skip the most common kinds of expressions that make 1204 // hierarchy-walking expensive. 1205 e = e->IgnoreParenCasts(); 1206 1207 if (const BlockExpr *be = dyn_cast<BlockExpr>(e)) { 1208 const BlockDecl *block = be->getBlockDecl(); 1209 for (const auto &I : block->captures()) { 1210 if (I.getVariable() == &var) 1211 return true; 1212 } 1213 1214 // No need to walk into the subexpressions. 1215 return false; 1216 } 1217 1218 if (const StmtExpr *SE = dyn_cast<StmtExpr>(e)) { 1219 const CompoundStmt *CS = SE->getSubStmt(); 1220 for (const auto *BI : CS->body()) 1221 if (const auto *E = dyn_cast<Expr>(BI)) { 1222 if (isCapturedBy(var, E)) 1223 return true; 1224 } 1225 else if (const auto *DS = dyn_cast<DeclStmt>(BI)) { 1226 // special case declarations 1227 for (const auto *I : DS->decls()) { 1228 if (const auto *VD = dyn_cast<VarDecl>((I))) { 1229 const Expr *Init = VD->getInit(); 1230 if (Init && isCapturedBy(var, Init)) 1231 return true; 1232 } 1233 } 1234 } 1235 else 1236 // FIXME. Make safe assumption assuming arbitrary statements cause capturing. 1237 // Later, provide code to poke into statements for capture analysis. 1238 return true; 1239 return false; 1240 } 1241 1242 for (const Stmt *SubStmt : e->children()) 1243 if (isCapturedBy(var, cast<Expr>(SubStmt))) 1244 return true; 1245 1246 return false; 1247 } 1248 1249 /// \brief Determine whether the given initializer is trivial in the sense 1250 /// that it requires no code to be generated. 1251 bool CodeGenFunction::isTrivialInitializer(const Expr *Init) { 1252 if (!Init) 1253 return true; 1254 1255 if (const CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init)) 1256 if (CXXConstructorDecl *Constructor = Construct->getConstructor()) 1257 if (Constructor->isTrivial() && 1258 Constructor->isDefaultConstructor() && 1259 !Construct->requiresZeroInitialization()) 1260 return true; 1261 1262 return false; 1263 } 1264 1265 void CodeGenFunction::EmitAutoVarInit(const AutoVarEmission &emission) { 1266 assert(emission.Variable && "emission was not valid!"); 1267 1268 // If this was emitted as a global constant, we're done. 1269 if (emission.wasEmittedAsGlobal()) return; 1270 1271 const VarDecl &D = *emission.Variable; 1272 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, D.getLocation()); 1273 QualType type = D.getType(); 1274 1275 // If this local has an initializer, emit it now. 1276 const Expr *Init = D.getInit(); 1277 1278 // If we are at an unreachable point, we don't need to emit the initializer 1279 // unless it contains a label. 1280 if (!HaveInsertPoint()) { 1281 if (!Init || !ContainsLabel(Init)) return; 1282 EnsureInsertPoint(); 1283 } 1284 1285 // Initialize the structure of a __block variable. 1286 if (emission.IsByRef) 1287 emitByrefStructureInit(emission); 1288 1289 if (isTrivialInitializer(Init)) 1290 return; 1291 1292 // Check whether this is a byref variable that's potentially 1293 // captured and moved by its own initializer. If so, we'll need to 1294 // emit the initializer first, then copy into the variable. 1295 bool capturedByInit = emission.IsByRef && isCapturedBy(D, Init); 1296 1297 Address Loc = 1298 capturedByInit ? emission.Addr : emission.getObjectAddress(*this); 1299 1300 llvm::Constant *constant = nullptr; 1301 if (emission.IsConstantAggregate || D.isConstexpr()) { 1302 assert(!capturedByInit && "constant init contains a capturing block?"); 1303 constant = ConstantEmitter(*this).tryEmitAbstractForInitializer(D); 1304 } 1305 1306 if (!constant) { 1307 LValue lv = MakeAddrLValue(Loc, type); 1308 lv.setNonGC(true); 1309 return EmitExprAsInit(Init, &D, lv, capturedByInit); 1310 } 1311 1312 if (!emission.IsConstantAggregate) { 1313 // For simple scalar/complex initialization, store the value directly. 1314 LValue lv = MakeAddrLValue(Loc, type); 1315 lv.setNonGC(true); 1316 return EmitStoreThroughLValue(RValue::get(constant), lv, true); 1317 } 1318 1319 // If this is a simple aggregate initialization, we can optimize it 1320 // in various ways. 1321 bool isVolatile = type.isVolatileQualified(); 1322 1323 llvm::Value *SizeVal = 1324 llvm::ConstantInt::get(IntPtrTy, 1325 getContext().getTypeSizeInChars(type).getQuantity()); 1326 1327 llvm::Type *BP = AllocaInt8PtrTy; 1328 if (Loc.getType() != BP) 1329 Loc = Builder.CreateBitCast(Loc, BP); 1330 1331 // If the initializer is all or mostly zeros, codegen with memset then do 1332 // a few stores afterward. 1333 if (shouldUseMemSetPlusStoresToInitialize(constant, 1334 CGM.getDataLayout().getTypeAllocSize(constant->getType()))) { 1335 Builder.CreateMemSet(Loc, llvm::ConstantInt::get(Int8Ty, 0), SizeVal, 1336 isVolatile); 1337 // Zero and undef don't require a stores. 1338 if (!constant->isNullValue() && !isa<llvm::UndefValue>(constant)) { 1339 Loc = Builder.CreateBitCast(Loc, constant->getType()->getPointerTo()); 1340 emitStoresForInitAfterMemset(constant, Loc.getPointer(), 1341 isVolatile, Builder); 1342 } 1343 } else { 1344 // Otherwise, create a temporary global with the initializer then 1345 // memcpy from the global to the alloca. 1346 std::string Name = getStaticDeclName(CGM, D); 1347 unsigned AS = 0; 1348 if (getLangOpts().OpenCL) { 1349 AS = CGM.getContext().getTargetAddressSpace(LangAS::opencl_constant); 1350 BP = llvm::PointerType::getInt8PtrTy(getLLVMContext(), AS); 1351 } 1352 llvm::GlobalVariable *GV = 1353 new llvm::GlobalVariable(CGM.getModule(), constant->getType(), true, 1354 llvm::GlobalValue::PrivateLinkage, 1355 constant, Name, nullptr, 1356 llvm::GlobalValue::NotThreadLocal, AS); 1357 GV->setAlignment(Loc.getAlignment().getQuantity()); 1358 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global); 1359 1360 Address SrcPtr = Address(GV, Loc.getAlignment()); 1361 if (SrcPtr.getType() != BP) 1362 SrcPtr = Builder.CreateBitCast(SrcPtr, BP); 1363 1364 Builder.CreateMemCpy(Loc, SrcPtr, SizeVal, isVolatile); 1365 } 1366 } 1367 1368 /// Emit an expression as an initializer for a variable at the given 1369 /// location. The expression is not necessarily the normal 1370 /// initializer for the variable, and the address is not necessarily 1371 /// its normal location. 1372 /// 1373 /// \param init the initializing expression 1374 /// \param var the variable to act as if we're initializing 1375 /// \param loc the address to initialize; its type is a pointer 1376 /// to the LLVM mapping of the variable's type 1377 /// \param alignment the alignment of the address 1378 /// \param capturedByInit true if the variable is a __block variable 1379 /// whose address is potentially changed by the initializer 1380 void CodeGenFunction::EmitExprAsInit(const Expr *init, const ValueDecl *D, 1381 LValue lvalue, bool capturedByInit) { 1382 QualType type = D->getType(); 1383 1384 if (type->isReferenceType()) { 1385 RValue rvalue = EmitReferenceBindingToExpr(init); 1386 if (capturedByInit) 1387 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D)); 1388 EmitStoreThroughLValue(rvalue, lvalue, true); 1389 return; 1390 } 1391 switch (getEvaluationKind(type)) { 1392 case TEK_Scalar: 1393 EmitScalarInit(init, D, lvalue, capturedByInit); 1394 return; 1395 case TEK_Complex: { 1396 ComplexPairTy complex = EmitComplexExpr(init); 1397 if (capturedByInit) 1398 drillIntoBlockVariable(*this, lvalue, cast<VarDecl>(D)); 1399 EmitStoreOfComplex(complex, lvalue, /*init*/ true); 1400 return; 1401 } 1402 case TEK_Aggregate: 1403 if (type->isAtomicType()) { 1404 EmitAtomicInit(const_cast<Expr*>(init), lvalue); 1405 } else { 1406 // TODO: how can we delay here if D is captured by its initializer? 1407 EmitAggExpr(init, AggValueSlot::forLValue(lvalue, 1408 AggValueSlot::IsDestructed, 1409 AggValueSlot::DoesNotNeedGCBarriers, 1410 AggValueSlot::IsNotAliased)); 1411 } 1412 return; 1413 } 1414 llvm_unreachable("bad evaluation kind"); 1415 } 1416 1417 /// Enter a destroy cleanup for the given local variable. 1418 void CodeGenFunction::emitAutoVarTypeCleanup( 1419 const CodeGenFunction::AutoVarEmission &emission, 1420 QualType::DestructionKind dtorKind) { 1421 assert(dtorKind != QualType::DK_none); 1422 1423 // Note that for __block variables, we want to destroy the 1424 // original stack object, not the possibly forwarded object. 1425 Address addr = emission.getObjectAddress(*this); 1426 1427 const VarDecl *var = emission.Variable; 1428 QualType type = var->getType(); 1429 1430 CleanupKind cleanupKind = NormalAndEHCleanup; 1431 CodeGenFunction::Destroyer *destroyer = nullptr; 1432 1433 switch (dtorKind) { 1434 case QualType::DK_none: 1435 llvm_unreachable("no cleanup for trivially-destructible variable"); 1436 1437 case QualType::DK_cxx_destructor: 1438 // If there's an NRVO flag on the emission, we need a different 1439 // cleanup. 1440 if (emission.NRVOFlag) { 1441 assert(!type->isArrayType()); 1442 CXXDestructorDecl *dtor = type->getAsCXXRecordDecl()->getDestructor(); 1443 EHStack.pushCleanup<DestroyNRVOVariable>(cleanupKind, addr, 1444 dtor, emission.NRVOFlag); 1445 return; 1446 } 1447 break; 1448 1449 case QualType::DK_objc_strong_lifetime: 1450 // Suppress cleanups for pseudo-strong variables. 1451 if (var->isARCPseudoStrong()) return; 1452 1453 // Otherwise, consider whether to use an EH cleanup or not. 1454 cleanupKind = getARCCleanupKind(); 1455 1456 // Use the imprecise destroyer by default. 1457 if (!var->hasAttr<ObjCPreciseLifetimeAttr>()) 1458 destroyer = CodeGenFunction::destroyARCStrongImprecise; 1459 break; 1460 1461 case QualType::DK_objc_weak_lifetime: 1462 break; 1463 } 1464 1465 // If we haven't chosen a more specific destroyer, use the default. 1466 if (!destroyer) destroyer = getDestroyer(dtorKind); 1467 1468 // Use an EH cleanup in array destructors iff the destructor itself 1469 // is being pushed as an EH cleanup. 1470 bool useEHCleanup = (cleanupKind & EHCleanup); 1471 EHStack.pushCleanup<DestroyObject>(cleanupKind, addr, type, destroyer, 1472 useEHCleanup); 1473 } 1474 1475 void CodeGenFunction::EmitAutoVarCleanups(const AutoVarEmission &emission) { 1476 assert(emission.Variable && "emission was not valid!"); 1477 1478 // If this was emitted as a global constant, we're done. 1479 if (emission.wasEmittedAsGlobal()) return; 1480 1481 // If we don't have an insertion point, we're done. Sema prevents 1482 // us from jumping into any of these scopes anyway. 1483 if (!HaveInsertPoint()) return; 1484 1485 const VarDecl &D = *emission.Variable; 1486 1487 // Check the type for a cleanup. 1488 if (QualType::DestructionKind dtorKind = D.getType().isDestructedType()) 1489 emitAutoVarTypeCleanup(emission, dtorKind); 1490 1491 // In GC mode, honor objc_precise_lifetime. 1492 if (getLangOpts().getGC() != LangOptions::NonGC && 1493 D.hasAttr<ObjCPreciseLifetimeAttr>()) { 1494 EHStack.pushCleanup<ExtendGCLifetime>(NormalCleanup, &D); 1495 } 1496 1497 // Handle the cleanup attribute. 1498 if (const CleanupAttr *CA = D.getAttr<CleanupAttr>()) { 1499 const FunctionDecl *FD = CA->getFunctionDecl(); 1500 1501 llvm::Constant *F = CGM.GetAddrOfFunction(FD); 1502 assert(F && "Could not find function!"); 1503 1504 const CGFunctionInfo &Info = CGM.getTypes().arrangeFunctionDeclaration(FD); 1505 EHStack.pushCleanup<CallCleanupFunction>(NormalAndEHCleanup, F, &Info, &D); 1506 } 1507 1508 // If this is a block variable, call _Block_object_destroy 1509 // (on the unforwarded address). 1510 if (emission.IsByRef) 1511 enterByrefCleanup(emission); 1512 } 1513 1514 CodeGenFunction::Destroyer * 1515 CodeGenFunction::getDestroyer(QualType::DestructionKind kind) { 1516 switch (kind) { 1517 case QualType::DK_none: llvm_unreachable("no destroyer for trivial dtor"); 1518 case QualType::DK_cxx_destructor: 1519 return destroyCXXObject; 1520 case QualType::DK_objc_strong_lifetime: 1521 return destroyARCStrongPrecise; 1522 case QualType::DK_objc_weak_lifetime: 1523 return destroyARCWeak; 1524 } 1525 llvm_unreachable("Unknown DestructionKind"); 1526 } 1527 1528 /// pushEHDestroy - Push the standard destructor for the given type as 1529 /// an EH-only cleanup. 1530 void CodeGenFunction::pushEHDestroy(QualType::DestructionKind dtorKind, 1531 Address addr, QualType type) { 1532 assert(dtorKind && "cannot push destructor for trivial type"); 1533 assert(needsEHCleanup(dtorKind)); 1534 1535 pushDestroy(EHCleanup, addr, type, getDestroyer(dtorKind), true); 1536 } 1537 1538 /// pushDestroy - Push the standard destructor for the given type as 1539 /// at least a normal cleanup. 1540 void CodeGenFunction::pushDestroy(QualType::DestructionKind dtorKind, 1541 Address addr, QualType type) { 1542 assert(dtorKind && "cannot push destructor for trivial type"); 1543 1544 CleanupKind cleanupKind = getCleanupKind(dtorKind); 1545 pushDestroy(cleanupKind, addr, type, getDestroyer(dtorKind), 1546 cleanupKind & EHCleanup); 1547 } 1548 1549 void CodeGenFunction::pushDestroy(CleanupKind cleanupKind, Address addr, 1550 QualType type, Destroyer *destroyer, 1551 bool useEHCleanupForArray) { 1552 pushFullExprCleanup<DestroyObject>(cleanupKind, addr, type, 1553 destroyer, useEHCleanupForArray); 1554 } 1555 1556 void CodeGenFunction::pushStackRestore(CleanupKind Kind, Address SPMem) { 1557 EHStack.pushCleanup<CallStackRestore>(Kind, SPMem); 1558 } 1559 1560 void CodeGenFunction::pushLifetimeExtendedDestroy( 1561 CleanupKind cleanupKind, Address addr, QualType type, 1562 Destroyer *destroyer, bool useEHCleanupForArray) { 1563 assert(!isInConditionalBranch() && 1564 "performing lifetime extension from within conditional"); 1565 1566 // Push an EH-only cleanup for the object now. 1567 // FIXME: When popping normal cleanups, we need to keep this EH cleanup 1568 // around in case a temporary's destructor throws an exception. 1569 if (cleanupKind & EHCleanup) 1570 EHStack.pushCleanup<DestroyObject>( 1571 static_cast<CleanupKind>(cleanupKind & ~NormalCleanup), addr, type, 1572 destroyer, useEHCleanupForArray); 1573 1574 // Remember that we need to push a full cleanup for the object at the 1575 // end of the full-expression. 1576 pushCleanupAfterFullExpr<DestroyObject>( 1577 cleanupKind, addr, type, destroyer, useEHCleanupForArray); 1578 } 1579 1580 /// emitDestroy - Immediately perform the destruction of the given 1581 /// object. 1582 /// 1583 /// \param addr - the address of the object; a type* 1584 /// \param type - the type of the object; if an array type, all 1585 /// objects are destroyed in reverse order 1586 /// \param destroyer - the function to call to destroy individual 1587 /// elements 1588 /// \param useEHCleanupForArray - whether an EH cleanup should be 1589 /// used when destroying array elements, in case one of the 1590 /// destructions throws an exception 1591 void CodeGenFunction::emitDestroy(Address addr, QualType type, 1592 Destroyer *destroyer, 1593 bool useEHCleanupForArray) { 1594 const ArrayType *arrayType = getContext().getAsArrayType(type); 1595 if (!arrayType) 1596 return destroyer(*this, addr, type); 1597 1598 llvm::Value *length = emitArrayLength(arrayType, type, addr); 1599 1600 CharUnits elementAlign = 1601 addr.getAlignment() 1602 .alignmentOfArrayElement(getContext().getTypeSizeInChars(type)); 1603 1604 // Normally we have to check whether the array is zero-length. 1605 bool checkZeroLength = true; 1606 1607 // But if the array length is constant, we can suppress that. 1608 if (llvm::ConstantInt *constLength = dyn_cast<llvm::ConstantInt>(length)) { 1609 // ...and if it's constant zero, we can just skip the entire thing. 1610 if (constLength->isZero()) return; 1611 checkZeroLength = false; 1612 } 1613 1614 llvm::Value *begin = addr.getPointer(); 1615 llvm::Value *end = Builder.CreateInBoundsGEP(begin, length); 1616 emitArrayDestroy(begin, end, type, elementAlign, destroyer, 1617 checkZeroLength, useEHCleanupForArray); 1618 } 1619 1620 /// emitArrayDestroy - Destroys all the elements of the given array, 1621 /// beginning from last to first. The array cannot be zero-length. 1622 /// 1623 /// \param begin - a type* denoting the first element of the array 1624 /// \param end - a type* denoting one past the end of the array 1625 /// \param elementType - the element type of the array 1626 /// \param destroyer - the function to call to destroy elements 1627 /// \param useEHCleanup - whether to push an EH cleanup to destroy 1628 /// the remaining elements in case the destruction of a single 1629 /// element throws 1630 void CodeGenFunction::emitArrayDestroy(llvm::Value *begin, 1631 llvm::Value *end, 1632 QualType elementType, 1633 CharUnits elementAlign, 1634 Destroyer *destroyer, 1635 bool checkZeroLength, 1636 bool useEHCleanup) { 1637 assert(!elementType->isArrayType()); 1638 1639 // The basic structure here is a do-while loop, because we don't 1640 // need to check for the zero-element case. 1641 llvm::BasicBlock *bodyBB = createBasicBlock("arraydestroy.body"); 1642 llvm::BasicBlock *doneBB = createBasicBlock("arraydestroy.done"); 1643 1644 if (checkZeroLength) { 1645 llvm::Value *isEmpty = Builder.CreateICmpEQ(begin, end, 1646 "arraydestroy.isempty"); 1647 Builder.CreateCondBr(isEmpty, doneBB, bodyBB); 1648 } 1649 1650 // Enter the loop body, making that address the current address. 1651 llvm::BasicBlock *entryBB = Builder.GetInsertBlock(); 1652 EmitBlock(bodyBB); 1653 llvm::PHINode *elementPast = 1654 Builder.CreatePHI(begin->getType(), 2, "arraydestroy.elementPast"); 1655 elementPast->addIncoming(end, entryBB); 1656 1657 // Shift the address back by one element. 1658 llvm::Value *negativeOne = llvm::ConstantInt::get(SizeTy, -1, true); 1659 llvm::Value *element = Builder.CreateInBoundsGEP(elementPast, negativeOne, 1660 "arraydestroy.element"); 1661 1662 if (useEHCleanup) 1663 pushRegularPartialArrayCleanup(begin, element, elementType, elementAlign, 1664 destroyer); 1665 1666 // Perform the actual destruction there. 1667 destroyer(*this, Address(element, elementAlign), elementType); 1668 1669 if (useEHCleanup) 1670 PopCleanupBlock(); 1671 1672 // Check whether we've reached the end. 1673 llvm::Value *done = Builder.CreateICmpEQ(element, begin, "arraydestroy.done"); 1674 Builder.CreateCondBr(done, doneBB, bodyBB); 1675 elementPast->addIncoming(element, Builder.GetInsertBlock()); 1676 1677 // Done. 1678 EmitBlock(doneBB); 1679 } 1680 1681 /// Perform partial array destruction as if in an EH cleanup. Unlike 1682 /// emitArrayDestroy, the element type here may still be an array type. 1683 static void emitPartialArrayDestroy(CodeGenFunction &CGF, 1684 llvm::Value *begin, llvm::Value *end, 1685 QualType type, CharUnits elementAlign, 1686 CodeGenFunction::Destroyer *destroyer) { 1687 // If the element type is itself an array, drill down. 1688 unsigned arrayDepth = 0; 1689 while (const ArrayType *arrayType = CGF.getContext().getAsArrayType(type)) { 1690 // VLAs don't require a GEP index to walk into. 1691 if (!isa<VariableArrayType>(arrayType)) 1692 arrayDepth++; 1693 type = arrayType->getElementType(); 1694 } 1695 1696 if (arrayDepth) { 1697 llvm::Value *zero = llvm::ConstantInt::get(CGF.SizeTy, 0); 1698 1699 SmallVector<llvm::Value*,4> gepIndices(arrayDepth+1, zero); 1700 begin = CGF.Builder.CreateInBoundsGEP(begin, gepIndices, "pad.arraybegin"); 1701 end = CGF.Builder.CreateInBoundsGEP(end, gepIndices, "pad.arrayend"); 1702 } 1703 1704 // Destroy the array. We don't ever need an EH cleanup because we 1705 // assume that we're in an EH cleanup ourselves, so a throwing 1706 // destructor causes an immediate terminate. 1707 CGF.emitArrayDestroy(begin, end, type, elementAlign, destroyer, 1708 /*checkZeroLength*/ true, /*useEHCleanup*/ false); 1709 } 1710 1711 namespace { 1712 /// RegularPartialArrayDestroy - a cleanup which performs a partial 1713 /// array destroy where the end pointer is regularly determined and 1714 /// does not need to be loaded from a local. 1715 class RegularPartialArrayDestroy final : public EHScopeStack::Cleanup { 1716 llvm::Value *ArrayBegin; 1717 llvm::Value *ArrayEnd; 1718 QualType ElementType; 1719 CodeGenFunction::Destroyer *Destroyer; 1720 CharUnits ElementAlign; 1721 public: 1722 RegularPartialArrayDestroy(llvm::Value *arrayBegin, llvm::Value *arrayEnd, 1723 QualType elementType, CharUnits elementAlign, 1724 CodeGenFunction::Destroyer *destroyer) 1725 : ArrayBegin(arrayBegin), ArrayEnd(arrayEnd), 1726 ElementType(elementType), Destroyer(destroyer), 1727 ElementAlign(elementAlign) {} 1728 1729 void Emit(CodeGenFunction &CGF, Flags flags) override { 1730 emitPartialArrayDestroy(CGF, ArrayBegin, ArrayEnd, 1731 ElementType, ElementAlign, Destroyer); 1732 } 1733 }; 1734 1735 /// IrregularPartialArrayDestroy - a cleanup which performs a 1736 /// partial array destroy where the end pointer is irregularly 1737 /// determined and must be loaded from a local. 1738 class IrregularPartialArrayDestroy final : public EHScopeStack::Cleanup { 1739 llvm::Value *ArrayBegin; 1740 Address ArrayEndPointer; 1741 QualType ElementType; 1742 CodeGenFunction::Destroyer *Destroyer; 1743 CharUnits ElementAlign; 1744 public: 1745 IrregularPartialArrayDestroy(llvm::Value *arrayBegin, 1746 Address arrayEndPointer, 1747 QualType elementType, 1748 CharUnits elementAlign, 1749 CodeGenFunction::Destroyer *destroyer) 1750 : ArrayBegin(arrayBegin), ArrayEndPointer(arrayEndPointer), 1751 ElementType(elementType), Destroyer(destroyer), 1752 ElementAlign(elementAlign) {} 1753 1754 void Emit(CodeGenFunction &CGF, Flags flags) override { 1755 llvm::Value *arrayEnd = CGF.Builder.CreateLoad(ArrayEndPointer); 1756 emitPartialArrayDestroy(CGF, ArrayBegin, arrayEnd, 1757 ElementType, ElementAlign, Destroyer); 1758 } 1759 }; 1760 } // end anonymous namespace 1761 1762 /// pushIrregularPartialArrayCleanup - Push an EH cleanup to destroy 1763 /// already-constructed elements of the given array. The cleanup 1764 /// may be popped with DeactivateCleanupBlock or PopCleanupBlock. 1765 /// 1766 /// \param elementType - the immediate element type of the array; 1767 /// possibly still an array type 1768 void CodeGenFunction::pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin, 1769 Address arrayEndPointer, 1770 QualType elementType, 1771 CharUnits elementAlign, 1772 Destroyer *destroyer) { 1773 pushFullExprCleanup<IrregularPartialArrayDestroy>(EHCleanup, 1774 arrayBegin, arrayEndPointer, 1775 elementType, elementAlign, 1776 destroyer); 1777 } 1778 1779 /// pushRegularPartialArrayCleanup - Push an EH cleanup to destroy 1780 /// already-constructed elements of the given array. The cleanup 1781 /// may be popped with DeactivateCleanupBlock or PopCleanupBlock. 1782 /// 1783 /// \param elementType - the immediate element type of the array; 1784 /// possibly still an array type 1785 void CodeGenFunction::pushRegularPartialArrayCleanup(llvm::Value *arrayBegin, 1786 llvm::Value *arrayEnd, 1787 QualType elementType, 1788 CharUnits elementAlign, 1789 Destroyer *destroyer) { 1790 pushFullExprCleanup<RegularPartialArrayDestroy>(EHCleanup, 1791 arrayBegin, arrayEnd, 1792 elementType, elementAlign, 1793 destroyer); 1794 } 1795 1796 /// Lazily declare the @llvm.lifetime.start intrinsic. 1797 llvm::Constant *CodeGenModule::getLLVMLifetimeStartFn() { 1798 if (LifetimeStartFn) 1799 return LifetimeStartFn; 1800 LifetimeStartFn = llvm::Intrinsic::getDeclaration(&getModule(), 1801 llvm::Intrinsic::lifetime_start, AllocaInt8PtrTy); 1802 return LifetimeStartFn; 1803 } 1804 1805 /// Lazily declare the @llvm.lifetime.end intrinsic. 1806 llvm::Constant *CodeGenModule::getLLVMLifetimeEndFn() { 1807 if (LifetimeEndFn) 1808 return LifetimeEndFn; 1809 LifetimeEndFn = llvm::Intrinsic::getDeclaration(&getModule(), 1810 llvm::Intrinsic::lifetime_end, AllocaInt8PtrTy); 1811 return LifetimeEndFn; 1812 } 1813 1814 namespace { 1815 /// A cleanup to perform a release of an object at the end of a 1816 /// function. This is used to balance out the incoming +1 of a 1817 /// ns_consumed argument when we can't reasonably do that just by 1818 /// not doing the initial retain for a __block argument. 1819 struct ConsumeARCParameter final : EHScopeStack::Cleanup { 1820 ConsumeARCParameter(llvm::Value *param, 1821 ARCPreciseLifetime_t precise) 1822 : Param(param), Precise(precise) {} 1823 1824 llvm::Value *Param; 1825 ARCPreciseLifetime_t Precise; 1826 1827 void Emit(CodeGenFunction &CGF, Flags flags) override { 1828 CGF.EmitARCRelease(Param, Precise); 1829 } 1830 }; 1831 } // end anonymous namespace 1832 1833 /// Emit an alloca (or GlobalValue depending on target) 1834 /// for the specified parameter and set up LocalDeclMap. 1835 void CodeGenFunction::EmitParmDecl(const VarDecl &D, ParamValue Arg, 1836 unsigned ArgNo) { 1837 // FIXME: Why isn't ImplicitParamDecl a ParmVarDecl? 1838 assert((isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)) && 1839 "Invalid argument to EmitParmDecl"); 1840 1841 Arg.getAnyValue()->setName(D.getName()); 1842 1843 QualType Ty = D.getType(); 1844 1845 // Use better IR generation for certain implicit parameters. 1846 if (auto IPD = dyn_cast<ImplicitParamDecl>(&D)) { 1847 // The only implicit argument a block has is its literal. 1848 // We assume this is always passed directly. 1849 if (BlockInfo) { 1850 setBlockContextParameter(IPD, ArgNo, Arg.getDirectValue()); 1851 return; 1852 } 1853 } 1854 1855 Address DeclPtr = Address::invalid(); 1856 bool DoStore = false; 1857 bool IsScalar = hasScalarEvaluationKind(Ty); 1858 // If we already have a pointer to the argument, reuse the input pointer. 1859 if (Arg.isIndirect()) { 1860 DeclPtr = Arg.getIndirectAddress(); 1861 // If we have a prettier pointer type at this point, bitcast to that. 1862 unsigned AS = DeclPtr.getType()->getAddressSpace(); 1863 llvm::Type *IRTy = ConvertTypeForMem(Ty)->getPointerTo(AS); 1864 if (DeclPtr.getType() != IRTy) 1865 DeclPtr = Builder.CreateBitCast(DeclPtr, IRTy, D.getName()); 1866 1867 // Push a destructor cleanup for this parameter if the ABI requires it. 1868 // Don't push a cleanup in a thunk for a method that will also emit a 1869 // cleanup. 1870 if (!IsScalar && !CurFuncIsThunk && 1871 getContext().isParamDestroyedInCallee(Ty)) { 1872 const CXXRecordDecl *RD = Ty->getAsCXXRecordDecl(); 1873 if (RD && RD->hasNonTrivialDestructor()) 1874 pushDestroy(QualType::DK_cxx_destructor, DeclPtr, Ty); 1875 } 1876 } else { 1877 // Otherwise, create a temporary to hold the value. 1878 DeclPtr = CreateMemTemp(Ty, getContext().getDeclAlign(&D), 1879 D.getName() + ".addr"); 1880 DoStore = true; 1881 } 1882 1883 llvm::Value *ArgVal = (DoStore ? Arg.getDirectValue() : nullptr); 1884 1885 LValue lv = MakeAddrLValue(DeclPtr, Ty); 1886 if (IsScalar) { 1887 Qualifiers qs = Ty.getQualifiers(); 1888 if (Qualifiers::ObjCLifetime lt = qs.getObjCLifetime()) { 1889 // We honor __attribute__((ns_consumed)) for types with lifetime. 1890 // For __strong, it's handled by just skipping the initial retain; 1891 // otherwise we have to balance out the initial +1 with an extra 1892 // cleanup to do the release at the end of the function. 1893 bool isConsumed = D.hasAttr<NSConsumedAttr>(); 1894 1895 // 'self' is always formally __strong, but if this is not an 1896 // init method then we don't want to retain it. 1897 if (D.isARCPseudoStrong()) { 1898 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CurCodeDecl); 1899 assert(&D == method->getSelfDecl()); 1900 assert(lt == Qualifiers::OCL_Strong); 1901 assert(qs.hasConst()); 1902 assert(method->getMethodFamily() != OMF_init); 1903 (void) method; 1904 lt = Qualifiers::OCL_ExplicitNone; 1905 } 1906 1907 // Load objects passed indirectly. 1908 if (Arg.isIndirect() && !ArgVal) 1909 ArgVal = Builder.CreateLoad(DeclPtr); 1910 1911 if (lt == Qualifiers::OCL_Strong) { 1912 if (!isConsumed) { 1913 if (CGM.getCodeGenOpts().OptimizationLevel == 0) { 1914 // use objc_storeStrong(&dest, value) for retaining the 1915 // object. But first, store a null into 'dest' because 1916 // objc_storeStrong attempts to release its old value. 1917 llvm::Value *Null = CGM.EmitNullConstant(D.getType()); 1918 EmitStoreOfScalar(Null, lv, /* isInitialization */ true); 1919 EmitARCStoreStrongCall(lv.getAddress(), ArgVal, true); 1920 DoStore = false; 1921 } 1922 else 1923 // Don't use objc_retainBlock for block pointers, because we 1924 // don't want to Block_copy something just because we got it 1925 // as a parameter. 1926 ArgVal = EmitARCRetainNonBlock(ArgVal); 1927 } 1928 } else { 1929 // Push the cleanup for a consumed parameter. 1930 if (isConsumed) { 1931 ARCPreciseLifetime_t precise = (D.hasAttr<ObjCPreciseLifetimeAttr>() 1932 ? ARCPreciseLifetime : ARCImpreciseLifetime); 1933 EHStack.pushCleanup<ConsumeARCParameter>(getARCCleanupKind(), ArgVal, 1934 precise); 1935 } 1936 1937 if (lt == Qualifiers::OCL_Weak) { 1938 EmitARCInitWeak(DeclPtr, ArgVal); 1939 DoStore = false; // The weak init is a store, no need to do two. 1940 } 1941 } 1942 1943 // Enter the cleanup scope. 1944 EmitAutoVarWithLifetime(*this, D, DeclPtr, lt); 1945 } 1946 } 1947 1948 // Store the initial value into the alloca. 1949 if (DoStore) 1950 EmitStoreOfScalar(ArgVal, lv, /* isInitialization */ true); 1951 1952 setAddrOfLocalVar(&D, DeclPtr); 1953 1954 // Emit debug info for param declaration. 1955 if (CGDebugInfo *DI = getDebugInfo()) { 1956 if (CGM.getCodeGenOpts().getDebugInfo() >= 1957 codegenoptions::LimitedDebugInfo) { 1958 DI->EmitDeclareOfArgVariable(&D, DeclPtr.getPointer(), ArgNo, Builder); 1959 } 1960 } 1961 1962 if (D.hasAttr<AnnotateAttr>()) 1963 EmitVarAnnotations(&D, DeclPtr.getPointer()); 1964 1965 // We can only check return value nullability if all arguments to the 1966 // function satisfy their nullability preconditions. This makes it necessary 1967 // to emit null checks for args in the function body itself. 1968 if (requiresReturnValueNullabilityCheck()) { 1969 auto Nullability = Ty->getNullability(getContext()); 1970 if (Nullability && *Nullability == NullabilityKind::NonNull) { 1971 SanitizerScope SanScope(this); 1972 RetValNullabilityPrecondition = 1973 Builder.CreateAnd(RetValNullabilityPrecondition, 1974 Builder.CreateIsNotNull(Arg.getAnyValue())); 1975 } 1976 } 1977 } 1978 1979 void CodeGenModule::EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D, 1980 CodeGenFunction *CGF) { 1981 if (!LangOpts.OpenMP || (!LangOpts.EmitAllDecls && !D->isUsed())) 1982 return; 1983 getOpenMPRuntime().emitUserDefinedReduction(CGF, D); 1984 } 1985