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