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