1 //===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the internal per-function state used for llvm translation.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
15 #define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
17 #include "CGBuilder.h"
18 #include "CGDebugInfo.h"
19 #include "CGLoopInfo.h"
21 #include "CodeGenModule.h"
22 #include "CodeGenPGO.h"
23 #include "EHScopeStack.h"
24 #include "VarBypassDetector.h"
25 #include "clang/AST/CharUnits.h"
26 #include "clang/AST/ExprCXX.h"
27 #include "clang/AST/ExprObjC.h"
28 #include "clang/AST/ExprOpenMP.h"
29 #include "clang/AST/Type.h"
30 #include "clang/Basic/ABI.h"
31 #include "clang/Basic/CapturedStmt.h"
32 #include "clang/Basic/OpenMPKinds.h"
33 #include "clang/Basic/TargetInfo.h"
34 #include "clang/Frontend/CodeGenOptions.h"
35 #include "llvm/ADT/ArrayRef.h"
36 #include "llvm/ADT/DenseMap.h"
37 #include "llvm/ADT/MapVector.h"
38 #include "llvm/ADT/SmallVector.h"
39 #include "llvm/IR/ValueHandle.h"
40 #include "llvm/Support/Debug.h"
41 #include "llvm/Transforms/Utils/SanitizerStats.h"
57 class CXXDestructorDecl;
58 class CXXForRangeStmt;
62 class EnumConstantDecl;
64 class FunctionProtoType;
66 class ObjCContainerDecl;
67 class ObjCInterfaceDecl;
70 class ObjCImplementationDecl;
71 class ObjCPropertyImplDecl;
74 class ObjCForCollectionStmt;
76 class ObjCAtThrowStmt;
77 class ObjCAtSynchronizedStmt;
78 class ObjCAutoreleasePoolStmt;
80 namespace analyze_os_log {
81 class OSLogBufferLayout;
91 class BlockByrefHelpers;
94 class BlockFieldFlags;
95 class RegionCodeGenTy;
96 class TargetCodeGenInfo;
100 /// The kind of evaluation to perform on values of a particular
101 /// type. Basically, is the code in CGExprScalar, CGExprComplex, or
104 /// TODO: should vectors maybe be split out into their own thing?
105 enum TypeEvaluationKind {
111 #define LIST_SANITIZER_CHECKS \
112 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
113 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
114 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
115 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
116 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
117 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
118 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
119 SANITIZER_CHECK(ImplicitConversion, implicit_conversion, 0) \
120 SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
121 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
122 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
123 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
124 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
125 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
126 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
127 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
128 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
129 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
130 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
131 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
132 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
133 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
134 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
136 enum SanitizerHandler {
137 #define SANITIZER_CHECK(Enum, Name, Version) Enum,
138 LIST_SANITIZER_CHECKS
139 #undef SANITIZER_CHECK
142 /// Helper class with most of the code for saving a value for a
143 /// conditional expression cleanup.
144 struct DominatingLLVMValue {
145 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
147 /// Answer whether the given value needs extra work to be saved.
148 static bool needsSaving(llvm::Value *value) {
149 // If it's not an instruction, we don't need to save.
150 if (!isa<llvm::Instruction>(value)) return false;
152 // If it's an instruction in the entry block, we don't need to save.
153 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
154 return (block != &block->getParent()->getEntryBlock());
157 static saved_type save(CodeGenFunction &CGF, llvm::Value *value);
158 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value);
161 /// A partial specialization of DominatingValue for llvm::Values that
162 /// might be llvm::Instructions.
163 template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
165 static type restore(CodeGenFunction &CGF, saved_type value) {
166 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
170 /// A specialization of DominatingValue for Address.
171 template <> struct DominatingValue<Address> {
172 typedef Address type;
175 DominatingLLVMValue::saved_type SavedValue;
179 static bool needsSaving(type value) {
180 return DominatingLLVMValue::needsSaving(value.getPointer());
182 static saved_type save(CodeGenFunction &CGF, type value) {
183 return { DominatingLLVMValue::save(CGF, value.getPointer()),
184 value.getAlignment() };
186 static type restore(CodeGenFunction &CGF, saved_type value) {
187 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
192 /// A specialization of DominatingValue for RValue.
193 template <> struct DominatingValue<RValue> {
196 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
197 AggregateAddress, ComplexAddress };
202 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
203 : Value(v), K(k), Align(a) {}
206 static bool needsSaving(RValue value);
207 static saved_type save(CodeGenFunction &CGF, RValue value);
208 RValue restore(CodeGenFunction &CGF);
210 // implementations in CGCleanup.cpp
213 static bool needsSaving(type value) {
214 return saved_type::needsSaving(value);
216 static saved_type save(CodeGenFunction &CGF, type value) {
217 return saved_type::save(CGF, value);
219 static type restore(CodeGenFunction &CGF, saved_type value) {
220 return value.restore(CGF);
224 /// CodeGenFunction - This class organizes the per-function state that is used
225 /// while generating LLVM code.
226 class CodeGenFunction : public CodeGenTypeCache {
227 CodeGenFunction(const CodeGenFunction &) = delete;
228 void operator=(const CodeGenFunction &) = delete;
230 friend class CGCXXABI;
232 /// A jump destination is an abstract label, branching to which may
233 /// require a jump out through normal cleanups.
235 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
236 JumpDest(llvm::BasicBlock *Block,
237 EHScopeStack::stable_iterator Depth,
239 : Block(Block), ScopeDepth(Depth), Index(Index) {}
241 bool isValid() const { return Block != nullptr; }
242 llvm::BasicBlock *getBlock() const { return Block; }
243 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
244 unsigned getDestIndex() const { return Index; }
246 // This should be used cautiously.
247 void setScopeDepth(EHScopeStack::stable_iterator depth) {
252 llvm::BasicBlock *Block;
253 EHScopeStack::stable_iterator ScopeDepth;
257 CodeGenModule &CGM; // Per-module state.
258 const TargetInfo &Target;
260 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
261 LoopInfoStack LoopStack;
264 // Stores variables for which we can't generate correct lifetime markers
266 VarBypassDetector Bypasses;
268 // CodeGen lambda for loops and support for ordered clause
269 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
272 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
273 const unsigned, const bool)>
276 // Codegen lambda for loop bounds in worksharing loop constructs
277 typedef llvm::function_ref<std::pair<LValue, LValue>(
278 CodeGenFunction &, const OMPExecutableDirective &S)>
281 // Codegen lambda for loop bounds in dispatch-based loop implementation
282 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
283 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
285 CodeGenDispatchBoundsTy;
287 /// CGBuilder insert helper. This function is called after an
288 /// instruction is created using Builder.
289 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
290 llvm::BasicBlock *BB,
291 llvm::BasicBlock::iterator InsertPt) const;
293 /// CurFuncDecl - Holds the Decl for the current outermost
294 /// non-closure context.
295 const Decl *CurFuncDecl;
296 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
297 const Decl *CurCodeDecl;
298 const CGFunctionInfo *CurFnInfo;
300 llvm::Function *CurFn = nullptr;
302 // Holds coroutine data if the current function is a coroutine. We use a
303 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
306 std::unique_ptr<CGCoroData> Data;
312 bool isCoroutine() const {
313 return CurCoro.Data != nullptr;
316 /// CurGD - The GlobalDecl for the current function being compiled.
319 /// PrologueCleanupDepth - The cleanup depth enclosing all the
320 /// cleanups associated with the parameters.
321 EHScopeStack::stable_iterator PrologueCleanupDepth;
323 /// ReturnBlock - Unified return block.
324 JumpDest ReturnBlock;
326 /// ReturnValue - The temporary alloca to hold the return
327 /// value. This is invalid iff the function has no return value.
328 Address ReturnValue = Address::invalid();
330 /// Return true if a label was seen in the current scope.
331 bool hasLabelBeenSeenInCurrentScope() const {
333 return CurLexicalScope->hasLabels();
334 return !LabelMap.empty();
337 /// AllocaInsertPoint - This is an instruction in the entry block before which
338 /// we prefer to insert allocas.
339 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
341 /// API for captured statement code generation.
342 class CGCapturedStmtInfo {
344 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
345 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
346 explicit CGCapturedStmtInfo(const CapturedStmt &S,
347 CapturedRegionKind K = CR_Default)
348 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
350 RecordDecl::field_iterator Field =
351 S.getCapturedRecordDecl()->field_begin();
352 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
354 I != E; ++I, ++Field) {
355 if (I->capturesThis())
356 CXXThisFieldDecl = *Field;
357 else if (I->capturesVariable())
358 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
359 else if (I->capturesVariableByCopy())
360 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
364 virtual ~CGCapturedStmtInfo();
366 CapturedRegionKind getKind() const { return Kind; }
368 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
369 // Retrieve the value of the context parameter.
370 virtual llvm::Value *getContextValue() const { return ThisValue; }
372 /// Lookup the captured field decl for a variable.
373 virtual const FieldDecl *lookup(const VarDecl *VD) const {
374 return CaptureFields.lookup(VD->getCanonicalDecl());
377 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
378 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
380 static bool classof(const CGCapturedStmtInfo *) {
384 /// Emit the captured statement body.
385 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
386 CGF.incrementProfileCounter(S);
390 /// Get the name of the capture helper.
391 virtual StringRef getHelperName() const { return "__captured_stmt"; }
394 /// The kind of captured statement being generated.
395 CapturedRegionKind Kind;
397 /// Keep the map between VarDecl and FieldDecl.
398 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
400 /// The base address of the captured record, passed in as the first
401 /// argument of the parallel region function.
402 llvm::Value *ThisValue;
404 /// Captured 'this' type.
405 FieldDecl *CXXThisFieldDecl;
407 CGCapturedStmtInfo *CapturedStmtInfo = nullptr;
409 /// RAII for correct setting/restoring of CapturedStmtInfo.
410 class CGCapturedStmtRAII {
412 CodeGenFunction &CGF;
413 CGCapturedStmtInfo *PrevCapturedStmtInfo;
415 CGCapturedStmtRAII(CodeGenFunction &CGF,
416 CGCapturedStmtInfo *NewCapturedStmtInfo)
417 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
418 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
420 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
423 /// An abstract representation of regular/ObjC call/message targets.
424 class AbstractCallee {
425 /// The function declaration of the callee.
426 const Decl *CalleeDecl;
429 AbstractCallee() : CalleeDecl(nullptr) {}
430 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
431 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
432 bool hasFunctionDecl() const {
433 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
435 const Decl *getDecl() const { return CalleeDecl; }
436 unsigned getNumParams() const {
437 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
438 return FD->getNumParams();
439 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
441 const ParmVarDecl *getParamDecl(unsigned I) const {
442 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
443 return FD->getParamDecl(I);
444 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
448 /// Sanitizers enabled for this function.
449 SanitizerSet SanOpts;
451 /// True if CodeGen currently emits code implementing sanitizer checks.
452 bool IsSanitizerScope = false;
454 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
455 class SanitizerScope {
456 CodeGenFunction *CGF;
458 SanitizerScope(CodeGenFunction *CGF);
462 /// In C++, whether we are code generating a thunk. This controls whether we
463 /// should emit cleanups.
464 bool CurFuncIsThunk = false;
466 /// In ARC, whether we should autorelease the return value.
467 bool AutoreleaseResult = false;
469 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
470 /// potentially set the return value.
471 bool SawAsmBlock = false;
473 const NamedDecl *CurSEHParent = nullptr;
475 /// True if the current function is an outlined SEH helper. This can be a
476 /// finally block or filter expression.
477 bool IsOutlinedSEHHelper = false;
479 const CodeGen::CGBlockInfo *BlockInfo = nullptr;
480 llvm::Value *BlockPointer = nullptr;
482 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
483 FieldDecl *LambdaThisCaptureField = nullptr;
485 /// A mapping from NRVO variables to the flags used to indicate
486 /// when the NRVO has been applied to this variable.
487 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
489 EHScopeStack EHStack;
490 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
491 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
493 llvm::Instruction *CurrentFuncletPad = nullptr;
495 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
500 CallLifetimeEnd(Address addr, llvm::Value *size)
501 : Addr(addr.getPointer()), Size(size) {}
503 void Emit(CodeGenFunction &CGF, Flags flags) override {
504 CGF.EmitLifetimeEnd(Size, Addr);
508 /// Header for data within LifetimeExtendedCleanupStack.
509 struct LifetimeExtendedCleanupHeader {
510 /// The size of the following cleanup object.
512 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
514 /// Whether this is a conditional cleanup.
515 unsigned IsConditional : 1;
517 size_t getSize() const { return Size; }
518 CleanupKind getKind() const { return (CleanupKind)Kind; }
519 bool isConditional() const { return IsConditional; }
522 /// i32s containing the indexes of the cleanup destinations.
523 Address NormalCleanupDest = Address::invalid();
525 unsigned NextCleanupDestIndex = 1;
527 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
528 CGBlockInfo *FirstBlockInfo = nullptr;
530 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
531 llvm::BasicBlock *EHResumeBlock = nullptr;
533 /// The exception slot. All landing pads write the current exception pointer
534 /// into this alloca.
535 llvm::Value *ExceptionSlot = nullptr;
537 /// The selector slot. Under the MandatoryCleanup model, all landing pads
538 /// write the current selector value into this alloca.
539 llvm::AllocaInst *EHSelectorSlot = nullptr;
541 /// A stack of exception code slots. Entering an __except block pushes a slot
542 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
543 /// a value from the top of the stack.
544 SmallVector<Address, 1> SEHCodeSlotStack;
546 /// Value returned by __exception_info intrinsic.
547 llvm::Value *SEHInfo = nullptr;
549 /// Emits a landing pad for the current EH stack.
550 llvm::BasicBlock *EmitLandingPad();
552 llvm::BasicBlock *getInvokeDestImpl();
555 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
556 return DominatingValue<T>::save(*this, value);
560 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
562 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
564 /// A class controlling the emission of a finally block.
566 /// Where the catchall's edge through the cleanup should go.
567 JumpDest RethrowDest;
569 /// A function to call to enter the catch.
570 llvm::Constant *BeginCatchFn;
572 /// An i1 variable indicating whether or not the @finally is
573 /// running for an exception.
574 llvm::AllocaInst *ForEHVar;
576 /// An i8* variable into which the exception pointer to rethrow
578 llvm::AllocaInst *SavedExnVar;
581 void enter(CodeGenFunction &CGF, const Stmt *Finally,
582 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
583 llvm::Constant *rethrowFn);
584 void exit(CodeGenFunction &CGF);
587 /// Returns true inside SEH __try blocks.
588 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
590 /// Returns true while emitting a cleanuppad.
591 bool isCleanupPadScope() const {
592 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
595 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
596 /// current full-expression. Safe against the possibility that
597 /// we're currently inside a conditionally-evaluated expression.
598 template <class T, class... As>
599 void pushFullExprCleanup(CleanupKind kind, As... A) {
600 // If we're not in a conditional branch, or if none of the
601 // arguments requires saving, then use the unconditional cleanup.
602 if (!isInConditionalBranch())
603 return EHStack.pushCleanup<T>(kind, A...);
605 // Stash values in a tuple so we can guarantee the order of saves.
606 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
607 SavedTuple Saved{saveValueInCond(A)...};
609 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
610 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
611 initFullExprCleanup();
614 /// Queue a cleanup to be pushed after finishing the current
616 template <class T, class... As>
617 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
618 if (!isInConditionalBranch())
619 return pushCleanupAfterFullExprImpl<T>(Kind, Address::invalid(), A...);
621 Address ActiveFlag = createCleanupActiveFlag();
622 assert(!DominatingValue<Address>::needsSaving(ActiveFlag) &&
623 "cleanup active flag should never need saving");
625 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
626 SavedTuple Saved{saveValueInCond(A)...};
628 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
629 pushCleanupAfterFullExprImpl<CleanupType>(Kind, ActiveFlag, Saved);
632 template <class T, class... As>
633 void pushCleanupAfterFullExprImpl(CleanupKind Kind, Address ActiveFlag,
635 LifetimeExtendedCleanupHeader Header = {sizeof(T), Kind,
636 ActiveFlag.isValid()};
638 size_t OldSize = LifetimeExtendedCleanupStack.size();
639 LifetimeExtendedCleanupStack.resize(
640 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size +
641 (Header.IsConditional ? sizeof(ActiveFlag) : 0));
643 static_assert(sizeof(Header) % alignof(T) == 0,
644 "Cleanup will be allocated on misaligned address");
645 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
646 new (Buffer) LifetimeExtendedCleanupHeader(Header);
647 new (Buffer + sizeof(Header)) T(A...);
648 if (Header.IsConditional)
649 new (Buffer + sizeof(Header) + sizeof(T)) Address(ActiveFlag);
652 /// Set up the last cleanup that was pushed as a conditional
653 /// full-expression cleanup.
654 void initFullExprCleanup() {
655 initFullExprCleanupWithFlag(createCleanupActiveFlag());
658 void initFullExprCleanupWithFlag(Address ActiveFlag);
659 Address createCleanupActiveFlag();
661 /// PushDestructorCleanup - Push a cleanup to call the
662 /// complete-object destructor of an object of the given type at the
663 /// given address. Does nothing if T is not a C++ class type with a
664 /// non-trivial destructor.
665 void PushDestructorCleanup(QualType T, Address Addr);
667 /// PushDestructorCleanup - Push a cleanup to call the
668 /// complete-object variant of the given destructor on the object at
669 /// the given address.
670 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
672 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
673 /// process all branch fixups.
674 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
676 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
677 /// The block cannot be reactivated. Pops it if it's the top of the
680 /// \param DominatingIP - An instruction which is known to
681 /// dominate the current IP (if set) and which lies along
682 /// all paths of execution between the current IP and the
683 /// the point at which the cleanup comes into scope.
684 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
685 llvm::Instruction *DominatingIP);
687 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
688 /// Cannot be used to resurrect a deactivated cleanup.
690 /// \param DominatingIP - An instruction which is known to
691 /// dominate the current IP (if set) and which lies along
692 /// all paths of execution between the current IP and the
693 /// the point at which the cleanup comes into scope.
694 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
695 llvm::Instruction *DominatingIP);
697 /// Enters a new scope for capturing cleanups, all of which
698 /// will be executed once the scope is exited.
699 class RunCleanupsScope {
700 EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
701 size_t LifetimeExtendedCleanupStackSize;
702 bool OldDidCallStackSave;
707 RunCleanupsScope(const RunCleanupsScope &) = delete;
708 void operator=(const RunCleanupsScope &) = delete;
711 CodeGenFunction& CGF;
714 /// Enter a new cleanup scope.
715 explicit RunCleanupsScope(CodeGenFunction &CGF)
716 : PerformCleanup(true), CGF(CGF)
718 CleanupStackDepth = CGF.EHStack.stable_begin();
719 LifetimeExtendedCleanupStackSize =
720 CGF.LifetimeExtendedCleanupStack.size();
721 OldDidCallStackSave = CGF.DidCallStackSave;
722 CGF.DidCallStackSave = false;
723 OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
724 CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
727 /// Exit this cleanup scope, emitting any accumulated cleanups.
728 ~RunCleanupsScope() {
733 /// Determine whether this scope requires any cleanups.
734 bool requiresCleanups() const {
735 return CGF.EHStack.stable_begin() != CleanupStackDepth;
738 /// Force the emission of cleanups now, instead of waiting
739 /// until this object is destroyed.
740 /// \param ValuesToReload - A list of values that need to be available at
741 /// the insertion point after cleanup emission. If cleanup emission created
742 /// a shared cleanup block, these value pointers will be rewritten.
743 /// Otherwise, they not will be modified.
744 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
745 assert(PerformCleanup && "Already forced cleanup");
746 CGF.DidCallStackSave = OldDidCallStackSave;
747 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
749 PerformCleanup = false;
750 CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
754 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
755 EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
756 EHScopeStack::stable_end();
758 class LexicalScope : public RunCleanupsScope {
760 SmallVector<const LabelDecl*, 4> Labels;
761 LexicalScope *ParentScope;
763 LexicalScope(const LexicalScope &) = delete;
764 void operator=(const LexicalScope &) = delete;
767 /// Enter a new cleanup scope.
768 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
769 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
770 CGF.CurLexicalScope = this;
771 if (CGDebugInfo *DI = CGF.getDebugInfo())
772 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
775 void addLabel(const LabelDecl *label) {
776 assert(PerformCleanup && "adding label to dead scope?");
777 Labels.push_back(label);
780 /// Exit this cleanup scope, emitting any accumulated
783 if (CGDebugInfo *DI = CGF.getDebugInfo())
784 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
786 // If we should perform a cleanup, force them now. Note that
787 // this ends the cleanup scope before rescoping any labels.
788 if (PerformCleanup) {
789 ApplyDebugLocation DL(CGF, Range.getEnd());
794 /// Force the emission of cleanups now, instead of waiting
795 /// until this object is destroyed.
796 void ForceCleanup() {
797 CGF.CurLexicalScope = ParentScope;
798 RunCleanupsScope::ForceCleanup();
804 bool hasLabels() const {
805 return !Labels.empty();
808 void rescopeLabels();
811 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
813 /// The class used to assign some variables some temporarily addresses.
815 DeclMapTy SavedLocals;
816 DeclMapTy SavedTempAddresses;
817 OMPMapVars(const OMPMapVars &) = delete;
818 void operator=(const OMPMapVars &) = delete;
821 explicit OMPMapVars() = default;
823 assert(SavedLocals.empty() && "Did not restored original addresses.");
826 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
828 /// \return true if at least one variable was set already, false otherwise.
829 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
831 LocalVD = LocalVD->getCanonicalDecl();
832 // Only save it once.
833 if (SavedLocals.count(LocalVD)) return false;
835 // Copy the existing local entry to SavedLocals.
836 auto it = CGF.LocalDeclMap.find(LocalVD);
837 if (it != CGF.LocalDeclMap.end())
838 SavedLocals.try_emplace(LocalVD, it->second);
840 SavedLocals.try_emplace(LocalVD, Address::invalid());
842 // Generate the private entry.
843 QualType VarTy = LocalVD->getType();
844 if (VarTy->isReferenceType()) {
845 Address Temp = CGF.CreateMemTemp(VarTy);
846 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
849 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
854 /// Applies new addresses to the list of the variables.
855 /// \return true if at least one variable is using new address, false
857 bool apply(CodeGenFunction &CGF) {
858 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
859 SavedTempAddresses.clear();
860 return !SavedLocals.empty();
863 /// Restores original addresses of the variables.
864 void restore(CodeGenFunction &CGF) {
865 if (!SavedLocals.empty()) {
866 copyInto(SavedLocals, CGF.LocalDeclMap);
872 /// Copy all the entries in the source map over the corresponding
873 /// entries in the destination, which must exist.
874 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
875 for (auto &Pair : Src) {
876 if (!Pair.second.isValid()) {
877 Dest.erase(Pair.first);
881 auto I = Dest.find(Pair.first);
883 I->second = Pair.second;
890 /// The scope used to remap some variables as private in the OpenMP loop body
891 /// (or other captured region emitted without outlining), and to restore old
892 /// vars back on exit.
893 class OMPPrivateScope : public RunCleanupsScope {
894 OMPMapVars MappedVars;
895 OMPPrivateScope(const OMPPrivateScope &) = delete;
896 void operator=(const OMPPrivateScope &) = delete;
899 /// Enter a new OpenMP private scope.
900 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
902 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
903 /// function for it to generate corresponding private variable. \p
904 /// PrivateGen returns an address of the generated private variable.
905 /// \return true if the variable is registered as private, false if it has
906 /// been privatized already.
907 bool addPrivate(const VarDecl *LocalVD,
908 const llvm::function_ref<Address()> PrivateGen) {
909 assert(PerformCleanup && "adding private to dead scope");
910 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
913 /// Privatizes local variables previously registered as private.
914 /// Registration is separate from the actual privatization to allow
915 /// initializers use values of the original variables, not the private one.
916 /// This is important, for example, if the private variable is a class
917 /// variable initialized by a constructor that references other private
918 /// variables. But at initialization original variables must be used, not
920 /// \return true if at least one variable was privatized, false otherwise.
921 bool Privatize() { return MappedVars.apply(CGF); }
923 void ForceCleanup() {
924 RunCleanupsScope::ForceCleanup();
925 MappedVars.restore(CGF);
928 /// Exit scope - all the mapped variables are restored.
934 /// Checks if the global variable is captured in current function.
935 bool isGlobalVarCaptured(const VarDecl *VD) const {
936 VD = VD->getCanonicalDecl();
937 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
941 /// Takes the old cleanup stack size and emits the cleanup blocks
942 /// that have been added.
944 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
945 std::initializer_list<llvm::Value **> ValuesToReload = {});
947 /// Takes the old cleanup stack size and emits the cleanup blocks
948 /// that have been added, then adds all lifetime-extended cleanups from
949 /// the given position to the stack.
951 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
952 size_t OldLifetimeExtendedStackSize,
953 std::initializer_list<llvm::Value **> ValuesToReload = {});
955 void ResolveBranchFixups(llvm::BasicBlock *Target);
957 /// The given basic block lies in the current EH scope, but may be a
958 /// target of a potentially scope-crossing jump; get a stable handle
959 /// to which we can perform this jump later.
960 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
961 return JumpDest(Target,
962 EHStack.getInnermostNormalCleanup(),
963 NextCleanupDestIndex++);
966 /// The given basic block lies in the current EH scope, but may be a
967 /// target of a potentially scope-crossing jump; get a stable handle
968 /// to which we can perform this jump later.
969 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
970 return getJumpDestInCurrentScope(createBasicBlock(Name));
973 /// EmitBranchThroughCleanup - Emit a branch from the current insert
974 /// block through the normal cleanup handling code (if any) and then
976 void EmitBranchThroughCleanup(JumpDest Dest);
978 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
979 /// specified destination obviously has no cleanups to run. 'false' is always
980 /// a conservatively correct answer for this method.
981 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
983 /// popCatchScope - Pops the catch scope at the top of the EHScope
984 /// stack, emitting any required code (other than the catch handlers
986 void popCatchScope();
988 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
989 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
991 getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope);
993 /// An object to manage conditionally-evaluated expressions.
994 class ConditionalEvaluation {
995 llvm::BasicBlock *StartBB;
998 ConditionalEvaluation(CodeGenFunction &CGF)
999 : StartBB(CGF.Builder.GetInsertBlock()) {}
1001 void begin(CodeGenFunction &CGF) {
1002 assert(CGF.OutermostConditional != this);
1003 if (!CGF.OutermostConditional)
1004 CGF.OutermostConditional = this;
1007 void end(CodeGenFunction &CGF) {
1008 assert(CGF.OutermostConditional != nullptr);
1009 if (CGF.OutermostConditional == this)
1010 CGF.OutermostConditional = nullptr;
1013 /// Returns a block which will be executed prior to each
1014 /// evaluation of the conditional code.
1015 llvm::BasicBlock *getStartingBlock() const {
1020 /// isInConditionalBranch - Return true if we're currently emitting
1021 /// one branch or the other of a conditional expression.
1022 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
1024 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
1025 assert(isInConditionalBranch());
1026 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
1027 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
1028 store->setAlignment(addr.getAlignment().getQuantity());
1031 /// An RAII object to record that we're evaluating a statement
1033 class StmtExprEvaluation {
1034 CodeGenFunction &CGF;
1036 /// We have to save the outermost conditional: cleanups in a
1037 /// statement expression aren't conditional just because the
1039 ConditionalEvaluation *SavedOutermostConditional;
1042 StmtExprEvaluation(CodeGenFunction &CGF)
1043 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
1044 CGF.OutermostConditional = nullptr;
1047 ~StmtExprEvaluation() {
1048 CGF.OutermostConditional = SavedOutermostConditional;
1049 CGF.EnsureInsertPoint();
1053 /// An object which temporarily prevents a value from being
1054 /// destroyed by aggressive peephole optimizations that assume that
1055 /// all uses of a value have been realized in the IR.
1056 class PeepholeProtection {
1057 llvm::Instruction *Inst;
1058 friend class CodeGenFunction;
1061 PeepholeProtection() : Inst(nullptr) {}
1064 /// A non-RAII class containing all the information about a bound
1065 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1066 /// this which makes individual mappings very simple; using this
1067 /// class directly is useful when you have a variable number of
1068 /// opaque values or don't want the RAII functionality for some
1070 class OpaqueValueMappingData {
1071 const OpaqueValueExpr *OpaqueValue;
1073 CodeGenFunction::PeepholeProtection Protection;
1075 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1077 : OpaqueValue(ov), BoundLValue(boundLValue) {}
1079 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
1081 static bool shouldBindAsLValue(const Expr *expr) {
1082 // gl-values should be bound as l-values for obvious reasons.
1083 // Records should be bound as l-values because IR generation
1084 // always keeps them in memory. Expressions of function type
1085 // act exactly like l-values but are formally required to be
1087 return expr->isGLValue() ||
1088 expr->getType()->isFunctionType() ||
1089 hasAggregateEvaluationKind(expr->getType());
1092 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1093 const OpaqueValueExpr *ov,
1095 if (shouldBindAsLValue(ov))
1096 return bind(CGF, ov, CGF.EmitLValue(e));
1097 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1100 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1101 const OpaqueValueExpr *ov,
1103 assert(shouldBindAsLValue(ov));
1104 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1105 return OpaqueValueMappingData(ov, true);
1108 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1109 const OpaqueValueExpr *ov,
1111 assert(!shouldBindAsLValue(ov));
1112 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1114 OpaqueValueMappingData data(ov, false);
1116 // Work around an extremely aggressive peephole optimization in
1117 // EmitScalarConversion which assumes that all other uses of a
1118 // value are extant.
1119 data.Protection = CGF.protectFromPeepholes(rv);
1124 bool isValid() const { return OpaqueValue != nullptr; }
1125 void clear() { OpaqueValue = nullptr; }
1127 void unbind(CodeGenFunction &CGF) {
1128 assert(OpaqueValue && "no data to unbind!");
1131 CGF.OpaqueLValues.erase(OpaqueValue);
1133 CGF.OpaqueRValues.erase(OpaqueValue);
1134 CGF.unprotectFromPeepholes(Protection);
1139 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1140 class OpaqueValueMapping {
1141 CodeGenFunction &CGF;
1142 OpaqueValueMappingData Data;
1145 static bool shouldBindAsLValue(const Expr *expr) {
1146 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1149 /// Build the opaque value mapping for the given conditional
1150 /// operator if it's the GNU ?: extension. This is a common
1151 /// enough pattern that the convenience operator is really
1154 OpaqueValueMapping(CodeGenFunction &CGF,
1155 const AbstractConditionalOperator *op) : CGF(CGF) {
1156 if (isa<ConditionalOperator>(op))
1157 // Leave Data empty.
1160 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
1161 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1165 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1166 /// expression is set to the expression the OVE represents.
1167 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1170 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1171 "for OVE with no source expression");
1172 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1176 OpaqueValueMapping(CodeGenFunction &CGF,
1177 const OpaqueValueExpr *opaqueValue,
1179 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
1182 OpaqueValueMapping(CodeGenFunction &CGF,
1183 const OpaqueValueExpr *opaqueValue,
1185 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
1193 ~OpaqueValueMapping() {
1194 if (Data.isValid()) Data.unbind(CGF);
1199 CGDebugInfo *DebugInfo;
1200 bool DisableDebugInfo = false;
1202 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1203 /// calling llvm.stacksave for multiple VLAs in the same scope.
1204 bool DidCallStackSave = false;
1206 /// IndirectBranch - The first time an indirect goto is seen we create a block
1207 /// with an indirect branch. Every time we see the address of a label taken,
1208 /// we add the label to the indirect goto. Every subsequent indirect goto is
1209 /// codegen'd as a jump to the IndirectBranch's basic block.
1210 llvm::IndirectBrInst *IndirectBranch = nullptr;
1212 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1214 DeclMapTy LocalDeclMap;
1216 // Keep track of the cleanups for callee-destructed parameters pushed to the
1217 // cleanup stack so that they can be deactivated later.
1218 llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1219 CalleeDestructedParamCleanups;
1221 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1222 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1224 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1227 /// Track escaped local variables with auto storage. Used during SEH
1228 /// outlining to produce a call to llvm.localescape.
1229 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1231 /// LabelMap - This keeps track of the LLVM basic block for each C label.
1232 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
1234 // BreakContinueStack - This keeps track of where break and continue
1235 // statements should jump to.
1236 struct BreakContinue {
1237 BreakContinue(JumpDest Break, JumpDest Continue)
1238 : BreakBlock(Break), ContinueBlock(Continue) {}
1240 JumpDest BreakBlock;
1241 JumpDest ContinueBlock;
1243 SmallVector<BreakContinue, 8> BreakContinueStack;
1245 /// Handles cancellation exit points in OpenMP-related constructs.
1246 class OpenMPCancelExitStack {
1247 /// Tracks cancellation exit point and join point for cancel-related exit
1248 /// and normal exit.
1250 CancelExit() = default;
1251 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1253 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1254 OpenMPDirectiveKind Kind = OMPD_unknown;
1255 /// true if the exit block has been emitted already by the special
1256 /// emitExit() call, false if the default codegen is used.
1257 bool HasBeenEmitted = false;
1262 SmallVector<CancelExit, 8> Stack;
1265 OpenMPCancelExitStack() : Stack(1) {}
1266 ~OpenMPCancelExitStack() = default;
1267 /// Fetches the exit block for the current OpenMP construct.
1268 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1269 /// Emits exit block with special codegen procedure specific for the related
1270 /// OpenMP construct + emits code for normal construct cleanup.
1271 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1272 const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
1273 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1274 assert(CGF.getOMPCancelDestination(Kind).isValid());
1275 assert(CGF.HaveInsertPoint());
1276 assert(!Stack.back().HasBeenEmitted);
1277 auto IP = CGF.Builder.saveAndClearIP();
1278 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1280 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
1281 CGF.Builder.restoreIP(IP);
1282 Stack.back().HasBeenEmitted = true;
1286 /// Enter the cancel supporting \a Kind construct.
1287 /// \param Kind OpenMP directive that supports cancel constructs.
1288 /// \param HasCancel true, if the construct has inner cancel directive,
1289 /// false otherwise.
1290 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1291 Stack.push_back({Kind,
1292 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1294 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1297 /// Emits default exit point for the cancel construct (if the special one
1298 /// has not be used) + join point for cancel/normal exits.
1299 void exit(CodeGenFunction &CGF) {
1300 if (getExitBlock().isValid()) {
1301 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1302 bool HaveIP = CGF.HaveInsertPoint();
1303 if (!Stack.back().HasBeenEmitted) {
1305 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1306 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1307 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1309 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1311 CGF.Builder.CreateUnreachable();
1312 CGF.Builder.ClearInsertionPoint();
1318 OpenMPCancelExitStack OMPCancelStack;
1322 /// Calculate branch weights appropriate for PGO data
1323 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1324 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1325 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1326 uint64_t LoopCount);
1329 /// Increment the profiler's counter for the given statement by \p StepV.
1330 /// If \p StepV is null, the default increment is 1.
1331 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
1332 if (CGM.getCodeGenOpts().hasProfileClangInstr())
1333 PGO.emitCounterIncrement(Builder, S, StepV);
1334 PGO.setCurrentStmt(S);
1337 /// Get the profiler's count for the given statement.
1338 uint64_t getProfileCount(const Stmt *S) {
1339 Optional<uint64_t> Count = PGO.getStmtCount(S);
1340 if (!Count.hasValue())
1345 /// Set the profiler's current count.
1346 void setCurrentProfileCount(uint64_t Count) {
1347 PGO.setCurrentRegionCount(Count);
1350 /// Get the profiler's current count. This is generally the count for the most
1351 /// recently incremented counter.
1352 uint64_t getCurrentProfileCount() {
1353 return PGO.getCurrentRegionCount();
1358 /// SwitchInsn - This is nearest current switch instruction. It is null if
1359 /// current context is not in a switch.
1360 llvm::SwitchInst *SwitchInsn = nullptr;
1361 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1362 SmallVector<uint64_t, 16> *SwitchWeights = nullptr;
1364 /// CaseRangeBlock - This block holds if condition check for last case
1365 /// statement range in current switch instruction.
1366 llvm::BasicBlock *CaseRangeBlock = nullptr;
1368 /// OpaqueLValues - Keeps track of the current set of opaque value
1370 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1371 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
1373 // VLASizeMap - This keeps track of the associated size for each VLA type.
1374 // We track this by the size expression rather than the type itself because
1375 // in certain situations, like a const qualifier applied to an VLA typedef,
1376 // multiple VLA types can share the same size expression.
1377 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1378 // enter/leave scopes.
1379 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
1381 /// A block containing a single 'unreachable' instruction. Created
1382 /// lazily by getUnreachableBlock().
1383 llvm::BasicBlock *UnreachableBlock = nullptr;
1385 /// Counts of the number return expressions in the function.
1386 unsigned NumReturnExprs = 0;
1388 /// Count the number of simple (constant) return expressions in the function.
1389 unsigned NumSimpleReturnExprs = 0;
1391 /// The last regular (non-return) debug location (breakpoint) in the function.
1392 SourceLocation LastStopPoint;
1395 /// A scope within which we are constructing the fields of an object which
1396 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1397 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1398 class FieldConstructionScope {
1400 FieldConstructionScope(CodeGenFunction &CGF, Address This)
1401 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1402 CGF.CXXDefaultInitExprThis = This;
1404 ~FieldConstructionScope() {
1405 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1409 CodeGenFunction &CGF;
1410 Address OldCXXDefaultInitExprThis;
1413 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1414 /// is overridden to be the object under construction.
1415 class CXXDefaultInitExprScope {
1417 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1418 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1419 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1420 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1421 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
1423 ~CXXDefaultInitExprScope() {
1424 CGF.CXXThisValue = OldCXXThisValue;
1425 CGF.CXXThisAlignment = OldCXXThisAlignment;
1429 CodeGenFunction &CGF;
1430 llvm::Value *OldCXXThisValue;
1431 CharUnits OldCXXThisAlignment;
1434 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1435 /// current loop index is overridden.
1436 class ArrayInitLoopExprScope {
1438 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1439 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1440 CGF.ArrayInitIndex = Index;
1442 ~ArrayInitLoopExprScope() {
1443 CGF.ArrayInitIndex = OldArrayInitIndex;
1447 CodeGenFunction &CGF;
1448 llvm::Value *OldArrayInitIndex;
1451 class InlinedInheritingConstructorScope {
1453 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1454 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1455 OldCurCodeDecl(CGF.CurCodeDecl),
1456 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1457 OldCXXABIThisValue(CGF.CXXABIThisValue),
1458 OldCXXThisValue(CGF.CXXThisValue),
1459 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1460 OldCXXThisAlignment(CGF.CXXThisAlignment),
1461 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1462 OldCXXInheritedCtorInitExprArgs(
1463 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1465 CGF.CurFuncDecl = CGF.CurCodeDecl =
1466 cast<CXXConstructorDecl>(GD.getDecl());
1467 CGF.CXXABIThisDecl = nullptr;
1468 CGF.CXXABIThisValue = nullptr;
1469 CGF.CXXThisValue = nullptr;
1470 CGF.CXXABIThisAlignment = CharUnits();
1471 CGF.CXXThisAlignment = CharUnits();
1472 CGF.ReturnValue = Address::invalid();
1473 CGF.FnRetTy = QualType();
1474 CGF.CXXInheritedCtorInitExprArgs.clear();
1476 ~InlinedInheritingConstructorScope() {
1477 CGF.CurGD = OldCurGD;
1478 CGF.CurFuncDecl = OldCurFuncDecl;
1479 CGF.CurCodeDecl = OldCurCodeDecl;
1480 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1481 CGF.CXXABIThisValue = OldCXXABIThisValue;
1482 CGF.CXXThisValue = OldCXXThisValue;
1483 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1484 CGF.CXXThisAlignment = OldCXXThisAlignment;
1485 CGF.ReturnValue = OldReturnValue;
1486 CGF.FnRetTy = OldFnRetTy;
1487 CGF.CXXInheritedCtorInitExprArgs =
1488 std::move(OldCXXInheritedCtorInitExprArgs);
1492 CodeGenFunction &CGF;
1493 GlobalDecl OldCurGD;
1494 const Decl *OldCurFuncDecl;
1495 const Decl *OldCurCodeDecl;
1496 ImplicitParamDecl *OldCXXABIThisDecl;
1497 llvm::Value *OldCXXABIThisValue;
1498 llvm::Value *OldCXXThisValue;
1499 CharUnits OldCXXABIThisAlignment;
1500 CharUnits OldCXXThisAlignment;
1501 Address OldReturnValue;
1502 QualType OldFnRetTy;
1503 CallArgList OldCXXInheritedCtorInitExprArgs;
1507 /// CXXThisDecl - When generating code for a C++ member function,
1508 /// this will hold the implicit 'this' declaration.
1509 ImplicitParamDecl *CXXABIThisDecl = nullptr;
1510 llvm::Value *CXXABIThisValue = nullptr;
1511 llvm::Value *CXXThisValue = nullptr;
1512 CharUnits CXXABIThisAlignment;
1513 CharUnits CXXThisAlignment;
1515 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1516 /// this expression.
1517 Address CXXDefaultInitExprThis = Address::invalid();
1519 /// The current array initialization index when evaluating an
1520 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1521 llvm::Value *ArrayInitIndex = nullptr;
1523 /// The values of function arguments to use when evaluating
1524 /// CXXInheritedCtorInitExprs within this context.
1525 CallArgList CXXInheritedCtorInitExprArgs;
1527 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1528 /// destructor, this will hold the implicit argument (e.g. VTT).
1529 ImplicitParamDecl *CXXStructorImplicitParamDecl = nullptr;
1530 llvm::Value *CXXStructorImplicitParamValue = nullptr;
1532 /// OutermostConditional - Points to the outermost active
1533 /// conditional control. This is used so that we know if a
1534 /// temporary should be destroyed conditionally.
1535 ConditionalEvaluation *OutermostConditional = nullptr;
1537 /// The current lexical scope.
1538 LexicalScope *CurLexicalScope = nullptr;
1540 /// The current source location that should be used for exception
1542 SourceLocation CurEHLocation;
1544 /// BlockByrefInfos - For each __block variable, contains
1545 /// information about the layout of the variable.
1546 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
1548 /// Used by -fsanitize=nullability-return to determine whether the return
1549 /// value can be checked.
1550 llvm::Value *RetValNullabilityPrecondition = nullptr;
1552 /// Check if -fsanitize=nullability-return instrumentation is required for
1554 bool requiresReturnValueNullabilityCheck() const {
1555 return RetValNullabilityPrecondition;
1558 /// Used to store precise source locations for return statements by the
1559 /// runtime return value checks.
1560 Address ReturnLocation = Address::invalid();
1562 /// Check if the return value of this function requires sanitization.
1563 bool requiresReturnValueCheck() const {
1564 return requiresReturnValueNullabilityCheck() ||
1565 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1566 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1569 llvm::BasicBlock *TerminateLandingPad = nullptr;
1570 llvm::BasicBlock *TerminateHandler = nullptr;
1571 llvm::BasicBlock *TrapBB = nullptr;
1573 /// Terminate funclets keyed by parent funclet pad.
1574 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1576 /// Largest vector width used in ths function. Will be used to create a
1577 /// function attribute.
1578 unsigned LargestVectorWidth = 0;
1580 /// True if we need emit the life-time markers.
1581 const bool ShouldEmitLifetimeMarkers;
1583 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
1584 /// the function metadata.
1585 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1586 llvm::Function *Fn);
1589 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
1592 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
1593 ASTContext &getContext() const { return CGM.getContext(); }
1594 CGDebugInfo *getDebugInfo() {
1595 if (DisableDebugInfo)
1599 void disableDebugInfo() { DisableDebugInfo = true; }
1600 void enableDebugInfo() { DisableDebugInfo = false; }
1602 bool shouldUseFusedARCCalls() {
1603 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1606 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
1608 /// Returns a pointer to the function's exception object and selector slot,
1609 /// which is assigned in every landing pad.
1610 Address getExceptionSlot();
1611 Address getEHSelectorSlot();
1613 /// Returns the contents of the function's exception object and selector
1615 llvm::Value *getExceptionFromSlot();
1616 llvm::Value *getSelectorFromSlot();
1618 Address getNormalCleanupDestSlot();
1620 llvm::BasicBlock *getUnreachableBlock() {
1621 if (!UnreachableBlock) {
1622 UnreachableBlock = createBasicBlock("unreachable");
1623 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1625 return UnreachableBlock;
1628 llvm::BasicBlock *getInvokeDest() {
1629 if (!EHStack.requiresLandingPad()) return nullptr;
1630 return getInvokeDestImpl();
1633 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
1635 const TargetInfo &getTarget() const { return Target; }
1636 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
1637 const TargetCodeGenInfo &getTargetHooks() const {
1638 return CGM.getTargetCodeGenInfo();
1641 //===--------------------------------------------------------------------===//
1643 //===--------------------------------------------------------------------===//
1645 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
1647 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1648 Address arrayEndPointer,
1649 QualType elementType,
1650 CharUnits elementAlignment,
1651 Destroyer *destroyer);
1652 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1653 llvm::Value *arrayEnd,
1654 QualType elementType,
1655 CharUnits elementAlignment,
1656 Destroyer *destroyer);
1658 void pushDestroy(QualType::DestructionKind dtorKind,
1659 Address addr, QualType type);
1660 void pushEHDestroy(QualType::DestructionKind dtorKind,
1661 Address addr, QualType type);
1662 void pushDestroy(CleanupKind kind, Address addr, QualType type,
1663 Destroyer *destroyer, bool useEHCleanupForArray);
1664 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
1665 QualType type, Destroyer *destroyer,
1666 bool useEHCleanupForArray);
1667 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1668 llvm::Value *CompletePtr,
1669 QualType ElementType);
1670 void pushStackRestore(CleanupKind kind, Address SPMem);
1671 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
1672 bool useEHCleanupForArray);
1673 llvm::Function *generateDestroyHelper(Address addr, QualType type,
1674 Destroyer *destroyer,
1675 bool useEHCleanupForArray,
1677 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
1678 QualType elementType, CharUnits elementAlign,
1679 Destroyer *destroyer,
1680 bool checkZeroLength, bool useEHCleanup);
1682 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
1684 /// Determines whether an EH cleanup is required to destroy a type
1685 /// with the given destruction kind.
1686 bool needsEHCleanup(QualType::DestructionKind kind) {
1688 case QualType::DK_none:
1690 case QualType::DK_cxx_destructor:
1691 case QualType::DK_objc_weak_lifetime:
1692 case QualType::DK_nontrivial_c_struct:
1693 return getLangOpts().Exceptions;
1694 case QualType::DK_objc_strong_lifetime:
1695 return getLangOpts().Exceptions &&
1696 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1698 llvm_unreachable("bad destruction kind");
1701 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1702 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1705 //===--------------------------------------------------------------------===//
1707 //===--------------------------------------------------------------------===//
1709 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
1711 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
1713 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
1714 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1715 const ObjCPropertyImplDecl *PID);
1716 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1717 const ObjCPropertyImplDecl *propImpl,
1718 const ObjCMethodDecl *GetterMothodDecl,
1719 llvm::Constant *AtomicHelperFn);
1721 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1722 ObjCMethodDecl *MD, bool ctor);
1724 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1725 /// for the given property.
1726 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1727 const ObjCPropertyImplDecl *PID);
1728 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1729 const ObjCPropertyImplDecl *propImpl,
1730 llvm::Constant *AtomicHelperFn);
1732 //===--------------------------------------------------------------------===//
1734 //===--------------------------------------------------------------------===//
1736 /// Emit block literal.
1737 /// \return an LLVM value which is a pointer to a struct which contains
1738 /// information about the block, including the block invoke function, the
1739 /// captured variables, etc.
1740 llvm::Value *EmitBlockLiteral(const BlockExpr *);
1741 static void destroyBlockInfos(CGBlockInfo *info);
1743 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
1744 const CGBlockInfo &Info,
1745 const DeclMapTy &ldm,
1746 bool IsLambdaConversionToBlock,
1747 bool BuildGlobalBlock);
1749 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1750 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
1751 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1752 const ObjCPropertyImplDecl *PID);
1753 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1754 const ObjCPropertyImplDecl *PID);
1755 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
1757 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1759 class AutoVarEmission;
1761 void emitByrefStructureInit(const AutoVarEmission &emission);
1763 /// Enter a cleanup to destroy a __block variable. Note that this
1764 /// cleanup should be a no-op if the variable hasn't left the stack
1765 /// yet; if a cleanup is required for the variable itself, that needs
1766 /// to be done externally.
1768 /// \param Kind Cleanup kind.
1770 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
1771 /// structure that will be passed to _Block_object_dispose. When
1772 /// \p LoadBlockVarAddr is true, the address of the field of the block
1773 /// structure that holds the address of the __block structure.
1775 /// \param Flags The flag that will be passed to _Block_object_dispose.
1777 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
1778 /// \p Addr to get the address of the __block structure.
1779 void enterByrefCleanup(CleanupKind Kind, Address Addr, BlockFieldFlags Flags,
1780 bool LoadBlockVarAddr);
1782 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1785 Address LoadBlockStruct();
1786 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1788 /// BuildBlockByrefAddress - Computes the location of the
1789 /// data in a variable which is declared as __block.
1790 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1791 bool followForward = true);
1792 Address emitBlockByrefAddress(Address baseAddr,
1793 const BlockByrefInfo &info,
1795 const llvm::Twine &name);
1797 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
1799 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1801 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1802 const CGFunctionInfo &FnInfo);
1803 /// Emit code for the start of a function.
1804 /// \param Loc The location to be associated with the function.
1805 /// \param StartLoc The location of the function body.
1806 void StartFunction(GlobalDecl GD,
1809 const CGFunctionInfo &FnInfo,
1810 const FunctionArgList &Args,
1811 SourceLocation Loc = SourceLocation(),
1812 SourceLocation StartLoc = SourceLocation());
1814 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1816 void EmitConstructorBody(FunctionArgList &Args);
1817 void EmitDestructorBody(FunctionArgList &Args);
1818 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
1819 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
1820 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
1822 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
1823 CallArgList &CallArgs);
1824 void EmitLambdaBlockInvokeBody();
1825 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1826 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
1827 void EmitAsanPrologueOrEpilogue(bool Prologue);
1829 /// Emit the unified return block, trying to avoid its emission when
1831 /// \return The debug location of the user written return statement if the
1832 /// return block is is avoided.
1833 llvm::DebugLoc EmitReturnBlock();
1835 /// FinishFunction - Complete IR generation of the current function. It is
1836 /// legal to call this function even if there is no current insertion point.
1837 void FinishFunction(SourceLocation EndLoc=SourceLocation());
1839 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1840 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
1842 void EmitCallAndReturnForThunk(llvm::Constant *Callee, const ThunkInfo *Thunk,
1843 bool IsUnprototyped);
1847 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1848 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1849 llvm::Value *Callee);
1851 /// Generate a thunk for the given method.
1852 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1853 GlobalDecl GD, const ThunkInfo &Thunk,
1854 bool IsUnprototyped);
1856 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1857 const CGFunctionInfo &FnInfo,
1858 GlobalDecl GD, const ThunkInfo &Thunk);
1860 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1861 FunctionArgList &Args);
1863 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
1865 /// Struct with all information about dynamic [sub]class needed to set vptr.
1868 const CXXRecordDecl *NearestVBase;
1869 CharUnits OffsetFromNearestVBase;
1870 const CXXRecordDecl *VTableClass;
1873 /// Initialize the vtable pointer of the given subobject.
1874 void InitializeVTablePointer(const VPtr &vptr);
1876 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
1878 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1879 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1881 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1882 CharUnits OffsetFromNearestVBase,
1883 bool BaseIsNonVirtualPrimaryBase,
1884 const CXXRecordDecl *VTableClass,
1885 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
1887 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
1889 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1891 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1892 const CXXRecordDecl *VTableClass);
1894 enum CFITypeCheckKind {
1898 CFITCK_UnrelatedCast,
1904 /// Derived is the presumed address of an object of type T after a
1905 /// cast. If T is a polymorphic class type, emit a check that the virtual
1906 /// table for Derived belongs to a class derived from T.
1907 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
1908 bool MayBeNull, CFITypeCheckKind TCK,
1909 SourceLocation Loc);
1911 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1912 /// If vptr CFI is enabled, emit a check that VTable is valid.
1913 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
1914 CFITypeCheckKind TCK, SourceLocation Loc);
1916 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1917 /// RD using llvm.type.test.
1918 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1919 CFITypeCheckKind TCK, SourceLocation Loc);
1921 /// If whole-program virtual table optimization is enabled, emit an assumption
1922 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1923 /// enabled, emit a check that VTable is a member of RD's type identifier.
1924 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1925 llvm::Value *VTable, SourceLocation Loc);
1927 /// Returns whether we should perform a type checked load when loading a
1928 /// virtual function for virtual calls to members of RD. This is generally
1929 /// true when both vcall CFI and whole-program-vtables are enabled.
1930 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1932 /// Emit a type checked load from the given vtable.
1933 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1934 uint64_t VTableByteOffset);
1936 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1937 /// given phase of destruction for a destructor. The end result
1938 /// should call destructors on members and base classes in reverse
1939 /// order of their construction.
1940 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
1942 /// ShouldInstrumentFunction - Return true if the current function should be
1943 /// instrumented with __cyg_profile_func_* calls
1944 bool ShouldInstrumentFunction();
1946 /// ShouldXRayInstrument - Return true if the current function should be
1947 /// instrumented with XRay nop sleds.
1948 bool ShouldXRayInstrumentFunction() const;
1950 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1951 /// XRay custom event handling calls.
1952 bool AlwaysEmitXRayCustomEvents() const;
1954 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
1955 /// XRay typed event handling calls.
1956 bool AlwaysEmitXRayTypedEvents() const;
1958 /// Encode an address into a form suitable for use in a function prologue.
1959 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1960 llvm::Constant *Addr);
1962 /// Decode an address used in a function prologue, encoded by \c
1963 /// EncodeAddrForUseInPrologue.
1964 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1965 llvm::Value *EncodedAddr);
1967 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1968 /// arguments for the given function. This is also responsible for naming the
1969 /// LLVM function arguments.
1970 void EmitFunctionProlog(const CGFunctionInfo &FI,
1972 const FunctionArgList &Args);
1974 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1975 /// given temporary.
1976 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1977 SourceLocation EndLoc);
1979 /// Emit a test that checks if the return value \p RV is nonnull.
1980 void EmitReturnValueCheck(llvm::Value *RV);
1982 /// EmitStartEHSpec - Emit the start of the exception spec.
1983 void EmitStartEHSpec(const Decl *D);
1985 /// EmitEndEHSpec - Emit the end of the exception spec.
1986 void EmitEndEHSpec(const Decl *D);
1988 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1989 llvm::BasicBlock *getTerminateLandingPad();
1991 /// getTerminateLandingPad - Return a cleanup funclet that just calls
1993 llvm::BasicBlock *getTerminateFunclet();
1995 /// getTerminateHandler - Return a handler (not a landing pad, just
1996 /// a catch handler) that just calls terminate. This is used when
1997 /// a terminate scope encloses a try.
1998 llvm::BasicBlock *getTerminateHandler();
2000 llvm::Type *ConvertTypeForMem(QualType T);
2001 llvm::Type *ConvertType(QualType T);
2002 llvm::Type *ConvertType(const TypeDecl *T) {
2003 return ConvertType(getContext().getTypeDeclType(T));
2006 /// LoadObjCSelf - Load the value of self. This function is only valid while
2007 /// generating code for an Objective-C method.
2008 llvm::Value *LoadObjCSelf();
2010 /// TypeOfSelfObject - Return type of object that this self represents.
2011 QualType TypeOfSelfObject();
2013 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
2014 static TypeEvaluationKind getEvaluationKind(QualType T);
2016 static bool hasScalarEvaluationKind(QualType T) {
2017 return getEvaluationKind(T) == TEK_Scalar;
2020 static bool hasAggregateEvaluationKind(QualType T) {
2021 return getEvaluationKind(T) == TEK_Aggregate;
2024 /// createBasicBlock - Create an LLVM basic block.
2025 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
2026 llvm::Function *parent = nullptr,
2027 llvm::BasicBlock *before = nullptr) {
2028 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
2031 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2033 JumpDest getJumpDestForLabel(const LabelDecl *S);
2035 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2036 /// another basic block, simplify it. This assumes that no other code could
2037 /// potentially reference the basic block.
2038 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
2040 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2041 /// adding a fall-through branch from the current insert block if
2042 /// necessary. It is legal to call this function even if there is no current
2043 /// insertion point.
2045 /// IsFinished - If true, indicates that the caller has finished emitting
2046 /// branches to the given block and does not expect to emit code into it. This
2047 /// means the block can be ignored if it is unreachable.
2048 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
2050 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2051 /// near its uses, and leave the insertion point in it.
2052 void EmitBlockAfterUses(llvm::BasicBlock *BB);
2054 /// EmitBranch - Emit a branch to the specified basic block from the current
2055 /// insert block, taking care to avoid creation of branches from dummy
2056 /// blocks. It is legal to call this function even if there is no current
2057 /// insertion point.
2059 /// This function clears the current insertion point. The caller should follow
2060 /// calls to this function with calls to Emit*Block prior to generation new
2062 void EmitBranch(llvm::BasicBlock *Block);
2064 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2065 /// indicates that the current code being emitted is unreachable.
2066 bool HaveInsertPoint() const {
2067 return Builder.GetInsertBlock() != nullptr;
2070 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2071 /// emitted IR has a place to go. Note that by definition, if this function
2072 /// creates a block then that block is unreachable; callers may do better to
2073 /// detect when no insertion point is defined and simply skip IR generation.
2074 void EnsureInsertPoint() {
2075 if (!HaveInsertPoint())
2076 EmitBlock(createBasicBlock());
2079 /// ErrorUnsupported - Print out an error that codegen doesn't support the
2080 /// specified stmt yet.
2081 void ErrorUnsupported(const Stmt *S, const char *Type);
2083 //===--------------------------------------------------------------------===//
2085 //===--------------------------------------------------------------------===//
2087 LValue MakeAddrLValue(Address Addr, QualType T,
2088 AlignmentSource Source = AlignmentSource::Type) {
2089 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
2090 CGM.getTBAAAccessInfo(T));
2093 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
2094 TBAAAccessInfo TBAAInfo) {
2095 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
2098 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
2099 AlignmentSource Source = AlignmentSource::Type) {
2100 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
2101 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
2104 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
2105 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
2106 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
2107 BaseInfo, TBAAInfo);
2110 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
2111 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
2112 CharUnits getNaturalTypeAlignment(QualType T,
2113 LValueBaseInfo *BaseInfo = nullptr,
2114 TBAAAccessInfo *TBAAInfo = nullptr,
2115 bool forPointeeType = false);
2116 CharUnits getNaturalPointeeTypeAlignment(QualType T,
2117 LValueBaseInfo *BaseInfo = nullptr,
2118 TBAAAccessInfo *TBAAInfo = nullptr);
2120 Address EmitLoadOfReference(LValue RefLVal,
2121 LValueBaseInfo *PointeeBaseInfo = nullptr,
2122 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
2123 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
2124 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
2125 AlignmentSource Source =
2126 AlignmentSource::Type) {
2127 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
2128 CGM.getTBAAAccessInfo(RefTy));
2129 return EmitLoadOfReferenceLValue(RefLVal);
2132 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
2133 LValueBaseInfo *BaseInfo = nullptr,
2134 TBAAAccessInfo *TBAAInfo = nullptr);
2135 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2137 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2138 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2139 /// insertion point of the builder. The caller is responsible for setting an
2140 /// appropriate alignment on
2143 /// \p ArraySize is the number of array elements to be allocated if it
2146 /// LangAS::Default is the address space of pointers to local variables and
2147 /// temporaries, as exposed in the source language. In certain
2148 /// configurations, this is not the same as the alloca address space, and a
2149 /// cast is needed to lift the pointer from the alloca AS into
2150 /// LangAS::Default. This can happen when the target uses a restricted
2151 /// address space for the stack but the source language requires
2152 /// LangAS::Default to be a generic address space. The latter condition is
2153 /// common for most programming languages; OpenCL is an exception in that
2154 /// LangAS::Default is the private address space, which naturally maps
2157 /// Because the address of a temporary is often exposed to the program in
2158 /// various ways, this function will perform the cast. The original alloca
2159 /// instruction is returned through \p Alloca if it is not nullptr.
2161 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
2162 /// more efficient if the caller knows that the address will not be exposed.
2163 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2164 llvm::Value *ArraySize = nullptr);
2165 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
2166 const Twine &Name = "tmp",
2167 llvm::Value *ArraySize = nullptr,
2168 Address *Alloca = nullptr);
2169 Address CreateTempAllocaWithoutCast(llvm::Type *Ty, CharUnits align,
2170 const Twine &Name = "tmp",
2171 llvm::Value *ArraySize = nullptr);
2173 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2174 /// default ABI alignment of the given LLVM type.
2176 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2177 /// any given AST type that happens to have been lowered to the
2178 /// given IR type. This should only ever be used for function-local,
2179 /// IR-driven manipulations like saving and restoring a value. Do
2180 /// not hand this address off to arbitrary IRGen routines, and especially
2181 /// do not pass it as an argument to a function that might expect a
2182 /// properly ABI-aligned value.
2183 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2184 const Twine &Name = "tmp");
2186 /// InitTempAlloca - Provide an initial value for the given alloca which
2187 /// will be observable at all locations in the function.
2189 /// The address should be something that was returned from one of
2190 /// the CreateTempAlloca or CreateMemTemp routines, and the
2191 /// initializer must be valid in the entry block (i.e. it must
2192 /// either be a constant or an argument value).
2193 void InitTempAlloca(Address Alloca, llvm::Value *Value);
2195 /// CreateIRTemp - Create a temporary IR object of the given type, with
2196 /// appropriate alignment. This routine should only be used when an temporary
2197 /// value needs to be stored into an alloca (for example, to avoid explicit
2198 /// PHI construction), but the type is the IR type, not the type appropriate
2199 /// for storing in memory.
2201 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2202 /// ConvertType instead of ConvertTypeForMem.
2203 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
2205 /// CreateMemTemp - Create a temporary memory object of the given type, with
2206 /// appropriate alignmen and cast it to the default address space. Returns
2207 /// the original alloca instruction by \p Alloca if it is not nullptr.
2208 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2209 Address *Alloca = nullptr);
2210 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2211 Address *Alloca = nullptr);
2213 /// CreateMemTemp - Create a temporary memory object of the given type, with
2214 /// appropriate alignmen without casting it to the default address space.
2215 Address CreateMemTempWithoutCast(QualType T, const Twine &Name = "tmp");
2216 Address CreateMemTempWithoutCast(QualType T, CharUnits Align,
2217 const Twine &Name = "tmp");
2219 /// CreateAggTemp - Create a temporary memory object for the given
2221 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
2222 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
2224 AggValueSlot::IsNotDestructed,
2225 AggValueSlot::DoesNotNeedGCBarriers,
2226 AggValueSlot::IsNotAliased,
2227 AggValueSlot::DoesNotOverlap);
2230 /// Emit a cast to void* in the appropriate address space.
2231 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2233 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2234 /// expression and compare the result against zero, returning an Int1Ty value.
2235 llvm::Value *EvaluateExprAsBool(const Expr *E);
2237 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2238 void EmitIgnoredExpr(const Expr *E);
2240 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2241 /// any type. The result is returned as an RValue struct. If this is an
2242 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2243 /// the result should be returned.
2245 /// \param ignoreResult True if the resulting value isn't used.
2246 RValue EmitAnyExpr(const Expr *E,
2247 AggValueSlot aggSlot = AggValueSlot::ignored(),
2248 bool ignoreResult = false);
2250 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2251 // or the value of the expression, depending on how va_list is defined.
2252 Address EmitVAListRef(const Expr *E);
2254 /// Emit a "reference" to a __builtin_ms_va_list; this is
2255 /// always the value of the expression, because a __builtin_ms_va_list is a
2256 /// pointer to a char.
2257 Address EmitMSVAListRef(const Expr *E);
2259 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
2260 /// always be accessible even if no aggregate location is provided.
2261 RValue EmitAnyExprToTemp(const Expr *E);
2263 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
2264 /// arbitrary expression into the given memory location.
2265 void EmitAnyExprToMem(const Expr *E, Address Location,
2266 Qualifiers Quals, bool IsInitializer);
2268 void EmitAnyExprToExn(const Expr *E, Address Addr);
2270 /// EmitExprAsInit - Emits the code necessary to initialize a
2271 /// location in memory with the given initializer.
2272 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
2273 bool capturedByInit);
2275 /// hasVolatileMember - returns true if aggregate type has a volatile
2277 bool hasVolatileMember(QualType T) {
2278 if (const RecordType *RT = T->getAs<RecordType>()) {
2279 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2280 return RD->hasVolatileMember();
2285 /// Determine whether a return value slot may overlap some other object.
2286 AggValueSlot::Overlap_t overlapForReturnValue() {
2287 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2288 // class subobjects. These cases may need to be revisited depending on the
2289 // resolution of the relevant core issue.
2290 return AggValueSlot::DoesNotOverlap;
2293 /// Determine whether a field initialization may overlap some other object.
2294 AggValueSlot::Overlap_t overlapForFieldInit(const FieldDecl *FD) {
2295 // FIXME: These cases can result in overlap as a result of P0840R0's
2296 // [[no_unique_address]] attribute. We can still infer NoOverlap in the
2297 // presence of that attribute if the field is within the nvsize of its
2298 // containing class, because non-virtual subobjects are initialized in
2300 return AggValueSlot::DoesNotOverlap;
2303 /// Determine whether a base class initialization may overlap some other
2305 AggValueSlot::Overlap_t overlapForBaseInit(const CXXRecordDecl *RD,
2306 const CXXRecordDecl *BaseRD,
2309 /// Emit an aggregate assignment.
2310 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2311 bool IsVolatile = hasVolatileMember(EltTy);
2312 EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2315 void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2316 AggValueSlot::Overlap_t MayOverlap) {
2317 EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
2320 /// EmitAggregateCopy - Emit an aggregate copy.
2322 /// \param isVolatile \c true iff either the source or the destination is
2324 /// \param MayOverlap Whether the tail padding of the destination might be
2325 /// occupied by some other object. More efficient code can often be
2326 /// generated if not.
2327 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
2328 AggValueSlot::Overlap_t MayOverlap,
2329 bool isVolatile = false);
2331 /// GetAddrOfLocalVar - Return the address of a local variable.
2332 Address GetAddrOfLocalVar(const VarDecl *VD) {
2333 auto it = LocalDeclMap.find(VD);
2334 assert(it != LocalDeclMap.end() &&
2335 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2339 /// Given an opaque value expression, return its LValue mapping if it exists,
2340 /// otherwise create one.
2341 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
2343 /// Given an opaque value expression, return its RValue mapping if it exists,
2344 /// otherwise create one.
2345 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
2347 /// Get the index of the current ArrayInitLoopExpr, if any.
2348 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2350 /// getAccessedFieldNo - Given an encoded value and a result number, return
2351 /// the input field number being accessed.
2352 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2354 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
2355 llvm::BasicBlock *GetIndirectGotoBlock();
2357 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2358 static bool IsWrappedCXXThis(const Expr *E);
2360 /// EmitNullInitialization - Generate code to set a value of the given type to
2361 /// null, If the type contains data member pointers, they will be initialized
2362 /// to -1 in accordance with the Itanium C++ ABI.
2363 void EmitNullInitialization(Address DestPtr, QualType Ty);
2365 /// Emits a call to an LLVM variable-argument intrinsic, either
2366 /// \c llvm.va_start or \c llvm.va_end.
2367 /// \param ArgValue A reference to the \c va_list as emitted by either
2368 /// \c EmitVAListRef or \c EmitMSVAListRef.
2369 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2370 /// calls \c llvm.va_end.
2371 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2373 /// Generate code to get an argument from the passed in pointer
2374 /// and update it accordingly.
2375 /// \param VE The \c VAArgExpr for which to generate code.
2376 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2377 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2378 /// \returns A pointer to the argument.
2379 // FIXME: We should be able to get rid of this method and use the va_arg
2380 // instruction in LLVM instead once it works well enough.
2381 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
2383 /// emitArrayLength - Compute the length of an array, even if it's a
2384 /// VLA, and drill down to the base element type.
2385 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2389 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2390 /// the given variably-modified type and store them in the VLASizeMap.
2392 /// This function can be called with a null (unreachable) insert point.
2393 void EmitVariablyModifiedType(QualType Ty);
2395 struct VlaSizePair {
2396 llvm::Value *NumElts;
2399 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2402 /// Return the number of elements for a single dimension
2403 /// for the given array type.
2404 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2405 VlaSizePair getVLAElements1D(QualType vla);
2407 /// Returns an LLVM value that corresponds to the size,
2408 /// in non-variably-sized elements, of a variable length array type,
2409 /// plus that largest non-variably-sized element type. Assumes that
2410 /// the type has already been emitted with EmitVariablyModifiedType.
2411 VlaSizePair getVLASize(const VariableArrayType *vla);
2412 VlaSizePair getVLASize(QualType vla);
2414 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2415 /// generating code for an C++ member function.
2416 llvm::Value *LoadCXXThis() {
2417 assert(CXXThisValue && "no 'this' value for this function");
2418 return CXXThisValue;
2420 Address LoadCXXThisAddress();
2422 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2424 // FIXME: Every place that calls LoadCXXVTT is something
2425 // that needs to be abstracted properly.
2426 llvm::Value *LoadCXXVTT() {
2427 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2428 return CXXStructorImplicitParamValue;
2431 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
2432 /// complete class to the given direct base.
2434 GetAddressOfDirectBaseInCompleteClass(Address Value,
2435 const CXXRecordDecl *Derived,
2436 const CXXRecordDecl *Base,
2437 bool BaseIsVirtual);
2439 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2441 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2442 /// load of 'this' and returns address of the base class.
2443 Address GetAddressOfBaseClass(Address Value,
2444 const CXXRecordDecl *Derived,
2445 CastExpr::path_const_iterator PathBegin,
2446 CastExpr::path_const_iterator PathEnd,
2447 bool NullCheckValue, SourceLocation Loc);
2449 Address GetAddressOfDerivedClass(Address Value,
2450 const CXXRecordDecl *Derived,
2451 CastExpr::path_const_iterator PathBegin,
2452 CastExpr::path_const_iterator PathEnd,
2453 bool NullCheckValue);
2455 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2456 /// base constructor/destructor with virtual bases.
2457 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2458 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2459 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2462 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2463 CXXCtorType CtorType,
2464 const FunctionArgList &Args,
2465 SourceLocation Loc);
2466 // It's important not to confuse this and the previous function. Delegating
2467 // constructors are the C++0x feature. The constructor delegate optimization
2468 // is used to reduce duplication in the base and complete consturctors where
2469 // they are substantially the same.
2470 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2471 const FunctionArgList &Args);
2473 /// Emit a call to an inheriting constructor (that is, one that invokes a
2474 /// constructor inherited from a base class) by inlining its definition. This
2475 /// is necessary if the ABI does not support forwarding the arguments to the
2476 /// base class constructor (because they're variadic or similar).
2477 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2478 CXXCtorType CtorType,
2479 bool ForVirtualBase,
2483 /// Emit a call to a constructor inherited from a base class, passing the
2484 /// current constructor's arguments along unmodified (without even making
2486 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2487 bool ForVirtualBase, Address This,
2488 bool InheritedFromVBase,
2489 const CXXInheritedCtorInitExpr *E);
2491 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2492 bool ForVirtualBase, bool Delegating,
2493 Address This, const CXXConstructExpr *E,
2494 AggValueSlot::Overlap_t Overlap,
2495 bool NewPointerIsChecked);
2497 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2498 bool ForVirtualBase, bool Delegating,
2499 Address This, CallArgList &Args,
2500 AggValueSlot::Overlap_t Overlap,
2502 bool NewPointerIsChecked);
2504 /// Emit assumption load for all bases. Requires to be be called only on
2505 /// most-derived class and not under construction of the object.
2506 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2508 /// Emit assumption that vptr load == global vtable.
2509 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2511 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
2512 Address This, Address Src,
2513 const CXXConstructExpr *E);
2515 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2516 const ArrayType *ArrayTy,
2518 const CXXConstructExpr *E,
2519 bool NewPointerIsChecked,
2520 bool ZeroInitialization = false);
2522 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2523 llvm::Value *NumElements,
2525 const CXXConstructExpr *E,
2526 bool NewPointerIsChecked,
2527 bool ZeroInitialization = false);
2529 static Destroyer destroyCXXObject;
2531 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
2532 bool ForVirtualBase, bool Delegating,
2535 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
2536 llvm::Type *ElementTy, Address NewPtr,
2537 llvm::Value *NumElements,
2538 llvm::Value *AllocSizeWithoutCookie);
2540 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
2543 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2544 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2546 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
2547 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
2549 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
2550 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2551 CharUnits CookieSize = CharUnits());
2553 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2554 const CallExpr *TheCallExpr, bool IsDelete);
2556 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2557 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2558 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
2560 /// Situations in which we might emit a check for the suitability of a
2561 /// pointer or glvalue.
2562 enum TypeCheckKind {
2563 /// Checking the operand of a load. Must be suitably sized and aligned.
2565 /// Checking the destination of a store. Must be suitably sized and aligned.
2567 /// Checking the bound value in a reference binding. Must be suitably sized
2568 /// and aligned, but is not required to refer to an object (until the
2569 /// reference is used), per core issue 453.
2570 TCK_ReferenceBinding,
2571 /// Checking the object expression in a non-static data member access. Must
2572 /// be an object within its lifetime.
2574 /// Checking the 'this' pointer for a call to a non-static member function.
2575 /// Must be an object within its lifetime.
2577 /// Checking the 'this' pointer for a constructor call.
2578 TCK_ConstructorCall,
2579 /// Checking the operand of a static_cast to a derived pointer type. Must be
2580 /// null or an object within its lifetime.
2581 TCK_DowncastPointer,
2582 /// Checking the operand of a static_cast to a derived reference type. Must
2583 /// be an object within its lifetime.
2584 TCK_DowncastReference,
2585 /// Checking the operand of a cast to a base object. Must be suitably sized
2588 /// Checking the operand of a cast to a virtual base object. Must be an
2589 /// object within its lifetime.
2590 TCK_UpcastToVirtualBase,
2591 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2593 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2594 /// null or an object within its lifetime.
2595 TCK_DynamicOperation
2598 /// Determine whether the pointer type check \p TCK permits null pointers.
2599 static bool isNullPointerAllowed(TypeCheckKind TCK);
2601 /// Determine whether the pointer type check \p TCK requires a vptr check.
2602 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2604 /// Whether any type-checking sanitizers are enabled. If \c false,
2605 /// calls to EmitTypeCheck can be skipped.
2606 bool sanitizePerformTypeCheck() const;
2608 /// Emit a check that \p V is the address of storage of the
2609 /// appropriate size and alignment for an object of type \p Type.
2610 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
2611 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2612 SanitizerSet SkippedChecks = SanitizerSet());
2614 /// Emit a check that \p Base points into an array object, which
2615 /// we can access at index \p Index. \p Accessed should be \c false if we
2616 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2617 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2618 QualType IndexType, bool Accessed);
2620 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2621 bool isInc, bool isPre);
2622 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2623 bool isInc, bool isPre);
2625 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
2626 llvm::Value *OffsetValue = nullptr) {
2627 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2631 /// Converts Location to a DebugLoc, if debug information is enabled.
2632 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2635 //===--------------------------------------------------------------------===//
2636 // Declaration Emission
2637 //===--------------------------------------------------------------------===//
2639 /// EmitDecl - Emit a declaration.
2641 /// This function can be called with a null (unreachable) insert point.
2642 void EmitDecl(const Decl &D);
2644 /// EmitVarDecl - Emit a local variable declaration.
2646 /// This function can be called with a null (unreachable) insert point.
2647 void EmitVarDecl(const VarDecl &D);
2649 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
2650 bool capturedByInit);
2652 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2653 llvm::Value *Address);
2655 /// Determine whether the given initializer is trivial in the sense
2656 /// that it requires no code to be generated.
2657 bool isTrivialInitializer(const Expr *Init);
2659 /// EmitAutoVarDecl - Emit an auto variable declaration.
2661 /// This function can be called with a null (unreachable) insert point.
2662 void EmitAutoVarDecl(const VarDecl &D);
2664 class AutoVarEmission {
2665 friend class CodeGenFunction;
2667 const VarDecl *Variable;
2669 /// The address of the alloca for languages with explicit address space
2670 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
2671 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
2672 /// as a global constant.
2675 llvm::Value *NRVOFlag;
2677 /// True if the variable is a __block variable.
2680 /// True if the variable is of aggregate type and has a constant
2682 bool IsConstantAggregate;
2684 /// Non-null if we should use lifetime annotations.
2685 llvm::Value *SizeForLifetimeMarkers;
2687 /// Address with original alloca instruction. Invalid if the variable was
2688 /// emitted as a global constant.
2692 AutoVarEmission(Invalid)
2693 : Variable(nullptr), Addr(Address::invalid()),
2694 AllocaAddr(Address::invalid()) {}
2696 AutoVarEmission(const VarDecl &variable)
2697 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
2698 IsByRef(false), IsConstantAggregate(false),
2699 SizeForLifetimeMarkers(nullptr), AllocaAddr(Address::invalid()) {}
2701 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
2704 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2706 bool useLifetimeMarkers() const {
2707 return SizeForLifetimeMarkers != nullptr;
2709 llvm::Value *getSizeForLifetimeMarkers() const {
2710 assert(useLifetimeMarkers());
2711 return SizeForLifetimeMarkers;
2714 /// Returns the raw, allocated address, which is not necessarily
2715 /// the address of the object itself. It is casted to default
2716 /// address space for address space agnostic languages.
2717 Address getAllocatedAddress() const {
2721 /// Returns the address for the original alloca instruction.
2722 Address getOriginalAllocatedAddress() const { return AllocaAddr; }
2724 /// Returns the address of the object within this declaration.
2725 /// Note that this does not chase the forwarding pointer for
2727 Address getObjectAddress(CodeGenFunction &CGF) const {
2728 if (!IsByRef) return Addr;
2730 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
2733 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2734 void EmitAutoVarInit(const AutoVarEmission &emission);
2735 void EmitAutoVarCleanups(const AutoVarEmission &emission);
2736 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2737 QualType::DestructionKind dtorKind);
2739 /// Emits the alloca and debug information for the size expressions for each
2740 /// dimension of an array. It registers the association of its (1-dimensional)
2741 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2742 /// reference this node when creating the DISubrange object to describe the
2744 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2746 bool EmitDebugInfo);
2748 void EmitStaticVarDecl(const VarDecl &D,
2749 llvm::GlobalValue::LinkageTypes Linkage);
2754 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2756 static ParamValue forDirect(llvm::Value *value) {
2757 return ParamValue(value, 0);
2759 static ParamValue forIndirect(Address addr) {
2760 assert(!addr.getAlignment().isZero());
2761 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2764 bool isIndirect() const { return Alignment != 0; }
2765 llvm::Value *getAnyValue() const { return Value; }
2767 llvm::Value *getDirectValue() const {
2768 assert(!isIndirect());
2772 Address getIndirectAddress() const {
2773 assert(isIndirect());
2774 return Address(Value, CharUnits::fromQuantity(Alignment));
2778 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
2779 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
2781 /// protectFromPeepholes - Protect a value that we're intending to
2782 /// store to the side, but which will probably be used later, from
2783 /// aggressive peepholing optimizations that might delete it.
2785 /// Pass the result to unprotectFromPeepholes to declare that
2786 /// protection is no longer required.
2788 /// There's no particular reason why this shouldn't apply to
2789 /// l-values, it's just that no existing peepholes work on pointers.
2790 PeepholeProtection protectFromPeepholes(RValue rvalue);
2791 void unprotectFromPeepholes(PeepholeProtection protection);
2793 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2794 llvm::Value *OffsetValue = nullptr) {
2795 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2799 //===--------------------------------------------------------------------===//
2800 // Statement Emission
2801 //===--------------------------------------------------------------------===//
2803 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
2804 void EmitStopPoint(const Stmt *S);
2806 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2807 /// this function even if there is no current insertion point.
2809 /// This function may clear the current insertion point; callers should use
2810 /// EnsureInsertPoint if they wish to subsequently generate code without first
2811 /// calling EmitBlock, EmitBranch, or EmitStmt.
2812 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
2814 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
2815 /// necessarily require an insertion point or debug information; typically
2816 /// because the statement amounts to a jump or a container of other
2819 /// \return True if the statement was handled.
2820 bool EmitSimpleStmt(const Stmt *S);
2822 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2823 AggValueSlot AVS = AggValueSlot::ignored());
2824 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2825 bool GetLast = false,
2827 AggValueSlot::ignored());
2829 /// EmitLabel - Emit the block for the given label. It is legal to call this
2830 /// function even if there is no current insertion point.
2831 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
2833 void EmitLabelStmt(const LabelStmt &S);
2834 void EmitAttributedStmt(const AttributedStmt &S);
2835 void EmitGotoStmt(const GotoStmt &S);
2836 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
2837 void EmitIfStmt(const IfStmt &S);
2839 void EmitWhileStmt(const WhileStmt &S,
2840 ArrayRef<const Attr *> Attrs = None);
2841 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
2842 void EmitForStmt(const ForStmt &S,
2843 ArrayRef<const Attr *> Attrs = None);
2844 void EmitReturnStmt(const ReturnStmt &S);
2845 void EmitDeclStmt(const DeclStmt &S);
2846 void EmitBreakStmt(const BreakStmt &S);
2847 void EmitContinueStmt(const ContinueStmt &S);
2848 void EmitSwitchStmt(const SwitchStmt &S);
2849 void EmitDefaultStmt(const DefaultStmt &S);
2850 void EmitCaseStmt(const CaseStmt &S);
2851 void EmitCaseStmtRange(const CaseStmt &S);
2852 void EmitAsmStmt(const AsmStmt &S);
2854 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
2855 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2856 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
2857 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
2858 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
2860 void EmitCoroutineBody(const CoroutineBodyStmt &S);
2861 void EmitCoreturnStmt(const CoreturnStmt &S);
2862 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2863 AggValueSlot aggSlot = AggValueSlot::ignored(),
2864 bool ignoreResult = false);
2865 LValue EmitCoawaitLValue(const CoawaitExpr *E);
2866 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2867 AggValueSlot aggSlot = AggValueSlot::ignored(),
2868 bool ignoreResult = false);
2869 LValue EmitCoyieldLValue(const CoyieldExpr *E);
2870 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2872 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2873 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2875 void EmitCXXTryStmt(const CXXTryStmt &S);
2876 void EmitSEHTryStmt(const SEHTryStmt &S);
2877 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
2878 void EnterSEHTryStmt(const SEHTryStmt &S);
2879 void ExitSEHTryStmt(const SEHTryStmt &S);
2881 void pushSEHCleanup(CleanupKind kind,
2882 llvm::Function *FinallyFunc);
2883 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
2884 const Stmt *OutlinedStmt);
2886 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2887 const SEHExceptStmt &Except);
2889 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2890 const SEHFinallyStmt &Finally);
2892 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2893 llvm::Value *ParentFP,
2894 llvm::Value *EntryEBP);
2895 llvm::Value *EmitSEHExceptionCode();
2896 llvm::Value *EmitSEHExceptionInfo();
2897 llvm::Value *EmitSEHAbnormalTermination();
2899 /// Emit simple code for OpenMP directives in Simd-only mode.
2900 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2902 /// Scan the outlined statement for captures from the parent function. For
2903 /// each capture, mark the capture as escaped and emit a call to
2904 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
2905 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
2908 /// Recovers the address of a local in a parent function. ParentVar is the
2909 /// address of the variable used in the immediate parent function. It can
2910 /// either be an alloca or a call to llvm.localrecover if there are nested
2911 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2913 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2915 llvm::Value *ParentFP);
2917 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
2918 ArrayRef<const Attr *> Attrs = None);
2920 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2921 class OMPCancelStackRAII {
2922 CodeGenFunction &CGF;
2925 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2928 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2930 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2933 /// Returns calculated size of the specified type.
2934 llvm::Value *getTypeSize(QualType Ty);
2935 LValue InitCapturedStruct(const CapturedStmt &S);
2936 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
2937 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
2938 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
2939 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
2940 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
2941 SmallVectorImpl<llvm::Value *> &CapturedVars);
2942 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2943 SourceLocation Loc);
2944 /// Perform element by element copying of arrays with type \a
2945 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2946 /// generated by \a CopyGen.
2948 /// \param DestAddr Address of the destination array.
2949 /// \param SrcAddr Address of the source array.
2950 /// \param OriginalType Type of destination and source arrays.
2951 /// \param CopyGen Copying procedure that copies value of single array element
2952 /// to another single array element.
2953 void EmitOMPAggregateAssign(
2954 Address DestAddr, Address SrcAddr, QualType OriginalType,
2955 const llvm::function_ref<void(Address, Address)> CopyGen);
2956 /// Emit proper copying of data from one variable to another.
2958 /// \param OriginalType Original type of the copied variables.
2959 /// \param DestAddr Destination address.
2960 /// \param SrcAddr Source address.
2961 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2962 /// type of the base array element).
2963 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2964 /// the base array element).
2965 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2967 void EmitOMPCopy(QualType OriginalType,
2968 Address DestAddr, Address SrcAddr,
2969 const VarDecl *DestVD, const VarDecl *SrcVD,
2971 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2972 /// \a X = \a E \a BO \a E.
2974 /// \param X Value to be updated.
2975 /// \param E Update value.
2976 /// \param BO Binary operation for update operation.
2977 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2978 /// expression, false otherwise.
2979 /// \param AO Atomic ordering of the generated atomic instructions.
2980 /// \param CommonGen Code generator for complex expressions that cannot be
2981 /// expressed through atomicrmw instruction.
2982 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2983 /// generated, <false, RValue::get(nullptr)> otherwise.
2984 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
2985 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2986 llvm::AtomicOrdering AO, SourceLocation Loc,
2987 const llvm::function_ref<RValue(RValue)> CommonGen);
2988 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
2989 OMPPrivateScope &PrivateScope);
2990 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2991 OMPPrivateScope &PrivateScope);
2992 void EmitOMPUseDevicePtrClause(
2993 const OMPClause &C, OMPPrivateScope &PrivateScope,
2994 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
2995 /// Emit code for copyin clause in \a D directive. The next code is
2996 /// generated at the start of outlined functions for directives:
2998 /// threadprivate_var1 = master_threadprivate_var1;
2999 /// operator=(threadprivate_var2, master_threadprivate_var2);
3001 /// __kmpc_barrier(&loc, global_tid);
3004 /// \param D OpenMP directive possibly with 'copyin' clause(s).
3005 /// \returns true if at least one copyin variable is found, false otherwise.
3006 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
3007 /// Emit initial code for lastprivate variables. If some variable is
3008 /// not also firstprivate, then the default initialization is used. Otherwise
3009 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3012 /// \param D Directive that may have 'lastprivate' directives.
3013 /// \param PrivateScope Private scope for capturing lastprivate variables for
3014 /// proper codegen in internal captured statement.
3016 /// \returns true if there is at least one lastprivate variable, false
3018 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
3019 OMPPrivateScope &PrivateScope);
3020 /// Emit final copying of lastprivate values to original variables at
3021 /// the end of the worksharing or simd directive.
3023 /// \param D Directive that has at least one 'lastprivate' directives.
3024 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3025 /// it is the last iteration of the loop code in associated directive, or to
3026 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
3027 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
3029 llvm::Value *IsLastIterCond = nullptr);
3030 /// Emit initial code for linear clauses.
3031 void EmitOMPLinearClause(const OMPLoopDirective &D,
3032 CodeGenFunction::OMPPrivateScope &PrivateScope);
3033 /// Emit final code for linear clauses.
3034 /// \param CondGen Optional conditional code for final part of codegen for
3036 void EmitOMPLinearClauseFinal(
3037 const OMPLoopDirective &D,
3038 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
3039 /// Emit initial code for reduction variables. Creates reduction copies
3040 /// and initializes them with the values according to OpenMP standard.
3042 /// \param D Directive (possibly) with the 'reduction' clause.
3043 /// \param PrivateScope Private scope for capturing reduction variables for
3044 /// proper codegen in internal captured statement.
3046 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
3047 OMPPrivateScope &PrivateScope);
3048 /// Emit final update of reduction values to original variables at
3049 /// the end of the directive.
3051 /// \param D Directive that has at least one 'reduction' directives.
3052 /// \param ReductionKind The kind of reduction to perform.
3053 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
3054 const OpenMPDirectiveKind ReductionKind);
3055 /// Emit initial code for linear variables. Creates private copies
3056 /// and initializes them with the values according to OpenMP standard.
3058 /// \param D Directive (possibly) with the 'linear' clause.
3059 /// \return true if at least one linear variable is found that should be
3060 /// initialized with the value of the original variable, false otherwise.
3061 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
3063 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
3064 llvm::Value * /*OutlinedFn*/,
3065 const OMPTaskDataTy & /*Data*/)>
3067 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
3068 const OpenMPDirectiveKind CapturedRegion,
3069 const RegionCodeGenTy &BodyGen,
3070 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
3071 struct OMPTargetDataInfo {
3072 Address BasePointersArray = Address::invalid();
3073 Address PointersArray = Address::invalid();
3074 Address SizesArray = Address::invalid();
3075 unsigned NumberOfTargetItems = 0;
3076 explicit OMPTargetDataInfo() = default;
3077 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
3078 Address SizesArray, unsigned NumberOfTargetItems)
3079 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
3080 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
3082 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
3083 const RegionCodeGenTy &BodyGen,
3084 OMPTargetDataInfo &InputInfo);
3086 void EmitOMPParallelDirective(const OMPParallelDirective &S);
3087 void EmitOMPSimdDirective(const OMPSimdDirective &S);
3088 void EmitOMPForDirective(const OMPForDirective &S);
3089 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
3090 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
3091 void EmitOMPSectionDirective(const OMPSectionDirective &S);
3092 void EmitOMPSingleDirective(const OMPSingleDirective &S);
3093 void EmitOMPMasterDirective(const OMPMasterDirective &S);
3094 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
3095 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
3096 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
3097 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
3098 void EmitOMPTaskDirective(const OMPTaskDirective &S);
3099 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
3100 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
3101 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
3102 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
3103 void EmitOMPFlushDirective(const OMPFlushDirective &S);
3104 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
3105 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
3106 void EmitOMPTargetDirective(const OMPTargetDirective &S);
3107 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
3108 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
3109 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
3110 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
3111 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
3113 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
3114 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
3116 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
3117 void EmitOMPCancelDirective(const OMPCancelDirective &S);
3118 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
3119 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
3120 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
3121 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
3122 void EmitOMPDistributeParallelForDirective(
3123 const OMPDistributeParallelForDirective &S);
3124 void EmitOMPDistributeParallelForSimdDirective(
3125 const OMPDistributeParallelForSimdDirective &S);
3126 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
3127 void EmitOMPTargetParallelForSimdDirective(
3128 const OMPTargetParallelForSimdDirective &S);
3129 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
3130 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
3132 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
3133 void EmitOMPTeamsDistributeParallelForSimdDirective(
3134 const OMPTeamsDistributeParallelForSimdDirective &S);
3135 void EmitOMPTeamsDistributeParallelForDirective(
3136 const OMPTeamsDistributeParallelForDirective &S);
3137 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
3138 void EmitOMPTargetTeamsDistributeDirective(
3139 const OMPTargetTeamsDistributeDirective &S);
3140 void EmitOMPTargetTeamsDistributeParallelForDirective(
3141 const OMPTargetTeamsDistributeParallelForDirective &S);
3142 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
3143 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
3144 void EmitOMPTargetTeamsDistributeSimdDirective(
3145 const OMPTargetTeamsDistributeSimdDirective &S);
3147 /// Emit device code for the target directive.
3148 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
3149 StringRef ParentName,
3150 const OMPTargetDirective &S);
3152 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3153 const OMPTargetParallelDirective &S);
3154 /// Emit device code for the target parallel for directive.
3155 static void EmitOMPTargetParallelForDeviceFunction(
3156 CodeGenModule &CGM, StringRef ParentName,
3157 const OMPTargetParallelForDirective &S);
3158 /// Emit device code for the target parallel for simd directive.
3159 static void EmitOMPTargetParallelForSimdDeviceFunction(
3160 CodeGenModule &CGM, StringRef ParentName,
3161 const OMPTargetParallelForSimdDirective &S);
3162 /// Emit device code for the target teams directive.
3164 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3165 const OMPTargetTeamsDirective &S);
3166 /// Emit device code for the target teams distribute directive.
3167 static void EmitOMPTargetTeamsDistributeDeviceFunction(
3168 CodeGenModule &CGM, StringRef ParentName,
3169 const OMPTargetTeamsDistributeDirective &S);
3170 /// Emit device code for the target teams distribute simd directive.
3171 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3172 CodeGenModule &CGM, StringRef ParentName,
3173 const OMPTargetTeamsDistributeSimdDirective &S);
3174 /// Emit device code for the target simd directive.
3175 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3176 StringRef ParentName,
3177 const OMPTargetSimdDirective &S);
3178 /// Emit device code for the target teams distribute parallel for simd
3180 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3181 CodeGenModule &CGM, StringRef ParentName,
3182 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
3184 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3185 CodeGenModule &CGM, StringRef ParentName,
3186 const OMPTargetTeamsDistributeParallelForDirective &S);
3187 /// Emit inner loop of the worksharing/simd construct.
3189 /// \param S Directive, for which the inner loop must be emitted.
3190 /// \param RequiresCleanup true, if directive has some associated private
3192 /// \param LoopCond Bollean condition for loop continuation.
3193 /// \param IncExpr Increment expression for loop control variable.
3194 /// \param BodyGen Generator for the inner body of the inner loop.
3195 /// \param PostIncGen Genrator for post-increment code (required for ordered
3196 /// loop directvies).
3197 void EmitOMPInnerLoop(
3198 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3199 const Expr *IncExpr,
3200 const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3201 const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
3203 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
3204 /// Emit initial code for loop counters of loop-based directives.
3205 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3206 OMPPrivateScope &LoopScope);
3208 /// Helper for the OpenMP loop directives.
3209 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3211 /// Emit code for the worksharing loop-based directive.
3212 /// \return true, if this construct has any lastprivate clause, false -
3214 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3215 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3216 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3218 /// Emit code for the distribute loop-based directive.
3219 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3220 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3222 /// Helpers for the OpenMP loop directives.
3223 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3224 void EmitOMPSimdFinal(
3225 const OMPLoopDirective &D,
3226 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
3228 /// Emits the lvalue for the expression with possibly captured variable.
3229 LValue EmitOMPSharedLValue(const Expr *E);
3232 /// Helpers for blocks.
3233 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
3235 /// struct with the values to be passed to the OpenMP loop-related functions
3236 struct OMPLoopArguments {
3237 /// loop lower bound
3238 Address LB = Address::invalid();
3239 /// loop upper bound
3240 Address UB = Address::invalid();
3242 Address ST = Address::invalid();
3243 /// isLastIteration argument for runtime functions
3244 Address IL = Address::invalid();
3245 /// Chunk value generated by sema
3246 llvm::Value *Chunk = nullptr;
3247 /// EnsureUpperBound
3248 Expr *EUB = nullptr;
3249 /// IncrementExpression
3250 Expr *IncExpr = nullptr;
3251 /// Loop initialization
3252 Expr *Init = nullptr;
3253 /// Loop exit condition
3254 Expr *Cond = nullptr;
3255 /// Update of LB after a whole chunk has been executed
3256 Expr *NextLB = nullptr;
3257 /// Update of UB after a whole chunk has been executed
3258 Expr *NextUB = nullptr;
3259 OMPLoopArguments() = default;
3260 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3261 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3262 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3263 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3264 Expr *NextUB = nullptr)
3265 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3266 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3269 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3270 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3271 const OMPLoopArguments &LoopArgs,
3272 const CodeGenLoopTy &CodeGenLoop,
3273 const CodeGenOrderedTy &CodeGenOrdered);
3274 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
3275 bool IsMonotonic, const OMPLoopDirective &S,
3276 OMPPrivateScope &LoopScope, bool Ordered,
3277 const OMPLoopArguments &LoopArgs,
3278 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3279 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3280 const OMPLoopDirective &S,
3281 OMPPrivateScope &LoopScope,
3282 const OMPLoopArguments &LoopArgs,
3283 const CodeGenLoopTy &CodeGenLoopContent);
3284 /// Emit code for sections directive.
3285 void EmitSections(const OMPExecutableDirective &S);
3289 //===--------------------------------------------------------------------===//
3290 // LValue Expression Emission
3291 //===--------------------------------------------------------------------===//
3293 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3294 RValue GetUndefRValue(QualType Ty);
3296 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3297 /// and issue an ErrorUnsupported style diagnostic (using the
3299 RValue EmitUnsupportedRValue(const Expr *E,
3302 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3303 /// an ErrorUnsupported style diagnostic (using the provided Name).
3304 LValue EmitUnsupportedLValue(const Expr *E,
3307 /// EmitLValue - Emit code to compute a designator that specifies the location
3308 /// of the expression.
3310 /// This can return one of two things: a simple address or a bitfield
3311 /// reference. In either case, the LLVM Value* in the LValue structure is
3312 /// guaranteed to be an LLVM pointer type.
3314 /// If this returns a bitfield reference, nothing about the pointee type of
3315 /// the LLVM value is known: For example, it may not be a pointer to an
3318 /// If this returns a normal address, and if the lvalue's C type is fixed
3319 /// size, this method guarantees that the returned pointer type will point to
3320 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3321 /// variable length type, this is not possible.
3323 LValue EmitLValue(const Expr *E);
3325 /// Same as EmitLValue but additionally we generate checking code to
3326 /// guard against undefined behavior. This is only suitable when we know
3327 /// that the address will be used to access the object.
3328 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
3330 RValue convertTempToRValue(Address addr, QualType type,
3331 SourceLocation Loc);
3333 void EmitAtomicInit(Expr *E, LValue lvalue);
3335 bool LValueIsSuitableForInlineAtomic(LValue Src);
3337 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3338 AggValueSlot Slot = AggValueSlot::ignored());
3340 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
3341 llvm::AtomicOrdering AO, bool IsVolatile = false,
3342 AggValueSlot slot = AggValueSlot::ignored());
3344 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3346 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3347 bool IsVolatile, bool isInit);
3349 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
3350 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
3351 llvm::AtomicOrdering Success =
3352 llvm::AtomicOrdering::SequentiallyConsistent,
3353 llvm::AtomicOrdering Failure =
3354 llvm::AtomicOrdering::SequentiallyConsistent,
3355 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3357 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
3358 const llvm::function_ref<RValue(RValue)> &UpdateOp,
3361 /// EmitToMemory - Change a scalar value from its value
3362 /// representation to its in-memory representation.
3363 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3365 /// EmitFromMemory - Change a scalar value from its memory
3366 /// representation to its value representation.
3367 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3369 /// Check if the scalar \p Value is within the valid range for the given
3372 /// Returns true if a check is needed (even if the range is unknown).
3373 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3374 SourceLocation Loc);
3376 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3377 /// care to appropriately convert from the memory representation to
3378 /// the LLVM value representation.
3379 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3381 AlignmentSource Source = AlignmentSource::Type,
3382 bool isNontemporal = false) {
3383 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
3384 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3387 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3388 SourceLocation Loc, LValueBaseInfo BaseInfo,
3389 TBAAAccessInfo TBAAInfo,
3390 bool isNontemporal = false);
3392 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3393 /// care to appropriately convert from the memory representation to
3394 /// the LLVM value representation. The l-value must be a simple
3396 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
3398 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3399 /// care to appropriately convert from the memory representation to
3400 /// the LLVM value representation.
3401 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3402 bool Volatile, QualType Ty,
3403 AlignmentSource Source = AlignmentSource::Type,
3404 bool isInit = false, bool isNontemporal = false) {
3405 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
3406 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3409 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3410 bool Volatile, QualType Ty,
3411 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
3412 bool isInit = false, bool isNontemporal = false);
3414 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3415 /// care to appropriately convert from the memory representation to
3416 /// the LLVM value representation. The l-value must be a simple
3417 /// l-value. The isInit flag indicates whether this is an initialization.
3418 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3419 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
3421 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3422 /// this method emits the address of the lvalue, then loads the result as an
3423 /// rvalue, returning the rvalue.
3424 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
3425 RValue EmitLoadOfExtVectorElementLValue(LValue V);
3426 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
3427 RValue EmitLoadOfGlobalRegLValue(LValue LV);
3429 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3430 /// lvalue, where both are guaranteed to the have the same type, and that type
3432 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
3433 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
3434 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
3436 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3437 /// as EmitStoreThroughLValue.
3439 /// \param Result [out] - If non-null, this will be set to a Value* for the
3440 /// bit-field contents after the store, appropriate for use as the result of
3441 /// an assignment to the bit-field.
3442 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
3443 llvm::Value **Result=nullptr);
3445 /// Emit an l-value for an assignment (simple or compound) of complex type.
3446 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
3447 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
3448 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3449 llvm::Value *&Result);
3451 // Note: only available for agg return types
3452 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
3453 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
3454 // Note: only available for agg return types
3455 LValue EmitCallExprLValue(const CallExpr *E);
3456 // Note: only available for agg return types
3457 LValue EmitVAArgExprLValue(const VAArgExpr *E);
3458 LValue EmitDeclRefLValue(const DeclRefExpr *E);
3459 LValue EmitStringLiteralLValue(const StringLiteral *E);
3460 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
3461 LValue EmitPredefinedLValue(const PredefinedExpr *E);
3462 LValue EmitUnaryOpLValue(const UnaryOperator *E);
3463 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3464 bool Accessed = false);
3465 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3466 bool IsLowerBound = true);
3467 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
3468 LValue EmitMemberExpr(const MemberExpr *E);
3469 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
3470 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
3471 LValue EmitInitListLValue(const InitListExpr *E);
3472 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
3473 LValue EmitCastLValue(const CastExpr *E);
3474 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
3475 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
3477 Address EmitExtVectorElementLValue(LValue V);
3479 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
3481 Address EmitArrayToPointerDecay(const Expr *Array,
3482 LValueBaseInfo *BaseInfo = nullptr,
3483 TBAAAccessInfo *TBAAInfo = nullptr);
3485 class ConstantEmission {
3486 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3487 ConstantEmission(llvm::Constant *C, bool isReference)
3488 : ValueAndIsReference(C, isReference) {}
3490 ConstantEmission() {}
3491 static ConstantEmission forReference(llvm::Constant *C) {
3492 return ConstantEmission(C, true);
3494 static ConstantEmission forValue(llvm::Constant *C) {
3495 return ConstantEmission(C, false);
3498 explicit operator bool() const {
3499 return ValueAndIsReference.getOpaqueValue() != nullptr;
3502 bool isReference() const { return ValueAndIsReference.getInt(); }
3503 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3504 assert(isReference());
3505 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3506 refExpr->getType());
3509 llvm::Constant *getValue() const {
3510 assert(!isReference());
3511 return ValueAndIsReference.getPointer();
3515 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
3516 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
3518 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3519 AggValueSlot slot = AggValueSlot::ignored());
3520 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3522 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
3523 const ObjCIvarDecl *Ivar);
3524 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
3525 LValue EmitLValueForLambdaField(const FieldDecl *Field);
3527 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3528 /// if the Field is a reference, this will return the address of the reference
3529 /// and not the address of the value stored in the reference.
3530 LValue EmitLValueForFieldInitialization(LValue Base,
3531 const FieldDecl* Field);
3533 LValue EmitLValueForIvar(QualType ObjectTy,
3534 llvm::Value* Base, const ObjCIvarDecl *Ivar,
3535 unsigned CVRQualifiers);
3537 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
3538 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
3539 LValue EmitLambdaLValue(const LambdaExpr *E);
3540 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
3541 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
3543 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
3544 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
3545 LValue EmitStmtExprLValue(const StmtExpr *E);
3546 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
3547 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
3548 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
3550 //===--------------------------------------------------------------------===//
3551 // Scalar Expression Emission
3552 //===--------------------------------------------------------------------===//
3554 /// EmitCall - Generate a call of the given function, expecting the given
3555 /// result type, and using the given argument list which specifies both the
3556 /// LLVM arguments and the types they were derived from.
3557 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3558 ReturnValueSlot ReturnValue, const CallArgList &Args,
3559 llvm::Instruction **callOrInvoke, SourceLocation Loc);
3560 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3561 ReturnValueSlot ReturnValue, const CallArgList &Args,
3562 llvm::Instruction **callOrInvoke = nullptr) {
3563 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3566 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
3567 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
3568 RValue EmitCallExpr(const CallExpr *E,
3569 ReturnValueSlot ReturnValue = ReturnValueSlot());
3570 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3571 CGCallee EmitCallee(const Expr *E);
3573 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
3575 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3576 const Twine &name = "");
3577 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3578 ArrayRef<llvm::Value*> args,
3579 const Twine &name = "");
3580 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3581 const Twine &name = "");
3582 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3583 ArrayRef<llvm::Value*> args,
3584 const Twine &name = "");
3586 SmallVector<llvm::OperandBundleDef, 1>
3587 getBundlesForFunclet(llvm::Value *Callee);
3589 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
3590 ArrayRef<llvm::Value *> Args,
3591 const Twine &Name = "");
3592 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3593 ArrayRef<llvm::Value*> args,
3594 const Twine &name = "");
3595 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3596 const Twine &name = "");
3597 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3598 ArrayRef<llvm::Value*> args);
3600 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3601 NestedNameSpecifier *Qual,
3604 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3606 const CXXRecordDecl *RD);
3608 // These functions emit calls to the special functions of non-trivial C
3610 void defaultInitNonTrivialCStructVar(LValue Dst);
3611 void callCStructDefaultConstructor(LValue Dst);
3612 void callCStructDestructor(LValue Dst);
3613 void callCStructCopyConstructor(LValue Dst, LValue Src);
3614 void callCStructMoveConstructor(LValue Dst, LValue Src);
3615 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3616 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3619 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3620 const CGCallee &Callee,
3621 ReturnValueSlot ReturnValue, llvm::Value *This,
3622 llvm::Value *ImplicitParam,
3623 QualType ImplicitParamTy, const CallExpr *E,
3624 CallArgList *RtlArgs);
3625 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3626 const CGCallee &Callee,
3627 llvm::Value *This, llvm::Value *ImplicitParam,
3628 QualType ImplicitParamTy, const CallExpr *E,
3630 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3631 ReturnValueSlot ReturnValue);
3632 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3633 const CXXMethodDecl *MD,
3634 ReturnValueSlot ReturnValue,
3636 NestedNameSpecifier *Qualifier,
3637 bool IsArrow, const Expr *Base);
3638 // Compute the object pointer.
3639 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3640 llvm::Value *memberPtr,
3641 const MemberPointerType *memberPtrType,
3642 LValueBaseInfo *BaseInfo = nullptr,
3643 TBAAAccessInfo *TBAAInfo = nullptr);
3644 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3645 ReturnValueSlot ReturnValue);
3647 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
3648 const CXXMethodDecl *MD,
3649 ReturnValueSlot ReturnValue);
3650 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
3652 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3653 ReturnValueSlot ReturnValue);
3655 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3656 ReturnValueSlot ReturnValue);
3658 RValue EmitBuiltinExpr(const FunctionDecl *FD,
3659 unsigned BuiltinID, const CallExpr *E,
3660 ReturnValueSlot ReturnValue);
3662 /// Emit IR for __builtin_os_log_format.
3663 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3665 llvm::Function *generateBuiltinOSLogHelperFunction(
3666 const analyze_os_log::OSLogBufferLayout &Layout,
3667 CharUnits BufferAlignment);
3669 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3671 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3672 /// is unhandled by the current target.
3673 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3675 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3676 const llvm::CmpInst::Predicate Fp,
3677 const llvm::CmpInst::Predicate Ip,
3678 const llvm::Twine &Name = "");
3679 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3680 llvm::Triple::ArchType Arch);
3682 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3683 unsigned LLVMIntrinsic,
3684 unsigned AltLLVMIntrinsic,
3685 const char *NameHint,
3688 SmallVectorImpl<llvm::Value *> &Ops,
3689 Address PtrOp0, Address PtrOp1,
3690 llvm::Triple::ArchType Arch);
3692 llvm::Value *EmitISOVolatileLoad(const CallExpr *E);
3693 llvm::Value *EmitISOVolatileStore(const CallExpr *E);
3695 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3696 unsigned Modifier, llvm::Type *ArgTy,
3698 llvm::Value *EmitNeonCall(llvm::Function *F,
3699 SmallVectorImpl<llvm::Value*> &O,
3701 unsigned shift = 0, bool rightshift = false);
3702 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
3703 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
3704 bool negateForRightShift);
3705 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3706 llvm::Type *Ty, bool usgn, const char *name);
3707 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
3708 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3709 llvm::Triple::ArchType Arch);
3711 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
3712 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3713 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3714 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3715 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3716 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3717 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3719 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3722 enum class MSVCIntrin;
3725 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3727 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3729 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
3730 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
3731 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
3732 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3733 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3734 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
3735 const ObjCMethodDecl *MethodWithObjects);
3736 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
3737 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3738 ReturnValueSlot Return = ReturnValueSlot());
3740 /// Retrieves the default cleanup kind for an ARC cleanup.
3741 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3742 CleanupKind getARCCleanupKind() {
3743 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3744 ? NormalAndEHCleanup : NormalCleanup;
3748 void EmitARCInitWeak(Address addr, llvm::Value *value);
3749 void EmitARCDestroyWeak(Address addr);
3750 llvm::Value *EmitARCLoadWeak(Address addr);
3751 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3752 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3753 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3754 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3755 void EmitARCCopyWeak(Address dst, Address src);
3756 void EmitARCMoveWeak(Address dst, Address src);
3757 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3758 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
3759 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
3760 bool resultIgnored);
3761 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
3762 bool resultIgnored);
3763 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
3764 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
3765 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
3766 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
3767 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
3768 llvm::Value *EmitARCAutorelease(llvm::Value *value);
3769 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3770 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3771 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
3772 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
3774 std::pair<LValue,llvm::Value*>
3775 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3776 std::pair<LValue,llvm::Value*>
3777 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
3778 std::pair<LValue,llvm::Value*>
3779 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
3781 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
3782 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3783 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3785 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
3786 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3787 bool allowUnsafeClaim);
3788 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3789 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
3790 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
3792 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
3794 static Destroyer destroyARCStrongImprecise;
3795 static Destroyer destroyARCStrongPrecise;
3796 static Destroyer destroyARCWeak;
3797 static Destroyer emitARCIntrinsicUse;
3798 static Destroyer destroyNonTrivialCStruct;
3800 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3801 llvm::Value *EmitObjCAutoreleasePoolPush();
3802 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3803 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3804 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3806 /// Emits a reference binding to the passed in expression.
3807 RValue EmitReferenceBindingToExpr(const Expr *E);
3809 //===--------------------------------------------------------------------===//
3810 // Expression Emission
3811 //===--------------------------------------------------------------------===//
3813 // Expressions are broken into three classes: scalar, complex, aggregate.
3815 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3816 /// scalar type, returning the result.
3817 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
3819 /// Emit a conversion from the specified type to the specified destination
3820 /// type, both of which are LLVM scalar types.
3821 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
3822 QualType DstTy, SourceLocation Loc);
3824 /// Emit a conversion from the specified complex type to the specified
3825 /// destination type, where the destination type is an LLVM scalar type.
3826 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
3828 SourceLocation Loc);
3830 /// EmitAggExpr - Emit the computation of the specified expression
3831 /// of aggregate type. The result is computed into the given slot,
3832 /// which may be null to indicate that the value is not needed.
3833 void EmitAggExpr(const Expr *E, AggValueSlot AS);
3835 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3836 /// aggregate type into a temporary LValue.
3837 LValue EmitAggExprToLValue(const Expr *E);
3839 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3840 /// make sure it survives garbage collection until this point.
3841 void EmitExtendGCLifetime(llvm::Value *object);
3843 /// EmitComplexExpr - Emit the computation of the specified expression of
3844 /// complex type, returning the result.
3845 ComplexPairTy EmitComplexExpr(const Expr *E,
3846 bool IgnoreReal = false,
3847 bool IgnoreImag = false);
3849 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3850 /// type and place its result into the specified l-value.
3851 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
3853 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
3854 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
3856 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
3857 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
3859 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3860 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3862 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3863 /// global variable that has already been created for it. If the initializer
3864 /// has a different type than GV does, this may free GV and return a different
3865 /// one. Otherwise it just returns GV.
3866 llvm::GlobalVariable *
3867 AddInitializerToStaticVarDecl(const VarDecl &D,
3868 llvm::GlobalVariable *GV);
3871 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3872 /// variable with global storage.
3873 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3876 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3877 llvm::Constant *Addr);
3879 /// Call atexit() with a function that passes the given argument to
3880 /// the given function.
3881 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3882 llvm::Constant *addr);
3884 /// Call atexit() with function dtorStub.
3885 void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
3887 /// Emit code in this function to perform a guarded variable
3888 /// initialization. Guarded initializations are used when it's not
3889 /// possible to prove that an initialization will be done exactly
3890 /// once, e.g. with a static local variable or a static data member
3891 /// of a class template.
3892 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
3895 enum class GuardKind { VariableGuard, TlsGuard };
3897 /// Emit a branch to select whether or not to perform guarded initialization.
3898 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3899 llvm::BasicBlock *InitBlock,
3900 llvm::BasicBlock *NoInitBlock,
3901 GuardKind Kind, const VarDecl *D);
3903 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3905 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
3906 ArrayRef<llvm::Function *> CXXThreadLocals,
3907 Address Guard = Address::invalid());
3909 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
3911 void GenerateCXXGlobalDtorsFunc(
3913 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3916 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3918 llvm::GlobalVariable *Addr,
3921 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
3923 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
3925 void enterFullExpression(const ExprWithCleanups *E) {
3926 if (E->getNumObjects() == 0) return;
3927 enterNonTrivialFullExpression(E);
3929 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
3931 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
3933 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3935 RValue EmitAtomicExpr(AtomicExpr *E);
3937 //===--------------------------------------------------------------------===//
3938 // Annotations Emission
3939 //===--------------------------------------------------------------------===//
3941 /// Emit an annotation call (intrinsic or builtin).
3942 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3943 llvm::Value *AnnotatedVal,
3944 StringRef AnnotationStr,
3945 SourceLocation Location);
3947 /// Emit local annotations for the local variable V, declared by D.
3948 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3950 /// Emit field annotations for the given field & value. Returns the
3951 /// annotation result.
3952 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
3954 //===--------------------------------------------------------------------===//
3956 //===--------------------------------------------------------------------===//
3958 /// ContainsLabel - Return true if the statement contains a label in it. If
3959 /// this statement is not executed normally, it not containing a label means
3960 /// that we can just remove the code.
3961 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
3963 /// containsBreak - Return true if the statement contains a break out of it.
3964 /// If the statement (recursively) contains a switch or loop with a break
3965 /// inside of it, this is fine.
3966 static bool containsBreak(const Stmt *S);
3968 /// Determine if the given statement might introduce a declaration into the
3969 /// current scope, by being a (possibly-labelled) DeclStmt.
3970 static bool mightAddDeclToScope(const Stmt *S);
3972 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3973 /// to a constant, or if it does but contains a label, return false. If it
3974 /// constant folds return true and set the boolean result in Result.
3975 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3976 bool AllowLabels = false);
3978 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3979 /// to a constant, or if it does but contains a label, return false. If it
3980 /// constant folds return true and set the folded value.
3981 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3982 bool AllowLabels = false);
3984 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3985 /// if statement) to the specified blocks. Based on the condition, this might
3986 /// try to simplify the codegen of the conditional based on the branch.
3987 /// TrueCount should be the number of times we expect the condition to
3988 /// evaluate to true based on PGO data.
3989 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
3990 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
3992 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3993 /// nonnull, if \p LHS is marked _Nonnull.
3994 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3996 /// An enumeration which makes it easier to specify whether or not an
3997 /// operation is a subtraction.
3998 enum { NotSubtraction = false, IsSubtraction = true };
4000 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
4001 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
4002 /// \p SignedIndices indicates whether any of the GEP indices are signed.
4003 /// \p IsSubtraction indicates whether the expression used to form the GEP
4004 /// is a subtraction.
4005 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
4006 ArrayRef<llvm::Value *> IdxList,
4010 const Twine &Name = "");
4012 /// Specifies which type of sanitizer check to apply when handling a
4013 /// particular builtin.
4014 enum BuiltinCheckKind {
4019 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
4020 /// enabled, a runtime check specified by \p Kind is also emitted.
4021 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
4023 /// Emit a description of a type in a format suitable for passing to
4024 /// a runtime sanitizer handler.
4025 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
4027 /// Convert a value into a format suitable for passing to a runtime
4028 /// sanitizer handler.
4029 llvm::Value *EmitCheckValue(llvm::Value *V);
4031 /// Emit a description of a source location in a format suitable for
4032 /// passing to a runtime sanitizer handler.
4033 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
4035 /// Create a basic block that will call a handler function in a
4036 /// sanitizer runtime with the provided arguments, and create a conditional
4038 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
4039 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
4040 ArrayRef<llvm::Value *> DynamicArgs);
4042 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
4043 /// if Cond if false.
4044 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
4045 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
4046 ArrayRef<llvm::Constant *> StaticArgs);
4048 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
4049 /// checking is enabled. Otherwise, just emit an unreachable instruction.
4050 void EmitUnreachable(SourceLocation Loc);
4052 /// Create a basic block that will call the trap intrinsic, and emit a
4053 /// conditional branch to it, for the -ftrapv checks.
4054 void EmitTrapCheck(llvm::Value *Checked);
4056 /// Emit a call to trap or debugtrap and attach function attribute
4057 /// "trap-func-name" if specified.
4058 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
4060 /// Emit a stub for the cross-DSO CFI check function.
4061 void EmitCfiCheckStub();
4063 /// Emit a cross-DSO CFI failure handling function.
4064 void EmitCfiCheckFail();
4066 /// Create a check for a function parameter that may potentially be
4067 /// declared as non-null.
4068 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
4069 AbstractCallee AC, unsigned ParmNum);
4071 /// EmitCallArg - Emit a single call argument.
4072 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
4074 /// EmitDelegateCallArg - We are performing a delegate call; that
4075 /// is, the current function is delegating to another one. Produce
4076 /// a r-value suitable for passing the given parameter.
4077 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
4078 SourceLocation loc);
4080 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
4081 /// point operation, expressed as the maximum relative error in ulp.
4082 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
4085 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
4086 void EmitReturnOfRValue(RValue RV, QualType Ty);
4088 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
4090 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
4091 DeferredReplacements;
4093 /// Set the address of a local variable.
4094 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
4095 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
4096 LocalDeclMap.insert({VD, Addr});
4099 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
4100 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
4102 /// \param AI - The first function argument of the expansion.
4103 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
4104 SmallVectorImpl<llvm::Value *>::iterator &AI);
4106 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
4107 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
4108 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
4109 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
4110 SmallVectorImpl<llvm::Value *> &IRCallArgs,
4111 unsigned &IRCallArgPos);
4113 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
4114 const Expr *InputExpr, std::string &ConstraintStr);
4116 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
4117 LValue InputValue, QualType InputType,
4118 std::string &ConstraintStr,
4119 SourceLocation Loc);
4121 /// Attempts to statically evaluate the object size of E. If that
4122 /// fails, emits code to figure the size of E out for us. This is
4123 /// pass_object_size aware.
4125 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
4126 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
4127 llvm::IntegerType *ResType,
4128 llvm::Value *EmittedE);
4130 /// Emits the size of E, as required by __builtin_object_size. This
4131 /// function is aware of pass_object_size parameters, and will act accordingly
4132 /// if E is a parameter with the pass_object_size attribute.
4133 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
4134 llvm::IntegerType *ResType,
4135 llvm::Value *EmittedE);
4139 // Determine whether the given argument is an Objective-C method
4140 // that may have type parameters in its signature.
4141 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
4142 const DeclContext *dc = method->getDeclContext();
4143 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
4144 return classDecl->getTypeParamListAsWritten();
4147 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
4148 return catDecl->getTypeParamList();
4154 template<typename T>
4155 static bool isObjCMethodWithTypeParams(const T *) { return false; }
4158 enum class EvaluationOrder {
4159 ///! No language constraints on evaluation order.
4161 ///! Language semantics require left-to-right evaluation.
4163 ///! Language semantics require right-to-left evaluation.
4167 /// EmitCallArgs - Emit call arguments for a function.
4168 template <typename T>
4169 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
4170 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
4171 AbstractCallee AC = AbstractCallee(),
4172 unsigned ParamsToSkip = 0,
4173 EvaluationOrder Order = EvaluationOrder::Default) {
4174 SmallVector<QualType, 16> ArgTypes;
4175 CallExpr::const_arg_iterator Arg = ArgRange.begin();
4177 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4178 "Can't skip parameters if type info is not provided");
4179 if (CallArgTypeInfo) {
4181 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4184 // First, use the argument types that the type info knows about
4185 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4186 E = CallArgTypeInfo->param_type_end();
4187 I != E; ++I, ++Arg) {
4188 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
4189 assert((isGenericMethod ||
4190 ((*I)->isVariablyModifiedType() ||
4191 (*I).getNonReferenceType()->isObjCRetainableType() ||
4193 .getCanonicalType((*I).getNonReferenceType())
4196 .getCanonicalType((*Arg)->getType())
4198 "type mismatch in call argument!");
4199 ArgTypes.push_back(*I);
4203 // Either we've emitted all the call args, or we have a call to variadic
4205 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4206 CallArgTypeInfo->isVariadic()) &&
4207 "Extra arguments in non-variadic function!");
4209 // If we still have any arguments, emit them using the type of the argument.
4210 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
4211 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
4213 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
4216 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
4217 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
4218 AbstractCallee AC = AbstractCallee(),
4219 unsigned ParamsToSkip = 0,
4220 EvaluationOrder Order = EvaluationOrder::Default);
4222 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4223 /// emit the value and compute our best estimate of the alignment of the
4226 /// \param BaseInfo - If non-null, this will be initialized with
4227 /// information about the source of the alignment and the may-alias
4228 /// attribute. Note that this function will conservatively fall back on
4229 /// the type when it doesn't recognize the expression and may-alias will
4230 /// be set to false.
4232 /// One reasonable way to use this information is when there's a language
4233 /// guarantee that the pointer must be aligned to some stricter value, and
4234 /// we're simply trying to ensure that sufficiently obvious uses of under-
4235 /// aligned objects don't get miscompiled; for example, a placement new
4236 /// into the address of a local variable. In such a case, it's quite
4237 /// reasonable to just ignore the returned alignment when it isn't from an
4238 /// explicit source.
4239 Address EmitPointerWithAlignment(const Expr *Addr,
4240 LValueBaseInfo *BaseInfo = nullptr,
4241 TBAAAccessInfo *TBAAInfo = nullptr);
4243 /// If \p E references a parameter with pass_object_size info or a constant
4244 /// array size modifier, emit the object size divided by the size of \p EltTy.
4245 /// Otherwise return null.
4246 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4248 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4250 struct MultiVersionResolverOption {
4251 llvm::Function *Function;
4253 StringRef Architecture;
4254 llvm::SmallVector<StringRef, 8> Features;
4256 Conds(StringRef Arch, ArrayRef<StringRef> Feats)
4257 : Architecture(Arch), Features(Feats.begin(), Feats.end()) {}
4260 MultiVersionResolverOption(llvm::Function *F, StringRef Arch,
4261 ArrayRef<StringRef> Feats)
4262 : Function(F), Conditions(Arch, Feats) {}
4265 // Emits the body of a multiversion function's resolver. Assumes that the
4266 // options are already sorted in the proper order, with the 'default' option
4267 // last (if it exists).
4268 void EmitMultiVersionResolver(llvm::Function *Resolver,
4269 ArrayRef<MultiVersionResolverOption> Options);
4271 struct CPUDispatchMultiVersionResolverOption {
4272 llvm::Function *Function;
4273 // Note: EmitX86CPUSupports only has 32 bits available, so we store the mask
4274 // as 32 bits here. When 64-bit support is added to __builtin_cpu_supports,
4275 // this can be extended to 64 bits.
4276 uint32_t FeatureMask;
4277 CPUDispatchMultiVersionResolverOption(llvm::Function *F, uint64_t Mask)
4278 : Function(F), FeatureMask(static_cast<uint32_t>(Mask)) {}
4279 bool operator>(const CPUDispatchMultiVersionResolverOption &Other) const {
4280 return FeatureMask > Other.FeatureMask;
4283 void EmitCPUDispatchMultiVersionResolver(
4284 llvm::Function *Resolver,
4285 ArrayRef<CPUDispatchMultiVersionResolverOption> Options);
4286 static uint32_t GetX86CpuSupportsMask(ArrayRef<StringRef> FeatureStrs);
4289 QualType getVarArgType(const Expr *Arg);
4291 void EmitDeclMetadata();
4293 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4294 const AutoVarEmission &emission);
4296 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
4298 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
4299 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4300 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4301 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4302 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
4303 llvm::Value *EmitX86CpuSupports(uint32_t Mask);
4304 llvm::Value *EmitX86CpuInit();
4305 llvm::Value *FormResolverCondition(const MultiVersionResolverOption &RO);
4308 inline DominatingLLVMValue::saved_type
4309 DominatingLLVMValue::save(CodeGenFunction &CGF, llvm::Value *value) {
4310 if (!needsSaving(value)) return saved_type(value, false);
4312 // Otherwise, we need an alloca.
4313 auto align = CharUnits::fromQuantity(
4314 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4316 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
4317 CGF.Builder.CreateStore(value, alloca);
4319 return saved_type(alloca.getPointer(), true);
4322 inline llvm::Value *DominatingLLVMValue::restore(CodeGenFunction &CGF,
4324 // If the value says it wasn't saved, trust that it's still dominating.
4325 if (!value.getInt()) return value.getPointer();
4327 // Otherwise, it should be an alloca instruction, as set up in save().
4328 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4329 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
4332 } // end namespace CodeGen
4333 } // end namespace clang