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(InvalidBuiltin, invalid_builtin, 0) \
120 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
121 SANITIZER_CHECK(MissingReturn, missing_return, 0) \
122 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
123 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
124 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
125 SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
126 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
127 SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
128 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
129 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
130 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
131 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
132 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
133 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
135 enum SanitizerHandler {
136 #define SANITIZER_CHECK(Enum, Name, Version) Enum,
137 LIST_SANITIZER_CHECKS
138 #undef SANITIZER_CHECK
141 /// Helper class with most of the code for saving a value for a
142 /// conditional expression cleanup.
143 struct DominatingLLVMValue {
144 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
146 /// Answer whether the given value needs extra work to be saved.
147 static bool needsSaving(llvm::Value *value) {
148 // If it's not an instruction, we don't need to save.
149 if (!isa<llvm::Instruction>(value)) return false;
151 // If it's an instruction in the entry block, we don't need to save.
152 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
153 return (block != &block->getParent()->getEntryBlock());
156 static saved_type save(CodeGenFunction &CGF, llvm::Value *value);
157 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value);
160 /// A partial specialization of DominatingValue for llvm::Values that
161 /// might be llvm::Instructions.
162 template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
164 static type restore(CodeGenFunction &CGF, saved_type value) {
165 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
169 /// A specialization of DominatingValue for Address.
170 template <> struct DominatingValue<Address> {
171 typedef Address type;
174 DominatingLLVMValue::saved_type SavedValue;
178 static bool needsSaving(type value) {
179 return DominatingLLVMValue::needsSaving(value.getPointer());
181 static saved_type save(CodeGenFunction &CGF, type value) {
182 return { DominatingLLVMValue::save(CGF, value.getPointer()),
183 value.getAlignment() };
185 static type restore(CodeGenFunction &CGF, saved_type value) {
186 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
191 /// A specialization of DominatingValue for RValue.
192 template <> struct DominatingValue<RValue> {
195 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
196 AggregateAddress, ComplexAddress };
201 saved_type(llvm::Value *v, Kind k, unsigned a = 0)
202 : Value(v), K(k), Align(a) {}
205 static bool needsSaving(RValue value);
206 static saved_type save(CodeGenFunction &CGF, RValue value);
207 RValue restore(CodeGenFunction &CGF);
209 // implementations in CGCleanup.cpp
212 static bool needsSaving(type value) {
213 return saved_type::needsSaving(value);
215 static saved_type save(CodeGenFunction &CGF, type value) {
216 return saved_type::save(CGF, value);
218 static type restore(CodeGenFunction &CGF, saved_type value) {
219 return value.restore(CGF);
223 /// CodeGenFunction - This class organizes the per-function state that is used
224 /// while generating LLVM code.
225 class CodeGenFunction : public CodeGenTypeCache {
226 CodeGenFunction(const CodeGenFunction &) = delete;
227 void operator=(const CodeGenFunction &) = delete;
229 friend class CGCXXABI;
231 /// A jump destination is an abstract label, branching to which may
232 /// require a jump out through normal cleanups.
234 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
235 JumpDest(llvm::BasicBlock *Block,
236 EHScopeStack::stable_iterator Depth,
238 : Block(Block), ScopeDepth(Depth), Index(Index) {}
240 bool isValid() const { return Block != nullptr; }
241 llvm::BasicBlock *getBlock() const { return Block; }
242 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
243 unsigned getDestIndex() const { return Index; }
245 // This should be used cautiously.
246 void setScopeDepth(EHScopeStack::stable_iterator depth) {
251 llvm::BasicBlock *Block;
252 EHScopeStack::stable_iterator ScopeDepth;
256 CodeGenModule &CGM; // Per-module state.
257 const TargetInfo &Target;
259 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
260 LoopInfoStack LoopStack;
263 // Stores variables for which we can't generate correct lifetime markers
265 VarBypassDetector Bypasses;
267 // CodeGen lambda for loops and support for ordered clause
268 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
271 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
272 const unsigned, const bool)>
275 // Codegen lambda for loop bounds in worksharing loop constructs
276 typedef llvm::function_ref<std::pair<LValue, LValue>(
277 CodeGenFunction &, const OMPExecutableDirective &S)>
280 // Codegen lambda for loop bounds in dispatch-based loop implementation
281 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
282 CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
284 CodeGenDispatchBoundsTy;
286 /// CGBuilder insert helper. This function is called after an
287 /// instruction is created using Builder.
288 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
289 llvm::BasicBlock *BB,
290 llvm::BasicBlock::iterator InsertPt) const;
292 /// CurFuncDecl - Holds the Decl for the current outermost
293 /// non-closure context.
294 const Decl *CurFuncDecl;
295 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
296 const Decl *CurCodeDecl;
297 const CGFunctionInfo *CurFnInfo;
299 llvm::Function *CurFn = nullptr;
301 // Holds coroutine data if the current function is a coroutine. We use a
302 // wrapper to manage its lifetime, so that we don't have to define CGCoroData
305 std::unique_ptr<CGCoroData> Data;
311 bool isCoroutine() const {
312 return CurCoro.Data != nullptr;
315 /// CurGD - The GlobalDecl for the current function being compiled.
318 /// PrologueCleanupDepth - The cleanup depth enclosing all the
319 /// cleanups associated with the parameters.
320 EHScopeStack::stable_iterator PrologueCleanupDepth;
322 /// ReturnBlock - Unified return block.
323 JumpDest ReturnBlock;
325 /// ReturnValue - The temporary alloca to hold the return
326 /// value. This is invalid iff the function has no return value.
327 Address ReturnValue = Address::invalid();
329 /// Return true if a label was seen in the current scope.
330 bool hasLabelBeenSeenInCurrentScope() const {
332 return CurLexicalScope->hasLabels();
333 return !LabelMap.empty();
336 /// AllocaInsertPoint - This is an instruction in the entry block before which
337 /// we prefer to insert allocas.
338 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
340 /// API for captured statement code generation.
341 class CGCapturedStmtInfo {
343 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
344 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
345 explicit CGCapturedStmtInfo(const CapturedStmt &S,
346 CapturedRegionKind K = CR_Default)
347 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
349 RecordDecl::field_iterator Field =
350 S.getCapturedRecordDecl()->field_begin();
351 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
353 I != E; ++I, ++Field) {
354 if (I->capturesThis())
355 CXXThisFieldDecl = *Field;
356 else if (I->capturesVariable())
357 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
358 else if (I->capturesVariableByCopy())
359 CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
363 virtual ~CGCapturedStmtInfo();
365 CapturedRegionKind getKind() const { return Kind; }
367 virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
368 // Retrieve the value of the context parameter.
369 virtual llvm::Value *getContextValue() const { return ThisValue; }
371 /// Lookup the captured field decl for a variable.
372 virtual const FieldDecl *lookup(const VarDecl *VD) const {
373 return CaptureFields.lookup(VD->getCanonicalDecl());
376 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
377 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
379 static bool classof(const CGCapturedStmtInfo *) {
383 /// Emit the captured statement body.
384 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
385 CGF.incrementProfileCounter(S);
389 /// Get the name of the capture helper.
390 virtual StringRef getHelperName() const { return "__captured_stmt"; }
393 /// The kind of captured statement being generated.
394 CapturedRegionKind Kind;
396 /// Keep the map between VarDecl and FieldDecl.
397 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
399 /// The base address of the captured record, passed in as the first
400 /// argument of the parallel region function.
401 llvm::Value *ThisValue;
403 /// Captured 'this' type.
404 FieldDecl *CXXThisFieldDecl;
406 CGCapturedStmtInfo *CapturedStmtInfo = nullptr;
408 /// RAII for correct setting/restoring of CapturedStmtInfo.
409 class CGCapturedStmtRAII {
411 CodeGenFunction &CGF;
412 CGCapturedStmtInfo *PrevCapturedStmtInfo;
414 CGCapturedStmtRAII(CodeGenFunction &CGF,
415 CGCapturedStmtInfo *NewCapturedStmtInfo)
416 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
417 CGF.CapturedStmtInfo = NewCapturedStmtInfo;
419 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
422 /// An abstract representation of regular/ObjC call/message targets.
423 class AbstractCallee {
424 /// The function declaration of the callee.
425 const Decl *CalleeDecl;
428 AbstractCallee() : CalleeDecl(nullptr) {}
429 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
430 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
431 bool hasFunctionDecl() const {
432 return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
434 const Decl *getDecl() const { return CalleeDecl; }
435 unsigned getNumParams() const {
436 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
437 return FD->getNumParams();
438 return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
440 const ParmVarDecl *getParamDecl(unsigned I) const {
441 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
442 return FD->getParamDecl(I);
443 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
447 /// Sanitizers enabled for this function.
448 SanitizerSet SanOpts;
450 /// True if CodeGen currently emits code implementing sanitizer checks.
451 bool IsSanitizerScope = false;
453 /// RAII object to set/unset CodeGenFunction::IsSanitizerScope.
454 class SanitizerScope {
455 CodeGenFunction *CGF;
457 SanitizerScope(CodeGenFunction *CGF);
461 /// In C++, whether we are code generating a thunk. This controls whether we
462 /// should emit cleanups.
463 bool CurFuncIsThunk = false;
465 /// In ARC, whether we should autorelease the return value.
466 bool AutoreleaseResult = false;
468 /// Whether we processed a Microsoft-style asm block during CodeGen. These can
469 /// potentially set the return value.
470 bool SawAsmBlock = false;
472 const FunctionDecl *CurSEHParent = nullptr;
474 /// True if the current function is an outlined SEH helper. This can be a
475 /// finally block or filter expression.
476 bool IsOutlinedSEHHelper = false;
478 const CodeGen::CGBlockInfo *BlockInfo = nullptr;
479 llvm::Value *BlockPointer = nullptr;
481 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
482 FieldDecl *LambdaThisCaptureField = nullptr;
484 /// A mapping from NRVO variables to the flags used to indicate
485 /// when the NRVO has been applied to this variable.
486 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
488 EHScopeStack EHStack;
489 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
490 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
492 llvm::Instruction *CurrentFuncletPad = nullptr;
494 class CallLifetimeEnd final : public EHScopeStack::Cleanup {
499 CallLifetimeEnd(Address addr, llvm::Value *size)
500 : Addr(addr.getPointer()), Size(size) {}
502 void Emit(CodeGenFunction &CGF, Flags flags) override {
503 CGF.EmitLifetimeEnd(Size, Addr);
507 /// Header for data within LifetimeExtendedCleanupStack.
508 struct LifetimeExtendedCleanupHeader {
509 /// The size of the following cleanup object.
511 /// The kind of cleanup to push: a value from the CleanupKind enumeration.
513 /// Whether this is a conditional cleanup.
514 unsigned IsConditional : 1;
516 size_t getSize() const { return Size; }
517 CleanupKind getKind() const { return (CleanupKind)Kind; }
518 bool isConditional() const { return IsConditional; }
521 /// i32s containing the indexes of the cleanup destinations.
522 Address NormalCleanupDest = Address::invalid();
524 unsigned NextCleanupDestIndex = 1;
526 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
527 CGBlockInfo *FirstBlockInfo = nullptr;
529 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
530 llvm::BasicBlock *EHResumeBlock = nullptr;
532 /// The exception slot. All landing pads write the current exception pointer
533 /// into this alloca.
534 llvm::Value *ExceptionSlot = nullptr;
536 /// The selector slot. Under the MandatoryCleanup model, all landing pads
537 /// write the current selector value into this alloca.
538 llvm::AllocaInst *EHSelectorSlot = nullptr;
540 /// A stack of exception code slots. Entering an __except block pushes a slot
541 /// on the stack and leaving pops one. The __exception_code() intrinsic loads
542 /// a value from the top of the stack.
543 SmallVector<Address, 1> SEHCodeSlotStack;
545 /// Value returned by __exception_info intrinsic.
546 llvm::Value *SEHInfo = nullptr;
548 /// Emits a landing pad for the current EH stack.
549 llvm::BasicBlock *EmitLandingPad();
551 llvm::BasicBlock *getInvokeDestImpl();
554 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
555 return DominatingValue<T>::save(*this, value);
559 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
561 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
563 /// A class controlling the emission of a finally block.
565 /// Where the catchall's edge through the cleanup should go.
566 JumpDest RethrowDest;
568 /// A function to call to enter the catch.
569 llvm::Constant *BeginCatchFn;
571 /// An i1 variable indicating whether or not the @finally is
572 /// running for an exception.
573 llvm::AllocaInst *ForEHVar;
575 /// An i8* variable into which the exception pointer to rethrow
577 llvm::AllocaInst *SavedExnVar;
580 void enter(CodeGenFunction &CGF, const Stmt *Finally,
581 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
582 llvm::Constant *rethrowFn);
583 void exit(CodeGenFunction &CGF);
586 /// Returns true inside SEH __try blocks.
587 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
589 /// Returns true while emitting a cleanuppad.
590 bool isCleanupPadScope() const {
591 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
594 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
595 /// current full-expression. Safe against the possibility that
596 /// we're currently inside a conditionally-evaluated expression.
597 template <class T, class... As>
598 void pushFullExprCleanup(CleanupKind kind, As... A) {
599 // If we're not in a conditional branch, or if none of the
600 // arguments requires saving, then use the unconditional cleanup.
601 if (!isInConditionalBranch())
602 return EHStack.pushCleanup<T>(kind, A...);
604 // Stash values in a tuple so we can guarantee the order of saves.
605 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
606 SavedTuple Saved{saveValueInCond(A)...};
608 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
609 EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
610 initFullExprCleanup();
613 /// Queue a cleanup to be pushed after finishing the current
615 template <class T, class... As>
616 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
617 if (!isInConditionalBranch())
618 return pushCleanupAfterFullExprImpl<T>(Kind, Address::invalid(), A...);
620 Address ActiveFlag = createCleanupActiveFlag();
621 assert(!DominatingValue<Address>::needsSaving(ActiveFlag) &&
622 "cleanup active flag should never need saving");
624 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
625 SavedTuple Saved{saveValueInCond(A)...};
627 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
628 pushCleanupAfterFullExprImpl<CleanupType>(Kind, ActiveFlag, Saved);
631 template <class T, class... As>
632 void pushCleanupAfterFullExprImpl(CleanupKind Kind, Address ActiveFlag,
634 LifetimeExtendedCleanupHeader Header = {sizeof(T), Kind,
635 ActiveFlag.isValid()};
637 size_t OldSize = LifetimeExtendedCleanupStack.size();
638 LifetimeExtendedCleanupStack.resize(
639 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size +
640 (Header.IsConditional ? sizeof(ActiveFlag) : 0));
642 static_assert(sizeof(Header) % alignof(T) == 0,
643 "Cleanup will be allocated on misaligned address");
644 char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
645 new (Buffer) LifetimeExtendedCleanupHeader(Header);
646 new (Buffer + sizeof(Header)) T(A...);
647 if (Header.IsConditional)
648 new (Buffer + sizeof(Header) + sizeof(T)) Address(ActiveFlag);
651 /// Set up the last cleanup that was pushed as a conditional
652 /// full-expression cleanup.
653 void initFullExprCleanup() {
654 initFullExprCleanupWithFlag(createCleanupActiveFlag());
657 void initFullExprCleanupWithFlag(Address ActiveFlag);
658 Address createCleanupActiveFlag();
660 /// PushDestructorCleanup - Push a cleanup to call the
661 /// complete-object destructor of an object of the given type at the
662 /// given address. Does nothing if T is not a C++ class type with a
663 /// non-trivial destructor.
664 void PushDestructorCleanup(QualType T, Address Addr);
666 /// PushDestructorCleanup - Push a cleanup to call the
667 /// complete-object variant of the given destructor on the object at
668 /// the given address.
669 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
671 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
672 /// process all branch fixups.
673 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
675 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
676 /// The block cannot be reactivated. Pops it if it's the top of the
679 /// \param DominatingIP - An instruction which is known to
680 /// dominate the current IP (if set) and which lies along
681 /// all paths of execution between the current IP and the
682 /// the point at which the cleanup comes into scope.
683 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
684 llvm::Instruction *DominatingIP);
686 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
687 /// Cannot be used to resurrect a deactivated cleanup.
689 /// \param DominatingIP - An instruction which is known to
690 /// dominate the current IP (if set) and which lies along
691 /// all paths of execution between the current IP and the
692 /// the point at which the cleanup comes into scope.
693 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
694 llvm::Instruction *DominatingIP);
696 /// Enters a new scope for capturing cleanups, all of which
697 /// will be executed once the scope is exited.
698 class RunCleanupsScope {
699 EHScopeStack::stable_iterator CleanupStackDepth, OldCleanupScopeDepth;
700 size_t LifetimeExtendedCleanupStackSize;
701 bool OldDidCallStackSave;
706 RunCleanupsScope(const RunCleanupsScope &) = delete;
707 void operator=(const RunCleanupsScope &) = delete;
710 CodeGenFunction& CGF;
713 /// Enter a new cleanup scope.
714 explicit RunCleanupsScope(CodeGenFunction &CGF)
715 : PerformCleanup(true), CGF(CGF)
717 CleanupStackDepth = CGF.EHStack.stable_begin();
718 LifetimeExtendedCleanupStackSize =
719 CGF.LifetimeExtendedCleanupStack.size();
720 OldDidCallStackSave = CGF.DidCallStackSave;
721 CGF.DidCallStackSave = false;
722 OldCleanupScopeDepth = CGF.CurrentCleanupScopeDepth;
723 CGF.CurrentCleanupScopeDepth = CleanupStackDepth;
726 /// Exit this cleanup scope, emitting any accumulated cleanups.
727 ~RunCleanupsScope() {
732 /// Determine whether this scope requires any cleanups.
733 bool requiresCleanups() const {
734 return CGF.EHStack.stable_begin() != CleanupStackDepth;
737 /// Force the emission of cleanups now, instead of waiting
738 /// until this object is destroyed.
739 /// \param ValuesToReload - A list of values that need to be available at
740 /// the insertion point after cleanup emission. If cleanup emission created
741 /// a shared cleanup block, these value pointers will be rewritten.
742 /// Otherwise, they not will be modified.
743 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
744 assert(PerformCleanup && "Already forced cleanup");
745 CGF.DidCallStackSave = OldDidCallStackSave;
746 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
748 PerformCleanup = false;
749 CGF.CurrentCleanupScopeDepth = OldCleanupScopeDepth;
753 // Cleanup stack depth of the RunCleanupsScope that was pushed most recently.
754 EHScopeStack::stable_iterator CurrentCleanupScopeDepth =
755 EHScopeStack::stable_end();
757 class LexicalScope : public RunCleanupsScope {
759 SmallVector<const LabelDecl*, 4> Labels;
760 LexicalScope *ParentScope;
762 LexicalScope(const LexicalScope &) = delete;
763 void operator=(const LexicalScope &) = delete;
766 /// Enter a new cleanup scope.
767 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
768 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
769 CGF.CurLexicalScope = this;
770 if (CGDebugInfo *DI = CGF.getDebugInfo())
771 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
774 void addLabel(const LabelDecl *label) {
775 assert(PerformCleanup && "adding label to dead scope?");
776 Labels.push_back(label);
779 /// Exit this cleanup scope, emitting any accumulated
782 if (CGDebugInfo *DI = CGF.getDebugInfo())
783 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
785 // If we should perform a cleanup, force them now. Note that
786 // this ends the cleanup scope before rescoping any labels.
787 if (PerformCleanup) {
788 ApplyDebugLocation DL(CGF, Range.getEnd());
793 /// Force the emission of cleanups now, instead of waiting
794 /// until this object is destroyed.
795 void ForceCleanup() {
796 CGF.CurLexicalScope = ParentScope;
797 RunCleanupsScope::ForceCleanup();
803 bool hasLabels() const {
804 return !Labels.empty();
807 void rescopeLabels();
810 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
812 /// The class used to assign some variables some temporarily addresses.
814 DeclMapTy SavedLocals;
815 DeclMapTy SavedTempAddresses;
816 OMPMapVars(const OMPMapVars &) = delete;
817 void operator=(const OMPMapVars &) = delete;
820 explicit OMPMapVars() = default;
822 assert(SavedLocals.empty() && "Did not restored original addresses.");
825 /// Sets the address of the variable \p LocalVD to be \p TempAddr in
827 /// \return true if at least one variable was set already, false otherwise.
828 bool setVarAddr(CodeGenFunction &CGF, const VarDecl *LocalVD,
830 LocalVD = LocalVD->getCanonicalDecl();
831 // Only save it once.
832 if (SavedLocals.count(LocalVD)) return false;
834 // Copy the existing local entry to SavedLocals.
835 auto it = CGF.LocalDeclMap.find(LocalVD);
836 if (it != CGF.LocalDeclMap.end())
837 SavedLocals.try_emplace(LocalVD, it->second);
839 SavedLocals.try_emplace(LocalVD, Address::invalid());
841 // Generate the private entry.
842 QualType VarTy = LocalVD->getType();
843 if (VarTy->isReferenceType()) {
844 Address Temp = CGF.CreateMemTemp(VarTy);
845 CGF.Builder.CreateStore(TempAddr.getPointer(), Temp);
848 SavedTempAddresses.try_emplace(LocalVD, TempAddr);
853 /// Applies new addresses to the list of the variables.
854 /// \return true if at least one variable is using new address, false
856 bool apply(CodeGenFunction &CGF) {
857 copyInto(SavedTempAddresses, CGF.LocalDeclMap);
858 SavedTempAddresses.clear();
859 return !SavedLocals.empty();
862 /// Restores original addresses of the variables.
863 void restore(CodeGenFunction &CGF) {
864 if (!SavedLocals.empty()) {
865 copyInto(SavedLocals, CGF.LocalDeclMap);
871 /// Copy all the entries in the source map over the corresponding
872 /// entries in the destination, which must exist.
873 static void copyInto(const DeclMapTy &Src, DeclMapTy &Dest) {
874 for (auto &Pair : Src) {
875 if (!Pair.second.isValid()) {
876 Dest.erase(Pair.first);
880 auto I = Dest.find(Pair.first);
882 I->second = Pair.second;
889 /// The scope used to remap some variables as private in the OpenMP loop body
890 /// (or other captured region emitted without outlining), and to restore old
891 /// vars back on exit.
892 class OMPPrivateScope : public RunCleanupsScope {
893 OMPMapVars MappedVars;
894 OMPPrivateScope(const OMPPrivateScope &) = delete;
895 void operator=(const OMPPrivateScope &) = delete;
898 /// Enter a new OpenMP private scope.
899 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
901 /// Registers \p LocalVD variable as a private and apply \p PrivateGen
902 /// function for it to generate corresponding private variable. \p
903 /// PrivateGen returns an address of the generated private variable.
904 /// \return true if the variable is registered as private, false if it has
905 /// been privatized already.
906 bool addPrivate(const VarDecl *LocalVD,
907 const llvm::function_ref<Address()> PrivateGen) {
908 assert(PerformCleanup && "adding private to dead scope");
909 return MappedVars.setVarAddr(CGF, LocalVD, PrivateGen());
912 /// Privatizes local variables previously registered as private.
913 /// Registration is separate from the actual privatization to allow
914 /// initializers use values of the original variables, not the private one.
915 /// This is important, for example, if the private variable is a class
916 /// variable initialized by a constructor that references other private
917 /// variables. But at initialization original variables must be used, not
919 /// \return true if at least one variable was privatized, false otherwise.
920 bool Privatize() { return MappedVars.apply(CGF); }
922 void ForceCleanup() {
923 RunCleanupsScope::ForceCleanup();
924 MappedVars.restore(CGF);
927 /// Exit scope - all the mapped variables are restored.
933 /// Checks if the global variable is captured in current function.
934 bool isGlobalVarCaptured(const VarDecl *VD) const {
935 VD = VD->getCanonicalDecl();
936 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
940 /// Takes the old cleanup stack size and emits the cleanup blocks
941 /// that have been added.
943 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
944 std::initializer_list<llvm::Value **> ValuesToReload = {});
946 /// Takes the old cleanup stack size and emits the cleanup blocks
947 /// that have been added, then adds all lifetime-extended cleanups from
948 /// the given position to the stack.
950 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
951 size_t OldLifetimeExtendedStackSize,
952 std::initializer_list<llvm::Value **> ValuesToReload = {});
954 void ResolveBranchFixups(llvm::BasicBlock *Target);
956 /// The given basic block lies in the current EH scope, but may be a
957 /// target of a potentially scope-crossing jump; get a stable handle
958 /// to which we can perform this jump later.
959 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
960 return JumpDest(Target,
961 EHStack.getInnermostNormalCleanup(),
962 NextCleanupDestIndex++);
965 /// The given basic block lies in the current EH scope, but may be a
966 /// target of a potentially scope-crossing jump; get a stable handle
967 /// to which we can perform this jump later.
968 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
969 return getJumpDestInCurrentScope(createBasicBlock(Name));
972 /// EmitBranchThroughCleanup - Emit a branch from the current insert
973 /// block through the normal cleanup handling code (if any) and then
975 void EmitBranchThroughCleanup(JumpDest Dest);
977 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
978 /// specified destination obviously has no cleanups to run. 'false' is always
979 /// a conservatively correct answer for this method.
980 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
982 /// popCatchScope - Pops the catch scope at the top of the EHScope
983 /// stack, emitting any required code (other than the catch handlers
985 void popCatchScope();
987 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
988 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
990 getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope);
992 /// An object to manage conditionally-evaluated expressions.
993 class ConditionalEvaluation {
994 llvm::BasicBlock *StartBB;
997 ConditionalEvaluation(CodeGenFunction &CGF)
998 : StartBB(CGF.Builder.GetInsertBlock()) {}
1000 void begin(CodeGenFunction &CGF) {
1001 assert(CGF.OutermostConditional != this);
1002 if (!CGF.OutermostConditional)
1003 CGF.OutermostConditional = this;
1006 void end(CodeGenFunction &CGF) {
1007 assert(CGF.OutermostConditional != nullptr);
1008 if (CGF.OutermostConditional == this)
1009 CGF.OutermostConditional = nullptr;
1012 /// Returns a block which will be executed prior to each
1013 /// evaluation of the conditional code.
1014 llvm::BasicBlock *getStartingBlock() const {
1019 /// isInConditionalBranch - Return true if we're currently emitting
1020 /// one branch or the other of a conditional expression.
1021 bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
1023 void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
1024 assert(isInConditionalBranch());
1025 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
1026 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
1027 store->setAlignment(addr.getAlignment().getQuantity());
1030 /// An RAII object to record that we're evaluating a statement
1032 class StmtExprEvaluation {
1033 CodeGenFunction &CGF;
1035 /// We have to save the outermost conditional: cleanups in a
1036 /// statement expression aren't conditional just because the
1038 ConditionalEvaluation *SavedOutermostConditional;
1041 StmtExprEvaluation(CodeGenFunction &CGF)
1042 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
1043 CGF.OutermostConditional = nullptr;
1046 ~StmtExprEvaluation() {
1047 CGF.OutermostConditional = SavedOutermostConditional;
1048 CGF.EnsureInsertPoint();
1052 /// An object which temporarily prevents a value from being
1053 /// destroyed by aggressive peephole optimizations that assume that
1054 /// all uses of a value have been realized in the IR.
1055 class PeepholeProtection {
1056 llvm::Instruction *Inst;
1057 friend class CodeGenFunction;
1060 PeepholeProtection() : Inst(nullptr) {}
1063 /// A non-RAII class containing all the information about a bound
1064 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1065 /// this which makes individual mappings very simple; using this
1066 /// class directly is useful when you have a variable number of
1067 /// opaque values or don't want the RAII functionality for some
1069 class OpaqueValueMappingData {
1070 const OpaqueValueExpr *OpaqueValue;
1072 CodeGenFunction::PeepholeProtection Protection;
1074 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1076 : OpaqueValue(ov), BoundLValue(boundLValue) {}
1078 OpaqueValueMappingData() : OpaqueValue(nullptr) {}
1080 static bool shouldBindAsLValue(const Expr *expr) {
1081 // gl-values should be bound as l-values for obvious reasons.
1082 // Records should be bound as l-values because IR generation
1083 // always keeps them in memory. Expressions of function type
1084 // act exactly like l-values but are formally required to be
1086 return expr->isGLValue() ||
1087 expr->getType()->isFunctionType() ||
1088 hasAggregateEvaluationKind(expr->getType());
1091 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1092 const OpaqueValueExpr *ov,
1094 if (shouldBindAsLValue(ov))
1095 return bind(CGF, ov, CGF.EmitLValue(e));
1096 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1099 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1100 const OpaqueValueExpr *ov,
1102 assert(shouldBindAsLValue(ov));
1103 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1104 return OpaqueValueMappingData(ov, true);
1107 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1108 const OpaqueValueExpr *ov,
1110 assert(!shouldBindAsLValue(ov));
1111 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1113 OpaqueValueMappingData data(ov, false);
1115 // Work around an extremely aggressive peephole optimization in
1116 // EmitScalarConversion which assumes that all other uses of a
1117 // value are extant.
1118 data.Protection = CGF.protectFromPeepholes(rv);
1123 bool isValid() const { return OpaqueValue != nullptr; }
1124 void clear() { OpaqueValue = nullptr; }
1126 void unbind(CodeGenFunction &CGF) {
1127 assert(OpaqueValue && "no data to unbind!");
1130 CGF.OpaqueLValues.erase(OpaqueValue);
1132 CGF.OpaqueRValues.erase(OpaqueValue);
1133 CGF.unprotectFromPeepholes(Protection);
1138 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1139 class OpaqueValueMapping {
1140 CodeGenFunction &CGF;
1141 OpaqueValueMappingData Data;
1144 static bool shouldBindAsLValue(const Expr *expr) {
1145 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1148 /// Build the opaque value mapping for the given conditional
1149 /// operator if it's the GNU ?: extension. This is a common
1150 /// enough pattern that the convenience operator is really
1153 OpaqueValueMapping(CodeGenFunction &CGF,
1154 const AbstractConditionalOperator *op) : CGF(CGF) {
1155 if (isa<ConditionalOperator>(op))
1156 // Leave Data empty.
1159 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
1160 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1164 /// Build the opaque value mapping for an OpaqueValueExpr whose source
1165 /// expression is set to the expression the OVE represents.
1166 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
1169 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
1170 "for OVE with no source expression");
1171 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
1175 OpaqueValueMapping(CodeGenFunction &CGF,
1176 const OpaqueValueExpr *opaqueValue,
1178 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
1181 OpaqueValueMapping(CodeGenFunction &CGF,
1182 const OpaqueValueExpr *opaqueValue,
1184 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
1192 ~OpaqueValueMapping() {
1193 if (Data.isValid()) Data.unbind(CGF);
1198 CGDebugInfo *DebugInfo;
1199 bool DisableDebugInfo = false;
1201 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1202 /// calling llvm.stacksave for multiple VLAs in the same scope.
1203 bool DidCallStackSave = false;
1205 /// IndirectBranch - The first time an indirect goto is seen we create a block
1206 /// with an indirect branch. Every time we see the address of a label taken,
1207 /// we add the label to the indirect goto. Every subsequent indirect goto is
1208 /// codegen'd as a jump to the IndirectBranch's basic block.
1209 llvm::IndirectBrInst *IndirectBranch = nullptr;
1211 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1213 DeclMapTy LocalDeclMap;
1215 // Keep track of the cleanups for callee-destructed parameters pushed to the
1216 // cleanup stack so that they can be deactivated later.
1217 llvm::DenseMap<const ParmVarDecl *, EHScopeStack::stable_iterator>
1218 CalleeDestructedParamCleanups;
1220 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
1221 /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
1223 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
1226 /// Track escaped local variables with auto storage. Used during SEH
1227 /// outlining to produce a call to llvm.localescape.
1228 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
1230 /// LabelMap - This keeps track of the LLVM basic block for each C label.
1231 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
1233 // BreakContinueStack - This keeps track of where break and continue
1234 // statements should jump to.
1235 struct BreakContinue {
1236 BreakContinue(JumpDest Break, JumpDest Continue)
1237 : BreakBlock(Break), ContinueBlock(Continue) {}
1239 JumpDest BreakBlock;
1240 JumpDest ContinueBlock;
1242 SmallVector<BreakContinue, 8> BreakContinueStack;
1244 /// Handles cancellation exit points in OpenMP-related constructs.
1245 class OpenMPCancelExitStack {
1246 /// Tracks cancellation exit point and join point for cancel-related exit
1247 /// and normal exit.
1249 CancelExit() = default;
1250 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
1252 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
1253 OpenMPDirectiveKind Kind = OMPD_unknown;
1254 /// true if the exit block has been emitted already by the special
1255 /// emitExit() call, false if the default codegen is used.
1256 bool HasBeenEmitted = false;
1261 SmallVector<CancelExit, 8> Stack;
1264 OpenMPCancelExitStack() : Stack(1) {}
1265 ~OpenMPCancelExitStack() = default;
1266 /// Fetches the exit block for the current OpenMP construct.
1267 JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
1268 /// Emits exit block with special codegen procedure specific for the related
1269 /// OpenMP construct + emits code for normal construct cleanup.
1270 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
1271 const llvm::function_ref<void(CodeGenFunction &)> CodeGen) {
1272 if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
1273 assert(CGF.getOMPCancelDestination(Kind).isValid());
1274 assert(CGF.HaveInsertPoint());
1275 assert(!Stack.back().HasBeenEmitted);
1276 auto IP = CGF.Builder.saveAndClearIP();
1277 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1279 CGF.EmitBranch(Stack.back().ContBlock.getBlock());
1280 CGF.Builder.restoreIP(IP);
1281 Stack.back().HasBeenEmitted = true;
1285 /// Enter the cancel supporting \a Kind construct.
1286 /// \param Kind OpenMP directive that supports cancel constructs.
1287 /// \param HasCancel true, if the construct has inner cancel directive,
1288 /// false otherwise.
1289 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
1290 Stack.push_back({Kind,
1291 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
1293 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
1296 /// Emits default exit point for the cancel construct (if the special one
1297 /// has not be used) + join point for cancel/normal exits.
1298 void exit(CodeGenFunction &CGF) {
1299 if (getExitBlock().isValid()) {
1300 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
1301 bool HaveIP = CGF.HaveInsertPoint();
1302 if (!Stack.back().HasBeenEmitted) {
1304 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1305 CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
1306 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
1308 CGF.EmitBlock(Stack.back().ContBlock.getBlock());
1310 CGF.Builder.CreateUnreachable();
1311 CGF.Builder.ClearInsertionPoint();
1317 OpenMPCancelExitStack OMPCancelStack;
1321 /// Calculate branch weights appropriate for PGO data
1322 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
1323 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
1324 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
1325 uint64_t LoopCount);
1328 /// Increment the profiler's counter for the given statement by \p StepV.
1329 /// If \p StepV is null, the default increment is 1.
1330 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
1331 if (CGM.getCodeGenOpts().hasProfileClangInstr())
1332 PGO.emitCounterIncrement(Builder, S, StepV);
1333 PGO.setCurrentStmt(S);
1336 /// Get the profiler's count for the given statement.
1337 uint64_t getProfileCount(const Stmt *S) {
1338 Optional<uint64_t> Count = PGO.getStmtCount(S);
1339 if (!Count.hasValue())
1344 /// Set the profiler's current count.
1345 void setCurrentProfileCount(uint64_t Count) {
1346 PGO.setCurrentRegionCount(Count);
1349 /// Get the profiler's current count. This is generally the count for the most
1350 /// recently incremented counter.
1351 uint64_t getCurrentProfileCount() {
1352 return PGO.getCurrentRegionCount();
1357 /// SwitchInsn - This is nearest current switch instruction. It is null if
1358 /// current context is not in a switch.
1359 llvm::SwitchInst *SwitchInsn = nullptr;
1360 /// The branch weights of SwitchInsn when doing instrumentation based PGO.
1361 SmallVector<uint64_t, 16> *SwitchWeights = nullptr;
1363 /// CaseRangeBlock - This block holds if condition check for last case
1364 /// statement range in current switch instruction.
1365 llvm::BasicBlock *CaseRangeBlock = nullptr;
1367 /// OpaqueLValues - Keeps track of the current set of opaque value
1369 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1370 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
1372 // VLASizeMap - This keeps track of the associated size for each VLA type.
1373 // We track this by the size expression rather than the type itself because
1374 // in certain situations, like a const qualifier applied to an VLA typedef,
1375 // multiple VLA types can share the same size expression.
1376 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1377 // enter/leave scopes.
1378 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
1380 /// A block containing a single 'unreachable' instruction. Created
1381 /// lazily by getUnreachableBlock().
1382 llvm::BasicBlock *UnreachableBlock = nullptr;
1384 /// Counts of the number return expressions in the function.
1385 unsigned NumReturnExprs = 0;
1387 /// Count the number of simple (constant) return expressions in the function.
1388 unsigned NumSimpleReturnExprs = 0;
1390 /// The last regular (non-return) debug location (breakpoint) in the function.
1391 SourceLocation LastStopPoint;
1394 /// A scope within which we are constructing the fields of an object which
1395 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1396 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1397 class FieldConstructionScope {
1399 FieldConstructionScope(CodeGenFunction &CGF, Address This)
1400 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1401 CGF.CXXDefaultInitExprThis = This;
1403 ~FieldConstructionScope() {
1404 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1408 CodeGenFunction &CGF;
1409 Address OldCXXDefaultInitExprThis;
1412 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1413 /// is overridden to be the object under construction.
1414 class CXXDefaultInitExprScope {
1416 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1417 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
1418 OldCXXThisAlignment(CGF.CXXThisAlignment) {
1419 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
1420 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
1422 ~CXXDefaultInitExprScope() {
1423 CGF.CXXThisValue = OldCXXThisValue;
1424 CGF.CXXThisAlignment = OldCXXThisAlignment;
1428 CodeGenFunction &CGF;
1429 llvm::Value *OldCXXThisValue;
1430 CharUnits OldCXXThisAlignment;
1433 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
1434 /// current loop index is overridden.
1435 class ArrayInitLoopExprScope {
1437 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
1438 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
1439 CGF.ArrayInitIndex = Index;
1441 ~ArrayInitLoopExprScope() {
1442 CGF.ArrayInitIndex = OldArrayInitIndex;
1446 CodeGenFunction &CGF;
1447 llvm::Value *OldArrayInitIndex;
1450 class InlinedInheritingConstructorScope {
1452 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
1453 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
1454 OldCurCodeDecl(CGF.CurCodeDecl),
1455 OldCXXABIThisDecl(CGF.CXXABIThisDecl),
1456 OldCXXABIThisValue(CGF.CXXABIThisValue),
1457 OldCXXThisValue(CGF.CXXThisValue),
1458 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
1459 OldCXXThisAlignment(CGF.CXXThisAlignment),
1460 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
1461 OldCXXInheritedCtorInitExprArgs(
1462 std::move(CGF.CXXInheritedCtorInitExprArgs)) {
1464 CGF.CurFuncDecl = CGF.CurCodeDecl =
1465 cast<CXXConstructorDecl>(GD.getDecl());
1466 CGF.CXXABIThisDecl = nullptr;
1467 CGF.CXXABIThisValue = nullptr;
1468 CGF.CXXThisValue = nullptr;
1469 CGF.CXXABIThisAlignment = CharUnits();
1470 CGF.CXXThisAlignment = CharUnits();
1471 CGF.ReturnValue = Address::invalid();
1472 CGF.FnRetTy = QualType();
1473 CGF.CXXInheritedCtorInitExprArgs.clear();
1475 ~InlinedInheritingConstructorScope() {
1476 CGF.CurGD = OldCurGD;
1477 CGF.CurFuncDecl = OldCurFuncDecl;
1478 CGF.CurCodeDecl = OldCurCodeDecl;
1479 CGF.CXXABIThisDecl = OldCXXABIThisDecl;
1480 CGF.CXXABIThisValue = OldCXXABIThisValue;
1481 CGF.CXXThisValue = OldCXXThisValue;
1482 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
1483 CGF.CXXThisAlignment = OldCXXThisAlignment;
1484 CGF.ReturnValue = OldReturnValue;
1485 CGF.FnRetTy = OldFnRetTy;
1486 CGF.CXXInheritedCtorInitExprArgs =
1487 std::move(OldCXXInheritedCtorInitExprArgs);
1491 CodeGenFunction &CGF;
1492 GlobalDecl OldCurGD;
1493 const Decl *OldCurFuncDecl;
1494 const Decl *OldCurCodeDecl;
1495 ImplicitParamDecl *OldCXXABIThisDecl;
1496 llvm::Value *OldCXXABIThisValue;
1497 llvm::Value *OldCXXThisValue;
1498 CharUnits OldCXXABIThisAlignment;
1499 CharUnits OldCXXThisAlignment;
1500 Address OldReturnValue;
1501 QualType OldFnRetTy;
1502 CallArgList OldCXXInheritedCtorInitExprArgs;
1506 /// CXXThisDecl - When generating code for a C++ member function,
1507 /// this will hold the implicit 'this' declaration.
1508 ImplicitParamDecl *CXXABIThisDecl = nullptr;
1509 llvm::Value *CXXABIThisValue = nullptr;
1510 llvm::Value *CXXThisValue = nullptr;
1511 CharUnits CXXABIThisAlignment;
1512 CharUnits CXXThisAlignment;
1514 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1515 /// this expression.
1516 Address CXXDefaultInitExprThis = Address::invalid();
1518 /// The current array initialization index when evaluating an
1519 /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
1520 llvm::Value *ArrayInitIndex = nullptr;
1522 /// The values of function arguments to use when evaluating
1523 /// CXXInheritedCtorInitExprs within this context.
1524 CallArgList CXXInheritedCtorInitExprArgs;
1526 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1527 /// destructor, this will hold the implicit argument (e.g. VTT).
1528 ImplicitParamDecl *CXXStructorImplicitParamDecl = nullptr;
1529 llvm::Value *CXXStructorImplicitParamValue = nullptr;
1531 /// OutermostConditional - Points to the outermost active
1532 /// conditional control. This is used so that we know if a
1533 /// temporary should be destroyed conditionally.
1534 ConditionalEvaluation *OutermostConditional = nullptr;
1536 /// The current lexical scope.
1537 LexicalScope *CurLexicalScope = nullptr;
1539 /// The current source location that should be used for exception
1541 SourceLocation CurEHLocation;
1543 /// BlockByrefInfos - For each __block variable, contains
1544 /// information about the layout of the variable.
1545 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
1547 /// Used by -fsanitize=nullability-return to determine whether the return
1548 /// value can be checked.
1549 llvm::Value *RetValNullabilityPrecondition = nullptr;
1551 /// Check if -fsanitize=nullability-return instrumentation is required for
1553 bool requiresReturnValueNullabilityCheck() const {
1554 return RetValNullabilityPrecondition;
1557 /// Used to store precise source locations for return statements by the
1558 /// runtime return value checks.
1559 Address ReturnLocation = Address::invalid();
1561 /// Check if the return value of this function requires sanitization.
1562 bool requiresReturnValueCheck() const {
1563 return requiresReturnValueNullabilityCheck() ||
1564 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
1565 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
1568 llvm::BasicBlock *TerminateLandingPad = nullptr;
1569 llvm::BasicBlock *TerminateHandler = nullptr;
1570 llvm::BasicBlock *TrapBB = nullptr;
1572 /// Terminate funclets keyed by parent funclet pad.
1573 llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
1575 /// Largest vector width used in ths function. Will be used to create a
1576 /// function attribute.
1577 unsigned LargestVectorWidth = 0;
1579 /// True if we need emit the life-time markers.
1580 const bool ShouldEmitLifetimeMarkers;
1582 /// Add OpenCL kernel arg metadata and the kernel attribute metadata to
1583 /// the function metadata.
1584 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1585 llvm::Function *Fn);
1588 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
1591 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
1592 ASTContext &getContext() const { return CGM.getContext(); }
1593 CGDebugInfo *getDebugInfo() {
1594 if (DisableDebugInfo)
1598 void disableDebugInfo() { DisableDebugInfo = true; }
1599 void enableDebugInfo() { DisableDebugInfo = false; }
1601 bool shouldUseFusedARCCalls() {
1602 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1605 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
1607 /// Returns a pointer to the function's exception object and selector slot,
1608 /// which is assigned in every landing pad.
1609 Address getExceptionSlot();
1610 Address getEHSelectorSlot();
1612 /// Returns the contents of the function's exception object and selector
1614 llvm::Value *getExceptionFromSlot();
1615 llvm::Value *getSelectorFromSlot();
1617 Address getNormalCleanupDestSlot();
1619 llvm::BasicBlock *getUnreachableBlock() {
1620 if (!UnreachableBlock) {
1621 UnreachableBlock = createBasicBlock("unreachable");
1622 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1624 return UnreachableBlock;
1627 llvm::BasicBlock *getInvokeDest() {
1628 if (!EHStack.requiresLandingPad()) return nullptr;
1629 return getInvokeDestImpl();
1632 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
1634 const TargetInfo &getTarget() const { return Target; }
1635 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
1636 const TargetCodeGenInfo &getTargetHooks() const {
1637 return CGM.getTargetCodeGenInfo();
1640 //===--------------------------------------------------------------------===//
1642 //===--------------------------------------------------------------------===//
1644 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
1646 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1647 Address arrayEndPointer,
1648 QualType elementType,
1649 CharUnits elementAlignment,
1650 Destroyer *destroyer);
1651 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1652 llvm::Value *arrayEnd,
1653 QualType elementType,
1654 CharUnits elementAlignment,
1655 Destroyer *destroyer);
1657 void pushDestroy(QualType::DestructionKind dtorKind,
1658 Address addr, QualType type);
1659 void pushEHDestroy(QualType::DestructionKind dtorKind,
1660 Address addr, QualType type);
1661 void pushDestroy(CleanupKind kind, Address addr, QualType type,
1662 Destroyer *destroyer, bool useEHCleanupForArray);
1663 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
1664 QualType type, Destroyer *destroyer,
1665 bool useEHCleanupForArray);
1666 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1667 llvm::Value *CompletePtr,
1668 QualType ElementType);
1669 void pushStackRestore(CleanupKind kind, Address SPMem);
1670 void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
1671 bool useEHCleanupForArray);
1672 llvm::Function *generateDestroyHelper(Address addr, QualType type,
1673 Destroyer *destroyer,
1674 bool useEHCleanupForArray,
1676 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
1677 QualType elementType, CharUnits elementAlign,
1678 Destroyer *destroyer,
1679 bool checkZeroLength, bool useEHCleanup);
1681 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
1683 /// Determines whether an EH cleanup is required to destroy a type
1684 /// with the given destruction kind.
1685 bool needsEHCleanup(QualType::DestructionKind kind) {
1687 case QualType::DK_none:
1689 case QualType::DK_cxx_destructor:
1690 case QualType::DK_objc_weak_lifetime:
1691 case QualType::DK_nontrivial_c_struct:
1692 return getLangOpts().Exceptions;
1693 case QualType::DK_objc_strong_lifetime:
1694 return getLangOpts().Exceptions &&
1695 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1697 llvm_unreachable("bad destruction kind");
1700 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1701 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1704 //===--------------------------------------------------------------------===//
1706 //===--------------------------------------------------------------------===//
1708 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
1710 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
1712 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
1713 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1714 const ObjCPropertyImplDecl *PID);
1715 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1716 const ObjCPropertyImplDecl *propImpl,
1717 const ObjCMethodDecl *GetterMothodDecl,
1718 llvm::Constant *AtomicHelperFn);
1720 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1721 ObjCMethodDecl *MD, bool ctor);
1723 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1724 /// for the given property.
1725 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1726 const ObjCPropertyImplDecl *PID);
1727 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1728 const ObjCPropertyImplDecl *propImpl,
1729 llvm::Constant *AtomicHelperFn);
1731 //===--------------------------------------------------------------------===//
1733 //===--------------------------------------------------------------------===//
1735 /// Emit block literal.
1736 /// \return an LLVM value which is a pointer to a struct which contains
1737 /// information about the block, including the block invoke function, the
1738 /// captured variables, etc.
1739 llvm::Value *EmitBlockLiteral(const BlockExpr *);
1740 static void destroyBlockInfos(CGBlockInfo *info);
1742 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
1743 const CGBlockInfo &Info,
1744 const DeclMapTy &ldm,
1745 bool IsLambdaConversionToBlock,
1746 bool BuildGlobalBlock);
1748 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1749 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
1750 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1751 const ObjCPropertyImplDecl *PID);
1752 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1753 const ObjCPropertyImplDecl *PID);
1754 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
1756 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1758 class AutoVarEmission;
1760 void emitByrefStructureInit(const AutoVarEmission &emission);
1762 /// Enter a cleanup to destroy a __block variable. Note that this
1763 /// cleanup should be a no-op if the variable hasn't left the stack
1764 /// yet; if a cleanup is required for the variable itself, that needs
1765 /// to be done externally.
1767 /// \param Kind Cleanup kind.
1769 /// \param Addr When \p LoadBlockVarAddr is false, the address of the __block
1770 /// structure that will be passed to _Block_object_dispose. When
1771 /// \p LoadBlockVarAddr is true, the address of the field of the block
1772 /// structure that holds the address of the __block structure.
1774 /// \param Flags The flag that will be passed to _Block_object_dispose.
1776 /// \param LoadBlockVarAddr Indicates whether we need to emit a load from
1777 /// \p Addr to get the address of the __block structure.
1778 void enterByrefCleanup(CleanupKind Kind, Address Addr, BlockFieldFlags Flags,
1779 bool LoadBlockVarAddr);
1781 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
1784 Address LoadBlockStruct();
1785 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1787 /// BuildBlockByrefAddress - Computes the location of the
1788 /// data in a variable which is declared as __block.
1789 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
1790 bool followForward = true);
1791 Address emitBlockByrefAddress(Address baseAddr,
1792 const BlockByrefInfo &info,
1794 const llvm::Twine &name);
1796 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
1798 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
1800 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1801 const CGFunctionInfo &FnInfo);
1802 /// Emit code for the start of a function.
1803 /// \param Loc The location to be associated with the function.
1804 /// \param StartLoc The location of the function body.
1805 void StartFunction(GlobalDecl GD,
1808 const CGFunctionInfo &FnInfo,
1809 const FunctionArgList &Args,
1810 SourceLocation Loc = SourceLocation(),
1811 SourceLocation StartLoc = SourceLocation());
1813 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
1815 void EmitConstructorBody(FunctionArgList &Args);
1816 void EmitDestructorBody(FunctionArgList &Args);
1817 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
1818 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
1819 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
1821 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
1822 CallArgList &CallArgs);
1823 void EmitLambdaBlockInvokeBody();
1824 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1825 void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
1826 void EmitAsanPrologueOrEpilogue(bool Prologue);
1828 /// Emit the unified return block, trying to avoid its emission when
1830 /// \return The debug location of the user written return statement if the
1831 /// return block is is avoided.
1832 llvm::DebugLoc EmitReturnBlock();
1834 /// FinishFunction - Complete IR generation of the current function. It is
1835 /// legal to call this function even if there is no current insertion point.
1836 void FinishFunction(SourceLocation EndLoc=SourceLocation());
1838 void StartThunk(llvm::Function *Fn, GlobalDecl GD,
1839 const CGFunctionInfo &FnInfo, bool IsUnprototyped);
1841 void EmitCallAndReturnForThunk(llvm::Constant *Callee, const ThunkInfo *Thunk,
1842 bool IsUnprototyped);
1846 /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
1847 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
1848 llvm::Value *Callee);
1850 /// Generate a thunk for the given method.
1851 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1852 GlobalDecl GD, const ThunkInfo &Thunk,
1853 bool IsUnprototyped);
1855 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
1856 const CGFunctionInfo &FnInfo,
1857 GlobalDecl GD, const ThunkInfo &Thunk);
1859 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1860 FunctionArgList &Args);
1862 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
1864 /// Struct with all information about dynamic [sub]class needed to set vptr.
1867 const CXXRecordDecl *NearestVBase;
1868 CharUnits OffsetFromNearestVBase;
1869 const CXXRecordDecl *VTableClass;
1872 /// Initialize the vtable pointer of the given subobject.
1873 void InitializeVTablePointer(const VPtr &vptr);
1875 typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
1877 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1878 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
1880 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
1881 CharUnits OffsetFromNearestVBase,
1882 bool BaseIsNonVirtualPrimaryBase,
1883 const CXXRecordDecl *VTableClass,
1884 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
1886 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
1888 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1890 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
1891 const CXXRecordDecl *VTableClass);
1893 enum CFITypeCheckKind {
1897 CFITCK_UnrelatedCast,
1903 /// Derived is the presumed address of an object of type T after a
1904 /// cast. If T is a polymorphic class type, emit a check that the virtual
1905 /// table for Derived belongs to a class derived from T.
1906 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
1907 bool MayBeNull, CFITypeCheckKind TCK,
1908 SourceLocation Loc);
1910 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
1911 /// If vptr CFI is enabled, emit a check that VTable is valid.
1912 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
1913 CFITypeCheckKind TCK, SourceLocation Loc);
1915 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
1916 /// RD using llvm.type.test.
1917 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
1918 CFITypeCheckKind TCK, SourceLocation Loc);
1920 /// If whole-program virtual table optimization is enabled, emit an assumption
1921 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
1922 /// enabled, emit a check that VTable is a member of RD's type identifier.
1923 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
1924 llvm::Value *VTable, SourceLocation Loc);
1926 /// Returns whether we should perform a type checked load when loading a
1927 /// virtual function for virtual calls to members of RD. This is generally
1928 /// true when both vcall CFI and whole-program-vtables are enabled.
1929 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
1931 /// Emit a type checked load from the given vtable.
1932 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
1933 uint64_t VTableByteOffset);
1935 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1936 /// given phase of destruction for a destructor. The end result
1937 /// should call destructors on members and base classes in reverse
1938 /// order of their construction.
1939 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
1941 /// ShouldInstrumentFunction - Return true if the current function should be
1942 /// instrumented with __cyg_profile_func_* calls
1943 bool ShouldInstrumentFunction();
1945 /// ShouldXRayInstrument - Return true if the current function should be
1946 /// instrumented with XRay nop sleds.
1947 bool ShouldXRayInstrumentFunction() const;
1949 /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
1950 /// XRay custom event handling calls.
1951 bool AlwaysEmitXRayCustomEvents() const;
1953 /// AlwaysEmitXRayTypedEvents - Return true if clang must unconditionally emit
1954 /// XRay typed event handling calls.
1955 bool AlwaysEmitXRayTypedEvents() const;
1957 /// Encode an address into a form suitable for use in a function prologue.
1958 llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
1959 llvm::Constant *Addr);
1961 /// Decode an address used in a function prologue, encoded by \c
1962 /// EncodeAddrForUseInPrologue.
1963 llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
1964 llvm::Value *EncodedAddr);
1966 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1967 /// arguments for the given function. This is also responsible for naming the
1968 /// LLVM function arguments.
1969 void EmitFunctionProlog(const CGFunctionInfo &FI,
1971 const FunctionArgList &Args);
1973 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1974 /// given temporary.
1975 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
1976 SourceLocation EndLoc);
1978 /// Emit a test that checks if the return value \p RV is nonnull.
1979 void EmitReturnValueCheck(llvm::Value *RV);
1981 /// EmitStartEHSpec - Emit the start of the exception spec.
1982 void EmitStartEHSpec(const Decl *D);
1984 /// EmitEndEHSpec - Emit the end of the exception spec.
1985 void EmitEndEHSpec(const Decl *D);
1987 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1988 llvm::BasicBlock *getTerminateLandingPad();
1990 /// getTerminateLandingPad - Return a cleanup funclet that just calls
1992 llvm::BasicBlock *getTerminateFunclet();
1994 /// getTerminateHandler - Return a handler (not a landing pad, just
1995 /// a catch handler) that just calls terminate. This is used when
1996 /// a terminate scope encloses a try.
1997 llvm::BasicBlock *getTerminateHandler();
1999 llvm::Type *ConvertTypeForMem(QualType T);
2000 llvm::Type *ConvertType(QualType T);
2001 llvm::Type *ConvertType(const TypeDecl *T) {
2002 return ConvertType(getContext().getTypeDeclType(T));
2005 /// LoadObjCSelf - Load the value of self. This function is only valid while
2006 /// generating code for an Objective-C method.
2007 llvm::Value *LoadObjCSelf();
2009 /// TypeOfSelfObject - Return type of object that this self represents.
2010 QualType TypeOfSelfObject();
2012 /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
2013 static TypeEvaluationKind getEvaluationKind(QualType T);
2015 static bool hasScalarEvaluationKind(QualType T) {
2016 return getEvaluationKind(T) == TEK_Scalar;
2019 static bool hasAggregateEvaluationKind(QualType T) {
2020 return getEvaluationKind(T) == TEK_Aggregate;
2023 /// createBasicBlock - Create an LLVM basic block.
2024 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
2025 llvm::Function *parent = nullptr,
2026 llvm::BasicBlock *before = nullptr) {
2027 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
2030 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
2032 JumpDest getJumpDestForLabel(const LabelDecl *S);
2034 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
2035 /// another basic block, simplify it. This assumes that no other code could
2036 /// potentially reference the basic block.
2037 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
2039 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
2040 /// adding a fall-through branch from the current insert block if
2041 /// necessary. It is legal to call this function even if there is no current
2042 /// insertion point.
2044 /// IsFinished - If true, indicates that the caller has finished emitting
2045 /// branches to the given block and does not expect to emit code into it. This
2046 /// means the block can be ignored if it is unreachable.
2047 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
2049 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
2050 /// near its uses, and leave the insertion point in it.
2051 void EmitBlockAfterUses(llvm::BasicBlock *BB);
2053 /// EmitBranch - Emit a branch to the specified basic block from the current
2054 /// insert block, taking care to avoid creation of branches from dummy
2055 /// blocks. It is legal to call this function even if there is no current
2056 /// insertion point.
2058 /// This function clears the current insertion point. The caller should follow
2059 /// calls to this function with calls to Emit*Block prior to generation new
2061 void EmitBranch(llvm::BasicBlock *Block);
2063 /// HaveInsertPoint - True if an insertion point is defined. If not, this
2064 /// indicates that the current code being emitted is unreachable.
2065 bool HaveInsertPoint() const {
2066 return Builder.GetInsertBlock() != nullptr;
2069 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
2070 /// emitted IR has a place to go. Note that by definition, if this function
2071 /// creates a block then that block is unreachable; callers may do better to
2072 /// detect when no insertion point is defined and simply skip IR generation.
2073 void EnsureInsertPoint() {
2074 if (!HaveInsertPoint())
2075 EmitBlock(createBasicBlock());
2078 /// ErrorUnsupported - Print out an error that codegen doesn't support the
2079 /// specified stmt yet.
2080 void ErrorUnsupported(const Stmt *S, const char *Type);
2082 //===--------------------------------------------------------------------===//
2084 //===--------------------------------------------------------------------===//
2086 LValue MakeAddrLValue(Address Addr, QualType T,
2087 AlignmentSource Source = AlignmentSource::Type) {
2088 return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
2089 CGM.getTBAAAccessInfo(T));
2092 LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
2093 TBAAAccessInfo TBAAInfo) {
2094 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
2097 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
2098 AlignmentSource Source = AlignmentSource::Type) {
2099 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
2100 LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
2103 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
2104 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
2105 return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
2106 BaseInfo, TBAAInfo);
2109 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
2110 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
2111 CharUnits getNaturalTypeAlignment(QualType T,
2112 LValueBaseInfo *BaseInfo = nullptr,
2113 TBAAAccessInfo *TBAAInfo = nullptr,
2114 bool forPointeeType = false);
2115 CharUnits getNaturalPointeeTypeAlignment(QualType T,
2116 LValueBaseInfo *BaseInfo = nullptr,
2117 TBAAAccessInfo *TBAAInfo = nullptr);
2119 Address EmitLoadOfReference(LValue RefLVal,
2120 LValueBaseInfo *PointeeBaseInfo = nullptr,
2121 TBAAAccessInfo *PointeeTBAAInfo = nullptr);
2122 LValue EmitLoadOfReferenceLValue(LValue RefLVal);
2123 LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
2124 AlignmentSource Source =
2125 AlignmentSource::Type) {
2126 LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
2127 CGM.getTBAAAccessInfo(RefTy));
2128 return EmitLoadOfReferenceLValue(RefLVal);
2131 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
2132 LValueBaseInfo *BaseInfo = nullptr,
2133 TBAAAccessInfo *TBAAInfo = nullptr);
2134 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
2136 /// CreateTempAlloca - This creates an alloca and inserts it into the entry
2137 /// block if \p ArraySize is nullptr, otherwise inserts it at the current
2138 /// insertion point of the builder. The caller is responsible for setting an
2139 /// appropriate alignment on
2142 /// \p ArraySize is the number of array elements to be allocated if it
2145 /// LangAS::Default is the address space of pointers to local variables and
2146 /// temporaries, as exposed in the source language. In certain
2147 /// configurations, this is not the same as the alloca address space, and a
2148 /// cast is needed to lift the pointer from the alloca AS into
2149 /// LangAS::Default. This can happen when the target uses a restricted
2150 /// address space for the stack but the source language requires
2151 /// LangAS::Default to be a generic address space. The latter condition is
2152 /// common for most programming languages; OpenCL is an exception in that
2153 /// LangAS::Default is the private address space, which naturally maps
2156 /// Because the address of a temporary is often exposed to the program in
2157 /// various ways, this function will perform the cast. The original alloca
2158 /// instruction is returned through \p Alloca if it is not nullptr.
2160 /// The cast is not performaed in CreateTempAllocaWithoutCast. This is
2161 /// more efficient if the caller knows that the address will not be exposed.
2162 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
2163 llvm::Value *ArraySize = nullptr);
2164 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
2165 const Twine &Name = "tmp",
2166 llvm::Value *ArraySize = nullptr,
2167 Address *Alloca = nullptr);
2168 Address CreateTempAllocaWithoutCast(llvm::Type *Ty, CharUnits align,
2169 const Twine &Name = "tmp",
2170 llvm::Value *ArraySize = nullptr);
2172 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
2173 /// default ABI alignment of the given LLVM type.
2175 /// IMPORTANT NOTE: This is *not* generally the right alignment for
2176 /// any given AST type that happens to have been lowered to the
2177 /// given IR type. This should only ever be used for function-local,
2178 /// IR-driven manipulations like saving and restoring a value. Do
2179 /// not hand this address off to arbitrary IRGen routines, and especially
2180 /// do not pass it as an argument to a function that might expect a
2181 /// properly ABI-aligned value.
2182 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
2183 const Twine &Name = "tmp");
2185 /// InitTempAlloca - Provide an initial value for the given alloca which
2186 /// will be observable at all locations in the function.
2188 /// The address should be something that was returned from one of
2189 /// the CreateTempAlloca or CreateMemTemp routines, and the
2190 /// initializer must be valid in the entry block (i.e. it must
2191 /// either be a constant or an argument value).
2192 void InitTempAlloca(Address Alloca, llvm::Value *Value);
2194 /// CreateIRTemp - Create a temporary IR object of the given type, with
2195 /// appropriate alignment. This routine should only be used when an temporary
2196 /// value needs to be stored into an alloca (for example, to avoid explicit
2197 /// PHI construction), but the type is the IR type, not the type appropriate
2198 /// for storing in memory.
2200 /// That is, this is exactly equivalent to CreateMemTemp, but calling
2201 /// ConvertType instead of ConvertTypeForMem.
2202 Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
2204 /// CreateMemTemp - Create a temporary memory object of the given type, with
2205 /// appropriate alignmen and cast it to the default address space. Returns
2206 /// the original alloca instruction by \p Alloca if it is not nullptr.
2207 Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
2208 Address *Alloca = nullptr);
2209 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
2210 Address *Alloca = nullptr);
2212 /// CreateMemTemp - Create a temporary memory object of the given type, with
2213 /// appropriate alignmen without casting it to the default address space.
2214 Address CreateMemTempWithoutCast(QualType T, const Twine &Name = "tmp");
2215 Address CreateMemTempWithoutCast(QualType T, CharUnits Align,
2216 const Twine &Name = "tmp");
2218 /// CreateAggTemp - Create a temporary memory object for the given
2220 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
2221 return AggValueSlot::forAddr(CreateMemTemp(T, Name),
2223 AggValueSlot::IsNotDestructed,
2224 AggValueSlot::DoesNotNeedGCBarriers,
2225 AggValueSlot::IsNotAliased,
2226 AggValueSlot::DoesNotOverlap);
2229 /// Emit a cast to void* in the appropriate address space.
2230 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
2232 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
2233 /// expression and compare the result against zero, returning an Int1Ty value.
2234 llvm::Value *EvaluateExprAsBool(const Expr *E);
2236 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
2237 void EmitIgnoredExpr(const Expr *E);
2239 /// EmitAnyExpr - Emit code to compute the specified expression which can have
2240 /// any type. The result is returned as an RValue struct. If this is an
2241 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
2242 /// the result should be returned.
2244 /// \param ignoreResult True if the resulting value isn't used.
2245 RValue EmitAnyExpr(const Expr *E,
2246 AggValueSlot aggSlot = AggValueSlot::ignored(),
2247 bool ignoreResult = false);
2249 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
2250 // or the value of the expression, depending on how va_list is defined.
2251 Address EmitVAListRef(const Expr *E);
2253 /// Emit a "reference" to a __builtin_ms_va_list; this is
2254 /// always the value of the expression, because a __builtin_ms_va_list is a
2255 /// pointer to a char.
2256 Address EmitMSVAListRef(const Expr *E);
2258 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
2259 /// always be accessible even if no aggregate location is provided.
2260 RValue EmitAnyExprToTemp(const Expr *E);
2262 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
2263 /// arbitrary expression into the given memory location.
2264 void EmitAnyExprToMem(const Expr *E, Address Location,
2265 Qualifiers Quals, bool IsInitializer);
2267 void EmitAnyExprToExn(const Expr *E, Address Addr);
2269 /// EmitExprAsInit - Emits the code necessary to initialize a
2270 /// location in memory with the given initializer.
2271 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
2272 bool capturedByInit);
2274 /// hasVolatileMember - returns true if aggregate type has a volatile
2276 bool hasVolatileMember(QualType T) {
2277 if (const RecordType *RT = T->getAs<RecordType>()) {
2278 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2279 return RD->hasVolatileMember();
2284 /// Determine whether a return value slot may overlap some other object.
2285 AggValueSlot::Overlap_t overlapForReturnValue() {
2286 // FIXME: Assuming no overlap here breaks guaranteed copy elision for base
2287 // class subobjects. These cases may need to be revisited depending on the
2288 // resolution of the relevant core issue.
2289 return AggValueSlot::DoesNotOverlap;
2292 /// Determine whether a field initialization may overlap some other object.
2293 AggValueSlot::Overlap_t overlapForFieldInit(const FieldDecl *FD) {
2294 // FIXME: These cases can result in overlap as a result of P0840R0's
2295 // [[no_unique_address]] attribute. We can still infer NoOverlap in the
2296 // presence of that attribute if the field is within the nvsize of its
2297 // containing class, because non-virtual subobjects are initialized in
2299 return AggValueSlot::DoesNotOverlap;
2302 /// Determine whether a base class initialization may overlap some other
2304 AggValueSlot::Overlap_t overlapForBaseInit(const CXXRecordDecl *RD,
2305 const CXXRecordDecl *BaseRD,
2308 /// Emit an aggregate assignment.
2309 void EmitAggregateAssign(LValue Dest, LValue Src, QualType EltTy) {
2310 bool IsVolatile = hasVolatileMember(EltTy);
2311 EmitAggregateCopy(Dest, Src, EltTy, AggValueSlot::MayOverlap, IsVolatile);
2314 void EmitAggregateCopyCtor(LValue Dest, LValue Src,
2315 AggValueSlot::Overlap_t MayOverlap) {
2316 EmitAggregateCopy(Dest, Src, Src.getType(), MayOverlap);
2319 /// EmitAggregateCopy - Emit an aggregate copy.
2321 /// \param isVolatile \c true iff either the source or the destination is
2323 /// \param MayOverlap Whether the tail padding of the destination might be
2324 /// occupied by some other object. More efficient code can often be
2325 /// generated if not.
2326 void EmitAggregateCopy(LValue Dest, LValue Src, QualType EltTy,
2327 AggValueSlot::Overlap_t MayOverlap,
2328 bool isVolatile = false);
2330 /// GetAddrOfLocalVar - Return the address of a local variable.
2331 Address GetAddrOfLocalVar(const VarDecl *VD) {
2332 auto it = LocalDeclMap.find(VD);
2333 assert(it != LocalDeclMap.end() &&
2334 "Invalid argument to GetAddrOfLocalVar(), no decl!");
2338 /// Given an opaque value expression, return its LValue mapping if it exists,
2339 /// otherwise create one.
2340 LValue getOrCreateOpaqueLValueMapping(const OpaqueValueExpr *e);
2342 /// Given an opaque value expression, return its RValue mapping if it exists,
2343 /// otherwise create one.
2344 RValue getOrCreateOpaqueRValueMapping(const OpaqueValueExpr *e);
2346 /// Get the index of the current ArrayInitLoopExpr, if any.
2347 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
2349 /// getAccessedFieldNo - Given an encoded value and a result number, return
2350 /// the input field number being accessed.
2351 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
2353 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
2354 llvm::BasicBlock *GetIndirectGotoBlock();
2356 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
2357 static bool IsWrappedCXXThis(const Expr *E);
2359 /// EmitNullInitialization - Generate code to set a value of the given type to
2360 /// null, If the type contains data member pointers, they will be initialized
2361 /// to -1 in accordance with the Itanium C++ ABI.
2362 void EmitNullInitialization(Address DestPtr, QualType Ty);
2364 /// Emits a call to an LLVM variable-argument intrinsic, either
2365 /// \c llvm.va_start or \c llvm.va_end.
2366 /// \param ArgValue A reference to the \c va_list as emitted by either
2367 /// \c EmitVAListRef or \c EmitMSVAListRef.
2368 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
2369 /// calls \c llvm.va_end.
2370 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
2372 /// Generate code to get an argument from the passed in pointer
2373 /// and update it accordingly.
2374 /// \param VE The \c VAArgExpr for which to generate code.
2375 /// \param VAListAddr Receives a reference to the \c va_list as emitted by
2376 /// either \c EmitVAListRef or \c EmitMSVAListRef.
2377 /// \returns A pointer to the argument.
2378 // FIXME: We should be able to get rid of this method and use the va_arg
2379 // instruction in LLVM instead once it works well enough.
2380 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
2382 /// emitArrayLength - Compute the length of an array, even if it's a
2383 /// VLA, and drill down to the base element type.
2384 llvm::Value *emitArrayLength(const ArrayType *arrayType,
2388 /// EmitVLASize - Capture all the sizes for the VLA expressions in
2389 /// the given variably-modified type and store them in the VLASizeMap.
2391 /// This function can be called with a null (unreachable) insert point.
2392 void EmitVariablyModifiedType(QualType Ty);
2394 struct VlaSizePair {
2395 llvm::Value *NumElts;
2398 VlaSizePair(llvm::Value *NE, QualType T) : NumElts(NE), Type(T) {}
2401 /// Return the number of elements for a single dimension
2402 /// for the given array type.
2403 VlaSizePair getVLAElements1D(const VariableArrayType *vla);
2404 VlaSizePair getVLAElements1D(QualType vla);
2406 /// Returns an LLVM value that corresponds to the size,
2407 /// in non-variably-sized elements, of a variable length array type,
2408 /// plus that largest non-variably-sized element type. Assumes that
2409 /// the type has already been emitted with EmitVariablyModifiedType.
2410 VlaSizePair getVLASize(const VariableArrayType *vla);
2411 VlaSizePair getVLASize(QualType vla);
2413 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
2414 /// generating code for an C++ member function.
2415 llvm::Value *LoadCXXThis() {
2416 assert(CXXThisValue && "no 'this' value for this function");
2417 return CXXThisValue;
2419 Address LoadCXXThisAddress();
2421 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
2423 // FIXME: Every place that calls LoadCXXVTT is something
2424 // that needs to be abstracted properly.
2425 llvm::Value *LoadCXXVTT() {
2426 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
2427 return CXXStructorImplicitParamValue;
2430 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
2431 /// complete class to the given direct base.
2433 GetAddressOfDirectBaseInCompleteClass(Address Value,
2434 const CXXRecordDecl *Derived,
2435 const CXXRecordDecl *Base,
2436 bool BaseIsVirtual);
2438 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
2440 /// GetAddressOfBaseClass - This function will add the necessary delta to the
2441 /// load of 'this' and returns address of the base class.
2442 Address GetAddressOfBaseClass(Address Value,
2443 const CXXRecordDecl *Derived,
2444 CastExpr::path_const_iterator PathBegin,
2445 CastExpr::path_const_iterator PathEnd,
2446 bool NullCheckValue, SourceLocation Loc);
2448 Address GetAddressOfDerivedClass(Address Value,
2449 const CXXRecordDecl *Derived,
2450 CastExpr::path_const_iterator PathBegin,
2451 CastExpr::path_const_iterator PathEnd,
2452 bool NullCheckValue);
2454 /// GetVTTParameter - Return the VTT parameter that should be passed to a
2455 /// base constructor/destructor with virtual bases.
2456 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
2457 /// to ItaniumCXXABI.cpp together with all the references to VTT.
2458 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
2461 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
2462 CXXCtorType CtorType,
2463 const FunctionArgList &Args,
2464 SourceLocation Loc);
2465 // It's important not to confuse this and the previous function. Delegating
2466 // constructors are the C++0x feature. The constructor delegate optimization
2467 // is used to reduce duplication in the base and complete consturctors where
2468 // they are substantially the same.
2469 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2470 const FunctionArgList &Args);
2472 /// Emit a call to an inheriting constructor (that is, one that invokes a
2473 /// constructor inherited from a base class) by inlining its definition. This
2474 /// is necessary if the ABI does not support forwarding the arguments to the
2475 /// base class constructor (because they're variadic or similar).
2476 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
2477 CXXCtorType CtorType,
2478 bool ForVirtualBase,
2482 /// Emit a call to a constructor inherited from a base class, passing the
2483 /// current constructor's arguments along unmodified (without even making
2485 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
2486 bool ForVirtualBase, Address This,
2487 bool InheritedFromVBase,
2488 const CXXInheritedCtorInitExpr *E);
2490 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2491 bool ForVirtualBase, bool Delegating,
2492 Address This, const CXXConstructExpr *E,
2493 AggValueSlot::Overlap_t Overlap);
2495 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
2496 bool ForVirtualBase, bool Delegating,
2497 Address This, CallArgList &Args,
2498 AggValueSlot::Overlap_t Overlap,
2499 SourceLocation Loc);
2501 /// Emit assumption load for all bases. Requires to be be called only on
2502 /// most-derived class and not under construction of the object.
2503 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
2505 /// Emit assumption that vptr load == global vtable.
2506 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
2508 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
2509 Address This, Address Src,
2510 const CXXConstructExpr *E);
2512 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2513 const ArrayType *ArrayTy,
2515 const CXXConstructExpr *E,
2516 bool ZeroInitialization = false);
2518 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2519 llvm::Value *NumElements,
2521 const CXXConstructExpr *E,
2522 bool ZeroInitialization = false);
2524 static Destroyer destroyCXXObject;
2526 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
2527 bool ForVirtualBase, bool Delegating,
2530 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
2531 llvm::Type *ElementTy, Address NewPtr,
2532 llvm::Value *NumElements,
2533 llvm::Value *AllocSizeWithoutCookie);
2535 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
2538 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
2539 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
2541 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
2542 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
2544 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
2545 QualType DeleteTy, llvm::Value *NumElements = nullptr,
2546 CharUnits CookieSize = CharUnits());
2548 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
2549 const CallExpr *TheCallExpr, bool IsDelete);
2551 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
2552 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
2553 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
2555 /// Situations in which we might emit a check for the suitability of a
2556 /// pointer or glvalue.
2557 enum TypeCheckKind {
2558 /// Checking the operand of a load. Must be suitably sized and aligned.
2560 /// Checking the destination of a store. Must be suitably sized and aligned.
2562 /// Checking the bound value in a reference binding. Must be suitably sized
2563 /// and aligned, but is not required to refer to an object (until the
2564 /// reference is used), per core issue 453.
2565 TCK_ReferenceBinding,
2566 /// Checking the object expression in a non-static data member access. Must
2567 /// be an object within its lifetime.
2569 /// Checking the 'this' pointer for a call to a non-static member function.
2570 /// Must be an object within its lifetime.
2572 /// Checking the 'this' pointer for a constructor call.
2573 TCK_ConstructorCall,
2574 /// Checking the operand of a static_cast to a derived pointer type. Must be
2575 /// null or an object within its lifetime.
2576 TCK_DowncastPointer,
2577 /// Checking the operand of a static_cast to a derived reference type. Must
2578 /// be an object within its lifetime.
2579 TCK_DowncastReference,
2580 /// Checking the operand of a cast to a base object. Must be suitably sized
2583 /// Checking the operand of a cast to a virtual base object. Must be an
2584 /// object within its lifetime.
2585 TCK_UpcastToVirtualBase,
2586 /// Checking the value assigned to a _Nonnull pointer. Must not be null.
2588 /// Checking the operand of a dynamic_cast or a typeid expression. Must be
2589 /// null or an object within its lifetime.
2590 TCK_DynamicOperation
2593 /// Determine whether the pointer type check \p TCK permits null pointers.
2594 static bool isNullPointerAllowed(TypeCheckKind TCK);
2596 /// Determine whether the pointer type check \p TCK requires a vptr check.
2597 static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
2599 /// Whether any type-checking sanitizers are enabled. If \c false,
2600 /// calls to EmitTypeCheck can be skipped.
2601 bool sanitizePerformTypeCheck() const;
2603 /// Emit a check that \p V is the address of storage of the
2604 /// appropriate size and alignment for an object of type \p Type.
2605 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
2606 QualType Type, CharUnits Alignment = CharUnits::Zero(),
2607 SanitizerSet SkippedChecks = SanitizerSet());
2609 /// Emit a check that \p Base points into an array object, which
2610 /// we can access at index \p Index. \p Accessed should be \c false if we
2611 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2612 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2613 QualType IndexType, bool Accessed);
2615 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2616 bool isInc, bool isPre);
2617 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2618 bool isInc, bool isPre);
2620 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
2621 llvm::Value *OffsetValue = nullptr) {
2622 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2626 /// Converts Location to a DebugLoc, if debug information is enabled.
2627 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
2630 //===--------------------------------------------------------------------===//
2631 // Declaration Emission
2632 //===--------------------------------------------------------------------===//
2634 /// EmitDecl - Emit a declaration.
2636 /// This function can be called with a null (unreachable) insert point.
2637 void EmitDecl(const Decl &D);
2639 /// EmitVarDecl - Emit a local variable declaration.
2641 /// This function can be called with a null (unreachable) insert point.
2642 void EmitVarDecl(const VarDecl &D);
2644 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
2645 bool capturedByInit);
2647 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2648 llvm::Value *Address);
2650 /// Determine whether the given initializer is trivial in the sense
2651 /// that it requires no code to be generated.
2652 bool isTrivialInitializer(const Expr *Init);
2654 /// EmitAutoVarDecl - Emit an auto variable declaration.
2656 /// This function can be called with a null (unreachable) insert point.
2657 void EmitAutoVarDecl(const VarDecl &D);
2659 class AutoVarEmission {
2660 friend class CodeGenFunction;
2662 const VarDecl *Variable;
2664 /// The address of the alloca for languages with explicit address space
2665 /// (e.g. OpenCL) or alloca casted to generic pointer for address space
2666 /// agnostic languages (e.g. C++). Invalid if the variable was emitted
2667 /// as a global constant.
2670 llvm::Value *NRVOFlag;
2672 /// True if the variable is a __block variable.
2675 /// True if the variable is of aggregate type and has a constant
2677 bool IsConstantAggregate;
2679 /// Non-null if we should use lifetime annotations.
2680 llvm::Value *SizeForLifetimeMarkers;
2682 /// Address with original alloca instruction. Invalid if the variable was
2683 /// emitted as a global constant.
2687 AutoVarEmission(Invalid)
2688 : Variable(nullptr), Addr(Address::invalid()),
2689 AllocaAddr(Address::invalid()) {}
2691 AutoVarEmission(const VarDecl &variable)
2692 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
2693 IsByRef(false), IsConstantAggregate(false),
2694 SizeForLifetimeMarkers(nullptr), AllocaAddr(Address::invalid()) {}
2696 bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
2699 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2701 bool useLifetimeMarkers() const {
2702 return SizeForLifetimeMarkers != nullptr;
2704 llvm::Value *getSizeForLifetimeMarkers() const {
2705 assert(useLifetimeMarkers());
2706 return SizeForLifetimeMarkers;
2709 /// Returns the raw, allocated address, which is not necessarily
2710 /// the address of the object itself. It is casted to default
2711 /// address space for address space agnostic languages.
2712 Address getAllocatedAddress() const {
2716 /// Returns the address for the original alloca instruction.
2717 Address getOriginalAllocatedAddress() const { return AllocaAddr; }
2719 /// Returns the address of the object within this declaration.
2720 /// Note that this does not chase the forwarding pointer for
2722 Address getObjectAddress(CodeGenFunction &CGF) const {
2723 if (!IsByRef) return Addr;
2725 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
2728 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2729 void EmitAutoVarInit(const AutoVarEmission &emission);
2730 void EmitAutoVarCleanups(const AutoVarEmission &emission);
2731 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2732 QualType::DestructionKind dtorKind);
2734 /// Emits the alloca and debug information for the size expressions for each
2735 /// dimension of an array. It registers the association of its (1-dimensional)
2736 /// QualTypes and size expression's debug node, so that CGDebugInfo can
2737 /// reference this node when creating the DISubrange object to describe the
2739 void EmitAndRegisterVariableArrayDimensions(CGDebugInfo *DI,
2741 bool EmitDebugInfo);
2743 void EmitStaticVarDecl(const VarDecl &D,
2744 llvm::GlobalValue::LinkageTypes Linkage);
2749 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
2751 static ParamValue forDirect(llvm::Value *value) {
2752 return ParamValue(value, 0);
2754 static ParamValue forIndirect(Address addr) {
2755 assert(!addr.getAlignment().isZero());
2756 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
2759 bool isIndirect() const { return Alignment != 0; }
2760 llvm::Value *getAnyValue() const { return Value; }
2762 llvm::Value *getDirectValue() const {
2763 assert(!isIndirect());
2767 Address getIndirectAddress() const {
2768 assert(isIndirect());
2769 return Address(Value, CharUnits::fromQuantity(Alignment));
2773 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
2774 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
2776 /// protectFromPeepholes - Protect a value that we're intending to
2777 /// store to the side, but which will probably be used later, from
2778 /// aggressive peepholing optimizations that might delete it.
2780 /// Pass the result to unprotectFromPeepholes to declare that
2781 /// protection is no longer required.
2783 /// There's no particular reason why this shouldn't apply to
2784 /// l-values, it's just that no existing peepholes work on pointers.
2785 PeepholeProtection protectFromPeepholes(RValue rvalue);
2786 void unprotectFromPeepholes(PeepholeProtection protection);
2788 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
2789 llvm::Value *OffsetValue = nullptr) {
2790 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
2794 //===--------------------------------------------------------------------===//
2795 // Statement Emission
2796 //===--------------------------------------------------------------------===//
2798 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
2799 void EmitStopPoint(const Stmt *S);
2801 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2802 /// this function even if there is no current insertion point.
2804 /// This function may clear the current insertion point; callers should use
2805 /// EnsureInsertPoint if they wish to subsequently generate code without first
2806 /// calling EmitBlock, EmitBranch, or EmitStmt.
2807 void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
2809 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
2810 /// necessarily require an insertion point or debug information; typically
2811 /// because the statement amounts to a jump or a container of other
2814 /// \return True if the statement was handled.
2815 bool EmitSimpleStmt(const Stmt *S);
2817 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2818 AggValueSlot AVS = AggValueSlot::ignored());
2819 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2820 bool GetLast = false,
2822 AggValueSlot::ignored());
2824 /// EmitLabel - Emit the block for the given label. It is legal to call this
2825 /// function even if there is no current insertion point.
2826 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
2828 void EmitLabelStmt(const LabelStmt &S);
2829 void EmitAttributedStmt(const AttributedStmt &S);
2830 void EmitGotoStmt(const GotoStmt &S);
2831 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
2832 void EmitIfStmt(const IfStmt &S);
2834 void EmitWhileStmt(const WhileStmt &S,
2835 ArrayRef<const Attr *> Attrs = None);
2836 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
2837 void EmitForStmt(const ForStmt &S,
2838 ArrayRef<const Attr *> Attrs = None);
2839 void EmitReturnStmt(const ReturnStmt &S);
2840 void EmitDeclStmt(const DeclStmt &S);
2841 void EmitBreakStmt(const BreakStmt &S);
2842 void EmitContinueStmt(const ContinueStmt &S);
2843 void EmitSwitchStmt(const SwitchStmt &S);
2844 void EmitDefaultStmt(const DefaultStmt &S);
2845 void EmitCaseStmt(const CaseStmt &S);
2846 void EmitCaseStmtRange(const CaseStmt &S);
2847 void EmitAsmStmt(const AsmStmt &S);
2849 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
2850 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2851 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
2852 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
2853 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
2855 void EmitCoroutineBody(const CoroutineBodyStmt &S);
2856 void EmitCoreturnStmt(const CoreturnStmt &S);
2857 RValue EmitCoawaitExpr(const CoawaitExpr &E,
2858 AggValueSlot aggSlot = AggValueSlot::ignored(),
2859 bool ignoreResult = false);
2860 LValue EmitCoawaitLValue(const CoawaitExpr *E);
2861 RValue EmitCoyieldExpr(const CoyieldExpr &E,
2862 AggValueSlot aggSlot = AggValueSlot::ignored(),
2863 bool ignoreResult = false);
2864 LValue EmitCoyieldLValue(const CoyieldExpr *E);
2865 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
2867 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2868 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2870 void EmitCXXTryStmt(const CXXTryStmt &S);
2871 void EmitSEHTryStmt(const SEHTryStmt &S);
2872 void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
2873 void EnterSEHTryStmt(const SEHTryStmt &S);
2874 void ExitSEHTryStmt(const SEHTryStmt &S);
2876 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
2877 const Stmt *OutlinedStmt);
2879 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
2880 const SEHExceptStmt &Except);
2882 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
2883 const SEHFinallyStmt &Finally);
2885 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
2886 llvm::Value *ParentFP,
2887 llvm::Value *EntryEBP);
2888 llvm::Value *EmitSEHExceptionCode();
2889 llvm::Value *EmitSEHExceptionInfo();
2890 llvm::Value *EmitSEHAbnormalTermination();
2892 /// Emit simple code for OpenMP directives in Simd-only mode.
2893 void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
2895 /// Scan the outlined statement for captures from the parent function. For
2896 /// each capture, mark the capture as escaped and emit a call to
2897 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
2898 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
2901 /// Recovers the address of a local in a parent function. ParentVar is the
2902 /// address of the variable used in the immediate parent function. It can
2903 /// either be an alloca or a call to llvm.localrecover if there are nested
2904 /// outlined functions. ParentFP is the frame pointer of the outermost parent
2906 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
2908 llvm::Value *ParentFP);
2910 void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
2911 ArrayRef<const Attr *> Attrs = None);
2913 /// Controls insertion of cancellation exit blocks in worksharing constructs.
2914 class OMPCancelStackRAII {
2915 CodeGenFunction &CGF;
2918 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
2921 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
2923 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
2926 /// Returns calculated size of the specified type.
2927 llvm::Value *getTypeSize(QualType Ty);
2928 LValue InitCapturedStruct(const CapturedStmt &S);
2929 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
2930 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
2931 Address GenerateCapturedStmtArgument(const CapturedStmt &S);
2932 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
2933 void GenerateOpenMPCapturedVars(const CapturedStmt &S,
2934 SmallVectorImpl<llvm::Value *> &CapturedVars);
2935 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
2936 SourceLocation Loc);
2937 /// Perform element by element copying of arrays with type \a
2938 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
2939 /// generated by \a CopyGen.
2941 /// \param DestAddr Address of the destination array.
2942 /// \param SrcAddr Address of the source array.
2943 /// \param OriginalType Type of destination and source arrays.
2944 /// \param CopyGen Copying procedure that copies value of single array element
2945 /// to another single array element.
2946 void EmitOMPAggregateAssign(
2947 Address DestAddr, Address SrcAddr, QualType OriginalType,
2948 const llvm::function_ref<void(Address, Address)> CopyGen);
2949 /// Emit proper copying of data from one variable to another.
2951 /// \param OriginalType Original type of the copied variables.
2952 /// \param DestAddr Destination address.
2953 /// \param SrcAddr Source address.
2954 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
2955 /// type of the base array element).
2956 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
2957 /// the base array element).
2958 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
2960 void EmitOMPCopy(QualType OriginalType,
2961 Address DestAddr, Address SrcAddr,
2962 const VarDecl *DestVD, const VarDecl *SrcVD,
2964 /// Emit atomic update code for constructs: \a X = \a X \a BO \a E or
2965 /// \a X = \a E \a BO \a E.
2967 /// \param X Value to be updated.
2968 /// \param E Update value.
2969 /// \param BO Binary operation for update operation.
2970 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
2971 /// expression, false otherwise.
2972 /// \param AO Atomic ordering of the generated atomic instructions.
2973 /// \param CommonGen Code generator for complex expressions that cannot be
2974 /// expressed through atomicrmw instruction.
2975 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
2976 /// generated, <false, RValue::get(nullptr)> otherwise.
2977 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
2978 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
2979 llvm::AtomicOrdering AO, SourceLocation Loc,
2980 const llvm::function_ref<RValue(RValue)> CommonGen);
2981 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
2982 OMPPrivateScope &PrivateScope);
2983 void EmitOMPPrivateClause(const OMPExecutableDirective &D,
2984 OMPPrivateScope &PrivateScope);
2985 void EmitOMPUseDevicePtrClause(
2986 const OMPClause &C, OMPPrivateScope &PrivateScope,
2987 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
2988 /// Emit code for copyin clause in \a D directive. The next code is
2989 /// generated at the start of outlined functions for directives:
2991 /// threadprivate_var1 = master_threadprivate_var1;
2992 /// operator=(threadprivate_var2, master_threadprivate_var2);
2994 /// __kmpc_barrier(&loc, global_tid);
2997 /// \param D OpenMP directive possibly with 'copyin' clause(s).
2998 /// \returns true if at least one copyin variable is found, false otherwise.
2999 bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
3000 /// Emit initial code for lastprivate variables. If some variable is
3001 /// not also firstprivate, then the default initialization is used. Otherwise
3002 /// initialization of this variable is performed by EmitOMPFirstprivateClause
3005 /// \param D Directive that may have 'lastprivate' directives.
3006 /// \param PrivateScope Private scope for capturing lastprivate variables for
3007 /// proper codegen in internal captured statement.
3009 /// \returns true if there is at least one lastprivate variable, false
3011 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
3012 OMPPrivateScope &PrivateScope);
3013 /// Emit final copying of lastprivate values to original variables at
3014 /// the end of the worksharing or simd directive.
3016 /// \param D Directive that has at least one 'lastprivate' directives.
3017 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
3018 /// it is the last iteration of the loop code in associated directive, or to
3019 /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
3020 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
3022 llvm::Value *IsLastIterCond = nullptr);
3023 /// Emit initial code for linear clauses.
3024 void EmitOMPLinearClause(const OMPLoopDirective &D,
3025 CodeGenFunction::OMPPrivateScope &PrivateScope);
3026 /// Emit final code for linear clauses.
3027 /// \param CondGen Optional conditional code for final part of codegen for
3029 void EmitOMPLinearClauseFinal(
3030 const OMPLoopDirective &D,
3031 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
3032 /// Emit initial code for reduction variables. Creates reduction copies
3033 /// and initializes them with the values according to OpenMP standard.
3035 /// \param D Directive (possibly) with the 'reduction' clause.
3036 /// \param PrivateScope Private scope for capturing reduction variables for
3037 /// proper codegen in internal captured statement.
3039 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
3040 OMPPrivateScope &PrivateScope);
3041 /// Emit final update of reduction values to original variables at
3042 /// the end of the directive.
3044 /// \param D Directive that has at least one 'reduction' directives.
3045 /// \param ReductionKind The kind of reduction to perform.
3046 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
3047 const OpenMPDirectiveKind ReductionKind);
3048 /// Emit initial code for linear variables. Creates private copies
3049 /// and initializes them with the values according to OpenMP standard.
3051 /// \param D Directive (possibly) with the 'linear' clause.
3052 /// \return true if at least one linear variable is found that should be
3053 /// initialized with the value of the original variable, false otherwise.
3054 bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
3056 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
3057 llvm::Value * /*OutlinedFn*/,
3058 const OMPTaskDataTy & /*Data*/)>
3060 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
3061 const OpenMPDirectiveKind CapturedRegion,
3062 const RegionCodeGenTy &BodyGen,
3063 const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
3064 struct OMPTargetDataInfo {
3065 Address BasePointersArray = Address::invalid();
3066 Address PointersArray = Address::invalid();
3067 Address SizesArray = Address::invalid();
3068 unsigned NumberOfTargetItems = 0;
3069 explicit OMPTargetDataInfo() = default;
3070 OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
3071 Address SizesArray, unsigned NumberOfTargetItems)
3072 : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
3073 SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
3075 void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
3076 const RegionCodeGenTy &BodyGen,
3077 OMPTargetDataInfo &InputInfo);
3079 void EmitOMPParallelDirective(const OMPParallelDirective &S);
3080 void EmitOMPSimdDirective(const OMPSimdDirective &S);
3081 void EmitOMPForDirective(const OMPForDirective &S);
3082 void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
3083 void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
3084 void EmitOMPSectionDirective(const OMPSectionDirective &S);
3085 void EmitOMPSingleDirective(const OMPSingleDirective &S);
3086 void EmitOMPMasterDirective(const OMPMasterDirective &S);
3087 void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
3088 void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
3089 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
3090 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
3091 void EmitOMPTaskDirective(const OMPTaskDirective &S);
3092 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
3093 void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
3094 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
3095 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
3096 void EmitOMPFlushDirective(const OMPFlushDirective &S);
3097 void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
3098 void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
3099 void EmitOMPTargetDirective(const OMPTargetDirective &S);
3100 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
3101 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
3102 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
3103 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
3104 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
3106 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
3107 void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
3109 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
3110 void EmitOMPCancelDirective(const OMPCancelDirective &S);
3111 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
3112 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
3113 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
3114 void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
3115 void EmitOMPDistributeParallelForDirective(
3116 const OMPDistributeParallelForDirective &S);
3117 void EmitOMPDistributeParallelForSimdDirective(
3118 const OMPDistributeParallelForSimdDirective &S);
3119 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
3120 void EmitOMPTargetParallelForSimdDirective(
3121 const OMPTargetParallelForSimdDirective &S);
3122 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
3123 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
3125 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
3126 void EmitOMPTeamsDistributeParallelForSimdDirective(
3127 const OMPTeamsDistributeParallelForSimdDirective &S);
3128 void EmitOMPTeamsDistributeParallelForDirective(
3129 const OMPTeamsDistributeParallelForDirective &S);
3130 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
3131 void EmitOMPTargetTeamsDistributeDirective(
3132 const OMPTargetTeamsDistributeDirective &S);
3133 void EmitOMPTargetTeamsDistributeParallelForDirective(
3134 const OMPTargetTeamsDistributeParallelForDirective &S);
3135 void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
3136 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
3137 void EmitOMPTargetTeamsDistributeSimdDirective(
3138 const OMPTargetTeamsDistributeSimdDirective &S);
3140 /// Emit device code for the target directive.
3141 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
3142 StringRef ParentName,
3143 const OMPTargetDirective &S);
3145 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3146 const OMPTargetParallelDirective &S);
3147 /// Emit device code for the target parallel for directive.
3148 static void EmitOMPTargetParallelForDeviceFunction(
3149 CodeGenModule &CGM, StringRef ParentName,
3150 const OMPTargetParallelForDirective &S);
3151 /// Emit device code for the target parallel for simd directive.
3152 static void EmitOMPTargetParallelForSimdDeviceFunction(
3153 CodeGenModule &CGM, StringRef ParentName,
3154 const OMPTargetParallelForSimdDirective &S);
3155 /// Emit device code for the target teams directive.
3157 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
3158 const OMPTargetTeamsDirective &S);
3159 /// Emit device code for the target teams distribute directive.
3160 static void EmitOMPTargetTeamsDistributeDeviceFunction(
3161 CodeGenModule &CGM, StringRef ParentName,
3162 const OMPTargetTeamsDistributeDirective &S);
3163 /// Emit device code for the target teams distribute simd directive.
3164 static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
3165 CodeGenModule &CGM, StringRef ParentName,
3166 const OMPTargetTeamsDistributeSimdDirective &S);
3167 /// Emit device code for the target simd directive.
3168 static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
3169 StringRef ParentName,
3170 const OMPTargetSimdDirective &S);
3171 /// Emit device code for the target teams distribute parallel for simd
3173 static void EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
3174 CodeGenModule &CGM, StringRef ParentName,
3175 const OMPTargetTeamsDistributeParallelForSimdDirective &S);
3177 static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
3178 CodeGenModule &CGM, StringRef ParentName,
3179 const OMPTargetTeamsDistributeParallelForDirective &S);
3180 /// Emit inner loop of the worksharing/simd construct.
3182 /// \param S Directive, for which the inner loop must be emitted.
3183 /// \param RequiresCleanup true, if directive has some associated private
3185 /// \param LoopCond Bollean condition for loop continuation.
3186 /// \param IncExpr Increment expression for loop control variable.
3187 /// \param BodyGen Generator for the inner body of the inner loop.
3188 /// \param PostIncGen Genrator for post-increment code (required for ordered
3189 /// loop directvies).
3190 void EmitOMPInnerLoop(
3191 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
3192 const Expr *IncExpr,
3193 const llvm::function_ref<void(CodeGenFunction &)> BodyGen,
3194 const llvm::function_ref<void(CodeGenFunction &)> PostIncGen);
3196 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
3197 /// Emit initial code for loop counters of loop-based directives.
3198 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
3199 OMPPrivateScope &LoopScope);
3201 /// Helper for the OpenMP loop directives.
3202 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
3204 /// Emit code for the worksharing loop-based directive.
3205 /// \return true, if this construct has any lastprivate clause, false -
3207 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
3208 const CodeGenLoopBoundsTy &CodeGenLoopBounds,
3209 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3211 /// Emit code for the distribute loop-based directive.
3212 void EmitOMPDistributeLoop(const OMPLoopDirective &S,
3213 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
3215 /// Helpers for the OpenMP loop directives.
3216 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
3217 void EmitOMPSimdFinal(
3218 const OMPLoopDirective &D,
3219 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> CondGen);
3221 /// Emits the lvalue for the expression with possibly captured variable.
3222 LValue EmitOMPSharedLValue(const Expr *E);
3225 /// Helpers for blocks.
3226 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
3228 /// struct with the values to be passed to the OpenMP loop-related functions
3229 struct OMPLoopArguments {
3230 /// loop lower bound
3231 Address LB = Address::invalid();
3232 /// loop upper bound
3233 Address UB = Address::invalid();
3235 Address ST = Address::invalid();
3236 /// isLastIteration argument for runtime functions
3237 Address IL = Address::invalid();
3238 /// Chunk value generated by sema
3239 llvm::Value *Chunk = nullptr;
3240 /// EnsureUpperBound
3241 Expr *EUB = nullptr;
3242 /// IncrementExpression
3243 Expr *IncExpr = nullptr;
3244 /// Loop initialization
3245 Expr *Init = nullptr;
3246 /// Loop exit condition
3247 Expr *Cond = nullptr;
3248 /// Update of LB after a whole chunk has been executed
3249 Expr *NextLB = nullptr;
3250 /// Update of UB after a whole chunk has been executed
3251 Expr *NextUB = nullptr;
3252 OMPLoopArguments() = default;
3253 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
3254 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
3255 Expr *IncExpr = nullptr, Expr *Init = nullptr,
3256 Expr *Cond = nullptr, Expr *NextLB = nullptr,
3257 Expr *NextUB = nullptr)
3258 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
3259 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
3262 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
3263 const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
3264 const OMPLoopArguments &LoopArgs,
3265 const CodeGenLoopTy &CodeGenLoop,
3266 const CodeGenOrderedTy &CodeGenOrdered);
3267 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
3268 bool IsMonotonic, const OMPLoopDirective &S,
3269 OMPPrivateScope &LoopScope, bool Ordered,
3270 const OMPLoopArguments &LoopArgs,
3271 const CodeGenDispatchBoundsTy &CGDispatchBounds);
3272 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
3273 const OMPLoopDirective &S,
3274 OMPPrivateScope &LoopScope,
3275 const OMPLoopArguments &LoopArgs,
3276 const CodeGenLoopTy &CodeGenLoopContent);
3277 /// Emit code for sections directive.
3278 void EmitSections(const OMPExecutableDirective &S);
3282 //===--------------------------------------------------------------------===//
3283 // LValue Expression Emission
3284 //===--------------------------------------------------------------------===//
3286 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
3287 RValue GetUndefRValue(QualType Ty);
3289 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
3290 /// and issue an ErrorUnsupported style diagnostic (using the
3292 RValue EmitUnsupportedRValue(const Expr *E,
3295 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
3296 /// an ErrorUnsupported style diagnostic (using the provided Name).
3297 LValue EmitUnsupportedLValue(const Expr *E,
3300 /// EmitLValue - Emit code to compute a designator that specifies the location
3301 /// of the expression.
3303 /// This can return one of two things: a simple address or a bitfield
3304 /// reference. In either case, the LLVM Value* in the LValue structure is
3305 /// guaranteed to be an LLVM pointer type.
3307 /// If this returns a bitfield reference, nothing about the pointee type of
3308 /// the LLVM value is known: For example, it may not be a pointer to an
3311 /// If this returns a normal address, and if the lvalue's C type is fixed
3312 /// size, this method guarantees that the returned pointer type will point to
3313 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
3314 /// variable length type, this is not possible.
3316 LValue EmitLValue(const Expr *E);
3318 /// Same as EmitLValue but additionally we generate checking code to
3319 /// guard against undefined behavior. This is only suitable when we know
3320 /// that the address will be used to access the object.
3321 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
3323 RValue convertTempToRValue(Address addr, QualType type,
3324 SourceLocation Loc);
3326 void EmitAtomicInit(Expr *E, LValue lvalue);
3328 bool LValueIsSuitableForInlineAtomic(LValue Src);
3330 RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
3331 AggValueSlot Slot = AggValueSlot::ignored());
3333 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
3334 llvm::AtomicOrdering AO, bool IsVolatile = false,
3335 AggValueSlot slot = AggValueSlot::ignored());
3337 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
3339 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
3340 bool IsVolatile, bool isInit);
3342 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
3343 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
3344 llvm::AtomicOrdering Success =
3345 llvm::AtomicOrdering::SequentiallyConsistent,
3346 llvm::AtomicOrdering Failure =
3347 llvm::AtomicOrdering::SequentiallyConsistent,
3348 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
3350 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
3351 const llvm::function_ref<RValue(RValue)> &UpdateOp,
3354 /// EmitToMemory - Change a scalar value from its value
3355 /// representation to its in-memory representation.
3356 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
3358 /// EmitFromMemory - Change a scalar value from its memory
3359 /// representation to its value representation.
3360 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
3362 /// Check if the scalar \p Value is within the valid range for the given
3365 /// Returns true if a check is needed (even if the range is unknown).
3366 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
3367 SourceLocation Loc);
3369 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3370 /// care to appropriately convert from the memory representation to
3371 /// the LLVM value representation.
3372 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3374 AlignmentSource Source = AlignmentSource::Type,
3375 bool isNontemporal = false) {
3376 return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
3377 CGM.getTBAAAccessInfo(Ty), isNontemporal);
3380 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
3381 SourceLocation Loc, LValueBaseInfo BaseInfo,
3382 TBAAAccessInfo TBAAInfo,
3383 bool isNontemporal = false);
3385 /// EmitLoadOfScalar - Load a scalar value from an address, taking
3386 /// care to appropriately convert from the memory representation to
3387 /// the LLVM value representation. The l-value must be a simple
3389 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
3391 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3392 /// care to appropriately convert from the memory representation to
3393 /// the LLVM value representation.
3394 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3395 bool Volatile, QualType Ty,
3396 AlignmentSource Source = AlignmentSource::Type,
3397 bool isInit = false, bool isNontemporal = false) {
3398 EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
3399 CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
3402 void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
3403 bool Volatile, QualType Ty,
3404 LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
3405 bool isInit = false, bool isNontemporal = false);
3407 /// EmitStoreOfScalar - Store a scalar value to an address, taking
3408 /// care to appropriately convert from the memory representation to
3409 /// the LLVM value representation. The l-value must be a simple
3410 /// l-value. The isInit flag indicates whether this is an initialization.
3411 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
3412 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
3414 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
3415 /// this method emits the address of the lvalue, then loads the result as an
3416 /// rvalue, returning the rvalue.
3417 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
3418 RValue EmitLoadOfExtVectorElementLValue(LValue V);
3419 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
3420 RValue EmitLoadOfGlobalRegLValue(LValue LV);
3422 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
3423 /// lvalue, where both are guaranteed to the have the same type, and that type
3425 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
3426 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
3427 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
3429 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
3430 /// as EmitStoreThroughLValue.
3432 /// \param Result [out] - If non-null, this will be set to a Value* for the
3433 /// bit-field contents after the store, appropriate for use as the result of
3434 /// an assignment to the bit-field.
3435 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
3436 llvm::Value **Result=nullptr);
3438 /// Emit an l-value for an assignment (simple or compound) of complex type.
3439 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
3440 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
3441 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
3442 llvm::Value *&Result);
3444 // Note: only available for agg return types
3445 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
3446 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
3447 // Note: only available for agg return types
3448 LValue EmitCallExprLValue(const CallExpr *E);
3449 // Note: only available for agg return types
3450 LValue EmitVAArgExprLValue(const VAArgExpr *E);
3451 LValue EmitDeclRefLValue(const DeclRefExpr *E);
3452 LValue EmitStringLiteralLValue(const StringLiteral *E);
3453 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
3454 LValue EmitPredefinedLValue(const PredefinedExpr *E);
3455 LValue EmitUnaryOpLValue(const UnaryOperator *E);
3456 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
3457 bool Accessed = false);
3458 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
3459 bool IsLowerBound = true);
3460 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
3461 LValue EmitMemberExpr(const MemberExpr *E);
3462 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
3463 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
3464 LValue EmitInitListLValue(const InitListExpr *E);
3465 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
3466 LValue EmitCastLValue(const CastExpr *E);
3467 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
3468 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
3470 Address EmitExtVectorElementLValue(LValue V);
3472 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
3474 Address EmitArrayToPointerDecay(const Expr *Array,
3475 LValueBaseInfo *BaseInfo = nullptr,
3476 TBAAAccessInfo *TBAAInfo = nullptr);
3478 class ConstantEmission {
3479 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
3480 ConstantEmission(llvm::Constant *C, bool isReference)
3481 : ValueAndIsReference(C, isReference) {}
3483 ConstantEmission() {}
3484 static ConstantEmission forReference(llvm::Constant *C) {
3485 return ConstantEmission(C, true);
3487 static ConstantEmission forValue(llvm::Constant *C) {
3488 return ConstantEmission(C, false);
3491 explicit operator bool() const {
3492 return ValueAndIsReference.getOpaqueValue() != nullptr;
3495 bool isReference() const { return ValueAndIsReference.getInt(); }
3496 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
3497 assert(isReference());
3498 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
3499 refExpr->getType());
3502 llvm::Constant *getValue() const {
3503 assert(!isReference());
3504 return ValueAndIsReference.getPointer();
3508 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
3509 ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
3511 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
3512 AggValueSlot slot = AggValueSlot::ignored());
3513 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
3515 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
3516 const ObjCIvarDecl *Ivar);
3517 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
3518 LValue EmitLValueForLambdaField(const FieldDecl *Field);
3520 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
3521 /// if the Field is a reference, this will return the address of the reference
3522 /// and not the address of the value stored in the reference.
3523 LValue EmitLValueForFieldInitialization(LValue Base,
3524 const FieldDecl* Field);
3526 LValue EmitLValueForIvar(QualType ObjectTy,
3527 llvm::Value* Base, const ObjCIvarDecl *Ivar,
3528 unsigned CVRQualifiers);
3530 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
3531 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
3532 LValue EmitLambdaLValue(const LambdaExpr *E);
3533 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
3534 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
3536 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
3537 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
3538 LValue EmitStmtExprLValue(const StmtExpr *E);
3539 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
3540 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
3541 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
3543 //===--------------------------------------------------------------------===//
3544 // Scalar Expression Emission
3545 //===--------------------------------------------------------------------===//
3547 /// EmitCall - Generate a call of the given function, expecting the given
3548 /// result type, and using the given argument list which specifies both the
3549 /// LLVM arguments and the types they were derived from.
3550 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3551 ReturnValueSlot ReturnValue, const CallArgList &Args,
3552 llvm::Instruction **callOrInvoke, SourceLocation Loc);
3553 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
3554 ReturnValueSlot ReturnValue, const CallArgList &Args,
3555 llvm::Instruction **callOrInvoke = nullptr) {
3556 return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
3559 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
3560 ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
3561 RValue EmitCallExpr(const CallExpr *E,
3562 ReturnValueSlot ReturnValue = ReturnValueSlot());
3563 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3564 CGCallee EmitCallee(const Expr *E);
3566 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
3568 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3569 const Twine &name = "");
3570 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
3571 ArrayRef<llvm::Value*> args,
3572 const Twine &name = "");
3573 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3574 const Twine &name = "");
3575 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
3576 ArrayRef<llvm::Value*> args,
3577 const Twine &name = "");
3579 SmallVector<llvm::OperandBundleDef, 1>
3580 getBundlesForFunclet(llvm::Value *Callee);
3582 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
3583 ArrayRef<llvm::Value *> Args,
3584 const Twine &Name = "");
3585 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3586 ArrayRef<llvm::Value*> args,
3587 const Twine &name = "");
3588 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
3589 const Twine &name = "");
3590 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3591 ArrayRef<llvm::Value*> args);
3593 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
3594 NestedNameSpecifier *Qual,
3597 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
3599 const CXXRecordDecl *RD);
3601 // These functions emit calls to the special functions of non-trivial C
3603 void defaultInitNonTrivialCStructVar(LValue Dst);
3604 void callCStructDefaultConstructor(LValue Dst);
3605 void callCStructDestructor(LValue Dst);
3606 void callCStructCopyConstructor(LValue Dst, LValue Src);
3607 void callCStructMoveConstructor(LValue Dst, LValue Src);
3608 void callCStructCopyAssignmentOperator(LValue Dst, LValue Src);
3609 void callCStructMoveAssignmentOperator(LValue Dst, LValue Src);
3612 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
3613 const CGCallee &Callee,
3614 ReturnValueSlot ReturnValue, llvm::Value *This,
3615 llvm::Value *ImplicitParam,
3616 QualType ImplicitParamTy, const CallExpr *E,
3617 CallArgList *RtlArgs);
3618 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
3619 const CGCallee &Callee,
3620 llvm::Value *This, llvm::Value *ImplicitParam,
3621 QualType ImplicitParamTy, const CallExpr *E,
3623 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
3624 ReturnValueSlot ReturnValue);
3625 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
3626 const CXXMethodDecl *MD,
3627 ReturnValueSlot ReturnValue,
3629 NestedNameSpecifier *Qualifier,
3630 bool IsArrow, const Expr *Base);
3631 // Compute the object pointer.
3632 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
3633 llvm::Value *memberPtr,
3634 const MemberPointerType *memberPtrType,
3635 LValueBaseInfo *BaseInfo = nullptr,
3636 TBAAAccessInfo *TBAAInfo = nullptr);
3637 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
3638 ReturnValueSlot ReturnValue);
3640 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
3641 const CXXMethodDecl *MD,
3642 ReturnValueSlot ReturnValue);
3643 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
3645 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
3646 ReturnValueSlot ReturnValue);
3648 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
3649 ReturnValueSlot ReturnValue);
3651 RValue EmitBuiltinExpr(const FunctionDecl *FD,
3652 unsigned BuiltinID, const CallExpr *E,
3653 ReturnValueSlot ReturnValue);
3655 /// Emit IR for __builtin_os_log_format.
3656 RValue emitBuiltinOSLogFormat(const CallExpr &E);
3658 llvm::Function *generateBuiltinOSLogHelperFunction(
3659 const analyze_os_log::OSLogBufferLayout &Layout,
3660 CharUnits BufferAlignment);
3662 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
3664 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
3665 /// is unhandled by the current target.
3666 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3668 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
3669 const llvm::CmpInst::Predicate Fp,
3670 const llvm::CmpInst::Predicate Ip,
3671 const llvm::Twine &Name = "");
3672 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3673 llvm::Triple::ArchType Arch);
3675 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
3676 unsigned LLVMIntrinsic,
3677 unsigned AltLLVMIntrinsic,
3678 const char *NameHint,
3681 SmallVectorImpl<llvm::Value *> &Ops,
3682 Address PtrOp0, Address PtrOp1,
3683 llvm::Triple::ArchType Arch);
3685 llvm::Value *EmitISOVolatileLoad(const CallExpr *E);
3686 llvm::Value *EmitISOVolatileStore(const CallExpr *E);
3688 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
3689 unsigned Modifier, llvm::Type *ArgTy,
3691 llvm::Value *EmitNeonCall(llvm::Function *F,
3692 SmallVectorImpl<llvm::Value*> &O,
3694 unsigned shift = 0, bool rightshift = false);
3695 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
3696 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
3697 bool negateForRightShift);
3698 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
3699 llvm::Type *Ty, bool usgn, const char *name);
3700 llvm::Value *vectorWrapScalar16(llvm::Value *Op);
3701 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
3702 llvm::Triple::ArchType Arch);
3704 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
3705 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3706 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3707 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3708 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3709 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3710 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
3712 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
3715 enum class MSVCIntrin;
3718 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
3720 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
3722 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
3723 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
3724 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
3725 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
3726 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
3727 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
3728 const ObjCMethodDecl *MethodWithObjects);
3729 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
3730 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
3731 ReturnValueSlot Return = ReturnValueSlot());
3733 /// Retrieves the default cleanup kind for an ARC cleanup.
3734 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
3735 CleanupKind getARCCleanupKind() {
3736 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
3737 ? NormalAndEHCleanup : NormalCleanup;
3741 void EmitARCInitWeak(Address addr, llvm::Value *value);
3742 void EmitARCDestroyWeak(Address addr);
3743 llvm::Value *EmitARCLoadWeak(Address addr);
3744 llvm::Value *EmitARCLoadWeakRetained(Address addr);
3745 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
3746 void emitARCCopyAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3747 void emitARCMoveAssignWeak(QualType Ty, Address DstAddr, Address SrcAddr);
3748 void EmitARCCopyWeak(Address dst, Address src);
3749 void EmitARCMoveWeak(Address dst, Address src);
3750 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
3751 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
3752 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
3753 bool resultIgnored);
3754 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
3755 bool resultIgnored);
3756 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
3757 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
3758 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
3759 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
3760 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
3761 llvm::Value *EmitARCAutorelease(llvm::Value *value);
3762 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
3763 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
3764 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
3765 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
3767 std::pair<LValue,llvm::Value*>
3768 EmitARCStoreAutoreleasing(const BinaryOperator *e);
3769 std::pair<LValue,llvm::Value*>
3770 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
3771 std::pair<LValue,llvm::Value*>
3772 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
3774 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
3775 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
3776 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
3778 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
3779 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
3780 bool allowUnsafeClaim);
3781 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
3782 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
3783 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
3785 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
3787 static Destroyer destroyARCStrongImprecise;
3788 static Destroyer destroyARCStrongPrecise;
3789 static Destroyer destroyARCWeak;
3790 static Destroyer emitARCIntrinsicUse;
3791 static Destroyer destroyNonTrivialCStruct;
3793 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
3794 llvm::Value *EmitObjCAutoreleasePoolPush();
3795 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
3796 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
3797 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
3799 /// Emits a reference binding to the passed in expression.
3800 RValue EmitReferenceBindingToExpr(const Expr *E);
3802 //===--------------------------------------------------------------------===//
3803 // Expression Emission
3804 //===--------------------------------------------------------------------===//
3806 // Expressions are broken into three classes: scalar, complex, aggregate.
3808 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
3809 /// scalar type, returning the result.
3810 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
3812 /// Emit a conversion from the specified type to the specified destination
3813 /// type, both of which are LLVM scalar types.
3814 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
3815 QualType DstTy, SourceLocation Loc);
3817 /// Emit a conversion from the specified complex type to the specified
3818 /// destination type, where the destination type is an LLVM scalar type.
3819 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
3821 SourceLocation Loc);
3823 /// EmitAggExpr - Emit the computation of the specified expression
3824 /// of aggregate type. The result is computed into the given slot,
3825 /// which may be null to indicate that the value is not needed.
3826 void EmitAggExpr(const Expr *E, AggValueSlot AS);
3828 /// EmitAggExprToLValue - Emit the computation of the specified expression of
3829 /// aggregate type into a temporary LValue.
3830 LValue EmitAggExprToLValue(const Expr *E);
3832 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3833 /// make sure it survives garbage collection until this point.
3834 void EmitExtendGCLifetime(llvm::Value *object);
3836 /// EmitComplexExpr - Emit the computation of the specified expression of
3837 /// complex type, returning the result.
3838 ComplexPairTy EmitComplexExpr(const Expr *E,
3839 bool IgnoreReal = false,
3840 bool IgnoreImag = false);
3842 /// EmitComplexExprIntoLValue - Emit the given expression of complex
3843 /// type and place its result into the specified l-value.
3844 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
3846 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
3847 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
3849 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
3850 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
3852 Address emitAddrOfRealComponent(Address complex, QualType complexType);
3853 Address emitAddrOfImagComponent(Address complex, QualType complexType);
3855 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
3856 /// global variable that has already been created for it. If the initializer
3857 /// has a different type than GV does, this may free GV and return a different
3858 /// one. Otherwise it just returns GV.
3859 llvm::GlobalVariable *
3860 AddInitializerToStaticVarDecl(const VarDecl &D,
3861 llvm::GlobalVariable *GV);
3864 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
3865 /// variable with global storage.
3866 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
3869 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
3870 llvm::Constant *Addr);
3872 /// Call atexit() with a function that passes the given argument to
3873 /// the given function.
3874 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
3875 llvm::Constant *addr);
3877 /// Call atexit() with function dtorStub.
3878 void registerGlobalDtorWithAtExit(llvm::Constant *dtorStub);
3880 /// Emit code in this function to perform a guarded variable
3881 /// initialization. Guarded initializations are used when it's not
3882 /// possible to prove that an initialization will be done exactly
3883 /// once, e.g. with a static local variable or a static data member
3884 /// of a class template.
3885 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
3888 enum class GuardKind { VariableGuard, TlsGuard };
3890 /// Emit a branch to select whether or not to perform guarded initialization.
3891 void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
3892 llvm::BasicBlock *InitBlock,
3893 llvm::BasicBlock *NoInitBlock,
3894 GuardKind Kind, const VarDecl *D);
3896 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
3898 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
3899 ArrayRef<llvm::Function *> CXXThreadLocals,
3900 Address Guard = Address::invalid());
3902 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
3904 void GenerateCXXGlobalDtorsFunc(
3906 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
3909 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
3911 llvm::GlobalVariable *Addr,
3914 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
3916 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
3918 void enterFullExpression(const ExprWithCleanups *E) {
3919 if (E->getNumObjects() == 0) return;
3920 enterNonTrivialFullExpression(E);
3922 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
3924 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
3926 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
3928 RValue EmitAtomicExpr(AtomicExpr *E);
3930 //===--------------------------------------------------------------------===//
3931 // Annotations Emission
3932 //===--------------------------------------------------------------------===//
3934 /// Emit an annotation call (intrinsic or builtin).
3935 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
3936 llvm::Value *AnnotatedVal,
3937 StringRef AnnotationStr,
3938 SourceLocation Location);
3940 /// Emit local annotations for the local variable V, declared by D.
3941 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
3943 /// Emit field annotations for the given field & value. Returns the
3944 /// annotation result.
3945 Address EmitFieldAnnotations(const FieldDecl *D, Address V);
3947 //===--------------------------------------------------------------------===//
3949 //===--------------------------------------------------------------------===//
3951 /// ContainsLabel - Return true if the statement contains a label in it. If
3952 /// this statement is not executed normally, it not containing a label means
3953 /// that we can just remove the code.
3954 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
3956 /// containsBreak - Return true if the statement contains a break out of it.
3957 /// If the statement (recursively) contains a switch or loop with a break
3958 /// inside of it, this is fine.
3959 static bool containsBreak(const Stmt *S);
3961 /// Determine if the given statement might introduce a declaration into the
3962 /// current scope, by being a (possibly-labelled) DeclStmt.
3963 static bool mightAddDeclToScope(const Stmt *S);
3965 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3966 /// to a constant, or if it does but contains a label, return false. If it
3967 /// constant folds return true and set the boolean result in Result.
3968 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
3969 bool AllowLabels = false);
3971 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
3972 /// to a constant, or if it does but contains a label, return false. If it
3973 /// constant folds return true and set the folded value.
3974 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
3975 bool AllowLabels = false);
3977 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
3978 /// if statement) to the specified blocks. Based on the condition, this might
3979 /// try to simplify the codegen of the conditional based on the branch.
3980 /// TrueCount should be the number of times we expect the condition to
3981 /// evaluate to true based on PGO data.
3982 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
3983 llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
3985 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
3986 /// nonnull, if \p LHS is marked _Nonnull.
3987 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
3989 /// An enumeration which makes it easier to specify whether or not an
3990 /// operation is a subtraction.
3991 enum { NotSubtraction = false, IsSubtraction = true };
3993 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
3994 /// detect undefined behavior when the pointer overflow sanitizer is enabled.
3995 /// \p SignedIndices indicates whether any of the GEP indices are signed.
3996 /// \p IsSubtraction indicates whether the expression used to form the GEP
3997 /// is a subtraction.
3998 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
3999 ArrayRef<llvm::Value *> IdxList,
4003 const Twine &Name = "");
4005 /// Specifies which type of sanitizer check to apply when handling a
4006 /// particular builtin.
4007 enum BuiltinCheckKind {
4012 /// Emits an argument for a call to a builtin. If the builtin sanitizer is
4013 /// enabled, a runtime check specified by \p Kind is also emitted.
4014 llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
4016 /// Emit a description of a type in a format suitable for passing to
4017 /// a runtime sanitizer handler.
4018 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
4020 /// Convert a value into a format suitable for passing to a runtime
4021 /// sanitizer handler.
4022 llvm::Value *EmitCheckValue(llvm::Value *V);
4024 /// Emit a description of a source location in a format suitable for
4025 /// passing to a runtime sanitizer handler.
4026 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
4028 /// Create a basic block that will call a handler function in a
4029 /// sanitizer runtime with the provided arguments, and create a conditional
4031 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
4032 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
4033 ArrayRef<llvm::Value *> DynamicArgs);
4035 /// Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
4036 /// if Cond if false.
4037 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
4038 llvm::ConstantInt *TypeId, llvm::Value *Ptr,
4039 ArrayRef<llvm::Constant *> StaticArgs);
4041 /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
4042 /// checking is enabled. Otherwise, just emit an unreachable instruction.
4043 void EmitUnreachable(SourceLocation Loc);
4045 /// Create a basic block that will call the trap intrinsic, and emit a
4046 /// conditional branch to it, for the -ftrapv checks.
4047 void EmitTrapCheck(llvm::Value *Checked);
4049 /// Emit a call to trap or debugtrap and attach function attribute
4050 /// "trap-func-name" if specified.
4051 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
4053 /// Emit a stub for the cross-DSO CFI check function.
4054 void EmitCfiCheckStub();
4056 /// Emit a cross-DSO CFI failure handling function.
4057 void EmitCfiCheckFail();
4059 /// Create a check for a function parameter that may potentially be
4060 /// declared as non-null.
4061 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
4062 AbstractCallee AC, unsigned ParmNum);
4064 /// EmitCallArg - Emit a single call argument.
4065 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
4067 /// EmitDelegateCallArg - We are performing a delegate call; that
4068 /// is, the current function is delegating to another one. Produce
4069 /// a r-value suitable for passing the given parameter.
4070 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
4071 SourceLocation loc);
4073 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
4074 /// point operation, expressed as the maximum relative error in ulp.
4075 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
4078 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
4079 void EmitReturnOfRValue(RValue RV, QualType Ty);
4081 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
4083 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
4084 DeferredReplacements;
4086 /// Set the address of a local variable.
4087 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
4088 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
4089 LocalDeclMap.insert({VD, Addr});
4092 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
4093 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
4095 /// \param AI - The first function argument of the expansion.
4096 void ExpandTypeFromArgs(QualType Ty, LValue Dst,
4097 SmallVectorImpl<llvm::Value *>::iterator &AI);
4099 /// ExpandTypeToArgs - Expand an CallArg \arg Arg, with the LLVM type for \arg
4100 /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
4101 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
4102 void ExpandTypeToArgs(QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
4103 SmallVectorImpl<llvm::Value *> &IRCallArgs,
4104 unsigned &IRCallArgPos);
4106 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
4107 const Expr *InputExpr, std::string &ConstraintStr);
4109 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
4110 LValue InputValue, QualType InputType,
4111 std::string &ConstraintStr,
4112 SourceLocation Loc);
4114 /// Attempts to statically evaluate the object size of E. If that
4115 /// fails, emits code to figure the size of E out for us. This is
4116 /// pass_object_size aware.
4118 /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
4119 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
4120 llvm::IntegerType *ResType,
4121 llvm::Value *EmittedE);
4123 /// Emits the size of E, as required by __builtin_object_size. This
4124 /// function is aware of pass_object_size parameters, and will act accordingly
4125 /// if E is a parameter with the pass_object_size attribute.
4126 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
4127 llvm::IntegerType *ResType,
4128 llvm::Value *EmittedE);
4132 // Determine whether the given argument is an Objective-C method
4133 // that may have type parameters in its signature.
4134 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
4135 const DeclContext *dc = method->getDeclContext();
4136 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
4137 return classDecl->getTypeParamListAsWritten();
4140 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
4141 return catDecl->getTypeParamList();
4147 template<typename T>
4148 static bool isObjCMethodWithTypeParams(const T *) { return false; }
4151 enum class EvaluationOrder {
4152 ///! No language constraints on evaluation order.
4154 ///! Language semantics require left-to-right evaluation.
4156 ///! Language semantics require right-to-left evaluation.
4160 /// EmitCallArgs - Emit call arguments for a function.
4161 template <typename T>
4162 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
4163 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
4164 AbstractCallee AC = AbstractCallee(),
4165 unsigned ParamsToSkip = 0,
4166 EvaluationOrder Order = EvaluationOrder::Default) {
4167 SmallVector<QualType, 16> ArgTypes;
4168 CallExpr::const_arg_iterator Arg = ArgRange.begin();
4170 assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
4171 "Can't skip parameters if type info is not provided");
4172 if (CallArgTypeInfo) {
4174 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
4177 // First, use the argument types that the type info knows about
4178 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
4179 E = CallArgTypeInfo->param_type_end();
4180 I != E; ++I, ++Arg) {
4181 assert(Arg != ArgRange.end() && "Running over edge of argument list!");
4182 assert((isGenericMethod ||
4183 ((*I)->isVariablyModifiedType() ||
4184 (*I).getNonReferenceType()->isObjCRetainableType() ||
4186 .getCanonicalType((*I).getNonReferenceType())
4189 .getCanonicalType((*Arg)->getType())
4191 "type mismatch in call argument!");
4192 ArgTypes.push_back(*I);
4196 // Either we've emitted all the call args, or we have a call to variadic
4198 assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
4199 CallArgTypeInfo->isVariadic()) &&
4200 "Extra arguments in non-variadic function!");
4202 // If we still have any arguments, emit them using the type of the argument.
4203 for (auto *A : llvm::make_range(Arg, ArgRange.end()))
4204 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
4206 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
4209 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
4210 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
4211 AbstractCallee AC = AbstractCallee(),
4212 unsigned ParamsToSkip = 0,
4213 EvaluationOrder Order = EvaluationOrder::Default);
4215 /// EmitPointerWithAlignment - Given an expression with a pointer type,
4216 /// emit the value and compute our best estimate of the alignment of the
4219 /// \param BaseInfo - If non-null, this will be initialized with
4220 /// information about the source of the alignment and the may-alias
4221 /// attribute. Note that this function will conservatively fall back on
4222 /// the type when it doesn't recognize the expression and may-alias will
4223 /// be set to false.
4225 /// One reasonable way to use this information is when there's a language
4226 /// guarantee that the pointer must be aligned to some stricter value, and
4227 /// we're simply trying to ensure that sufficiently obvious uses of under-
4228 /// aligned objects don't get miscompiled; for example, a placement new
4229 /// into the address of a local variable. In such a case, it's quite
4230 /// reasonable to just ignore the returned alignment when it isn't from an
4231 /// explicit source.
4232 Address EmitPointerWithAlignment(const Expr *Addr,
4233 LValueBaseInfo *BaseInfo = nullptr,
4234 TBAAAccessInfo *TBAAInfo = nullptr);
4236 /// If \p E references a parameter with pass_object_size info or a constant
4237 /// array size modifier, emit the object size divided by the size of \p EltTy.
4238 /// Otherwise return null.
4239 llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
4241 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
4243 struct TargetMultiVersionResolverOption {
4244 llvm::Function *Function;
4245 TargetAttr::ParsedTargetAttr ParsedAttribute;
4247 TargetMultiVersionResolverOption(
4248 const TargetInfo &TargInfo, llvm::Function *F,
4249 const clang::TargetAttr::ParsedTargetAttr &PT)
4250 : Function(F), ParsedAttribute(PT), Priority(0u) {
4251 for (StringRef Feat : PT.Features)
4252 Priority = std::max(Priority,
4253 TargInfo.multiVersionSortPriority(Feat.substr(1)));
4255 if (!PT.Architecture.empty())
4256 Priority = std::max(Priority,
4257 TargInfo.multiVersionSortPriority(PT.Architecture));
4260 bool operator>(const TargetMultiVersionResolverOption &Other) const {
4261 return Priority > Other.Priority;
4264 void EmitTargetMultiVersionResolver(
4265 llvm::Function *Resolver,
4266 ArrayRef<TargetMultiVersionResolverOption> Options);
4268 struct CPUDispatchMultiVersionResolverOption {
4269 llvm::Function *Function;
4270 // Note: EmitX86CPUSupports only has 32 bits available, so we store the mask
4271 // as 32 bits here. When 64-bit support is added to __builtin_cpu_supports,
4272 // this can be extended to 64 bits.
4273 uint32_t FeatureMask;
4274 CPUDispatchMultiVersionResolverOption(llvm::Function *F, uint64_t Mask)
4275 : Function(F), FeatureMask(static_cast<uint32_t>(Mask)) {}
4276 bool operator>(const CPUDispatchMultiVersionResolverOption &Other) const {
4277 return FeatureMask > Other.FeatureMask;
4280 void EmitCPUDispatchMultiVersionResolver(
4281 llvm::Function *Resolver,
4282 ArrayRef<CPUDispatchMultiVersionResolverOption> Options);
4283 static uint32_t GetX86CpuSupportsMask(ArrayRef<StringRef> FeatureStrs);
4286 QualType getVarArgType(const Expr *Arg);
4288 void EmitDeclMetadata();
4290 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
4291 const AutoVarEmission &emission);
4293 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
4295 llvm::Value *GetValueForARMHint(unsigned BuiltinID);
4296 llvm::Value *EmitX86CpuIs(const CallExpr *E);
4297 llvm::Value *EmitX86CpuIs(StringRef CPUStr);
4298 llvm::Value *EmitX86CpuSupports(const CallExpr *E);
4299 llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
4300 llvm::Value *EmitX86CpuSupports(uint32_t Mask);
4301 llvm::Value *EmitX86CpuInit();
4303 FormResolverCondition(const TargetMultiVersionResolverOption &RO);
4306 inline DominatingLLVMValue::saved_type
4307 DominatingLLVMValue::save(CodeGenFunction &CGF, llvm::Value *value) {
4308 if (!needsSaving(value)) return saved_type(value, false);
4310 // Otherwise, we need an alloca.
4311 auto align = CharUnits::fromQuantity(
4312 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
4314 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
4315 CGF.Builder.CreateStore(value, alloca);
4317 return saved_type(alloca.getPointer(), true);
4320 inline llvm::Value *DominatingLLVMValue::restore(CodeGenFunction &CGF,
4322 // If the value says it wasn't saved, trust that it's still dominating.
4323 if (!value.getInt()) return value.getPointer();
4325 // Otherwise, it should be an alloca instruction, as set up in save().
4326 auto alloca = cast<llvm::AllocaInst>(value.getPointer());
4327 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
4330 } // end namespace CodeGen
4331 } // end namespace clang