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