1 //===--- CodeGenFunction.cpp - Emit LLVM Code from ASTs for a Function ----===// 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 coordinates the per-function state used while generating code. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #include "CodeGenFunction.h" 14 #include "CGBlocks.h" 15 #include "CGCUDARuntime.h" 16 #include "CGCXXABI.h" 17 #include "CGCleanup.h" 18 #include "CGDebugInfo.h" 19 #include "CGOpenMPRuntime.h" 20 #include "CodeGenModule.h" 21 #include "CodeGenPGO.h" 22 #include "TargetInfo.h" 23 #include "clang/AST/ASTContext.h" 24 #include "clang/AST/ASTLambda.h" 25 #include "clang/AST/Attr.h" 26 #include "clang/AST/Decl.h" 27 #include "clang/AST/DeclCXX.h" 28 #include "clang/AST/StmtCXX.h" 29 #include "clang/AST/StmtObjC.h" 30 #include "clang/Basic/Builtins.h" 31 #include "clang/Basic/CodeGenOptions.h" 32 #include "clang/Basic/TargetInfo.h" 33 #include "clang/CodeGen/CGFunctionInfo.h" 34 #include "clang/Frontend/FrontendDiagnostic.h" 35 #include "llvm/IR/DataLayout.h" 36 #include "llvm/IR/Dominators.h" 37 #include "llvm/IR/FPEnv.h" 38 #include "llvm/IR/IntrinsicInst.h" 39 #include "llvm/IR/Intrinsics.h" 40 #include "llvm/IR/MDBuilder.h" 41 #include "llvm/IR/Operator.h" 42 #include "llvm/Transforms/Utils/PromoteMemToReg.h" 43 using namespace clang; 44 using namespace CodeGen; 45 46 /// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time 47 /// markers. 48 static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts, 49 const LangOptions &LangOpts) { 50 if (CGOpts.DisableLifetimeMarkers) 51 return false; 52 53 // Sanitizers may use markers. 54 if (CGOpts.SanitizeAddressUseAfterScope || 55 LangOpts.Sanitize.has(SanitizerKind::HWAddress) || 56 LangOpts.Sanitize.has(SanitizerKind::Memory)) 57 return true; 58 59 // For now, only in optimized builds. 60 return CGOpts.OptimizationLevel != 0; 61 } 62 63 CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext) 64 : CodeGenTypeCache(cgm), CGM(cgm), Target(cgm.getTarget()), 65 Builder(cgm, cgm.getModule().getContext(), llvm::ConstantFolder(), 66 CGBuilderInserterTy(this)), 67 SanOpts(CGM.getLangOpts().Sanitize), DebugInfo(CGM.getModuleDebugInfo()), 68 PGO(cgm), ShouldEmitLifetimeMarkers(shouldEmitLifetimeMarkers( 69 CGM.getCodeGenOpts(), CGM.getLangOpts())) { 70 if (!suppressNewContext) 71 CGM.getCXXABI().getMangleContext().startNewFunction(); 72 73 llvm::FastMathFlags FMF; 74 if (CGM.getLangOpts().FastMath) 75 FMF.setFast(); 76 if (CGM.getLangOpts().FiniteMathOnly) { 77 FMF.setNoNaNs(); 78 FMF.setNoInfs(); 79 } 80 if (CGM.getCodeGenOpts().NoNaNsFPMath) { 81 FMF.setNoNaNs(); 82 } 83 if (CGM.getCodeGenOpts().NoSignedZeros) { 84 FMF.setNoSignedZeros(); 85 } 86 if (CGM.getCodeGenOpts().ReciprocalMath) { 87 FMF.setAllowReciprocal(); 88 } 89 if (CGM.getCodeGenOpts().Reassociate) { 90 FMF.setAllowReassoc(); 91 } 92 Builder.setFastMathFlags(FMF); 93 SetFPModel(); 94 } 95 96 CodeGenFunction::~CodeGenFunction() { 97 assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup"); 98 99 // If there are any unclaimed block infos, go ahead and destroy them 100 // now. This can happen if IR-gen gets clever and skips evaluating 101 // something. 102 if (FirstBlockInfo) 103 destroyBlockInfos(FirstBlockInfo); 104 105 if (getLangOpts().OpenMP && CurFn) 106 CGM.getOpenMPRuntime().functionFinished(*this); 107 } 108 109 // Map the LangOption for rounding mode into 110 // the corresponding enum in the IR. 111 static llvm::fp::RoundingMode ToConstrainedRoundingMD( 112 LangOptions::FPRoundingModeKind Kind) { 113 114 switch (Kind) { 115 case LangOptions::FPR_ToNearest: return llvm::fp::rmToNearest; 116 case LangOptions::FPR_Downward: return llvm::fp::rmDownward; 117 case LangOptions::FPR_Upward: return llvm::fp::rmUpward; 118 case LangOptions::FPR_TowardZero: return llvm::fp::rmTowardZero; 119 case LangOptions::FPR_Dynamic: return llvm::fp::rmDynamic; 120 } 121 llvm_unreachable("Unsupported FP RoundingMode"); 122 } 123 124 // Map the LangOption for exception behavior into 125 // the corresponding enum in the IR. 126 static llvm::fp::ExceptionBehavior ToConstrainedExceptMD( 127 LangOptions::FPExceptionModeKind Kind) { 128 129 switch (Kind) { 130 case LangOptions::FPE_Ignore: return llvm::fp::ebIgnore; 131 case LangOptions::FPE_MayTrap: return llvm::fp::ebMayTrap; 132 case LangOptions::FPE_Strict: return llvm::fp::ebStrict; 133 } 134 llvm_unreachable("Unsupported FP Exception Behavior"); 135 } 136 137 void CodeGenFunction::SetFPModel() { 138 auto fpRoundingMode = ToConstrainedRoundingMD( 139 getLangOpts().getFPRoundingMode()); 140 auto fpExceptionBehavior = ToConstrainedExceptMD( 141 getLangOpts().getFPExceptionMode()); 142 143 if (fpExceptionBehavior == llvm::fp::ebIgnore && 144 fpRoundingMode == llvm::fp::rmToNearest) 145 // Constrained intrinsics are not used. 146 ; 147 else { 148 Builder.setIsFPConstrained(true); 149 Builder.setDefaultConstrainedRounding(fpRoundingMode); 150 Builder.setDefaultConstrainedExcept(fpExceptionBehavior); 151 } 152 } 153 154 CharUnits CodeGenFunction::getNaturalPointeeTypeAlignment(QualType T, 155 LValueBaseInfo *BaseInfo, 156 TBAAAccessInfo *TBAAInfo) { 157 return getNaturalTypeAlignment(T->getPointeeType(), BaseInfo, TBAAInfo, 158 /* forPointeeType= */ true); 159 } 160 161 CharUnits CodeGenFunction::getNaturalTypeAlignment(QualType T, 162 LValueBaseInfo *BaseInfo, 163 TBAAAccessInfo *TBAAInfo, 164 bool forPointeeType) { 165 if (TBAAInfo) 166 *TBAAInfo = CGM.getTBAAAccessInfo(T); 167 168 // Honor alignment typedef attributes even on incomplete types. 169 // We also honor them straight for C++ class types, even as pointees; 170 // there's an expressivity gap here. 171 if (auto TT = T->getAs<TypedefType>()) { 172 if (auto Align = TT->getDecl()->getMaxAlignment()) { 173 if (BaseInfo) 174 *BaseInfo = LValueBaseInfo(AlignmentSource::AttributedType); 175 return getContext().toCharUnitsFromBits(Align); 176 } 177 } 178 179 if (BaseInfo) 180 *BaseInfo = LValueBaseInfo(AlignmentSource::Type); 181 182 CharUnits Alignment; 183 if (T->isIncompleteType()) { 184 Alignment = CharUnits::One(); // Shouldn't be used, but pessimistic is best. 185 } else { 186 // For C++ class pointees, we don't know whether we're pointing at a 187 // base or a complete object, so we generally need to use the 188 // non-virtual alignment. 189 const CXXRecordDecl *RD; 190 if (forPointeeType && (RD = T->getAsCXXRecordDecl())) { 191 Alignment = CGM.getClassPointerAlignment(RD); 192 } else { 193 Alignment = getContext().getTypeAlignInChars(T); 194 if (T.getQualifiers().hasUnaligned()) 195 Alignment = CharUnits::One(); 196 } 197 198 // Cap to the global maximum type alignment unless the alignment 199 // was somehow explicit on the type. 200 if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) { 201 if (Alignment.getQuantity() > MaxAlign && 202 !getContext().isAlignmentRequired(T)) 203 Alignment = CharUnits::fromQuantity(MaxAlign); 204 } 205 } 206 return Alignment; 207 } 208 209 LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) { 210 LValueBaseInfo BaseInfo; 211 TBAAAccessInfo TBAAInfo; 212 CharUnits Alignment = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo); 213 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), BaseInfo, 214 TBAAInfo); 215 } 216 217 /// Given a value of type T* that may not be to a complete object, 218 /// construct an l-value with the natural pointee alignment of T. 219 LValue 220 CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) { 221 LValueBaseInfo BaseInfo; 222 TBAAAccessInfo TBAAInfo; 223 CharUnits Align = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo, 224 /* forPointeeType= */ true); 225 return MakeAddrLValue(Address(V, Align), T, BaseInfo, TBAAInfo); 226 } 227 228 229 llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) { 230 return CGM.getTypes().ConvertTypeForMem(T); 231 } 232 233 llvm::Type *CodeGenFunction::ConvertType(QualType T) { 234 return CGM.getTypes().ConvertType(T); 235 } 236 237 TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) { 238 type = type.getCanonicalType(); 239 while (true) { 240 switch (type->getTypeClass()) { 241 #define TYPE(name, parent) 242 #define ABSTRACT_TYPE(name, parent) 243 #define NON_CANONICAL_TYPE(name, parent) case Type::name: 244 #define DEPENDENT_TYPE(name, parent) case Type::name: 245 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name: 246 #include "clang/AST/TypeNodes.inc" 247 llvm_unreachable("non-canonical or dependent type in IR-generation"); 248 249 case Type::Auto: 250 case Type::DeducedTemplateSpecialization: 251 llvm_unreachable("undeduced type in IR-generation"); 252 253 // Various scalar types. 254 case Type::Builtin: 255 case Type::Pointer: 256 case Type::BlockPointer: 257 case Type::LValueReference: 258 case Type::RValueReference: 259 case Type::MemberPointer: 260 case Type::Vector: 261 case Type::ExtVector: 262 case Type::FunctionProto: 263 case Type::FunctionNoProto: 264 case Type::Enum: 265 case Type::ObjCObjectPointer: 266 case Type::Pipe: 267 return TEK_Scalar; 268 269 // Complexes. 270 case Type::Complex: 271 return TEK_Complex; 272 273 // Arrays, records, and Objective-C objects. 274 case Type::ConstantArray: 275 case Type::IncompleteArray: 276 case Type::VariableArray: 277 case Type::Record: 278 case Type::ObjCObject: 279 case Type::ObjCInterface: 280 return TEK_Aggregate; 281 282 // We operate on atomic values according to their underlying type. 283 case Type::Atomic: 284 type = cast<AtomicType>(type)->getValueType(); 285 continue; 286 } 287 llvm_unreachable("unknown type kind!"); 288 } 289 } 290 291 llvm::DebugLoc CodeGenFunction::EmitReturnBlock() { 292 // For cleanliness, we try to avoid emitting the return block for 293 // simple cases. 294 llvm::BasicBlock *CurBB = Builder.GetInsertBlock(); 295 296 if (CurBB) { 297 assert(!CurBB->getTerminator() && "Unexpected terminated block."); 298 299 // We have a valid insert point, reuse it if it is empty or there are no 300 // explicit jumps to the return block. 301 if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) { 302 ReturnBlock.getBlock()->replaceAllUsesWith(CurBB); 303 delete ReturnBlock.getBlock(); 304 ReturnBlock = JumpDest(); 305 } else 306 EmitBlock(ReturnBlock.getBlock()); 307 return llvm::DebugLoc(); 308 } 309 310 // Otherwise, if the return block is the target of a single direct 311 // branch then we can just put the code in that block instead. This 312 // cleans up functions which started with a unified return block. 313 if (ReturnBlock.getBlock()->hasOneUse()) { 314 llvm::BranchInst *BI = 315 dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin()); 316 if (BI && BI->isUnconditional() && 317 BI->getSuccessor(0) == ReturnBlock.getBlock()) { 318 // Record/return the DebugLoc of the simple 'return' expression to be used 319 // later by the actual 'ret' instruction. 320 llvm::DebugLoc Loc = BI->getDebugLoc(); 321 Builder.SetInsertPoint(BI->getParent()); 322 BI->eraseFromParent(); 323 delete ReturnBlock.getBlock(); 324 ReturnBlock = JumpDest(); 325 return Loc; 326 } 327 } 328 329 // FIXME: We are at an unreachable point, there is no reason to emit the block 330 // unless it has uses. However, we still need a place to put the debug 331 // region.end for now. 332 333 EmitBlock(ReturnBlock.getBlock()); 334 return llvm::DebugLoc(); 335 } 336 337 static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) { 338 if (!BB) return; 339 if (!BB->use_empty()) 340 return CGF.CurFn->getBasicBlockList().push_back(BB); 341 delete BB; 342 } 343 344 void CodeGenFunction::FinishFunction(SourceLocation EndLoc) { 345 assert(BreakContinueStack.empty() && 346 "mismatched push/pop in break/continue stack!"); 347 348 bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0 349 && NumSimpleReturnExprs == NumReturnExprs 350 && ReturnBlock.getBlock()->use_empty(); 351 // Usually the return expression is evaluated before the cleanup 352 // code. If the function contains only a simple return statement, 353 // such as a constant, the location before the cleanup code becomes 354 // the last useful breakpoint in the function, because the simple 355 // return expression will be evaluated after the cleanup code. To be 356 // safe, set the debug location for cleanup code to the location of 357 // the return statement. Otherwise the cleanup code should be at the 358 // end of the function's lexical scope. 359 // 360 // If there are multiple branches to the return block, the branch 361 // instructions will get the location of the return statements and 362 // all will be fine. 363 if (CGDebugInfo *DI = getDebugInfo()) { 364 if (OnlySimpleReturnStmts) 365 DI->EmitLocation(Builder, LastStopPoint); 366 else 367 DI->EmitLocation(Builder, EndLoc); 368 } 369 370 // Pop any cleanups that might have been associated with the 371 // parameters. Do this in whatever block we're currently in; it's 372 // important to do this before we enter the return block or return 373 // edges will be *really* confused. 374 bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth; 375 bool HasOnlyLifetimeMarkers = 376 HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth); 377 bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers; 378 if (HasCleanups) { 379 // Make sure the line table doesn't jump back into the body for 380 // the ret after it's been at EndLoc. 381 Optional<ApplyDebugLocation> AL; 382 if (CGDebugInfo *DI = getDebugInfo()) { 383 if (OnlySimpleReturnStmts) 384 DI->EmitLocation(Builder, EndLoc); 385 else 386 // We may not have a valid end location. Try to apply it anyway, and 387 // fall back to an artificial location if needed. 388 AL = ApplyDebugLocation::CreateDefaultArtificial(*this, EndLoc); 389 } 390 391 PopCleanupBlocks(PrologueCleanupDepth); 392 } 393 394 // Emit function epilog (to return). 395 llvm::DebugLoc Loc = EmitReturnBlock(); 396 397 if (ShouldInstrumentFunction()) { 398 if (CGM.getCodeGenOpts().InstrumentFunctions) 399 CurFn->addFnAttr("instrument-function-exit", "__cyg_profile_func_exit"); 400 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining) 401 CurFn->addFnAttr("instrument-function-exit-inlined", 402 "__cyg_profile_func_exit"); 403 } 404 405 // Emit debug descriptor for function end. 406 if (CGDebugInfo *DI = getDebugInfo()) 407 DI->EmitFunctionEnd(Builder, CurFn); 408 409 // Reset the debug location to that of the simple 'return' expression, if any 410 // rather than that of the end of the function's scope '}'. 411 ApplyDebugLocation AL(*this, Loc); 412 EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc); 413 EmitEndEHSpec(CurCodeDecl); 414 415 assert(EHStack.empty() && 416 "did not remove all scopes from cleanup stack!"); 417 418 // If someone did an indirect goto, emit the indirect goto block at the end of 419 // the function. 420 if (IndirectBranch) { 421 EmitBlock(IndirectBranch->getParent()); 422 Builder.ClearInsertionPoint(); 423 } 424 425 // If some of our locals escaped, insert a call to llvm.localescape in the 426 // entry block. 427 if (!EscapedLocals.empty()) { 428 // Invert the map from local to index into a simple vector. There should be 429 // no holes. 430 SmallVector<llvm::Value *, 4> EscapeArgs; 431 EscapeArgs.resize(EscapedLocals.size()); 432 for (auto &Pair : EscapedLocals) 433 EscapeArgs[Pair.second] = Pair.first; 434 llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration( 435 &CGM.getModule(), llvm::Intrinsic::localescape); 436 CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs); 437 } 438 439 // Remove the AllocaInsertPt instruction, which is just a convenience for us. 440 llvm::Instruction *Ptr = AllocaInsertPt; 441 AllocaInsertPt = nullptr; 442 Ptr->eraseFromParent(); 443 444 // If someone took the address of a label but never did an indirect goto, we 445 // made a zero entry PHI node, which is illegal, zap it now. 446 if (IndirectBranch) { 447 llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress()); 448 if (PN->getNumIncomingValues() == 0) { 449 PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType())); 450 PN->eraseFromParent(); 451 } 452 } 453 454 EmitIfUsed(*this, EHResumeBlock); 455 EmitIfUsed(*this, TerminateLandingPad); 456 EmitIfUsed(*this, TerminateHandler); 457 EmitIfUsed(*this, UnreachableBlock); 458 459 for (const auto &FuncletAndParent : TerminateFunclets) 460 EmitIfUsed(*this, FuncletAndParent.second); 461 462 if (CGM.getCodeGenOpts().EmitDeclMetadata) 463 EmitDeclMetadata(); 464 465 for (SmallVectorImpl<std::pair<llvm::Instruction *, llvm::Value *> >::iterator 466 I = DeferredReplacements.begin(), 467 E = DeferredReplacements.end(); 468 I != E; ++I) { 469 I->first->replaceAllUsesWith(I->second); 470 I->first->eraseFromParent(); 471 } 472 473 // Eliminate CleanupDestSlot alloca by replacing it with SSA values and 474 // PHIs if the current function is a coroutine. We don't do it for all 475 // functions as it may result in slight increase in numbers of instructions 476 // if compiled with no optimizations. We do it for coroutine as the lifetime 477 // of CleanupDestSlot alloca make correct coroutine frame building very 478 // difficult. 479 if (NormalCleanupDest.isValid() && isCoroutine()) { 480 llvm::DominatorTree DT(*CurFn); 481 llvm::PromoteMemToReg( 482 cast<llvm::AllocaInst>(NormalCleanupDest.getPointer()), DT); 483 NormalCleanupDest = Address::invalid(); 484 } 485 486 // Scan function arguments for vector width. 487 for (llvm::Argument &A : CurFn->args()) 488 if (auto *VT = dyn_cast<llvm::VectorType>(A.getType())) 489 LargestVectorWidth = std::max((uint64_t)LargestVectorWidth, 490 VT->getPrimitiveSizeInBits().getFixedSize()); 491 492 // Update vector width based on return type. 493 if (auto *VT = dyn_cast<llvm::VectorType>(CurFn->getReturnType())) 494 LargestVectorWidth = std::max((uint64_t)LargestVectorWidth, 495 VT->getPrimitiveSizeInBits().getFixedSize()); 496 497 // Add the required-vector-width attribute. This contains the max width from: 498 // 1. min-vector-width attribute used in the source program. 499 // 2. Any builtins used that have a vector width specified. 500 // 3. Values passed in and out of inline assembly. 501 // 4. Width of vector arguments and return types for this function. 502 // 5. Width of vector aguments and return types for functions called by this 503 // function. 504 CurFn->addFnAttr("min-legal-vector-width", llvm::utostr(LargestVectorWidth)); 505 506 // If we generated an unreachable return block, delete it now. 507 if (ReturnBlock.isValid() && ReturnBlock.getBlock()->use_empty()) { 508 Builder.ClearInsertionPoint(); 509 ReturnBlock.getBlock()->eraseFromParent(); 510 } 511 if (ReturnValue.isValid()) { 512 auto *RetAlloca = dyn_cast<llvm::AllocaInst>(ReturnValue.getPointer()); 513 if (RetAlloca && RetAlloca->use_empty()) { 514 RetAlloca->eraseFromParent(); 515 ReturnValue = Address::invalid(); 516 } 517 } 518 } 519 520 /// ShouldInstrumentFunction - Return true if the current function should be 521 /// instrumented with __cyg_profile_func_* calls 522 bool CodeGenFunction::ShouldInstrumentFunction() { 523 if (!CGM.getCodeGenOpts().InstrumentFunctions && 524 !CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining && 525 !CGM.getCodeGenOpts().InstrumentFunctionEntryBare) 526 return false; 527 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) 528 return false; 529 return true; 530 } 531 532 /// ShouldXRayInstrument - Return true if the current function should be 533 /// instrumented with XRay nop sleds. 534 bool CodeGenFunction::ShouldXRayInstrumentFunction() const { 535 return CGM.getCodeGenOpts().XRayInstrumentFunctions; 536 } 537 538 /// AlwaysEmitXRayCustomEvents - Return true if we should emit IR for calls to 539 /// the __xray_customevent(...) builtin calls, when doing XRay instrumentation. 540 bool CodeGenFunction::AlwaysEmitXRayCustomEvents() const { 541 return CGM.getCodeGenOpts().XRayInstrumentFunctions && 542 (CGM.getCodeGenOpts().XRayAlwaysEmitCustomEvents || 543 CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask == 544 XRayInstrKind::Custom); 545 } 546 547 bool CodeGenFunction::AlwaysEmitXRayTypedEvents() const { 548 return CGM.getCodeGenOpts().XRayInstrumentFunctions && 549 (CGM.getCodeGenOpts().XRayAlwaysEmitTypedEvents || 550 CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask == 551 XRayInstrKind::Typed); 552 } 553 554 llvm::Constant * 555 CodeGenFunction::EncodeAddrForUseInPrologue(llvm::Function *F, 556 llvm::Constant *Addr) { 557 // Addresses stored in prologue data can't require run-time fixups and must 558 // be PC-relative. Run-time fixups are undesirable because they necessitate 559 // writable text segments, which are unsafe. And absolute addresses are 560 // undesirable because they break PIE mode. 561 562 // Add a layer of indirection through a private global. Taking its address 563 // won't result in a run-time fixup, even if Addr has linkonce_odr linkage. 564 auto *GV = new llvm::GlobalVariable(CGM.getModule(), Addr->getType(), 565 /*isConstant=*/true, 566 llvm::GlobalValue::PrivateLinkage, Addr); 567 568 // Create a PC-relative address. 569 auto *GOTAsInt = llvm::ConstantExpr::getPtrToInt(GV, IntPtrTy); 570 auto *FuncAsInt = llvm::ConstantExpr::getPtrToInt(F, IntPtrTy); 571 auto *PCRelAsInt = llvm::ConstantExpr::getSub(GOTAsInt, FuncAsInt); 572 return (IntPtrTy == Int32Ty) 573 ? PCRelAsInt 574 : llvm::ConstantExpr::getTrunc(PCRelAsInt, Int32Ty); 575 } 576 577 llvm::Value * 578 CodeGenFunction::DecodeAddrUsedInPrologue(llvm::Value *F, 579 llvm::Value *EncodedAddr) { 580 // Reconstruct the address of the global. 581 auto *PCRelAsInt = Builder.CreateSExt(EncodedAddr, IntPtrTy); 582 auto *FuncAsInt = Builder.CreatePtrToInt(F, IntPtrTy, "func_addr.int"); 583 auto *GOTAsInt = Builder.CreateAdd(PCRelAsInt, FuncAsInt, "global_addr.int"); 584 auto *GOTAddr = Builder.CreateIntToPtr(GOTAsInt, Int8PtrPtrTy, "global_addr"); 585 586 // Load the original pointer through the global. 587 return Builder.CreateLoad(Address(GOTAddr, getPointerAlign()), 588 "decoded_addr"); 589 } 590 591 void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD, 592 llvm::Function *Fn) 593 { 594 if (!FD->hasAttr<OpenCLKernelAttr>()) 595 return; 596 597 llvm::LLVMContext &Context = getLLVMContext(); 598 599 CGM.GenOpenCLArgMetadata(Fn, FD, this); 600 601 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) { 602 QualType HintQTy = A->getTypeHint(); 603 const ExtVectorType *HintEltQTy = HintQTy->getAs<ExtVectorType>(); 604 bool IsSignedInteger = 605 HintQTy->isSignedIntegerType() || 606 (HintEltQTy && HintEltQTy->getElementType()->isSignedIntegerType()); 607 llvm::Metadata *AttrMDArgs[] = { 608 llvm::ConstantAsMetadata::get(llvm::UndefValue::get( 609 CGM.getTypes().ConvertType(A->getTypeHint()))), 610 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get( 611 llvm::IntegerType::get(Context, 32), 612 llvm::APInt(32, (uint64_t)(IsSignedInteger ? 1 : 0))))}; 613 Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, AttrMDArgs)); 614 } 615 616 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) { 617 llvm::Metadata *AttrMDArgs[] = { 618 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())), 619 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())), 620 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))}; 621 Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, AttrMDArgs)); 622 } 623 624 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) { 625 llvm::Metadata *AttrMDArgs[] = { 626 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())), 627 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())), 628 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))}; 629 Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, AttrMDArgs)); 630 } 631 632 if (const OpenCLIntelReqdSubGroupSizeAttr *A = 633 FD->getAttr<OpenCLIntelReqdSubGroupSizeAttr>()) { 634 llvm::Metadata *AttrMDArgs[] = { 635 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getSubGroupSize()))}; 636 Fn->setMetadata("intel_reqd_sub_group_size", 637 llvm::MDNode::get(Context, AttrMDArgs)); 638 } 639 } 640 641 /// Determine whether the function F ends with a return stmt. 642 static bool endsWithReturn(const Decl* F) { 643 const Stmt *Body = nullptr; 644 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F)) 645 Body = FD->getBody(); 646 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F)) 647 Body = OMD->getBody(); 648 649 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) { 650 auto LastStmt = CS->body_rbegin(); 651 if (LastStmt != CS->body_rend()) 652 return isa<ReturnStmt>(*LastStmt); 653 } 654 return false; 655 } 656 657 void CodeGenFunction::markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) { 658 if (SanOpts.has(SanitizerKind::Thread)) { 659 Fn->addFnAttr("sanitize_thread_no_checking_at_run_time"); 660 Fn->removeFnAttr(llvm::Attribute::SanitizeThread); 661 } 662 } 663 664 /// Check if the return value of this function requires sanitization. 665 bool CodeGenFunction::requiresReturnValueCheck() const { 666 return requiresReturnValueNullabilityCheck() || 667 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) && CurCodeDecl && 668 CurCodeDecl->getAttr<ReturnsNonNullAttr>()); 669 } 670 671 static bool matchesStlAllocatorFn(const Decl *D, const ASTContext &Ctx) { 672 auto *MD = dyn_cast_or_null<CXXMethodDecl>(D); 673 if (!MD || !MD->getDeclName().getAsIdentifierInfo() || 674 !MD->getDeclName().getAsIdentifierInfo()->isStr("allocate") || 675 (MD->getNumParams() != 1 && MD->getNumParams() != 2)) 676 return false; 677 678 if (MD->parameters()[0]->getType().getCanonicalType() != Ctx.getSizeType()) 679 return false; 680 681 if (MD->getNumParams() == 2) { 682 auto *PT = MD->parameters()[1]->getType()->getAs<PointerType>(); 683 if (!PT || !PT->isVoidPointerType() || 684 !PT->getPointeeType().isConstQualified()) 685 return false; 686 } 687 688 return true; 689 } 690 691 /// Return the UBSan prologue signature for \p FD if one is available. 692 static llvm::Constant *getPrologueSignature(CodeGenModule &CGM, 693 const FunctionDecl *FD) { 694 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD)) 695 if (!MD->isStatic()) 696 return nullptr; 697 return CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM); 698 } 699 700 void CodeGenFunction::StartFunction(GlobalDecl GD, QualType RetTy, 701 llvm::Function *Fn, 702 const CGFunctionInfo &FnInfo, 703 const FunctionArgList &Args, 704 SourceLocation Loc, 705 SourceLocation StartLoc) { 706 assert(!CurFn && 707 "Do not use a CodeGenFunction object for more than one function"); 708 709 const Decl *D = GD.getDecl(); 710 711 DidCallStackSave = false; 712 CurCodeDecl = D; 713 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D)) 714 if (FD->usesSEHTry()) 715 CurSEHParent = FD; 716 CurFuncDecl = (D ? D->getNonClosureContext() : nullptr); 717 FnRetTy = RetTy; 718 CurFn = Fn; 719 CurFnInfo = &FnInfo; 720 assert(CurFn->isDeclaration() && "Function already has body?"); 721 722 // If this function has been blacklisted for any of the enabled sanitizers, 723 // disable the sanitizer for the function. 724 do { 725 #define SANITIZER(NAME, ID) \ 726 if (SanOpts.empty()) \ 727 break; \ 728 if (SanOpts.has(SanitizerKind::ID)) \ 729 if (CGM.isInSanitizerBlacklist(SanitizerKind::ID, Fn, Loc)) \ 730 SanOpts.set(SanitizerKind::ID, false); 731 732 #include "clang/Basic/Sanitizers.def" 733 #undef SANITIZER 734 } while (0); 735 736 if (D) { 737 // Apply the no_sanitize* attributes to SanOpts. 738 for (auto Attr : D->specific_attrs<NoSanitizeAttr>()) { 739 SanitizerMask mask = Attr->getMask(); 740 SanOpts.Mask &= ~mask; 741 if (mask & SanitizerKind::Address) 742 SanOpts.set(SanitizerKind::KernelAddress, false); 743 if (mask & SanitizerKind::KernelAddress) 744 SanOpts.set(SanitizerKind::Address, false); 745 if (mask & SanitizerKind::HWAddress) 746 SanOpts.set(SanitizerKind::KernelHWAddress, false); 747 if (mask & SanitizerKind::KernelHWAddress) 748 SanOpts.set(SanitizerKind::HWAddress, false); 749 } 750 } 751 752 // Apply sanitizer attributes to the function. 753 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress)) 754 Fn->addFnAttr(llvm::Attribute::SanitizeAddress); 755 if (SanOpts.hasOneOf(SanitizerKind::HWAddress | SanitizerKind::KernelHWAddress)) 756 Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress); 757 if (SanOpts.has(SanitizerKind::MemTag)) 758 Fn->addFnAttr(llvm::Attribute::SanitizeMemTag); 759 if (SanOpts.has(SanitizerKind::Thread)) 760 Fn->addFnAttr(llvm::Attribute::SanitizeThread); 761 if (SanOpts.hasOneOf(SanitizerKind::Memory | SanitizerKind::KernelMemory)) 762 Fn->addFnAttr(llvm::Attribute::SanitizeMemory); 763 if (SanOpts.has(SanitizerKind::SafeStack)) 764 Fn->addFnAttr(llvm::Attribute::SafeStack); 765 if (SanOpts.has(SanitizerKind::ShadowCallStack)) 766 Fn->addFnAttr(llvm::Attribute::ShadowCallStack); 767 768 // Apply fuzzing attribute to the function. 769 if (SanOpts.hasOneOf(SanitizerKind::Fuzzer | SanitizerKind::FuzzerNoLink)) 770 Fn->addFnAttr(llvm::Attribute::OptForFuzzing); 771 772 // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize, 773 // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time. 774 if (SanOpts.has(SanitizerKind::Thread)) { 775 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) { 776 IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0); 777 if (OMD->getMethodFamily() == OMF_dealloc || 778 OMD->getMethodFamily() == OMF_initialize || 779 (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) { 780 markAsIgnoreThreadCheckingAtRuntime(Fn); 781 } 782 } 783 } 784 785 // Ignore unrelated casts in STL allocate() since the allocator must cast 786 // from void* to T* before object initialization completes. Don't match on the 787 // namespace because not all allocators are in std:: 788 if (D && SanOpts.has(SanitizerKind::CFIUnrelatedCast)) { 789 if (matchesStlAllocatorFn(D, getContext())) 790 SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast; 791 } 792 793 // Ignore null checks in coroutine functions since the coroutines passes 794 // are not aware of how to move the extra UBSan instructions across the split 795 // coroutine boundaries. 796 if (D && SanOpts.has(SanitizerKind::Null)) 797 if (const auto *FD = dyn_cast<FunctionDecl>(D)) 798 if (FD->getBody() && 799 FD->getBody()->getStmtClass() == Stmt::CoroutineBodyStmtClass) 800 SanOpts.Mask &= ~SanitizerKind::Null; 801 802 if (D) { 803 // Apply xray attributes to the function (as a string, for now) 804 if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) { 805 if (CGM.getCodeGenOpts().XRayInstrumentationBundle.has( 806 XRayInstrKind::FunctionEntry) || 807 CGM.getCodeGenOpts().XRayInstrumentationBundle.has( 808 XRayInstrKind::FunctionExit)) { 809 if (XRayAttr->alwaysXRayInstrument() && ShouldXRayInstrumentFunction()) 810 Fn->addFnAttr("function-instrument", "xray-always"); 811 if (XRayAttr->neverXRayInstrument()) 812 Fn->addFnAttr("function-instrument", "xray-never"); 813 if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>()) 814 if (ShouldXRayInstrumentFunction()) 815 Fn->addFnAttr("xray-log-args", 816 llvm::utostr(LogArgs->getArgumentCount())); 817 } 818 } else { 819 if (ShouldXRayInstrumentFunction() && !CGM.imbueXRayAttrs(Fn, Loc)) 820 Fn->addFnAttr( 821 "xray-instruction-threshold", 822 llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold)); 823 } 824 825 if (ShouldXRayInstrumentFunction()) { 826 if (CGM.getCodeGenOpts().XRayIgnoreLoops) 827 Fn->addFnAttr("xray-ignore-loops"); 828 829 if (!CGM.getCodeGenOpts().XRayInstrumentationBundle.has( 830 XRayInstrKind::FunctionExit)) 831 Fn->addFnAttr("xray-skip-exit"); 832 833 if (!CGM.getCodeGenOpts().XRayInstrumentationBundle.has( 834 XRayInstrKind::FunctionEntry)) 835 Fn->addFnAttr("xray-skip-entry"); 836 } 837 838 unsigned Count, Offset; 839 if (const auto *Attr = D->getAttr<PatchableFunctionEntryAttr>()) { 840 Count = Attr->getCount(); 841 Offset = Attr->getOffset(); 842 } else { 843 Count = CGM.getCodeGenOpts().PatchableFunctionEntryCount; 844 Offset = CGM.getCodeGenOpts().PatchableFunctionEntryOffset; 845 } 846 if (Count && Offset <= Count) { 847 Fn->addFnAttr("patchable-function-entry", std::to_string(Count - Offset)); 848 if (Offset) 849 Fn->addFnAttr("patchable-function-prefix", std::to_string(Offset)); 850 } 851 } 852 853 // Add no-jump-tables value. 854 Fn->addFnAttr("no-jump-tables", 855 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables)); 856 857 // Add no-inline-line-tables value. 858 if (CGM.getCodeGenOpts().NoInlineLineTables) 859 Fn->addFnAttr("no-inline-line-tables"); 860 861 // Add profile-sample-accurate value. 862 if (CGM.getCodeGenOpts().ProfileSampleAccurate) 863 Fn->addFnAttr("profile-sample-accurate"); 864 865 if (D && D->hasAttr<CFICanonicalJumpTableAttr>()) 866 Fn->addFnAttr("cfi-canonical-jump-table"); 867 868 if (getLangOpts().OpenCL) { 869 // Add metadata for a kernel function. 870 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 871 EmitOpenCLKernelMetadata(FD, Fn); 872 } 873 874 // If we are checking function types, emit a function type signature as 875 // prologue data. 876 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) { 877 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) { 878 if (llvm::Constant *PrologueSig = getPrologueSignature(CGM, FD)) { 879 // Remove any (C++17) exception specifications, to allow calling e.g. a 880 // noexcept function through a non-noexcept pointer. 881 auto ProtoTy = 882 getContext().getFunctionTypeWithExceptionSpec(FD->getType(), 883 EST_None); 884 llvm::Constant *FTRTTIConst = 885 CGM.GetAddrOfRTTIDescriptor(ProtoTy, /*ForEH=*/true); 886 llvm::Constant *FTRTTIConstEncoded = 887 EncodeAddrForUseInPrologue(Fn, FTRTTIConst); 888 llvm::Constant *PrologueStructElems[] = {PrologueSig, 889 FTRTTIConstEncoded}; 890 llvm::Constant *PrologueStructConst = 891 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true); 892 Fn->setPrologueData(PrologueStructConst); 893 } 894 } 895 } 896 897 // If we're checking nullability, we need to know whether we can check the 898 // return value. Initialize the flag to 'true' and refine it in EmitParmDecl. 899 if (SanOpts.has(SanitizerKind::NullabilityReturn)) { 900 auto Nullability = FnRetTy->getNullability(getContext()); 901 if (Nullability && *Nullability == NullabilityKind::NonNull) { 902 if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) && 903 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>())) 904 RetValNullabilityPrecondition = 905 llvm::ConstantInt::getTrue(getLLVMContext()); 906 } 907 } 908 909 // If we're in C++ mode and the function name is "main", it is guaranteed 910 // to be norecurse by the standard (3.6.1.3 "The function main shall not be 911 // used within a program"). 912 if (getLangOpts().CPlusPlus) 913 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 914 if (FD->isMain()) 915 Fn->addFnAttr(llvm::Attribute::NoRecurse); 916 917 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 918 if (FD->usesFPIntrin()) 919 Fn->addFnAttr(llvm::Attribute::StrictFP); 920 921 // If a custom alignment is used, force realigning to this alignment on 922 // any main function which certainly will need it. 923 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 924 if ((FD->isMain() || FD->isMSVCRTEntryPoint()) && 925 CGM.getCodeGenOpts().StackAlignment) 926 Fn->addFnAttr("stackrealign"); 927 928 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn); 929 930 // Create a marker to make it easy to insert allocas into the entryblock 931 // later. Don't create this with the builder, because we don't want it 932 // folded. 933 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty); 934 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB); 935 936 ReturnBlock = getJumpDestInCurrentScope("return"); 937 938 Builder.SetInsertPoint(EntryBB); 939 940 // If we're checking the return value, allocate space for a pointer to a 941 // precise source location of the checked return statement. 942 if (requiresReturnValueCheck()) { 943 ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr"); 944 InitTempAlloca(ReturnLocation, llvm::ConstantPointerNull::get(Int8PtrTy)); 945 } 946 947 // Emit subprogram debug descriptor. 948 if (CGDebugInfo *DI = getDebugInfo()) { 949 // Reconstruct the type from the argument list so that implicit parameters, 950 // such as 'this' and 'vtt', show up in the debug info. Preserve the calling 951 // convention. 952 CallingConv CC = CallingConv::CC_C; 953 if (auto *FD = dyn_cast_or_null<FunctionDecl>(D)) 954 if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>()) 955 CC = SrcFnTy->getCallConv(); 956 SmallVector<QualType, 16> ArgTypes; 957 for (const VarDecl *VD : Args) 958 ArgTypes.push_back(VD->getType()); 959 QualType FnType = getContext().getFunctionType( 960 RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC)); 961 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, CurFuncIsThunk, 962 Builder); 963 } 964 965 if (ShouldInstrumentFunction()) { 966 if (CGM.getCodeGenOpts().InstrumentFunctions) 967 CurFn->addFnAttr("instrument-function-entry", "__cyg_profile_func_enter"); 968 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining) 969 CurFn->addFnAttr("instrument-function-entry-inlined", 970 "__cyg_profile_func_enter"); 971 if (CGM.getCodeGenOpts().InstrumentFunctionEntryBare) 972 CurFn->addFnAttr("instrument-function-entry-inlined", 973 "__cyg_profile_func_enter_bare"); 974 } 975 976 // Since emitting the mcount call here impacts optimizations such as function 977 // inlining, we just add an attribute to insert a mcount call in backend. 978 // The attribute "counting-function" is set to mcount function name which is 979 // architecture dependent. 980 if (CGM.getCodeGenOpts().InstrumentForProfiling) { 981 // Calls to fentry/mcount should not be generated if function has 982 // the no_instrument_function attribute. 983 if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) { 984 if (CGM.getCodeGenOpts().CallFEntry) 985 Fn->addFnAttr("fentry-call", "true"); 986 else { 987 Fn->addFnAttr("instrument-function-entry-inlined", 988 getTarget().getMCountName()); 989 } 990 if (CGM.getCodeGenOpts().MNopMCount) { 991 if (!CGM.getCodeGenOpts().CallFEntry) 992 CGM.getDiags().Report(diag::err_opt_not_valid_without_opt) 993 << "-mnop-mcount" << "-mfentry"; 994 Fn->addFnAttr("mnop-mcount"); 995 } 996 997 if (CGM.getCodeGenOpts().RecordMCount) { 998 if (!CGM.getCodeGenOpts().CallFEntry) 999 CGM.getDiags().Report(diag::err_opt_not_valid_without_opt) 1000 << "-mrecord-mcount" << "-mfentry"; 1001 Fn->addFnAttr("mrecord-mcount"); 1002 } 1003 } 1004 } 1005 1006 if (CGM.getCodeGenOpts().PackedStack) { 1007 if (getContext().getTargetInfo().getTriple().getArch() != 1008 llvm::Triple::systemz) 1009 CGM.getDiags().Report(diag::err_opt_not_valid_on_target) 1010 << "-mpacked-stack"; 1011 Fn->addFnAttr("packed-stack"); 1012 } 1013 1014 if (RetTy->isVoidType()) { 1015 // Void type; nothing to return. 1016 ReturnValue = Address::invalid(); 1017 1018 // Count the implicit return. 1019 if (!endsWithReturn(D)) 1020 ++NumReturnExprs; 1021 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect) { 1022 // Indirect return; emit returned value directly into sret slot. 1023 // This reduces code size, and affects correctness in C++. 1024 auto AI = CurFn->arg_begin(); 1025 if (CurFnInfo->getReturnInfo().isSRetAfterThis()) 1026 ++AI; 1027 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign()); 1028 if (!CurFnInfo->getReturnInfo().getIndirectByVal()) { 1029 ReturnValuePointer = 1030 CreateDefaultAlignTempAlloca(Int8PtrTy, "result.ptr"); 1031 Builder.CreateStore(Builder.CreatePointerBitCastOrAddrSpaceCast( 1032 ReturnValue.getPointer(), Int8PtrTy), 1033 ReturnValuePointer); 1034 } 1035 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca && 1036 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) { 1037 // Load the sret pointer from the argument struct and return into that. 1038 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex(); 1039 llvm::Function::arg_iterator EI = CurFn->arg_end(); 1040 --EI; 1041 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx); 1042 ReturnValuePointer = Address(Addr, getPointerAlign()); 1043 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result"); 1044 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy)); 1045 } else { 1046 ReturnValue = CreateIRTemp(RetTy, "retval"); 1047 1048 // Tell the epilog emitter to autorelease the result. We do this 1049 // now so that various specialized functions can suppress it 1050 // during their IR-generation. 1051 if (getLangOpts().ObjCAutoRefCount && 1052 !CurFnInfo->isReturnsRetained() && 1053 RetTy->isObjCRetainableType()) 1054 AutoreleaseResult = true; 1055 } 1056 1057 EmitStartEHSpec(CurCodeDecl); 1058 1059 PrologueCleanupDepth = EHStack.stable_begin(); 1060 1061 // Emit OpenMP specific initialization of the device functions. 1062 if (getLangOpts().OpenMP && CurCodeDecl) 1063 CGM.getOpenMPRuntime().emitFunctionProlog(*this, CurCodeDecl); 1064 1065 EmitFunctionProlog(*CurFnInfo, CurFn, Args); 1066 1067 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) { 1068 CGM.getCXXABI().EmitInstanceFunctionProlog(*this); 1069 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D); 1070 if (MD->getParent()->isLambda() && 1071 MD->getOverloadedOperator() == OO_Call) { 1072 // We're in a lambda; figure out the captures. 1073 MD->getParent()->getCaptureFields(LambdaCaptureFields, 1074 LambdaThisCaptureField); 1075 if (LambdaThisCaptureField) { 1076 // If the lambda captures the object referred to by '*this' - either by 1077 // value or by reference, make sure CXXThisValue points to the correct 1078 // object. 1079 1080 // Get the lvalue for the field (which is a copy of the enclosing object 1081 // or contains the address of the enclosing object). 1082 LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField); 1083 if (!LambdaThisCaptureField->getType()->isPointerType()) { 1084 // If the enclosing object was captured by value, just use its address. 1085 CXXThisValue = ThisFieldLValue.getAddress(*this).getPointer(); 1086 } else { 1087 // Load the lvalue pointed to by the field, since '*this' was captured 1088 // by reference. 1089 CXXThisValue = 1090 EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal(); 1091 } 1092 } 1093 for (auto *FD : MD->getParent()->fields()) { 1094 if (FD->hasCapturedVLAType()) { 1095 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD), 1096 SourceLocation()).getScalarVal(); 1097 auto VAT = FD->getCapturedVLAType(); 1098 VLASizeMap[VAT->getSizeExpr()] = ExprArg; 1099 } 1100 } 1101 } else { 1102 // Not in a lambda; just use 'this' from the method. 1103 // FIXME: Should we generate a new load for each use of 'this'? The 1104 // fast register allocator would be happier... 1105 CXXThisValue = CXXABIThisValue; 1106 } 1107 1108 // Check the 'this' pointer once per function, if it's available. 1109 if (CXXABIThisValue) { 1110 SanitizerSet SkippedChecks; 1111 SkippedChecks.set(SanitizerKind::ObjectSize, true); 1112 QualType ThisTy = MD->getThisType(); 1113 1114 // If this is the call operator of a lambda with no capture-default, it 1115 // may have a static invoker function, which may call this operator with 1116 // a null 'this' pointer. 1117 if (isLambdaCallOperator(MD) && 1118 MD->getParent()->getLambdaCaptureDefault() == LCD_None) 1119 SkippedChecks.set(SanitizerKind::Null, true); 1120 1121 EmitTypeCheck(isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall 1122 : TCK_MemberCall, 1123 Loc, CXXABIThisValue, ThisTy, 1124 getContext().getTypeAlignInChars(ThisTy->getPointeeType()), 1125 SkippedChecks); 1126 } 1127 } 1128 1129 // If any of the arguments have a variably modified type, make sure to 1130 // emit the type size. 1131 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end(); 1132 i != e; ++i) { 1133 const VarDecl *VD = *i; 1134 1135 // Dig out the type as written from ParmVarDecls; it's unclear whether 1136 // the standard (C99 6.9.1p10) requires this, but we're following the 1137 // precedent set by gcc. 1138 QualType Ty; 1139 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD)) 1140 Ty = PVD->getOriginalType(); 1141 else 1142 Ty = VD->getType(); 1143 1144 if (Ty->isVariablyModifiedType()) 1145 EmitVariablyModifiedType(Ty); 1146 } 1147 // Emit a location at the end of the prologue. 1148 if (CGDebugInfo *DI = getDebugInfo()) 1149 DI->EmitLocation(Builder, StartLoc); 1150 1151 // TODO: Do we need to handle this in two places like we do with 1152 // target-features/target-cpu? 1153 if (CurFuncDecl) 1154 if (const auto *VecWidth = CurFuncDecl->getAttr<MinVectorWidthAttr>()) 1155 LargestVectorWidth = VecWidth->getVectorWidth(); 1156 } 1157 1158 void CodeGenFunction::EmitFunctionBody(const Stmt *Body) { 1159 incrementProfileCounter(Body); 1160 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body)) 1161 EmitCompoundStmtWithoutScope(*S); 1162 else 1163 EmitStmt(Body); 1164 } 1165 1166 /// When instrumenting to collect profile data, the counts for some blocks 1167 /// such as switch cases need to not include the fall-through counts, so 1168 /// emit a branch around the instrumentation code. When not instrumenting, 1169 /// this just calls EmitBlock(). 1170 void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB, 1171 const Stmt *S) { 1172 llvm::BasicBlock *SkipCountBB = nullptr; 1173 if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) { 1174 // When instrumenting for profiling, the fallthrough to certain 1175 // statements needs to skip over the instrumentation code so that we 1176 // get an accurate count. 1177 SkipCountBB = createBasicBlock("skipcount"); 1178 EmitBranch(SkipCountBB); 1179 } 1180 EmitBlock(BB); 1181 uint64_t CurrentCount = getCurrentProfileCount(); 1182 incrementProfileCounter(S); 1183 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount); 1184 if (SkipCountBB) 1185 EmitBlock(SkipCountBB); 1186 } 1187 1188 /// Tries to mark the given function nounwind based on the 1189 /// non-existence of any throwing calls within it. We believe this is 1190 /// lightweight enough to do at -O0. 1191 static void TryMarkNoThrow(llvm::Function *F) { 1192 // LLVM treats 'nounwind' on a function as part of the type, so we 1193 // can't do this on functions that can be overwritten. 1194 if (F->isInterposable()) return; 1195 1196 for (llvm::BasicBlock &BB : *F) 1197 for (llvm::Instruction &I : BB) 1198 if (I.mayThrow()) 1199 return; 1200 1201 F->setDoesNotThrow(); 1202 } 1203 1204 QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD, 1205 FunctionArgList &Args) { 1206 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl()); 1207 QualType ResTy = FD->getReturnType(); 1208 1209 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD); 1210 if (MD && MD->isInstance()) { 1211 if (CGM.getCXXABI().HasThisReturn(GD)) 1212 ResTy = MD->getThisType(); 1213 else if (CGM.getCXXABI().hasMostDerivedReturn(GD)) 1214 ResTy = CGM.getContext().VoidPtrTy; 1215 CGM.getCXXABI().buildThisParam(*this, Args); 1216 } 1217 1218 // The base version of an inheriting constructor whose constructed base is a 1219 // virtual base is not passed any arguments (because it doesn't actually call 1220 // the inherited constructor). 1221 bool PassedParams = true; 1222 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD)) 1223 if (auto Inherited = CD->getInheritedConstructor()) 1224 PassedParams = 1225 getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType()); 1226 1227 if (PassedParams) { 1228 for (auto *Param : FD->parameters()) { 1229 Args.push_back(Param); 1230 if (!Param->hasAttr<PassObjectSizeAttr>()) 1231 continue; 1232 1233 auto *Implicit = ImplicitParamDecl::Create( 1234 getContext(), Param->getDeclContext(), Param->getLocation(), 1235 /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other); 1236 SizeArguments[Param] = Implicit; 1237 Args.push_back(Implicit); 1238 } 1239 } 1240 1241 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD))) 1242 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args); 1243 1244 return ResTy; 1245 } 1246 1247 static bool 1248 shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD, 1249 const ASTContext &Context) { 1250 QualType T = FD->getReturnType(); 1251 // Avoid the optimization for functions that return a record type with a 1252 // trivial destructor or another trivially copyable type. 1253 if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) { 1254 if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl())) 1255 return !ClassDecl->hasTrivialDestructor(); 1256 } 1257 return !T.isTriviallyCopyableType(Context); 1258 } 1259 1260 void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn, 1261 const CGFunctionInfo &FnInfo) { 1262 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl()); 1263 CurGD = GD; 1264 1265 FunctionArgList Args; 1266 QualType ResTy = BuildFunctionArgList(GD, Args); 1267 1268 // Check if we should generate debug info for this function. 1269 if (FD->hasAttr<NoDebugAttr>()) 1270 DebugInfo = nullptr; // disable debug info indefinitely for this function 1271 1272 // The function might not have a body if we're generating thunks for a 1273 // function declaration. 1274 SourceRange BodyRange; 1275 if (Stmt *Body = FD->getBody()) 1276 BodyRange = Body->getSourceRange(); 1277 else 1278 BodyRange = FD->getLocation(); 1279 CurEHLocation = BodyRange.getEnd(); 1280 1281 // Use the location of the start of the function to determine where 1282 // the function definition is located. By default use the location 1283 // of the declaration as the location for the subprogram. A function 1284 // may lack a declaration in the source code if it is created by code 1285 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk). 1286 SourceLocation Loc = FD->getLocation(); 1287 1288 // If this is a function specialization then use the pattern body 1289 // as the location for the function. 1290 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern()) 1291 if (SpecDecl->hasBody(SpecDecl)) 1292 Loc = SpecDecl->getLocation(); 1293 1294 Stmt *Body = FD->getBody(); 1295 1296 // Initialize helper which will detect jumps which can cause invalid lifetime 1297 // markers. 1298 if (Body && ShouldEmitLifetimeMarkers) 1299 Bypasses.Init(Body); 1300 1301 // Emit the standard function prologue. 1302 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin()); 1303 1304 // Generate the body of the function. 1305 PGO.assignRegionCounters(GD, CurFn); 1306 if (isa<CXXDestructorDecl>(FD)) 1307 EmitDestructorBody(Args); 1308 else if (isa<CXXConstructorDecl>(FD)) 1309 EmitConstructorBody(Args); 1310 else if (getLangOpts().CUDA && 1311 !getLangOpts().CUDAIsDevice && 1312 FD->hasAttr<CUDAGlobalAttr>()) 1313 CGM.getCUDARuntime().emitDeviceStub(*this, Args); 1314 else if (isa<CXXMethodDecl>(FD) && 1315 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) { 1316 // The lambda static invoker function is special, because it forwards or 1317 // clones the body of the function call operator (but is actually static). 1318 EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD)); 1319 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) && 1320 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() || 1321 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) { 1322 // Implicit copy-assignment gets the same special treatment as implicit 1323 // copy-constructors. 1324 emitImplicitAssignmentOperatorBody(Args); 1325 } else if (Body) { 1326 EmitFunctionBody(Body); 1327 } else 1328 llvm_unreachable("no definition for emitted function"); 1329 1330 // C++11 [stmt.return]p2: 1331 // Flowing off the end of a function [...] results in undefined behavior in 1332 // a value-returning function. 1333 // C11 6.9.1p12: 1334 // If the '}' that terminates a function is reached, and the value of the 1335 // function call is used by the caller, the behavior is undefined. 1336 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock && 1337 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) { 1338 bool ShouldEmitUnreachable = 1339 CGM.getCodeGenOpts().StrictReturn || 1340 shouldUseUndefinedBehaviorReturnOptimization(FD, getContext()); 1341 if (SanOpts.has(SanitizerKind::Return)) { 1342 SanitizerScope SanScope(this); 1343 llvm::Value *IsFalse = Builder.getFalse(); 1344 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return), 1345 SanitizerHandler::MissingReturn, 1346 EmitCheckSourceLocation(FD->getLocation()), None); 1347 } else if (ShouldEmitUnreachable) { 1348 if (CGM.getCodeGenOpts().OptimizationLevel == 0) 1349 EmitTrapCall(llvm::Intrinsic::trap); 1350 } 1351 if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) { 1352 Builder.CreateUnreachable(); 1353 Builder.ClearInsertionPoint(); 1354 } 1355 } 1356 1357 // Emit the standard function epilogue. 1358 FinishFunction(BodyRange.getEnd()); 1359 1360 // If we haven't marked the function nothrow through other means, do 1361 // a quick pass now to see if we can. 1362 if (!CurFn->doesNotThrow()) 1363 TryMarkNoThrow(CurFn); 1364 } 1365 1366 /// ContainsLabel - Return true if the statement contains a label in it. If 1367 /// this statement is not executed normally, it not containing a label means 1368 /// that we can just remove the code. 1369 bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) { 1370 // Null statement, not a label! 1371 if (!S) return false; 1372 1373 // If this is a label, we have to emit the code, consider something like: 1374 // if (0) { ... foo: bar(); } goto foo; 1375 // 1376 // TODO: If anyone cared, we could track __label__'s, since we know that you 1377 // can't jump to one from outside their declared region. 1378 if (isa<LabelStmt>(S)) 1379 return true; 1380 1381 // If this is a case/default statement, and we haven't seen a switch, we have 1382 // to emit the code. 1383 if (isa<SwitchCase>(S) && !IgnoreCaseStmts) 1384 return true; 1385 1386 // If this is a switch statement, we want to ignore cases below it. 1387 if (isa<SwitchStmt>(S)) 1388 IgnoreCaseStmts = true; 1389 1390 // Scan subexpressions for verboten labels. 1391 for (const Stmt *SubStmt : S->children()) 1392 if (ContainsLabel(SubStmt, IgnoreCaseStmts)) 1393 return true; 1394 1395 return false; 1396 } 1397 1398 /// containsBreak - Return true if the statement contains a break out of it. 1399 /// If the statement (recursively) contains a switch or loop with a break 1400 /// inside of it, this is fine. 1401 bool CodeGenFunction::containsBreak(const Stmt *S) { 1402 // Null statement, not a label! 1403 if (!S) return false; 1404 1405 // If this is a switch or loop that defines its own break scope, then we can 1406 // include it and anything inside of it. 1407 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) || 1408 isa<ForStmt>(S)) 1409 return false; 1410 1411 if (isa<BreakStmt>(S)) 1412 return true; 1413 1414 // Scan subexpressions for verboten breaks. 1415 for (const Stmt *SubStmt : S->children()) 1416 if (containsBreak(SubStmt)) 1417 return true; 1418 1419 return false; 1420 } 1421 1422 bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) { 1423 if (!S) return false; 1424 1425 // Some statement kinds add a scope and thus never add a decl to the current 1426 // scope. Note, this list is longer than the list of statements that might 1427 // have an unscoped decl nested within them, but this way is conservatively 1428 // correct even if more statement kinds are added. 1429 if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) || 1430 isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) || 1431 isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) || 1432 isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S)) 1433 return false; 1434 1435 if (isa<DeclStmt>(S)) 1436 return true; 1437 1438 for (const Stmt *SubStmt : S->children()) 1439 if (mightAddDeclToScope(SubStmt)) 1440 return true; 1441 1442 return false; 1443 } 1444 1445 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 1446 /// to a constant, or if it does but contains a label, return false. If it 1447 /// constant folds return true and set the boolean result in Result. 1448 bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond, 1449 bool &ResultBool, 1450 bool AllowLabels) { 1451 llvm::APSInt ResultInt; 1452 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels)) 1453 return false; 1454 1455 ResultBool = ResultInt.getBoolValue(); 1456 return true; 1457 } 1458 1459 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 1460 /// to a constant, or if it does but contains a label, return false. If it 1461 /// constant folds return true and set the folded value. 1462 bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond, 1463 llvm::APSInt &ResultInt, 1464 bool AllowLabels) { 1465 // FIXME: Rename and handle conversion of other evaluatable things 1466 // to bool. 1467 Expr::EvalResult Result; 1468 if (!Cond->EvaluateAsInt(Result, getContext())) 1469 return false; // Not foldable, not integer or not fully evaluatable. 1470 1471 llvm::APSInt Int = Result.Val.getInt(); 1472 if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond)) 1473 return false; // Contains a label. 1474 1475 ResultInt = Int; 1476 return true; 1477 } 1478 1479 1480 1481 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if 1482 /// statement) to the specified blocks. Based on the condition, this might try 1483 /// to simplify the codegen of the conditional based on the branch. 1484 /// 1485 void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond, 1486 llvm::BasicBlock *TrueBlock, 1487 llvm::BasicBlock *FalseBlock, 1488 uint64_t TrueCount) { 1489 Cond = Cond->IgnoreParens(); 1490 1491 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) { 1492 1493 // Handle X && Y in a condition. 1494 if (CondBOp->getOpcode() == BO_LAnd) { 1495 // If we have "1 && X", simplify the code. "0 && X" would have constant 1496 // folded if the case was simple enough. 1497 bool ConstantBool = false; 1498 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) && 1499 ConstantBool) { 1500 // br(1 && X) -> br(X). 1501 incrementProfileCounter(CondBOp); 1502 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, 1503 TrueCount); 1504 } 1505 1506 // If we have "X && 1", simplify the code to use an uncond branch. 1507 // "X && 0" would have been constant folded to 0. 1508 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) && 1509 ConstantBool) { 1510 // br(X && 1) -> br(X). 1511 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock, 1512 TrueCount); 1513 } 1514 1515 // Emit the LHS as a conditional. If the LHS conditional is false, we 1516 // want to jump to the FalseBlock. 1517 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true"); 1518 // The counter tells us how often we evaluate RHS, and all of TrueCount 1519 // can be propagated to that branch. 1520 uint64_t RHSCount = getProfileCount(CondBOp->getRHS()); 1521 1522 ConditionalEvaluation eval(*this); 1523 { 1524 ApplyDebugLocation DL(*this, Cond); 1525 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount); 1526 EmitBlock(LHSTrue); 1527 } 1528 1529 incrementProfileCounter(CondBOp); 1530 setCurrentProfileCount(getProfileCount(CondBOp->getRHS())); 1531 1532 // Any temporaries created here are conditional. 1533 eval.begin(*this); 1534 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount); 1535 eval.end(*this); 1536 1537 return; 1538 } 1539 1540 if (CondBOp->getOpcode() == BO_LOr) { 1541 // If we have "0 || X", simplify the code. "1 || X" would have constant 1542 // folded if the case was simple enough. 1543 bool ConstantBool = false; 1544 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) && 1545 !ConstantBool) { 1546 // br(0 || X) -> br(X). 1547 incrementProfileCounter(CondBOp); 1548 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, 1549 TrueCount); 1550 } 1551 1552 // If we have "X || 0", simplify the code to use an uncond branch. 1553 // "X || 1" would have been constant folded to 1. 1554 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) && 1555 !ConstantBool) { 1556 // br(X || 0) -> br(X). 1557 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock, 1558 TrueCount); 1559 } 1560 1561 // Emit the LHS as a conditional. If the LHS conditional is true, we 1562 // want to jump to the TrueBlock. 1563 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false"); 1564 // We have the count for entry to the RHS and for the whole expression 1565 // being true, so we can divy up True count between the short circuit and 1566 // the RHS. 1567 uint64_t LHSCount = 1568 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS()); 1569 uint64_t RHSCount = TrueCount - LHSCount; 1570 1571 ConditionalEvaluation eval(*this); 1572 { 1573 ApplyDebugLocation DL(*this, Cond); 1574 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount); 1575 EmitBlock(LHSFalse); 1576 } 1577 1578 incrementProfileCounter(CondBOp); 1579 setCurrentProfileCount(getProfileCount(CondBOp->getRHS())); 1580 1581 // Any temporaries created here are conditional. 1582 eval.begin(*this); 1583 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount); 1584 1585 eval.end(*this); 1586 1587 return; 1588 } 1589 } 1590 1591 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) { 1592 // br(!x, t, f) -> br(x, f, t) 1593 if (CondUOp->getOpcode() == UO_LNot) { 1594 // Negate the count. 1595 uint64_t FalseCount = getCurrentProfileCount() - TrueCount; 1596 // Negate the condition and swap the destination blocks. 1597 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock, 1598 FalseCount); 1599 } 1600 } 1601 1602 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) { 1603 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f)) 1604 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true"); 1605 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false"); 1606 1607 ConditionalEvaluation cond(*this); 1608 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock, 1609 getProfileCount(CondOp)); 1610 1611 // When computing PGO branch weights, we only know the overall count for 1612 // the true block. This code is essentially doing tail duplication of the 1613 // naive code-gen, introducing new edges for which counts are not 1614 // available. Divide the counts proportionally between the LHS and RHS of 1615 // the conditional operator. 1616 uint64_t LHSScaledTrueCount = 0; 1617 if (TrueCount) { 1618 double LHSRatio = 1619 getProfileCount(CondOp) / (double)getCurrentProfileCount(); 1620 LHSScaledTrueCount = TrueCount * LHSRatio; 1621 } 1622 1623 cond.begin(*this); 1624 EmitBlock(LHSBlock); 1625 incrementProfileCounter(CondOp); 1626 { 1627 ApplyDebugLocation DL(*this, Cond); 1628 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock, 1629 LHSScaledTrueCount); 1630 } 1631 cond.end(*this); 1632 1633 cond.begin(*this); 1634 EmitBlock(RHSBlock); 1635 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock, 1636 TrueCount - LHSScaledTrueCount); 1637 cond.end(*this); 1638 1639 return; 1640 } 1641 1642 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) { 1643 // Conditional operator handling can give us a throw expression as a 1644 // condition for a case like: 1645 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f) 1646 // Fold this to: 1647 // br(c, throw x, br(y, t, f)) 1648 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false); 1649 return; 1650 } 1651 1652 // If the branch has a condition wrapped by __builtin_unpredictable, 1653 // create metadata that specifies that the branch is unpredictable. 1654 // Don't bother if not optimizing because that metadata would not be used. 1655 llvm::MDNode *Unpredictable = nullptr; 1656 auto *Call = dyn_cast<CallExpr>(Cond->IgnoreImpCasts()); 1657 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) { 1658 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl()); 1659 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) { 1660 llvm::MDBuilder MDHelper(getLLVMContext()); 1661 Unpredictable = MDHelper.createUnpredictable(); 1662 } 1663 } 1664 1665 // Create branch weights based on the number of times we get here and the 1666 // number of times the condition should be true. 1667 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount); 1668 llvm::MDNode *Weights = 1669 createProfileWeights(TrueCount, CurrentCount - TrueCount); 1670 1671 // Emit the code with the fully general case. 1672 llvm::Value *CondV; 1673 { 1674 ApplyDebugLocation DL(*this, Cond); 1675 CondV = EvaluateExprAsBool(Cond); 1676 } 1677 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable); 1678 } 1679 1680 /// ErrorUnsupported - Print out an error that codegen doesn't support the 1681 /// specified stmt yet. 1682 void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) { 1683 CGM.ErrorUnsupported(S, Type); 1684 } 1685 1686 /// emitNonZeroVLAInit - Emit the "zero" initialization of a 1687 /// variable-length array whose elements have a non-zero bit-pattern. 1688 /// 1689 /// \param baseType the inner-most element type of the array 1690 /// \param src - a char* pointing to the bit-pattern for a single 1691 /// base element of the array 1692 /// \param sizeInChars - the total size of the VLA, in chars 1693 static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType, 1694 Address dest, Address src, 1695 llvm::Value *sizeInChars) { 1696 CGBuilderTy &Builder = CGF.Builder; 1697 1698 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType); 1699 llvm::Value *baseSizeInChars 1700 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity()); 1701 1702 Address begin = 1703 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin"); 1704 llvm::Value *end = 1705 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end"); 1706 1707 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock(); 1708 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop"); 1709 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont"); 1710 1711 // Make a loop over the VLA. C99 guarantees that the VLA element 1712 // count must be nonzero. 1713 CGF.EmitBlock(loopBB); 1714 1715 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur"); 1716 cur->addIncoming(begin.getPointer(), originBB); 1717 1718 CharUnits curAlign = 1719 dest.getAlignment().alignmentOfArrayElement(baseSize); 1720 1721 // memcpy the individual element bit-pattern. 1722 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars, 1723 /*volatile*/ false); 1724 1725 // Go to the next element. 1726 llvm::Value *next = 1727 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next"); 1728 1729 // Leave if that's the end of the VLA. 1730 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone"); 1731 Builder.CreateCondBr(done, contBB, loopBB); 1732 cur->addIncoming(next, loopBB); 1733 1734 CGF.EmitBlock(contBB); 1735 } 1736 1737 void 1738 CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) { 1739 // Ignore empty classes in C++. 1740 if (getLangOpts().CPlusPlus) { 1741 if (const RecordType *RT = Ty->getAs<RecordType>()) { 1742 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty()) 1743 return; 1744 } 1745 } 1746 1747 // Cast the dest ptr to the appropriate i8 pointer type. 1748 if (DestPtr.getElementType() != Int8Ty) 1749 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty); 1750 1751 // Get size and alignment info for this aggregate. 1752 CharUnits size = getContext().getTypeSizeInChars(Ty); 1753 1754 llvm::Value *SizeVal; 1755 const VariableArrayType *vla; 1756 1757 // Don't bother emitting a zero-byte memset. 1758 if (size.isZero()) { 1759 // But note that getTypeInfo returns 0 for a VLA. 1760 if (const VariableArrayType *vlaType = 1761 dyn_cast_or_null<VariableArrayType>( 1762 getContext().getAsArrayType(Ty))) { 1763 auto VlaSize = getVLASize(vlaType); 1764 SizeVal = VlaSize.NumElts; 1765 CharUnits eltSize = getContext().getTypeSizeInChars(VlaSize.Type); 1766 if (!eltSize.isOne()) 1767 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize)); 1768 vla = vlaType; 1769 } else { 1770 return; 1771 } 1772 } else { 1773 SizeVal = CGM.getSize(size); 1774 vla = nullptr; 1775 } 1776 1777 // If the type contains a pointer to data member we can't memset it to zero. 1778 // Instead, create a null constant and copy it to the destination. 1779 // TODO: there are other patterns besides zero that we can usefully memset, 1780 // like -1, which happens to be the pattern used by member-pointers. 1781 if (!CGM.getTypes().isZeroInitializable(Ty)) { 1782 // For a VLA, emit a single element, then splat that over the VLA. 1783 if (vla) Ty = getContext().getBaseElementType(vla); 1784 1785 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty); 1786 1787 llvm::GlobalVariable *NullVariable = 1788 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(), 1789 /*isConstant=*/true, 1790 llvm::GlobalVariable::PrivateLinkage, 1791 NullConstant, Twine()); 1792 CharUnits NullAlign = DestPtr.getAlignment(); 1793 NullVariable->setAlignment(NullAlign.getAsAlign()); 1794 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()), 1795 NullAlign); 1796 1797 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal); 1798 1799 // Get and call the appropriate llvm.memcpy overload. 1800 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false); 1801 return; 1802 } 1803 1804 // Otherwise, just memset the whole thing to zero. This is legal 1805 // because in LLVM, all default initializers (other than the ones we just 1806 // handled above) are guaranteed to have a bit pattern of all zeros. 1807 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false); 1808 } 1809 1810 llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) { 1811 // Make sure that there is a block for the indirect goto. 1812 if (!IndirectBranch) 1813 GetIndirectGotoBlock(); 1814 1815 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock(); 1816 1817 // Make sure the indirect branch includes all of the address-taken blocks. 1818 IndirectBranch->addDestination(BB); 1819 return llvm::BlockAddress::get(CurFn, BB); 1820 } 1821 1822 llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() { 1823 // If we already made the indirect branch for indirect goto, return its block. 1824 if (IndirectBranch) return IndirectBranch->getParent(); 1825 1826 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto")); 1827 1828 // Create the PHI node that indirect gotos will add entries to. 1829 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0, 1830 "indirect.goto.dest"); 1831 1832 // Create the indirect branch instruction. 1833 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal); 1834 return IndirectBranch->getParent(); 1835 } 1836 1837 /// Computes the length of an array in elements, as well as the base 1838 /// element type and a properly-typed first element pointer. 1839 llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType, 1840 QualType &baseType, 1841 Address &addr) { 1842 const ArrayType *arrayType = origArrayType; 1843 1844 // If it's a VLA, we have to load the stored size. Note that 1845 // this is the size of the VLA in bytes, not its size in elements. 1846 llvm::Value *numVLAElements = nullptr; 1847 if (isa<VariableArrayType>(arrayType)) { 1848 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).NumElts; 1849 1850 // Walk into all VLAs. This doesn't require changes to addr, 1851 // which has type T* where T is the first non-VLA element type. 1852 do { 1853 QualType elementType = arrayType->getElementType(); 1854 arrayType = getContext().getAsArrayType(elementType); 1855 1856 // If we only have VLA components, 'addr' requires no adjustment. 1857 if (!arrayType) { 1858 baseType = elementType; 1859 return numVLAElements; 1860 } 1861 } while (isa<VariableArrayType>(arrayType)); 1862 1863 // We get out here only if we find a constant array type 1864 // inside the VLA. 1865 } 1866 1867 // We have some number of constant-length arrays, so addr should 1868 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks 1869 // down to the first element of addr. 1870 SmallVector<llvm::Value*, 8> gepIndices; 1871 1872 // GEP down to the array type. 1873 llvm::ConstantInt *zero = Builder.getInt32(0); 1874 gepIndices.push_back(zero); 1875 1876 uint64_t countFromCLAs = 1; 1877 QualType eltType; 1878 1879 llvm::ArrayType *llvmArrayType = 1880 dyn_cast<llvm::ArrayType>(addr.getElementType()); 1881 while (llvmArrayType) { 1882 assert(isa<ConstantArrayType>(arrayType)); 1883 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue() 1884 == llvmArrayType->getNumElements()); 1885 1886 gepIndices.push_back(zero); 1887 countFromCLAs *= llvmArrayType->getNumElements(); 1888 eltType = arrayType->getElementType(); 1889 1890 llvmArrayType = 1891 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType()); 1892 arrayType = getContext().getAsArrayType(arrayType->getElementType()); 1893 assert((!llvmArrayType || arrayType) && 1894 "LLVM and Clang types are out-of-synch"); 1895 } 1896 1897 if (arrayType) { 1898 // From this point onwards, the Clang array type has been emitted 1899 // as some other type (probably a packed struct). Compute the array 1900 // size, and just emit the 'begin' expression as a bitcast. 1901 while (arrayType) { 1902 countFromCLAs *= 1903 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue(); 1904 eltType = arrayType->getElementType(); 1905 arrayType = getContext().getAsArrayType(eltType); 1906 } 1907 1908 llvm::Type *baseType = ConvertType(eltType); 1909 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin"); 1910 } else { 1911 // Create the actual GEP. 1912 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(), 1913 gepIndices, "array.begin"), 1914 addr.getAlignment()); 1915 } 1916 1917 baseType = eltType; 1918 1919 llvm::Value *numElements 1920 = llvm::ConstantInt::get(SizeTy, countFromCLAs); 1921 1922 // If we had any VLA dimensions, factor them in. 1923 if (numVLAElements) 1924 numElements = Builder.CreateNUWMul(numVLAElements, numElements); 1925 1926 return numElements; 1927 } 1928 1929 CodeGenFunction::VlaSizePair CodeGenFunction::getVLASize(QualType type) { 1930 const VariableArrayType *vla = getContext().getAsVariableArrayType(type); 1931 assert(vla && "type was not a variable array type!"); 1932 return getVLASize(vla); 1933 } 1934 1935 CodeGenFunction::VlaSizePair 1936 CodeGenFunction::getVLASize(const VariableArrayType *type) { 1937 // The number of elements so far; always size_t. 1938 llvm::Value *numElements = nullptr; 1939 1940 QualType elementType; 1941 do { 1942 elementType = type->getElementType(); 1943 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()]; 1944 assert(vlaSize && "no size for VLA!"); 1945 assert(vlaSize->getType() == SizeTy); 1946 1947 if (!numElements) { 1948 numElements = vlaSize; 1949 } else { 1950 // It's undefined behavior if this wraps around, so mark it that way. 1951 // FIXME: Teach -fsanitize=undefined to trap this. 1952 numElements = Builder.CreateNUWMul(numElements, vlaSize); 1953 } 1954 } while ((type = getContext().getAsVariableArrayType(elementType))); 1955 1956 return { numElements, elementType }; 1957 } 1958 1959 CodeGenFunction::VlaSizePair 1960 CodeGenFunction::getVLAElements1D(QualType type) { 1961 const VariableArrayType *vla = getContext().getAsVariableArrayType(type); 1962 assert(vla && "type was not a variable array type!"); 1963 return getVLAElements1D(vla); 1964 } 1965 1966 CodeGenFunction::VlaSizePair 1967 CodeGenFunction::getVLAElements1D(const VariableArrayType *Vla) { 1968 llvm::Value *VlaSize = VLASizeMap[Vla->getSizeExpr()]; 1969 assert(VlaSize && "no size for VLA!"); 1970 assert(VlaSize->getType() == SizeTy); 1971 return { VlaSize, Vla->getElementType() }; 1972 } 1973 1974 void CodeGenFunction::EmitVariablyModifiedType(QualType type) { 1975 assert(type->isVariablyModifiedType() && 1976 "Must pass variably modified type to EmitVLASizes!"); 1977 1978 EnsureInsertPoint(); 1979 1980 // We're going to walk down into the type and look for VLA 1981 // expressions. 1982 do { 1983 assert(type->isVariablyModifiedType()); 1984 1985 const Type *ty = type.getTypePtr(); 1986 switch (ty->getTypeClass()) { 1987 1988 #define TYPE(Class, Base) 1989 #define ABSTRACT_TYPE(Class, Base) 1990 #define NON_CANONICAL_TYPE(Class, Base) 1991 #define DEPENDENT_TYPE(Class, Base) case Type::Class: 1992 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) 1993 #include "clang/AST/TypeNodes.inc" 1994 llvm_unreachable("unexpected dependent type!"); 1995 1996 // These types are never variably-modified. 1997 case Type::Builtin: 1998 case Type::Complex: 1999 case Type::Vector: 2000 case Type::ExtVector: 2001 case Type::Record: 2002 case Type::Enum: 2003 case Type::Elaborated: 2004 case Type::TemplateSpecialization: 2005 case Type::ObjCTypeParam: 2006 case Type::ObjCObject: 2007 case Type::ObjCInterface: 2008 case Type::ObjCObjectPointer: 2009 llvm_unreachable("type class is never variably-modified!"); 2010 2011 case Type::Adjusted: 2012 type = cast<AdjustedType>(ty)->getAdjustedType(); 2013 break; 2014 2015 case Type::Decayed: 2016 type = cast<DecayedType>(ty)->getPointeeType(); 2017 break; 2018 2019 case Type::Pointer: 2020 type = cast<PointerType>(ty)->getPointeeType(); 2021 break; 2022 2023 case Type::BlockPointer: 2024 type = cast<BlockPointerType>(ty)->getPointeeType(); 2025 break; 2026 2027 case Type::LValueReference: 2028 case Type::RValueReference: 2029 type = cast<ReferenceType>(ty)->getPointeeType(); 2030 break; 2031 2032 case Type::MemberPointer: 2033 type = cast<MemberPointerType>(ty)->getPointeeType(); 2034 break; 2035 2036 case Type::ConstantArray: 2037 case Type::IncompleteArray: 2038 // Losing element qualification here is fine. 2039 type = cast<ArrayType>(ty)->getElementType(); 2040 break; 2041 2042 case Type::VariableArray: { 2043 // Losing element qualification here is fine. 2044 const VariableArrayType *vat = cast<VariableArrayType>(ty); 2045 2046 // Unknown size indication requires no size computation. 2047 // Otherwise, evaluate and record it. 2048 if (const Expr *size = vat->getSizeExpr()) { 2049 // It's possible that we might have emitted this already, 2050 // e.g. with a typedef and a pointer to it. 2051 llvm::Value *&entry = VLASizeMap[size]; 2052 if (!entry) { 2053 llvm::Value *Size = EmitScalarExpr(size); 2054 2055 // C11 6.7.6.2p5: 2056 // If the size is an expression that is not an integer constant 2057 // expression [...] each time it is evaluated it shall have a value 2058 // greater than zero. 2059 if (SanOpts.has(SanitizerKind::VLABound) && 2060 size->getType()->isSignedIntegerType()) { 2061 SanitizerScope SanScope(this); 2062 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType()); 2063 llvm::Constant *StaticArgs[] = { 2064 EmitCheckSourceLocation(size->getBeginLoc()), 2065 EmitCheckTypeDescriptor(size->getType())}; 2066 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero), 2067 SanitizerKind::VLABound), 2068 SanitizerHandler::VLABoundNotPositive, StaticArgs, Size); 2069 } 2070 2071 // Always zexting here would be wrong if it weren't 2072 // undefined behavior to have a negative bound. 2073 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false); 2074 } 2075 } 2076 type = vat->getElementType(); 2077 break; 2078 } 2079 2080 case Type::FunctionProto: 2081 case Type::FunctionNoProto: 2082 type = cast<FunctionType>(ty)->getReturnType(); 2083 break; 2084 2085 case Type::Paren: 2086 case Type::TypeOf: 2087 case Type::UnaryTransform: 2088 case Type::Attributed: 2089 case Type::SubstTemplateTypeParm: 2090 case Type::PackExpansion: 2091 case Type::MacroQualified: 2092 // Keep walking after single level desugaring. 2093 type = type.getSingleStepDesugaredType(getContext()); 2094 break; 2095 2096 case Type::Typedef: 2097 case Type::Decltype: 2098 case Type::Auto: 2099 case Type::DeducedTemplateSpecialization: 2100 // Stop walking: nothing to do. 2101 return; 2102 2103 case Type::TypeOfExpr: 2104 // Stop walking: emit typeof expression. 2105 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr()); 2106 return; 2107 2108 case Type::Atomic: 2109 type = cast<AtomicType>(ty)->getValueType(); 2110 break; 2111 2112 case Type::Pipe: 2113 type = cast<PipeType>(ty)->getElementType(); 2114 break; 2115 } 2116 } while (type->isVariablyModifiedType()); 2117 } 2118 2119 Address CodeGenFunction::EmitVAListRef(const Expr* E) { 2120 if (getContext().getBuiltinVaListType()->isArrayType()) 2121 return EmitPointerWithAlignment(E); 2122 return EmitLValue(E).getAddress(*this); 2123 } 2124 2125 Address CodeGenFunction::EmitMSVAListRef(const Expr *E) { 2126 return EmitLValue(E).getAddress(*this); 2127 } 2128 2129 void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E, 2130 const APValue &Init) { 2131 assert(Init.hasValue() && "Invalid DeclRefExpr initializer!"); 2132 if (CGDebugInfo *Dbg = getDebugInfo()) 2133 if (CGM.getCodeGenOpts().hasReducedDebugInfo()) 2134 Dbg->EmitGlobalVariable(E->getDecl(), Init); 2135 } 2136 2137 CodeGenFunction::PeepholeProtection 2138 CodeGenFunction::protectFromPeepholes(RValue rvalue) { 2139 // At the moment, the only aggressive peephole we do in IR gen 2140 // is trunc(zext) folding, but if we add more, we can easily 2141 // extend this protection. 2142 2143 if (!rvalue.isScalar()) return PeepholeProtection(); 2144 llvm::Value *value = rvalue.getScalarVal(); 2145 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection(); 2146 2147 // Just make an extra bitcast. 2148 assert(HaveInsertPoint()); 2149 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "", 2150 Builder.GetInsertBlock()); 2151 2152 PeepholeProtection protection; 2153 protection.Inst = inst; 2154 return protection; 2155 } 2156 2157 void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) { 2158 if (!protection.Inst) return; 2159 2160 // In theory, we could try to duplicate the peepholes now, but whatever. 2161 protection.Inst->eraseFromParent(); 2162 } 2163 2164 void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue, 2165 QualType Ty, SourceLocation Loc, 2166 SourceLocation AssumptionLoc, 2167 llvm::Value *Alignment, 2168 llvm::Value *OffsetValue) { 2169 llvm::Value *TheCheck; 2170 llvm::Instruction *Assumption = Builder.CreateAlignmentAssumption( 2171 CGM.getDataLayout(), PtrValue, Alignment, OffsetValue, &TheCheck); 2172 if (SanOpts.has(SanitizerKind::Alignment)) { 2173 EmitAlignmentAssumptionCheck(PtrValue, Ty, Loc, AssumptionLoc, Alignment, 2174 OffsetValue, TheCheck, Assumption); 2175 } 2176 } 2177 2178 void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue, 2179 const Expr *E, 2180 SourceLocation AssumptionLoc, 2181 llvm::Value *Alignment, 2182 llvm::Value *OffsetValue) { 2183 if (auto *CE = dyn_cast<CastExpr>(E)) 2184 E = CE->getSubExprAsWritten(); 2185 QualType Ty = E->getType(); 2186 SourceLocation Loc = E->getExprLoc(); 2187 2188 EmitAlignmentAssumption(PtrValue, Ty, Loc, AssumptionLoc, Alignment, 2189 OffsetValue); 2190 } 2191 2192 llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Function *AnnotationFn, 2193 llvm::Value *AnnotatedVal, 2194 StringRef AnnotationStr, 2195 SourceLocation Location) { 2196 llvm::Value *Args[4] = { 2197 AnnotatedVal, 2198 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy), 2199 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy), 2200 CGM.EmitAnnotationLineNo(Location) 2201 }; 2202 return Builder.CreateCall(AnnotationFn, Args); 2203 } 2204 2205 void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) { 2206 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute"); 2207 // FIXME We create a new bitcast for every annotation because that's what 2208 // llvm-gcc was doing. 2209 for (const auto *I : D->specific_attrs<AnnotateAttr>()) 2210 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation), 2211 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()), 2212 I->getAnnotation(), D->getLocation()); 2213 } 2214 2215 Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D, 2216 Address Addr) { 2217 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute"); 2218 llvm::Value *V = Addr.getPointer(); 2219 llvm::Type *VTy = V->getType(); 2220 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation, 2221 CGM.Int8PtrTy); 2222 2223 for (const auto *I : D->specific_attrs<AnnotateAttr>()) { 2224 // FIXME Always emit the cast inst so we can differentiate between 2225 // annotation on the first field of a struct and annotation on the struct 2226 // itself. 2227 if (VTy != CGM.Int8PtrTy) 2228 V = Builder.CreateBitCast(V, CGM.Int8PtrTy); 2229 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation()); 2230 V = Builder.CreateBitCast(V, VTy); 2231 } 2232 2233 return Address(V, Addr.getAlignment()); 2234 } 2235 2236 CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { } 2237 2238 CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF) 2239 : CGF(CGF) { 2240 assert(!CGF->IsSanitizerScope); 2241 CGF->IsSanitizerScope = true; 2242 } 2243 2244 CodeGenFunction::SanitizerScope::~SanitizerScope() { 2245 CGF->IsSanitizerScope = false; 2246 } 2247 2248 void CodeGenFunction::InsertHelper(llvm::Instruction *I, 2249 const llvm::Twine &Name, 2250 llvm::BasicBlock *BB, 2251 llvm::BasicBlock::iterator InsertPt) const { 2252 LoopStack.InsertHelper(I); 2253 if (IsSanitizerScope) 2254 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I); 2255 } 2256 2257 void CGBuilderInserter::InsertHelper( 2258 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB, 2259 llvm::BasicBlock::iterator InsertPt) const { 2260 llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt); 2261 if (CGF) 2262 CGF->InsertHelper(I, Name, BB, InsertPt); 2263 } 2264 2265 static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures, 2266 CodeGenModule &CGM, const FunctionDecl *FD, 2267 std::string &FirstMissing) { 2268 // If there aren't any required features listed then go ahead and return. 2269 if (ReqFeatures.empty()) 2270 return false; 2271 2272 // Now build up the set of caller features and verify that all the required 2273 // features are there. 2274 llvm::StringMap<bool> CallerFeatureMap; 2275 CGM.getContext().getFunctionFeatureMap(CallerFeatureMap, FD); 2276 2277 // If we have at least one of the features in the feature list return 2278 // true, otherwise return false. 2279 return std::all_of( 2280 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) { 2281 SmallVector<StringRef, 1> OrFeatures; 2282 Feature.split(OrFeatures, '|'); 2283 return llvm::any_of(OrFeatures, [&](StringRef Feature) { 2284 if (!CallerFeatureMap.lookup(Feature)) { 2285 FirstMissing = Feature.str(); 2286 return false; 2287 } 2288 return true; 2289 }); 2290 }); 2291 } 2292 2293 // Emits an error if we don't have a valid set of target features for the 2294 // called function. 2295 void CodeGenFunction::checkTargetFeatures(const CallExpr *E, 2296 const FunctionDecl *TargetDecl) { 2297 return checkTargetFeatures(E->getBeginLoc(), TargetDecl); 2298 } 2299 2300 // Emits an error if we don't have a valid set of target features for the 2301 // called function. 2302 void CodeGenFunction::checkTargetFeatures(SourceLocation Loc, 2303 const FunctionDecl *TargetDecl) { 2304 // Early exit if this is an indirect call. 2305 if (!TargetDecl) 2306 return; 2307 2308 // Get the current enclosing function if it exists. If it doesn't 2309 // we can't check the target features anyhow. 2310 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl); 2311 if (!FD) 2312 return; 2313 2314 // Grab the required features for the call. For a builtin this is listed in 2315 // the td file with the default cpu, for an always_inline function this is any 2316 // listed cpu and any listed features. 2317 unsigned BuiltinID = TargetDecl->getBuiltinID(); 2318 std::string MissingFeature; 2319 if (BuiltinID) { 2320 SmallVector<StringRef, 1> ReqFeatures; 2321 const char *FeatureList = 2322 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID); 2323 // Return if the builtin doesn't have any required features. 2324 if (!FeatureList || StringRef(FeatureList) == "") 2325 return; 2326 StringRef(FeatureList).split(ReqFeatures, ','); 2327 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature)) 2328 CGM.getDiags().Report(Loc, diag::err_builtin_needs_feature) 2329 << TargetDecl->getDeclName() 2330 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID); 2331 2332 } else if (!TargetDecl->isMultiVersion() && 2333 TargetDecl->hasAttr<TargetAttr>()) { 2334 // Get the required features for the callee. 2335 2336 const TargetAttr *TD = TargetDecl->getAttr<TargetAttr>(); 2337 ParsedTargetAttr ParsedAttr = 2338 CGM.getContext().filterFunctionTargetAttrs(TD); 2339 2340 SmallVector<StringRef, 1> ReqFeatures; 2341 llvm::StringMap<bool> CalleeFeatureMap; 2342 CGM.getContext().getFunctionFeatureMap(CalleeFeatureMap, 2343 GlobalDecl(TargetDecl)); 2344 2345 for (const auto &F : ParsedAttr.Features) { 2346 if (F[0] == '+' && CalleeFeatureMap.lookup(F.substr(1))) 2347 ReqFeatures.push_back(StringRef(F).substr(1)); 2348 } 2349 2350 for (const auto &F : CalleeFeatureMap) { 2351 // Only positive features are "required". 2352 if (F.getValue()) 2353 ReqFeatures.push_back(F.getKey()); 2354 } 2355 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature)) 2356 CGM.getDiags().Report(Loc, diag::err_function_needs_feature) 2357 << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature; 2358 } 2359 } 2360 2361 void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) { 2362 if (!CGM.getCodeGenOpts().SanitizeStats) 2363 return; 2364 2365 llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint()); 2366 IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation()); 2367 CGM.getSanStats().create(IRB, SSK); 2368 } 2369 2370 llvm::Value * 2371 CodeGenFunction::FormResolverCondition(const MultiVersionResolverOption &RO) { 2372 llvm::Value *Condition = nullptr; 2373 2374 if (!RO.Conditions.Architecture.empty()) 2375 Condition = EmitX86CpuIs(RO.Conditions.Architecture); 2376 2377 if (!RO.Conditions.Features.empty()) { 2378 llvm::Value *FeatureCond = EmitX86CpuSupports(RO.Conditions.Features); 2379 Condition = 2380 Condition ? Builder.CreateAnd(Condition, FeatureCond) : FeatureCond; 2381 } 2382 return Condition; 2383 } 2384 2385 static void CreateMultiVersionResolverReturn(CodeGenModule &CGM, 2386 llvm::Function *Resolver, 2387 CGBuilderTy &Builder, 2388 llvm::Function *FuncToReturn, 2389 bool SupportsIFunc) { 2390 if (SupportsIFunc) { 2391 Builder.CreateRet(FuncToReturn); 2392 return; 2393 } 2394 2395 llvm::SmallVector<llvm::Value *, 10> Args; 2396 llvm::for_each(Resolver->args(), 2397 [&](llvm::Argument &Arg) { Args.push_back(&Arg); }); 2398 2399 llvm::CallInst *Result = Builder.CreateCall(FuncToReturn, Args); 2400 Result->setTailCallKind(llvm::CallInst::TCK_MustTail); 2401 2402 if (Resolver->getReturnType()->isVoidTy()) 2403 Builder.CreateRetVoid(); 2404 else 2405 Builder.CreateRet(Result); 2406 } 2407 2408 void CodeGenFunction::EmitMultiVersionResolver( 2409 llvm::Function *Resolver, ArrayRef<MultiVersionResolverOption> Options) { 2410 assert(getContext().getTargetInfo().getTriple().isX86() && 2411 "Only implemented for x86 targets"); 2412 2413 bool SupportsIFunc = getContext().getTargetInfo().supportsIFunc(); 2414 2415 // Main function's basic block. 2416 llvm::BasicBlock *CurBlock = createBasicBlock("resolver_entry", Resolver); 2417 Builder.SetInsertPoint(CurBlock); 2418 EmitX86CpuInit(); 2419 2420 for (const MultiVersionResolverOption &RO : Options) { 2421 Builder.SetInsertPoint(CurBlock); 2422 llvm::Value *Condition = FormResolverCondition(RO); 2423 2424 // The 'default' or 'generic' case. 2425 if (!Condition) { 2426 assert(&RO == Options.end() - 1 && 2427 "Default or Generic case must be last"); 2428 CreateMultiVersionResolverReturn(CGM, Resolver, Builder, RO.Function, 2429 SupportsIFunc); 2430 return; 2431 } 2432 2433 llvm::BasicBlock *RetBlock = createBasicBlock("resolver_return", Resolver); 2434 CGBuilderTy RetBuilder(*this, RetBlock); 2435 CreateMultiVersionResolverReturn(CGM, Resolver, RetBuilder, RO.Function, 2436 SupportsIFunc); 2437 CurBlock = createBasicBlock("resolver_else", Resolver); 2438 Builder.CreateCondBr(Condition, RetBlock, CurBlock); 2439 } 2440 2441 // If no generic/default, emit an unreachable. 2442 Builder.SetInsertPoint(CurBlock); 2443 llvm::CallInst *TrapCall = EmitTrapCall(llvm::Intrinsic::trap); 2444 TrapCall->setDoesNotReturn(); 2445 TrapCall->setDoesNotThrow(); 2446 Builder.CreateUnreachable(); 2447 Builder.ClearInsertionPoint(); 2448 } 2449 2450 // Loc - where the diagnostic will point, where in the source code this 2451 // alignment has failed. 2452 // SecondaryLoc - if present (will be present if sufficiently different from 2453 // Loc), the diagnostic will additionally point a "Note:" to this location. 2454 // It should be the location where the __attribute__((assume_aligned)) 2455 // was written e.g. 2456 void CodeGenFunction::EmitAlignmentAssumptionCheck( 2457 llvm::Value *Ptr, QualType Ty, SourceLocation Loc, 2458 SourceLocation SecondaryLoc, llvm::Value *Alignment, 2459 llvm::Value *OffsetValue, llvm::Value *TheCheck, 2460 llvm::Instruction *Assumption) { 2461 assert(Assumption && isa<llvm::CallInst>(Assumption) && 2462 cast<llvm::CallInst>(Assumption)->getCalledValue() == 2463 llvm::Intrinsic::getDeclaration( 2464 Builder.GetInsertBlock()->getParent()->getParent(), 2465 llvm::Intrinsic::assume) && 2466 "Assumption should be a call to llvm.assume()."); 2467 assert(&(Builder.GetInsertBlock()->back()) == Assumption && 2468 "Assumption should be the last instruction of the basic block, " 2469 "since the basic block is still being generated."); 2470 2471 if (!SanOpts.has(SanitizerKind::Alignment)) 2472 return; 2473 2474 // Don't check pointers to volatile data. The behavior here is implementation- 2475 // defined. 2476 if (Ty->getPointeeType().isVolatileQualified()) 2477 return; 2478 2479 // We need to temorairly remove the assumption so we can insert the 2480 // sanitizer check before it, else the check will be dropped by optimizations. 2481 Assumption->removeFromParent(); 2482 2483 { 2484 SanitizerScope SanScope(this); 2485 2486 if (!OffsetValue) 2487 OffsetValue = Builder.getInt1(0); // no offset. 2488 2489 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(Loc), 2490 EmitCheckSourceLocation(SecondaryLoc), 2491 EmitCheckTypeDescriptor(Ty)}; 2492 llvm::Value *DynamicData[] = {EmitCheckValue(Ptr), 2493 EmitCheckValue(Alignment), 2494 EmitCheckValue(OffsetValue)}; 2495 EmitCheck({std::make_pair(TheCheck, SanitizerKind::Alignment)}, 2496 SanitizerHandler::AlignmentAssumption, StaticData, DynamicData); 2497 } 2498 2499 // We are now in the (new, empty) "cont" basic block. 2500 // Reintroduce the assumption. 2501 Builder.Insert(Assumption); 2502 // FIXME: Assumption still has it's original basic block as it's Parent. 2503 } 2504 2505 llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) { 2506 if (CGDebugInfo *DI = getDebugInfo()) 2507 return DI->SourceLocToDebugLoc(Location); 2508 2509 return llvm::DebugLoc(); 2510 } 2511