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   // Apply xray attributes to the function (as a string, for now)
803   if (D) {
804     if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) {
805       if (CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
806               XRayInstrKind::Function)) {
807         if (XRayAttr->alwaysXRayInstrument() && ShouldXRayInstrumentFunction())
808           Fn->addFnAttr("function-instrument", "xray-always");
809         if (XRayAttr->neverXRayInstrument())
810           Fn->addFnAttr("function-instrument", "xray-never");
811         if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>())
812           if (ShouldXRayInstrumentFunction())
813             Fn->addFnAttr("xray-log-args",
814                           llvm::utostr(LogArgs->getArgumentCount()));
815       }
816     } else {
817       if (ShouldXRayInstrumentFunction() && !CGM.imbueXRayAttrs(Fn, Loc))
818         Fn->addFnAttr(
819             "xray-instruction-threshold",
820             llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold));
821     }
822   }
823 
824   // Add no-jump-tables value.
825   Fn->addFnAttr("no-jump-tables",
826                 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables));
827 
828   // Add no-inline-line-tables value.
829   if (CGM.getCodeGenOpts().NoInlineLineTables)
830     Fn->addFnAttr("no-inline-line-tables");
831 
832   // Add profile-sample-accurate value.
833   if (CGM.getCodeGenOpts().ProfileSampleAccurate)
834     Fn->addFnAttr("profile-sample-accurate");
835 
836   if (D && D->hasAttr<CFICanonicalJumpTableAttr>())
837     Fn->addFnAttr("cfi-canonical-jump-table");
838 
839   if (getLangOpts().OpenCL) {
840     // Add metadata for a kernel function.
841     if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
842       EmitOpenCLKernelMetadata(FD, Fn);
843   }
844 
845   // If we are checking function types, emit a function type signature as
846   // prologue data.
847   if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
848     if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
849       if (llvm::Constant *PrologueSig = getPrologueSignature(CGM, FD)) {
850         // Remove any (C++17) exception specifications, to allow calling e.g. a
851         // noexcept function through a non-noexcept pointer.
852         auto ProtoTy =
853           getContext().getFunctionTypeWithExceptionSpec(FD->getType(),
854                                                         EST_None);
855         llvm::Constant *FTRTTIConst =
856             CGM.GetAddrOfRTTIDescriptor(ProtoTy, /*ForEH=*/true);
857         llvm::Constant *FTRTTIConstEncoded =
858             EncodeAddrForUseInPrologue(Fn, FTRTTIConst);
859         llvm::Constant *PrologueStructElems[] = {PrologueSig,
860                                                  FTRTTIConstEncoded};
861         llvm::Constant *PrologueStructConst =
862             llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
863         Fn->setPrologueData(PrologueStructConst);
864       }
865     }
866   }
867 
868   // If we're checking nullability, we need to know whether we can check the
869   // return value. Initialize the flag to 'true' and refine it in EmitParmDecl.
870   if (SanOpts.has(SanitizerKind::NullabilityReturn)) {
871     auto Nullability = FnRetTy->getNullability(getContext());
872     if (Nullability && *Nullability == NullabilityKind::NonNull) {
873       if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
874             CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>()))
875         RetValNullabilityPrecondition =
876             llvm::ConstantInt::getTrue(getLLVMContext());
877     }
878   }
879 
880   // If we're in C++ mode and the function name is "main", it is guaranteed
881   // to be norecurse by the standard (3.6.1.3 "The function main shall not be
882   // used within a program").
883   if (getLangOpts().CPlusPlus)
884     if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
885       if (FD->isMain())
886         Fn->addFnAttr(llvm::Attribute::NoRecurse);
887 
888   if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
889     if (FD->usesFPIntrin())
890       Fn->addFnAttr(llvm::Attribute::StrictFP);
891 
892   // If a custom alignment is used, force realigning to this alignment on
893   // any main function which certainly will need it.
894   if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
895     if ((FD->isMain() || FD->isMSVCRTEntryPoint()) &&
896         CGM.getCodeGenOpts().StackAlignment)
897       Fn->addFnAttr("stackrealign");
898 
899   llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
900 
901   // Create a marker to make it easy to insert allocas into the entryblock
902   // later.  Don't create this with the builder, because we don't want it
903   // folded.
904   llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
905   AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB);
906 
907   ReturnBlock = getJumpDestInCurrentScope("return");
908 
909   Builder.SetInsertPoint(EntryBB);
910 
911   // If we're checking the return value, allocate space for a pointer to a
912   // precise source location of the checked return statement.
913   if (requiresReturnValueCheck()) {
914     ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr");
915     InitTempAlloca(ReturnLocation, llvm::ConstantPointerNull::get(Int8PtrTy));
916   }
917 
918   // Emit subprogram debug descriptor.
919   if (CGDebugInfo *DI = getDebugInfo()) {
920     // Reconstruct the type from the argument list so that implicit parameters,
921     // such as 'this' and 'vtt', show up in the debug info. Preserve the calling
922     // convention.
923     CallingConv CC = CallingConv::CC_C;
924     if (auto *FD = dyn_cast_or_null<FunctionDecl>(D))
925       if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>())
926         CC = SrcFnTy->getCallConv();
927     SmallVector<QualType, 16> ArgTypes;
928     for (const VarDecl *VD : Args)
929       ArgTypes.push_back(VD->getType());
930     QualType FnType = getContext().getFunctionType(
931         RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
932     DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, CurFuncIsThunk,
933                           Builder);
934   }
935 
936   if (ShouldInstrumentFunction()) {
937     if (CGM.getCodeGenOpts().InstrumentFunctions)
938       CurFn->addFnAttr("instrument-function-entry", "__cyg_profile_func_enter");
939     if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
940       CurFn->addFnAttr("instrument-function-entry-inlined",
941                        "__cyg_profile_func_enter");
942     if (CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
943       CurFn->addFnAttr("instrument-function-entry-inlined",
944                        "__cyg_profile_func_enter_bare");
945   }
946 
947   // Since emitting the mcount call here impacts optimizations such as function
948   // inlining, we just add an attribute to insert a mcount call in backend.
949   // The attribute "counting-function" is set to mcount function name which is
950   // architecture dependent.
951   if (CGM.getCodeGenOpts().InstrumentForProfiling) {
952     // Calls to fentry/mcount should not be generated if function has
953     // the no_instrument_function attribute.
954     if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) {
955       if (CGM.getCodeGenOpts().CallFEntry)
956         Fn->addFnAttr("fentry-call", "true");
957       else {
958         Fn->addFnAttr("instrument-function-entry-inlined",
959                       getTarget().getMCountName());
960       }
961       if (CGM.getCodeGenOpts().MNopMCount) {
962         if (!CGM.getCodeGenOpts().CallFEntry)
963           CGM.getDiags().Report(diag::err_opt_not_valid_without_opt)
964             << "-mnop-mcount" << "-mfentry";
965         Fn->addFnAttr("mnop-mcount");
966       }
967 
968       if (CGM.getCodeGenOpts().RecordMCount) {
969         if (!CGM.getCodeGenOpts().CallFEntry)
970           CGM.getDiags().Report(diag::err_opt_not_valid_without_opt)
971             << "-mrecord-mcount" << "-mfentry";
972         Fn->addFnAttr("mrecord-mcount");
973       }
974     }
975   }
976 
977   if (CGM.getCodeGenOpts().PackedStack) {
978     if (getContext().getTargetInfo().getTriple().getArch() !=
979         llvm::Triple::systemz)
980       CGM.getDiags().Report(diag::err_opt_not_valid_on_target)
981         << "-mpacked-stack";
982     Fn->addFnAttr("packed-stack");
983   }
984 
985   if (RetTy->isVoidType()) {
986     // Void type; nothing to return.
987     ReturnValue = Address::invalid();
988 
989     // Count the implicit return.
990     if (!endsWithReturn(D))
991       ++NumReturnExprs;
992   } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect) {
993     // Indirect return; emit returned value directly into sret slot.
994     // This reduces code size, and affects correctness in C++.
995     auto AI = CurFn->arg_begin();
996     if (CurFnInfo->getReturnInfo().isSRetAfterThis())
997       ++AI;
998     ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign());
999     if (!CurFnInfo->getReturnInfo().getIndirectByVal()) {
1000       ReturnValuePointer =
1001           CreateDefaultAlignTempAlloca(Int8PtrTy, "result.ptr");
1002       Builder.CreateStore(Builder.CreatePointerBitCastOrAddrSpaceCast(
1003                               ReturnValue.getPointer(), Int8PtrTy),
1004                           ReturnValuePointer);
1005     }
1006   } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
1007              !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
1008     // Load the sret pointer from the argument struct and return into that.
1009     unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
1010     llvm::Function::arg_iterator EI = CurFn->arg_end();
1011     --EI;
1012     llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx);
1013     ReturnValuePointer = Address(Addr, getPointerAlign());
1014     Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result");
1015     ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy));
1016   } else {
1017     ReturnValue = CreateIRTemp(RetTy, "retval");
1018 
1019     // Tell the epilog emitter to autorelease the result.  We do this
1020     // now so that various specialized functions can suppress it
1021     // during their IR-generation.
1022     if (getLangOpts().ObjCAutoRefCount &&
1023         !CurFnInfo->isReturnsRetained() &&
1024         RetTy->isObjCRetainableType())
1025       AutoreleaseResult = true;
1026   }
1027 
1028   EmitStartEHSpec(CurCodeDecl);
1029 
1030   PrologueCleanupDepth = EHStack.stable_begin();
1031 
1032   // Emit OpenMP specific initialization of the device functions.
1033   if (getLangOpts().OpenMP && CurCodeDecl)
1034     CGM.getOpenMPRuntime().emitFunctionProlog(*this, CurCodeDecl);
1035 
1036   EmitFunctionProlog(*CurFnInfo, CurFn, Args);
1037 
1038   if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
1039     CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
1040     const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
1041     if (MD->getParent()->isLambda() &&
1042         MD->getOverloadedOperator() == OO_Call) {
1043       // We're in a lambda; figure out the captures.
1044       MD->getParent()->getCaptureFields(LambdaCaptureFields,
1045                                         LambdaThisCaptureField);
1046       if (LambdaThisCaptureField) {
1047         // If the lambda captures the object referred to by '*this' - either by
1048         // value or by reference, make sure CXXThisValue points to the correct
1049         // object.
1050 
1051         // Get the lvalue for the field (which is a copy of the enclosing object
1052         // or contains the address of the enclosing object).
1053         LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
1054         if (!LambdaThisCaptureField->getType()->isPointerType()) {
1055           // If the enclosing object was captured by value, just use its address.
1056           CXXThisValue = ThisFieldLValue.getAddress(*this).getPointer();
1057         } else {
1058           // Load the lvalue pointed to by the field, since '*this' was captured
1059           // by reference.
1060           CXXThisValue =
1061               EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal();
1062         }
1063       }
1064       for (auto *FD : MD->getParent()->fields()) {
1065         if (FD->hasCapturedVLAType()) {
1066           auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
1067                                            SourceLocation()).getScalarVal();
1068           auto VAT = FD->getCapturedVLAType();
1069           VLASizeMap[VAT->getSizeExpr()] = ExprArg;
1070         }
1071       }
1072     } else {
1073       // Not in a lambda; just use 'this' from the method.
1074       // FIXME: Should we generate a new load for each use of 'this'?  The
1075       // fast register allocator would be happier...
1076       CXXThisValue = CXXABIThisValue;
1077     }
1078 
1079     // Check the 'this' pointer once per function, if it's available.
1080     if (CXXABIThisValue) {
1081       SanitizerSet SkippedChecks;
1082       SkippedChecks.set(SanitizerKind::ObjectSize, true);
1083       QualType ThisTy = MD->getThisType();
1084 
1085       // If this is the call operator of a lambda with no capture-default, it
1086       // may have a static invoker function, which may call this operator with
1087       // a null 'this' pointer.
1088       if (isLambdaCallOperator(MD) &&
1089           MD->getParent()->getLambdaCaptureDefault() == LCD_None)
1090         SkippedChecks.set(SanitizerKind::Null, true);
1091 
1092       EmitTypeCheck(isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall
1093                                                 : TCK_MemberCall,
1094                     Loc, CXXABIThisValue, ThisTy,
1095                     getContext().getTypeAlignInChars(ThisTy->getPointeeType()),
1096                     SkippedChecks);
1097     }
1098   }
1099 
1100   // If any of the arguments have a variably modified type, make sure to
1101   // emit the type size.
1102   for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
1103        i != e; ++i) {
1104     const VarDecl *VD = *i;
1105 
1106     // Dig out the type as written from ParmVarDecls; it's unclear whether
1107     // the standard (C99 6.9.1p10) requires this, but we're following the
1108     // precedent set by gcc.
1109     QualType Ty;
1110     if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
1111       Ty = PVD->getOriginalType();
1112     else
1113       Ty = VD->getType();
1114 
1115     if (Ty->isVariablyModifiedType())
1116       EmitVariablyModifiedType(Ty);
1117   }
1118   // Emit a location at the end of the prologue.
1119   if (CGDebugInfo *DI = getDebugInfo())
1120     DI->EmitLocation(Builder, StartLoc);
1121 
1122   // TODO: Do we need to handle this in two places like we do with
1123   // target-features/target-cpu?
1124   if (CurFuncDecl)
1125     if (const auto *VecWidth = CurFuncDecl->getAttr<MinVectorWidthAttr>())
1126       LargestVectorWidth = VecWidth->getVectorWidth();
1127 }
1128 
1129 void CodeGenFunction::EmitFunctionBody(const Stmt *Body) {
1130   incrementProfileCounter(Body);
1131   if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
1132     EmitCompoundStmtWithoutScope(*S);
1133   else
1134     EmitStmt(Body);
1135 }
1136 
1137 /// When instrumenting to collect profile data, the counts for some blocks
1138 /// such as switch cases need to not include the fall-through counts, so
1139 /// emit a branch around the instrumentation code. When not instrumenting,
1140 /// this just calls EmitBlock().
1141 void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
1142                                                const Stmt *S) {
1143   llvm::BasicBlock *SkipCountBB = nullptr;
1144   if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) {
1145     // When instrumenting for profiling, the fallthrough to certain
1146     // statements needs to skip over the instrumentation code so that we
1147     // get an accurate count.
1148     SkipCountBB = createBasicBlock("skipcount");
1149     EmitBranch(SkipCountBB);
1150   }
1151   EmitBlock(BB);
1152   uint64_t CurrentCount = getCurrentProfileCount();
1153   incrementProfileCounter(S);
1154   setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
1155   if (SkipCountBB)
1156     EmitBlock(SkipCountBB);
1157 }
1158 
1159 /// Tries to mark the given function nounwind based on the
1160 /// non-existence of any throwing calls within it.  We believe this is
1161 /// lightweight enough to do at -O0.
1162 static void TryMarkNoThrow(llvm::Function *F) {
1163   // LLVM treats 'nounwind' on a function as part of the type, so we
1164   // can't do this on functions that can be overwritten.
1165   if (F->isInterposable()) return;
1166 
1167   for (llvm::BasicBlock &BB : *F)
1168     for (llvm::Instruction &I : BB)
1169       if (I.mayThrow())
1170         return;
1171 
1172   F->setDoesNotThrow();
1173 }
1174 
1175 QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD,
1176                                                FunctionArgList &Args) {
1177   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
1178   QualType ResTy = FD->getReturnType();
1179 
1180   const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1181   if (MD && MD->isInstance()) {
1182     if (CGM.getCXXABI().HasThisReturn(GD))
1183       ResTy = MD->getThisType();
1184     else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
1185       ResTy = CGM.getContext().VoidPtrTy;
1186     CGM.getCXXABI().buildThisParam(*this, Args);
1187   }
1188 
1189   // The base version of an inheriting constructor whose constructed base is a
1190   // virtual base is not passed any arguments (because it doesn't actually call
1191   // the inherited constructor).
1192   bool PassedParams = true;
1193   if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
1194     if (auto Inherited = CD->getInheritedConstructor())
1195       PassedParams =
1196           getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType());
1197 
1198   if (PassedParams) {
1199     for (auto *Param : FD->parameters()) {
1200       Args.push_back(Param);
1201       if (!Param->hasAttr<PassObjectSizeAttr>())
1202         continue;
1203 
1204       auto *Implicit = ImplicitParamDecl::Create(
1205           getContext(), Param->getDeclContext(), Param->getLocation(),
1206           /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other);
1207       SizeArguments[Param] = Implicit;
1208       Args.push_back(Implicit);
1209     }
1210   }
1211 
1212   if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
1213     CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
1214 
1215   return ResTy;
1216 }
1217 
1218 static bool
1219 shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD,
1220                                              const ASTContext &Context) {
1221   QualType T = FD->getReturnType();
1222   // Avoid the optimization for functions that return a record type with a
1223   // trivial destructor or another trivially copyable type.
1224   if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) {
1225     if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl()))
1226       return !ClassDecl->hasTrivialDestructor();
1227   }
1228   return !T.isTriviallyCopyableType(Context);
1229 }
1230 
1231 void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1232                                    const CGFunctionInfo &FnInfo) {
1233   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
1234   CurGD = GD;
1235 
1236   FunctionArgList Args;
1237   QualType ResTy = BuildFunctionArgList(GD, Args);
1238 
1239   // Check if we should generate debug info for this function.
1240   if (FD->hasAttr<NoDebugAttr>())
1241     DebugInfo = nullptr; // disable debug info indefinitely for this function
1242 
1243   // The function might not have a body if we're generating thunks for a
1244   // function declaration.
1245   SourceRange BodyRange;
1246   if (Stmt *Body = FD->getBody())
1247     BodyRange = Body->getSourceRange();
1248   else
1249     BodyRange = FD->getLocation();
1250   CurEHLocation = BodyRange.getEnd();
1251 
1252   // Use the location of the start of the function to determine where
1253   // the function definition is located. By default use the location
1254   // of the declaration as the location for the subprogram. A function
1255   // may lack a declaration in the source code if it is created by code
1256   // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
1257   SourceLocation Loc = FD->getLocation();
1258 
1259   // If this is a function specialization then use the pattern body
1260   // as the location for the function.
1261   if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
1262     if (SpecDecl->hasBody(SpecDecl))
1263       Loc = SpecDecl->getLocation();
1264 
1265   Stmt *Body = FD->getBody();
1266 
1267   // Initialize helper which will detect jumps which can cause invalid lifetime
1268   // markers.
1269   if (Body && ShouldEmitLifetimeMarkers)
1270     Bypasses.Init(Body);
1271 
1272   // Emit the standard function prologue.
1273   StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
1274 
1275   // Generate the body of the function.
1276   PGO.assignRegionCounters(GD, CurFn);
1277   if (isa<CXXDestructorDecl>(FD))
1278     EmitDestructorBody(Args);
1279   else if (isa<CXXConstructorDecl>(FD))
1280     EmitConstructorBody(Args);
1281   else if (getLangOpts().CUDA &&
1282            !getLangOpts().CUDAIsDevice &&
1283            FD->hasAttr<CUDAGlobalAttr>())
1284     CGM.getCUDARuntime().emitDeviceStub(*this, Args);
1285   else if (isa<CXXMethodDecl>(FD) &&
1286            cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
1287     // The lambda static invoker function is special, because it forwards or
1288     // clones the body of the function call operator (but is actually static).
1289     EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD));
1290   } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
1291              (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
1292               cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
1293     // Implicit copy-assignment gets the same special treatment as implicit
1294     // copy-constructors.
1295     emitImplicitAssignmentOperatorBody(Args);
1296   } else if (Body) {
1297     EmitFunctionBody(Body);
1298   } else
1299     llvm_unreachable("no definition for emitted function");
1300 
1301   // C++11 [stmt.return]p2:
1302   //   Flowing off the end of a function [...] results in undefined behavior in
1303   //   a value-returning function.
1304   // C11 6.9.1p12:
1305   //   If the '}' that terminates a function is reached, and the value of the
1306   //   function call is used by the caller, the behavior is undefined.
1307   if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
1308       !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
1309     bool ShouldEmitUnreachable =
1310         CGM.getCodeGenOpts().StrictReturn ||
1311         shouldUseUndefinedBehaviorReturnOptimization(FD, getContext());
1312     if (SanOpts.has(SanitizerKind::Return)) {
1313       SanitizerScope SanScope(this);
1314       llvm::Value *IsFalse = Builder.getFalse();
1315       EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
1316                 SanitizerHandler::MissingReturn,
1317                 EmitCheckSourceLocation(FD->getLocation()), None);
1318     } else if (ShouldEmitUnreachable) {
1319       if (CGM.getCodeGenOpts().OptimizationLevel == 0)
1320         EmitTrapCall(llvm::Intrinsic::trap);
1321     }
1322     if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) {
1323       Builder.CreateUnreachable();
1324       Builder.ClearInsertionPoint();
1325     }
1326   }
1327 
1328   // Emit the standard function epilogue.
1329   FinishFunction(BodyRange.getEnd());
1330 
1331   // If we haven't marked the function nothrow through other means, do
1332   // a quick pass now to see if we can.
1333   if (!CurFn->doesNotThrow())
1334     TryMarkNoThrow(CurFn);
1335 }
1336 
1337 /// ContainsLabel - Return true if the statement contains a label in it.  If
1338 /// this statement is not executed normally, it not containing a label means
1339 /// that we can just remove the code.
1340 bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
1341   // Null statement, not a label!
1342   if (!S) return false;
1343 
1344   // If this is a label, we have to emit the code, consider something like:
1345   // if (0) {  ...  foo:  bar(); }  goto foo;
1346   //
1347   // TODO: If anyone cared, we could track __label__'s, since we know that you
1348   // can't jump to one from outside their declared region.
1349   if (isa<LabelStmt>(S))
1350     return true;
1351 
1352   // If this is a case/default statement, and we haven't seen a switch, we have
1353   // to emit the code.
1354   if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
1355     return true;
1356 
1357   // If this is a switch statement, we want to ignore cases below it.
1358   if (isa<SwitchStmt>(S))
1359     IgnoreCaseStmts = true;
1360 
1361   // Scan subexpressions for verboten labels.
1362   for (const Stmt *SubStmt : S->children())
1363     if (ContainsLabel(SubStmt, IgnoreCaseStmts))
1364       return true;
1365 
1366   return false;
1367 }
1368 
1369 /// containsBreak - Return true if the statement contains a break out of it.
1370 /// If the statement (recursively) contains a switch or loop with a break
1371 /// inside of it, this is fine.
1372 bool CodeGenFunction::containsBreak(const Stmt *S) {
1373   // Null statement, not a label!
1374   if (!S) return false;
1375 
1376   // If this is a switch or loop that defines its own break scope, then we can
1377   // include it and anything inside of it.
1378   if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
1379       isa<ForStmt>(S))
1380     return false;
1381 
1382   if (isa<BreakStmt>(S))
1383     return true;
1384 
1385   // Scan subexpressions for verboten breaks.
1386   for (const Stmt *SubStmt : S->children())
1387     if (containsBreak(SubStmt))
1388       return true;
1389 
1390   return false;
1391 }
1392 
1393 bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) {
1394   if (!S) return false;
1395 
1396   // Some statement kinds add a scope and thus never add a decl to the current
1397   // scope. Note, this list is longer than the list of statements that might
1398   // have an unscoped decl nested within them, but this way is conservatively
1399   // correct even if more statement kinds are added.
1400   if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
1401       isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) ||
1402       isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) ||
1403       isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S))
1404     return false;
1405 
1406   if (isa<DeclStmt>(S))
1407     return true;
1408 
1409   for (const Stmt *SubStmt : S->children())
1410     if (mightAddDeclToScope(SubStmt))
1411       return true;
1412 
1413   return false;
1414 }
1415 
1416 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1417 /// to a constant, or if it does but contains a label, return false.  If it
1418 /// constant folds return true and set the boolean result in Result.
1419 bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1420                                                    bool &ResultBool,
1421                                                    bool AllowLabels) {
1422   llvm::APSInt ResultInt;
1423   if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels))
1424     return false;
1425 
1426   ResultBool = ResultInt.getBoolValue();
1427   return true;
1428 }
1429 
1430 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1431 /// to a constant, or if it does but contains a label, return false.  If it
1432 /// constant folds return true and set the folded value.
1433 bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1434                                                    llvm::APSInt &ResultInt,
1435                                                    bool AllowLabels) {
1436   // FIXME: Rename and handle conversion of other evaluatable things
1437   // to bool.
1438   Expr::EvalResult Result;
1439   if (!Cond->EvaluateAsInt(Result, getContext()))
1440     return false;  // Not foldable, not integer or not fully evaluatable.
1441 
1442   llvm::APSInt Int = Result.Val.getInt();
1443   if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond))
1444     return false;  // Contains a label.
1445 
1446   ResultInt = Int;
1447   return true;
1448 }
1449 
1450 
1451 
1452 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
1453 /// statement) to the specified blocks.  Based on the condition, this might try
1454 /// to simplify the codegen of the conditional based on the branch.
1455 ///
1456 void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
1457                                            llvm::BasicBlock *TrueBlock,
1458                                            llvm::BasicBlock *FalseBlock,
1459                                            uint64_t TrueCount) {
1460   Cond = Cond->IgnoreParens();
1461 
1462   if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
1463 
1464     // Handle X && Y in a condition.
1465     if (CondBOp->getOpcode() == BO_LAnd) {
1466       // If we have "1 && X", simplify the code.  "0 && X" would have constant
1467       // folded if the case was simple enough.
1468       bool ConstantBool = false;
1469       if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1470           ConstantBool) {
1471         // br(1 && X) -> br(X).
1472         incrementProfileCounter(CondBOp);
1473         return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1474                                     TrueCount);
1475       }
1476 
1477       // If we have "X && 1", simplify the code to use an uncond branch.
1478       // "X && 0" would have been constant folded to 0.
1479       if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1480           ConstantBool) {
1481         // br(X && 1) -> br(X).
1482         return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1483                                     TrueCount);
1484       }
1485 
1486       // Emit the LHS as a conditional.  If the LHS conditional is false, we
1487       // want to jump to the FalseBlock.
1488       llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
1489       // The counter tells us how often we evaluate RHS, and all of TrueCount
1490       // can be propagated to that branch.
1491       uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
1492 
1493       ConditionalEvaluation eval(*this);
1494       {
1495         ApplyDebugLocation DL(*this, Cond);
1496         EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount);
1497         EmitBlock(LHSTrue);
1498       }
1499 
1500       incrementProfileCounter(CondBOp);
1501       setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1502 
1503       // Any temporaries created here are conditional.
1504       eval.begin(*this);
1505       EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount);
1506       eval.end(*this);
1507 
1508       return;
1509     }
1510 
1511     if (CondBOp->getOpcode() == BO_LOr) {
1512       // If we have "0 || X", simplify the code.  "1 || X" would have constant
1513       // folded if the case was simple enough.
1514       bool ConstantBool = false;
1515       if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1516           !ConstantBool) {
1517         // br(0 || X) -> br(X).
1518         incrementProfileCounter(CondBOp);
1519         return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1520                                     TrueCount);
1521       }
1522 
1523       // If we have "X || 0", simplify the code to use an uncond branch.
1524       // "X || 1" would have been constant folded to 1.
1525       if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1526           !ConstantBool) {
1527         // br(X || 0) -> br(X).
1528         return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1529                                     TrueCount);
1530       }
1531 
1532       // Emit the LHS as a conditional.  If the LHS conditional is true, we
1533       // want to jump to the TrueBlock.
1534       llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
1535       // We have the count for entry to the RHS and for the whole expression
1536       // being true, so we can divy up True count between the short circuit and
1537       // the RHS.
1538       uint64_t LHSCount =
1539           getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
1540       uint64_t RHSCount = TrueCount - LHSCount;
1541 
1542       ConditionalEvaluation eval(*this);
1543       {
1544         ApplyDebugLocation DL(*this, Cond);
1545         EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount);
1546         EmitBlock(LHSFalse);
1547       }
1548 
1549       incrementProfileCounter(CondBOp);
1550       setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1551 
1552       // Any temporaries created here are conditional.
1553       eval.begin(*this);
1554       EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount);
1555 
1556       eval.end(*this);
1557 
1558       return;
1559     }
1560   }
1561 
1562   if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
1563     // br(!x, t, f) -> br(x, f, t)
1564     if (CondUOp->getOpcode() == UO_LNot) {
1565       // Negate the count.
1566       uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
1567       // Negate the condition and swap the destination blocks.
1568       return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1569                                   FalseCount);
1570     }
1571   }
1572 
1573   if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
1574     // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
1575     llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
1576     llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
1577 
1578     ConditionalEvaluation cond(*this);
1579     EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1580                          getProfileCount(CondOp));
1581 
1582     // When computing PGO branch weights, we only know the overall count for
1583     // the true block. This code is essentially doing tail duplication of the
1584     // naive code-gen, introducing new edges for which counts are not
1585     // available. Divide the counts proportionally between the LHS and RHS of
1586     // the conditional operator.
1587     uint64_t LHSScaledTrueCount = 0;
1588     if (TrueCount) {
1589       double LHSRatio =
1590           getProfileCount(CondOp) / (double)getCurrentProfileCount();
1591       LHSScaledTrueCount = TrueCount * LHSRatio;
1592     }
1593 
1594     cond.begin(*this);
1595     EmitBlock(LHSBlock);
1596     incrementProfileCounter(CondOp);
1597     {
1598       ApplyDebugLocation DL(*this, Cond);
1599       EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1600                            LHSScaledTrueCount);
1601     }
1602     cond.end(*this);
1603 
1604     cond.begin(*this);
1605     EmitBlock(RHSBlock);
1606     EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1607                          TrueCount - LHSScaledTrueCount);
1608     cond.end(*this);
1609 
1610     return;
1611   }
1612 
1613   if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
1614     // Conditional operator handling can give us a throw expression as a
1615     // condition for a case like:
1616     //   br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
1617     // Fold this to:
1618     //   br(c, throw x, br(y, t, f))
1619     EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
1620     return;
1621   }
1622 
1623   // If the branch has a condition wrapped by __builtin_unpredictable,
1624   // create metadata that specifies that the branch is unpredictable.
1625   // Don't bother if not optimizing because that metadata would not be used.
1626   llvm::MDNode *Unpredictable = nullptr;
1627   auto *Call = dyn_cast<CallExpr>(Cond->IgnoreImpCasts());
1628   if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1629     auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1630     if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1631       llvm::MDBuilder MDHelper(getLLVMContext());
1632       Unpredictable = MDHelper.createUnpredictable();
1633     }
1634   }
1635 
1636   // Create branch weights based on the number of times we get here and the
1637   // number of times the condition should be true.
1638   uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
1639   llvm::MDNode *Weights =
1640       createProfileWeights(TrueCount, CurrentCount - TrueCount);
1641 
1642   // Emit the code with the fully general case.
1643   llvm::Value *CondV;
1644   {
1645     ApplyDebugLocation DL(*this, Cond);
1646     CondV = EvaluateExprAsBool(Cond);
1647   }
1648   Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
1649 }
1650 
1651 /// ErrorUnsupported - Print out an error that codegen doesn't support the
1652 /// specified stmt yet.
1653 void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
1654   CGM.ErrorUnsupported(S, Type);
1655 }
1656 
1657 /// emitNonZeroVLAInit - Emit the "zero" initialization of a
1658 /// variable-length array whose elements have a non-zero bit-pattern.
1659 ///
1660 /// \param baseType the inner-most element type of the array
1661 /// \param src - a char* pointing to the bit-pattern for a single
1662 /// base element of the array
1663 /// \param sizeInChars - the total size of the VLA, in chars
1664 static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
1665                                Address dest, Address src,
1666                                llvm::Value *sizeInChars) {
1667   CGBuilderTy &Builder = CGF.Builder;
1668 
1669   CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
1670   llvm::Value *baseSizeInChars
1671     = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
1672 
1673   Address begin =
1674     Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1675   llvm::Value *end =
1676     Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end");
1677 
1678   llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
1679   llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
1680   llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
1681 
1682   // Make a loop over the VLA.  C99 guarantees that the VLA element
1683   // count must be nonzero.
1684   CGF.EmitBlock(loopBB);
1685 
1686   llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
1687   cur->addIncoming(begin.getPointer(), originBB);
1688 
1689   CharUnits curAlign =
1690     dest.getAlignment().alignmentOfArrayElement(baseSize);
1691 
1692   // memcpy the individual element bit-pattern.
1693   Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
1694                        /*volatile*/ false);
1695 
1696   // Go to the next element.
1697   llvm::Value *next =
1698     Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
1699 
1700   // Leave if that's the end of the VLA.
1701   llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
1702   Builder.CreateCondBr(done, contBB, loopBB);
1703   cur->addIncoming(next, loopBB);
1704 
1705   CGF.EmitBlock(contBB);
1706 }
1707 
1708 void
1709 CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
1710   // Ignore empty classes in C++.
1711   if (getLangOpts().CPlusPlus) {
1712     if (const RecordType *RT = Ty->getAs<RecordType>()) {
1713       if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
1714         return;
1715     }
1716   }
1717 
1718   // Cast the dest ptr to the appropriate i8 pointer type.
1719   if (DestPtr.getElementType() != Int8Ty)
1720     DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
1721 
1722   // Get size and alignment info for this aggregate.
1723   CharUnits size = getContext().getTypeSizeInChars(Ty);
1724 
1725   llvm::Value *SizeVal;
1726   const VariableArrayType *vla;
1727 
1728   // Don't bother emitting a zero-byte memset.
1729   if (size.isZero()) {
1730     // But note that getTypeInfo returns 0 for a VLA.
1731     if (const VariableArrayType *vlaType =
1732           dyn_cast_or_null<VariableArrayType>(
1733                                           getContext().getAsArrayType(Ty))) {
1734       auto VlaSize = getVLASize(vlaType);
1735       SizeVal = VlaSize.NumElts;
1736       CharUnits eltSize = getContext().getTypeSizeInChars(VlaSize.Type);
1737       if (!eltSize.isOne())
1738         SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
1739       vla = vlaType;
1740     } else {
1741       return;
1742     }
1743   } else {
1744     SizeVal = CGM.getSize(size);
1745     vla = nullptr;
1746   }
1747 
1748   // If the type contains a pointer to data member we can't memset it to zero.
1749   // Instead, create a null constant and copy it to the destination.
1750   // TODO: there are other patterns besides zero that we can usefully memset,
1751   // like -1, which happens to be the pattern used by member-pointers.
1752   if (!CGM.getTypes().isZeroInitializable(Ty)) {
1753     // For a VLA, emit a single element, then splat that over the VLA.
1754     if (vla) Ty = getContext().getBaseElementType(vla);
1755 
1756     llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
1757 
1758     llvm::GlobalVariable *NullVariable =
1759       new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
1760                                /*isConstant=*/true,
1761                                llvm::GlobalVariable::PrivateLinkage,
1762                                NullConstant, Twine());
1763     CharUnits NullAlign = DestPtr.getAlignment();
1764     NullVariable->setAlignment(NullAlign.getAsAlign());
1765     Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
1766                    NullAlign);
1767 
1768     if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
1769 
1770     // Get and call the appropriate llvm.memcpy overload.
1771     Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
1772     return;
1773   }
1774 
1775   // Otherwise, just memset the whole thing to zero.  This is legal
1776   // because in LLVM, all default initializers (other than the ones we just
1777   // handled above) are guaranteed to have a bit pattern of all zeros.
1778   Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
1779 }
1780 
1781 llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
1782   // Make sure that there is a block for the indirect goto.
1783   if (!IndirectBranch)
1784     GetIndirectGotoBlock();
1785 
1786   llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
1787 
1788   // Make sure the indirect branch includes all of the address-taken blocks.
1789   IndirectBranch->addDestination(BB);
1790   return llvm::BlockAddress::get(CurFn, BB);
1791 }
1792 
1793 llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
1794   // If we already made the indirect branch for indirect goto, return its block.
1795   if (IndirectBranch) return IndirectBranch->getParent();
1796 
1797   CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
1798 
1799   // Create the PHI node that indirect gotos will add entries to.
1800   llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
1801                                               "indirect.goto.dest");
1802 
1803   // Create the indirect branch instruction.
1804   IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
1805   return IndirectBranch->getParent();
1806 }
1807 
1808 /// Computes the length of an array in elements, as well as the base
1809 /// element type and a properly-typed first element pointer.
1810 llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1811                                               QualType &baseType,
1812                                               Address &addr) {
1813   const ArrayType *arrayType = origArrayType;
1814 
1815   // If it's a VLA, we have to load the stored size.  Note that
1816   // this is the size of the VLA in bytes, not its size in elements.
1817   llvm::Value *numVLAElements = nullptr;
1818   if (isa<VariableArrayType>(arrayType)) {
1819     numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).NumElts;
1820 
1821     // Walk into all VLAs.  This doesn't require changes to addr,
1822     // which has type T* where T is the first non-VLA element type.
1823     do {
1824       QualType elementType = arrayType->getElementType();
1825       arrayType = getContext().getAsArrayType(elementType);
1826 
1827       // If we only have VLA components, 'addr' requires no adjustment.
1828       if (!arrayType) {
1829         baseType = elementType;
1830         return numVLAElements;
1831       }
1832     } while (isa<VariableArrayType>(arrayType));
1833 
1834     // We get out here only if we find a constant array type
1835     // inside the VLA.
1836   }
1837 
1838   // We have some number of constant-length arrays, so addr should
1839   // have LLVM type [M x [N x [...]]]*.  Build a GEP that walks
1840   // down to the first element of addr.
1841   SmallVector<llvm::Value*, 8> gepIndices;
1842 
1843   // GEP down to the array type.
1844   llvm::ConstantInt *zero = Builder.getInt32(0);
1845   gepIndices.push_back(zero);
1846 
1847   uint64_t countFromCLAs = 1;
1848   QualType eltType;
1849 
1850   llvm::ArrayType *llvmArrayType =
1851     dyn_cast<llvm::ArrayType>(addr.getElementType());
1852   while (llvmArrayType) {
1853     assert(isa<ConstantArrayType>(arrayType));
1854     assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1855              == llvmArrayType->getNumElements());
1856 
1857     gepIndices.push_back(zero);
1858     countFromCLAs *= llvmArrayType->getNumElements();
1859     eltType = arrayType->getElementType();
1860 
1861     llvmArrayType =
1862       dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
1863     arrayType = getContext().getAsArrayType(arrayType->getElementType());
1864     assert((!llvmArrayType || arrayType) &&
1865            "LLVM and Clang types are out-of-synch");
1866   }
1867 
1868   if (arrayType) {
1869     // From this point onwards, the Clang array type has been emitted
1870     // as some other type (probably a packed struct). Compute the array
1871     // size, and just emit the 'begin' expression as a bitcast.
1872     while (arrayType) {
1873       countFromCLAs *=
1874           cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1875       eltType = arrayType->getElementType();
1876       arrayType = getContext().getAsArrayType(eltType);
1877     }
1878 
1879     llvm::Type *baseType = ConvertType(eltType);
1880     addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
1881   } else {
1882     // Create the actual GEP.
1883     addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(),
1884                                              gepIndices, "array.begin"),
1885                    addr.getAlignment());
1886   }
1887 
1888   baseType = eltType;
1889 
1890   llvm::Value *numElements
1891     = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1892 
1893   // If we had any VLA dimensions, factor them in.
1894   if (numVLAElements)
1895     numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1896 
1897   return numElements;
1898 }
1899 
1900 CodeGenFunction::VlaSizePair CodeGenFunction::getVLASize(QualType type) {
1901   const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1902   assert(vla && "type was not a variable array type!");
1903   return getVLASize(vla);
1904 }
1905 
1906 CodeGenFunction::VlaSizePair
1907 CodeGenFunction::getVLASize(const VariableArrayType *type) {
1908   // The number of elements so far; always size_t.
1909   llvm::Value *numElements = nullptr;
1910 
1911   QualType elementType;
1912   do {
1913     elementType = type->getElementType();
1914     llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1915     assert(vlaSize && "no size for VLA!");
1916     assert(vlaSize->getType() == SizeTy);
1917 
1918     if (!numElements) {
1919       numElements = vlaSize;
1920     } else {
1921       // It's undefined behavior if this wraps around, so mark it that way.
1922       // FIXME: Teach -fsanitize=undefined to trap this.
1923       numElements = Builder.CreateNUWMul(numElements, vlaSize);
1924     }
1925   } while ((type = getContext().getAsVariableArrayType(elementType)));
1926 
1927   return { numElements, elementType };
1928 }
1929 
1930 CodeGenFunction::VlaSizePair
1931 CodeGenFunction::getVLAElements1D(QualType type) {
1932   const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1933   assert(vla && "type was not a variable array type!");
1934   return getVLAElements1D(vla);
1935 }
1936 
1937 CodeGenFunction::VlaSizePair
1938 CodeGenFunction::getVLAElements1D(const VariableArrayType *Vla) {
1939   llvm::Value *VlaSize = VLASizeMap[Vla->getSizeExpr()];
1940   assert(VlaSize && "no size for VLA!");
1941   assert(VlaSize->getType() == SizeTy);
1942   return { VlaSize, Vla->getElementType() };
1943 }
1944 
1945 void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
1946   assert(type->isVariablyModifiedType() &&
1947          "Must pass variably modified type to EmitVLASizes!");
1948 
1949   EnsureInsertPoint();
1950 
1951   // We're going to walk down into the type and look for VLA
1952   // expressions.
1953   do {
1954     assert(type->isVariablyModifiedType());
1955 
1956     const Type *ty = type.getTypePtr();
1957     switch (ty->getTypeClass()) {
1958 
1959 #define TYPE(Class, Base)
1960 #define ABSTRACT_TYPE(Class, Base)
1961 #define NON_CANONICAL_TYPE(Class, Base)
1962 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
1963 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
1964 #include "clang/AST/TypeNodes.inc"
1965       llvm_unreachable("unexpected dependent type!");
1966 
1967     // These types are never variably-modified.
1968     case Type::Builtin:
1969     case Type::Complex:
1970     case Type::Vector:
1971     case Type::ExtVector:
1972     case Type::Record:
1973     case Type::Enum:
1974     case Type::Elaborated:
1975     case Type::TemplateSpecialization:
1976     case Type::ObjCTypeParam:
1977     case Type::ObjCObject:
1978     case Type::ObjCInterface:
1979     case Type::ObjCObjectPointer:
1980       llvm_unreachable("type class is never variably-modified!");
1981 
1982     case Type::Adjusted:
1983       type = cast<AdjustedType>(ty)->getAdjustedType();
1984       break;
1985 
1986     case Type::Decayed:
1987       type = cast<DecayedType>(ty)->getPointeeType();
1988       break;
1989 
1990     case Type::Pointer:
1991       type = cast<PointerType>(ty)->getPointeeType();
1992       break;
1993 
1994     case Type::BlockPointer:
1995       type = cast<BlockPointerType>(ty)->getPointeeType();
1996       break;
1997 
1998     case Type::LValueReference:
1999     case Type::RValueReference:
2000       type = cast<ReferenceType>(ty)->getPointeeType();
2001       break;
2002 
2003     case Type::MemberPointer:
2004       type = cast<MemberPointerType>(ty)->getPointeeType();
2005       break;
2006 
2007     case Type::ConstantArray:
2008     case Type::IncompleteArray:
2009       // Losing element qualification here is fine.
2010       type = cast<ArrayType>(ty)->getElementType();
2011       break;
2012 
2013     case Type::VariableArray: {
2014       // Losing element qualification here is fine.
2015       const VariableArrayType *vat = cast<VariableArrayType>(ty);
2016 
2017       // Unknown size indication requires no size computation.
2018       // Otherwise, evaluate and record it.
2019       if (const Expr *size = vat->getSizeExpr()) {
2020         // It's possible that we might have emitted this already,
2021         // e.g. with a typedef and a pointer to it.
2022         llvm::Value *&entry = VLASizeMap[size];
2023         if (!entry) {
2024           llvm::Value *Size = EmitScalarExpr(size);
2025 
2026           // C11 6.7.6.2p5:
2027           //   If the size is an expression that is not an integer constant
2028           //   expression [...] each time it is evaluated it shall have a value
2029           //   greater than zero.
2030           if (SanOpts.has(SanitizerKind::VLABound) &&
2031               size->getType()->isSignedIntegerType()) {
2032             SanitizerScope SanScope(this);
2033             llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
2034             llvm::Constant *StaticArgs[] = {
2035                 EmitCheckSourceLocation(size->getBeginLoc()),
2036                 EmitCheckTypeDescriptor(size->getType())};
2037             EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
2038                                      SanitizerKind::VLABound),
2039                       SanitizerHandler::VLABoundNotPositive, StaticArgs, Size);
2040           }
2041 
2042           // Always zexting here would be wrong if it weren't
2043           // undefined behavior to have a negative bound.
2044           entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
2045         }
2046       }
2047       type = vat->getElementType();
2048       break;
2049     }
2050 
2051     case Type::FunctionProto:
2052     case Type::FunctionNoProto:
2053       type = cast<FunctionType>(ty)->getReturnType();
2054       break;
2055 
2056     case Type::Paren:
2057     case Type::TypeOf:
2058     case Type::UnaryTransform:
2059     case Type::Attributed:
2060     case Type::SubstTemplateTypeParm:
2061     case Type::PackExpansion:
2062     case Type::MacroQualified:
2063       // Keep walking after single level desugaring.
2064       type = type.getSingleStepDesugaredType(getContext());
2065       break;
2066 
2067     case Type::Typedef:
2068     case Type::Decltype:
2069     case Type::Auto:
2070     case Type::DeducedTemplateSpecialization:
2071       // Stop walking: nothing to do.
2072       return;
2073 
2074     case Type::TypeOfExpr:
2075       // Stop walking: emit typeof expression.
2076       EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
2077       return;
2078 
2079     case Type::Atomic:
2080       type = cast<AtomicType>(ty)->getValueType();
2081       break;
2082 
2083     case Type::Pipe:
2084       type = cast<PipeType>(ty)->getElementType();
2085       break;
2086     }
2087   } while (type->isVariablyModifiedType());
2088 }
2089 
2090 Address CodeGenFunction::EmitVAListRef(const Expr* E) {
2091   if (getContext().getBuiltinVaListType()->isArrayType())
2092     return EmitPointerWithAlignment(E);
2093   return EmitLValue(E).getAddress(*this);
2094 }
2095 
2096 Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
2097   return EmitLValue(E).getAddress(*this);
2098 }
2099 
2100 void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
2101                                               const APValue &Init) {
2102   assert(Init.hasValue() && "Invalid DeclRefExpr initializer!");
2103   if (CGDebugInfo *Dbg = getDebugInfo())
2104     if (CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo)
2105       Dbg->EmitGlobalVariable(E->getDecl(), Init);
2106 }
2107 
2108 CodeGenFunction::PeepholeProtection
2109 CodeGenFunction::protectFromPeepholes(RValue rvalue) {
2110   // At the moment, the only aggressive peephole we do in IR gen
2111   // is trunc(zext) folding, but if we add more, we can easily
2112   // extend this protection.
2113 
2114   if (!rvalue.isScalar()) return PeepholeProtection();
2115   llvm::Value *value = rvalue.getScalarVal();
2116   if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
2117 
2118   // Just make an extra bitcast.
2119   assert(HaveInsertPoint());
2120   llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
2121                                                   Builder.GetInsertBlock());
2122 
2123   PeepholeProtection protection;
2124   protection.Inst = inst;
2125   return protection;
2126 }
2127 
2128 void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
2129   if (!protection.Inst) return;
2130 
2131   // In theory, we could try to duplicate the peepholes now, but whatever.
2132   protection.Inst->eraseFromParent();
2133 }
2134 
2135 void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue,
2136                                               QualType Ty, SourceLocation Loc,
2137                                               SourceLocation AssumptionLoc,
2138                                               llvm::Value *Alignment,
2139                                               llvm::Value *OffsetValue) {
2140   llvm::Value *TheCheck;
2141   llvm::Instruction *Assumption = Builder.CreateAlignmentAssumption(
2142       CGM.getDataLayout(), PtrValue, Alignment, OffsetValue, &TheCheck);
2143   if (SanOpts.has(SanitizerKind::Alignment)) {
2144     EmitAlignmentAssumptionCheck(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
2145                                  OffsetValue, TheCheck, Assumption);
2146   }
2147 }
2148 
2149 void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue,
2150                                               const Expr *E,
2151                                               SourceLocation AssumptionLoc,
2152                                               llvm::Value *Alignment,
2153                                               llvm::Value *OffsetValue) {
2154   if (auto *CE = dyn_cast<CastExpr>(E))
2155     E = CE->getSubExprAsWritten();
2156   QualType Ty = E->getType();
2157   SourceLocation Loc = E->getExprLoc();
2158 
2159   EmitAlignmentAssumption(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
2160                           OffsetValue);
2161 }
2162 
2163 llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Function *AnnotationFn,
2164                                                  llvm::Value *AnnotatedVal,
2165                                                  StringRef AnnotationStr,
2166                                                  SourceLocation Location) {
2167   llvm::Value *Args[4] = {
2168     AnnotatedVal,
2169     Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
2170     Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
2171     CGM.EmitAnnotationLineNo(Location)
2172   };
2173   return Builder.CreateCall(AnnotationFn, Args);
2174 }
2175 
2176 void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
2177   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2178   // FIXME We create a new bitcast for every annotation because that's what
2179   // llvm-gcc was doing.
2180   for (const auto *I : D->specific_attrs<AnnotateAttr>())
2181     EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
2182                        Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
2183                        I->getAnnotation(), D->getLocation());
2184 }
2185 
2186 Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
2187                                               Address Addr) {
2188   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2189   llvm::Value *V = Addr.getPointer();
2190   llvm::Type *VTy = V->getType();
2191   llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
2192                                     CGM.Int8PtrTy);
2193 
2194   for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
2195     // FIXME Always emit the cast inst so we can differentiate between
2196     // annotation on the first field of a struct and annotation on the struct
2197     // itself.
2198     if (VTy != CGM.Int8PtrTy)
2199       V = Builder.CreateBitCast(V, CGM.Int8PtrTy);
2200     V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation());
2201     V = Builder.CreateBitCast(V, VTy);
2202   }
2203 
2204   return Address(V, Addr.getAlignment());
2205 }
2206 
2207 CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
2208 
2209 CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
2210     : CGF(CGF) {
2211   assert(!CGF->IsSanitizerScope);
2212   CGF->IsSanitizerScope = true;
2213 }
2214 
2215 CodeGenFunction::SanitizerScope::~SanitizerScope() {
2216   CGF->IsSanitizerScope = false;
2217 }
2218 
2219 void CodeGenFunction::InsertHelper(llvm::Instruction *I,
2220                                    const llvm::Twine &Name,
2221                                    llvm::BasicBlock *BB,
2222                                    llvm::BasicBlock::iterator InsertPt) const {
2223   LoopStack.InsertHelper(I);
2224   if (IsSanitizerScope)
2225     CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
2226 }
2227 
2228 void CGBuilderInserter::InsertHelper(
2229     llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
2230     llvm::BasicBlock::iterator InsertPt) const {
2231   llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt);
2232   if (CGF)
2233     CGF->InsertHelper(I, Name, BB, InsertPt);
2234 }
2235 
2236 static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures,
2237                                 CodeGenModule &CGM, const FunctionDecl *FD,
2238                                 std::string &FirstMissing) {
2239   // If there aren't any required features listed then go ahead and return.
2240   if (ReqFeatures.empty())
2241     return false;
2242 
2243   // Now build up the set of caller features and verify that all the required
2244   // features are there.
2245   llvm::StringMap<bool> CallerFeatureMap;
2246   CGM.getContext().getFunctionFeatureMap(CallerFeatureMap, FD);
2247 
2248   // If we have at least one of the features in the feature list return
2249   // true, otherwise return false.
2250   return std::all_of(
2251       ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) {
2252         SmallVector<StringRef, 1> OrFeatures;
2253         Feature.split(OrFeatures, '|');
2254         return llvm::any_of(OrFeatures, [&](StringRef Feature) {
2255           if (!CallerFeatureMap.lookup(Feature)) {
2256             FirstMissing = Feature.str();
2257             return false;
2258           }
2259           return true;
2260         });
2261       });
2262 }
2263 
2264 // Emits an error if we don't have a valid set of target features for the
2265 // called function.
2266 void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
2267                                           const FunctionDecl *TargetDecl) {
2268   return checkTargetFeatures(E->getBeginLoc(), TargetDecl);
2269 }
2270 
2271 // Emits an error if we don't have a valid set of target features for the
2272 // called function.
2273 void CodeGenFunction::checkTargetFeatures(SourceLocation Loc,
2274                                           const FunctionDecl *TargetDecl) {
2275   // Early exit if this is an indirect call.
2276   if (!TargetDecl)
2277     return;
2278 
2279   // Get the current enclosing function if it exists. If it doesn't
2280   // we can't check the target features anyhow.
2281   const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
2282   if (!FD)
2283     return;
2284 
2285   // Grab the required features for the call. For a builtin this is listed in
2286   // the td file with the default cpu, for an always_inline function this is any
2287   // listed cpu and any listed features.
2288   unsigned BuiltinID = TargetDecl->getBuiltinID();
2289   std::string MissingFeature;
2290   if (BuiltinID) {
2291     SmallVector<StringRef, 1> ReqFeatures;
2292     const char *FeatureList =
2293         CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2294     // Return if the builtin doesn't have any required features.
2295     if (!FeatureList || StringRef(FeatureList) == "")
2296       return;
2297     StringRef(FeatureList).split(ReqFeatures, ',');
2298     if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
2299       CGM.getDiags().Report(Loc, diag::err_builtin_needs_feature)
2300           << TargetDecl->getDeclName()
2301           << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2302 
2303   } else if (!TargetDecl->isMultiVersion() &&
2304              TargetDecl->hasAttr<TargetAttr>()) {
2305     // Get the required features for the callee.
2306 
2307     const TargetAttr *TD = TargetDecl->getAttr<TargetAttr>();
2308     ParsedTargetAttr ParsedAttr =
2309         CGM.getContext().filterFunctionTargetAttrs(TD);
2310 
2311     SmallVector<StringRef, 1> ReqFeatures;
2312     llvm::StringMap<bool> CalleeFeatureMap;
2313     CGM.getContext().getFunctionFeatureMap(CalleeFeatureMap,
2314                                            GlobalDecl(TargetDecl));
2315 
2316     for (const auto &F : ParsedAttr.Features) {
2317       if (F[0] == '+' && CalleeFeatureMap.lookup(F.substr(1)))
2318         ReqFeatures.push_back(StringRef(F).substr(1));
2319     }
2320 
2321     for (const auto &F : CalleeFeatureMap) {
2322       // Only positive features are "required".
2323       if (F.getValue())
2324         ReqFeatures.push_back(F.getKey());
2325     }
2326     if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
2327       CGM.getDiags().Report(Loc, diag::err_function_needs_feature)
2328           << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature;
2329   }
2330 }
2331 
2332 void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) {
2333   if (!CGM.getCodeGenOpts().SanitizeStats)
2334     return;
2335 
2336   llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint());
2337   IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation());
2338   CGM.getSanStats().create(IRB, SSK);
2339 }
2340 
2341 llvm::Value *
2342 CodeGenFunction::FormResolverCondition(const MultiVersionResolverOption &RO) {
2343   llvm::Value *Condition = nullptr;
2344 
2345   if (!RO.Conditions.Architecture.empty())
2346     Condition = EmitX86CpuIs(RO.Conditions.Architecture);
2347 
2348   if (!RO.Conditions.Features.empty()) {
2349     llvm::Value *FeatureCond = EmitX86CpuSupports(RO.Conditions.Features);
2350     Condition =
2351         Condition ? Builder.CreateAnd(Condition, FeatureCond) : FeatureCond;
2352   }
2353   return Condition;
2354 }
2355 
2356 static void CreateMultiVersionResolverReturn(CodeGenModule &CGM,
2357                                              llvm::Function *Resolver,
2358                                              CGBuilderTy &Builder,
2359                                              llvm::Function *FuncToReturn,
2360                                              bool SupportsIFunc) {
2361   if (SupportsIFunc) {
2362     Builder.CreateRet(FuncToReturn);
2363     return;
2364   }
2365 
2366   llvm::SmallVector<llvm::Value *, 10> Args;
2367   llvm::for_each(Resolver->args(),
2368                  [&](llvm::Argument &Arg) { Args.push_back(&Arg); });
2369 
2370   llvm::CallInst *Result = Builder.CreateCall(FuncToReturn, Args);
2371   Result->setTailCallKind(llvm::CallInst::TCK_MustTail);
2372 
2373   if (Resolver->getReturnType()->isVoidTy())
2374     Builder.CreateRetVoid();
2375   else
2376     Builder.CreateRet(Result);
2377 }
2378 
2379 void CodeGenFunction::EmitMultiVersionResolver(
2380     llvm::Function *Resolver, ArrayRef<MultiVersionResolverOption> Options) {
2381   assert(getContext().getTargetInfo().getTriple().isX86() &&
2382          "Only implemented for x86 targets");
2383 
2384   bool SupportsIFunc = getContext().getTargetInfo().supportsIFunc();
2385 
2386   // Main function's basic block.
2387   llvm::BasicBlock *CurBlock = createBasicBlock("resolver_entry", Resolver);
2388   Builder.SetInsertPoint(CurBlock);
2389   EmitX86CpuInit();
2390 
2391   for (const MultiVersionResolverOption &RO : Options) {
2392     Builder.SetInsertPoint(CurBlock);
2393     llvm::Value *Condition = FormResolverCondition(RO);
2394 
2395     // The 'default' or 'generic' case.
2396     if (!Condition) {
2397       assert(&RO == Options.end() - 1 &&
2398              "Default or Generic case must be last");
2399       CreateMultiVersionResolverReturn(CGM, Resolver, Builder, RO.Function,
2400                                        SupportsIFunc);
2401       return;
2402     }
2403 
2404     llvm::BasicBlock *RetBlock = createBasicBlock("resolver_return", Resolver);
2405     CGBuilderTy RetBuilder(*this, RetBlock);
2406     CreateMultiVersionResolverReturn(CGM, Resolver, RetBuilder, RO.Function,
2407                                      SupportsIFunc);
2408     CurBlock = createBasicBlock("resolver_else", Resolver);
2409     Builder.CreateCondBr(Condition, RetBlock, CurBlock);
2410   }
2411 
2412   // If no generic/default, emit an unreachable.
2413   Builder.SetInsertPoint(CurBlock);
2414   llvm::CallInst *TrapCall = EmitTrapCall(llvm::Intrinsic::trap);
2415   TrapCall->setDoesNotReturn();
2416   TrapCall->setDoesNotThrow();
2417   Builder.CreateUnreachable();
2418   Builder.ClearInsertionPoint();
2419 }
2420 
2421 // Loc - where the diagnostic will point, where in the source code this
2422 //  alignment has failed.
2423 // SecondaryLoc - if present (will be present if sufficiently different from
2424 //  Loc), the diagnostic will additionally point a "Note:" to this location.
2425 //  It should be the location where the __attribute__((assume_aligned))
2426 //  was written e.g.
2427 void CodeGenFunction::EmitAlignmentAssumptionCheck(
2428     llvm::Value *Ptr, QualType Ty, SourceLocation Loc,
2429     SourceLocation SecondaryLoc, llvm::Value *Alignment,
2430     llvm::Value *OffsetValue, llvm::Value *TheCheck,
2431     llvm::Instruction *Assumption) {
2432   assert(Assumption && isa<llvm::CallInst>(Assumption) &&
2433          cast<llvm::CallInst>(Assumption)->getCalledValue() ==
2434              llvm::Intrinsic::getDeclaration(
2435                  Builder.GetInsertBlock()->getParent()->getParent(),
2436                  llvm::Intrinsic::assume) &&
2437          "Assumption should be a call to llvm.assume().");
2438   assert(&(Builder.GetInsertBlock()->back()) == Assumption &&
2439          "Assumption should be the last instruction of the basic block, "
2440          "since the basic block is still being generated.");
2441 
2442   if (!SanOpts.has(SanitizerKind::Alignment))
2443     return;
2444 
2445   // Don't check pointers to volatile data. The behavior here is implementation-
2446   // defined.
2447   if (Ty->getPointeeType().isVolatileQualified())
2448     return;
2449 
2450   // We need to temorairly remove the assumption so we can insert the
2451   // sanitizer check before it, else the check will be dropped by optimizations.
2452   Assumption->removeFromParent();
2453 
2454   {
2455     SanitizerScope SanScope(this);
2456 
2457     if (!OffsetValue)
2458       OffsetValue = Builder.getInt1(0); // no offset.
2459 
2460     llvm::Constant *StaticData[] = {EmitCheckSourceLocation(Loc),
2461                                     EmitCheckSourceLocation(SecondaryLoc),
2462                                     EmitCheckTypeDescriptor(Ty)};
2463     llvm::Value *DynamicData[] = {EmitCheckValue(Ptr),
2464                                   EmitCheckValue(Alignment),
2465                                   EmitCheckValue(OffsetValue)};
2466     EmitCheck({std::make_pair(TheCheck, SanitizerKind::Alignment)},
2467               SanitizerHandler::AlignmentAssumption, StaticData, DynamicData);
2468   }
2469 
2470   // We are now in the (new, empty) "cont" basic block.
2471   // Reintroduce the assumption.
2472   Builder.Insert(Assumption);
2473   // FIXME: Assumption still has it's original basic block as it's Parent.
2474 }
2475 
2476 llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) {
2477   if (CGDebugInfo *DI = getDebugInfo())
2478     return DI->SourceLocToDebugLoc(Location);
2479 
2480   return llvm::DebugLoc();
2481 }
2482