10b57cec5SDimitry Andric //===--- CodeGenFunction.cpp - Emit LLVM Code from ASTs for a Function ----===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This coordinates the per-function state used while generating code.
100b57cec5SDimitry Andric //
110b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
120b57cec5SDimitry Andric 
130b57cec5SDimitry Andric #include "CodeGenFunction.h"
140b57cec5SDimitry Andric #include "CGBlocks.h"
150b57cec5SDimitry Andric #include "CGCUDARuntime.h"
160b57cec5SDimitry Andric #include "CGCXXABI.h"
17480093f4SDimitry Andric #include "CGCleanup.h"
180b57cec5SDimitry Andric #include "CGDebugInfo.h"
190b57cec5SDimitry Andric #include "CGOpenMPRuntime.h"
200b57cec5SDimitry Andric #include "CodeGenModule.h"
210b57cec5SDimitry Andric #include "CodeGenPGO.h"
220b57cec5SDimitry Andric #include "TargetInfo.h"
230b57cec5SDimitry Andric #include "clang/AST/ASTContext.h"
240b57cec5SDimitry Andric #include "clang/AST/ASTLambda.h"
25480093f4SDimitry Andric #include "clang/AST/Attr.h"
260b57cec5SDimitry Andric #include "clang/AST/Decl.h"
270b57cec5SDimitry Andric #include "clang/AST/DeclCXX.h"
28e8d8bef9SDimitry Andric #include "clang/AST/Expr.h"
290b57cec5SDimitry Andric #include "clang/AST/StmtCXX.h"
300b57cec5SDimitry Andric #include "clang/AST/StmtObjC.h"
310b57cec5SDimitry Andric #include "clang/Basic/Builtins.h"
320b57cec5SDimitry Andric #include "clang/Basic/CodeGenOptions.h"
330b57cec5SDimitry Andric #include "clang/Basic/TargetInfo.h"
340b57cec5SDimitry Andric #include "clang/CodeGen/CGFunctionInfo.h"
350b57cec5SDimitry Andric #include "clang/Frontend/FrontendDiagnostic.h"
36e8d8bef9SDimitry Andric #include "llvm/ADT/ArrayRef.h"
375ffd83dbSDimitry Andric #include "llvm/Frontend/OpenMP/OMPIRBuilder.h"
380b57cec5SDimitry Andric #include "llvm/IR/DataLayout.h"
390b57cec5SDimitry Andric #include "llvm/IR/Dominators.h"
40480093f4SDimitry Andric #include "llvm/IR/FPEnv.h"
41480093f4SDimitry Andric #include "llvm/IR/IntrinsicInst.h"
420b57cec5SDimitry Andric #include "llvm/IR/Intrinsics.h"
430b57cec5SDimitry Andric #include "llvm/IR/MDBuilder.h"
440b57cec5SDimitry Andric #include "llvm/IR/Operator.h"
45e8d8bef9SDimitry Andric #include "llvm/Support/CRC.h"
46e8d8bef9SDimitry Andric #include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
470b57cec5SDimitry Andric #include "llvm/Transforms/Utils/PromoteMemToReg.h"
48349cc55cSDimitry Andric 
490b57cec5SDimitry Andric using namespace clang;
500b57cec5SDimitry Andric using namespace CodeGen;
510b57cec5SDimitry Andric 
520b57cec5SDimitry Andric /// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time
530b57cec5SDimitry Andric /// markers.
540b57cec5SDimitry Andric static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts,
550b57cec5SDimitry Andric                                       const LangOptions &LangOpts) {
560b57cec5SDimitry Andric   if (CGOpts.DisableLifetimeMarkers)
570b57cec5SDimitry Andric     return false;
580b57cec5SDimitry Andric 
59a7dea167SDimitry Andric   // Sanitizers may use markers.
60a7dea167SDimitry Andric   if (CGOpts.SanitizeAddressUseAfterScope ||
61a7dea167SDimitry Andric       LangOpts.Sanitize.has(SanitizerKind::HWAddress) ||
62a7dea167SDimitry Andric       LangOpts.Sanitize.has(SanitizerKind::Memory))
630b57cec5SDimitry Andric     return true;
640b57cec5SDimitry Andric 
650b57cec5SDimitry Andric   // For now, only in optimized builds.
660b57cec5SDimitry Andric   return CGOpts.OptimizationLevel != 0;
670b57cec5SDimitry Andric }
680b57cec5SDimitry Andric 
690b57cec5SDimitry Andric CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext)
700b57cec5SDimitry Andric     : CodeGenTypeCache(cgm), CGM(cgm), Target(cgm.getTarget()),
710b57cec5SDimitry Andric       Builder(cgm, cgm.getModule().getContext(), llvm::ConstantFolder(),
720b57cec5SDimitry Andric               CGBuilderInserterTy(this)),
735ffd83dbSDimitry Andric       SanOpts(CGM.getLangOpts().Sanitize), CurFPFeatures(CGM.getLangOpts()),
745ffd83dbSDimitry Andric       DebugInfo(CGM.getModuleDebugInfo()), PGO(cgm),
755ffd83dbSDimitry Andric       ShouldEmitLifetimeMarkers(
765ffd83dbSDimitry Andric           shouldEmitLifetimeMarkers(CGM.getCodeGenOpts(), CGM.getLangOpts())) {
770b57cec5SDimitry Andric   if (!suppressNewContext)
780b57cec5SDimitry Andric     CGM.getCXXABI().getMangleContext().startNewFunction();
79fe6060f1SDimitry Andric   EHStack.setCGF(this);
800b57cec5SDimitry Andric 
815ffd83dbSDimitry Andric   SetFastMathFlags(CurFPFeatures);
820b57cec5SDimitry Andric }
830b57cec5SDimitry Andric 
840b57cec5SDimitry Andric CodeGenFunction::~CodeGenFunction() {
850b57cec5SDimitry Andric   assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup");
860b57cec5SDimitry Andric 
870b57cec5SDimitry Andric   if (getLangOpts().OpenMP && CurFn)
880b57cec5SDimitry Andric     CGM.getOpenMPRuntime().functionFinished(*this);
890b57cec5SDimitry Andric 
905ffd83dbSDimitry Andric   // If we have an OpenMPIRBuilder we want to finalize functions (incl.
915ffd83dbSDimitry Andric   // outlining etc) at some point. Doing it once the function codegen is done
925ffd83dbSDimitry Andric   // seems to be a reasonable spot. We do it here, as opposed to the deletion
935ffd83dbSDimitry Andric   // time of the CodeGenModule, because we have to ensure the IR has not yet
945ffd83dbSDimitry Andric   // been "emitted" to the outside, thus, modifications are still sensible.
95fe6060f1SDimitry Andric   if (CGM.getLangOpts().OpenMPIRBuilder && CurFn)
96fe6060f1SDimitry Andric     CGM.getOpenMPRuntime().getOMPBuilder().finalize(CurFn);
97480093f4SDimitry Andric }
98480093f4SDimitry Andric 
99480093f4SDimitry Andric // Map the LangOption for exception behavior into
100480093f4SDimitry Andric // the corresponding enum in the IR.
1015ffd83dbSDimitry Andric llvm::fp::ExceptionBehavior
1025ffd83dbSDimitry Andric clang::ToConstrainedExceptMD(LangOptions::FPExceptionModeKind Kind) {
103480093f4SDimitry Andric 
104480093f4SDimitry Andric   switch (Kind) {
105480093f4SDimitry Andric   case LangOptions::FPE_Ignore:  return llvm::fp::ebIgnore;
106480093f4SDimitry Andric   case LangOptions::FPE_MayTrap: return llvm::fp::ebMayTrap;
107480093f4SDimitry Andric   case LangOptions::FPE_Strict:  return llvm::fp::ebStrict;
108480093f4SDimitry Andric   }
109480093f4SDimitry Andric   llvm_unreachable("Unsupported FP Exception Behavior");
110480093f4SDimitry Andric }
111480093f4SDimitry Andric 
1125ffd83dbSDimitry Andric void CodeGenFunction::SetFastMathFlags(FPOptions FPFeatures) {
1135ffd83dbSDimitry Andric   llvm::FastMathFlags FMF;
1145ffd83dbSDimitry Andric   FMF.setAllowReassoc(FPFeatures.getAllowFPReassociate());
1155ffd83dbSDimitry Andric   FMF.setNoNaNs(FPFeatures.getNoHonorNaNs());
1165ffd83dbSDimitry Andric   FMF.setNoInfs(FPFeatures.getNoHonorInfs());
1175ffd83dbSDimitry Andric   FMF.setNoSignedZeros(FPFeatures.getNoSignedZero());
1185ffd83dbSDimitry Andric   FMF.setAllowReciprocal(FPFeatures.getAllowReciprocal());
1195ffd83dbSDimitry Andric   FMF.setApproxFunc(FPFeatures.getAllowApproxFunc());
1205ffd83dbSDimitry Andric   FMF.setAllowContract(FPFeatures.allowFPContractAcrossStatement());
1215ffd83dbSDimitry Andric   Builder.setFastMathFlags(FMF);
1220b57cec5SDimitry Andric }
1230b57cec5SDimitry Andric 
1245ffd83dbSDimitry Andric CodeGenFunction::CGFPOptionsRAII::CGFPOptionsRAII(CodeGenFunction &CGF,
125e8d8bef9SDimitry Andric                                                   const Expr *E)
126e8d8bef9SDimitry Andric     : CGF(CGF) {
127e8d8bef9SDimitry Andric   ConstructorHelper(E->getFPFeaturesInEffect(CGF.getLangOpts()));
128e8d8bef9SDimitry Andric }
129e8d8bef9SDimitry Andric 
130e8d8bef9SDimitry Andric CodeGenFunction::CGFPOptionsRAII::CGFPOptionsRAII(CodeGenFunction &CGF,
1315ffd83dbSDimitry Andric                                                   FPOptions FPFeatures)
132e8d8bef9SDimitry Andric     : CGF(CGF) {
133e8d8bef9SDimitry Andric   ConstructorHelper(FPFeatures);
134e8d8bef9SDimitry Andric }
135e8d8bef9SDimitry Andric 
136e8d8bef9SDimitry Andric void CodeGenFunction::CGFPOptionsRAII::ConstructorHelper(FPOptions FPFeatures) {
137e8d8bef9SDimitry Andric   OldFPFeatures = CGF.CurFPFeatures;
1385ffd83dbSDimitry Andric   CGF.CurFPFeatures = FPFeatures;
1390b57cec5SDimitry Andric 
140e8d8bef9SDimitry Andric   OldExcept = CGF.Builder.getDefaultConstrainedExcept();
141e8d8bef9SDimitry Andric   OldRounding = CGF.Builder.getDefaultConstrainedRounding();
142e8d8bef9SDimitry Andric 
1435ffd83dbSDimitry Andric   if (OldFPFeatures == FPFeatures)
1445ffd83dbSDimitry Andric     return;
1455ffd83dbSDimitry Andric 
1465ffd83dbSDimitry Andric   FMFGuard.emplace(CGF.Builder);
1475ffd83dbSDimitry Andric 
1485ffd83dbSDimitry Andric   llvm::RoundingMode NewRoundingBehavior =
1495ffd83dbSDimitry Andric       static_cast<llvm::RoundingMode>(FPFeatures.getRoundingMode());
1505ffd83dbSDimitry Andric   CGF.Builder.setDefaultConstrainedRounding(NewRoundingBehavior);
1515ffd83dbSDimitry Andric   auto NewExceptionBehavior =
1525ffd83dbSDimitry Andric       ToConstrainedExceptMD(static_cast<LangOptions::FPExceptionModeKind>(
1535ffd83dbSDimitry Andric           FPFeatures.getFPExceptionMode()));
1545ffd83dbSDimitry Andric   CGF.Builder.setDefaultConstrainedExcept(NewExceptionBehavior);
1555ffd83dbSDimitry Andric 
1565ffd83dbSDimitry Andric   CGF.SetFastMathFlags(FPFeatures);
1575ffd83dbSDimitry Andric 
1585ffd83dbSDimitry Andric   assert((CGF.CurFuncDecl == nullptr || CGF.Builder.getIsFPConstrained() ||
1595ffd83dbSDimitry Andric           isa<CXXConstructorDecl>(CGF.CurFuncDecl) ||
1605ffd83dbSDimitry Andric           isa<CXXDestructorDecl>(CGF.CurFuncDecl) ||
1615ffd83dbSDimitry Andric           (NewExceptionBehavior == llvm::fp::ebIgnore &&
1625ffd83dbSDimitry Andric            NewRoundingBehavior == llvm::RoundingMode::NearestTiesToEven)) &&
1635ffd83dbSDimitry Andric          "FPConstrained should be enabled on entire function");
1645ffd83dbSDimitry Andric 
1655ffd83dbSDimitry Andric   auto mergeFnAttrValue = [&](StringRef Name, bool Value) {
1665ffd83dbSDimitry Andric     auto OldValue =
167fe6060f1SDimitry Andric         CGF.CurFn->getFnAttribute(Name).getValueAsBool();
1685ffd83dbSDimitry Andric     auto NewValue = OldValue & Value;
1695ffd83dbSDimitry Andric     if (OldValue != NewValue)
1705ffd83dbSDimitry Andric       CGF.CurFn->addFnAttr(Name, llvm::toStringRef(NewValue));
1715ffd83dbSDimitry Andric   };
1725ffd83dbSDimitry Andric   mergeFnAttrValue("no-infs-fp-math", FPFeatures.getNoHonorInfs());
1735ffd83dbSDimitry Andric   mergeFnAttrValue("no-nans-fp-math", FPFeatures.getNoHonorNaNs());
1745ffd83dbSDimitry Andric   mergeFnAttrValue("no-signed-zeros-fp-math", FPFeatures.getNoSignedZero());
1755ffd83dbSDimitry Andric   mergeFnAttrValue("unsafe-fp-math", FPFeatures.getAllowFPReassociate() &&
1765ffd83dbSDimitry Andric                                          FPFeatures.getAllowReciprocal() &&
1775ffd83dbSDimitry Andric                                          FPFeatures.getAllowApproxFunc() &&
1785ffd83dbSDimitry Andric                                          FPFeatures.getNoSignedZero());
1790b57cec5SDimitry Andric }
1800b57cec5SDimitry Andric 
1815ffd83dbSDimitry Andric CodeGenFunction::CGFPOptionsRAII::~CGFPOptionsRAII() {
1825ffd83dbSDimitry Andric   CGF.CurFPFeatures = OldFPFeatures;
183e8d8bef9SDimitry Andric   CGF.Builder.setDefaultConstrainedExcept(OldExcept);
184e8d8bef9SDimitry Andric   CGF.Builder.setDefaultConstrainedRounding(OldRounding);
1850b57cec5SDimitry Andric }
1860b57cec5SDimitry Andric 
1870b57cec5SDimitry Andric LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
1880b57cec5SDimitry Andric   LValueBaseInfo BaseInfo;
1890b57cec5SDimitry Andric   TBAAAccessInfo TBAAInfo;
1905ffd83dbSDimitry Andric   CharUnits Alignment = CGM.getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo);
1910eae32dcSDimitry Andric   Address Addr(V, ConvertTypeForMem(T), Alignment);
1920eae32dcSDimitry Andric   return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
1930b57cec5SDimitry Andric }
1940b57cec5SDimitry Andric 
1950b57cec5SDimitry Andric /// Given a value of type T* that may not be to a complete object,
1960b57cec5SDimitry Andric /// construct an l-value with the natural pointee alignment of T.
1970b57cec5SDimitry Andric LValue
1980b57cec5SDimitry Andric CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) {
1990b57cec5SDimitry Andric   LValueBaseInfo BaseInfo;
2000b57cec5SDimitry Andric   TBAAAccessInfo TBAAInfo;
2015ffd83dbSDimitry Andric   CharUnits Align = CGM.getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo,
2020b57cec5SDimitry Andric                                                 /* forPointeeType= */ true);
2030eae32dcSDimitry Andric   Address Addr(V, ConvertTypeForMem(T), Align);
2040eae32dcSDimitry Andric   return MakeAddrLValue(Addr, T, BaseInfo, TBAAInfo);
2050b57cec5SDimitry Andric }
2060b57cec5SDimitry Andric 
2070b57cec5SDimitry Andric 
2080b57cec5SDimitry Andric llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) {
2090b57cec5SDimitry Andric   return CGM.getTypes().ConvertTypeForMem(T);
2100b57cec5SDimitry Andric }
2110b57cec5SDimitry Andric 
2120b57cec5SDimitry Andric llvm::Type *CodeGenFunction::ConvertType(QualType T) {
2130b57cec5SDimitry Andric   return CGM.getTypes().ConvertType(T);
2140b57cec5SDimitry Andric }
2150b57cec5SDimitry Andric 
2160b57cec5SDimitry Andric TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) {
2170b57cec5SDimitry Andric   type = type.getCanonicalType();
2180b57cec5SDimitry Andric   while (true) {
2190b57cec5SDimitry Andric     switch (type->getTypeClass()) {
2200b57cec5SDimitry Andric #define TYPE(name, parent)
2210b57cec5SDimitry Andric #define ABSTRACT_TYPE(name, parent)
2220b57cec5SDimitry Andric #define NON_CANONICAL_TYPE(name, parent) case Type::name:
2230b57cec5SDimitry Andric #define DEPENDENT_TYPE(name, parent) case Type::name:
2240b57cec5SDimitry Andric #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name:
225a7dea167SDimitry Andric #include "clang/AST/TypeNodes.inc"
2260b57cec5SDimitry Andric       llvm_unreachable("non-canonical or dependent type in IR-generation");
2270b57cec5SDimitry Andric 
2280b57cec5SDimitry Andric     case Type::Auto:
2290b57cec5SDimitry Andric     case Type::DeducedTemplateSpecialization:
2300b57cec5SDimitry Andric       llvm_unreachable("undeduced type in IR-generation");
2310b57cec5SDimitry Andric 
2320b57cec5SDimitry Andric     // Various scalar types.
2330b57cec5SDimitry Andric     case Type::Builtin:
2340b57cec5SDimitry Andric     case Type::Pointer:
2350b57cec5SDimitry Andric     case Type::BlockPointer:
2360b57cec5SDimitry Andric     case Type::LValueReference:
2370b57cec5SDimitry Andric     case Type::RValueReference:
2380b57cec5SDimitry Andric     case Type::MemberPointer:
2390b57cec5SDimitry Andric     case Type::Vector:
2400b57cec5SDimitry Andric     case Type::ExtVector:
2415ffd83dbSDimitry Andric     case Type::ConstantMatrix:
2420b57cec5SDimitry Andric     case Type::FunctionProto:
2430b57cec5SDimitry Andric     case Type::FunctionNoProto:
2440b57cec5SDimitry Andric     case Type::Enum:
2450b57cec5SDimitry Andric     case Type::ObjCObjectPointer:
2460b57cec5SDimitry Andric     case Type::Pipe:
2470eae32dcSDimitry Andric     case Type::BitInt:
2480b57cec5SDimitry Andric       return TEK_Scalar;
2490b57cec5SDimitry Andric 
2500b57cec5SDimitry Andric     // Complexes.
2510b57cec5SDimitry Andric     case Type::Complex:
2520b57cec5SDimitry Andric       return TEK_Complex;
2530b57cec5SDimitry Andric 
2540b57cec5SDimitry Andric     // Arrays, records, and Objective-C objects.
2550b57cec5SDimitry Andric     case Type::ConstantArray:
2560b57cec5SDimitry Andric     case Type::IncompleteArray:
2570b57cec5SDimitry Andric     case Type::VariableArray:
2580b57cec5SDimitry Andric     case Type::Record:
2590b57cec5SDimitry Andric     case Type::ObjCObject:
2600b57cec5SDimitry Andric     case Type::ObjCInterface:
2610b57cec5SDimitry Andric       return TEK_Aggregate;
2620b57cec5SDimitry Andric 
2630b57cec5SDimitry Andric     // We operate on atomic values according to their underlying type.
2640b57cec5SDimitry Andric     case Type::Atomic:
2650b57cec5SDimitry Andric       type = cast<AtomicType>(type)->getValueType();
2660b57cec5SDimitry Andric       continue;
2670b57cec5SDimitry Andric     }
2680b57cec5SDimitry Andric     llvm_unreachable("unknown type kind!");
2690b57cec5SDimitry Andric   }
2700b57cec5SDimitry Andric }
2710b57cec5SDimitry Andric 
2720b57cec5SDimitry Andric llvm::DebugLoc CodeGenFunction::EmitReturnBlock() {
2730b57cec5SDimitry Andric   // For cleanliness, we try to avoid emitting the return block for
2740b57cec5SDimitry Andric   // simple cases.
2750b57cec5SDimitry Andric   llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
2760b57cec5SDimitry Andric 
2770b57cec5SDimitry Andric   if (CurBB) {
2780b57cec5SDimitry Andric     assert(!CurBB->getTerminator() && "Unexpected terminated block.");
2790b57cec5SDimitry Andric 
2800b57cec5SDimitry Andric     // We have a valid insert point, reuse it if it is empty or there are no
2810b57cec5SDimitry Andric     // explicit jumps to the return block.
2820b57cec5SDimitry Andric     if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) {
2830b57cec5SDimitry Andric       ReturnBlock.getBlock()->replaceAllUsesWith(CurBB);
2840b57cec5SDimitry Andric       delete ReturnBlock.getBlock();
2850b57cec5SDimitry Andric       ReturnBlock = JumpDest();
2860b57cec5SDimitry Andric     } else
2870b57cec5SDimitry Andric       EmitBlock(ReturnBlock.getBlock());
2880b57cec5SDimitry Andric     return llvm::DebugLoc();
2890b57cec5SDimitry Andric   }
2900b57cec5SDimitry Andric 
2910b57cec5SDimitry Andric   // Otherwise, if the return block is the target of a single direct
2920b57cec5SDimitry Andric   // branch then we can just put the code in that block instead. This
2930b57cec5SDimitry Andric   // cleans up functions which started with a unified return block.
2940b57cec5SDimitry Andric   if (ReturnBlock.getBlock()->hasOneUse()) {
2950b57cec5SDimitry Andric     llvm::BranchInst *BI =
2960b57cec5SDimitry Andric       dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin());
2970b57cec5SDimitry Andric     if (BI && BI->isUnconditional() &&
2980b57cec5SDimitry Andric         BI->getSuccessor(0) == ReturnBlock.getBlock()) {
2990b57cec5SDimitry Andric       // Record/return the DebugLoc of the simple 'return' expression to be used
3000b57cec5SDimitry Andric       // later by the actual 'ret' instruction.
3010b57cec5SDimitry Andric       llvm::DebugLoc Loc = BI->getDebugLoc();
3020b57cec5SDimitry Andric       Builder.SetInsertPoint(BI->getParent());
3030b57cec5SDimitry Andric       BI->eraseFromParent();
3040b57cec5SDimitry Andric       delete ReturnBlock.getBlock();
3050b57cec5SDimitry Andric       ReturnBlock = JumpDest();
3060b57cec5SDimitry Andric       return Loc;
3070b57cec5SDimitry Andric     }
3080b57cec5SDimitry Andric   }
3090b57cec5SDimitry Andric 
3100b57cec5SDimitry Andric   // FIXME: We are at an unreachable point, there is no reason to emit the block
3110b57cec5SDimitry Andric   // unless it has uses. However, we still need a place to put the debug
3120b57cec5SDimitry Andric   // region.end for now.
3130b57cec5SDimitry Andric 
3140b57cec5SDimitry Andric   EmitBlock(ReturnBlock.getBlock());
3150b57cec5SDimitry Andric   return llvm::DebugLoc();
3160b57cec5SDimitry Andric }
3170b57cec5SDimitry Andric 
3180b57cec5SDimitry Andric static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) {
3190b57cec5SDimitry Andric   if (!BB) return;
3200b57cec5SDimitry Andric   if (!BB->use_empty())
3210b57cec5SDimitry Andric     return CGF.CurFn->getBasicBlockList().push_back(BB);
3220b57cec5SDimitry Andric   delete BB;
3230b57cec5SDimitry Andric }
3240b57cec5SDimitry Andric 
3250b57cec5SDimitry Andric void CodeGenFunction::FinishFunction(SourceLocation EndLoc) {
3260b57cec5SDimitry Andric   assert(BreakContinueStack.empty() &&
3270b57cec5SDimitry Andric          "mismatched push/pop in break/continue stack!");
3280b57cec5SDimitry Andric 
3290b57cec5SDimitry Andric   bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0
3300b57cec5SDimitry Andric     && NumSimpleReturnExprs == NumReturnExprs
3310b57cec5SDimitry Andric     && ReturnBlock.getBlock()->use_empty();
3320b57cec5SDimitry Andric   // Usually the return expression is evaluated before the cleanup
3330b57cec5SDimitry Andric   // code.  If the function contains only a simple return statement,
3340b57cec5SDimitry Andric   // such as a constant, the location before the cleanup code becomes
3350b57cec5SDimitry Andric   // the last useful breakpoint in the function, because the simple
3360b57cec5SDimitry Andric   // return expression will be evaluated after the cleanup code. To be
3370b57cec5SDimitry Andric   // safe, set the debug location for cleanup code to the location of
3380b57cec5SDimitry Andric   // the return statement.  Otherwise the cleanup code should be at the
3390b57cec5SDimitry Andric   // end of the function's lexical scope.
3400b57cec5SDimitry Andric   //
3410b57cec5SDimitry Andric   // If there are multiple branches to the return block, the branch
3420b57cec5SDimitry Andric   // instructions will get the location of the return statements and
3430b57cec5SDimitry Andric   // all will be fine.
3440b57cec5SDimitry Andric   if (CGDebugInfo *DI = getDebugInfo()) {
3450b57cec5SDimitry Andric     if (OnlySimpleReturnStmts)
3460b57cec5SDimitry Andric       DI->EmitLocation(Builder, LastStopPoint);
3470b57cec5SDimitry Andric     else
3480b57cec5SDimitry Andric       DI->EmitLocation(Builder, EndLoc);
3490b57cec5SDimitry Andric   }
3500b57cec5SDimitry Andric 
3510b57cec5SDimitry Andric   // Pop any cleanups that might have been associated with the
3520b57cec5SDimitry Andric   // parameters.  Do this in whatever block we're currently in; it's
3530b57cec5SDimitry Andric   // important to do this before we enter the return block or return
3540b57cec5SDimitry Andric   // edges will be *really* confused.
3550b57cec5SDimitry Andric   bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth;
3560b57cec5SDimitry Andric   bool HasOnlyLifetimeMarkers =
3570b57cec5SDimitry Andric       HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth);
3580b57cec5SDimitry Andric   bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers;
3590b57cec5SDimitry Andric   if (HasCleanups) {
3600b57cec5SDimitry Andric     // Make sure the line table doesn't jump back into the body for
3610b57cec5SDimitry Andric     // the ret after it's been at EndLoc.
362480093f4SDimitry Andric     Optional<ApplyDebugLocation> AL;
363480093f4SDimitry Andric     if (CGDebugInfo *DI = getDebugInfo()) {
3640b57cec5SDimitry Andric       if (OnlySimpleReturnStmts)
3650b57cec5SDimitry Andric         DI->EmitLocation(Builder, EndLoc);
366480093f4SDimitry Andric       else
367480093f4SDimitry Andric         // We may not have a valid end location. Try to apply it anyway, and
368480093f4SDimitry Andric         // fall back to an artificial location if needed.
369480093f4SDimitry Andric         AL = ApplyDebugLocation::CreateDefaultArtificial(*this, EndLoc);
370480093f4SDimitry Andric     }
3710b57cec5SDimitry Andric 
3720b57cec5SDimitry Andric     PopCleanupBlocks(PrologueCleanupDepth);
3730b57cec5SDimitry Andric   }
3740b57cec5SDimitry Andric 
3750b57cec5SDimitry Andric   // Emit function epilog (to return).
3760b57cec5SDimitry Andric   llvm::DebugLoc Loc = EmitReturnBlock();
3770b57cec5SDimitry Andric 
3780b57cec5SDimitry Andric   if (ShouldInstrumentFunction()) {
3790b57cec5SDimitry Andric     if (CGM.getCodeGenOpts().InstrumentFunctions)
3800b57cec5SDimitry Andric       CurFn->addFnAttr("instrument-function-exit", "__cyg_profile_func_exit");
3810b57cec5SDimitry Andric     if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
3820b57cec5SDimitry Andric       CurFn->addFnAttr("instrument-function-exit-inlined",
3830b57cec5SDimitry Andric                        "__cyg_profile_func_exit");
3840b57cec5SDimitry Andric   }
3850b57cec5SDimitry Andric 
386349cc55cSDimitry Andric   if (ShouldSkipSanitizerInstrumentation())
387349cc55cSDimitry Andric     CurFn->addFnAttr(llvm::Attribute::DisableSanitizerInstrumentation);
388349cc55cSDimitry Andric 
3890b57cec5SDimitry Andric   // Emit debug descriptor for function end.
3900b57cec5SDimitry Andric   if (CGDebugInfo *DI = getDebugInfo())
3910b57cec5SDimitry Andric     DI->EmitFunctionEnd(Builder, CurFn);
3920b57cec5SDimitry Andric 
3930b57cec5SDimitry Andric   // Reset the debug location to that of the simple 'return' expression, if any
3940b57cec5SDimitry Andric   // rather than that of the end of the function's scope '}'.
3950b57cec5SDimitry Andric   ApplyDebugLocation AL(*this, Loc);
3960b57cec5SDimitry Andric   EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc);
3970b57cec5SDimitry Andric   EmitEndEHSpec(CurCodeDecl);
3980b57cec5SDimitry Andric 
3990b57cec5SDimitry Andric   assert(EHStack.empty() &&
4000b57cec5SDimitry Andric          "did not remove all scopes from cleanup stack!");
4010b57cec5SDimitry Andric 
4020b57cec5SDimitry Andric   // If someone did an indirect goto, emit the indirect goto block at the end of
4030b57cec5SDimitry Andric   // the function.
4040b57cec5SDimitry Andric   if (IndirectBranch) {
4050b57cec5SDimitry Andric     EmitBlock(IndirectBranch->getParent());
4060b57cec5SDimitry Andric     Builder.ClearInsertionPoint();
4070b57cec5SDimitry Andric   }
4080b57cec5SDimitry Andric 
4090b57cec5SDimitry Andric   // If some of our locals escaped, insert a call to llvm.localescape in the
4100b57cec5SDimitry Andric   // entry block.
4110b57cec5SDimitry Andric   if (!EscapedLocals.empty()) {
4120b57cec5SDimitry Andric     // Invert the map from local to index into a simple vector. There should be
4130b57cec5SDimitry Andric     // no holes.
4140b57cec5SDimitry Andric     SmallVector<llvm::Value *, 4> EscapeArgs;
4150b57cec5SDimitry Andric     EscapeArgs.resize(EscapedLocals.size());
4160b57cec5SDimitry Andric     for (auto &Pair : EscapedLocals)
4170b57cec5SDimitry Andric       EscapeArgs[Pair.second] = Pair.first;
4180b57cec5SDimitry Andric     llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration(
4190b57cec5SDimitry Andric         &CGM.getModule(), llvm::Intrinsic::localescape);
4200b57cec5SDimitry Andric     CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs);
4210b57cec5SDimitry Andric   }
4220b57cec5SDimitry Andric 
4230b57cec5SDimitry Andric   // Remove the AllocaInsertPt instruction, which is just a convenience for us.
4240b57cec5SDimitry Andric   llvm::Instruction *Ptr = AllocaInsertPt;
4250b57cec5SDimitry Andric   AllocaInsertPt = nullptr;
4260b57cec5SDimitry Andric   Ptr->eraseFromParent();
4270b57cec5SDimitry Andric 
428349cc55cSDimitry Andric   // PostAllocaInsertPt, if created, was lazily created when it was required,
429349cc55cSDimitry Andric   // remove it now since it was just created for our own convenience.
430349cc55cSDimitry Andric   if (PostAllocaInsertPt) {
431349cc55cSDimitry Andric     llvm::Instruction *PostPtr = PostAllocaInsertPt;
432349cc55cSDimitry Andric     PostAllocaInsertPt = nullptr;
433349cc55cSDimitry Andric     PostPtr->eraseFromParent();
434349cc55cSDimitry Andric   }
435349cc55cSDimitry Andric 
4360b57cec5SDimitry Andric   // If someone took the address of a label but never did an indirect goto, we
4370b57cec5SDimitry Andric   // made a zero entry PHI node, which is illegal, zap it now.
4380b57cec5SDimitry Andric   if (IndirectBranch) {
4390b57cec5SDimitry Andric     llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress());
4400b57cec5SDimitry Andric     if (PN->getNumIncomingValues() == 0) {
4410b57cec5SDimitry Andric       PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType()));
4420b57cec5SDimitry Andric       PN->eraseFromParent();
4430b57cec5SDimitry Andric     }
4440b57cec5SDimitry Andric   }
4450b57cec5SDimitry Andric 
4460b57cec5SDimitry Andric   EmitIfUsed(*this, EHResumeBlock);
4470b57cec5SDimitry Andric   EmitIfUsed(*this, TerminateLandingPad);
4480b57cec5SDimitry Andric   EmitIfUsed(*this, TerminateHandler);
4490b57cec5SDimitry Andric   EmitIfUsed(*this, UnreachableBlock);
4500b57cec5SDimitry Andric 
4510b57cec5SDimitry Andric   for (const auto &FuncletAndParent : TerminateFunclets)
4520b57cec5SDimitry Andric     EmitIfUsed(*this, FuncletAndParent.second);
4530b57cec5SDimitry Andric 
4540b57cec5SDimitry Andric   if (CGM.getCodeGenOpts().EmitDeclMetadata)
4550b57cec5SDimitry Andric     EmitDeclMetadata();
4560b57cec5SDimitry Andric 
457fe6060f1SDimitry Andric   for (const auto &R : DeferredReplacements) {
458fe6060f1SDimitry Andric     if (llvm::Value *Old = R.first) {
459fe6060f1SDimitry Andric       Old->replaceAllUsesWith(R.second);
460fe6060f1SDimitry Andric       cast<llvm::Instruction>(Old)->eraseFromParent();
4610b57cec5SDimitry Andric     }
462fe6060f1SDimitry Andric   }
463fe6060f1SDimitry Andric   DeferredReplacements.clear();
4640b57cec5SDimitry Andric 
4650b57cec5SDimitry Andric   // Eliminate CleanupDestSlot alloca by replacing it with SSA values and
4660b57cec5SDimitry Andric   // PHIs if the current function is a coroutine. We don't do it for all
4670b57cec5SDimitry Andric   // functions as it may result in slight increase in numbers of instructions
4680b57cec5SDimitry Andric   // if compiled with no optimizations. We do it for coroutine as the lifetime
4690b57cec5SDimitry Andric   // of CleanupDestSlot alloca make correct coroutine frame building very
4700b57cec5SDimitry Andric   // difficult.
4710b57cec5SDimitry Andric   if (NormalCleanupDest.isValid() && isCoroutine()) {
4720b57cec5SDimitry Andric     llvm::DominatorTree DT(*CurFn);
4730b57cec5SDimitry Andric     llvm::PromoteMemToReg(
4740b57cec5SDimitry Andric         cast<llvm::AllocaInst>(NormalCleanupDest.getPointer()), DT);
4750b57cec5SDimitry Andric     NormalCleanupDest = Address::invalid();
4760b57cec5SDimitry Andric   }
4770b57cec5SDimitry Andric 
4780b57cec5SDimitry Andric   // Scan function arguments for vector width.
4790b57cec5SDimitry Andric   for (llvm::Argument &A : CurFn->args())
4800b57cec5SDimitry Andric     if (auto *VT = dyn_cast<llvm::VectorType>(A.getType()))
4815ffd83dbSDimitry Andric       LargestVectorWidth =
4825ffd83dbSDimitry Andric           std::max((uint64_t)LargestVectorWidth,
4835ffd83dbSDimitry Andric                    VT->getPrimitiveSizeInBits().getKnownMinSize());
4840b57cec5SDimitry Andric 
4850b57cec5SDimitry Andric   // Update vector width based on return type.
4860b57cec5SDimitry Andric   if (auto *VT = dyn_cast<llvm::VectorType>(CurFn->getReturnType()))
4875ffd83dbSDimitry Andric     LargestVectorWidth =
4885ffd83dbSDimitry Andric         std::max((uint64_t)LargestVectorWidth,
4895ffd83dbSDimitry Andric                  VT->getPrimitiveSizeInBits().getKnownMinSize());
4900b57cec5SDimitry Andric 
4910b57cec5SDimitry Andric   // Add the required-vector-width attribute. This contains the max width from:
4920b57cec5SDimitry Andric   // 1. min-vector-width attribute used in the source program.
4930b57cec5SDimitry Andric   // 2. Any builtins used that have a vector width specified.
4940b57cec5SDimitry Andric   // 3. Values passed in and out of inline assembly.
4950b57cec5SDimitry Andric   // 4. Width of vector arguments and return types for this function.
4960b57cec5SDimitry Andric   // 5. Width of vector aguments and return types for functions called by this
4970b57cec5SDimitry Andric   //    function.
4980b57cec5SDimitry Andric   CurFn->addFnAttr("min-legal-vector-width", llvm::utostr(LargestVectorWidth));
4990b57cec5SDimitry Andric 
500349cc55cSDimitry Andric   // Add vscale_range attribute if appropriate.
501349cc55cSDimitry Andric   Optional<std::pair<unsigned, unsigned>> VScaleRange =
502349cc55cSDimitry Andric       getContext().getTargetInfo().getVScaleRange(getLangOpts());
503349cc55cSDimitry Andric   if (VScaleRange) {
504349cc55cSDimitry Andric     CurFn->addFnAttr(llvm::Attribute::getWithVScaleRangeArgs(
505349cc55cSDimitry Andric         getLLVMContext(), VScaleRange.getValue().first,
506349cc55cSDimitry Andric         VScaleRange.getValue().second));
507fe6060f1SDimitry Andric   }
508fe6060f1SDimitry Andric 
5090b57cec5SDimitry Andric   // If we generated an unreachable return block, delete it now.
5100b57cec5SDimitry Andric   if (ReturnBlock.isValid() && ReturnBlock.getBlock()->use_empty()) {
5110b57cec5SDimitry Andric     Builder.ClearInsertionPoint();
5120b57cec5SDimitry Andric     ReturnBlock.getBlock()->eraseFromParent();
5130b57cec5SDimitry Andric   }
5140b57cec5SDimitry Andric   if (ReturnValue.isValid()) {
5150b57cec5SDimitry Andric     auto *RetAlloca = dyn_cast<llvm::AllocaInst>(ReturnValue.getPointer());
5160b57cec5SDimitry Andric     if (RetAlloca && RetAlloca->use_empty()) {
5170b57cec5SDimitry Andric       RetAlloca->eraseFromParent();
5180b57cec5SDimitry Andric       ReturnValue = Address::invalid();
5190b57cec5SDimitry Andric     }
5200b57cec5SDimitry Andric   }
5210b57cec5SDimitry Andric }
5220b57cec5SDimitry Andric 
5230b57cec5SDimitry Andric /// ShouldInstrumentFunction - Return true if the current function should be
5240b57cec5SDimitry Andric /// instrumented with __cyg_profile_func_* calls
5250b57cec5SDimitry Andric bool CodeGenFunction::ShouldInstrumentFunction() {
5260b57cec5SDimitry Andric   if (!CGM.getCodeGenOpts().InstrumentFunctions &&
5270b57cec5SDimitry Andric       !CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining &&
5280b57cec5SDimitry Andric       !CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
5290b57cec5SDimitry Andric     return false;
5300b57cec5SDimitry Andric   if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
5310b57cec5SDimitry Andric     return false;
5320b57cec5SDimitry Andric   return true;
5330b57cec5SDimitry Andric }
5340b57cec5SDimitry Andric 
535349cc55cSDimitry Andric bool CodeGenFunction::ShouldSkipSanitizerInstrumentation() {
536349cc55cSDimitry Andric   if (!CurFuncDecl)
537349cc55cSDimitry Andric     return false;
538349cc55cSDimitry Andric   return CurFuncDecl->hasAttr<DisableSanitizerInstrumentationAttr>();
539349cc55cSDimitry Andric }
540349cc55cSDimitry Andric 
5410b57cec5SDimitry Andric /// ShouldXRayInstrument - Return true if the current function should be
5420b57cec5SDimitry Andric /// instrumented with XRay nop sleds.
5430b57cec5SDimitry Andric bool CodeGenFunction::ShouldXRayInstrumentFunction() const {
5440b57cec5SDimitry Andric   return CGM.getCodeGenOpts().XRayInstrumentFunctions;
5450b57cec5SDimitry Andric }
5460b57cec5SDimitry Andric 
5470b57cec5SDimitry Andric /// AlwaysEmitXRayCustomEvents - Return true if we should emit IR for calls to
5480b57cec5SDimitry Andric /// the __xray_customevent(...) builtin calls, when doing XRay instrumentation.
5490b57cec5SDimitry Andric bool CodeGenFunction::AlwaysEmitXRayCustomEvents() const {
5500b57cec5SDimitry Andric   return CGM.getCodeGenOpts().XRayInstrumentFunctions &&
5510b57cec5SDimitry Andric          (CGM.getCodeGenOpts().XRayAlwaysEmitCustomEvents ||
5520b57cec5SDimitry Andric           CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask ==
5530b57cec5SDimitry Andric               XRayInstrKind::Custom);
5540b57cec5SDimitry Andric }
5550b57cec5SDimitry Andric 
5560b57cec5SDimitry Andric bool CodeGenFunction::AlwaysEmitXRayTypedEvents() const {
5570b57cec5SDimitry Andric   return CGM.getCodeGenOpts().XRayInstrumentFunctions &&
5580b57cec5SDimitry Andric          (CGM.getCodeGenOpts().XRayAlwaysEmitTypedEvents ||
5590b57cec5SDimitry Andric           CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask ==
5600b57cec5SDimitry Andric               XRayInstrKind::Typed);
5610b57cec5SDimitry Andric }
5620b57cec5SDimitry Andric 
5630b57cec5SDimitry Andric llvm::Constant *
5640b57cec5SDimitry Andric CodeGenFunction::EncodeAddrForUseInPrologue(llvm::Function *F,
5650b57cec5SDimitry Andric                                             llvm::Constant *Addr) {
5660b57cec5SDimitry Andric   // Addresses stored in prologue data can't require run-time fixups and must
5670b57cec5SDimitry Andric   // be PC-relative. Run-time fixups are undesirable because they necessitate
5680b57cec5SDimitry Andric   // writable text segments, which are unsafe. And absolute addresses are
5690b57cec5SDimitry Andric   // undesirable because they break PIE mode.
5700b57cec5SDimitry Andric 
5710b57cec5SDimitry Andric   // Add a layer of indirection through a private global. Taking its address
5720b57cec5SDimitry Andric   // won't result in a run-time fixup, even if Addr has linkonce_odr linkage.
5730b57cec5SDimitry Andric   auto *GV = new llvm::GlobalVariable(CGM.getModule(), Addr->getType(),
5740b57cec5SDimitry Andric                                       /*isConstant=*/true,
5750b57cec5SDimitry Andric                                       llvm::GlobalValue::PrivateLinkage, Addr);
5760b57cec5SDimitry Andric 
5770b57cec5SDimitry Andric   // Create a PC-relative address.
5780b57cec5SDimitry Andric   auto *GOTAsInt = llvm::ConstantExpr::getPtrToInt(GV, IntPtrTy);
5790b57cec5SDimitry Andric   auto *FuncAsInt = llvm::ConstantExpr::getPtrToInt(F, IntPtrTy);
5800b57cec5SDimitry Andric   auto *PCRelAsInt = llvm::ConstantExpr::getSub(GOTAsInt, FuncAsInt);
5810b57cec5SDimitry Andric   return (IntPtrTy == Int32Ty)
5820b57cec5SDimitry Andric              ? PCRelAsInt
5830b57cec5SDimitry Andric              : llvm::ConstantExpr::getTrunc(PCRelAsInt, Int32Ty);
5840b57cec5SDimitry Andric }
5850b57cec5SDimitry Andric 
5860b57cec5SDimitry Andric llvm::Value *
5870b57cec5SDimitry Andric CodeGenFunction::DecodeAddrUsedInPrologue(llvm::Value *F,
5880b57cec5SDimitry Andric                                           llvm::Value *EncodedAddr) {
5890b57cec5SDimitry Andric   // Reconstruct the address of the global.
5900b57cec5SDimitry Andric   auto *PCRelAsInt = Builder.CreateSExt(EncodedAddr, IntPtrTy);
5910b57cec5SDimitry Andric   auto *FuncAsInt = Builder.CreatePtrToInt(F, IntPtrTy, "func_addr.int");
5920b57cec5SDimitry Andric   auto *GOTAsInt = Builder.CreateAdd(PCRelAsInt, FuncAsInt, "global_addr.int");
5930b57cec5SDimitry Andric   auto *GOTAddr = Builder.CreateIntToPtr(GOTAsInt, Int8PtrPtrTy, "global_addr");
5940b57cec5SDimitry Andric 
5950b57cec5SDimitry Andric   // Load the original pointer through the global.
5960b57cec5SDimitry Andric   return Builder.CreateLoad(Address(GOTAddr, getPointerAlign()),
5970b57cec5SDimitry Andric                             "decoded_addr");
5980b57cec5SDimitry Andric }
5990b57cec5SDimitry Andric 
6000b57cec5SDimitry Andric void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
6010b57cec5SDimitry Andric                                                llvm::Function *Fn)
6020b57cec5SDimitry Andric {
6030b57cec5SDimitry Andric   if (!FD->hasAttr<OpenCLKernelAttr>())
6040b57cec5SDimitry Andric     return;
6050b57cec5SDimitry Andric 
6060b57cec5SDimitry Andric   llvm::LLVMContext &Context = getLLVMContext();
6070b57cec5SDimitry Andric 
6080b57cec5SDimitry Andric   CGM.GenOpenCLArgMetadata(Fn, FD, this);
6090b57cec5SDimitry Andric 
6100b57cec5SDimitry Andric   if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) {
6110b57cec5SDimitry Andric     QualType HintQTy = A->getTypeHint();
6120b57cec5SDimitry Andric     const ExtVectorType *HintEltQTy = HintQTy->getAs<ExtVectorType>();
6130b57cec5SDimitry Andric     bool IsSignedInteger =
6140b57cec5SDimitry Andric         HintQTy->isSignedIntegerType() ||
6150b57cec5SDimitry Andric         (HintEltQTy && HintEltQTy->getElementType()->isSignedIntegerType());
6160b57cec5SDimitry Andric     llvm::Metadata *AttrMDArgs[] = {
6170b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(llvm::UndefValue::get(
6180b57cec5SDimitry Andric             CGM.getTypes().ConvertType(A->getTypeHint()))),
6190b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
6200b57cec5SDimitry Andric             llvm::IntegerType::get(Context, 32),
6210b57cec5SDimitry Andric             llvm::APInt(32, (uint64_t)(IsSignedInteger ? 1 : 0))))};
6220b57cec5SDimitry Andric     Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, AttrMDArgs));
6230b57cec5SDimitry Andric   }
6240b57cec5SDimitry Andric 
6250b57cec5SDimitry Andric   if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) {
6260b57cec5SDimitry Andric     llvm::Metadata *AttrMDArgs[] = {
6270b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
6280b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
6290b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
6300b57cec5SDimitry Andric     Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, AttrMDArgs));
6310b57cec5SDimitry Andric   }
6320b57cec5SDimitry Andric 
6330b57cec5SDimitry Andric   if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) {
6340b57cec5SDimitry Andric     llvm::Metadata *AttrMDArgs[] = {
6350b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
6360b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
6370b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
6380b57cec5SDimitry Andric     Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, AttrMDArgs));
6390b57cec5SDimitry Andric   }
6400b57cec5SDimitry Andric 
6410b57cec5SDimitry Andric   if (const OpenCLIntelReqdSubGroupSizeAttr *A =
6420b57cec5SDimitry Andric           FD->getAttr<OpenCLIntelReqdSubGroupSizeAttr>()) {
6430b57cec5SDimitry Andric     llvm::Metadata *AttrMDArgs[] = {
6440b57cec5SDimitry Andric         llvm::ConstantAsMetadata::get(Builder.getInt32(A->getSubGroupSize()))};
6450b57cec5SDimitry Andric     Fn->setMetadata("intel_reqd_sub_group_size",
6460b57cec5SDimitry Andric                     llvm::MDNode::get(Context, AttrMDArgs));
6470b57cec5SDimitry Andric   }
6480b57cec5SDimitry Andric }
6490b57cec5SDimitry Andric 
6500b57cec5SDimitry Andric /// Determine whether the function F ends with a return stmt.
6510b57cec5SDimitry Andric static bool endsWithReturn(const Decl* F) {
6520b57cec5SDimitry Andric   const Stmt *Body = nullptr;
6530b57cec5SDimitry Andric   if (auto *FD = dyn_cast_or_null<FunctionDecl>(F))
6540b57cec5SDimitry Andric     Body = FD->getBody();
6550b57cec5SDimitry Andric   else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F))
6560b57cec5SDimitry Andric     Body = OMD->getBody();
6570b57cec5SDimitry Andric 
6580b57cec5SDimitry Andric   if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) {
6590b57cec5SDimitry Andric     auto LastStmt = CS->body_rbegin();
6600b57cec5SDimitry Andric     if (LastStmt != CS->body_rend())
6610b57cec5SDimitry Andric       return isa<ReturnStmt>(*LastStmt);
6620b57cec5SDimitry Andric   }
6630b57cec5SDimitry Andric   return false;
6640b57cec5SDimitry Andric }
6650b57cec5SDimitry Andric 
6660b57cec5SDimitry Andric void CodeGenFunction::markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) {
6670b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::Thread)) {
6680b57cec5SDimitry Andric     Fn->addFnAttr("sanitize_thread_no_checking_at_run_time");
6690b57cec5SDimitry Andric     Fn->removeFnAttr(llvm::Attribute::SanitizeThread);
6700b57cec5SDimitry Andric   }
6710b57cec5SDimitry Andric }
6720b57cec5SDimitry Andric 
673480093f4SDimitry Andric /// Check if the return value of this function requires sanitization.
674480093f4SDimitry Andric bool CodeGenFunction::requiresReturnValueCheck() const {
675480093f4SDimitry Andric   return requiresReturnValueNullabilityCheck() ||
676480093f4SDimitry Andric          (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) && CurCodeDecl &&
677480093f4SDimitry Andric           CurCodeDecl->getAttr<ReturnsNonNullAttr>());
678480093f4SDimitry Andric }
679480093f4SDimitry Andric 
6800b57cec5SDimitry Andric static bool matchesStlAllocatorFn(const Decl *D, const ASTContext &Ctx) {
6810b57cec5SDimitry Andric   auto *MD = dyn_cast_or_null<CXXMethodDecl>(D);
6820b57cec5SDimitry Andric   if (!MD || !MD->getDeclName().getAsIdentifierInfo() ||
6830b57cec5SDimitry Andric       !MD->getDeclName().getAsIdentifierInfo()->isStr("allocate") ||
6840b57cec5SDimitry Andric       (MD->getNumParams() != 1 && MD->getNumParams() != 2))
6850b57cec5SDimitry Andric     return false;
6860b57cec5SDimitry Andric 
6870b57cec5SDimitry Andric   if (MD->parameters()[0]->getType().getCanonicalType() != Ctx.getSizeType())
6880b57cec5SDimitry Andric     return false;
6890b57cec5SDimitry Andric 
6900b57cec5SDimitry Andric   if (MD->getNumParams() == 2) {
6910b57cec5SDimitry Andric     auto *PT = MD->parameters()[1]->getType()->getAs<PointerType>();
6920b57cec5SDimitry Andric     if (!PT || !PT->isVoidPointerType() ||
6930b57cec5SDimitry Andric         !PT->getPointeeType().isConstQualified())
6940b57cec5SDimitry Andric       return false;
6950b57cec5SDimitry Andric   }
6960b57cec5SDimitry Andric 
6970b57cec5SDimitry Andric   return true;
6980b57cec5SDimitry Andric }
6990b57cec5SDimitry Andric 
7000b57cec5SDimitry Andric /// Return the UBSan prologue signature for \p FD if one is available.
7010b57cec5SDimitry Andric static llvm::Constant *getPrologueSignature(CodeGenModule &CGM,
7020b57cec5SDimitry Andric                                             const FunctionDecl *FD) {
7030b57cec5SDimitry Andric   if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
7040b57cec5SDimitry Andric     if (!MD->isStatic())
7050b57cec5SDimitry Andric       return nullptr;
7060b57cec5SDimitry Andric   return CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM);
7070b57cec5SDimitry Andric }
7080b57cec5SDimitry Andric 
709480093f4SDimitry Andric void CodeGenFunction::StartFunction(GlobalDecl GD, QualType RetTy,
7100b57cec5SDimitry Andric                                     llvm::Function *Fn,
7110b57cec5SDimitry Andric                                     const CGFunctionInfo &FnInfo,
7120b57cec5SDimitry Andric                                     const FunctionArgList &Args,
7130b57cec5SDimitry Andric                                     SourceLocation Loc,
7140b57cec5SDimitry Andric                                     SourceLocation StartLoc) {
7150b57cec5SDimitry Andric   assert(!CurFn &&
7160b57cec5SDimitry Andric          "Do not use a CodeGenFunction object for more than one function");
7170b57cec5SDimitry Andric 
7180b57cec5SDimitry Andric   const Decl *D = GD.getDecl();
7190b57cec5SDimitry Andric 
7200b57cec5SDimitry Andric   DidCallStackSave = false;
7210b57cec5SDimitry Andric   CurCodeDecl = D;
722fe6060f1SDimitry Andric   const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D);
723fe6060f1SDimitry Andric   if (FD && FD->usesSEHTry())
7240b57cec5SDimitry Andric     CurSEHParent = FD;
7250b57cec5SDimitry Andric   CurFuncDecl = (D ? D->getNonClosureContext() : nullptr);
7260b57cec5SDimitry Andric   FnRetTy = RetTy;
7270b57cec5SDimitry Andric   CurFn = Fn;
7280b57cec5SDimitry Andric   CurFnInfo = &FnInfo;
7290b57cec5SDimitry Andric   assert(CurFn->isDeclaration() && "Function already has body?");
7300b57cec5SDimitry Andric 
731fe6060f1SDimitry Andric   // If this function is ignored for any of the enabled sanitizers,
7320b57cec5SDimitry Andric   // disable the sanitizer for the function.
7330b57cec5SDimitry Andric   do {
7340b57cec5SDimitry Andric #define SANITIZER(NAME, ID)                                                    \
7350b57cec5SDimitry Andric   if (SanOpts.empty())                                                         \
7360b57cec5SDimitry Andric     break;                                                                     \
7370b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::ID))                                          \
738fe6060f1SDimitry Andric     if (CGM.isInNoSanitizeList(SanitizerKind::ID, Fn, Loc))                    \
7390b57cec5SDimitry Andric       SanOpts.set(SanitizerKind::ID, false);
7400b57cec5SDimitry Andric 
7410b57cec5SDimitry Andric #include "clang/Basic/Sanitizers.def"
7420b57cec5SDimitry Andric #undef SANITIZER
7430b57cec5SDimitry Andric   } while (0);
7440b57cec5SDimitry Andric 
7450b57cec5SDimitry Andric   if (D) {
746fe6060f1SDimitry Andric     bool NoSanitizeCoverage = false;
747fe6060f1SDimitry Andric 
7480b57cec5SDimitry Andric     for (auto Attr : D->specific_attrs<NoSanitizeAttr>()) {
749fe6060f1SDimitry Andric       // Apply the no_sanitize* attributes to SanOpts.
7500b57cec5SDimitry Andric       SanitizerMask mask = Attr->getMask();
7510b57cec5SDimitry Andric       SanOpts.Mask &= ~mask;
7520b57cec5SDimitry Andric       if (mask & SanitizerKind::Address)
7530b57cec5SDimitry Andric         SanOpts.set(SanitizerKind::KernelAddress, false);
7540b57cec5SDimitry Andric       if (mask & SanitizerKind::KernelAddress)
7550b57cec5SDimitry Andric         SanOpts.set(SanitizerKind::Address, false);
7560b57cec5SDimitry Andric       if (mask & SanitizerKind::HWAddress)
7570b57cec5SDimitry Andric         SanOpts.set(SanitizerKind::KernelHWAddress, false);
7580b57cec5SDimitry Andric       if (mask & SanitizerKind::KernelHWAddress)
7590b57cec5SDimitry Andric         SanOpts.set(SanitizerKind::HWAddress, false);
760fe6060f1SDimitry Andric 
761fe6060f1SDimitry Andric       // SanitizeCoverage is not handled by SanOpts.
762fe6060f1SDimitry Andric       if (Attr->hasCoverage())
763fe6060f1SDimitry Andric         NoSanitizeCoverage = true;
7640b57cec5SDimitry Andric     }
765fe6060f1SDimitry Andric 
766fe6060f1SDimitry Andric     if (NoSanitizeCoverage && CGM.getCodeGenOpts().hasSanitizeCoverage())
767fe6060f1SDimitry Andric       Fn->addFnAttr(llvm::Attribute::NoSanitizeCoverage);
7680b57cec5SDimitry Andric   }
7690b57cec5SDimitry Andric 
7700b57cec5SDimitry Andric   // Apply sanitizer attributes to the function.
7710b57cec5SDimitry Andric   if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress))
7720b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
7730b57cec5SDimitry Andric   if (SanOpts.hasOneOf(SanitizerKind::HWAddress | SanitizerKind::KernelHWAddress))
7740b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress);
7750b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::MemTag))
7760b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::SanitizeMemTag);
7770b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::Thread))
7780b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::SanitizeThread);
7790b57cec5SDimitry Andric   if (SanOpts.hasOneOf(SanitizerKind::Memory | SanitizerKind::KernelMemory))
7800b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
7810b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::SafeStack))
7820b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::SafeStack);
7830b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::ShadowCallStack))
7840b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::ShadowCallStack);
7850b57cec5SDimitry Andric 
7860b57cec5SDimitry Andric   // Apply fuzzing attribute to the function.
7870b57cec5SDimitry Andric   if (SanOpts.hasOneOf(SanitizerKind::Fuzzer | SanitizerKind::FuzzerNoLink))
7880b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::OptForFuzzing);
7890b57cec5SDimitry Andric 
7900b57cec5SDimitry Andric   // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize,
7910b57cec5SDimitry Andric   // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time.
7920b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::Thread)) {
7930b57cec5SDimitry Andric     if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
7940b57cec5SDimitry Andric       IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0);
7950b57cec5SDimitry Andric       if (OMD->getMethodFamily() == OMF_dealloc ||
7960b57cec5SDimitry Andric           OMD->getMethodFamily() == OMF_initialize ||
7970b57cec5SDimitry Andric           (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) {
7980b57cec5SDimitry Andric         markAsIgnoreThreadCheckingAtRuntime(Fn);
7990b57cec5SDimitry Andric       }
8000b57cec5SDimitry Andric     }
8010b57cec5SDimitry Andric   }
8020b57cec5SDimitry Andric 
8030b57cec5SDimitry Andric   // Ignore unrelated casts in STL allocate() since the allocator must cast
8040b57cec5SDimitry Andric   // from void* to T* before object initialization completes. Don't match on the
8050b57cec5SDimitry Andric   // namespace because not all allocators are in std::
8060b57cec5SDimitry Andric   if (D && SanOpts.has(SanitizerKind::CFIUnrelatedCast)) {
8070b57cec5SDimitry Andric     if (matchesStlAllocatorFn(D, getContext()))
8080b57cec5SDimitry Andric       SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast;
8090b57cec5SDimitry Andric   }
8100b57cec5SDimitry Andric 
811a7dea167SDimitry Andric   // Ignore null checks in coroutine functions since the coroutines passes
812a7dea167SDimitry Andric   // are not aware of how to move the extra UBSan instructions across the split
813a7dea167SDimitry Andric   // coroutine boundaries.
814a7dea167SDimitry Andric   if (D && SanOpts.has(SanitizerKind::Null))
815fe6060f1SDimitry Andric     if (FD && FD->getBody() &&
816a7dea167SDimitry Andric         FD->getBody()->getStmtClass() == Stmt::CoroutineBodyStmtClass)
817a7dea167SDimitry Andric       SanOpts.Mask &= ~SanitizerKind::Null;
818a7dea167SDimitry Andric 
819480093f4SDimitry Andric   // Apply xray attributes to the function (as a string, for now)
820e8d8bef9SDimitry Andric   bool AlwaysXRayAttr = false;
8215ffd83dbSDimitry Andric   if (const auto *XRayAttr = D ? D->getAttr<XRayInstrumentAttr>() : nullptr) {
8220b57cec5SDimitry Andric     if (CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
8235ffd83dbSDimitry Andric             XRayInstrKind::FunctionEntry) ||
8245ffd83dbSDimitry Andric         CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
8255ffd83dbSDimitry Andric             XRayInstrKind::FunctionExit)) {
826e8d8bef9SDimitry Andric       if (XRayAttr->alwaysXRayInstrument() && ShouldXRayInstrumentFunction()) {
8270b57cec5SDimitry Andric         Fn->addFnAttr("function-instrument", "xray-always");
828e8d8bef9SDimitry Andric         AlwaysXRayAttr = true;
829e8d8bef9SDimitry Andric       }
8300b57cec5SDimitry Andric       if (XRayAttr->neverXRayInstrument())
8310b57cec5SDimitry Andric         Fn->addFnAttr("function-instrument", "xray-never");
8320b57cec5SDimitry Andric       if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>())
8330b57cec5SDimitry Andric         if (ShouldXRayInstrumentFunction())
8340b57cec5SDimitry Andric           Fn->addFnAttr("xray-log-args",
8350b57cec5SDimitry Andric                         llvm::utostr(LogArgs->getArgumentCount()));
8360b57cec5SDimitry Andric     }
8370b57cec5SDimitry Andric   } else {
8380b57cec5SDimitry Andric     if (ShouldXRayInstrumentFunction() && !CGM.imbueXRayAttrs(Fn, Loc))
8390b57cec5SDimitry Andric       Fn->addFnAttr(
8400b57cec5SDimitry Andric           "xray-instruction-threshold",
8410b57cec5SDimitry Andric           llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold));
8420b57cec5SDimitry Andric   }
843480093f4SDimitry Andric 
8445ffd83dbSDimitry Andric   if (ShouldXRayInstrumentFunction()) {
8455ffd83dbSDimitry Andric     if (CGM.getCodeGenOpts().XRayIgnoreLoops)
8465ffd83dbSDimitry Andric       Fn->addFnAttr("xray-ignore-loops");
8475ffd83dbSDimitry Andric 
8485ffd83dbSDimitry Andric     if (!CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
8495ffd83dbSDimitry Andric             XRayInstrKind::FunctionExit))
8505ffd83dbSDimitry Andric       Fn->addFnAttr("xray-skip-exit");
8515ffd83dbSDimitry Andric 
8525ffd83dbSDimitry Andric     if (!CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
8535ffd83dbSDimitry Andric             XRayInstrKind::FunctionEntry))
8545ffd83dbSDimitry Andric       Fn->addFnAttr("xray-skip-entry");
855e8d8bef9SDimitry Andric 
856e8d8bef9SDimitry Andric     auto FuncGroups = CGM.getCodeGenOpts().XRayTotalFunctionGroups;
857e8d8bef9SDimitry Andric     if (FuncGroups > 1) {
858e8d8bef9SDimitry Andric       auto FuncName = llvm::makeArrayRef<uint8_t>(
859e8d8bef9SDimitry Andric           CurFn->getName().bytes_begin(), CurFn->getName().bytes_end());
860e8d8bef9SDimitry Andric       auto Group = crc32(FuncName) % FuncGroups;
861e8d8bef9SDimitry Andric       if (Group != CGM.getCodeGenOpts().XRaySelectedFunctionGroup &&
862e8d8bef9SDimitry Andric           !AlwaysXRayAttr)
863e8d8bef9SDimitry Andric         Fn->addFnAttr("function-instrument", "xray-never");
8645ffd83dbSDimitry Andric     }
865e8d8bef9SDimitry Andric   }
866e8d8bef9SDimitry Andric 
867e8d8bef9SDimitry Andric   if (CGM.getCodeGenOpts().getProfileInstr() != CodeGenOptions::ProfileNone)
868e8d8bef9SDimitry Andric     if (CGM.isProfileInstrExcluded(Fn, Loc))
869e8d8bef9SDimitry Andric       Fn->addFnAttr(llvm::Attribute::NoProfile);
8705ffd83dbSDimitry Andric 
87155e4f9d5SDimitry Andric   unsigned Count, Offset;
8725ffd83dbSDimitry Andric   if (const auto *Attr =
8735ffd83dbSDimitry Andric           D ? D->getAttr<PatchableFunctionEntryAttr>() : nullptr) {
87455e4f9d5SDimitry Andric     Count = Attr->getCount();
87555e4f9d5SDimitry Andric     Offset = Attr->getOffset();
87655e4f9d5SDimitry Andric   } else {
87755e4f9d5SDimitry Andric     Count = CGM.getCodeGenOpts().PatchableFunctionEntryCount;
87855e4f9d5SDimitry Andric     Offset = CGM.getCodeGenOpts().PatchableFunctionEntryOffset;
87955e4f9d5SDimitry Andric   }
88055e4f9d5SDimitry Andric   if (Count && Offset <= Count) {
88155e4f9d5SDimitry Andric     Fn->addFnAttr("patchable-function-entry", std::to_string(Count - Offset));
88255e4f9d5SDimitry Andric     if (Offset)
88355e4f9d5SDimitry Andric       Fn->addFnAttr("patchable-function-prefix", std::to_string(Offset));
884480093f4SDimitry Andric   }
8850b57cec5SDimitry Andric 
8860b57cec5SDimitry Andric   // Add no-jump-tables value.
887fe6060f1SDimitry Andric   if (CGM.getCodeGenOpts().NoUseJumpTables)
888fe6060f1SDimitry Andric     Fn->addFnAttr("no-jump-tables", "true");
8890b57cec5SDimitry Andric 
890480093f4SDimitry Andric   // Add no-inline-line-tables value.
891480093f4SDimitry Andric   if (CGM.getCodeGenOpts().NoInlineLineTables)
892480093f4SDimitry Andric     Fn->addFnAttr("no-inline-line-tables");
893480093f4SDimitry Andric 
8940b57cec5SDimitry Andric   // Add profile-sample-accurate value.
8950b57cec5SDimitry Andric   if (CGM.getCodeGenOpts().ProfileSampleAccurate)
8960b57cec5SDimitry Andric     Fn->addFnAttr("profile-sample-accurate");
8970b57cec5SDimitry Andric 
8985ffd83dbSDimitry Andric   if (!CGM.getCodeGenOpts().SampleProfileFile.empty())
8995ffd83dbSDimitry Andric     Fn->addFnAttr("use-sample-profile");
9005ffd83dbSDimitry Andric 
901a7dea167SDimitry Andric   if (D && D->hasAttr<CFICanonicalJumpTableAttr>())
902a7dea167SDimitry Andric     Fn->addFnAttr("cfi-canonical-jump-table");
903a7dea167SDimitry Andric 
904fe6060f1SDimitry Andric   if (D && D->hasAttr<NoProfileFunctionAttr>())
905fe6060f1SDimitry Andric     Fn->addFnAttr(llvm::Attribute::NoProfile);
906fe6060f1SDimitry Andric 
907fe6060f1SDimitry Andric   if (FD && getLangOpts().OpenCL) {
9080b57cec5SDimitry Andric     // Add metadata for a kernel function.
9090b57cec5SDimitry Andric     EmitOpenCLKernelMetadata(FD, Fn);
9100b57cec5SDimitry Andric   }
9110b57cec5SDimitry Andric 
9120b57cec5SDimitry Andric   // If we are checking function types, emit a function type signature as
9130b57cec5SDimitry Andric   // prologue data.
914fe6060f1SDimitry Andric   if (FD && getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
9150b57cec5SDimitry Andric     if (llvm::Constant *PrologueSig = getPrologueSignature(CGM, FD)) {
9160b57cec5SDimitry Andric       // Remove any (C++17) exception specifications, to allow calling e.g. a
9170b57cec5SDimitry Andric       // noexcept function through a non-noexcept pointer.
918fe6060f1SDimitry Andric       auto ProtoTy = getContext().getFunctionTypeWithExceptionSpec(
919fe6060f1SDimitry Andric           FD->getType(), EST_None);
9200b57cec5SDimitry Andric       llvm::Constant *FTRTTIConst =
9210b57cec5SDimitry Andric           CGM.GetAddrOfRTTIDescriptor(ProtoTy, /*ForEH=*/true);
9220b57cec5SDimitry Andric       llvm::Constant *FTRTTIConstEncoded =
9230b57cec5SDimitry Andric           EncodeAddrForUseInPrologue(Fn, FTRTTIConst);
924fe6060f1SDimitry Andric       llvm::Constant *PrologueStructElems[] = {PrologueSig, FTRTTIConstEncoded};
9250b57cec5SDimitry Andric       llvm::Constant *PrologueStructConst =
9260b57cec5SDimitry Andric           llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
9270b57cec5SDimitry Andric       Fn->setPrologueData(PrologueStructConst);
9280b57cec5SDimitry Andric     }
9290b57cec5SDimitry Andric   }
9300b57cec5SDimitry Andric 
9310b57cec5SDimitry Andric   // If we're checking nullability, we need to know whether we can check the
9320b57cec5SDimitry Andric   // return value. Initialize the flag to 'true' and refine it in EmitParmDecl.
9330b57cec5SDimitry Andric   if (SanOpts.has(SanitizerKind::NullabilityReturn)) {
9340b57cec5SDimitry Andric     auto Nullability = FnRetTy->getNullability(getContext());
9350b57cec5SDimitry Andric     if (Nullability && *Nullability == NullabilityKind::NonNull) {
9360b57cec5SDimitry Andric       if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
9370b57cec5SDimitry Andric             CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>()))
9380b57cec5SDimitry Andric         RetValNullabilityPrecondition =
9390b57cec5SDimitry Andric             llvm::ConstantInt::getTrue(getLLVMContext());
9400b57cec5SDimitry Andric     }
9410b57cec5SDimitry Andric   }
9420b57cec5SDimitry Andric 
9430b57cec5SDimitry Andric   // If we're in C++ mode and the function name is "main", it is guaranteed
9440b57cec5SDimitry Andric   // to be norecurse by the standard (3.6.1.3 "The function main shall not be
9450b57cec5SDimitry Andric   // used within a program").
9465ffd83dbSDimitry Andric   //
9475ffd83dbSDimitry Andric   // OpenCL C 2.0 v2.2-11 s6.9.i:
9485ffd83dbSDimitry Andric   //     Recursion is not supported.
9495ffd83dbSDimitry Andric   //
9505ffd83dbSDimitry Andric   // SYCL v1.2.1 s3.10:
9515ffd83dbSDimitry Andric   //     kernels cannot include RTTI information, exception classes,
9525ffd83dbSDimitry Andric   //     recursive code, virtual functions or make use of C++ libraries that
9535ffd83dbSDimitry Andric   //     are not compiled for the device.
954fe6060f1SDimitry Andric   if (FD && ((getLangOpts().CPlusPlus && FD->isMain()) ||
955fe6060f1SDimitry Andric              getLangOpts().OpenCL || getLangOpts().SYCLIsDevice ||
956fe6060f1SDimitry Andric              (getLangOpts().CUDA && FD->hasAttr<CUDAGlobalAttr>())))
9570b57cec5SDimitry Andric     Fn->addFnAttr(llvm::Attribute::NoRecurse);
9580b57cec5SDimitry Andric 
959349cc55cSDimitry Andric   llvm::RoundingMode RM = getLangOpts().getFPRoundingMode();
960349cc55cSDimitry Andric   llvm::fp::ExceptionBehavior FPExceptionBehavior =
961349cc55cSDimitry Andric       ToConstrainedExceptMD(getLangOpts().getFPExceptionMode());
962349cc55cSDimitry Andric   Builder.setDefaultConstrainedRounding(RM);
963349cc55cSDimitry Andric   Builder.setDefaultConstrainedExcept(FPExceptionBehavior);
964349cc55cSDimitry Andric   if ((FD && (FD->UsesFPIntrin() || FD->hasAttr<StrictFPAttr>())) ||
965349cc55cSDimitry Andric       (!FD && (FPExceptionBehavior != llvm::fp::ebIgnore ||
966349cc55cSDimitry Andric                RM != llvm::RoundingMode::NearestTiesToEven))) {
967349cc55cSDimitry Andric     Builder.setIsFPConstrained(true);
968480093f4SDimitry Andric     Fn->addFnAttr(llvm::Attribute::StrictFP);
9695ffd83dbSDimitry Andric   }
970480093f4SDimitry Andric 
9710b57cec5SDimitry Andric   // If a custom alignment is used, force realigning to this alignment on
9720b57cec5SDimitry Andric   // any main function which certainly will need it.
973fe6060f1SDimitry Andric   if (FD && ((FD->isMain() || FD->isMSVCRTEntryPoint()) &&
974fe6060f1SDimitry Andric              CGM.getCodeGenOpts().StackAlignment))
9750b57cec5SDimitry Andric     Fn->addFnAttr("stackrealign");
9760b57cec5SDimitry Andric 
9770b57cec5SDimitry Andric   llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
9780b57cec5SDimitry Andric 
9790b57cec5SDimitry Andric   // Create a marker to make it easy to insert allocas into the entryblock
9800b57cec5SDimitry Andric   // later.  Don't create this with the builder, because we don't want it
9810b57cec5SDimitry Andric   // folded.
9820b57cec5SDimitry Andric   llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
9830b57cec5SDimitry Andric   AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB);
9840b57cec5SDimitry Andric 
9850b57cec5SDimitry Andric   ReturnBlock = getJumpDestInCurrentScope("return");
9860b57cec5SDimitry Andric 
9870b57cec5SDimitry Andric   Builder.SetInsertPoint(EntryBB);
9880b57cec5SDimitry Andric 
9890b57cec5SDimitry Andric   // If we're checking the return value, allocate space for a pointer to a
9900b57cec5SDimitry Andric   // precise source location of the checked return statement.
9910b57cec5SDimitry Andric   if (requiresReturnValueCheck()) {
9920b57cec5SDimitry Andric     ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr");
993349cc55cSDimitry Andric     Builder.CreateStore(llvm::ConstantPointerNull::get(Int8PtrTy),
994349cc55cSDimitry Andric                         ReturnLocation);
9950b57cec5SDimitry Andric   }
9960b57cec5SDimitry Andric 
9970b57cec5SDimitry Andric   // Emit subprogram debug descriptor.
9980b57cec5SDimitry Andric   if (CGDebugInfo *DI = getDebugInfo()) {
9990b57cec5SDimitry Andric     // Reconstruct the type from the argument list so that implicit parameters,
10000b57cec5SDimitry Andric     // such as 'this' and 'vtt', show up in the debug info. Preserve the calling
10010b57cec5SDimitry Andric     // convention.
1002349cc55cSDimitry Andric     DI->emitFunctionStart(GD, Loc, StartLoc,
1003349cc55cSDimitry Andric                           DI->getFunctionType(FD, RetTy, Args), CurFn,
1004349cc55cSDimitry Andric                           CurFuncIsThunk);
10050b57cec5SDimitry Andric   }
10060b57cec5SDimitry Andric 
10070b57cec5SDimitry Andric   if (ShouldInstrumentFunction()) {
10080b57cec5SDimitry Andric     if (CGM.getCodeGenOpts().InstrumentFunctions)
10090b57cec5SDimitry Andric       CurFn->addFnAttr("instrument-function-entry", "__cyg_profile_func_enter");
10100b57cec5SDimitry Andric     if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
10110b57cec5SDimitry Andric       CurFn->addFnAttr("instrument-function-entry-inlined",
10120b57cec5SDimitry Andric                        "__cyg_profile_func_enter");
10130b57cec5SDimitry Andric     if (CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
10140b57cec5SDimitry Andric       CurFn->addFnAttr("instrument-function-entry-inlined",
10150b57cec5SDimitry Andric                        "__cyg_profile_func_enter_bare");
10160b57cec5SDimitry Andric   }
10170b57cec5SDimitry Andric 
10180b57cec5SDimitry Andric   // Since emitting the mcount call here impacts optimizations such as function
10190b57cec5SDimitry Andric   // inlining, we just add an attribute to insert a mcount call in backend.
10200b57cec5SDimitry Andric   // The attribute "counting-function" is set to mcount function name which is
10210b57cec5SDimitry Andric   // architecture dependent.
10220b57cec5SDimitry Andric   if (CGM.getCodeGenOpts().InstrumentForProfiling) {
10230b57cec5SDimitry Andric     // Calls to fentry/mcount should not be generated if function has
10240b57cec5SDimitry Andric     // the no_instrument_function attribute.
10250b57cec5SDimitry Andric     if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) {
10260b57cec5SDimitry Andric       if (CGM.getCodeGenOpts().CallFEntry)
10270b57cec5SDimitry Andric         Fn->addFnAttr("fentry-call", "true");
10280b57cec5SDimitry Andric       else {
10290b57cec5SDimitry Andric         Fn->addFnAttr("instrument-function-entry-inlined",
10300b57cec5SDimitry Andric                       getTarget().getMCountName());
10310b57cec5SDimitry Andric       }
1032480093f4SDimitry Andric       if (CGM.getCodeGenOpts().MNopMCount) {
1033480093f4SDimitry Andric         if (!CGM.getCodeGenOpts().CallFEntry)
1034480093f4SDimitry Andric           CGM.getDiags().Report(diag::err_opt_not_valid_without_opt)
1035480093f4SDimitry Andric             << "-mnop-mcount" << "-mfentry";
1036480093f4SDimitry Andric         Fn->addFnAttr("mnop-mcount");
10370b57cec5SDimitry Andric       }
1038480093f4SDimitry Andric 
1039480093f4SDimitry Andric       if (CGM.getCodeGenOpts().RecordMCount) {
1040480093f4SDimitry Andric         if (!CGM.getCodeGenOpts().CallFEntry)
1041480093f4SDimitry Andric           CGM.getDiags().Report(diag::err_opt_not_valid_without_opt)
1042480093f4SDimitry Andric             << "-mrecord-mcount" << "-mfentry";
1043480093f4SDimitry Andric         Fn->addFnAttr("mrecord-mcount");
1044480093f4SDimitry Andric       }
1045480093f4SDimitry Andric     }
1046480093f4SDimitry Andric   }
1047480093f4SDimitry Andric 
1048480093f4SDimitry Andric   if (CGM.getCodeGenOpts().PackedStack) {
1049480093f4SDimitry Andric     if (getContext().getTargetInfo().getTriple().getArch() !=
1050480093f4SDimitry Andric         llvm::Triple::systemz)
1051480093f4SDimitry Andric       CGM.getDiags().Report(diag::err_opt_not_valid_on_target)
1052480093f4SDimitry Andric         << "-mpacked-stack";
1053480093f4SDimitry Andric     Fn->addFnAttr("packed-stack");
10540b57cec5SDimitry Andric   }
10550b57cec5SDimitry Andric 
1056349cc55cSDimitry Andric   if (CGM.getCodeGenOpts().WarnStackSize != UINT_MAX &&
1057349cc55cSDimitry Andric       !CGM.getDiags().isIgnored(diag::warn_fe_backend_frame_larger_than, Loc))
1058fe6060f1SDimitry Andric     Fn->addFnAttr("warn-stack-size",
1059fe6060f1SDimitry Andric                   std::to_string(CGM.getCodeGenOpts().WarnStackSize));
1060fe6060f1SDimitry Andric 
10610b57cec5SDimitry Andric   if (RetTy->isVoidType()) {
10620b57cec5SDimitry Andric     // Void type; nothing to return.
10630b57cec5SDimitry Andric     ReturnValue = Address::invalid();
10640b57cec5SDimitry Andric 
10650b57cec5SDimitry Andric     // Count the implicit return.
10660b57cec5SDimitry Andric     if (!endsWithReturn(D))
10670b57cec5SDimitry Andric       ++NumReturnExprs;
10680b57cec5SDimitry Andric   } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect) {
10690b57cec5SDimitry Andric     // Indirect return; emit returned value directly into sret slot.
10700b57cec5SDimitry Andric     // This reduces code size, and affects correctness in C++.
10710b57cec5SDimitry Andric     auto AI = CurFn->arg_begin();
10720b57cec5SDimitry Andric     if (CurFnInfo->getReturnInfo().isSRetAfterThis())
10730b57cec5SDimitry Andric       ++AI;
10740eae32dcSDimitry Andric     ReturnValue = Address(&*AI, ConvertType(RetTy),
10750eae32dcSDimitry Andric                           CurFnInfo->getReturnInfo().getIndirectAlign());
10760b57cec5SDimitry Andric     if (!CurFnInfo->getReturnInfo().getIndirectByVal()) {
10770b57cec5SDimitry Andric       ReturnValuePointer =
10780b57cec5SDimitry Andric           CreateDefaultAlignTempAlloca(Int8PtrTy, "result.ptr");
10790b57cec5SDimitry Andric       Builder.CreateStore(Builder.CreatePointerBitCastOrAddrSpaceCast(
10800b57cec5SDimitry Andric                               ReturnValue.getPointer(), Int8PtrTy),
10810b57cec5SDimitry Andric                           ReturnValuePointer);
10820b57cec5SDimitry Andric     }
10830b57cec5SDimitry Andric   } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
10840b57cec5SDimitry Andric              !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
10850b57cec5SDimitry Andric     // Load the sret pointer from the argument struct and return into that.
10860b57cec5SDimitry Andric     unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
10870b57cec5SDimitry Andric     llvm::Function::arg_iterator EI = CurFn->arg_end();
10880b57cec5SDimitry Andric     --EI;
1089fe6060f1SDimitry Andric     llvm::Value *Addr = Builder.CreateStructGEP(
1090fe6060f1SDimitry Andric         EI->getType()->getPointerElementType(), &*EI, Idx);
1091fe6060f1SDimitry Andric     llvm::Type *Ty =
1092fe6060f1SDimitry Andric         cast<llvm::GetElementPtrInst>(Addr)->getResultElementType();
10930b57cec5SDimitry Andric     ReturnValuePointer = Address(Addr, getPointerAlign());
1094fe6060f1SDimitry Andric     Addr = Builder.CreateAlignedLoad(Ty, Addr, getPointerAlign(), "agg.result");
10955ffd83dbSDimitry Andric     ReturnValue = Address(Addr, CGM.getNaturalTypeAlignment(RetTy));
10960b57cec5SDimitry Andric   } else {
10970b57cec5SDimitry Andric     ReturnValue = CreateIRTemp(RetTy, "retval");
10980b57cec5SDimitry Andric 
10990b57cec5SDimitry Andric     // Tell the epilog emitter to autorelease the result.  We do this
11000b57cec5SDimitry Andric     // now so that various specialized functions can suppress it
11010b57cec5SDimitry Andric     // during their IR-generation.
11020b57cec5SDimitry Andric     if (getLangOpts().ObjCAutoRefCount &&
11030b57cec5SDimitry Andric         !CurFnInfo->isReturnsRetained() &&
11040b57cec5SDimitry Andric         RetTy->isObjCRetainableType())
11050b57cec5SDimitry Andric       AutoreleaseResult = true;
11060b57cec5SDimitry Andric   }
11070b57cec5SDimitry Andric 
11080b57cec5SDimitry Andric   EmitStartEHSpec(CurCodeDecl);
11090b57cec5SDimitry Andric 
11100b57cec5SDimitry Andric   PrologueCleanupDepth = EHStack.stable_begin();
11110b57cec5SDimitry Andric 
11120b57cec5SDimitry Andric   // Emit OpenMP specific initialization of the device functions.
11130b57cec5SDimitry Andric   if (getLangOpts().OpenMP && CurCodeDecl)
11140b57cec5SDimitry Andric     CGM.getOpenMPRuntime().emitFunctionProlog(*this, CurCodeDecl);
11150b57cec5SDimitry Andric 
11160b57cec5SDimitry Andric   EmitFunctionProlog(*CurFnInfo, CurFn, Args);
11170b57cec5SDimitry Andric 
11180b57cec5SDimitry Andric   if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
11190b57cec5SDimitry Andric     CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
11200b57cec5SDimitry Andric     const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
11210b57cec5SDimitry Andric     if (MD->getParent()->isLambda() &&
11220b57cec5SDimitry Andric         MD->getOverloadedOperator() == OO_Call) {
11230b57cec5SDimitry Andric       // We're in a lambda; figure out the captures.
11240b57cec5SDimitry Andric       MD->getParent()->getCaptureFields(LambdaCaptureFields,
11250b57cec5SDimitry Andric                                         LambdaThisCaptureField);
11260b57cec5SDimitry Andric       if (LambdaThisCaptureField) {
11270b57cec5SDimitry Andric         // If the lambda captures the object referred to by '*this' - either by
11280b57cec5SDimitry Andric         // value or by reference, make sure CXXThisValue points to the correct
11290b57cec5SDimitry Andric         // object.
11300b57cec5SDimitry Andric 
11310b57cec5SDimitry Andric         // Get the lvalue for the field (which is a copy of the enclosing object
11320b57cec5SDimitry Andric         // or contains the address of the enclosing object).
11330b57cec5SDimitry Andric         LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
11340b57cec5SDimitry Andric         if (!LambdaThisCaptureField->getType()->isPointerType()) {
11350b57cec5SDimitry Andric           // If the enclosing object was captured by value, just use its address.
1136480093f4SDimitry Andric           CXXThisValue = ThisFieldLValue.getAddress(*this).getPointer();
11370b57cec5SDimitry Andric         } else {
11380b57cec5SDimitry Andric           // Load the lvalue pointed to by the field, since '*this' was captured
11390b57cec5SDimitry Andric           // by reference.
11400b57cec5SDimitry Andric           CXXThisValue =
11410b57cec5SDimitry Andric               EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal();
11420b57cec5SDimitry Andric         }
11430b57cec5SDimitry Andric       }
11440b57cec5SDimitry Andric       for (auto *FD : MD->getParent()->fields()) {
11450b57cec5SDimitry Andric         if (FD->hasCapturedVLAType()) {
11460b57cec5SDimitry Andric           auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
11470b57cec5SDimitry Andric                                            SourceLocation()).getScalarVal();
11480b57cec5SDimitry Andric           auto VAT = FD->getCapturedVLAType();
11490b57cec5SDimitry Andric           VLASizeMap[VAT->getSizeExpr()] = ExprArg;
11500b57cec5SDimitry Andric         }
11510b57cec5SDimitry Andric       }
11520b57cec5SDimitry Andric     } else {
11530b57cec5SDimitry Andric       // Not in a lambda; just use 'this' from the method.
11540b57cec5SDimitry Andric       // FIXME: Should we generate a new load for each use of 'this'?  The
11550b57cec5SDimitry Andric       // fast register allocator would be happier...
11560b57cec5SDimitry Andric       CXXThisValue = CXXABIThisValue;
11570b57cec5SDimitry Andric     }
11580b57cec5SDimitry Andric 
11590b57cec5SDimitry Andric     // Check the 'this' pointer once per function, if it's available.
11600b57cec5SDimitry Andric     if (CXXABIThisValue) {
11610b57cec5SDimitry Andric       SanitizerSet SkippedChecks;
11620b57cec5SDimitry Andric       SkippedChecks.set(SanitizerKind::ObjectSize, true);
11630b57cec5SDimitry Andric       QualType ThisTy = MD->getThisType();
11640b57cec5SDimitry Andric 
11650b57cec5SDimitry Andric       // If this is the call operator of a lambda with no capture-default, it
11660b57cec5SDimitry Andric       // may have a static invoker function, which may call this operator with
11670b57cec5SDimitry Andric       // a null 'this' pointer.
11680b57cec5SDimitry Andric       if (isLambdaCallOperator(MD) &&
11690b57cec5SDimitry Andric           MD->getParent()->getLambdaCaptureDefault() == LCD_None)
11700b57cec5SDimitry Andric         SkippedChecks.set(SanitizerKind::Null, true);
11710b57cec5SDimitry Andric 
1172e8d8bef9SDimitry Andric       EmitTypeCheck(
1173e8d8bef9SDimitry Andric           isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall : TCK_MemberCall,
1174e8d8bef9SDimitry Andric           Loc, CXXABIThisValue, ThisTy, CXXABIThisAlignment, SkippedChecks);
11750b57cec5SDimitry Andric     }
11760b57cec5SDimitry Andric   }
11770b57cec5SDimitry Andric 
11780b57cec5SDimitry Andric   // If any of the arguments have a variably modified type, make sure to
11790b57cec5SDimitry Andric   // emit the type size.
11800b57cec5SDimitry Andric   for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
11810b57cec5SDimitry Andric        i != e; ++i) {
11820b57cec5SDimitry Andric     const VarDecl *VD = *i;
11830b57cec5SDimitry Andric 
11840b57cec5SDimitry Andric     // Dig out the type as written from ParmVarDecls; it's unclear whether
11850b57cec5SDimitry Andric     // the standard (C99 6.9.1p10) requires this, but we're following the
11860b57cec5SDimitry Andric     // precedent set by gcc.
11870b57cec5SDimitry Andric     QualType Ty;
11880b57cec5SDimitry Andric     if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
11890b57cec5SDimitry Andric       Ty = PVD->getOriginalType();
11900b57cec5SDimitry Andric     else
11910b57cec5SDimitry Andric       Ty = VD->getType();
11920b57cec5SDimitry Andric 
11930b57cec5SDimitry Andric     if (Ty->isVariablyModifiedType())
11940b57cec5SDimitry Andric       EmitVariablyModifiedType(Ty);
11950b57cec5SDimitry Andric   }
11960b57cec5SDimitry Andric   // Emit a location at the end of the prologue.
11970b57cec5SDimitry Andric   if (CGDebugInfo *DI = getDebugInfo())
11980b57cec5SDimitry Andric     DI->EmitLocation(Builder, StartLoc);
11990b57cec5SDimitry Andric 
12000b57cec5SDimitry Andric   // TODO: Do we need to handle this in two places like we do with
12010b57cec5SDimitry Andric   // target-features/target-cpu?
12020b57cec5SDimitry Andric   if (CurFuncDecl)
12030b57cec5SDimitry Andric     if (const auto *VecWidth = CurFuncDecl->getAttr<MinVectorWidthAttr>())
12040b57cec5SDimitry Andric       LargestVectorWidth = VecWidth->getVectorWidth();
12050b57cec5SDimitry Andric }
12060b57cec5SDimitry Andric 
12070b57cec5SDimitry Andric void CodeGenFunction::EmitFunctionBody(const Stmt *Body) {
12080b57cec5SDimitry Andric   incrementProfileCounter(Body);
12090b57cec5SDimitry Andric   if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
12100b57cec5SDimitry Andric     EmitCompoundStmtWithoutScope(*S);
12110b57cec5SDimitry Andric   else
12120b57cec5SDimitry Andric     EmitStmt(Body);
1213e8d8bef9SDimitry Andric 
1214e8d8bef9SDimitry Andric   // This is checked after emitting the function body so we know if there
1215e8d8bef9SDimitry Andric   // are any permitted infinite loops.
1216fe6060f1SDimitry Andric   if (checkIfFunctionMustProgress())
1217e8d8bef9SDimitry Andric     CurFn->addFnAttr(llvm::Attribute::MustProgress);
12180b57cec5SDimitry Andric }
12190b57cec5SDimitry Andric 
12200b57cec5SDimitry Andric /// When instrumenting to collect profile data, the counts for some blocks
12210b57cec5SDimitry Andric /// such as switch cases need to not include the fall-through counts, so
12220b57cec5SDimitry Andric /// emit a branch around the instrumentation code. When not instrumenting,
12230b57cec5SDimitry Andric /// this just calls EmitBlock().
12240b57cec5SDimitry Andric void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
12250b57cec5SDimitry Andric                                                const Stmt *S) {
12260b57cec5SDimitry Andric   llvm::BasicBlock *SkipCountBB = nullptr;
12270b57cec5SDimitry Andric   if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) {
12280b57cec5SDimitry Andric     // When instrumenting for profiling, the fallthrough to certain
12290b57cec5SDimitry Andric     // statements needs to skip over the instrumentation code so that we
12300b57cec5SDimitry Andric     // get an accurate count.
12310b57cec5SDimitry Andric     SkipCountBB = createBasicBlock("skipcount");
12320b57cec5SDimitry Andric     EmitBranch(SkipCountBB);
12330b57cec5SDimitry Andric   }
12340b57cec5SDimitry Andric   EmitBlock(BB);
12350b57cec5SDimitry Andric   uint64_t CurrentCount = getCurrentProfileCount();
12360b57cec5SDimitry Andric   incrementProfileCounter(S);
12370b57cec5SDimitry Andric   setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
12380b57cec5SDimitry Andric   if (SkipCountBB)
12390b57cec5SDimitry Andric     EmitBlock(SkipCountBB);
12400b57cec5SDimitry Andric }
12410b57cec5SDimitry Andric 
12420b57cec5SDimitry Andric /// Tries to mark the given function nounwind based on the
12430b57cec5SDimitry Andric /// non-existence of any throwing calls within it.  We believe this is
12440b57cec5SDimitry Andric /// lightweight enough to do at -O0.
12450b57cec5SDimitry Andric static void TryMarkNoThrow(llvm::Function *F) {
12460b57cec5SDimitry Andric   // LLVM treats 'nounwind' on a function as part of the type, so we
12470b57cec5SDimitry Andric   // can't do this on functions that can be overwritten.
12480b57cec5SDimitry Andric   if (F->isInterposable()) return;
12490b57cec5SDimitry Andric 
12500b57cec5SDimitry Andric   for (llvm::BasicBlock &BB : *F)
12510b57cec5SDimitry Andric     for (llvm::Instruction &I : BB)
12520b57cec5SDimitry Andric       if (I.mayThrow())
12530b57cec5SDimitry Andric         return;
12540b57cec5SDimitry Andric 
12550b57cec5SDimitry Andric   F->setDoesNotThrow();
12560b57cec5SDimitry Andric }
12570b57cec5SDimitry Andric 
12580b57cec5SDimitry Andric QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD,
12590b57cec5SDimitry Andric                                                FunctionArgList &Args) {
12600b57cec5SDimitry Andric   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
12610b57cec5SDimitry Andric   QualType ResTy = FD->getReturnType();
12620b57cec5SDimitry Andric 
12630b57cec5SDimitry Andric   const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
12640b57cec5SDimitry Andric   if (MD && MD->isInstance()) {
12650b57cec5SDimitry Andric     if (CGM.getCXXABI().HasThisReturn(GD))
12660b57cec5SDimitry Andric       ResTy = MD->getThisType();
12670b57cec5SDimitry Andric     else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
12680b57cec5SDimitry Andric       ResTy = CGM.getContext().VoidPtrTy;
12690b57cec5SDimitry Andric     CGM.getCXXABI().buildThisParam(*this, Args);
12700b57cec5SDimitry Andric   }
12710b57cec5SDimitry Andric 
12720b57cec5SDimitry Andric   // The base version of an inheriting constructor whose constructed base is a
12730b57cec5SDimitry Andric   // virtual base is not passed any arguments (because it doesn't actually call
12740b57cec5SDimitry Andric   // the inherited constructor).
12750b57cec5SDimitry Andric   bool PassedParams = true;
12760b57cec5SDimitry Andric   if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
12770b57cec5SDimitry Andric     if (auto Inherited = CD->getInheritedConstructor())
12780b57cec5SDimitry Andric       PassedParams =
12790b57cec5SDimitry Andric           getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType());
12800b57cec5SDimitry Andric 
12810b57cec5SDimitry Andric   if (PassedParams) {
12820b57cec5SDimitry Andric     for (auto *Param : FD->parameters()) {
12830b57cec5SDimitry Andric       Args.push_back(Param);
12840b57cec5SDimitry Andric       if (!Param->hasAttr<PassObjectSizeAttr>())
12850b57cec5SDimitry Andric         continue;
12860b57cec5SDimitry Andric 
12870b57cec5SDimitry Andric       auto *Implicit = ImplicitParamDecl::Create(
12880b57cec5SDimitry Andric           getContext(), Param->getDeclContext(), Param->getLocation(),
12890b57cec5SDimitry Andric           /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other);
12900b57cec5SDimitry Andric       SizeArguments[Param] = Implicit;
12910b57cec5SDimitry Andric       Args.push_back(Implicit);
12920b57cec5SDimitry Andric     }
12930b57cec5SDimitry Andric   }
12940b57cec5SDimitry Andric 
12950b57cec5SDimitry Andric   if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
12960b57cec5SDimitry Andric     CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
12970b57cec5SDimitry Andric 
12980b57cec5SDimitry Andric   return ResTy;
12990b57cec5SDimitry Andric }
13000b57cec5SDimitry Andric 
13010b57cec5SDimitry Andric void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
13020b57cec5SDimitry Andric                                    const CGFunctionInfo &FnInfo) {
13030eae32dcSDimitry Andric   assert(Fn && "generating code for null Function");
13040b57cec5SDimitry Andric   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
13050b57cec5SDimitry Andric   CurGD = GD;
13060b57cec5SDimitry Andric 
13070b57cec5SDimitry Andric   FunctionArgList Args;
13080b57cec5SDimitry Andric   QualType ResTy = BuildFunctionArgList(GD, Args);
13090b57cec5SDimitry Andric 
1310349cc55cSDimitry Andric   if (FD->isInlineBuiltinDeclaration()) {
13110eae32dcSDimitry Andric     // When generating code for a builtin with an inline declaration, use a
13120eae32dcSDimitry Andric     // mangled name to hold the actual body, while keeping an external
13130eae32dcSDimitry Andric     // definition in case the function pointer is referenced somewhere.
1314349cc55cSDimitry Andric     std::string FDInlineName = (Fn->getName() + ".inline").str();
1315349cc55cSDimitry Andric     llvm::Module *M = Fn->getParent();
1316349cc55cSDimitry Andric     llvm::Function *Clone = M->getFunction(FDInlineName);
1317349cc55cSDimitry Andric     if (!Clone) {
1318349cc55cSDimitry Andric       Clone = llvm::Function::Create(Fn->getFunctionType(),
1319349cc55cSDimitry Andric                                      llvm::GlobalValue::InternalLinkage,
1320349cc55cSDimitry Andric                                      Fn->getAddressSpace(), FDInlineName, M);
1321349cc55cSDimitry Andric       Clone->addFnAttr(llvm::Attribute::AlwaysInline);
1322349cc55cSDimitry Andric     }
1323349cc55cSDimitry Andric     Fn->setLinkage(llvm::GlobalValue::ExternalLinkage);
1324349cc55cSDimitry Andric     Fn = Clone;
13250eae32dcSDimitry Andric   } else {
1326349cc55cSDimitry Andric     // Detect the unusual situation where an inline version is shadowed by a
1327349cc55cSDimitry Andric     // non-inline version. In that case we should pick the external one
1328349cc55cSDimitry Andric     // everywhere. That's GCC behavior too. Unfortunately, I cannot find a way
1329349cc55cSDimitry Andric     // to detect that situation before we reach codegen, so do some late
1330349cc55cSDimitry Andric     // replacement.
1331349cc55cSDimitry Andric     for (const FunctionDecl *PD = FD->getPreviousDecl(); PD;
1332349cc55cSDimitry Andric          PD = PD->getPreviousDecl()) {
1333349cc55cSDimitry Andric       if (LLVM_UNLIKELY(PD->isInlineBuiltinDeclaration())) {
1334349cc55cSDimitry Andric         std::string FDInlineName = (Fn->getName() + ".inline").str();
1335349cc55cSDimitry Andric         llvm::Module *M = Fn->getParent();
1336349cc55cSDimitry Andric         if (llvm::Function *Clone = M->getFunction(FDInlineName)) {
1337349cc55cSDimitry Andric           Clone->replaceAllUsesWith(Fn);
1338349cc55cSDimitry Andric           Clone->eraseFromParent();
1339349cc55cSDimitry Andric         }
1340349cc55cSDimitry Andric         break;
1341349cc55cSDimitry Andric       }
1342349cc55cSDimitry Andric     }
1343349cc55cSDimitry Andric   }
1344349cc55cSDimitry Andric 
13450b57cec5SDimitry Andric   // Check if we should generate debug info for this function.
1346fe6060f1SDimitry Andric   if (FD->hasAttr<NoDebugAttr>()) {
1347fe6060f1SDimitry Andric     // Clear non-distinct debug info that was possibly attached to the function
1348fe6060f1SDimitry Andric     // due to an earlier declaration without the nodebug attribute
1349fe6060f1SDimitry Andric     Fn->setSubprogram(nullptr);
1350fe6060f1SDimitry Andric     // Disable debug info indefinitely for this function
1351fe6060f1SDimitry Andric     DebugInfo = nullptr;
1352fe6060f1SDimitry Andric   }
13530b57cec5SDimitry Andric 
13540b57cec5SDimitry Andric   // The function might not have a body if we're generating thunks for a
13550b57cec5SDimitry Andric   // function declaration.
13560b57cec5SDimitry Andric   SourceRange BodyRange;
13570b57cec5SDimitry Andric   if (Stmt *Body = FD->getBody())
13580b57cec5SDimitry Andric     BodyRange = Body->getSourceRange();
13590b57cec5SDimitry Andric   else
13600b57cec5SDimitry Andric     BodyRange = FD->getLocation();
13610b57cec5SDimitry Andric   CurEHLocation = BodyRange.getEnd();
13620b57cec5SDimitry Andric 
13630b57cec5SDimitry Andric   // Use the location of the start of the function to determine where
13640b57cec5SDimitry Andric   // the function definition is located. By default use the location
13650b57cec5SDimitry Andric   // of the declaration as the location for the subprogram. A function
13660b57cec5SDimitry Andric   // may lack a declaration in the source code if it is created by code
13670b57cec5SDimitry Andric   // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
13680b57cec5SDimitry Andric   SourceLocation Loc = FD->getLocation();
13690b57cec5SDimitry Andric 
13700b57cec5SDimitry Andric   // If this is a function specialization then use the pattern body
13710b57cec5SDimitry Andric   // as the location for the function.
13720b57cec5SDimitry Andric   if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
13730b57cec5SDimitry Andric     if (SpecDecl->hasBody(SpecDecl))
13740b57cec5SDimitry Andric       Loc = SpecDecl->getLocation();
13750b57cec5SDimitry Andric 
13760b57cec5SDimitry Andric   Stmt *Body = FD->getBody();
13770b57cec5SDimitry Andric 
1378fe6060f1SDimitry Andric   if (Body) {
1379fe6060f1SDimitry Andric     // Coroutines always emit lifetime markers.
1380fe6060f1SDimitry Andric     if (isa<CoroutineBodyStmt>(Body))
1381fe6060f1SDimitry Andric       ShouldEmitLifetimeMarkers = true;
1382fe6060f1SDimitry Andric 
1383fe6060f1SDimitry Andric     // Initialize helper which will detect jumps which can cause invalid
1384fe6060f1SDimitry Andric     // lifetime markers.
1385fe6060f1SDimitry Andric     if (ShouldEmitLifetimeMarkers)
13860b57cec5SDimitry Andric       Bypasses.Init(Body);
1387fe6060f1SDimitry Andric   }
13880b57cec5SDimitry Andric 
13890b57cec5SDimitry Andric   // Emit the standard function prologue.
13900b57cec5SDimitry Andric   StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
13910b57cec5SDimitry Andric 
1392fe6060f1SDimitry Andric   // Save parameters for coroutine function.
1393fe6060f1SDimitry Andric   if (Body && isa_and_nonnull<CoroutineBodyStmt>(Body))
1394fe6060f1SDimitry Andric     for (const auto *ParamDecl : FD->parameters())
1395fe6060f1SDimitry Andric       FnArgs.push_back(ParamDecl);
1396fe6060f1SDimitry Andric 
13970b57cec5SDimitry Andric   // Generate the body of the function.
13980b57cec5SDimitry Andric   PGO.assignRegionCounters(GD, CurFn);
13990b57cec5SDimitry Andric   if (isa<CXXDestructorDecl>(FD))
14000b57cec5SDimitry Andric     EmitDestructorBody(Args);
14010b57cec5SDimitry Andric   else if (isa<CXXConstructorDecl>(FD))
14020b57cec5SDimitry Andric     EmitConstructorBody(Args);
14030b57cec5SDimitry Andric   else if (getLangOpts().CUDA &&
14040b57cec5SDimitry Andric            !getLangOpts().CUDAIsDevice &&
14050b57cec5SDimitry Andric            FD->hasAttr<CUDAGlobalAttr>())
14060b57cec5SDimitry Andric     CGM.getCUDARuntime().emitDeviceStub(*this, Args);
14070b57cec5SDimitry Andric   else if (isa<CXXMethodDecl>(FD) &&
14080b57cec5SDimitry Andric            cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
14090b57cec5SDimitry Andric     // The lambda static invoker function is special, because it forwards or
14100b57cec5SDimitry Andric     // clones the body of the function call operator (but is actually static).
14110b57cec5SDimitry Andric     EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD));
14120b57cec5SDimitry Andric   } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
14130b57cec5SDimitry Andric              (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
14140b57cec5SDimitry Andric               cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
14150b57cec5SDimitry Andric     // Implicit copy-assignment gets the same special treatment as implicit
14160b57cec5SDimitry Andric     // copy-constructors.
14170b57cec5SDimitry Andric     emitImplicitAssignmentOperatorBody(Args);
14180b57cec5SDimitry Andric   } else if (Body) {
14190b57cec5SDimitry Andric     EmitFunctionBody(Body);
14200b57cec5SDimitry Andric   } else
14210b57cec5SDimitry Andric     llvm_unreachable("no definition for emitted function");
14220b57cec5SDimitry Andric 
14230b57cec5SDimitry Andric   // C++11 [stmt.return]p2:
14240b57cec5SDimitry Andric   //   Flowing off the end of a function [...] results in undefined behavior in
14250b57cec5SDimitry Andric   //   a value-returning function.
14260b57cec5SDimitry Andric   // C11 6.9.1p12:
14270b57cec5SDimitry Andric   //   If the '}' that terminates a function is reached, and the value of the
14280b57cec5SDimitry Andric   //   function call is used by the caller, the behavior is undefined.
14290b57cec5SDimitry Andric   if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
14300b57cec5SDimitry Andric       !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
14310b57cec5SDimitry Andric     bool ShouldEmitUnreachable =
14320b57cec5SDimitry Andric         CGM.getCodeGenOpts().StrictReturn ||
1433fe6060f1SDimitry Andric         !CGM.MayDropFunctionReturn(FD->getASTContext(), FD->getReturnType());
14340b57cec5SDimitry Andric     if (SanOpts.has(SanitizerKind::Return)) {
14350b57cec5SDimitry Andric       SanitizerScope SanScope(this);
14360b57cec5SDimitry Andric       llvm::Value *IsFalse = Builder.getFalse();
14370b57cec5SDimitry Andric       EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
14380b57cec5SDimitry Andric                 SanitizerHandler::MissingReturn,
14390b57cec5SDimitry Andric                 EmitCheckSourceLocation(FD->getLocation()), None);
14400b57cec5SDimitry Andric     } else if (ShouldEmitUnreachable) {
14410b57cec5SDimitry Andric       if (CGM.getCodeGenOpts().OptimizationLevel == 0)
14420b57cec5SDimitry Andric         EmitTrapCall(llvm::Intrinsic::trap);
14430b57cec5SDimitry Andric     }
14440b57cec5SDimitry Andric     if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) {
14450b57cec5SDimitry Andric       Builder.CreateUnreachable();
14460b57cec5SDimitry Andric       Builder.ClearInsertionPoint();
14470b57cec5SDimitry Andric     }
14480b57cec5SDimitry Andric   }
14490b57cec5SDimitry Andric 
14500b57cec5SDimitry Andric   // Emit the standard function epilogue.
14510b57cec5SDimitry Andric   FinishFunction(BodyRange.getEnd());
14520b57cec5SDimitry Andric 
14530b57cec5SDimitry Andric   // If we haven't marked the function nothrow through other means, do
14540b57cec5SDimitry Andric   // a quick pass now to see if we can.
14550b57cec5SDimitry Andric   if (!CurFn->doesNotThrow())
14560b57cec5SDimitry Andric     TryMarkNoThrow(CurFn);
14570b57cec5SDimitry Andric }
14580b57cec5SDimitry Andric 
14590b57cec5SDimitry Andric /// ContainsLabel - Return true if the statement contains a label in it.  If
14600b57cec5SDimitry Andric /// this statement is not executed normally, it not containing a label means
14610b57cec5SDimitry Andric /// that we can just remove the code.
14620b57cec5SDimitry Andric bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
14630b57cec5SDimitry Andric   // Null statement, not a label!
14640b57cec5SDimitry Andric   if (!S) return false;
14650b57cec5SDimitry Andric 
14660b57cec5SDimitry Andric   // If this is a label, we have to emit the code, consider something like:
14670b57cec5SDimitry Andric   // if (0) {  ...  foo:  bar(); }  goto foo;
14680b57cec5SDimitry Andric   //
14690b57cec5SDimitry Andric   // TODO: If anyone cared, we could track __label__'s, since we know that you
14700b57cec5SDimitry Andric   // can't jump to one from outside their declared region.
14710b57cec5SDimitry Andric   if (isa<LabelStmt>(S))
14720b57cec5SDimitry Andric     return true;
14730b57cec5SDimitry Andric 
14740b57cec5SDimitry Andric   // If this is a case/default statement, and we haven't seen a switch, we have
14750b57cec5SDimitry Andric   // to emit the code.
14760b57cec5SDimitry Andric   if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
14770b57cec5SDimitry Andric     return true;
14780b57cec5SDimitry Andric 
14790b57cec5SDimitry Andric   // If this is a switch statement, we want to ignore cases below it.
14800b57cec5SDimitry Andric   if (isa<SwitchStmt>(S))
14810b57cec5SDimitry Andric     IgnoreCaseStmts = true;
14820b57cec5SDimitry Andric 
14830b57cec5SDimitry Andric   // Scan subexpressions for verboten labels.
14840b57cec5SDimitry Andric   for (const Stmt *SubStmt : S->children())
14850b57cec5SDimitry Andric     if (ContainsLabel(SubStmt, IgnoreCaseStmts))
14860b57cec5SDimitry Andric       return true;
14870b57cec5SDimitry Andric 
14880b57cec5SDimitry Andric   return false;
14890b57cec5SDimitry Andric }
14900b57cec5SDimitry Andric 
14910b57cec5SDimitry Andric /// containsBreak - Return true if the statement contains a break out of it.
14920b57cec5SDimitry Andric /// If the statement (recursively) contains a switch or loop with a break
14930b57cec5SDimitry Andric /// inside of it, this is fine.
14940b57cec5SDimitry Andric bool CodeGenFunction::containsBreak(const Stmt *S) {
14950b57cec5SDimitry Andric   // Null statement, not a label!
14960b57cec5SDimitry Andric   if (!S) return false;
14970b57cec5SDimitry Andric 
14980b57cec5SDimitry Andric   // If this is a switch or loop that defines its own break scope, then we can
14990b57cec5SDimitry Andric   // include it and anything inside of it.
15000b57cec5SDimitry Andric   if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
15010b57cec5SDimitry Andric       isa<ForStmt>(S))
15020b57cec5SDimitry Andric     return false;
15030b57cec5SDimitry Andric 
15040b57cec5SDimitry Andric   if (isa<BreakStmt>(S))
15050b57cec5SDimitry Andric     return true;
15060b57cec5SDimitry Andric 
15070b57cec5SDimitry Andric   // Scan subexpressions for verboten breaks.
15080b57cec5SDimitry Andric   for (const Stmt *SubStmt : S->children())
15090b57cec5SDimitry Andric     if (containsBreak(SubStmt))
15100b57cec5SDimitry Andric       return true;
15110b57cec5SDimitry Andric 
15120b57cec5SDimitry Andric   return false;
15130b57cec5SDimitry Andric }
15140b57cec5SDimitry Andric 
15150b57cec5SDimitry Andric bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) {
15160b57cec5SDimitry Andric   if (!S) return false;
15170b57cec5SDimitry Andric 
15180b57cec5SDimitry Andric   // Some statement kinds add a scope and thus never add a decl to the current
15190b57cec5SDimitry Andric   // scope. Note, this list is longer than the list of statements that might
15200b57cec5SDimitry Andric   // have an unscoped decl nested within them, but this way is conservatively
15210b57cec5SDimitry Andric   // correct even if more statement kinds are added.
15220b57cec5SDimitry Andric   if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
15230b57cec5SDimitry Andric       isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) ||
15240b57cec5SDimitry Andric       isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) ||
15250b57cec5SDimitry Andric       isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S))
15260b57cec5SDimitry Andric     return false;
15270b57cec5SDimitry Andric 
15280b57cec5SDimitry Andric   if (isa<DeclStmt>(S))
15290b57cec5SDimitry Andric     return true;
15300b57cec5SDimitry Andric 
15310b57cec5SDimitry Andric   for (const Stmt *SubStmt : S->children())
15320b57cec5SDimitry Andric     if (mightAddDeclToScope(SubStmt))
15330b57cec5SDimitry Andric       return true;
15340b57cec5SDimitry Andric 
15350b57cec5SDimitry Andric   return false;
15360b57cec5SDimitry Andric }
15370b57cec5SDimitry Andric 
15380b57cec5SDimitry Andric /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
15390b57cec5SDimitry Andric /// to a constant, or if it does but contains a label, return false.  If it
15400b57cec5SDimitry Andric /// constant folds return true and set the boolean result in Result.
15410b57cec5SDimitry Andric bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
15420b57cec5SDimitry Andric                                                    bool &ResultBool,
15430b57cec5SDimitry Andric                                                    bool AllowLabels) {
15440b57cec5SDimitry Andric   llvm::APSInt ResultInt;
15450b57cec5SDimitry Andric   if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels))
15460b57cec5SDimitry Andric     return false;
15470b57cec5SDimitry Andric 
15480b57cec5SDimitry Andric   ResultBool = ResultInt.getBoolValue();
15490b57cec5SDimitry Andric   return true;
15500b57cec5SDimitry Andric }
15510b57cec5SDimitry Andric 
15520b57cec5SDimitry Andric /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
15530b57cec5SDimitry Andric /// to a constant, or if it does but contains a label, return false.  If it
15540b57cec5SDimitry Andric /// constant folds return true and set the folded value.
15550b57cec5SDimitry Andric bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
15560b57cec5SDimitry Andric                                                    llvm::APSInt &ResultInt,
15570b57cec5SDimitry Andric                                                    bool AllowLabels) {
15580b57cec5SDimitry Andric   // FIXME: Rename and handle conversion of other evaluatable things
15590b57cec5SDimitry Andric   // to bool.
15600b57cec5SDimitry Andric   Expr::EvalResult Result;
15610b57cec5SDimitry Andric   if (!Cond->EvaluateAsInt(Result, getContext()))
15620b57cec5SDimitry Andric     return false;  // Not foldable, not integer or not fully evaluatable.
15630b57cec5SDimitry Andric 
15640b57cec5SDimitry Andric   llvm::APSInt Int = Result.Val.getInt();
15650b57cec5SDimitry Andric   if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond))
15660b57cec5SDimitry Andric     return false;  // Contains a label.
15670b57cec5SDimitry Andric 
15680b57cec5SDimitry Andric   ResultInt = Int;
15690b57cec5SDimitry Andric   return true;
15700b57cec5SDimitry Andric }
15710b57cec5SDimitry Andric 
1572e8d8bef9SDimitry Andric /// Determine whether the given condition is an instrumentable condition
1573e8d8bef9SDimitry Andric /// (i.e. no "&&" or "||").
1574e8d8bef9SDimitry Andric bool CodeGenFunction::isInstrumentedCondition(const Expr *C) {
1575e8d8bef9SDimitry Andric   // Bypass simplistic logical-NOT operator before determining whether the
1576e8d8bef9SDimitry Andric   // condition contains any other logical operator.
1577e8d8bef9SDimitry Andric   if (const UnaryOperator *UnOp = dyn_cast<UnaryOperator>(C->IgnoreParens()))
1578e8d8bef9SDimitry Andric     if (UnOp->getOpcode() == UO_LNot)
1579e8d8bef9SDimitry Andric       C = UnOp->getSubExpr();
15800b57cec5SDimitry Andric 
1581e8d8bef9SDimitry Andric   const BinaryOperator *BOp = dyn_cast<BinaryOperator>(C->IgnoreParens());
1582e8d8bef9SDimitry Andric   return (!BOp || !BOp->isLogicalOp());
1583e8d8bef9SDimitry Andric }
1584e8d8bef9SDimitry Andric 
1585e8d8bef9SDimitry Andric /// EmitBranchToCounterBlock - Emit a conditional branch to a new block that
1586e8d8bef9SDimitry Andric /// increments a profile counter based on the semantics of the given logical
1587e8d8bef9SDimitry Andric /// operator opcode.  This is used to instrument branch condition coverage for
1588e8d8bef9SDimitry Andric /// logical operators.
1589e8d8bef9SDimitry Andric void CodeGenFunction::EmitBranchToCounterBlock(
1590e8d8bef9SDimitry Andric     const Expr *Cond, BinaryOperator::Opcode LOp, llvm::BasicBlock *TrueBlock,
1591e8d8bef9SDimitry Andric     llvm::BasicBlock *FalseBlock, uint64_t TrueCount /* = 0 */,
1592e8d8bef9SDimitry Andric     Stmt::Likelihood LH /* =None */, const Expr *CntrIdx /* = nullptr */) {
1593e8d8bef9SDimitry Andric   // If not instrumenting, just emit a branch.
1594e8d8bef9SDimitry Andric   bool InstrumentRegions = CGM.getCodeGenOpts().hasProfileClangInstr();
1595e8d8bef9SDimitry Andric   if (!InstrumentRegions || !isInstrumentedCondition(Cond))
1596e8d8bef9SDimitry Andric     return EmitBranchOnBoolExpr(Cond, TrueBlock, FalseBlock, TrueCount, LH);
1597e8d8bef9SDimitry Andric 
1598e8d8bef9SDimitry Andric   llvm::BasicBlock *ThenBlock = NULL;
1599e8d8bef9SDimitry Andric   llvm::BasicBlock *ElseBlock = NULL;
1600e8d8bef9SDimitry Andric   llvm::BasicBlock *NextBlock = NULL;
1601e8d8bef9SDimitry Andric 
1602e8d8bef9SDimitry Andric   // Create the block we'll use to increment the appropriate counter.
1603e8d8bef9SDimitry Andric   llvm::BasicBlock *CounterIncrBlock = createBasicBlock("lop.rhscnt");
1604e8d8bef9SDimitry Andric 
1605e8d8bef9SDimitry Andric   // Set block pointers according to Logical-AND (BO_LAnd) semantics. This
1606e8d8bef9SDimitry Andric   // means we need to evaluate the condition and increment the counter on TRUE:
1607e8d8bef9SDimitry Andric   //
1608e8d8bef9SDimitry Andric   // if (Cond)
1609e8d8bef9SDimitry Andric   //   goto CounterIncrBlock;
1610e8d8bef9SDimitry Andric   // else
1611e8d8bef9SDimitry Andric   //   goto FalseBlock;
1612e8d8bef9SDimitry Andric   //
1613e8d8bef9SDimitry Andric   // CounterIncrBlock:
1614e8d8bef9SDimitry Andric   //   Counter++;
1615e8d8bef9SDimitry Andric   //   goto TrueBlock;
1616e8d8bef9SDimitry Andric 
1617e8d8bef9SDimitry Andric   if (LOp == BO_LAnd) {
1618e8d8bef9SDimitry Andric     ThenBlock = CounterIncrBlock;
1619e8d8bef9SDimitry Andric     ElseBlock = FalseBlock;
1620e8d8bef9SDimitry Andric     NextBlock = TrueBlock;
1621e8d8bef9SDimitry Andric   }
1622e8d8bef9SDimitry Andric 
1623e8d8bef9SDimitry Andric   // Set block pointers according to Logical-OR (BO_LOr) semantics. This means
1624e8d8bef9SDimitry Andric   // we need to evaluate the condition and increment the counter on FALSE:
1625e8d8bef9SDimitry Andric   //
1626e8d8bef9SDimitry Andric   // if (Cond)
1627e8d8bef9SDimitry Andric   //   goto TrueBlock;
1628e8d8bef9SDimitry Andric   // else
1629e8d8bef9SDimitry Andric   //   goto CounterIncrBlock;
1630e8d8bef9SDimitry Andric   //
1631e8d8bef9SDimitry Andric   // CounterIncrBlock:
1632e8d8bef9SDimitry Andric   //   Counter++;
1633e8d8bef9SDimitry Andric   //   goto FalseBlock;
1634e8d8bef9SDimitry Andric 
1635e8d8bef9SDimitry Andric   else if (LOp == BO_LOr) {
1636e8d8bef9SDimitry Andric     ThenBlock = TrueBlock;
1637e8d8bef9SDimitry Andric     ElseBlock = CounterIncrBlock;
1638e8d8bef9SDimitry Andric     NextBlock = FalseBlock;
1639e8d8bef9SDimitry Andric   } else {
1640e8d8bef9SDimitry Andric     llvm_unreachable("Expected Opcode must be that of a Logical Operator");
1641e8d8bef9SDimitry Andric   }
1642e8d8bef9SDimitry Andric 
1643e8d8bef9SDimitry Andric   // Emit Branch based on condition.
1644e8d8bef9SDimitry Andric   EmitBranchOnBoolExpr(Cond, ThenBlock, ElseBlock, TrueCount, LH);
1645e8d8bef9SDimitry Andric 
1646e8d8bef9SDimitry Andric   // Emit the block containing the counter increment(s).
1647e8d8bef9SDimitry Andric   EmitBlock(CounterIncrBlock);
1648e8d8bef9SDimitry Andric 
1649e8d8bef9SDimitry Andric   // Increment corresponding counter; if index not provided, use Cond as index.
1650e8d8bef9SDimitry Andric   incrementProfileCounter(CntrIdx ? CntrIdx : Cond);
1651e8d8bef9SDimitry Andric 
1652e8d8bef9SDimitry Andric   // Go to the next block.
1653e8d8bef9SDimitry Andric   EmitBranch(NextBlock);
1654e8d8bef9SDimitry Andric }
16550b57cec5SDimitry Andric 
16560b57cec5SDimitry Andric /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
16570b57cec5SDimitry Andric /// statement) to the specified blocks.  Based on the condition, this might try
16580b57cec5SDimitry Andric /// to simplify the codegen of the conditional based on the branch.
1659e8d8bef9SDimitry Andric /// \param LH The value of the likelihood attribute on the True branch.
16600b57cec5SDimitry Andric void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
16610b57cec5SDimitry Andric                                            llvm::BasicBlock *TrueBlock,
16620b57cec5SDimitry Andric                                            llvm::BasicBlock *FalseBlock,
1663e8d8bef9SDimitry Andric                                            uint64_t TrueCount,
1664e8d8bef9SDimitry Andric                                            Stmt::Likelihood LH) {
16650b57cec5SDimitry Andric   Cond = Cond->IgnoreParens();
16660b57cec5SDimitry Andric 
16670b57cec5SDimitry Andric   if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
16680b57cec5SDimitry Andric 
16690b57cec5SDimitry Andric     // Handle X && Y in a condition.
16700b57cec5SDimitry Andric     if (CondBOp->getOpcode() == BO_LAnd) {
16710b57cec5SDimitry Andric       // If we have "1 && X", simplify the code.  "0 && X" would have constant
16720b57cec5SDimitry Andric       // folded if the case was simple enough.
16730b57cec5SDimitry Andric       bool ConstantBool = false;
16740b57cec5SDimitry Andric       if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
16750b57cec5SDimitry Andric           ConstantBool) {
16760b57cec5SDimitry Andric         // br(1 && X) -> br(X).
16770b57cec5SDimitry Andric         incrementProfileCounter(CondBOp);
1678e8d8bef9SDimitry Andric         return EmitBranchToCounterBlock(CondBOp->getRHS(), BO_LAnd, TrueBlock,
1679e8d8bef9SDimitry Andric                                         FalseBlock, TrueCount, LH);
16800b57cec5SDimitry Andric       }
16810b57cec5SDimitry Andric 
16820b57cec5SDimitry Andric       // If we have "X && 1", simplify the code to use an uncond branch.
16830b57cec5SDimitry Andric       // "X && 0" would have been constant folded to 0.
16840b57cec5SDimitry Andric       if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
16850b57cec5SDimitry Andric           ConstantBool) {
16860b57cec5SDimitry Andric         // br(X && 1) -> br(X).
1687e8d8bef9SDimitry Andric         return EmitBranchToCounterBlock(CondBOp->getLHS(), BO_LAnd, TrueBlock,
1688e8d8bef9SDimitry Andric                                         FalseBlock, TrueCount, LH, CondBOp);
16890b57cec5SDimitry Andric       }
16900b57cec5SDimitry Andric 
16910b57cec5SDimitry Andric       // Emit the LHS as a conditional.  If the LHS conditional is false, we
16920b57cec5SDimitry Andric       // want to jump to the FalseBlock.
16930b57cec5SDimitry Andric       llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
16940b57cec5SDimitry Andric       // The counter tells us how often we evaluate RHS, and all of TrueCount
16950b57cec5SDimitry Andric       // can be propagated to that branch.
16960b57cec5SDimitry Andric       uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
16970b57cec5SDimitry Andric 
16980b57cec5SDimitry Andric       ConditionalEvaluation eval(*this);
16990b57cec5SDimitry Andric       {
17000b57cec5SDimitry Andric         ApplyDebugLocation DL(*this, Cond);
1701e8d8bef9SDimitry Andric         // Propagate the likelihood attribute like __builtin_expect
1702e8d8bef9SDimitry Andric         // __builtin_expect(X && Y, 1) -> X and Y are likely
1703e8d8bef9SDimitry Andric         // __builtin_expect(X && Y, 0) -> only Y is unlikely
1704e8d8bef9SDimitry Andric         EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount,
1705e8d8bef9SDimitry Andric                              LH == Stmt::LH_Unlikely ? Stmt::LH_None : LH);
17060b57cec5SDimitry Andric         EmitBlock(LHSTrue);
17070b57cec5SDimitry Andric       }
17080b57cec5SDimitry Andric 
17090b57cec5SDimitry Andric       incrementProfileCounter(CondBOp);
17100b57cec5SDimitry Andric       setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
17110b57cec5SDimitry Andric 
17120b57cec5SDimitry Andric       // Any temporaries created here are conditional.
17130b57cec5SDimitry Andric       eval.begin(*this);
1714e8d8bef9SDimitry Andric       EmitBranchToCounterBlock(CondBOp->getRHS(), BO_LAnd, TrueBlock,
1715e8d8bef9SDimitry Andric                                FalseBlock, TrueCount, LH);
17160b57cec5SDimitry Andric       eval.end(*this);
17170b57cec5SDimitry Andric 
17180b57cec5SDimitry Andric       return;
17190b57cec5SDimitry Andric     }
17200b57cec5SDimitry Andric 
17210b57cec5SDimitry Andric     if (CondBOp->getOpcode() == BO_LOr) {
17220b57cec5SDimitry Andric       // If we have "0 || X", simplify the code.  "1 || X" would have constant
17230b57cec5SDimitry Andric       // folded if the case was simple enough.
17240b57cec5SDimitry Andric       bool ConstantBool = false;
17250b57cec5SDimitry Andric       if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
17260b57cec5SDimitry Andric           !ConstantBool) {
17270b57cec5SDimitry Andric         // br(0 || X) -> br(X).
17280b57cec5SDimitry Andric         incrementProfileCounter(CondBOp);
1729e8d8bef9SDimitry Andric         return EmitBranchToCounterBlock(CondBOp->getRHS(), BO_LOr, TrueBlock,
1730e8d8bef9SDimitry Andric                                         FalseBlock, TrueCount, LH);
17310b57cec5SDimitry Andric       }
17320b57cec5SDimitry Andric 
17330b57cec5SDimitry Andric       // If we have "X || 0", simplify the code to use an uncond branch.
17340b57cec5SDimitry Andric       // "X || 1" would have been constant folded to 1.
17350b57cec5SDimitry Andric       if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
17360b57cec5SDimitry Andric           !ConstantBool) {
17370b57cec5SDimitry Andric         // br(X || 0) -> br(X).
1738e8d8bef9SDimitry Andric         return EmitBranchToCounterBlock(CondBOp->getLHS(), BO_LOr, TrueBlock,
1739e8d8bef9SDimitry Andric                                         FalseBlock, TrueCount, LH, CondBOp);
17400b57cec5SDimitry Andric       }
17410b57cec5SDimitry Andric 
17420b57cec5SDimitry Andric       // Emit the LHS as a conditional.  If the LHS conditional is true, we
17430b57cec5SDimitry Andric       // want to jump to the TrueBlock.
17440b57cec5SDimitry Andric       llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
17450b57cec5SDimitry Andric       // We have the count for entry to the RHS and for the whole expression
17460b57cec5SDimitry Andric       // being true, so we can divy up True count between the short circuit and
17470b57cec5SDimitry Andric       // the RHS.
17480b57cec5SDimitry Andric       uint64_t LHSCount =
17490b57cec5SDimitry Andric           getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
17500b57cec5SDimitry Andric       uint64_t RHSCount = TrueCount - LHSCount;
17510b57cec5SDimitry Andric 
17520b57cec5SDimitry Andric       ConditionalEvaluation eval(*this);
17530b57cec5SDimitry Andric       {
1754e8d8bef9SDimitry Andric         // Propagate the likelihood attribute like __builtin_expect
1755e8d8bef9SDimitry Andric         // __builtin_expect(X || Y, 1) -> only Y is likely
1756e8d8bef9SDimitry Andric         // __builtin_expect(X || Y, 0) -> both X and Y are unlikely
17570b57cec5SDimitry Andric         ApplyDebugLocation DL(*this, Cond);
1758e8d8bef9SDimitry Andric         EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount,
1759e8d8bef9SDimitry Andric                              LH == Stmt::LH_Likely ? Stmt::LH_None : LH);
17600b57cec5SDimitry Andric         EmitBlock(LHSFalse);
17610b57cec5SDimitry Andric       }
17620b57cec5SDimitry Andric 
17630b57cec5SDimitry Andric       incrementProfileCounter(CondBOp);
17640b57cec5SDimitry Andric       setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
17650b57cec5SDimitry Andric 
17660b57cec5SDimitry Andric       // Any temporaries created here are conditional.
17670b57cec5SDimitry Andric       eval.begin(*this);
1768e8d8bef9SDimitry Andric       EmitBranchToCounterBlock(CondBOp->getRHS(), BO_LOr, TrueBlock, FalseBlock,
1769e8d8bef9SDimitry Andric                                RHSCount, LH);
17700b57cec5SDimitry Andric 
17710b57cec5SDimitry Andric       eval.end(*this);
17720b57cec5SDimitry Andric 
17730b57cec5SDimitry Andric       return;
17740b57cec5SDimitry Andric     }
17750b57cec5SDimitry Andric   }
17760b57cec5SDimitry Andric 
17770b57cec5SDimitry Andric   if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
17780b57cec5SDimitry Andric     // br(!x, t, f) -> br(x, f, t)
17790b57cec5SDimitry Andric     if (CondUOp->getOpcode() == UO_LNot) {
17800b57cec5SDimitry Andric       // Negate the count.
17810b57cec5SDimitry Andric       uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
1782e8d8bef9SDimitry Andric       // The values of the enum are chosen to make this negation possible.
1783e8d8bef9SDimitry Andric       LH = static_cast<Stmt::Likelihood>(-LH);
17840b57cec5SDimitry Andric       // Negate the condition and swap the destination blocks.
17850b57cec5SDimitry Andric       return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1786e8d8bef9SDimitry Andric                                   FalseCount, LH);
17870b57cec5SDimitry Andric     }
17880b57cec5SDimitry Andric   }
17890b57cec5SDimitry Andric 
17900b57cec5SDimitry Andric   if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
17910b57cec5SDimitry Andric     // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
17920b57cec5SDimitry Andric     llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
17930b57cec5SDimitry Andric     llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
17940b57cec5SDimitry Andric 
1795e8d8bef9SDimitry Andric     // The ConditionalOperator itself has no likelihood information for its
1796e8d8bef9SDimitry Andric     // true and false branches. This matches the behavior of __builtin_expect.
17970b57cec5SDimitry Andric     ConditionalEvaluation cond(*this);
17980b57cec5SDimitry Andric     EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1799e8d8bef9SDimitry Andric                          getProfileCount(CondOp), Stmt::LH_None);
18000b57cec5SDimitry Andric 
18010b57cec5SDimitry Andric     // When computing PGO branch weights, we only know the overall count for
18020b57cec5SDimitry Andric     // the true block. This code is essentially doing tail duplication of the
18030b57cec5SDimitry Andric     // naive code-gen, introducing new edges for which counts are not
18040b57cec5SDimitry Andric     // available. Divide the counts proportionally between the LHS and RHS of
18050b57cec5SDimitry Andric     // the conditional operator.
18060b57cec5SDimitry Andric     uint64_t LHSScaledTrueCount = 0;
18070b57cec5SDimitry Andric     if (TrueCount) {
18080b57cec5SDimitry Andric       double LHSRatio =
18090b57cec5SDimitry Andric           getProfileCount(CondOp) / (double)getCurrentProfileCount();
18100b57cec5SDimitry Andric       LHSScaledTrueCount = TrueCount * LHSRatio;
18110b57cec5SDimitry Andric     }
18120b57cec5SDimitry Andric 
18130b57cec5SDimitry Andric     cond.begin(*this);
18140b57cec5SDimitry Andric     EmitBlock(LHSBlock);
18150b57cec5SDimitry Andric     incrementProfileCounter(CondOp);
18160b57cec5SDimitry Andric     {
18170b57cec5SDimitry Andric       ApplyDebugLocation DL(*this, Cond);
18180b57cec5SDimitry Andric       EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1819e8d8bef9SDimitry Andric                            LHSScaledTrueCount, LH);
18200b57cec5SDimitry Andric     }
18210b57cec5SDimitry Andric     cond.end(*this);
18220b57cec5SDimitry Andric 
18230b57cec5SDimitry Andric     cond.begin(*this);
18240b57cec5SDimitry Andric     EmitBlock(RHSBlock);
18250b57cec5SDimitry Andric     EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1826e8d8bef9SDimitry Andric                          TrueCount - LHSScaledTrueCount, LH);
18270b57cec5SDimitry Andric     cond.end(*this);
18280b57cec5SDimitry Andric 
18290b57cec5SDimitry Andric     return;
18300b57cec5SDimitry Andric   }
18310b57cec5SDimitry Andric 
18320b57cec5SDimitry Andric   if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
18330b57cec5SDimitry Andric     // Conditional operator handling can give us a throw expression as a
18340b57cec5SDimitry Andric     // condition for a case like:
18350b57cec5SDimitry Andric     //   br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
18360b57cec5SDimitry Andric     // Fold this to:
18370b57cec5SDimitry Andric     //   br(c, throw x, br(y, t, f))
18380b57cec5SDimitry Andric     EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
18390b57cec5SDimitry Andric     return;
18400b57cec5SDimitry Andric   }
18410b57cec5SDimitry Andric 
1842fe6060f1SDimitry Andric   // Emit the code with the fully general case.
1843fe6060f1SDimitry Andric   llvm::Value *CondV;
1844fe6060f1SDimitry Andric   {
1845fe6060f1SDimitry Andric     ApplyDebugLocation DL(*this, Cond);
1846fe6060f1SDimitry Andric     CondV = EvaluateExprAsBool(Cond);
1847fe6060f1SDimitry Andric   }
1848fe6060f1SDimitry Andric 
1849fe6060f1SDimitry Andric   llvm::MDNode *Weights = nullptr;
1850fe6060f1SDimitry Andric   llvm::MDNode *Unpredictable = nullptr;
1851fe6060f1SDimitry Andric 
18520b57cec5SDimitry Andric   // If the branch has a condition wrapped by __builtin_unpredictable,
18530b57cec5SDimitry Andric   // create metadata that specifies that the branch is unpredictable.
18540b57cec5SDimitry Andric   // Don't bother if not optimizing because that metadata would not be used.
18550b57cec5SDimitry Andric   auto *Call = dyn_cast<CallExpr>(Cond->IgnoreImpCasts());
18560b57cec5SDimitry Andric   if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
18570b57cec5SDimitry Andric     auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
18580b57cec5SDimitry Andric     if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
18590b57cec5SDimitry Andric       llvm::MDBuilder MDHelper(getLLVMContext());
18600b57cec5SDimitry Andric       Unpredictable = MDHelper.createUnpredictable();
18610b57cec5SDimitry Andric     }
18620b57cec5SDimitry Andric   }
18630b57cec5SDimitry Andric 
1864fe6060f1SDimitry Andric   // If there is a Likelihood knowledge for the cond, lower it.
1865fe6060f1SDimitry Andric   // Note that if not optimizing this won't emit anything.
1866fe6060f1SDimitry Andric   llvm::Value *NewCondV = emitCondLikelihoodViaExpectIntrinsic(CondV, LH);
1867fe6060f1SDimitry Andric   if (CondV != NewCondV)
1868fe6060f1SDimitry Andric     CondV = NewCondV;
1869fe6060f1SDimitry Andric   else {
1870fe6060f1SDimitry Andric     // Otherwise, lower profile counts. Note that we do this even at -O0.
18710b57cec5SDimitry Andric     uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
1872e8d8bef9SDimitry Andric     Weights = createProfileWeights(TrueCount, CurrentCount - TrueCount);
1873e8d8bef9SDimitry Andric   }
18740b57cec5SDimitry Andric 
18750b57cec5SDimitry Andric   Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
18760b57cec5SDimitry Andric }
18770b57cec5SDimitry Andric 
18780b57cec5SDimitry Andric /// ErrorUnsupported - Print out an error that codegen doesn't support the
18790b57cec5SDimitry Andric /// specified stmt yet.
18800b57cec5SDimitry Andric void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
18810b57cec5SDimitry Andric   CGM.ErrorUnsupported(S, Type);
18820b57cec5SDimitry Andric }
18830b57cec5SDimitry Andric 
18840b57cec5SDimitry Andric /// emitNonZeroVLAInit - Emit the "zero" initialization of a
18850b57cec5SDimitry Andric /// variable-length array whose elements have a non-zero bit-pattern.
18860b57cec5SDimitry Andric ///
18870b57cec5SDimitry Andric /// \param baseType the inner-most element type of the array
18880b57cec5SDimitry Andric /// \param src - a char* pointing to the bit-pattern for a single
18890b57cec5SDimitry Andric /// base element of the array
18900b57cec5SDimitry Andric /// \param sizeInChars - the total size of the VLA, in chars
18910b57cec5SDimitry Andric static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
18920b57cec5SDimitry Andric                                Address dest, Address src,
18930b57cec5SDimitry Andric                                llvm::Value *sizeInChars) {
18940b57cec5SDimitry Andric   CGBuilderTy &Builder = CGF.Builder;
18950b57cec5SDimitry Andric 
18960b57cec5SDimitry Andric   CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
18970b57cec5SDimitry Andric   llvm::Value *baseSizeInChars
18980b57cec5SDimitry Andric     = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
18990b57cec5SDimitry Andric 
19000b57cec5SDimitry Andric   Address begin =
19010b57cec5SDimitry Andric     Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1902fe6060f1SDimitry Andric   llvm::Value *end = Builder.CreateInBoundsGEP(
1903fe6060f1SDimitry Andric       begin.getElementType(), begin.getPointer(), sizeInChars, "vla.end");
19040b57cec5SDimitry Andric 
19050b57cec5SDimitry Andric   llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
19060b57cec5SDimitry Andric   llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
19070b57cec5SDimitry Andric   llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
19080b57cec5SDimitry Andric 
19090b57cec5SDimitry Andric   // Make a loop over the VLA.  C99 guarantees that the VLA element
19100b57cec5SDimitry Andric   // count must be nonzero.
19110b57cec5SDimitry Andric   CGF.EmitBlock(loopBB);
19120b57cec5SDimitry Andric 
19130b57cec5SDimitry Andric   llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
19140b57cec5SDimitry Andric   cur->addIncoming(begin.getPointer(), originBB);
19150b57cec5SDimitry Andric 
19160b57cec5SDimitry Andric   CharUnits curAlign =
19170b57cec5SDimitry Andric     dest.getAlignment().alignmentOfArrayElement(baseSize);
19180b57cec5SDimitry Andric 
19190b57cec5SDimitry Andric   // memcpy the individual element bit-pattern.
19200b57cec5SDimitry Andric   Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
19210b57cec5SDimitry Andric                        /*volatile*/ false);
19220b57cec5SDimitry Andric 
19230b57cec5SDimitry Andric   // Go to the next element.
19240b57cec5SDimitry Andric   llvm::Value *next =
19250b57cec5SDimitry Andric     Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
19260b57cec5SDimitry Andric 
19270b57cec5SDimitry Andric   // Leave if that's the end of the VLA.
19280b57cec5SDimitry Andric   llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
19290b57cec5SDimitry Andric   Builder.CreateCondBr(done, contBB, loopBB);
19300b57cec5SDimitry Andric   cur->addIncoming(next, loopBB);
19310b57cec5SDimitry Andric 
19320b57cec5SDimitry Andric   CGF.EmitBlock(contBB);
19330b57cec5SDimitry Andric }
19340b57cec5SDimitry Andric 
19350b57cec5SDimitry Andric void
19360b57cec5SDimitry Andric CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
19370b57cec5SDimitry Andric   // Ignore empty classes in C++.
19380b57cec5SDimitry Andric   if (getLangOpts().CPlusPlus) {
19390b57cec5SDimitry Andric     if (const RecordType *RT = Ty->getAs<RecordType>()) {
19400b57cec5SDimitry Andric       if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
19410b57cec5SDimitry Andric         return;
19420b57cec5SDimitry Andric     }
19430b57cec5SDimitry Andric   }
19440b57cec5SDimitry Andric 
19450b57cec5SDimitry Andric   // Cast the dest ptr to the appropriate i8 pointer type.
19460b57cec5SDimitry Andric   if (DestPtr.getElementType() != Int8Ty)
19470b57cec5SDimitry Andric     DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
19480b57cec5SDimitry Andric 
19490b57cec5SDimitry Andric   // Get size and alignment info for this aggregate.
19500b57cec5SDimitry Andric   CharUnits size = getContext().getTypeSizeInChars(Ty);
19510b57cec5SDimitry Andric 
19520b57cec5SDimitry Andric   llvm::Value *SizeVal;
19530b57cec5SDimitry Andric   const VariableArrayType *vla;
19540b57cec5SDimitry Andric 
19550b57cec5SDimitry Andric   // Don't bother emitting a zero-byte memset.
19560b57cec5SDimitry Andric   if (size.isZero()) {
19570b57cec5SDimitry Andric     // But note that getTypeInfo returns 0 for a VLA.
19580b57cec5SDimitry Andric     if (const VariableArrayType *vlaType =
19590b57cec5SDimitry Andric           dyn_cast_or_null<VariableArrayType>(
19600b57cec5SDimitry Andric                                           getContext().getAsArrayType(Ty))) {
19610b57cec5SDimitry Andric       auto VlaSize = getVLASize(vlaType);
19620b57cec5SDimitry Andric       SizeVal = VlaSize.NumElts;
19630b57cec5SDimitry Andric       CharUnits eltSize = getContext().getTypeSizeInChars(VlaSize.Type);
19640b57cec5SDimitry Andric       if (!eltSize.isOne())
19650b57cec5SDimitry Andric         SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
19660b57cec5SDimitry Andric       vla = vlaType;
19670b57cec5SDimitry Andric     } else {
19680b57cec5SDimitry Andric       return;
19690b57cec5SDimitry Andric     }
19700b57cec5SDimitry Andric   } else {
19710b57cec5SDimitry Andric     SizeVal = CGM.getSize(size);
19720b57cec5SDimitry Andric     vla = nullptr;
19730b57cec5SDimitry Andric   }
19740b57cec5SDimitry Andric 
19750b57cec5SDimitry Andric   // If the type contains a pointer to data member we can't memset it to zero.
19760b57cec5SDimitry Andric   // Instead, create a null constant and copy it to the destination.
19770b57cec5SDimitry Andric   // TODO: there are other patterns besides zero that we can usefully memset,
19780b57cec5SDimitry Andric   // like -1, which happens to be the pattern used by member-pointers.
19790b57cec5SDimitry Andric   if (!CGM.getTypes().isZeroInitializable(Ty)) {
19800b57cec5SDimitry Andric     // For a VLA, emit a single element, then splat that over the VLA.
19810b57cec5SDimitry Andric     if (vla) Ty = getContext().getBaseElementType(vla);
19820b57cec5SDimitry Andric 
19830b57cec5SDimitry Andric     llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
19840b57cec5SDimitry Andric 
19850b57cec5SDimitry Andric     llvm::GlobalVariable *NullVariable =
19860b57cec5SDimitry Andric       new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
19870b57cec5SDimitry Andric                                /*isConstant=*/true,
19880b57cec5SDimitry Andric                                llvm::GlobalVariable::PrivateLinkage,
19890b57cec5SDimitry Andric                                NullConstant, Twine());
19900b57cec5SDimitry Andric     CharUnits NullAlign = DestPtr.getAlignment();
1991a7dea167SDimitry Andric     NullVariable->setAlignment(NullAlign.getAsAlign());
19920b57cec5SDimitry Andric     Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
19930b57cec5SDimitry Andric                    NullAlign);
19940b57cec5SDimitry Andric 
19950b57cec5SDimitry Andric     if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
19960b57cec5SDimitry Andric 
19970b57cec5SDimitry Andric     // Get and call the appropriate llvm.memcpy overload.
19980b57cec5SDimitry Andric     Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
19990b57cec5SDimitry Andric     return;
20000b57cec5SDimitry Andric   }
20010b57cec5SDimitry Andric 
20020b57cec5SDimitry Andric   // Otherwise, just memset the whole thing to zero.  This is legal
20030b57cec5SDimitry Andric   // because in LLVM, all default initializers (other than the ones we just
20040b57cec5SDimitry Andric   // handled above) are guaranteed to have a bit pattern of all zeros.
20050b57cec5SDimitry Andric   Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
20060b57cec5SDimitry Andric }
20070b57cec5SDimitry Andric 
20080b57cec5SDimitry Andric llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
20090b57cec5SDimitry Andric   // Make sure that there is a block for the indirect goto.
20100b57cec5SDimitry Andric   if (!IndirectBranch)
20110b57cec5SDimitry Andric     GetIndirectGotoBlock();
20120b57cec5SDimitry Andric 
20130b57cec5SDimitry Andric   llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
20140b57cec5SDimitry Andric 
20150b57cec5SDimitry Andric   // Make sure the indirect branch includes all of the address-taken blocks.
20160b57cec5SDimitry Andric   IndirectBranch->addDestination(BB);
20170b57cec5SDimitry Andric   return llvm::BlockAddress::get(CurFn, BB);
20180b57cec5SDimitry Andric }
20190b57cec5SDimitry Andric 
20200b57cec5SDimitry Andric llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
20210b57cec5SDimitry Andric   // If we already made the indirect branch for indirect goto, return its block.
20220b57cec5SDimitry Andric   if (IndirectBranch) return IndirectBranch->getParent();
20230b57cec5SDimitry Andric 
20240b57cec5SDimitry Andric   CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
20250b57cec5SDimitry Andric 
20260b57cec5SDimitry Andric   // Create the PHI node that indirect gotos will add entries to.
20270b57cec5SDimitry Andric   llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
20280b57cec5SDimitry Andric                                               "indirect.goto.dest");
20290b57cec5SDimitry Andric 
20300b57cec5SDimitry Andric   // Create the indirect branch instruction.
20310b57cec5SDimitry Andric   IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
20320b57cec5SDimitry Andric   return IndirectBranch->getParent();
20330b57cec5SDimitry Andric }
20340b57cec5SDimitry Andric 
20350b57cec5SDimitry Andric /// Computes the length of an array in elements, as well as the base
20360b57cec5SDimitry Andric /// element type and a properly-typed first element pointer.
20370b57cec5SDimitry Andric llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
20380b57cec5SDimitry Andric                                               QualType &baseType,
20390b57cec5SDimitry Andric                                               Address &addr) {
20400b57cec5SDimitry Andric   const ArrayType *arrayType = origArrayType;
20410b57cec5SDimitry Andric 
20420b57cec5SDimitry Andric   // If it's a VLA, we have to load the stored size.  Note that
20430b57cec5SDimitry Andric   // this is the size of the VLA in bytes, not its size in elements.
20440b57cec5SDimitry Andric   llvm::Value *numVLAElements = nullptr;
20450b57cec5SDimitry Andric   if (isa<VariableArrayType>(arrayType)) {
20460b57cec5SDimitry Andric     numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).NumElts;
20470b57cec5SDimitry Andric 
20480b57cec5SDimitry Andric     // Walk into all VLAs.  This doesn't require changes to addr,
20490b57cec5SDimitry Andric     // which has type T* where T is the first non-VLA element type.
20500b57cec5SDimitry Andric     do {
20510b57cec5SDimitry Andric       QualType elementType = arrayType->getElementType();
20520b57cec5SDimitry Andric       arrayType = getContext().getAsArrayType(elementType);
20530b57cec5SDimitry Andric 
20540b57cec5SDimitry Andric       // If we only have VLA components, 'addr' requires no adjustment.
20550b57cec5SDimitry Andric       if (!arrayType) {
20560b57cec5SDimitry Andric         baseType = elementType;
20570b57cec5SDimitry Andric         return numVLAElements;
20580b57cec5SDimitry Andric       }
20590b57cec5SDimitry Andric     } while (isa<VariableArrayType>(arrayType));
20600b57cec5SDimitry Andric 
20610b57cec5SDimitry Andric     // We get out here only if we find a constant array type
20620b57cec5SDimitry Andric     // inside the VLA.
20630b57cec5SDimitry Andric   }
20640b57cec5SDimitry Andric 
20650b57cec5SDimitry Andric   // We have some number of constant-length arrays, so addr should
20660b57cec5SDimitry Andric   // have LLVM type [M x [N x [...]]]*.  Build a GEP that walks
20670b57cec5SDimitry Andric   // down to the first element of addr.
20680b57cec5SDimitry Andric   SmallVector<llvm::Value*, 8> gepIndices;
20690b57cec5SDimitry Andric 
20700b57cec5SDimitry Andric   // GEP down to the array type.
20710b57cec5SDimitry Andric   llvm::ConstantInt *zero = Builder.getInt32(0);
20720b57cec5SDimitry Andric   gepIndices.push_back(zero);
20730b57cec5SDimitry Andric 
20740b57cec5SDimitry Andric   uint64_t countFromCLAs = 1;
20750b57cec5SDimitry Andric   QualType eltType;
20760b57cec5SDimitry Andric 
20770b57cec5SDimitry Andric   llvm::ArrayType *llvmArrayType =
20780b57cec5SDimitry Andric     dyn_cast<llvm::ArrayType>(addr.getElementType());
20790b57cec5SDimitry Andric   while (llvmArrayType) {
20800b57cec5SDimitry Andric     assert(isa<ConstantArrayType>(arrayType));
20810b57cec5SDimitry Andric     assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
20820b57cec5SDimitry Andric              == llvmArrayType->getNumElements());
20830b57cec5SDimitry Andric 
20840b57cec5SDimitry Andric     gepIndices.push_back(zero);
20850b57cec5SDimitry Andric     countFromCLAs *= llvmArrayType->getNumElements();
20860b57cec5SDimitry Andric     eltType = arrayType->getElementType();
20870b57cec5SDimitry Andric 
20880b57cec5SDimitry Andric     llvmArrayType =
20890b57cec5SDimitry Andric       dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
20900b57cec5SDimitry Andric     arrayType = getContext().getAsArrayType(arrayType->getElementType());
20910b57cec5SDimitry Andric     assert((!llvmArrayType || arrayType) &&
20920b57cec5SDimitry Andric            "LLVM and Clang types are out-of-synch");
20930b57cec5SDimitry Andric   }
20940b57cec5SDimitry Andric 
20950b57cec5SDimitry Andric   if (arrayType) {
20960b57cec5SDimitry Andric     // From this point onwards, the Clang array type has been emitted
20970b57cec5SDimitry Andric     // as some other type (probably a packed struct). Compute the array
20980b57cec5SDimitry Andric     // size, and just emit the 'begin' expression as a bitcast.
20990b57cec5SDimitry Andric     while (arrayType) {
21000b57cec5SDimitry Andric       countFromCLAs *=
21010b57cec5SDimitry Andric           cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
21020b57cec5SDimitry Andric       eltType = arrayType->getElementType();
21030b57cec5SDimitry Andric       arrayType = getContext().getAsArrayType(eltType);
21040b57cec5SDimitry Andric     }
21050b57cec5SDimitry Andric 
21060b57cec5SDimitry Andric     llvm::Type *baseType = ConvertType(eltType);
21070b57cec5SDimitry Andric     addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
21080b57cec5SDimitry Andric   } else {
21090b57cec5SDimitry Andric     // Create the actual GEP.
2110fe6060f1SDimitry Andric     addr = Address(Builder.CreateInBoundsGEP(
2111fe6060f1SDimitry Andric         addr.getElementType(), addr.getPointer(), gepIndices, "array.begin"),
21120b57cec5SDimitry Andric         addr.getAlignment());
21130b57cec5SDimitry Andric   }
21140b57cec5SDimitry Andric 
21150b57cec5SDimitry Andric   baseType = eltType;
21160b57cec5SDimitry Andric 
21170b57cec5SDimitry Andric   llvm::Value *numElements
21180b57cec5SDimitry Andric     = llvm::ConstantInt::get(SizeTy, countFromCLAs);
21190b57cec5SDimitry Andric 
21200b57cec5SDimitry Andric   // If we had any VLA dimensions, factor them in.
21210b57cec5SDimitry Andric   if (numVLAElements)
21220b57cec5SDimitry Andric     numElements = Builder.CreateNUWMul(numVLAElements, numElements);
21230b57cec5SDimitry Andric 
21240b57cec5SDimitry Andric   return numElements;
21250b57cec5SDimitry Andric }
21260b57cec5SDimitry Andric 
21270b57cec5SDimitry Andric CodeGenFunction::VlaSizePair CodeGenFunction::getVLASize(QualType type) {
21280b57cec5SDimitry Andric   const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
21290b57cec5SDimitry Andric   assert(vla && "type was not a variable array type!");
21300b57cec5SDimitry Andric   return getVLASize(vla);
21310b57cec5SDimitry Andric }
21320b57cec5SDimitry Andric 
21330b57cec5SDimitry Andric CodeGenFunction::VlaSizePair
21340b57cec5SDimitry Andric CodeGenFunction::getVLASize(const VariableArrayType *type) {
21350b57cec5SDimitry Andric   // The number of elements so far; always size_t.
21360b57cec5SDimitry Andric   llvm::Value *numElements = nullptr;
21370b57cec5SDimitry Andric 
21380b57cec5SDimitry Andric   QualType elementType;
21390b57cec5SDimitry Andric   do {
21400b57cec5SDimitry Andric     elementType = type->getElementType();
21410b57cec5SDimitry Andric     llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
21420b57cec5SDimitry Andric     assert(vlaSize && "no size for VLA!");
21430b57cec5SDimitry Andric     assert(vlaSize->getType() == SizeTy);
21440b57cec5SDimitry Andric 
21450b57cec5SDimitry Andric     if (!numElements) {
21460b57cec5SDimitry Andric       numElements = vlaSize;
21470b57cec5SDimitry Andric     } else {
21480b57cec5SDimitry Andric       // It's undefined behavior if this wraps around, so mark it that way.
21490b57cec5SDimitry Andric       // FIXME: Teach -fsanitize=undefined to trap this.
21500b57cec5SDimitry Andric       numElements = Builder.CreateNUWMul(numElements, vlaSize);
21510b57cec5SDimitry Andric     }
21520b57cec5SDimitry Andric   } while ((type = getContext().getAsVariableArrayType(elementType)));
21530b57cec5SDimitry Andric 
21540b57cec5SDimitry Andric   return { numElements, elementType };
21550b57cec5SDimitry Andric }
21560b57cec5SDimitry Andric 
21570b57cec5SDimitry Andric CodeGenFunction::VlaSizePair
21580b57cec5SDimitry Andric CodeGenFunction::getVLAElements1D(QualType type) {
21590b57cec5SDimitry Andric   const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
21600b57cec5SDimitry Andric   assert(vla && "type was not a variable array type!");
21610b57cec5SDimitry Andric   return getVLAElements1D(vla);
21620b57cec5SDimitry Andric }
21630b57cec5SDimitry Andric 
21640b57cec5SDimitry Andric CodeGenFunction::VlaSizePair
21650b57cec5SDimitry Andric CodeGenFunction::getVLAElements1D(const VariableArrayType *Vla) {
21660b57cec5SDimitry Andric   llvm::Value *VlaSize = VLASizeMap[Vla->getSizeExpr()];
21670b57cec5SDimitry Andric   assert(VlaSize && "no size for VLA!");
21680b57cec5SDimitry Andric   assert(VlaSize->getType() == SizeTy);
21690b57cec5SDimitry Andric   return { VlaSize, Vla->getElementType() };
21700b57cec5SDimitry Andric }
21710b57cec5SDimitry Andric 
21720b57cec5SDimitry Andric void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
21730b57cec5SDimitry Andric   assert(type->isVariablyModifiedType() &&
21740b57cec5SDimitry Andric          "Must pass variably modified type to EmitVLASizes!");
21750b57cec5SDimitry Andric 
21760b57cec5SDimitry Andric   EnsureInsertPoint();
21770b57cec5SDimitry Andric 
21780b57cec5SDimitry Andric   // We're going to walk down into the type and look for VLA
21790b57cec5SDimitry Andric   // expressions.
21800b57cec5SDimitry Andric   do {
21810b57cec5SDimitry Andric     assert(type->isVariablyModifiedType());
21820b57cec5SDimitry Andric 
21830b57cec5SDimitry Andric     const Type *ty = type.getTypePtr();
21840b57cec5SDimitry Andric     switch (ty->getTypeClass()) {
21850b57cec5SDimitry Andric 
21860b57cec5SDimitry Andric #define TYPE(Class, Base)
21870b57cec5SDimitry Andric #define ABSTRACT_TYPE(Class, Base)
21880b57cec5SDimitry Andric #define NON_CANONICAL_TYPE(Class, Base)
21890b57cec5SDimitry Andric #define DEPENDENT_TYPE(Class, Base) case Type::Class:
21900b57cec5SDimitry Andric #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
2191a7dea167SDimitry Andric #include "clang/AST/TypeNodes.inc"
21920b57cec5SDimitry Andric       llvm_unreachable("unexpected dependent type!");
21930b57cec5SDimitry Andric 
21940b57cec5SDimitry Andric     // These types are never variably-modified.
21950b57cec5SDimitry Andric     case Type::Builtin:
21960b57cec5SDimitry Andric     case Type::Complex:
21970b57cec5SDimitry Andric     case Type::Vector:
21980b57cec5SDimitry Andric     case Type::ExtVector:
21995ffd83dbSDimitry Andric     case Type::ConstantMatrix:
22000b57cec5SDimitry Andric     case Type::Record:
22010b57cec5SDimitry Andric     case Type::Enum:
22020b57cec5SDimitry Andric     case Type::Elaborated:
22030eae32dcSDimitry Andric     case Type::Using:
22040b57cec5SDimitry Andric     case Type::TemplateSpecialization:
22050b57cec5SDimitry Andric     case Type::ObjCTypeParam:
22060b57cec5SDimitry Andric     case Type::ObjCObject:
22070b57cec5SDimitry Andric     case Type::ObjCInterface:
22080b57cec5SDimitry Andric     case Type::ObjCObjectPointer:
22090eae32dcSDimitry Andric     case Type::BitInt:
22100b57cec5SDimitry Andric       llvm_unreachable("type class is never variably-modified!");
22110b57cec5SDimitry Andric 
22120b57cec5SDimitry Andric     case Type::Adjusted:
22130b57cec5SDimitry Andric       type = cast<AdjustedType>(ty)->getAdjustedType();
22140b57cec5SDimitry Andric       break;
22150b57cec5SDimitry Andric 
22160b57cec5SDimitry Andric     case Type::Decayed:
22170b57cec5SDimitry Andric       type = cast<DecayedType>(ty)->getPointeeType();
22180b57cec5SDimitry Andric       break;
22190b57cec5SDimitry Andric 
22200b57cec5SDimitry Andric     case Type::Pointer:
22210b57cec5SDimitry Andric       type = cast<PointerType>(ty)->getPointeeType();
22220b57cec5SDimitry Andric       break;
22230b57cec5SDimitry Andric 
22240b57cec5SDimitry Andric     case Type::BlockPointer:
22250b57cec5SDimitry Andric       type = cast<BlockPointerType>(ty)->getPointeeType();
22260b57cec5SDimitry Andric       break;
22270b57cec5SDimitry Andric 
22280b57cec5SDimitry Andric     case Type::LValueReference:
22290b57cec5SDimitry Andric     case Type::RValueReference:
22300b57cec5SDimitry Andric       type = cast<ReferenceType>(ty)->getPointeeType();
22310b57cec5SDimitry Andric       break;
22320b57cec5SDimitry Andric 
22330b57cec5SDimitry Andric     case Type::MemberPointer:
22340b57cec5SDimitry Andric       type = cast<MemberPointerType>(ty)->getPointeeType();
22350b57cec5SDimitry Andric       break;
22360b57cec5SDimitry Andric 
22370b57cec5SDimitry Andric     case Type::ConstantArray:
22380b57cec5SDimitry Andric     case Type::IncompleteArray:
22390b57cec5SDimitry Andric       // Losing element qualification here is fine.
22400b57cec5SDimitry Andric       type = cast<ArrayType>(ty)->getElementType();
22410b57cec5SDimitry Andric       break;
22420b57cec5SDimitry Andric 
22430b57cec5SDimitry Andric     case Type::VariableArray: {
22440b57cec5SDimitry Andric       // Losing element qualification here is fine.
22450b57cec5SDimitry Andric       const VariableArrayType *vat = cast<VariableArrayType>(ty);
22460b57cec5SDimitry Andric 
22470b57cec5SDimitry Andric       // Unknown size indication requires no size computation.
22480b57cec5SDimitry Andric       // Otherwise, evaluate and record it.
22490b57cec5SDimitry Andric       if (const Expr *size = vat->getSizeExpr()) {
22500b57cec5SDimitry Andric         // It's possible that we might have emitted this already,
22510b57cec5SDimitry Andric         // e.g. with a typedef and a pointer to it.
22520b57cec5SDimitry Andric         llvm::Value *&entry = VLASizeMap[size];
22530b57cec5SDimitry Andric         if (!entry) {
22540b57cec5SDimitry Andric           llvm::Value *Size = EmitScalarExpr(size);
22550b57cec5SDimitry Andric 
22560b57cec5SDimitry Andric           // C11 6.7.6.2p5:
22570b57cec5SDimitry Andric           //   If the size is an expression that is not an integer constant
22580b57cec5SDimitry Andric           //   expression [...] each time it is evaluated it shall have a value
22590b57cec5SDimitry Andric           //   greater than zero.
22600b57cec5SDimitry Andric           if (SanOpts.has(SanitizerKind::VLABound) &&
22610b57cec5SDimitry Andric               size->getType()->isSignedIntegerType()) {
22620b57cec5SDimitry Andric             SanitizerScope SanScope(this);
22630b57cec5SDimitry Andric             llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
22640b57cec5SDimitry Andric             llvm::Constant *StaticArgs[] = {
22650b57cec5SDimitry Andric                 EmitCheckSourceLocation(size->getBeginLoc()),
22660b57cec5SDimitry Andric                 EmitCheckTypeDescriptor(size->getType())};
22670b57cec5SDimitry Andric             EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
22680b57cec5SDimitry Andric                                      SanitizerKind::VLABound),
22690b57cec5SDimitry Andric                       SanitizerHandler::VLABoundNotPositive, StaticArgs, Size);
22700b57cec5SDimitry Andric           }
22710b57cec5SDimitry Andric 
22720b57cec5SDimitry Andric           // Always zexting here would be wrong if it weren't
22730b57cec5SDimitry Andric           // undefined behavior to have a negative bound.
22740b57cec5SDimitry Andric           entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
22750b57cec5SDimitry Andric         }
22760b57cec5SDimitry Andric       }
22770b57cec5SDimitry Andric       type = vat->getElementType();
22780b57cec5SDimitry Andric       break;
22790b57cec5SDimitry Andric     }
22800b57cec5SDimitry Andric 
22810b57cec5SDimitry Andric     case Type::FunctionProto:
22820b57cec5SDimitry Andric     case Type::FunctionNoProto:
22830b57cec5SDimitry Andric       type = cast<FunctionType>(ty)->getReturnType();
22840b57cec5SDimitry Andric       break;
22850b57cec5SDimitry Andric 
22860b57cec5SDimitry Andric     case Type::Paren:
22870b57cec5SDimitry Andric     case Type::TypeOf:
22880b57cec5SDimitry Andric     case Type::UnaryTransform:
22890b57cec5SDimitry Andric     case Type::Attributed:
22900b57cec5SDimitry Andric     case Type::SubstTemplateTypeParm:
22910b57cec5SDimitry Andric     case Type::MacroQualified:
22920b57cec5SDimitry Andric       // Keep walking after single level desugaring.
22930b57cec5SDimitry Andric       type = type.getSingleStepDesugaredType(getContext());
22940b57cec5SDimitry Andric       break;
22950b57cec5SDimitry Andric 
22960b57cec5SDimitry Andric     case Type::Typedef:
22970b57cec5SDimitry Andric     case Type::Decltype:
22980b57cec5SDimitry Andric     case Type::Auto:
22990b57cec5SDimitry Andric     case Type::DeducedTemplateSpecialization:
23000b57cec5SDimitry Andric       // Stop walking: nothing to do.
23010b57cec5SDimitry Andric       return;
23020b57cec5SDimitry Andric 
23030b57cec5SDimitry Andric     case Type::TypeOfExpr:
23040b57cec5SDimitry Andric       // Stop walking: emit typeof expression.
23050b57cec5SDimitry Andric       EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
23060b57cec5SDimitry Andric       return;
23070b57cec5SDimitry Andric 
23080b57cec5SDimitry Andric     case Type::Atomic:
23090b57cec5SDimitry Andric       type = cast<AtomicType>(ty)->getValueType();
23100b57cec5SDimitry Andric       break;
23110b57cec5SDimitry Andric 
23120b57cec5SDimitry Andric     case Type::Pipe:
23130b57cec5SDimitry Andric       type = cast<PipeType>(ty)->getElementType();
23140b57cec5SDimitry Andric       break;
23150b57cec5SDimitry Andric     }
23160b57cec5SDimitry Andric   } while (type->isVariablyModifiedType());
23170b57cec5SDimitry Andric }
23180b57cec5SDimitry Andric 
23190b57cec5SDimitry Andric Address CodeGenFunction::EmitVAListRef(const Expr* E) {
23200b57cec5SDimitry Andric   if (getContext().getBuiltinVaListType()->isArrayType())
23210b57cec5SDimitry Andric     return EmitPointerWithAlignment(E);
2322480093f4SDimitry Andric   return EmitLValue(E).getAddress(*this);
23230b57cec5SDimitry Andric }
23240b57cec5SDimitry Andric 
23250b57cec5SDimitry Andric Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
2326480093f4SDimitry Andric   return EmitLValue(E).getAddress(*this);
23270b57cec5SDimitry Andric }
23280b57cec5SDimitry Andric 
23290b57cec5SDimitry Andric void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
23300b57cec5SDimitry Andric                                               const APValue &Init) {
23310b57cec5SDimitry Andric   assert(Init.hasValue() && "Invalid DeclRefExpr initializer!");
23320b57cec5SDimitry Andric   if (CGDebugInfo *Dbg = getDebugInfo())
2333480093f4SDimitry Andric     if (CGM.getCodeGenOpts().hasReducedDebugInfo())
23340b57cec5SDimitry Andric       Dbg->EmitGlobalVariable(E->getDecl(), Init);
23350b57cec5SDimitry Andric }
23360b57cec5SDimitry Andric 
23370b57cec5SDimitry Andric CodeGenFunction::PeepholeProtection
23380b57cec5SDimitry Andric CodeGenFunction::protectFromPeepholes(RValue rvalue) {
23390b57cec5SDimitry Andric   // At the moment, the only aggressive peephole we do in IR gen
23400b57cec5SDimitry Andric   // is trunc(zext) folding, but if we add more, we can easily
23410b57cec5SDimitry Andric   // extend this protection.
23420b57cec5SDimitry Andric 
23430b57cec5SDimitry Andric   if (!rvalue.isScalar()) return PeepholeProtection();
23440b57cec5SDimitry Andric   llvm::Value *value = rvalue.getScalarVal();
23450b57cec5SDimitry Andric   if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
23460b57cec5SDimitry Andric 
23470b57cec5SDimitry Andric   // Just make an extra bitcast.
23480b57cec5SDimitry Andric   assert(HaveInsertPoint());
23490b57cec5SDimitry Andric   llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
23500b57cec5SDimitry Andric                                                   Builder.GetInsertBlock());
23510b57cec5SDimitry Andric 
23520b57cec5SDimitry Andric   PeepholeProtection protection;
23530b57cec5SDimitry Andric   protection.Inst = inst;
23540b57cec5SDimitry Andric   return protection;
23550b57cec5SDimitry Andric }
23560b57cec5SDimitry Andric 
23570b57cec5SDimitry Andric void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
23580b57cec5SDimitry Andric   if (!protection.Inst) return;
23590b57cec5SDimitry Andric 
23600b57cec5SDimitry Andric   // In theory, we could try to duplicate the peepholes now, but whatever.
23610b57cec5SDimitry Andric   protection.Inst->eraseFromParent();
23620b57cec5SDimitry Andric }
23630b57cec5SDimitry Andric 
23645ffd83dbSDimitry Andric void CodeGenFunction::emitAlignmentAssumption(llvm::Value *PtrValue,
23650b57cec5SDimitry Andric                                               QualType Ty, SourceLocation Loc,
23660b57cec5SDimitry Andric                                               SourceLocation AssumptionLoc,
23670b57cec5SDimitry Andric                                               llvm::Value *Alignment,
23680b57cec5SDimitry Andric                                               llvm::Value *OffsetValue) {
2369e8d8bef9SDimitry Andric   if (Alignment->getType() != IntPtrTy)
2370e8d8bef9SDimitry Andric     Alignment =
2371e8d8bef9SDimitry Andric         Builder.CreateIntCast(Alignment, IntPtrTy, false, "casted.align");
2372e8d8bef9SDimitry Andric   if (OffsetValue && OffsetValue->getType() != IntPtrTy)
2373e8d8bef9SDimitry Andric     OffsetValue =
2374e8d8bef9SDimitry Andric         Builder.CreateIntCast(OffsetValue, IntPtrTy, true, "casted.offset");
2375e8d8bef9SDimitry Andric   llvm::Value *TheCheck = nullptr;
2376590d96feSDimitry Andric   if (SanOpts.has(SanitizerKind::Alignment)) {
2377e8d8bef9SDimitry Andric     llvm::Value *PtrIntValue =
2378e8d8bef9SDimitry Andric         Builder.CreatePtrToInt(PtrValue, IntPtrTy, "ptrint");
2379e8d8bef9SDimitry Andric 
2380e8d8bef9SDimitry Andric     if (OffsetValue) {
2381e8d8bef9SDimitry Andric       bool IsOffsetZero = false;
2382e8d8bef9SDimitry Andric       if (const auto *CI = dyn_cast<llvm::ConstantInt>(OffsetValue))
2383e8d8bef9SDimitry Andric         IsOffsetZero = CI->isZero();
2384e8d8bef9SDimitry Andric 
2385e8d8bef9SDimitry Andric       if (!IsOffsetZero)
2386e8d8bef9SDimitry Andric         PtrIntValue = Builder.CreateSub(PtrIntValue, OffsetValue, "offsetptr");
2387e8d8bef9SDimitry Andric     }
2388e8d8bef9SDimitry Andric 
2389e8d8bef9SDimitry Andric     llvm::Value *Zero = llvm::ConstantInt::get(IntPtrTy, 0);
2390e8d8bef9SDimitry Andric     llvm::Value *Mask =
2391e8d8bef9SDimitry Andric         Builder.CreateSub(Alignment, llvm::ConstantInt::get(IntPtrTy, 1));
2392e8d8bef9SDimitry Andric     llvm::Value *MaskedPtr = Builder.CreateAnd(PtrIntValue, Mask, "maskedptr");
2393e8d8bef9SDimitry Andric     TheCheck = Builder.CreateICmpEQ(MaskedPtr, Zero, "maskcond");
2394e8d8bef9SDimitry Andric   }
2395e8d8bef9SDimitry Andric   llvm::Instruction *Assumption = Builder.CreateAlignmentAssumption(
2396e8d8bef9SDimitry Andric       CGM.getDataLayout(), PtrValue, Alignment, OffsetValue);
2397e8d8bef9SDimitry Andric 
2398e8d8bef9SDimitry Andric   if (!SanOpts.has(SanitizerKind::Alignment))
2399e8d8bef9SDimitry Andric     return;
24005ffd83dbSDimitry Andric   emitAlignmentAssumptionCheck(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
24015ffd83dbSDimitry Andric                                OffsetValue, TheCheck, Assumption);
24025ffd83dbSDimitry Andric }
24035ffd83dbSDimitry Andric 
24045ffd83dbSDimitry Andric void CodeGenFunction::emitAlignmentAssumption(llvm::Value *PtrValue,
24050b57cec5SDimitry Andric                                               const Expr *E,
24060b57cec5SDimitry Andric                                               SourceLocation AssumptionLoc,
2407a7dea167SDimitry Andric                                               llvm::Value *Alignment,
24080b57cec5SDimitry Andric                                               llvm::Value *OffsetValue) {
24090b57cec5SDimitry Andric   if (auto *CE = dyn_cast<CastExpr>(E))
24100b57cec5SDimitry Andric     E = CE->getSubExprAsWritten();
24110b57cec5SDimitry Andric   QualType Ty = E->getType();
24120b57cec5SDimitry Andric   SourceLocation Loc = E->getExprLoc();
24130b57cec5SDimitry Andric 
24145ffd83dbSDimitry Andric   emitAlignmentAssumption(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
24150b57cec5SDimitry Andric                           OffsetValue);
24160b57cec5SDimitry Andric }
24170b57cec5SDimitry Andric 
24180b57cec5SDimitry Andric llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Function *AnnotationFn,
24190b57cec5SDimitry Andric                                                  llvm::Value *AnnotatedVal,
24200b57cec5SDimitry Andric                                                  StringRef AnnotationStr,
2421e8d8bef9SDimitry Andric                                                  SourceLocation Location,
2422e8d8bef9SDimitry Andric                                                  const AnnotateAttr *Attr) {
2423e8d8bef9SDimitry Andric   SmallVector<llvm::Value *, 5> Args = {
24240b57cec5SDimitry Andric       AnnotatedVal,
24250b57cec5SDimitry Andric       Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
24260b57cec5SDimitry Andric       Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
2427e8d8bef9SDimitry Andric       CGM.EmitAnnotationLineNo(Location),
24280b57cec5SDimitry Andric   };
2429e8d8bef9SDimitry Andric   if (Attr)
2430e8d8bef9SDimitry Andric     Args.push_back(CGM.EmitAnnotationArgs(Attr));
24310b57cec5SDimitry Andric   return Builder.CreateCall(AnnotationFn, Args);
24320b57cec5SDimitry Andric }
24330b57cec5SDimitry Andric 
24340b57cec5SDimitry Andric void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
24350b57cec5SDimitry Andric   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
24360b57cec5SDimitry Andric   // FIXME We create a new bitcast for every annotation because that's what
24370b57cec5SDimitry Andric   // llvm-gcc was doing.
24380b57cec5SDimitry Andric   for (const auto *I : D->specific_attrs<AnnotateAttr>())
24390b57cec5SDimitry Andric     EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
24400b57cec5SDimitry Andric                        Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
2441e8d8bef9SDimitry Andric                        I->getAnnotation(), D->getLocation(), I);
24420b57cec5SDimitry Andric }
24430b57cec5SDimitry Andric 
24440b57cec5SDimitry Andric Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
24450b57cec5SDimitry Andric                                               Address Addr) {
24460b57cec5SDimitry Andric   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
24470b57cec5SDimitry Andric   llvm::Value *V = Addr.getPointer();
24480b57cec5SDimitry Andric   llvm::Type *VTy = V->getType();
2449349cc55cSDimitry Andric   auto *PTy = dyn_cast<llvm::PointerType>(VTy);
2450349cc55cSDimitry Andric   unsigned AS = PTy ? PTy->getAddressSpace() : 0;
2451349cc55cSDimitry Andric   llvm::PointerType *IntrinTy =
2452349cc55cSDimitry Andric       llvm::PointerType::getWithSamePointeeType(CGM.Int8PtrTy, AS);
2453349cc55cSDimitry Andric   llvm::Function *F =
2454349cc55cSDimitry Andric       CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation, IntrinTy);
24550b57cec5SDimitry Andric 
24560b57cec5SDimitry Andric   for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
24570b57cec5SDimitry Andric     // FIXME Always emit the cast inst so we can differentiate between
24580b57cec5SDimitry Andric     // annotation on the first field of a struct and annotation on the struct
24590b57cec5SDimitry Andric     // itself.
2460349cc55cSDimitry Andric     if (VTy != IntrinTy)
2461349cc55cSDimitry Andric       V = Builder.CreateBitCast(V, IntrinTy);
2462e8d8bef9SDimitry Andric     V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation(), I);
24630b57cec5SDimitry Andric     V = Builder.CreateBitCast(V, VTy);
24640b57cec5SDimitry Andric   }
24650b57cec5SDimitry Andric 
24660b57cec5SDimitry Andric   return Address(V, Addr.getAlignment());
24670b57cec5SDimitry Andric }
24680b57cec5SDimitry Andric 
24690b57cec5SDimitry Andric CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
24700b57cec5SDimitry Andric 
24710b57cec5SDimitry Andric CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
24720b57cec5SDimitry Andric     : CGF(CGF) {
24730b57cec5SDimitry Andric   assert(!CGF->IsSanitizerScope);
24740b57cec5SDimitry Andric   CGF->IsSanitizerScope = true;
24750b57cec5SDimitry Andric }
24760b57cec5SDimitry Andric 
24770b57cec5SDimitry Andric CodeGenFunction::SanitizerScope::~SanitizerScope() {
24780b57cec5SDimitry Andric   CGF->IsSanitizerScope = false;
24790b57cec5SDimitry Andric }
24800b57cec5SDimitry Andric 
24810b57cec5SDimitry Andric void CodeGenFunction::InsertHelper(llvm::Instruction *I,
24820b57cec5SDimitry Andric                                    const llvm::Twine &Name,
24830b57cec5SDimitry Andric                                    llvm::BasicBlock *BB,
24840b57cec5SDimitry Andric                                    llvm::BasicBlock::iterator InsertPt) const {
24850b57cec5SDimitry Andric   LoopStack.InsertHelper(I);
24860b57cec5SDimitry Andric   if (IsSanitizerScope)
24870b57cec5SDimitry Andric     CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
24880b57cec5SDimitry Andric }
24890b57cec5SDimitry Andric 
24900b57cec5SDimitry Andric void CGBuilderInserter::InsertHelper(
24910b57cec5SDimitry Andric     llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
24920b57cec5SDimitry Andric     llvm::BasicBlock::iterator InsertPt) const {
24930b57cec5SDimitry Andric   llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt);
24940b57cec5SDimitry Andric   if (CGF)
24950b57cec5SDimitry Andric     CGF->InsertHelper(I, Name, BB, InsertPt);
24960b57cec5SDimitry Andric }
24970b57cec5SDimitry Andric 
24980b57cec5SDimitry Andric // Emits an error if we don't have a valid set of target features for the
24990b57cec5SDimitry Andric // called function.
25000b57cec5SDimitry Andric void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
25010b57cec5SDimitry Andric                                           const FunctionDecl *TargetDecl) {
25020b57cec5SDimitry Andric   return checkTargetFeatures(E->getBeginLoc(), TargetDecl);
25030b57cec5SDimitry Andric }
25040b57cec5SDimitry Andric 
25050b57cec5SDimitry Andric // Emits an error if we don't have a valid set of target features for the
25060b57cec5SDimitry Andric // called function.
25070b57cec5SDimitry Andric void CodeGenFunction::checkTargetFeatures(SourceLocation Loc,
25080b57cec5SDimitry Andric                                           const FunctionDecl *TargetDecl) {
25090b57cec5SDimitry Andric   // Early exit if this is an indirect call.
25100b57cec5SDimitry Andric   if (!TargetDecl)
25110b57cec5SDimitry Andric     return;
25120b57cec5SDimitry Andric 
25130b57cec5SDimitry Andric   // Get the current enclosing function if it exists. If it doesn't
25140b57cec5SDimitry Andric   // we can't check the target features anyhow.
2515a7dea167SDimitry Andric   const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
25160b57cec5SDimitry Andric   if (!FD)
25170b57cec5SDimitry Andric     return;
25180b57cec5SDimitry Andric 
25190b57cec5SDimitry Andric   // Grab the required features for the call. For a builtin this is listed in
25200b57cec5SDimitry Andric   // the td file with the default cpu, for an always_inline function this is any
25210b57cec5SDimitry Andric   // listed cpu and any listed features.
25220b57cec5SDimitry Andric   unsigned BuiltinID = TargetDecl->getBuiltinID();
25230b57cec5SDimitry Andric   std::string MissingFeature;
2524e8d8bef9SDimitry Andric   llvm::StringMap<bool> CallerFeatureMap;
2525e8d8bef9SDimitry Andric   CGM.getContext().getFunctionFeatureMap(CallerFeatureMap, FD);
25260b57cec5SDimitry Andric   if (BuiltinID) {
2527e8d8bef9SDimitry Andric     StringRef FeatureList(
2528e8d8bef9SDimitry Andric         CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID));
25290b57cec5SDimitry Andric     // Return if the builtin doesn't have any required features.
2530e8d8bef9SDimitry Andric     if (FeatureList.empty())
25310b57cec5SDimitry Andric       return;
2532349cc55cSDimitry Andric     assert(!FeatureList.contains(' ') && "Space in feature list");
2533e8d8bef9SDimitry Andric     TargetFeatures TF(CallerFeatureMap);
2534e8d8bef9SDimitry Andric     if (!TF.hasRequiredFeatures(FeatureList))
25350b57cec5SDimitry Andric       CGM.getDiags().Report(Loc, diag::err_builtin_needs_feature)
2536e8d8bef9SDimitry Andric           << TargetDecl->getDeclName() << FeatureList;
2537480093f4SDimitry Andric   } else if (!TargetDecl->isMultiVersion() &&
2538480093f4SDimitry Andric              TargetDecl->hasAttr<TargetAttr>()) {
25390b57cec5SDimitry Andric     // Get the required features for the callee.
25400b57cec5SDimitry Andric 
25410b57cec5SDimitry Andric     const TargetAttr *TD = TargetDecl->getAttr<TargetAttr>();
2542480093f4SDimitry Andric     ParsedTargetAttr ParsedAttr =
2543480093f4SDimitry Andric         CGM.getContext().filterFunctionTargetAttrs(TD);
25440b57cec5SDimitry Andric 
25450b57cec5SDimitry Andric     SmallVector<StringRef, 1> ReqFeatures;
25460b57cec5SDimitry Andric     llvm::StringMap<bool> CalleeFeatureMap;
2547*c3ca3130SDimitry Andric     CGM.getContext().getFunctionFeatureMap(CalleeFeatureMap, TargetDecl);
25480b57cec5SDimitry Andric 
25490b57cec5SDimitry Andric     for (const auto &F : ParsedAttr.Features) {
25500b57cec5SDimitry Andric       if (F[0] == '+' && CalleeFeatureMap.lookup(F.substr(1)))
25510b57cec5SDimitry Andric         ReqFeatures.push_back(StringRef(F).substr(1));
25520b57cec5SDimitry Andric     }
25530b57cec5SDimitry Andric 
25540b57cec5SDimitry Andric     for (const auto &F : CalleeFeatureMap) {
25550b57cec5SDimitry Andric       // Only positive features are "required".
25560b57cec5SDimitry Andric       if (F.getValue())
25570b57cec5SDimitry Andric         ReqFeatures.push_back(F.getKey());
25580b57cec5SDimitry Andric     }
2559e8d8bef9SDimitry Andric     if (!llvm::all_of(ReqFeatures, [&](StringRef Feature) {
2560e8d8bef9SDimitry Andric       if (!CallerFeatureMap.lookup(Feature)) {
2561e8d8bef9SDimitry Andric         MissingFeature = Feature.str();
2562e8d8bef9SDimitry Andric         return false;
2563e8d8bef9SDimitry Andric       }
2564e8d8bef9SDimitry Andric       return true;
2565e8d8bef9SDimitry Andric     }))
25660b57cec5SDimitry Andric       CGM.getDiags().Report(Loc, diag::err_function_needs_feature)
25670b57cec5SDimitry Andric           << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature;
25680b57cec5SDimitry Andric   }
25690b57cec5SDimitry Andric }
25700b57cec5SDimitry Andric 
25710b57cec5SDimitry Andric void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) {
25720b57cec5SDimitry Andric   if (!CGM.getCodeGenOpts().SanitizeStats)
25730b57cec5SDimitry Andric     return;
25740b57cec5SDimitry Andric 
25750b57cec5SDimitry Andric   llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint());
25760b57cec5SDimitry Andric   IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation());
25770b57cec5SDimitry Andric   CGM.getSanStats().create(IRB, SSK);
25780b57cec5SDimitry Andric }
25790b57cec5SDimitry Andric 
25800b57cec5SDimitry Andric llvm::Value *
25810b57cec5SDimitry Andric CodeGenFunction::FormResolverCondition(const MultiVersionResolverOption &RO) {
25820b57cec5SDimitry Andric   llvm::Value *Condition = nullptr;
25830b57cec5SDimitry Andric 
25840b57cec5SDimitry Andric   if (!RO.Conditions.Architecture.empty())
25850b57cec5SDimitry Andric     Condition = EmitX86CpuIs(RO.Conditions.Architecture);
25860b57cec5SDimitry Andric 
25870b57cec5SDimitry Andric   if (!RO.Conditions.Features.empty()) {
25880b57cec5SDimitry Andric     llvm::Value *FeatureCond = EmitX86CpuSupports(RO.Conditions.Features);
25890b57cec5SDimitry Andric     Condition =
25900b57cec5SDimitry Andric         Condition ? Builder.CreateAnd(Condition, FeatureCond) : FeatureCond;
25910b57cec5SDimitry Andric   }
25920b57cec5SDimitry Andric   return Condition;
25930b57cec5SDimitry Andric }
25940b57cec5SDimitry Andric 
25950b57cec5SDimitry Andric static void CreateMultiVersionResolverReturn(CodeGenModule &CGM,
25960b57cec5SDimitry Andric                                              llvm::Function *Resolver,
25970b57cec5SDimitry Andric                                              CGBuilderTy &Builder,
25980b57cec5SDimitry Andric                                              llvm::Function *FuncToReturn,
25990b57cec5SDimitry Andric                                              bool SupportsIFunc) {
26000b57cec5SDimitry Andric   if (SupportsIFunc) {
26010b57cec5SDimitry Andric     Builder.CreateRet(FuncToReturn);
26020b57cec5SDimitry Andric     return;
26030b57cec5SDimitry Andric   }
26040b57cec5SDimitry Andric 
26050b57cec5SDimitry Andric   llvm::SmallVector<llvm::Value *, 10> Args;
26060b57cec5SDimitry Andric   llvm::for_each(Resolver->args(),
26070b57cec5SDimitry Andric                  [&](llvm::Argument &Arg) { Args.push_back(&Arg); });
26080b57cec5SDimitry Andric 
26090b57cec5SDimitry Andric   llvm::CallInst *Result = Builder.CreateCall(FuncToReturn, Args);
26100b57cec5SDimitry Andric   Result->setTailCallKind(llvm::CallInst::TCK_MustTail);
26110b57cec5SDimitry Andric 
26120b57cec5SDimitry Andric   if (Resolver->getReturnType()->isVoidTy())
26130b57cec5SDimitry Andric     Builder.CreateRetVoid();
26140b57cec5SDimitry Andric   else
26150b57cec5SDimitry Andric     Builder.CreateRet(Result);
26160b57cec5SDimitry Andric }
26170b57cec5SDimitry Andric 
26180b57cec5SDimitry Andric void CodeGenFunction::EmitMultiVersionResolver(
26190b57cec5SDimitry Andric     llvm::Function *Resolver, ArrayRef<MultiVersionResolverOption> Options) {
2620480093f4SDimitry Andric   assert(getContext().getTargetInfo().getTriple().isX86() &&
26210b57cec5SDimitry Andric          "Only implemented for x86 targets");
26220b57cec5SDimitry Andric 
26230b57cec5SDimitry Andric   bool SupportsIFunc = getContext().getTargetInfo().supportsIFunc();
26240b57cec5SDimitry Andric 
26250b57cec5SDimitry Andric   // Main function's basic block.
26260b57cec5SDimitry Andric   llvm::BasicBlock *CurBlock = createBasicBlock("resolver_entry", Resolver);
26270b57cec5SDimitry Andric   Builder.SetInsertPoint(CurBlock);
26280b57cec5SDimitry Andric   EmitX86CpuInit();
26290b57cec5SDimitry Andric 
26300b57cec5SDimitry Andric   for (const MultiVersionResolverOption &RO : Options) {
26310b57cec5SDimitry Andric     Builder.SetInsertPoint(CurBlock);
26320b57cec5SDimitry Andric     llvm::Value *Condition = FormResolverCondition(RO);
26330b57cec5SDimitry Andric 
26340b57cec5SDimitry Andric     // The 'default' or 'generic' case.
26350b57cec5SDimitry Andric     if (!Condition) {
26360b57cec5SDimitry Andric       assert(&RO == Options.end() - 1 &&
26370b57cec5SDimitry Andric              "Default or Generic case must be last");
26380b57cec5SDimitry Andric       CreateMultiVersionResolverReturn(CGM, Resolver, Builder, RO.Function,
26390b57cec5SDimitry Andric                                        SupportsIFunc);
26400b57cec5SDimitry Andric       return;
26410b57cec5SDimitry Andric     }
26420b57cec5SDimitry Andric 
26430b57cec5SDimitry Andric     llvm::BasicBlock *RetBlock = createBasicBlock("resolver_return", Resolver);
26440b57cec5SDimitry Andric     CGBuilderTy RetBuilder(*this, RetBlock);
26450b57cec5SDimitry Andric     CreateMultiVersionResolverReturn(CGM, Resolver, RetBuilder, RO.Function,
26460b57cec5SDimitry Andric                                      SupportsIFunc);
26470b57cec5SDimitry Andric     CurBlock = createBasicBlock("resolver_else", Resolver);
26480b57cec5SDimitry Andric     Builder.CreateCondBr(Condition, RetBlock, CurBlock);
26490b57cec5SDimitry Andric   }
26500b57cec5SDimitry Andric 
26510b57cec5SDimitry Andric   // If no generic/default, emit an unreachable.
26520b57cec5SDimitry Andric   Builder.SetInsertPoint(CurBlock);
26530b57cec5SDimitry Andric   llvm::CallInst *TrapCall = EmitTrapCall(llvm::Intrinsic::trap);
26540b57cec5SDimitry Andric   TrapCall->setDoesNotReturn();
26550b57cec5SDimitry Andric   TrapCall->setDoesNotThrow();
26560b57cec5SDimitry Andric   Builder.CreateUnreachable();
26570b57cec5SDimitry Andric   Builder.ClearInsertionPoint();
26580b57cec5SDimitry Andric }
26590b57cec5SDimitry Andric 
26600b57cec5SDimitry Andric // Loc - where the diagnostic will point, where in the source code this
26610b57cec5SDimitry Andric //  alignment has failed.
26620b57cec5SDimitry Andric // SecondaryLoc - if present (will be present if sufficiently different from
26630b57cec5SDimitry Andric //  Loc), the diagnostic will additionally point a "Note:" to this location.
26640b57cec5SDimitry Andric //  It should be the location where the __attribute__((assume_aligned))
26650b57cec5SDimitry Andric //  was written e.g.
26665ffd83dbSDimitry Andric void CodeGenFunction::emitAlignmentAssumptionCheck(
26670b57cec5SDimitry Andric     llvm::Value *Ptr, QualType Ty, SourceLocation Loc,
26680b57cec5SDimitry Andric     SourceLocation SecondaryLoc, llvm::Value *Alignment,
26690b57cec5SDimitry Andric     llvm::Value *OffsetValue, llvm::Value *TheCheck,
26700b57cec5SDimitry Andric     llvm::Instruction *Assumption) {
26710b57cec5SDimitry Andric   assert(Assumption && isa<llvm::CallInst>(Assumption) &&
26725ffd83dbSDimitry Andric          cast<llvm::CallInst>(Assumption)->getCalledOperand() ==
26730b57cec5SDimitry Andric              llvm::Intrinsic::getDeclaration(
26740b57cec5SDimitry Andric                  Builder.GetInsertBlock()->getParent()->getParent(),
26750b57cec5SDimitry Andric                  llvm::Intrinsic::assume) &&
26760b57cec5SDimitry Andric          "Assumption should be a call to llvm.assume().");
26770b57cec5SDimitry Andric   assert(&(Builder.GetInsertBlock()->back()) == Assumption &&
26780b57cec5SDimitry Andric          "Assumption should be the last instruction of the basic block, "
26790b57cec5SDimitry Andric          "since the basic block is still being generated.");
26800b57cec5SDimitry Andric 
26810b57cec5SDimitry Andric   if (!SanOpts.has(SanitizerKind::Alignment))
26820b57cec5SDimitry Andric     return;
26830b57cec5SDimitry Andric 
26840b57cec5SDimitry Andric   // Don't check pointers to volatile data. The behavior here is implementation-
26850b57cec5SDimitry Andric   // defined.
26860b57cec5SDimitry Andric   if (Ty->getPointeeType().isVolatileQualified())
26870b57cec5SDimitry Andric     return;
26880b57cec5SDimitry Andric 
26890b57cec5SDimitry Andric   // We need to temorairly remove the assumption so we can insert the
26900b57cec5SDimitry Andric   // sanitizer check before it, else the check will be dropped by optimizations.
26910b57cec5SDimitry Andric   Assumption->removeFromParent();
26920b57cec5SDimitry Andric 
26930b57cec5SDimitry Andric   {
26940b57cec5SDimitry Andric     SanitizerScope SanScope(this);
26950b57cec5SDimitry Andric 
26960b57cec5SDimitry Andric     if (!OffsetValue)
26970b57cec5SDimitry Andric       OffsetValue = Builder.getInt1(0); // no offset.
26980b57cec5SDimitry Andric 
26990b57cec5SDimitry Andric     llvm::Constant *StaticData[] = {EmitCheckSourceLocation(Loc),
27000b57cec5SDimitry Andric                                     EmitCheckSourceLocation(SecondaryLoc),
27010b57cec5SDimitry Andric                                     EmitCheckTypeDescriptor(Ty)};
27020b57cec5SDimitry Andric     llvm::Value *DynamicData[] = {EmitCheckValue(Ptr),
27030b57cec5SDimitry Andric                                   EmitCheckValue(Alignment),
27040b57cec5SDimitry Andric                                   EmitCheckValue(OffsetValue)};
27050b57cec5SDimitry Andric     EmitCheck({std::make_pair(TheCheck, SanitizerKind::Alignment)},
27060b57cec5SDimitry Andric               SanitizerHandler::AlignmentAssumption, StaticData, DynamicData);
27070b57cec5SDimitry Andric   }
27080b57cec5SDimitry Andric 
27090b57cec5SDimitry Andric   // We are now in the (new, empty) "cont" basic block.
27100b57cec5SDimitry Andric   // Reintroduce the assumption.
27110b57cec5SDimitry Andric   Builder.Insert(Assumption);
27120b57cec5SDimitry Andric   // FIXME: Assumption still has it's original basic block as it's Parent.
27130b57cec5SDimitry Andric }
27140b57cec5SDimitry Andric 
27150b57cec5SDimitry Andric llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) {
27160b57cec5SDimitry Andric   if (CGDebugInfo *DI = getDebugInfo())
27170b57cec5SDimitry Andric     return DI->SourceLocToDebugLoc(Location);
27180b57cec5SDimitry Andric 
27190b57cec5SDimitry Andric   return llvm::DebugLoc();
27200b57cec5SDimitry Andric }
2721e8d8bef9SDimitry Andric 
2722fe6060f1SDimitry Andric llvm::Value *
2723fe6060f1SDimitry Andric CodeGenFunction::emitCondLikelihoodViaExpectIntrinsic(llvm::Value *Cond,
2724fe6060f1SDimitry Andric                                                       Stmt::Likelihood LH) {
2725e8d8bef9SDimitry Andric   switch (LH) {
2726e8d8bef9SDimitry Andric   case Stmt::LH_None:
2727fe6060f1SDimitry Andric     return Cond;
2728e8d8bef9SDimitry Andric   case Stmt::LH_Likely:
2729fe6060f1SDimitry Andric   case Stmt::LH_Unlikely:
2730fe6060f1SDimitry Andric     // Don't generate llvm.expect on -O0 as the backend won't use it for
2731fe6060f1SDimitry Andric     // anything.
2732fe6060f1SDimitry Andric     if (CGM.getCodeGenOpts().OptimizationLevel == 0)
2733fe6060f1SDimitry Andric       return Cond;
2734fe6060f1SDimitry Andric     llvm::Type *CondTy = Cond->getType();
2735fe6060f1SDimitry Andric     assert(CondTy->isIntegerTy(1) && "expecting condition to be a boolean");
2736fe6060f1SDimitry Andric     llvm::Function *FnExpect =
2737fe6060f1SDimitry Andric         CGM.getIntrinsic(llvm::Intrinsic::expect, CondTy);
2738fe6060f1SDimitry Andric     llvm::Value *ExpectedValueOfCond =
2739fe6060f1SDimitry Andric         llvm::ConstantInt::getBool(CondTy, LH == Stmt::LH_Likely);
2740fe6060f1SDimitry Andric     return Builder.CreateCall(FnExpect, {Cond, ExpectedValueOfCond},
2741fe6060f1SDimitry Andric                               Cond->getName() + ".expval");
2742e8d8bef9SDimitry Andric   }
2743e8d8bef9SDimitry Andric   llvm_unreachable("Unknown Likelihood");
2744e8d8bef9SDimitry Andric }
2745