1 //===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This is the internal per-function state used for llvm translation. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H 15 #define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H 16 17 #include "CGBuilder.h" 18 #include "CGDebugInfo.h" 19 #include "CGLoopInfo.h" 20 #include "CGValue.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/SmallVector.h" 38 #include "llvm/IR/ValueHandle.h" 39 #include "llvm/Support/Debug.h" 40 #include "llvm/Transforms/Utils/SanitizerStats.h" 41 42 namespace llvm { 43 class BasicBlock; 44 class LLVMContext; 45 class MDNode; 46 class Module; 47 class SwitchInst; 48 class Twine; 49 class Value; 50 class CallSite; 51 } 52 53 namespace clang { 54 class ASTContext; 55 class BlockDecl; 56 class CXXDestructorDecl; 57 class CXXForRangeStmt; 58 class CXXTryStmt; 59 class Decl; 60 class LabelDecl; 61 class EnumConstantDecl; 62 class FunctionDecl; 63 class FunctionProtoType; 64 class LabelStmt; 65 class ObjCContainerDecl; 66 class ObjCInterfaceDecl; 67 class ObjCIvarDecl; 68 class ObjCMethodDecl; 69 class ObjCImplementationDecl; 70 class ObjCPropertyImplDecl; 71 class TargetInfo; 72 class VarDecl; 73 class ObjCForCollectionStmt; 74 class ObjCAtTryStmt; 75 class ObjCAtThrowStmt; 76 class ObjCAtSynchronizedStmt; 77 class ObjCAutoreleasePoolStmt; 78 79 namespace CodeGen { 80 class CodeGenTypes; 81 class CGCallee; 82 class CGFunctionInfo; 83 class CGRecordLayout; 84 class CGBlockInfo; 85 class CGCXXABI; 86 class BlockByrefHelpers; 87 class BlockByrefInfo; 88 class BlockFlags; 89 class BlockFieldFlags; 90 class RegionCodeGenTy; 91 class TargetCodeGenInfo; 92 struct OMPTaskDataTy; 93 struct CGCoroData; 94 95 /// The kind of evaluation to perform on values of a particular 96 /// type. Basically, is the code in CGExprScalar, CGExprComplex, or 97 /// CGExprAgg? 98 /// 99 /// TODO: should vectors maybe be split out into their own thing? 100 enum TypeEvaluationKind { 101 TEK_Scalar, 102 TEK_Complex, 103 TEK_Aggregate 104 }; 105 106 #define LIST_SANITIZER_CHECKS \ 107 SANITIZER_CHECK(AddOverflow, add_overflow, 0) \ 108 SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \ 109 SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \ 110 SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \ 111 SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \ 112 SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \ 113 SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \ 114 SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \ 115 SANITIZER_CHECK(MissingReturn, missing_return, 0) \ 116 SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \ 117 SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \ 118 SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \ 119 SANITIZER_CHECK(NullabilityReturn, nullability_return, 0) \ 120 SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \ 121 SANITIZER_CHECK(NonnullReturn, nonnull_return, 0) \ 122 SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \ 123 SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \ 124 SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \ 125 SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \ 126 SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \ 127 SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0) 128 129 enum SanitizerHandler { 130 #define SANITIZER_CHECK(Enum, Name, Version) Enum, 131 LIST_SANITIZER_CHECKS 132 #undef SANITIZER_CHECK 133 }; 134 135 /// CodeGenFunction - This class organizes the per-function state that is used 136 /// while generating LLVM code. 137 class CodeGenFunction : public CodeGenTypeCache { 138 CodeGenFunction(const CodeGenFunction &) = delete; 139 void operator=(const CodeGenFunction &) = delete; 140 141 friend class CGCXXABI; 142 public: 143 /// A jump destination is an abstract label, branching to which may 144 /// require a jump out through normal cleanups. 145 struct JumpDest { 146 JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {} 147 JumpDest(llvm::BasicBlock *Block, 148 EHScopeStack::stable_iterator Depth, 149 unsigned Index) 150 : Block(Block), ScopeDepth(Depth), Index(Index) {} 151 152 bool isValid() const { return Block != nullptr; } 153 llvm::BasicBlock *getBlock() const { return Block; } 154 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; } 155 unsigned getDestIndex() const { return Index; } 156 157 // This should be used cautiously. 158 void setScopeDepth(EHScopeStack::stable_iterator depth) { 159 ScopeDepth = depth; 160 } 161 162 private: 163 llvm::BasicBlock *Block; 164 EHScopeStack::stable_iterator ScopeDepth; 165 unsigned Index; 166 }; 167 168 CodeGenModule &CGM; // Per-module state. 169 const TargetInfo &Target; 170 171 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy; 172 LoopInfoStack LoopStack; 173 CGBuilderTy Builder; 174 175 // Stores variables for which we can't generate correct lifetime markers 176 // because of jumps. 177 VarBypassDetector Bypasses; 178 179 // CodeGen lambda for loops and support for ordered clause 180 typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &, 181 JumpDest)> 182 CodeGenLoopTy; 183 typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation, 184 const unsigned, const bool)> 185 CodeGenOrderedTy; 186 187 // Codegen lambda for loop bounds in worksharing loop constructs 188 typedef llvm::function_ref<std::pair<LValue, LValue>( 189 CodeGenFunction &, const OMPExecutableDirective &S)> 190 CodeGenLoopBoundsTy; 191 192 // Codegen lambda for loop bounds in dispatch-based loop implementation 193 typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>( 194 CodeGenFunction &, const OMPExecutableDirective &S, Address LB, 195 Address UB)> 196 CodeGenDispatchBoundsTy; 197 198 /// \brief CGBuilder insert helper. This function is called after an 199 /// instruction is created using Builder. 200 void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name, 201 llvm::BasicBlock *BB, 202 llvm::BasicBlock::iterator InsertPt) const; 203 204 /// CurFuncDecl - Holds the Decl for the current outermost 205 /// non-closure context. 206 const Decl *CurFuncDecl; 207 /// CurCodeDecl - This is the inner-most code context, which includes blocks. 208 const Decl *CurCodeDecl; 209 const CGFunctionInfo *CurFnInfo; 210 QualType FnRetTy; 211 llvm::Function *CurFn; 212 213 // Holds coroutine data if the current function is a coroutine. We use a 214 // wrapper to manage its lifetime, so that we don't have to define CGCoroData 215 // in this header. 216 struct CGCoroInfo { 217 std::unique_ptr<CGCoroData> Data; 218 CGCoroInfo(); 219 ~CGCoroInfo(); 220 }; 221 CGCoroInfo CurCoro; 222 223 /// CurGD - The GlobalDecl for the current function being compiled. 224 GlobalDecl CurGD; 225 226 /// PrologueCleanupDepth - The cleanup depth enclosing all the 227 /// cleanups associated with the parameters. 228 EHScopeStack::stable_iterator PrologueCleanupDepth; 229 230 /// ReturnBlock - Unified return block. 231 JumpDest ReturnBlock; 232 233 /// ReturnValue - The temporary alloca to hold the return 234 /// value. This is invalid iff the function has no return value. 235 Address ReturnValue; 236 237 /// Return true if a label was seen in the current scope. 238 bool hasLabelBeenSeenInCurrentScope() const { 239 if (CurLexicalScope) 240 return CurLexicalScope->hasLabels(); 241 return !LabelMap.empty(); 242 } 243 244 /// AllocaInsertPoint - This is an instruction in the entry block before which 245 /// we prefer to insert allocas. 246 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt; 247 248 /// \brief API for captured statement code generation. 249 class CGCapturedStmtInfo { 250 public: 251 explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default) 252 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {} 253 explicit CGCapturedStmtInfo(const CapturedStmt &S, 254 CapturedRegionKind K = CR_Default) 255 : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) { 256 257 RecordDecl::field_iterator Field = 258 S.getCapturedRecordDecl()->field_begin(); 259 for (CapturedStmt::const_capture_iterator I = S.capture_begin(), 260 E = S.capture_end(); 261 I != E; ++I, ++Field) { 262 if (I->capturesThis()) 263 CXXThisFieldDecl = *Field; 264 else if (I->capturesVariable()) 265 CaptureFields[I->getCapturedVar()] = *Field; 266 else if (I->capturesVariableByCopy()) 267 CaptureFields[I->getCapturedVar()] = *Field; 268 } 269 } 270 271 virtual ~CGCapturedStmtInfo(); 272 273 CapturedRegionKind getKind() const { return Kind; } 274 275 virtual void setContextValue(llvm::Value *V) { ThisValue = V; } 276 // \brief Retrieve the value of the context parameter. 277 virtual llvm::Value *getContextValue() const { return ThisValue; } 278 279 /// \brief Lookup the captured field decl for a variable. 280 virtual const FieldDecl *lookup(const VarDecl *VD) const { 281 return CaptureFields.lookup(VD); 282 } 283 284 bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; } 285 virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; } 286 287 static bool classof(const CGCapturedStmtInfo *) { 288 return true; 289 } 290 291 /// \brief Emit the captured statement body. 292 virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) { 293 CGF.incrementProfileCounter(S); 294 CGF.EmitStmt(S); 295 } 296 297 /// \brief Get the name of the capture helper. 298 virtual StringRef getHelperName() const { return "__captured_stmt"; } 299 300 private: 301 /// \brief The kind of captured statement being generated. 302 CapturedRegionKind Kind; 303 304 /// \brief Keep the map between VarDecl and FieldDecl. 305 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields; 306 307 /// \brief The base address of the captured record, passed in as the first 308 /// argument of the parallel region function. 309 llvm::Value *ThisValue; 310 311 /// \brief Captured 'this' type. 312 FieldDecl *CXXThisFieldDecl; 313 }; 314 CGCapturedStmtInfo *CapturedStmtInfo; 315 316 /// \brief RAII for correct setting/restoring of CapturedStmtInfo. 317 class CGCapturedStmtRAII { 318 private: 319 CodeGenFunction &CGF; 320 CGCapturedStmtInfo *PrevCapturedStmtInfo; 321 public: 322 CGCapturedStmtRAII(CodeGenFunction &CGF, 323 CGCapturedStmtInfo *NewCapturedStmtInfo) 324 : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) { 325 CGF.CapturedStmtInfo = NewCapturedStmtInfo; 326 } 327 ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; } 328 }; 329 330 /// An abstract representation of regular/ObjC call/message targets. 331 class AbstractCallee { 332 /// The function declaration of the callee. 333 const Decl *CalleeDecl; 334 335 public: 336 AbstractCallee() : CalleeDecl(nullptr) {} 337 AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {} 338 AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {} 339 bool hasFunctionDecl() const { 340 return dyn_cast_or_null<FunctionDecl>(CalleeDecl); 341 } 342 const Decl *getDecl() const { return CalleeDecl; } 343 unsigned getNumParams() const { 344 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl)) 345 return FD->getNumParams(); 346 return cast<ObjCMethodDecl>(CalleeDecl)->param_size(); 347 } 348 const ParmVarDecl *getParamDecl(unsigned I) const { 349 if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl)) 350 return FD->getParamDecl(I); 351 return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I); 352 } 353 }; 354 355 /// \brief Sanitizers enabled for this function. 356 SanitizerSet SanOpts; 357 358 /// \brief True if CodeGen currently emits code implementing sanitizer checks. 359 bool IsSanitizerScope; 360 361 /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope. 362 class SanitizerScope { 363 CodeGenFunction *CGF; 364 public: 365 SanitizerScope(CodeGenFunction *CGF); 366 ~SanitizerScope(); 367 }; 368 369 /// In C++, whether we are code generating a thunk. This controls whether we 370 /// should emit cleanups. 371 bool CurFuncIsThunk; 372 373 /// In ARC, whether we should autorelease the return value. 374 bool AutoreleaseResult; 375 376 /// Whether we processed a Microsoft-style asm block during CodeGen. These can 377 /// potentially set the return value. 378 bool SawAsmBlock; 379 380 const FunctionDecl *CurSEHParent = nullptr; 381 382 /// True if the current function is an outlined SEH helper. This can be a 383 /// finally block or filter expression. 384 bool IsOutlinedSEHHelper; 385 386 const CodeGen::CGBlockInfo *BlockInfo; 387 llvm::Value *BlockPointer; 388 389 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields; 390 FieldDecl *LambdaThisCaptureField; 391 392 /// \brief A mapping from NRVO variables to the flags used to indicate 393 /// when the NRVO has been applied to this variable. 394 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags; 395 396 EHScopeStack EHStack; 397 llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack; 398 llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack; 399 400 llvm::Instruction *CurrentFuncletPad = nullptr; 401 402 class CallLifetimeEnd final : public EHScopeStack::Cleanup { 403 llvm::Value *Addr; 404 llvm::Value *Size; 405 406 public: 407 CallLifetimeEnd(Address addr, llvm::Value *size) 408 : Addr(addr.getPointer()), Size(size) {} 409 410 void Emit(CodeGenFunction &CGF, Flags flags) override { 411 CGF.EmitLifetimeEnd(Size, Addr); 412 } 413 }; 414 415 /// Header for data within LifetimeExtendedCleanupStack. 416 struct LifetimeExtendedCleanupHeader { 417 /// The size of the following cleanup object. 418 unsigned Size; 419 /// The kind of cleanup to push: a value from the CleanupKind enumeration. 420 CleanupKind Kind; 421 422 size_t getSize() const { return Size; } 423 CleanupKind getKind() const { return Kind; } 424 }; 425 426 /// i32s containing the indexes of the cleanup destinations. 427 llvm::AllocaInst *NormalCleanupDest; 428 429 unsigned NextCleanupDestIndex; 430 431 /// FirstBlockInfo - The head of a singly-linked-list of block layouts. 432 CGBlockInfo *FirstBlockInfo; 433 434 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume. 435 llvm::BasicBlock *EHResumeBlock; 436 437 /// The exception slot. All landing pads write the current exception pointer 438 /// into this alloca. 439 llvm::Value *ExceptionSlot; 440 441 /// The selector slot. Under the MandatoryCleanup model, all landing pads 442 /// write the current selector value into this alloca. 443 llvm::AllocaInst *EHSelectorSlot; 444 445 /// A stack of exception code slots. Entering an __except block pushes a slot 446 /// on the stack and leaving pops one. The __exception_code() intrinsic loads 447 /// a value from the top of the stack. 448 SmallVector<Address, 1> SEHCodeSlotStack; 449 450 /// Value returned by __exception_info intrinsic. 451 llvm::Value *SEHInfo = nullptr; 452 453 /// Emits a landing pad for the current EH stack. 454 llvm::BasicBlock *EmitLandingPad(); 455 456 llvm::BasicBlock *getInvokeDestImpl(); 457 458 template <class T> 459 typename DominatingValue<T>::saved_type saveValueInCond(T value) { 460 return DominatingValue<T>::save(*this, value); 461 } 462 463 public: 464 /// ObjCEHValueStack - Stack of Objective-C exception values, used for 465 /// rethrows. 466 SmallVector<llvm::Value*, 8> ObjCEHValueStack; 467 468 /// A class controlling the emission of a finally block. 469 class FinallyInfo { 470 /// Where the catchall's edge through the cleanup should go. 471 JumpDest RethrowDest; 472 473 /// A function to call to enter the catch. 474 llvm::Constant *BeginCatchFn; 475 476 /// An i1 variable indicating whether or not the @finally is 477 /// running for an exception. 478 llvm::AllocaInst *ForEHVar; 479 480 /// An i8* variable into which the exception pointer to rethrow 481 /// has been saved. 482 llvm::AllocaInst *SavedExnVar; 483 484 public: 485 void enter(CodeGenFunction &CGF, const Stmt *Finally, 486 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn, 487 llvm::Constant *rethrowFn); 488 void exit(CodeGenFunction &CGF); 489 }; 490 491 /// Returns true inside SEH __try blocks. 492 bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); } 493 494 /// Returns true while emitting a cleanuppad. 495 bool isCleanupPadScope() const { 496 return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad); 497 } 498 499 /// pushFullExprCleanup - Push a cleanup to be run at the end of the 500 /// current full-expression. Safe against the possibility that 501 /// we're currently inside a conditionally-evaluated expression. 502 template <class T, class... As> 503 void pushFullExprCleanup(CleanupKind kind, As... A) { 504 // If we're not in a conditional branch, or if none of the 505 // arguments requires saving, then use the unconditional cleanup. 506 if (!isInConditionalBranch()) 507 return EHStack.pushCleanup<T>(kind, A...); 508 509 // Stash values in a tuple so we can guarantee the order of saves. 510 typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple; 511 SavedTuple Saved{saveValueInCond(A)...}; 512 513 typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType; 514 EHStack.pushCleanupTuple<CleanupType>(kind, Saved); 515 initFullExprCleanup(); 516 } 517 518 /// \brief Queue a cleanup to be pushed after finishing the current 519 /// full-expression. 520 template <class T, class... As> 521 void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) { 522 assert(!isInConditionalBranch() && "can't defer conditional cleanup"); 523 524 LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind }; 525 526 size_t OldSize = LifetimeExtendedCleanupStack.size(); 527 LifetimeExtendedCleanupStack.resize( 528 LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size); 529 530 static_assert(sizeof(Header) % alignof(T) == 0, 531 "Cleanup will be allocated on misaligned address"); 532 char *Buffer = &LifetimeExtendedCleanupStack[OldSize]; 533 new (Buffer) LifetimeExtendedCleanupHeader(Header); 534 new (Buffer + sizeof(Header)) T(A...); 535 } 536 537 /// Set up the last cleaup that was pushed as a conditional 538 /// full-expression cleanup. 539 void initFullExprCleanup(); 540 541 /// PushDestructorCleanup - Push a cleanup to call the 542 /// complete-object destructor of an object of the given type at the 543 /// given address. Does nothing if T is not a C++ class type with a 544 /// non-trivial destructor. 545 void PushDestructorCleanup(QualType T, Address Addr); 546 547 /// PushDestructorCleanup - Push a cleanup to call the 548 /// complete-object variant of the given destructor on the object at 549 /// the given address. 550 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr); 551 552 /// PopCleanupBlock - Will pop the cleanup entry on the stack and 553 /// process all branch fixups. 554 void PopCleanupBlock(bool FallThroughIsBranchThrough = false); 555 556 /// DeactivateCleanupBlock - Deactivates the given cleanup block. 557 /// The block cannot be reactivated. Pops it if it's the top of the 558 /// stack. 559 /// 560 /// \param DominatingIP - An instruction which is known to 561 /// dominate the current IP (if set) and which lies along 562 /// all paths of execution between the current IP and the 563 /// the point at which the cleanup comes into scope. 564 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup, 565 llvm::Instruction *DominatingIP); 566 567 /// ActivateCleanupBlock - Activates an initially-inactive cleanup. 568 /// Cannot be used to resurrect a deactivated cleanup. 569 /// 570 /// \param DominatingIP - An instruction which is known to 571 /// dominate the current IP (if set) and which lies along 572 /// all paths of execution between the current IP and the 573 /// the point at which the cleanup comes into scope. 574 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup, 575 llvm::Instruction *DominatingIP); 576 577 /// \brief Enters a new scope for capturing cleanups, all of which 578 /// will be executed once the scope is exited. 579 class RunCleanupsScope { 580 EHScopeStack::stable_iterator CleanupStackDepth; 581 size_t LifetimeExtendedCleanupStackSize; 582 bool OldDidCallStackSave; 583 protected: 584 bool PerformCleanup; 585 private: 586 587 RunCleanupsScope(const RunCleanupsScope &) = delete; 588 void operator=(const RunCleanupsScope &) = delete; 589 590 protected: 591 CodeGenFunction& CGF; 592 593 public: 594 /// \brief Enter a new cleanup scope. 595 explicit RunCleanupsScope(CodeGenFunction &CGF) 596 : PerformCleanup(true), CGF(CGF) 597 { 598 CleanupStackDepth = CGF.EHStack.stable_begin(); 599 LifetimeExtendedCleanupStackSize = 600 CGF.LifetimeExtendedCleanupStack.size(); 601 OldDidCallStackSave = CGF.DidCallStackSave; 602 CGF.DidCallStackSave = false; 603 } 604 605 /// \brief Exit this cleanup scope, emitting any accumulated cleanups. 606 ~RunCleanupsScope() { 607 if (PerformCleanup) 608 ForceCleanup(); 609 } 610 611 /// \brief Determine whether this scope requires any cleanups. 612 bool requiresCleanups() const { 613 return CGF.EHStack.stable_begin() != CleanupStackDepth; 614 } 615 616 /// \brief Force the emission of cleanups now, instead of waiting 617 /// until this object is destroyed. 618 /// \param ValuesToReload - A list of values that need to be available at 619 /// the insertion point after cleanup emission. If cleanup emission created 620 /// a shared cleanup block, these value pointers will be rewritten. 621 /// Otherwise, they not will be modified. 622 void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) { 623 assert(PerformCleanup && "Already forced cleanup"); 624 CGF.DidCallStackSave = OldDidCallStackSave; 625 CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize, 626 ValuesToReload); 627 PerformCleanup = false; 628 } 629 }; 630 631 class LexicalScope : public RunCleanupsScope { 632 SourceRange Range; 633 SmallVector<const LabelDecl*, 4> Labels; 634 LexicalScope *ParentScope; 635 636 LexicalScope(const LexicalScope &) = delete; 637 void operator=(const LexicalScope &) = delete; 638 639 public: 640 /// \brief Enter a new cleanup scope. 641 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range) 642 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) { 643 CGF.CurLexicalScope = this; 644 if (CGDebugInfo *DI = CGF.getDebugInfo()) 645 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin()); 646 } 647 648 void addLabel(const LabelDecl *label) { 649 assert(PerformCleanup && "adding label to dead scope?"); 650 Labels.push_back(label); 651 } 652 653 /// \brief Exit this cleanup scope, emitting any accumulated 654 /// cleanups. 655 ~LexicalScope() { 656 if (CGDebugInfo *DI = CGF.getDebugInfo()) 657 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd()); 658 659 // If we should perform a cleanup, force them now. Note that 660 // this ends the cleanup scope before rescoping any labels. 661 if (PerformCleanup) { 662 ApplyDebugLocation DL(CGF, Range.getEnd()); 663 ForceCleanup(); 664 } 665 } 666 667 /// \brief Force the emission of cleanups now, instead of waiting 668 /// until this object is destroyed. 669 void ForceCleanup() { 670 CGF.CurLexicalScope = ParentScope; 671 RunCleanupsScope::ForceCleanup(); 672 673 if (!Labels.empty()) 674 rescopeLabels(); 675 } 676 677 bool hasLabels() const { 678 return !Labels.empty(); 679 } 680 681 void rescopeLabels(); 682 }; 683 684 typedef llvm::DenseMap<const Decl *, Address> DeclMapTy; 685 686 /// \brief The scope used to remap some variables as private in the OpenMP 687 /// loop body (or other captured region emitted without outlining), and to 688 /// restore old vars back on exit. 689 class OMPPrivateScope : public RunCleanupsScope { 690 DeclMapTy SavedLocals; 691 DeclMapTy SavedPrivates; 692 693 private: 694 OMPPrivateScope(const OMPPrivateScope &) = delete; 695 void operator=(const OMPPrivateScope &) = delete; 696 697 public: 698 /// \brief Enter a new OpenMP private scope. 699 explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {} 700 701 /// \brief Registers \a LocalVD variable as a private and apply \a 702 /// PrivateGen function for it to generate corresponding private variable. 703 /// \a PrivateGen returns an address of the generated private variable. 704 /// \return true if the variable is registered as private, false if it has 705 /// been privatized already. 706 bool 707 addPrivate(const VarDecl *LocalVD, 708 llvm::function_ref<Address()> PrivateGen) { 709 assert(PerformCleanup && "adding private to dead scope"); 710 711 // Only save it once. 712 if (SavedLocals.count(LocalVD)) return false; 713 714 // Copy the existing local entry to SavedLocals. 715 auto it = CGF.LocalDeclMap.find(LocalVD); 716 if (it != CGF.LocalDeclMap.end()) { 717 SavedLocals.insert({LocalVD, it->second}); 718 } else { 719 SavedLocals.insert({LocalVD, Address::invalid()}); 720 } 721 722 // Generate the private entry. 723 Address Addr = PrivateGen(); 724 QualType VarTy = LocalVD->getType(); 725 if (VarTy->isReferenceType()) { 726 Address Temp = CGF.CreateMemTemp(VarTy); 727 CGF.Builder.CreateStore(Addr.getPointer(), Temp); 728 Addr = Temp; 729 } 730 SavedPrivates.insert({LocalVD, Addr}); 731 732 return true; 733 } 734 735 /// \brief Privatizes local variables previously registered as private. 736 /// Registration is separate from the actual privatization to allow 737 /// initializers use values of the original variables, not the private one. 738 /// This is important, for example, if the private variable is a class 739 /// variable initialized by a constructor that references other private 740 /// variables. But at initialization original variables must be used, not 741 /// private copies. 742 /// \return true if at least one variable was privatized, false otherwise. 743 bool Privatize() { 744 copyInto(SavedPrivates, CGF.LocalDeclMap); 745 SavedPrivates.clear(); 746 return !SavedLocals.empty(); 747 } 748 749 void ForceCleanup() { 750 RunCleanupsScope::ForceCleanup(); 751 copyInto(SavedLocals, CGF.LocalDeclMap); 752 SavedLocals.clear(); 753 } 754 755 /// \brief Exit scope - all the mapped variables are restored. 756 ~OMPPrivateScope() { 757 if (PerformCleanup) 758 ForceCleanup(); 759 } 760 761 /// Checks if the global variable is captured in current function. 762 bool isGlobalVarCaptured(const VarDecl *VD) const { 763 return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0; 764 } 765 766 private: 767 /// Copy all the entries in the source map over the corresponding 768 /// entries in the destination, which must exist. 769 static void copyInto(const DeclMapTy &src, DeclMapTy &dest) { 770 for (auto &pair : src) { 771 if (!pair.second.isValid()) { 772 dest.erase(pair.first); 773 continue; 774 } 775 776 auto it = dest.find(pair.first); 777 if (it != dest.end()) { 778 it->second = pair.second; 779 } else { 780 dest.insert(pair); 781 } 782 } 783 } 784 }; 785 786 /// \brief Takes the old cleanup stack size and emits the cleanup blocks 787 /// that have been added. 788 void 789 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize, 790 std::initializer_list<llvm::Value **> ValuesToReload = {}); 791 792 /// \brief Takes the old cleanup stack size and emits the cleanup blocks 793 /// that have been added, then adds all lifetime-extended cleanups from 794 /// the given position to the stack. 795 void 796 PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize, 797 size_t OldLifetimeExtendedStackSize, 798 std::initializer_list<llvm::Value **> ValuesToReload = {}); 799 800 void ResolveBranchFixups(llvm::BasicBlock *Target); 801 802 /// The given basic block lies in the current EH scope, but may be a 803 /// target of a potentially scope-crossing jump; get a stable handle 804 /// to which we can perform this jump later. 805 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) { 806 return JumpDest(Target, 807 EHStack.getInnermostNormalCleanup(), 808 NextCleanupDestIndex++); 809 } 810 811 /// The given basic block lies in the current EH scope, but may be a 812 /// target of a potentially scope-crossing jump; get a stable handle 813 /// to which we can perform this jump later. 814 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) { 815 return getJumpDestInCurrentScope(createBasicBlock(Name)); 816 } 817 818 /// EmitBranchThroughCleanup - Emit a branch from the current insert 819 /// block through the normal cleanup handling code (if any) and then 820 /// on to \arg Dest. 821 void EmitBranchThroughCleanup(JumpDest Dest); 822 823 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the 824 /// specified destination obviously has no cleanups to run. 'false' is always 825 /// a conservatively correct answer for this method. 826 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const; 827 828 /// popCatchScope - Pops the catch scope at the top of the EHScope 829 /// stack, emitting any required code (other than the catch handlers 830 /// themselves). 831 void popCatchScope(); 832 833 llvm::BasicBlock *getEHResumeBlock(bool isCleanup); 834 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope); 835 llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope); 836 837 /// An object to manage conditionally-evaluated expressions. 838 class ConditionalEvaluation { 839 llvm::BasicBlock *StartBB; 840 841 public: 842 ConditionalEvaluation(CodeGenFunction &CGF) 843 : StartBB(CGF.Builder.GetInsertBlock()) {} 844 845 void begin(CodeGenFunction &CGF) { 846 assert(CGF.OutermostConditional != this); 847 if (!CGF.OutermostConditional) 848 CGF.OutermostConditional = this; 849 } 850 851 void end(CodeGenFunction &CGF) { 852 assert(CGF.OutermostConditional != nullptr); 853 if (CGF.OutermostConditional == this) 854 CGF.OutermostConditional = nullptr; 855 } 856 857 /// Returns a block which will be executed prior to each 858 /// evaluation of the conditional code. 859 llvm::BasicBlock *getStartingBlock() const { 860 return StartBB; 861 } 862 }; 863 864 /// isInConditionalBranch - Return true if we're currently emitting 865 /// one branch or the other of a conditional expression. 866 bool isInConditionalBranch() const { return OutermostConditional != nullptr; } 867 868 void setBeforeOutermostConditional(llvm::Value *value, Address addr) { 869 assert(isInConditionalBranch()); 870 llvm::BasicBlock *block = OutermostConditional->getStartingBlock(); 871 auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back()); 872 store->setAlignment(addr.getAlignment().getQuantity()); 873 } 874 875 /// An RAII object to record that we're evaluating a statement 876 /// expression. 877 class StmtExprEvaluation { 878 CodeGenFunction &CGF; 879 880 /// We have to save the outermost conditional: cleanups in a 881 /// statement expression aren't conditional just because the 882 /// StmtExpr is. 883 ConditionalEvaluation *SavedOutermostConditional; 884 885 public: 886 StmtExprEvaluation(CodeGenFunction &CGF) 887 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) { 888 CGF.OutermostConditional = nullptr; 889 } 890 891 ~StmtExprEvaluation() { 892 CGF.OutermostConditional = SavedOutermostConditional; 893 CGF.EnsureInsertPoint(); 894 } 895 }; 896 897 /// An object which temporarily prevents a value from being 898 /// destroyed by aggressive peephole optimizations that assume that 899 /// all uses of a value have been realized in the IR. 900 class PeepholeProtection { 901 llvm::Instruction *Inst; 902 friend class CodeGenFunction; 903 904 public: 905 PeepholeProtection() : Inst(nullptr) {} 906 }; 907 908 /// A non-RAII class containing all the information about a bound 909 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for 910 /// this which makes individual mappings very simple; using this 911 /// class directly is useful when you have a variable number of 912 /// opaque values or don't want the RAII functionality for some 913 /// reason. 914 class OpaqueValueMappingData { 915 const OpaqueValueExpr *OpaqueValue; 916 bool BoundLValue; 917 CodeGenFunction::PeepholeProtection Protection; 918 919 OpaqueValueMappingData(const OpaqueValueExpr *ov, 920 bool boundLValue) 921 : OpaqueValue(ov), BoundLValue(boundLValue) {} 922 public: 923 OpaqueValueMappingData() : OpaqueValue(nullptr) {} 924 925 static bool shouldBindAsLValue(const Expr *expr) { 926 // gl-values should be bound as l-values for obvious reasons. 927 // Records should be bound as l-values because IR generation 928 // always keeps them in memory. Expressions of function type 929 // act exactly like l-values but are formally required to be 930 // r-values in C. 931 return expr->isGLValue() || 932 expr->getType()->isFunctionType() || 933 hasAggregateEvaluationKind(expr->getType()); 934 } 935 936 static OpaqueValueMappingData bind(CodeGenFunction &CGF, 937 const OpaqueValueExpr *ov, 938 const Expr *e) { 939 if (shouldBindAsLValue(ov)) 940 return bind(CGF, ov, CGF.EmitLValue(e)); 941 return bind(CGF, ov, CGF.EmitAnyExpr(e)); 942 } 943 944 static OpaqueValueMappingData bind(CodeGenFunction &CGF, 945 const OpaqueValueExpr *ov, 946 const LValue &lv) { 947 assert(shouldBindAsLValue(ov)); 948 CGF.OpaqueLValues.insert(std::make_pair(ov, lv)); 949 return OpaqueValueMappingData(ov, true); 950 } 951 952 static OpaqueValueMappingData bind(CodeGenFunction &CGF, 953 const OpaqueValueExpr *ov, 954 const RValue &rv) { 955 assert(!shouldBindAsLValue(ov)); 956 CGF.OpaqueRValues.insert(std::make_pair(ov, rv)); 957 958 OpaqueValueMappingData data(ov, false); 959 960 // Work around an extremely aggressive peephole optimization in 961 // EmitScalarConversion which assumes that all other uses of a 962 // value are extant. 963 data.Protection = CGF.protectFromPeepholes(rv); 964 965 return data; 966 } 967 968 bool isValid() const { return OpaqueValue != nullptr; } 969 void clear() { OpaqueValue = nullptr; } 970 971 void unbind(CodeGenFunction &CGF) { 972 assert(OpaqueValue && "no data to unbind!"); 973 974 if (BoundLValue) { 975 CGF.OpaqueLValues.erase(OpaqueValue); 976 } else { 977 CGF.OpaqueRValues.erase(OpaqueValue); 978 CGF.unprotectFromPeepholes(Protection); 979 } 980 } 981 }; 982 983 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr. 984 class OpaqueValueMapping { 985 CodeGenFunction &CGF; 986 OpaqueValueMappingData Data; 987 988 public: 989 static bool shouldBindAsLValue(const Expr *expr) { 990 return OpaqueValueMappingData::shouldBindAsLValue(expr); 991 } 992 993 /// Build the opaque value mapping for the given conditional 994 /// operator if it's the GNU ?: extension. This is a common 995 /// enough pattern that the convenience operator is really 996 /// helpful. 997 /// 998 OpaqueValueMapping(CodeGenFunction &CGF, 999 const AbstractConditionalOperator *op) : CGF(CGF) { 1000 if (isa<ConditionalOperator>(op)) 1001 // Leave Data empty. 1002 return; 1003 1004 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op); 1005 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(), 1006 e->getCommon()); 1007 } 1008 1009 /// Build the opaque value mapping for an OpaqueValueExpr whose source 1010 /// expression is set to the expression the OVE represents. 1011 OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV) 1012 : CGF(CGF) { 1013 if (OV) { 1014 assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used " 1015 "for OVE with no source expression"); 1016 Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr()); 1017 } 1018 } 1019 1020 OpaqueValueMapping(CodeGenFunction &CGF, 1021 const OpaqueValueExpr *opaqueValue, 1022 LValue lvalue) 1023 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) { 1024 } 1025 1026 OpaqueValueMapping(CodeGenFunction &CGF, 1027 const OpaqueValueExpr *opaqueValue, 1028 RValue rvalue) 1029 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) { 1030 } 1031 1032 void pop() { 1033 Data.unbind(CGF); 1034 Data.clear(); 1035 } 1036 1037 ~OpaqueValueMapping() { 1038 if (Data.isValid()) Data.unbind(CGF); 1039 } 1040 }; 1041 1042 private: 1043 CGDebugInfo *DebugInfo; 1044 bool DisableDebugInfo; 1045 1046 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid 1047 /// calling llvm.stacksave for multiple VLAs in the same scope. 1048 bool DidCallStackSave; 1049 1050 /// IndirectBranch - The first time an indirect goto is seen we create a block 1051 /// with an indirect branch. Every time we see the address of a label taken, 1052 /// we add the label to the indirect goto. Every subsequent indirect goto is 1053 /// codegen'd as a jump to the IndirectBranch's basic block. 1054 llvm::IndirectBrInst *IndirectBranch; 1055 1056 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C 1057 /// decls. 1058 DeclMapTy LocalDeclMap; 1059 1060 /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this 1061 /// will contain a mapping from said ParmVarDecl to its implicit "object_size" 1062 /// parameter. 1063 llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2> 1064 SizeArguments; 1065 1066 /// Track escaped local variables with auto storage. Used during SEH 1067 /// outlining to produce a call to llvm.localescape. 1068 llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals; 1069 1070 /// LabelMap - This keeps track of the LLVM basic block for each C label. 1071 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap; 1072 1073 // BreakContinueStack - This keeps track of where break and continue 1074 // statements should jump to. 1075 struct BreakContinue { 1076 BreakContinue(JumpDest Break, JumpDest Continue) 1077 : BreakBlock(Break), ContinueBlock(Continue) {} 1078 1079 JumpDest BreakBlock; 1080 JumpDest ContinueBlock; 1081 }; 1082 SmallVector<BreakContinue, 8> BreakContinueStack; 1083 1084 /// Handles cancellation exit points in OpenMP-related constructs. 1085 class OpenMPCancelExitStack { 1086 /// Tracks cancellation exit point and join point for cancel-related exit 1087 /// and normal exit. 1088 struct CancelExit { 1089 CancelExit() = default; 1090 CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock, 1091 JumpDest ContBlock) 1092 : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {} 1093 OpenMPDirectiveKind Kind = OMPD_unknown; 1094 /// true if the exit block has been emitted already by the special 1095 /// emitExit() call, false if the default codegen is used. 1096 bool HasBeenEmitted = false; 1097 JumpDest ExitBlock; 1098 JumpDest ContBlock; 1099 }; 1100 1101 SmallVector<CancelExit, 8> Stack; 1102 1103 public: 1104 OpenMPCancelExitStack() : Stack(1) {} 1105 ~OpenMPCancelExitStack() = default; 1106 /// Fetches the exit block for the current OpenMP construct. 1107 JumpDest getExitBlock() const { return Stack.back().ExitBlock; } 1108 /// Emits exit block with special codegen procedure specific for the related 1109 /// OpenMP construct + emits code for normal construct cleanup. 1110 void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, 1111 const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) { 1112 if (Stack.back().Kind == Kind && getExitBlock().isValid()) { 1113 assert(CGF.getOMPCancelDestination(Kind).isValid()); 1114 assert(CGF.HaveInsertPoint()); 1115 assert(!Stack.back().HasBeenEmitted); 1116 auto IP = CGF.Builder.saveAndClearIP(); 1117 CGF.EmitBlock(Stack.back().ExitBlock.getBlock()); 1118 CodeGen(CGF); 1119 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock); 1120 CGF.Builder.restoreIP(IP); 1121 Stack.back().HasBeenEmitted = true; 1122 } 1123 CodeGen(CGF); 1124 } 1125 /// Enter the cancel supporting \a Kind construct. 1126 /// \param Kind OpenMP directive that supports cancel constructs. 1127 /// \param HasCancel true, if the construct has inner cancel directive, 1128 /// false otherwise. 1129 void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) { 1130 Stack.push_back({Kind, 1131 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit") 1132 : JumpDest(), 1133 HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont") 1134 : JumpDest()}); 1135 } 1136 /// Emits default exit point for the cancel construct (if the special one 1137 /// has not be used) + join point for cancel/normal exits. 1138 void exit(CodeGenFunction &CGF) { 1139 if (getExitBlock().isValid()) { 1140 assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid()); 1141 bool HaveIP = CGF.HaveInsertPoint(); 1142 if (!Stack.back().HasBeenEmitted) { 1143 if (HaveIP) 1144 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock); 1145 CGF.EmitBlock(Stack.back().ExitBlock.getBlock()); 1146 CGF.EmitBranchThroughCleanup(Stack.back().ContBlock); 1147 } 1148 CGF.EmitBlock(Stack.back().ContBlock.getBlock()); 1149 if (!HaveIP) { 1150 CGF.Builder.CreateUnreachable(); 1151 CGF.Builder.ClearInsertionPoint(); 1152 } 1153 } 1154 Stack.pop_back(); 1155 } 1156 }; 1157 OpenMPCancelExitStack OMPCancelStack; 1158 1159 /// Controls insertion of cancellation exit blocks in worksharing constructs. 1160 class OMPCancelStackRAII { 1161 CodeGenFunction &CGF; 1162 1163 public: 1164 OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, 1165 bool HasCancel) 1166 : CGF(CGF) { 1167 CGF.OMPCancelStack.enter(CGF, Kind, HasCancel); 1168 } 1169 ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); } 1170 }; 1171 1172 CodeGenPGO PGO; 1173 1174 /// Calculate branch weights appropriate for PGO data 1175 llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount); 1176 llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights); 1177 llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond, 1178 uint64_t LoopCount); 1179 1180 public: 1181 /// Increment the profiler's counter for the given statement by \p StepV. 1182 /// If \p StepV is null, the default increment is 1. 1183 void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) { 1184 if (CGM.getCodeGenOpts().hasProfileClangInstr()) 1185 PGO.emitCounterIncrement(Builder, S, StepV); 1186 PGO.setCurrentStmt(S); 1187 } 1188 1189 /// Get the profiler's count for the given statement. 1190 uint64_t getProfileCount(const Stmt *S) { 1191 Optional<uint64_t> Count = PGO.getStmtCount(S); 1192 if (!Count.hasValue()) 1193 return 0; 1194 return *Count; 1195 } 1196 1197 /// Set the profiler's current count. 1198 void setCurrentProfileCount(uint64_t Count) { 1199 PGO.setCurrentRegionCount(Count); 1200 } 1201 1202 /// Get the profiler's current count. This is generally the count for the most 1203 /// recently incremented counter. 1204 uint64_t getCurrentProfileCount() { 1205 return PGO.getCurrentRegionCount(); 1206 } 1207 1208 private: 1209 1210 /// SwitchInsn - This is nearest current switch instruction. It is null if 1211 /// current context is not in a switch. 1212 llvm::SwitchInst *SwitchInsn; 1213 /// The branch weights of SwitchInsn when doing instrumentation based PGO. 1214 SmallVector<uint64_t, 16> *SwitchWeights; 1215 1216 /// CaseRangeBlock - This block holds if condition check for last case 1217 /// statement range in current switch instruction. 1218 llvm::BasicBlock *CaseRangeBlock; 1219 1220 /// OpaqueLValues - Keeps track of the current set of opaque value 1221 /// expressions. 1222 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues; 1223 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues; 1224 1225 // VLASizeMap - This keeps track of the associated size for each VLA type. 1226 // We track this by the size expression rather than the type itself because 1227 // in certain situations, like a const qualifier applied to an VLA typedef, 1228 // multiple VLA types can share the same size expression. 1229 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we 1230 // enter/leave scopes. 1231 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap; 1232 1233 /// A block containing a single 'unreachable' instruction. Created 1234 /// lazily by getUnreachableBlock(). 1235 llvm::BasicBlock *UnreachableBlock; 1236 1237 /// Counts of the number return expressions in the function. 1238 unsigned NumReturnExprs; 1239 1240 /// Count the number of simple (constant) return expressions in the function. 1241 unsigned NumSimpleReturnExprs; 1242 1243 /// The last regular (non-return) debug location (breakpoint) in the function. 1244 SourceLocation LastStopPoint; 1245 1246 public: 1247 /// A scope within which we are constructing the fields of an object which 1248 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use 1249 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation. 1250 class FieldConstructionScope { 1251 public: 1252 FieldConstructionScope(CodeGenFunction &CGF, Address This) 1253 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) { 1254 CGF.CXXDefaultInitExprThis = This; 1255 } 1256 ~FieldConstructionScope() { 1257 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis; 1258 } 1259 1260 private: 1261 CodeGenFunction &CGF; 1262 Address OldCXXDefaultInitExprThis; 1263 }; 1264 1265 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this' 1266 /// is overridden to be the object under construction. 1267 class CXXDefaultInitExprScope { 1268 public: 1269 CXXDefaultInitExprScope(CodeGenFunction &CGF) 1270 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue), 1271 OldCXXThisAlignment(CGF.CXXThisAlignment) { 1272 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer(); 1273 CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment(); 1274 } 1275 ~CXXDefaultInitExprScope() { 1276 CGF.CXXThisValue = OldCXXThisValue; 1277 CGF.CXXThisAlignment = OldCXXThisAlignment; 1278 } 1279 1280 public: 1281 CodeGenFunction &CGF; 1282 llvm::Value *OldCXXThisValue; 1283 CharUnits OldCXXThisAlignment; 1284 }; 1285 1286 /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the 1287 /// current loop index is overridden. 1288 class ArrayInitLoopExprScope { 1289 public: 1290 ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index) 1291 : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) { 1292 CGF.ArrayInitIndex = Index; 1293 } 1294 ~ArrayInitLoopExprScope() { 1295 CGF.ArrayInitIndex = OldArrayInitIndex; 1296 } 1297 1298 private: 1299 CodeGenFunction &CGF; 1300 llvm::Value *OldArrayInitIndex; 1301 }; 1302 1303 class InlinedInheritingConstructorScope { 1304 public: 1305 InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD) 1306 : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl), 1307 OldCurCodeDecl(CGF.CurCodeDecl), 1308 OldCXXABIThisDecl(CGF.CXXABIThisDecl), 1309 OldCXXABIThisValue(CGF.CXXABIThisValue), 1310 OldCXXThisValue(CGF.CXXThisValue), 1311 OldCXXABIThisAlignment(CGF.CXXABIThisAlignment), 1312 OldCXXThisAlignment(CGF.CXXThisAlignment), 1313 OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy), 1314 OldCXXInheritedCtorInitExprArgs( 1315 std::move(CGF.CXXInheritedCtorInitExprArgs)) { 1316 CGF.CurGD = GD; 1317 CGF.CurFuncDecl = CGF.CurCodeDecl = 1318 cast<CXXConstructorDecl>(GD.getDecl()); 1319 CGF.CXXABIThisDecl = nullptr; 1320 CGF.CXXABIThisValue = nullptr; 1321 CGF.CXXThisValue = nullptr; 1322 CGF.CXXABIThisAlignment = CharUnits(); 1323 CGF.CXXThisAlignment = CharUnits(); 1324 CGF.ReturnValue = Address::invalid(); 1325 CGF.FnRetTy = QualType(); 1326 CGF.CXXInheritedCtorInitExprArgs.clear(); 1327 } 1328 ~InlinedInheritingConstructorScope() { 1329 CGF.CurGD = OldCurGD; 1330 CGF.CurFuncDecl = OldCurFuncDecl; 1331 CGF.CurCodeDecl = OldCurCodeDecl; 1332 CGF.CXXABIThisDecl = OldCXXABIThisDecl; 1333 CGF.CXXABIThisValue = OldCXXABIThisValue; 1334 CGF.CXXThisValue = OldCXXThisValue; 1335 CGF.CXXABIThisAlignment = OldCXXABIThisAlignment; 1336 CGF.CXXThisAlignment = OldCXXThisAlignment; 1337 CGF.ReturnValue = OldReturnValue; 1338 CGF.FnRetTy = OldFnRetTy; 1339 CGF.CXXInheritedCtorInitExprArgs = 1340 std::move(OldCXXInheritedCtorInitExprArgs); 1341 } 1342 1343 private: 1344 CodeGenFunction &CGF; 1345 GlobalDecl OldCurGD; 1346 const Decl *OldCurFuncDecl; 1347 const Decl *OldCurCodeDecl; 1348 ImplicitParamDecl *OldCXXABIThisDecl; 1349 llvm::Value *OldCXXABIThisValue; 1350 llvm::Value *OldCXXThisValue; 1351 CharUnits OldCXXABIThisAlignment; 1352 CharUnits OldCXXThisAlignment; 1353 Address OldReturnValue; 1354 QualType OldFnRetTy; 1355 CallArgList OldCXXInheritedCtorInitExprArgs; 1356 }; 1357 1358 private: 1359 /// CXXThisDecl - When generating code for a C++ member function, 1360 /// this will hold the implicit 'this' declaration. 1361 ImplicitParamDecl *CXXABIThisDecl; 1362 llvm::Value *CXXABIThisValue; 1363 llvm::Value *CXXThisValue; 1364 CharUnits CXXABIThisAlignment; 1365 CharUnits CXXThisAlignment; 1366 1367 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within 1368 /// this expression. 1369 Address CXXDefaultInitExprThis = Address::invalid(); 1370 1371 /// The current array initialization index when evaluating an 1372 /// ArrayInitIndexExpr within an ArrayInitLoopExpr. 1373 llvm::Value *ArrayInitIndex = nullptr; 1374 1375 /// The values of function arguments to use when evaluating 1376 /// CXXInheritedCtorInitExprs within this context. 1377 CallArgList CXXInheritedCtorInitExprArgs; 1378 1379 /// CXXStructorImplicitParamDecl - When generating code for a constructor or 1380 /// destructor, this will hold the implicit argument (e.g. VTT). 1381 ImplicitParamDecl *CXXStructorImplicitParamDecl; 1382 llvm::Value *CXXStructorImplicitParamValue; 1383 1384 /// OutermostConditional - Points to the outermost active 1385 /// conditional control. This is used so that we know if a 1386 /// temporary should be destroyed conditionally. 1387 ConditionalEvaluation *OutermostConditional; 1388 1389 /// The current lexical scope. 1390 LexicalScope *CurLexicalScope; 1391 1392 /// The current source location that should be used for exception 1393 /// handling code. 1394 SourceLocation CurEHLocation; 1395 1396 /// BlockByrefInfos - For each __block variable, contains 1397 /// information about the layout of the variable. 1398 llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos; 1399 1400 /// Used by -fsanitize=nullability-return to determine whether the return 1401 /// value can be checked. 1402 llvm::Value *RetValNullabilityPrecondition = nullptr; 1403 1404 /// Check if -fsanitize=nullability-return instrumentation is required for 1405 /// this function. 1406 bool requiresReturnValueNullabilityCheck() const { 1407 return RetValNullabilityPrecondition; 1408 } 1409 1410 llvm::BasicBlock *TerminateLandingPad; 1411 llvm::BasicBlock *TerminateHandler; 1412 llvm::BasicBlock *TrapBB; 1413 1414 /// True if we need emit the life-time markers. 1415 const bool ShouldEmitLifetimeMarkers; 1416 1417 /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to 1418 /// the function metadata. 1419 void EmitOpenCLKernelMetadata(const FunctionDecl *FD, 1420 llvm::Function *Fn); 1421 1422 public: 1423 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false); 1424 ~CodeGenFunction(); 1425 1426 CodeGenTypes &getTypes() const { return CGM.getTypes(); } 1427 ASTContext &getContext() const { return CGM.getContext(); } 1428 CGDebugInfo *getDebugInfo() { 1429 if (DisableDebugInfo) 1430 return nullptr; 1431 return DebugInfo; 1432 } 1433 void disableDebugInfo() { DisableDebugInfo = true; } 1434 void enableDebugInfo() { DisableDebugInfo = false; } 1435 1436 bool shouldUseFusedARCCalls() { 1437 return CGM.getCodeGenOpts().OptimizationLevel == 0; 1438 } 1439 1440 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); } 1441 1442 /// Returns a pointer to the function's exception object and selector slot, 1443 /// which is assigned in every landing pad. 1444 Address getExceptionSlot(); 1445 Address getEHSelectorSlot(); 1446 1447 /// Returns the contents of the function's exception object and selector 1448 /// slots. 1449 llvm::Value *getExceptionFromSlot(); 1450 llvm::Value *getSelectorFromSlot(); 1451 1452 Address getNormalCleanupDestSlot(); 1453 1454 llvm::BasicBlock *getUnreachableBlock() { 1455 if (!UnreachableBlock) { 1456 UnreachableBlock = createBasicBlock("unreachable"); 1457 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock); 1458 } 1459 return UnreachableBlock; 1460 } 1461 1462 llvm::BasicBlock *getInvokeDest() { 1463 if (!EHStack.requiresLandingPad()) return nullptr; 1464 return getInvokeDestImpl(); 1465 } 1466 1467 bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; } 1468 1469 const TargetInfo &getTarget() const { return Target; } 1470 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); } 1471 1472 //===--------------------------------------------------------------------===// 1473 // Cleanups 1474 //===--------------------------------------------------------------------===// 1475 1476 typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty); 1477 1478 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin, 1479 Address arrayEndPointer, 1480 QualType elementType, 1481 CharUnits elementAlignment, 1482 Destroyer *destroyer); 1483 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin, 1484 llvm::Value *arrayEnd, 1485 QualType elementType, 1486 CharUnits elementAlignment, 1487 Destroyer *destroyer); 1488 1489 void pushDestroy(QualType::DestructionKind dtorKind, 1490 Address addr, QualType type); 1491 void pushEHDestroy(QualType::DestructionKind dtorKind, 1492 Address addr, QualType type); 1493 void pushDestroy(CleanupKind kind, Address addr, QualType type, 1494 Destroyer *destroyer, bool useEHCleanupForArray); 1495 void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr, 1496 QualType type, Destroyer *destroyer, 1497 bool useEHCleanupForArray); 1498 void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete, 1499 llvm::Value *CompletePtr, 1500 QualType ElementType); 1501 void pushStackRestore(CleanupKind kind, Address SPMem); 1502 void emitDestroy(Address addr, QualType type, Destroyer *destroyer, 1503 bool useEHCleanupForArray); 1504 llvm::Function *generateDestroyHelper(Address addr, QualType type, 1505 Destroyer *destroyer, 1506 bool useEHCleanupForArray, 1507 const VarDecl *VD); 1508 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end, 1509 QualType elementType, CharUnits elementAlign, 1510 Destroyer *destroyer, 1511 bool checkZeroLength, bool useEHCleanup); 1512 1513 Destroyer *getDestroyer(QualType::DestructionKind destructionKind); 1514 1515 /// Determines whether an EH cleanup is required to destroy a type 1516 /// with the given destruction kind. 1517 bool needsEHCleanup(QualType::DestructionKind kind) { 1518 switch (kind) { 1519 case QualType::DK_none: 1520 return false; 1521 case QualType::DK_cxx_destructor: 1522 case QualType::DK_objc_weak_lifetime: 1523 return getLangOpts().Exceptions; 1524 case QualType::DK_objc_strong_lifetime: 1525 return getLangOpts().Exceptions && 1526 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions; 1527 } 1528 llvm_unreachable("bad destruction kind"); 1529 } 1530 1531 CleanupKind getCleanupKind(QualType::DestructionKind kind) { 1532 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup); 1533 } 1534 1535 //===--------------------------------------------------------------------===// 1536 // Objective-C 1537 //===--------------------------------------------------------------------===// 1538 1539 void GenerateObjCMethod(const ObjCMethodDecl *OMD); 1540 1541 void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD); 1542 1543 /// GenerateObjCGetter - Synthesize an Objective-C property getter function. 1544 void GenerateObjCGetter(ObjCImplementationDecl *IMP, 1545 const ObjCPropertyImplDecl *PID); 1546 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl, 1547 const ObjCPropertyImplDecl *propImpl, 1548 const ObjCMethodDecl *GetterMothodDecl, 1549 llvm::Constant *AtomicHelperFn); 1550 1551 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP, 1552 ObjCMethodDecl *MD, bool ctor); 1553 1554 /// GenerateObjCSetter - Synthesize an Objective-C property setter function 1555 /// for the given property. 1556 void GenerateObjCSetter(ObjCImplementationDecl *IMP, 1557 const ObjCPropertyImplDecl *PID); 1558 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl, 1559 const ObjCPropertyImplDecl *propImpl, 1560 llvm::Constant *AtomicHelperFn); 1561 1562 //===--------------------------------------------------------------------===// 1563 // Block Bits 1564 //===--------------------------------------------------------------------===// 1565 1566 llvm::Value *EmitBlockLiteral(const BlockExpr *); 1567 static void destroyBlockInfos(CGBlockInfo *info); 1568 1569 llvm::Function *GenerateBlockFunction(GlobalDecl GD, 1570 const CGBlockInfo &Info, 1571 const DeclMapTy &ldm, 1572 bool IsLambdaConversionToBlock); 1573 1574 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo); 1575 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo); 1576 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction( 1577 const ObjCPropertyImplDecl *PID); 1578 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction( 1579 const ObjCPropertyImplDecl *PID); 1580 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty); 1581 1582 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags); 1583 1584 class AutoVarEmission; 1585 1586 void emitByrefStructureInit(const AutoVarEmission &emission); 1587 void enterByrefCleanup(const AutoVarEmission &emission); 1588 1589 void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum, 1590 llvm::Value *ptr); 1591 1592 Address LoadBlockStruct(); 1593 Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef); 1594 1595 /// BuildBlockByrefAddress - Computes the location of the 1596 /// data in a variable which is declared as __block. 1597 Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V, 1598 bool followForward = true); 1599 Address emitBlockByrefAddress(Address baseAddr, 1600 const BlockByrefInfo &info, 1601 bool followForward, 1602 const llvm::Twine &name); 1603 1604 const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var); 1605 1606 QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args); 1607 1608 void GenerateCode(GlobalDecl GD, llvm::Function *Fn, 1609 const CGFunctionInfo &FnInfo); 1610 /// \brief Emit code for the start of a function. 1611 /// \param Loc The location to be associated with the function. 1612 /// \param StartLoc The location of the function body. 1613 void StartFunction(GlobalDecl GD, 1614 QualType RetTy, 1615 llvm::Function *Fn, 1616 const CGFunctionInfo &FnInfo, 1617 const FunctionArgList &Args, 1618 SourceLocation Loc = SourceLocation(), 1619 SourceLocation StartLoc = SourceLocation()); 1620 1621 static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor); 1622 1623 void EmitConstructorBody(FunctionArgList &Args); 1624 void EmitDestructorBody(FunctionArgList &Args); 1625 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args); 1626 void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body); 1627 void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S); 1628 1629 void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator, 1630 CallArgList &CallArgs); 1631 void EmitLambdaToBlockPointerBody(FunctionArgList &Args); 1632 void EmitLambdaBlockInvokeBody(); 1633 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD); 1634 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD); 1635 void EmitAsanPrologueOrEpilogue(bool Prologue); 1636 1637 /// \brief Emit the unified return block, trying to avoid its emission when 1638 /// possible. 1639 /// \return The debug location of the user written return statement if the 1640 /// return block is is avoided. 1641 llvm::DebugLoc EmitReturnBlock(); 1642 1643 /// FinishFunction - Complete IR generation of the current function. It is 1644 /// legal to call this function even if there is no current insertion point. 1645 void FinishFunction(SourceLocation EndLoc=SourceLocation()); 1646 1647 void StartThunk(llvm::Function *Fn, GlobalDecl GD, 1648 const CGFunctionInfo &FnInfo); 1649 1650 void EmitCallAndReturnForThunk(llvm::Constant *Callee, 1651 const ThunkInfo *Thunk); 1652 1653 void FinishThunk(); 1654 1655 /// Emit a musttail call for a thunk with a potentially adjusted this pointer. 1656 void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr, 1657 llvm::Value *Callee); 1658 1659 /// Generate a thunk for the given method. 1660 void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo, 1661 GlobalDecl GD, const ThunkInfo &Thunk); 1662 1663 llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn, 1664 const CGFunctionInfo &FnInfo, 1665 GlobalDecl GD, const ThunkInfo &Thunk); 1666 1667 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type, 1668 FunctionArgList &Args); 1669 1670 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init); 1671 1672 /// Struct with all informations about dynamic [sub]class needed to set vptr. 1673 struct VPtr { 1674 BaseSubobject Base; 1675 const CXXRecordDecl *NearestVBase; 1676 CharUnits OffsetFromNearestVBase; 1677 const CXXRecordDecl *VTableClass; 1678 }; 1679 1680 /// Initialize the vtable pointer of the given subobject. 1681 void InitializeVTablePointer(const VPtr &vptr); 1682 1683 typedef llvm::SmallVector<VPtr, 4> VPtrsVector; 1684 1685 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy; 1686 VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass); 1687 1688 void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase, 1689 CharUnits OffsetFromNearestVBase, 1690 bool BaseIsNonVirtualPrimaryBase, 1691 const CXXRecordDecl *VTableClass, 1692 VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs); 1693 1694 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl); 1695 1696 /// GetVTablePtr - Return the Value of the vtable pointer member pointed 1697 /// to by This. 1698 llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy, 1699 const CXXRecordDecl *VTableClass); 1700 1701 enum CFITypeCheckKind { 1702 CFITCK_VCall, 1703 CFITCK_NVCall, 1704 CFITCK_DerivedCast, 1705 CFITCK_UnrelatedCast, 1706 CFITCK_ICall, 1707 }; 1708 1709 /// \brief Derived is the presumed address of an object of type T after a 1710 /// cast. If T is a polymorphic class type, emit a check that the virtual 1711 /// table for Derived belongs to a class derived from T. 1712 void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived, 1713 bool MayBeNull, CFITypeCheckKind TCK, 1714 SourceLocation Loc); 1715 1716 /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable. 1717 /// If vptr CFI is enabled, emit a check that VTable is valid. 1718 void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable, 1719 CFITypeCheckKind TCK, SourceLocation Loc); 1720 1721 /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for 1722 /// RD using llvm.type.test. 1723 void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable, 1724 CFITypeCheckKind TCK, SourceLocation Loc); 1725 1726 /// If whole-program virtual table optimization is enabled, emit an assumption 1727 /// that VTable is a member of RD's type identifier. Or, if vptr CFI is 1728 /// enabled, emit a check that VTable is a member of RD's type identifier. 1729 void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD, 1730 llvm::Value *VTable, SourceLocation Loc); 1731 1732 /// Returns whether we should perform a type checked load when loading a 1733 /// virtual function for virtual calls to members of RD. This is generally 1734 /// true when both vcall CFI and whole-program-vtables are enabled. 1735 bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD); 1736 1737 /// Emit a type checked load from the given vtable. 1738 llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable, 1739 uint64_t VTableByteOffset); 1740 1741 /// CanDevirtualizeMemberFunctionCalls - Checks whether virtual calls on given 1742 /// expr can be devirtualized. 1743 bool CanDevirtualizeMemberFunctionCall(const Expr *Base, 1744 const CXXMethodDecl *MD); 1745 1746 /// EnterDtorCleanups - Enter the cleanups necessary to complete the 1747 /// given phase of destruction for a destructor. The end result 1748 /// should call destructors on members and base classes in reverse 1749 /// order of their construction. 1750 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type); 1751 1752 /// ShouldInstrumentFunction - Return true if the current function should be 1753 /// instrumented with __cyg_profile_func_* calls 1754 bool ShouldInstrumentFunction(); 1755 1756 /// ShouldXRayInstrument - Return true if the current function should be 1757 /// instrumented with XRay nop sleds. 1758 bool ShouldXRayInstrumentFunction() const; 1759 1760 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified 1761 /// instrumentation function with the current function and the call site, if 1762 /// function instrumentation is enabled. 1763 void EmitFunctionInstrumentation(const char *Fn); 1764 1765 /// EmitMCountInstrumentation - Emit call to .mcount. 1766 void EmitMCountInstrumentation(); 1767 1768 /// EmitFunctionProlog - Emit the target specific LLVM code to load the 1769 /// arguments for the given function. This is also responsible for naming the 1770 /// LLVM function arguments. 1771 void EmitFunctionProlog(const CGFunctionInfo &FI, 1772 llvm::Function *Fn, 1773 const FunctionArgList &Args); 1774 1775 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the 1776 /// given temporary. 1777 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc, 1778 SourceLocation EndLoc); 1779 1780 /// Emit a test that checks if the return value \p RV is nonnull. 1781 void EmitReturnValueCheck(llvm::Value *RV, SourceLocation EndLoc); 1782 1783 /// EmitStartEHSpec - Emit the start of the exception spec. 1784 void EmitStartEHSpec(const Decl *D); 1785 1786 /// EmitEndEHSpec - Emit the end of the exception spec. 1787 void EmitEndEHSpec(const Decl *D); 1788 1789 /// getTerminateLandingPad - Return a landing pad that just calls terminate. 1790 llvm::BasicBlock *getTerminateLandingPad(); 1791 1792 /// getTerminateHandler - Return a handler (not a landing pad, just 1793 /// a catch handler) that just calls terminate. This is used when 1794 /// a terminate scope encloses a try. 1795 llvm::BasicBlock *getTerminateHandler(); 1796 1797 llvm::Type *ConvertTypeForMem(QualType T); 1798 llvm::Type *ConvertType(QualType T); 1799 llvm::Type *ConvertType(const TypeDecl *T) { 1800 return ConvertType(getContext().getTypeDeclType(T)); 1801 } 1802 1803 /// LoadObjCSelf - Load the value of self. This function is only valid while 1804 /// generating code for an Objective-C method. 1805 llvm::Value *LoadObjCSelf(); 1806 1807 /// TypeOfSelfObject - Return type of object that this self represents. 1808 QualType TypeOfSelfObject(); 1809 1810 /// hasAggregateLLVMType - Return true if the specified AST type will map into 1811 /// an aggregate LLVM type or is void. 1812 static TypeEvaluationKind getEvaluationKind(QualType T); 1813 1814 static bool hasScalarEvaluationKind(QualType T) { 1815 return getEvaluationKind(T) == TEK_Scalar; 1816 } 1817 1818 static bool hasAggregateEvaluationKind(QualType T) { 1819 return getEvaluationKind(T) == TEK_Aggregate; 1820 } 1821 1822 /// createBasicBlock - Create an LLVM basic block. 1823 llvm::BasicBlock *createBasicBlock(const Twine &name = "", 1824 llvm::Function *parent = nullptr, 1825 llvm::BasicBlock *before = nullptr) { 1826 #ifdef NDEBUG 1827 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before); 1828 #else 1829 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before); 1830 #endif 1831 } 1832 1833 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified 1834 /// label maps to. 1835 JumpDest getJumpDestForLabel(const LabelDecl *S); 1836 1837 /// SimplifyForwardingBlocks - If the given basic block is only a branch to 1838 /// another basic block, simplify it. This assumes that no other code could 1839 /// potentially reference the basic block. 1840 void SimplifyForwardingBlocks(llvm::BasicBlock *BB); 1841 1842 /// EmitBlock - Emit the given block \arg BB and set it as the insert point, 1843 /// adding a fall-through branch from the current insert block if 1844 /// necessary. It is legal to call this function even if there is no current 1845 /// insertion point. 1846 /// 1847 /// IsFinished - If true, indicates that the caller has finished emitting 1848 /// branches to the given block and does not expect to emit code into it. This 1849 /// means the block can be ignored if it is unreachable. 1850 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false); 1851 1852 /// EmitBlockAfterUses - Emit the given block somewhere hopefully 1853 /// near its uses, and leave the insertion point in it. 1854 void EmitBlockAfterUses(llvm::BasicBlock *BB); 1855 1856 /// EmitBranch - Emit a branch to the specified basic block from the current 1857 /// insert block, taking care to avoid creation of branches from dummy 1858 /// blocks. It is legal to call this function even if there is no current 1859 /// insertion point. 1860 /// 1861 /// This function clears the current insertion point. The caller should follow 1862 /// calls to this function with calls to Emit*Block prior to generation new 1863 /// code. 1864 void EmitBranch(llvm::BasicBlock *Block); 1865 1866 /// HaveInsertPoint - True if an insertion point is defined. If not, this 1867 /// indicates that the current code being emitted is unreachable. 1868 bool HaveInsertPoint() const { 1869 return Builder.GetInsertBlock() != nullptr; 1870 } 1871 1872 /// EnsureInsertPoint - Ensure that an insertion point is defined so that 1873 /// emitted IR has a place to go. Note that by definition, if this function 1874 /// creates a block then that block is unreachable; callers may do better to 1875 /// detect when no insertion point is defined and simply skip IR generation. 1876 void EnsureInsertPoint() { 1877 if (!HaveInsertPoint()) 1878 EmitBlock(createBasicBlock()); 1879 } 1880 1881 /// ErrorUnsupported - Print out an error that codegen doesn't support the 1882 /// specified stmt yet. 1883 void ErrorUnsupported(const Stmt *S, const char *Type); 1884 1885 //===--------------------------------------------------------------------===// 1886 // Helpers 1887 //===--------------------------------------------------------------------===// 1888 1889 LValue MakeAddrLValue(Address Addr, QualType T, 1890 LValueBaseInfo BaseInfo = 1891 LValueBaseInfo(AlignmentSource::Type)) { 1892 return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, 1893 CGM.getTBAAInfo(T)); 1894 } 1895 1896 LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment, 1897 LValueBaseInfo BaseInfo = 1898 LValueBaseInfo(AlignmentSource::Type)) { 1899 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), 1900 BaseInfo, CGM.getTBAAInfo(T)); 1901 } 1902 1903 LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T); 1904 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T); 1905 CharUnits getNaturalTypeAlignment(QualType T, 1906 LValueBaseInfo *BaseInfo = nullptr, 1907 bool forPointeeType = false); 1908 CharUnits getNaturalPointeeTypeAlignment(QualType T, 1909 LValueBaseInfo *BaseInfo = nullptr); 1910 1911 Address EmitLoadOfReference(Address Ref, const ReferenceType *RefTy, 1912 LValueBaseInfo *BaseInfo = nullptr); 1913 LValue EmitLoadOfReferenceLValue(Address Ref, const ReferenceType *RefTy); 1914 1915 Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy, 1916 LValueBaseInfo *BaseInfo = nullptr); 1917 LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy); 1918 1919 /// CreateTempAlloca - This creates an alloca and inserts it into the entry 1920 /// block if \p ArraySize is nullptr, otherwise inserts it at the current 1921 /// insertion point of the builder. The caller is responsible for setting an 1922 /// appropriate alignment on 1923 /// the alloca. 1924 /// 1925 /// \p ArraySize is the number of array elements to be allocated if it 1926 /// is not nullptr. 1927 /// 1928 /// LangAS::Default is the address space of pointers to local variables and 1929 /// temporaries, as exposed in the source language. In certain 1930 /// configurations, this is not the same as the alloca address space, and a 1931 /// cast is needed to lift the pointer from the alloca AS into 1932 /// LangAS::Default. This can happen when the target uses a restricted 1933 /// address space for the stack but the source language requires 1934 /// LangAS::Default to be a generic address space. The latter condition is 1935 /// common for most programming languages; OpenCL is an exception in that 1936 /// LangAS::Default is the private address space, which naturally maps 1937 /// to the stack. 1938 /// 1939 /// Because the address of a temporary is often exposed to the program in 1940 /// various ways, this function will perform the cast by default. The cast 1941 /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is 1942 /// more efficient if the caller knows that the address will not be exposed. 1943 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp", 1944 llvm::Value *ArraySize = nullptr); 1945 Address CreateTempAlloca(llvm::Type *Ty, CharUnits align, 1946 const Twine &Name = "tmp", 1947 llvm::Value *ArraySize = nullptr, 1948 bool CastToDefaultAddrSpace = true); 1949 1950 /// CreateDefaultAlignedTempAlloca - This creates an alloca with the 1951 /// default ABI alignment of the given LLVM type. 1952 /// 1953 /// IMPORTANT NOTE: This is *not* generally the right alignment for 1954 /// any given AST type that happens to have been lowered to the 1955 /// given IR type. This should only ever be used for function-local, 1956 /// IR-driven manipulations like saving and restoring a value. Do 1957 /// not hand this address off to arbitrary IRGen routines, and especially 1958 /// do not pass it as an argument to a function that might expect a 1959 /// properly ABI-aligned value. 1960 Address CreateDefaultAlignTempAlloca(llvm::Type *Ty, 1961 const Twine &Name = "tmp"); 1962 1963 /// InitTempAlloca - Provide an initial value for the given alloca which 1964 /// will be observable at all locations in the function. 1965 /// 1966 /// The address should be something that was returned from one of 1967 /// the CreateTempAlloca or CreateMemTemp routines, and the 1968 /// initializer must be valid in the entry block (i.e. it must 1969 /// either be a constant or an argument value). 1970 void InitTempAlloca(Address Alloca, llvm::Value *Value); 1971 1972 /// CreateIRTemp - Create a temporary IR object of the given type, with 1973 /// appropriate alignment. This routine should only be used when an temporary 1974 /// value needs to be stored into an alloca (for example, to avoid explicit 1975 /// PHI construction), but the type is the IR type, not the type appropriate 1976 /// for storing in memory. 1977 /// 1978 /// That is, this is exactly equivalent to CreateMemTemp, but calling 1979 /// ConvertType instead of ConvertTypeForMem. 1980 Address CreateIRTemp(QualType T, const Twine &Name = "tmp"); 1981 1982 /// CreateMemTemp - Create a temporary memory object of the given type, with 1983 /// appropriate alignment. Cast it to the default address space if 1984 /// \p CastToDefaultAddrSpace is true. 1985 Address CreateMemTemp(QualType T, const Twine &Name = "tmp", 1986 bool CastToDefaultAddrSpace = true); 1987 Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp", 1988 bool CastToDefaultAddrSpace = true); 1989 1990 /// CreateAggTemp - Create a temporary memory object for the given 1991 /// aggregate type. 1992 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") { 1993 return AggValueSlot::forAddr(CreateMemTemp(T, Name), 1994 T.getQualifiers(), 1995 AggValueSlot::IsNotDestructed, 1996 AggValueSlot::DoesNotNeedGCBarriers, 1997 AggValueSlot::IsNotAliased); 1998 } 1999 2000 /// Emit a cast to void* in the appropriate address space. 2001 llvm::Value *EmitCastToVoidPtr(llvm::Value *value); 2002 2003 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified 2004 /// expression and compare the result against zero, returning an Int1Ty value. 2005 llvm::Value *EvaluateExprAsBool(const Expr *E); 2006 2007 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result. 2008 void EmitIgnoredExpr(const Expr *E); 2009 2010 /// EmitAnyExpr - Emit code to compute the specified expression which can have 2011 /// any type. The result is returned as an RValue struct. If this is an 2012 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where 2013 /// the result should be returned. 2014 /// 2015 /// \param ignoreResult True if the resulting value isn't used. 2016 RValue EmitAnyExpr(const Expr *E, 2017 AggValueSlot aggSlot = AggValueSlot::ignored(), 2018 bool ignoreResult = false); 2019 2020 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address 2021 // or the value of the expression, depending on how va_list is defined. 2022 Address EmitVAListRef(const Expr *E); 2023 2024 /// Emit a "reference" to a __builtin_ms_va_list; this is 2025 /// always the value of the expression, because a __builtin_ms_va_list is a 2026 /// pointer to a char. 2027 Address EmitMSVAListRef(const Expr *E); 2028 2029 /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will 2030 /// always be accessible even if no aggregate location is provided. 2031 RValue EmitAnyExprToTemp(const Expr *E); 2032 2033 /// EmitAnyExprToMem - Emits the code necessary to evaluate an 2034 /// arbitrary expression into the given memory location. 2035 void EmitAnyExprToMem(const Expr *E, Address Location, 2036 Qualifiers Quals, bool IsInitializer); 2037 2038 void EmitAnyExprToExn(const Expr *E, Address Addr); 2039 2040 /// EmitExprAsInit - Emits the code necessary to initialize a 2041 /// location in memory with the given initializer. 2042 void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue, 2043 bool capturedByInit); 2044 2045 /// hasVolatileMember - returns true if aggregate type has a volatile 2046 /// member. 2047 bool hasVolatileMember(QualType T) { 2048 if (const RecordType *RT = T->getAs<RecordType>()) { 2049 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl()); 2050 return RD->hasVolatileMember(); 2051 } 2052 return false; 2053 } 2054 /// EmitAggregateCopy - Emit an aggregate assignment. 2055 /// 2056 /// The difference to EmitAggregateCopy is that tail padding is not copied. 2057 /// This is required for correctness when assigning non-POD structures in C++. 2058 void EmitAggregateAssign(Address DestPtr, Address SrcPtr, 2059 QualType EltTy) { 2060 bool IsVolatile = hasVolatileMember(EltTy); 2061 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true); 2062 } 2063 2064 void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr, 2065 QualType DestTy, QualType SrcTy) { 2066 EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false, 2067 /*IsAssignment=*/false); 2068 } 2069 2070 /// EmitAggregateCopy - Emit an aggregate copy. 2071 /// 2072 /// \param isVolatile - True iff either the source or the destination is 2073 /// volatile. 2074 /// \param isAssignment - If false, allow padding to be copied. This often 2075 /// yields more efficient. 2076 void EmitAggregateCopy(Address DestPtr, Address SrcPtr, 2077 QualType EltTy, bool isVolatile=false, 2078 bool isAssignment = false); 2079 2080 /// GetAddrOfLocalVar - Return the address of a local variable. 2081 Address GetAddrOfLocalVar(const VarDecl *VD) { 2082 auto it = LocalDeclMap.find(VD); 2083 assert(it != LocalDeclMap.end() && 2084 "Invalid argument to GetAddrOfLocalVar(), no decl!"); 2085 return it->second; 2086 } 2087 2088 /// getOpaqueLValueMapping - Given an opaque value expression (which 2089 /// must be mapped to an l-value), return its mapping. 2090 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) { 2091 assert(OpaqueValueMapping::shouldBindAsLValue(e)); 2092 2093 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator 2094 it = OpaqueLValues.find(e); 2095 assert(it != OpaqueLValues.end() && "no mapping for opaque value!"); 2096 return it->second; 2097 } 2098 2099 /// getOpaqueRValueMapping - Given an opaque value expression (which 2100 /// must be mapped to an r-value), return its mapping. 2101 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) { 2102 assert(!OpaqueValueMapping::shouldBindAsLValue(e)); 2103 2104 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator 2105 it = OpaqueRValues.find(e); 2106 assert(it != OpaqueRValues.end() && "no mapping for opaque value!"); 2107 return it->second; 2108 } 2109 2110 /// Get the index of the current ArrayInitLoopExpr, if any. 2111 llvm::Value *getArrayInitIndex() { return ArrayInitIndex; } 2112 2113 /// getAccessedFieldNo - Given an encoded value and a result number, return 2114 /// the input field number being accessed. 2115 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts); 2116 2117 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L); 2118 llvm::BasicBlock *GetIndirectGotoBlock(); 2119 2120 /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts. 2121 static bool IsWrappedCXXThis(const Expr *E); 2122 2123 /// EmitNullInitialization - Generate code to set a value of the given type to 2124 /// null, If the type contains data member pointers, they will be initialized 2125 /// to -1 in accordance with the Itanium C++ ABI. 2126 void EmitNullInitialization(Address DestPtr, QualType Ty); 2127 2128 /// Emits a call to an LLVM variable-argument intrinsic, either 2129 /// \c llvm.va_start or \c llvm.va_end. 2130 /// \param ArgValue A reference to the \c va_list as emitted by either 2131 /// \c EmitVAListRef or \c EmitMSVAListRef. 2132 /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise, 2133 /// calls \c llvm.va_end. 2134 llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart); 2135 2136 /// Generate code to get an argument from the passed in pointer 2137 /// and update it accordingly. 2138 /// \param VE The \c VAArgExpr for which to generate code. 2139 /// \param VAListAddr Receives a reference to the \c va_list as emitted by 2140 /// either \c EmitVAListRef or \c EmitMSVAListRef. 2141 /// \returns A pointer to the argument. 2142 // FIXME: We should be able to get rid of this method and use the va_arg 2143 // instruction in LLVM instead once it works well enough. 2144 Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr); 2145 2146 /// emitArrayLength - Compute the length of an array, even if it's a 2147 /// VLA, and drill down to the base element type. 2148 llvm::Value *emitArrayLength(const ArrayType *arrayType, 2149 QualType &baseType, 2150 Address &addr); 2151 2152 /// EmitVLASize - Capture all the sizes for the VLA expressions in 2153 /// the given variably-modified type and store them in the VLASizeMap. 2154 /// 2155 /// This function can be called with a null (unreachable) insert point. 2156 void EmitVariablyModifiedType(QualType Ty); 2157 2158 /// getVLASize - Returns an LLVM value that corresponds to the size, 2159 /// in non-variably-sized elements, of a variable length array type, 2160 /// plus that largest non-variably-sized element type. Assumes that 2161 /// the type has already been emitted with EmitVariablyModifiedType. 2162 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla); 2163 std::pair<llvm::Value*,QualType> getVLASize(QualType vla); 2164 2165 /// LoadCXXThis - Load the value of 'this'. This function is only valid while 2166 /// generating code for an C++ member function. 2167 llvm::Value *LoadCXXThis() { 2168 assert(CXXThisValue && "no 'this' value for this function"); 2169 return CXXThisValue; 2170 } 2171 Address LoadCXXThisAddress(); 2172 2173 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have 2174 /// virtual bases. 2175 // FIXME: Every place that calls LoadCXXVTT is something 2176 // that needs to be abstracted properly. 2177 llvm::Value *LoadCXXVTT() { 2178 assert(CXXStructorImplicitParamValue && "no VTT value for this function"); 2179 return CXXStructorImplicitParamValue; 2180 } 2181 2182 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a 2183 /// complete class to the given direct base. 2184 Address 2185 GetAddressOfDirectBaseInCompleteClass(Address Value, 2186 const CXXRecordDecl *Derived, 2187 const CXXRecordDecl *Base, 2188 bool BaseIsVirtual); 2189 2190 static bool ShouldNullCheckClassCastValue(const CastExpr *Cast); 2191 2192 /// GetAddressOfBaseClass - This function will add the necessary delta to the 2193 /// load of 'this' and returns address of the base class. 2194 Address GetAddressOfBaseClass(Address Value, 2195 const CXXRecordDecl *Derived, 2196 CastExpr::path_const_iterator PathBegin, 2197 CastExpr::path_const_iterator PathEnd, 2198 bool NullCheckValue, SourceLocation Loc); 2199 2200 Address GetAddressOfDerivedClass(Address Value, 2201 const CXXRecordDecl *Derived, 2202 CastExpr::path_const_iterator PathBegin, 2203 CastExpr::path_const_iterator PathEnd, 2204 bool NullCheckValue); 2205 2206 /// GetVTTParameter - Return the VTT parameter that should be passed to a 2207 /// base constructor/destructor with virtual bases. 2208 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move 2209 /// to ItaniumCXXABI.cpp together with all the references to VTT. 2210 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase, 2211 bool Delegating); 2212 2213 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor, 2214 CXXCtorType CtorType, 2215 const FunctionArgList &Args, 2216 SourceLocation Loc); 2217 // It's important not to confuse this and the previous function. Delegating 2218 // constructors are the C++0x feature. The constructor delegate optimization 2219 // is used to reduce duplication in the base and complete consturctors where 2220 // they are substantially the same. 2221 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor, 2222 const FunctionArgList &Args); 2223 2224 /// Emit a call to an inheriting constructor (that is, one that invokes a 2225 /// constructor inherited from a base class) by inlining its definition. This 2226 /// is necessary if the ABI does not support forwarding the arguments to the 2227 /// base class constructor (because they're variadic or similar). 2228 void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor, 2229 CXXCtorType CtorType, 2230 bool ForVirtualBase, 2231 bool Delegating, 2232 CallArgList &Args); 2233 2234 /// Emit a call to a constructor inherited from a base class, passing the 2235 /// current constructor's arguments along unmodified (without even making 2236 /// a copy). 2237 void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D, 2238 bool ForVirtualBase, Address This, 2239 bool InheritedFromVBase, 2240 const CXXInheritedCtorInitExpr *E); 2241 2242 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type, 2243 bool ForVirtualBase, bool Delegating, 2244 Address This, const CXXConstructExpr *E); 2245 2246 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type, 2247 bool ForVirtualBase, bool Delegating, 2248 Address This, CallArgList &Args); 2249 2250 /// Emit assumption load for all bases. Requires to be be called only on 2251 /// most-derived class and not under construction of the object. 2252 void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This); 2253 2254 /// Emit assumption that vptr load == global vtable. 2255 void EmitVTableAssumptionLoad(const VPtr &vptr, Address This); 2256 2257 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D, 2258 Address This, Address Src, 2259 const CXXConstructExpr *E); 2260 2261 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D, 2262 const ArrayType *ArrayTy, 2263 Address ArrayPtr, 2264 const CXXConstructExpr *E, 2265 bool ZeroInitialization = false); 2266 2267 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D, 2268 llvm::Value *NumElements, 2269 Address ArrayPtr, 2270 const CXXConstructExpr *E, 2271 bool ZeroInitialization = false); 2272 2273 static Destroyer destroyCXXObject; 2274 2275 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type, 2276 bool ForVirtualBase, bool Delegating, 2277 Address This); 2278 2279 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType, 2280 llvm::Type *ElementTy, Address NewPtr, 2281 llvm::Value *NumElements, 2282 llvm::Value *AllocSizeWithoutCookie); 2283 2284 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType, 2285 Address Ptr); 2286 2287 llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr); 2288 void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr); 2289 2290 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E); 2291 void EmitCXXDeleteExpr(const CXXDeleteExpr *E); 2292 2293 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr, 2294 QualType DeleteTy, llvm::Value *NumElements = nullptr, 2295 CharUnits CookieSize = CharUnits()); 2296 2297 RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type, 2298 const Expr *Arg, bool IsDelete); 2299 2300 llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E); 2301 llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE); 2302 Address EmitCXXUuidofExpr(const CXXUuidofExpr *E); 2303 2304 /// \brief Situations in which we might emit a check for the suitability of a 2305 /// pointer or glvalue. 2306 enum TypeCheckKind { 2307 /// Checking the operand of a load. Must be suitably sized and aligned. 2308 TCK_Load, 2309 /// Checking the destination of a store. Must be suitably sized and aligned. 2310 TCK_Store, 2311 /// Checking the bound value in a reference binding. Must be suitably sized 2312 /// and aligned, but is not required to refer to an object (until the 2313 /// reference is used), per core issue 453. 2314 TCK_ReferenceBinding, 2315 /// Checking the object expression in a non-static data member access. Must 2316 /// be an object within its lifetime. 2317 TCK_MemberAccess, 2318 /// Checking the 'this' pointer for a call to a non-static member function. 2319 /// Must be an object within its lifetime. 2320 TCK_MemberCall, 2321 /// Checking the 'this' pointer for a constructor call. 2322 TCK_ConstructorCall, 2323 /// Checking the operand of a static_cast to a derived pointer type. Must be 2324 /// null or an object within its lifetime. 2325 TCK_DowncastPointer, 2326 /// Checking the operand of a static_cast to a derived reference type. Must 2327 /// be an object within its lifetime. 2328 TCK_DowncastReference, 2329 /// Checking the operand of a cast to a base object. Must be suitably sized 2330 /// and aligned. 2331 TCK_Upcast, 2332 /// Checking the operand of a cast to a virtual base object. Must be an 2333 /// object within its lifetime. 2334 TCK_UpcastToVirtualBase, 2335 /// Checking the value assigned to a _Nonnull pointer. Must not be null. 2336 TCK_NonnullAssign 2337 }; 2338 2339 /// \brief Whether any type-checking sanitizers are enabled. If \c false, 2340 /// calls to EmitTypeCheck can be skipped. 2341 bool sanitizePerformTypeCheck() const; 2342 2343 /// \brief Emit a check that \p V is the address of storage of the 2344 /// appropriate size and alignment for an object of type \p Type. 2345 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V, 2346 QualType Type, CharUnits Alignment = CharUnits::Zero(), 2347 SanitizerSet SkippedChecks = SanitizerSet()); 2348 2349 /// \brief Emit a check that \p Base points into an array object, which 2350 /// we can access at index \p Index. \p Accessed should be \c false if we 2351 /// this expression is used as an lvalue, for instance in "&Arr[Idx]". 2352 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index, 2353 QualType IndexType, bool Accessed); 2354 2355 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV, 2356 bool isInc, bool isPre); 2357 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV, 2358 bool isInc, bool isPre); 2359 2360 void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment, 2361 llvm::Value *OffsetValue = nullptr) { 2362 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment, 2363 OffsetValue); 2364 } 2365 2366 /// Converts Location to a DebugLoc, if debug information is enabled. 2367 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location); 2368 2369 2370 //===--------------------------------------------------------------------===// 2371 // Declaration Emission 2372 //===--------------------------------------------------------------------===// 2373 2374 /// EmitDecl - Emit a declaration. 2375 /// 2376 /// This function can be called with a null (unreachable) insert point. 2377 void EmitDecl(const Decl &D); 2378 2379 /// EmitVarDecl - Emit a local variable declaration. 2380 /// 2381 /// This function can be called with a null (unreachable) insert point. 2382 void EmitVarDecl(const VarDecl &D); 2383 2384 void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue, 2385 bool capturedByInit); 2386 2387 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D, 2388 llvm::Value *Address); 2389 2390 /// \brief Determine whether the given initializer is trivial in the sense 2391 /// that it requires no code to be generated. 2392 bool isTrivialInitializer(const Expr *Init); 2393 2394 /// EmitAutoVarDecl - Emit an auto variable declaration. 2395 /// 2396 /// This function can be called with a null (unreachable) insert point. 2397 void EmitAutoVarDecl(const VarDecl &D); 2398 2399 class AutoVarEmission { 2400 friend class CodeGenFunction; 2401 2402 const VarDecl *Variable; 2403 2404 /// The address of the alloca. Invalid if the variable was emitted 2405 /// as a global constant. 2406 Address Addr; 2407 2408 llvm::Value *NRVOFlag; 2409 2410 /// True if the variable is a __block variable. 2411 bool IsByRef; 2412 2413 /// True if the variable is of aggregate type and has a constant 2414 /// initializer. 2415 bool IsConstantAggregate; 2416 2417 /// Non-null if we should use lifetime annotations. 2418 llvm::Value *SizeForLifetimeMarkers; 2419 2420 struct Invalid {}; 2421 AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {} 2422 2423 AutoVarEmission(const VarDecl &variable) 2424 : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr), 2425 IsByRef(false), IsConstantAggregate(false), 2426 SizeForLifetimeMarkers(nullptr) {} 2427 2428 bool wasEmittedAsGlobal() const { return !Addr.isValid(); } 2429 2430 public: 2431 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); } 2432 2433 bool useLifetimeMarkers() const { 2434 return SizeForLifetimeMarkers != nullptr; 2435 } 2436 llvm::Value *getSizeForLifetimeMarkers() const { 2437 assert(useLifetimeMarkers()); 2438 return SizeForLifetimeMarkers; 2439 } 2440 2441 /// Returns the raw, allocated address, which is not necessarily 2442 /// the address of the object itself. 2443 Address getAllocatedAddress() const { 2444 return Addr; 2445 } 2446 2447 /// Returns the address of the object within this declaration. 2448 /// Note that this does not chase the forwarding pointer for 2449 /// __block decls. 2450 Address getObjectAddress(CodeGenFunction &CGF) const { 2451 if (!IsByRef) return Addr; 2452 2453 return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false); 2454 } 2455 }; 2456 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var); 2457 void EmitAutoVarInit(const AutoVarEmission &emission); 2458 void EmitAutoVarCleanups(const AutoVarEmission &emission); 2459 void emitAutoVarTypeCleanup(const AutoVarEmission &emission, 2460 QualType::DestructionKind dtorKind); 2461 2462 void EmitStaticVarDecl(const VarDecl &D, 2463 llvm::GlobalValue::LinkageTypes Linkage); 2464 2465 class ParamValue { 2466 llvm::Value *Value; 2467 unsigned Alignment; 2468 ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {} 2469 public: 2470 static ParamValue forDirect(llvm::Value *value) { 2471 return ParamValue(value, 0); 2472 } 2473 static ParamValue forIndirect(Address addr) { 2474 assert(!addr.getAlignment().isZero()); 2475 return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity()); 2476 } 2477 2478 bool isIndirect() const { return Alignment != 0; } 2479 llvm::Value *getAnyValue() const { return Value; } 2480 2481 llvm::Value *getDirectValue() const { 2482 assert(!isIndirect()); 2483 return Value; 2484 } 2485 2486 Address getIndirectAddress() const { 2487 assert(isIndirect()); 2488 return Address(Value, CharUnits::fromQuantity(Alignment)); 2489 } 2490 }; 2491 2492 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl. 2493 void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo); 2494 2495 /// protectFromPeepholes - Protect a value that we're intending to 2496 /// store to the side, but which will probably be used later, from 2497 /// aggressive peepholing optimizations that might delete it. 2498 /// 2499 /// Pass the result to unprotectFromPeepholes to declare that 2500 /// protection is no longer required. 2501 /// 2502 /// There's no particular reason why this shouldn't apply to 2503 /// l-values, it's just that no existing peepholes work on pointers. 2504 PeepholeProtection protectFromPeepholes(RValue rvalue); 2505 void unprotectFromPeepholes(PeepholeProtection protection); 2506 2507 void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment, 2508 llvm::Value *OffsetValue = nullptr) { 2509 Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment, 2510 OffsetValue); 2511 } 2512 2513 //===--------------------------------------------------------------------===// 2514 // Statement Emission 2515 //===--------------------------------------------------------------------===// 2516 2517 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info. 2518 void EmitStopPoint(const Stmt *S); 2519 2520 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call 2521 /// this function even if there is no current insertion point. 2522 /// 2523 /// This function may clear the current insertion point; callers should use 2524 /// EnsureInsertPoint if they wish to subsequently generate code without first 2525 /// calling EmitBlock, EmitBranch, or EmitStmt. 2526 void EmitStmt(const Stmt *S); 2527 2528 /// EmitSimpleStmt - Try to emit a "simple" statement which does not 2529 /// necessarily require an insertion point or debug information; typically 2530 /// because the statement amounts to a jump or a container of other 2531 /// statements. 2532 /// 2533 /// \return True if the statement was handled. 2534 bool EmitSimpleStmt(const Stmt *S); 2535 2536 Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false, 2537 AggValueSlot AVS = AggValueSlot::ignored()); 2538 Address EmitCompoundStmtWithoutScope(const CompoundStmt &S, 2539 bool GetLast = false, 2540 AggValueSlot AVS = 2541 AggValueSlot::ignored()); 2542 2543 /// EmitLabel - Emit the block for the given label. It is legal to call this 2544 /// function even if there is no current insertion point. 2545 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt. 2546 2547 void EmitLabelStmt(const LabelStmt &S); 2548 void EmitAttributedStmt(const AttributedStmt &S); 2549 void EmitGotoStmt(const GotoStmt &S); 2550 void EmitIndirectGotoStmt(const IndirectGotoStmt &S); 2551 void EmitIfStmt(const IfStmt &S); 2552 2553 void EmitWhileStmt(const WhileStmt &S, 2554 ArrayRef<const Attr *> Attrs = None); 2555 void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None); 2556 void EmitForStmt(const ForStmt &S, 2557 ArrayRef<const Attr *> Attrs = None); 2558 void EmitReturnStmt(const ReturnStmt &S); 2559 void EmitDeclStmt(const DeclStmt &S); 2560 void EmitBreakStmt(const BreakStmt &S); 2561 void EmitContinueStmt(const ContinueStmt &S); 2562 void EmitSwitchStmt(const SwitchStmt &S); 2563 void EmitDefaultStmt(const DefaultStmt &S); 2564 void EmitCaseStmt(const CaseStmt &S); 2565 void EmitCaseStmtRange(const CaseStmt &S); 2566 void EmitAsmStmt(const AsmStmt &S); 2567 2568 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S); 2569 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S); 2570 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S); 2571 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S); 2572 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S); 2573 2574 void EmitCoroutineBody(const CoroutineBodyStmt &S); 2575 void EmitCoreturnStmt(const CoreturnStmt &S); 2576 RValue EmitCoawaitExpr(const CoawaitExpr &E, 2577 AggValueSlot aggSlot = AggValueSlot::ignored(), 2578 bool ignoreResult = false); 2579 LValue EmitCoawaitLValue(const CoawaitExpr *E); 2580 RValue EmitCoyieldExpr(const CoyieldExpr &E, 2581 AggValueSlot aggSlot = AggValueSlot::ignored(), 2582 bool ignoreResult = false); 2583 LValue EmitCoyieldLValue(const CoyieldExpr *E); 2584 RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID); 2585 2586 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false); 2587 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false); 2588 2589 void EmitCXXTryStmt(const CXXTryStmt &S); 2590 void EmitSEHTryStmt(const SEHTryStmt &S); 2591 void EmitSEHLeaveStmt(const SEHLeaveStmt &S); 2592 void EnterSEHTryStmt(const SEHTryStmt &S); 2593 void ExitSEHTryStmt(const SEHTryStmt &S); 2594 2595 void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter, 2596 const Stmt *OutlinedStmt); 2597 2598 llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF, 2599 const SEHExceptStmt &Except); 2600 2601 llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF, 2602 const SEHFinallyStmt &Finally); 2603 2604 void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF, 2605 llvm::Value *ParentFP, 2606 llvm::Value *EntryEBP); 2607 llvm::Value *EmitSEHExceptionCode(); 2608 llvm::Value *EmitSEHExceptionInfo(); 2609 llvm::Value *EmitSEHAbnormalTermination(); 2610 2611 /// Scan the outlined statement for captures from the parent function. For 2612 /// each capture, mark the capture as escaped and emit a call to 2613 /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap. 2614 void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt, 2615 bool IsFilter); 2616 2617 /// Recovers the address of a local in a parent function. ParentVar is the 2618 /// address of the variable used in the immediate parent function. It can 2619 /// either be an alloca or a call to llvm.localrecover if there are nested 2620 /// outlined functions. ParentFP is the frame pointer of the outermost parent 2621 /// frame. 2622 Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF, 2623 Address ParentVar, 2624 llvm::Value *ParentFP); 2625 2626 void EmitCXXForRangeStmt(const CXXForRangeStmt &S, 2627 ArrayRef<const Attr *> Attrs = None); 2628 2629 /// Returns calculated size of the specified type. 2630 llvm::Value *getTypeSize(QualType Ty); 2631 LValue InitCapturedStruct(const CapturedStmt &S); 2632 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K); 2633 llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S); 2634 Address GenerateCapturedStmtArgument(const CapturedStmt &S); 2635 llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S); 2636 void GenerateOpenMPCapturedVars(const CapturedStmt &S, 2637 SmallVectorImpl<llvm::Value *> &CapturedVars); 2638 void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy, 2639 SourceLocation Loc); 2640 /// \brief Perform element by element copying of arrays with type \a 2641 /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure 2642 /// generated by \a CopyGen. 2643 /// 2644 /// \param DestAddr Address of the destination array. 2645 /// \param SrcAddr Address of the source array. 2646 /// \param OriginalType Type of destination and source arrays. 2647 /// \param CopyGen Copying procedure that copies value of single array element 2648 /// to another single array element. 2649 void EmitOMPAggregateAssign( 2650 Address DestAddr, Address SrcAddr, QualType OriginalType, 2651 const llvm::function_ref<void(Address, Address)> &CopyGen); 2652 /// \brief Emit proper copying of data from one variable to another. 2653 /// 2654 /// \param OriginalType Original type of the copied variables. 2655 /// \param DestAddr Destination address. 2656 /// \param SrcAddr Source address. 2657 /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has 2658 /// type of the base array element). 2659 /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of 2660 /// the base array element). 2661 /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a 2662 /// DestVD. 2663 void EmitOMPCopy(QualType OriginalType, 2664 Address DestAddr, Address SrcAddr, 2665 const VarDecl *DestVD, const VarDecl *SrcVD, 2666 const Expr *Copy); 2667 /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or 2668 /// \a X = \a E \a BO \a E. 2669 /// 2670 /// \param X Value to be updated. 2671 /// \param E Update value. 2672 /// \param BO Binary operation for update operation. 2673 /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update 2674 /// expression, false otherwise. 2675 /// \param AO Atomic ordering of the generated atomic instructions. 2676 /// \param CommonGen Code generator for complex expressions that cannot be 2677 /// expressed through atomicrmw instruction. 2678 /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was 2679 /// generated, <false, RValue::get(nullptr)> otherwise. 2680 std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr( 2681 LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart, 2682 llvm::AtomicOrdering AO, SourceLocation Loc, 2683 const llvm::function_ref<RValue(RValue)> &CommonGen); 2684 bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D, 2685 OMPPrivateScope &PrivateScope); 2686 void EmitOMPPrivateClause(const OMPExecutableDirective &D, 2687 OMPPrivateScope &PrivateScope); 2688 void EmitOMPUseDevicePtrClause( 2689 const OMPClause &C, OMPPrivateScope &PrivateScope, 2690 const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap); 2691 /// \brief Emit code for copyin clause in \a D directive. The next code is 2692 /// generated at the start of outlined functions for directives: 2693 /// \code 2694 /// threadprivate_var1 = master_threadprivate_var1; 2695 /// operator=(threadprivate_var2, master_threadprivate_var2); 2696 /// ... 2697 /// __kmpc_barrier(&loc, global_tid); 2698 /// \endcode 2699 /// 2700 /// \param D OpenMP directive possibly with 'copyin' clause(s). 2701 /// \returns true if at least one copyin variable is found, false otherwise. 2702 bool EmitOMPCopyinClause(const OMPExecutableDirective &D); 2703 /// \brief Emit initial code for lastprivate variables. If some variable is 2704 /// not also firstprivate, then the default initialization is used. Otherwise 2705 /// initialization of this variable is performed by EmitOMPFirstprivateClause 2706 /// method. 2707 /// 2708 /// \param D Directive that may have 'lastprivate' directives. 2709 /// \param PrivateScope Private scope for capturing lastprivate variables for 2710 /// proper codegen in internal captured statement. 2711 /// 2712 /// \returns true if there is at least one lastprivate variable, false 2713 /// otherwise. 2714 bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D, 2715 OMPPrivateScope &PrivateScope); 2716 /// \brief Emit final copying of lastprivate values to original variables at 2717 /// the end of the worksharing or simd directive. 2718 /// 2719 /// \param D Directive that has at least one 'lastprivate' directives. 2720 /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if 2721 /// it is the last iteration of the loop code in associated directive, or to 2722 /// 'i1 false' otherwise. If this item is nullptr, no final check is required. 2723 void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D, 2724 bool NoFinals, 2725 llvm::Value *IsLastIterCond = nullptr); 2726 /// Emit initial code for linear clauses. 2727 void EmitOMPLinearClause(const OMPLoopDirective &D, 2728 CodeGenFunction::OMPPrivateScope &PrivateScope); 2729 /// Emit final code for linear clauses. 2730 /// \param CondGen Optional conditional code for final part of codegen for 2731 /// linear clause. 2732 void EmitOMPLinearClauseFinal( 2733 const OMPLoopDirective &D, 2734 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen); 2735 /// \brief Emit initial code for reduction variables. Creates reduction copies 2736 /// and initializes them with the values according to OpenMP standard. 2737 /// 2738 /// \param D Directive (possibly) with the 'reduction' clause. 2739 /// \param PrivateScope Private scope for capturing reduction variables for 2740 /// proper codegen in internal captured statement. 2741 /// 2742 void EmitOMPReductionClauseInit(const OMPExecutableDirective &D, 2743 OMPPrivateScope &PrivateScope); 2744 /// \brief Emit final update of reduction values to original variables at 2745 /// the end of the directive. 2746 /// 2747 /// \param D Directive that has at least one 'reduction' directives. 2748 /// \param ReductionKind The kind of reduction to perform. 2749 void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D, 2750 const OpenMPDirectiveKind ReductionKind); 2751 /// \brief Emit initial code for linear variables. Creates private copies 2752 /// and initializes them with the values according to OpenMP standard. 2753 /// 2754 /// \param D Directive (possibly) with the 'linear' clause. 2755 void EmitOMPLinearClauseInit(const OMPLoopDirective &D); 2756 2757 typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/, 2758 llvm::Value * /*OutlinedFn*/, 2759 const OMPTaskDataTy & /*Data*/)> 2760 TaskGenTy; 2761 void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S, 2762 const RegionCodeGenTy &BodyGen, 2763 const TaskGenTy &TaskGen, OMPTaskDataTy &Data); 2764 2765 void EmitOMPParallelDirective(const OMPParallelDirective &S); 2766 void EmitOMPSimdDirective(const OMPSimdDirective &S); 2767 void EmitOMPForDirective(const OMPForDirective &S); 2768 void EmitOMPForSimdDirective(const OMPForSimdDirective &S); 2769 void EmitOMPSectionsDirective(const OMPSectionsDirective &S); 2770 void EmitOMPSectionDirective(const OMPSectionDirective &S); 2771 void EmitOMPSingleDirective(const OMPSingleDirective &S); 2772 void EmitOMPMasterDirective(const OMPMasterDirective &S); 2773 void EmitOMPCriticalDirective(const OMPCriticalDirective &S); 2774 void EmitOMPParallelForDirective(const OMPParallelForDirective &S); 2775 void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S); 2776 void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S); 2777 void EmitOMPTaskDirective(const OMPTaskDirective &S); 2778 void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S); 2779 void EmitOMPBarrierDirective(const OMPBarrierDirective &S); 2780 void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S); 2781 void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S); 2782 void EmitOMPFlushDirective(const OMPFlushDirective &S); 2783 void EmitOMPOrderedDirective(const OMPOrderedDirective &S); 2784 void EmitOMPAtomicDirective(const OMPAtomicDirective &S); 2785 void EmitOMPTargetDirective(const OMPTargetDirective &S); 2786 void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S); 2787 void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S); 2788 void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S); 2789 void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S); 2790 void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S); 2791 void 2792 EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S); 2793 void EmitOMPTeamsDirective(const OMPTeamsDirective &S); 2794 void 2795 EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S); 2796 void EmitOMPCancelDirective(const OMPCancelDirective &S); 2797 void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S); 2798 void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S); 2799 void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S); 2800 void EmitOMPDistributeDirective(const OMPDistributeDirective &S); 2801 void EmitOMPDistributeParallelForDirective( 2802 const OMPDistributeParallelForDirective &S); 2803 void EmitOMPDistributeParallelForSimdDirective( 2804 const OMPDistributeParallelForSimdDirective &S); 2805 void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S); 2806 void EmitOMPTargetParallelForSimdDirective( 2807 const OMPTargetParallelForSimdDirective &S); 2808 void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S); 2809 void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S); 2810 void 2811 EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S); 2812 void EmitOMPTeamsDistributeParallelForSimdDirective( 2813 const OMPTeamsDistributeParallelForSimdDirective &S); 2814 void EmitOMPTeamsDistributeParallelForDirective( 2815 const OMPTeamsDistributeParallelForDirective &S); 2816 void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S); 2817 void EmitOMPTargetTeamsDistributeDirective( 2818 const OMPTargetTeamsDistributeDirective &S); 2819 void EmitOMPTargetTeamsDistributeParallelForDirective( 2820 const OMPTargetTeamsDistributeParallelForDirective &S); 2821 void EmitOMPTargetTeamsDistributeParallelForSimdDirective( 2822 const OMPTargetTeamsDistributeParallelForSimdDirective &S); 2823 void EmitOMPTargetTeamsDistributeSimdDirective( 2824 const OMPTargetTeamsDistributeSimdDirective &S); 2825 2826 /// Emit device code for the target directive. 2827 static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM, 2828 StringRef ParentName, 2829 const OMPTargetDirective &S); 2830 static void 2831 EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName, 2832 const OMPTargetParallelDirective &S); 2833 static void 2834 EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName, 2835 const OMPTargetTeamsDirective &S); 2836 /// \brief Emit inner loop of the worksharing/simd construct. 2837 /// 2838 /// \param S Directive, for which the inner loop must be emitted. 2839 /// \param RequiresCleanup true, if directive has some associated private 2840 /// variables. 2841 /// \param LoopCond Bollean condition for loop continuation. 2842 /// \param IncExpr Increment expression for loop control variable. 2843 /// \param BodyGen Generator for the inner body of the inner loop. 2844 /// \param PostIncGen Genrator for post-increment code (required for ordered 2845 /// loop directvies). 2846 void EmitOMPInnerLoop( 2847 const Stmt &S, bool RequiresCleanup, const Expr *LoopCond, 2848 const Expr *IncExpr, 2849 const llvm::function_ref<void(CodeGenFunction &)> &BodyGen, 2850 const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen); 2851 2852 JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind); 2853 /// Emit initial code for loop counters of loop-based directives. 2854 void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S, 2855 OMPPrivateScope &LoopScope); 2856 2857 /// Helper for the OpenMP loop directives. 2858 void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit); 2859 2860 /// \brief Emit code for the worksharing loop-based directive. 2861 /// \return true, if this construct has any lastprivate clause, false - 2862 /// otherwise. 2863 bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB, 2864 const CodeGenLoopBoundsTy &CodeGenLoopBounds, 2865 const CodeGenDispatchBoundsTy &CGDispatchBounds); 2866 2867 private: 2868 /// Helpers for blocks 2869 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info); 2870 2871 /// Helpers for the OpenMP loop directives. 2872 void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false); 2873 void EmitOMPSimdFinal( 2874 const OMPLoopDirective &D, 2875 const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen); 2876 2877 void EmitOMPDistributeLoop(const OMPLoopDirective &S, 2878 const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr); 2879 2880 /// struct with the values to be passed to the OpenMP loop-related functions 2881 struct OMPLoopArguments { 2882 /// loop lower bound 2883 Address LB = Address::invalid(); 2884 /// loop upper bound 2885 Address UB = Address::invalid(); 2886 /// loop stride 2887 Address ST = Address::invalid(); 2888 /// isLastIteration argument for runtime functions 2889 Address IL = Address::invalid(); 2890 /// Chunk value generated by sema 2891 llvm::Value *Chunk = nullptr; 2892 /// EnsureUpperBound 2893 Expr *EUB = nullptr; 2894 /// IncrementExpression 2895 Expr *IncExpr = nullptr; 2896 /// Loop initialization 2897 Expr *Init = nullptr; 2898 /// Loop exit condition 2899 Expr *Cond = nullptr; 2900 /// Update of LB after a whole chunk has been executed 2901 Expr *NextLB = nullptr; 2902 /// Update of UB after a whole chunk has been executed 2903 Expr *NextUB = nullptr; 2904 OMPLoopArguments() = default; 2905 OMPLoopArguments(Address LB, Address UB, Address ST, Address IL, 2906 llvm::Value *Chunk = nullptr, Expr *EUB = nullptr, 2907 Expr *IncExpr = nullptr, Expr *Init = nullptr, 2908 Expr *Cond = nullptr, Expr *NextLB = nullptr, 2909 Expr *NextUB = nullptr) 2910 : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB), 2911 IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB), 2912 NextUB(NextUB) {} 2913 }; 2914 void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic, 2915 const OMPLoopDirective &S, OMPPrivateScope &LoopScope, 2916 const OMPLoopArguments &LoopArgs, 2917 const CodeGenLoopTy &CodeGenLoop, 2918 const CodeGenOrderedTy &CodeGenOrdered); 2919 void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind, 2920 bool IsMonotonic, const OMPLoopDirective &S, 2921 OMPPrivateScope &LoopScope, bool Ordered, 2922 const OMPLoopArguments &LoopArgs, 2923 const CodeGenDispatchBoundsTy &CGDispatchBounds); 2924 void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind, 2925 const OMPLoopDirective &S, 2926 OMPPrivateScope &LoopScope, 2927 const OMPLoopArguments &LoopArgs, 2928 const CodeGenLoopTy &CodeGenLoopContent); 2929 /// \brief Emit code for sections directive. 2930 void EmitSections(const OMPExecutableDirective &S); 2931 2932 public: 2933 2934 //===--------------------------------------------------------------------===// 2935 // LValue Expression Emission 2936 //===--------------------------------------------------------------------===// 2937 2938 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type. 2939 RValue GetUndefRValue(QualType Ty); 2940 2941 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E 2942 /// and issue an ErrorUnsupported style diagnostic (using the 2943 /// provided Name). 2944 RValue EmitUnsupportedRValue(const Expr *E, 2945 const char *Name); 2946 2947 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue 2948 /// an ErrorUnsupported style diagnostic (using the provided Name). 2949 LValue EmitUnsupportedLValue(const Expr *E, 2950 const char *Name); 2951 2952 /// EmitLValue - Emit code to compute a designator that specifies the location 2953 /// of the expression. 2954 /// 2955 /// This can return one of two things: a simple address or a bitfield 2956 /// reference. In either case, the LLVM Value* in the LValue structure is 2957 /// guaranteed to be an LLVM pointer type. 2958 /// 2959 /// If this returns a bitfield reference, nothing about the pointee type of 2960 /// the LLVM value is known: For example, it may not be a pointer to an 2961 /// integer. 2962 /// 2963 /// If this returns a normal address, and if the lvalue's C type is fixed 2964 /// size, this method guarantees that the returned pointer type will point to 2965 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a 2966 /// variable length type, this is not possible. 2967 /// 2968 LValue EmitLValue(const Expr *E); 2969 2970 /// \brief Same as EmitLValue but additionally we generate checking code to 2971 /// guard against undefined behavior. This is only suitable when we know 2972 /// that the address will be used to access the object. 2973 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK); 2974 2975 RValue convertTempToRValue(Address addr, QualType type, 2976 SourceLocation Loc); 2977 2978 void EmitAtomicInit(Expr *E, LValue lvalue); 2979 2980 bool LValueIsSuitableForInlineAtomic(LValue Src); 2981 2982 RValue EmitAtomicLoad(LValue LV, SourceLocation SL, 2983 AggValueSlot Slot = AggValueSlot::ignored()); 2984 2985 RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc, 2986 llvm::AtomicOrdering AO, bool IsVolatile = false, 2987 AggValueSlot slot = AggValueSlot::ignored()); 2988 2989 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit); 2990 2991 void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO, 2992 bool IsVolatile, bool isInit); 2993 2994 std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange( 2995 LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc, 2996 llvm::AtomicOrdering Success = 2997 llvm::AtomicOrdering::SequentiallyConsistent, 2998 llvm::AtomicOrdering Failure = 2999 llvm::AtomicOrdering::SequentiallyConsistent, 3000 bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored()); 3001 3002 void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO, 3003 const llvm::function_ref<RValue(RValue)> &UpdateOp, 3004 bool IsVolatile); 3005 3006 /// EmitToMemory - Change a scalar value from its value 3007 /// representation to its in-memory representation. 3008 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty); 3009 3010 /// EmitFromMemory - Change a scalar value from its memory 3011 /// representation to its value representation. 3012 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty); 3013 3014 /// Check if the scalar \p Value is within the valid range for the given 3015 /// type \p Ty. 3016 /// 3017 /// Returns true if a check is needed (even if the range is unknown). 3018 bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty, 3019 SourceLocation Loc); 3020 3021 /// EmitLoadOfScalar - Load a scalar value from an address, taking 3022 /// care to appropriately convert from the memory representation to 3023 /// the LLVM value representation. 3024 llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty, 3025 SourceLocation Loc, 3026 LValueBaseInfo BaseInfo = 3027 LValueBaseInfo(AlignmentSource::Type), 3028 llvm::MDNode *TBAAInfo = nullptr, 3029 QualType TBAABaseTy = QualType(), 3030 uint64_t TBAAOffset = 0, 3031 bool isNontemporal = false); 3032 3033 /// EmitLoadOfScalar - Load a scalar value from an address, taking 3034 /// care to appropriately convert from the memory representation to 3035 /// the LLVM value representation. The l-value must be a simple 3036 /// l-value. 3037 llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc); 3038 3039 /// EmitStoreOfScalar - Store a scalar value to an address, taking 3040 /// care to appropriately convert from the memory representation to 3041 /// the LLVM value representation. 3042 void EmitStoreOfScalar(llvm::Value *Value, Address Addr, 3043 bool Volatile, QualType Ty, 3044 LValueBaseInfo BaseInfo = 3045 LValueBaseInfo(AlignmentSource::Type), 3046 llvm::MDNode *TBAAInfo = nullptr, bool isInit = false, 3047 QualType TBAABaseTy = QualType(), 3048 uint64_t TBAAOffset = 0, bool isNontemporal = false); 3049 3050 /// EmitStoreOfScalar - Store a scalar value to an address, taking 3051 /// care to appropriately convert from the memory representation to 3052 /// the LLVM value representation. The l-value must be a simple 3053 /// l-value. The isInit flag indicates whether this is an initialization. 3054 /// If so, atomic qualifiers are ignored and the store is always non-atomic. 3055 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false); 3056 3057 /// EmitLoadOfLValue - Given an expression that represents a value lvalue, 3058 /// this method emits the address of the lvalue, then loads the result as an 3059 /// rvalue, returning the rvalue. 3060 RValue EmitLoadOfLValue(LValue V, SourceLocation Loc); 3061 RValue EmitLoadOfExtVectorElementLValue(LValue V); 3062 RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc); 3063 RValue EmitLoadOfGlobalRegLValue(LValue LV); 3064 3065 /// EmitStoreThroughLValue - Store the specified rvalue into the specified 3066 /// lvalue, where both are guaranteed to the have the same type, and that type 3067 /// is 'Ty'. 3068 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false); 3069 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst); 3070 void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst); 3071 3072 /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints 3073 /// as EmitStoreThroughLValue. 3074 /// 3075 /// \param Result [out] - If non-null, this will be set to a Value* for the 3076 /// bit-field contents after the store, appropriate for use as the result of 3077 /// an assignment to the bit-field. 3078 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, 3079 llvm::Value **Result=nullptr); 3080 3081 /// Emit an l-value for an assignment (simple or compound) of complex type. 3082 LValue EmitComplexAssignmentLValue(const BinaryOperator *E); 3083 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E); 3084 LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E, 3085 llvm::Value *&Result); 3086 3087 // Note: only available for agg return types 3088 LValue EmitBinaryOperatorLValue(const BinaryOperator *E); 3089 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E); 3090 // Note: only available for agg return types 3091 LValue EmitCallExprLValue(const CallExpr *E); 3092 // Note: only available for agg return types 3093 LValue EmitVAArgExprLValue(const VAArgExpr *E); 3094 LValue EmitDeclRefLValue(const DeclRefExpr *E); 3095 LValue EmitStringLiteralLValue(const StringLiteral *E); 3096 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E); 3097 LValue EmitPredefinedLValue(const PredefinedExpr *E); 3098 LValue EmitUnaryOpLValue(const UnaryOperator *E); 3099 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E, 3100 bool Accessed = false); 3101 LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E, 3102 bool IsLowerBound = true); 3103 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E); 3104 LValue EmitMemberExpr(const MemberExpr *E); 3105 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E); 3106 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E); 3107 LValue EmitInitListLValue(const InitListExpr *E); 3108 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E); 3109 LValue EmitCastLValue(const CastExpr *E); 3110 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E); 3111 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e); 3112 3113 Address EmitExtVectorElementLValue(LValue V); 3114 3115 RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc); 3116 3117 Address EmitArrayToPointerDecay(const Expr *Array, 3118 LValueBaseInfo *BaseInfo = nullptr); 3119 3120 class ConstantEmission { 3121 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference; 3122 ConstantEmission(llvm::Constant *C, bool isReference) 3123 : ValueAndIsReference(C, isReference) {} 3124 public: 3125 ConstantEmission() {} 3126 static ConstantEmission forReference(llvm::Constant *C) { 3127 return ConstantEmission(C, true); 3128 } 3129 static ConstantEmission forValue(llvm::Constant *C) { 3130 return ConstantEmission(C, false); 3131 } 3132 3133 explicit operator bool() const { 3134 return ValueAndIsReference.getOpaqueValue() != nullptr; 3135 } 3136 3137 bool isReference() const { return ValueAndIsReference.getInt(); } 3138 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const { 3139 assert(isReference()); 3140 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(), 3141 refExpr->getType()); 3142 } 3143 3144 llvm::Constant *getValue() const { 3145 assert(!isReference()); 3146 return ValueAndIsReference.getPointer(); 3147 } 3148 }; 3149 3150 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr); 3151 3152 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e, 3153 AggValueSlot slot = AggValueSlot::ignored()); 3154 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e); 3155 3156 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface, 3157 const ObjCIvarDecl *Ivar); 3158 LValue EmitLValueForField(LValue Base, const FieldDecl* Field); 3159 LValue EmitLValueForLambdaField(const FieldDecl *Field); 3160 3161 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that 3162 /// if the Field is a reference, this will return the address of the reference 3163 /// and not the address of the value stored in the reference. 3164 LValue EmitLValueForFieldInitialization(LValue Base, 3165 const FieldDecl* Field); 3166 3167 LValue EmitLValueForIvar(QualType ObjectTy, 3168 llvm::Value* Base, const ObjCIvarDecl *Ivar, 3169 unsigned CVRQualifiers); 3170 3171 LValue EmitCXXConstructLValue(const CXXConstructExpr *E); 3172 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E); 3173 LValue EmitLambdaLValue(const LambdaExpr *E); 3174 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E); 3175 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E); 3176 3177 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E); 3178 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E); 3179 LValue EmitStmtExprLValue(const StmtExpr *E); 3180 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E); 3181 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E); 3182 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init); 3183 3184 //===--------------------------------------------------------------------===// 3185 // Scalar Expression Emission 3186 //===--------------------------------------------------------------------===// 3187 3188 /// EmitCall - Generate a call of the given function, expecting the given 3189 /// result type, and using the given argument list which specifies both the 3190 /// LLVM arguments and the types they were derived from. 3191 RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee, 3192 ReturnValueSlot ReturnValue, const CallArgList &Args, 3193 llvm::Instruction **callOrInvoke = nullptr); 3194 3195 RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E, 3196 ReturnValueSlot ReturnValue, 3197 llvm::Value *Chain = nullptr); 3198 RValue EmitCallExpr(const CallExpr *E, 3199 ReturnValueSlot ReturnValue = ReturnValueSlot()); 3200 RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue); 3201 CGCallee EmitCallee(const Expr *E); 3202 3203 void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl); 3204 3205 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee, 3206 const Twine &name = ""); 3207 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee, 3208 ArrayRef<llvm::Value*> args, 3209 const Twine &name = ""); 3210 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee, 3211 const Twine &name = ""); 3212 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee, 3213 ArrayRef<llvm::Value*> args, 3214 const Twine &name = ""); 3215 3216 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee, 3217 ArrayRef<llvm::Value *> Args, 3218 const Twine &Name = ""); 3219 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee, 3220 ArrayRef<llvm::Value*> args, 3221 const Twine &name = ""); 3222 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee, 3223 const Twine &name = ""); 3224 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee, 3225 ArrayRef<llvm::Value*> args); 3226 3227 CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD, 3228 NestedNameSpecifier *Qual, 3229 llvm::Type *Ty); 3230 3231 CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD, 3232 CXXDtorType Type, 3233 const CXXRecordDecl *RD); 3234 3235 RValue 3236 EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method, 3237 const CGCallee &Callee, 3238 ReturnValueSlot ReturnValue, llvm::Value *This, 3239 llvm::Value *ImplicitParam, 3240 QualType ImplicitParamTy, const CallExpr *E, 3241 CallArgList *RtlArgs); 3242 RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD, 3243 const CGCallee &Callee, 3244 llvm::Value *This, llvm::Value *ImplicitParam, 3245 QualType ImplicitParamTy, const CallExpr *E, 3246 StructorType Type); 3247 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E, 3248 ReturnValueSlot ReturnValue); 3249 RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE, 3250 const CXXMethodDecl *MD, 3251 ReturnValueSlot ReturnValue, 3252 bool HasQualifier, 3253 NestedNameSpecifier *Qualifier, 3254 bool IsArrow, const Expr *Base); 3255 // Compute the object pointer. 3256 Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base, 3257 llvm::Value *memberPtr, 3258 const MemberPointerType *memberPtrType, 3259 LValueBaseInfo *BaseInfo = nullptr); 3260 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E, 3261 ReturnValueSlot ReturnValue); 3262 3263 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E, 3264 const CXXMethodDecl *MD, 3265 ReturnValueSlot ReturnValue); 3266 RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E); 3267 3268 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E, 3269 ReturnValueSlot ReturnValue); 3270 3271 RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E, 3272 ReturnValueSlot ReturnValue); 3273 3274 RValue EmitBuiltinExpr(const FunctionDecl *FD, 3275 unsigned BuiltinID, const CallExpr *E, 3276 ReturnValueSlot ReturnValue); 3277 3278 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue); 3279 3280 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call 3281 /// is unhandled by the current target. 3282 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3283 3284 llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty, 3285 const llvm::CmpInst::Predicate Fp, 3286 const llvm::CmpInst::Predicate Ip, 3287 const llvm::Twine &Name = ""); 3288 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3289 3290 llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID, 3291 unsigned LLVMIntrinsic, 3292 unsigned AltLLVMIntrinsic, 3293 const char *NameHint, 3294 unsigned Modifier, 3295 const CallExpr *E, 3296 SmallVectorImpl<llvm::Value *> &Ops, 3297 Address PtrOp0, Address PtrOp1); 3298 llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID, 3299 unsigned Modifier, llvm::Type *ArgTy, 3300 const CallExpr *E); 3301 llvm::Value *EmitNeonCall(llvm::Function *F, 3302 SmallVectorImpl<llvm::Value*> &O, 3303 const char *name, 3304 unsigned shift = 0, bool rightshift = false); 3305 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx); 3306 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty, 3307 bool negateForRightShift); 3308 llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt, 3309 llvm::Type *Ty, bool usgn, const char *name); 3310 llvm::Value *vectorWrapScalar16(llvm::Value *Op); 3311 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3312 3313 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops); 3314 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3315 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3316 llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3317 llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3318 llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 3319 llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID, 3320 const CallExpr *E); 3321 3322 private: 3323 enum class MSVCIntrin; 3324 3325 public: 3326 llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E); 3327 3328 llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args); 3329 3330 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E); 3331 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E); 3332 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E); 3333 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E); 3334 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E); 3335 llvm::Value *EmitObjCCollectionLiteral(const Expr *E, 3336 const ObjCMethodDecl *MethodWithObjects); 3337 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E); 3338 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E, 3339 ReturnValueSlot Return = ReturnValueSlot()); 3340 3341 /// Retrieves the default cleanup kind for an ARC cleanup. 3342 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only. 3343 CleanupKind getARCCleanupKind() { 3344 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions 3345 ? NormalAndEHCleanup : NormalCleanup; 3346 } 3347 3348 // ARC primitives. 3349 void EmitARCInitWeak(Address addr, llvm::Value *value); 3350 void EmitARCDestroyWeak(Address addr); 3351 llvm::Value *EmitARCLoadWeak(Address addr); 3352 llvm::Value *EmitARCLoadWeakRetained(Address addr); 3353 llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored); 3354 void EmitARCCopyWeak(Address dst, Address src); 3355 void EmitARCMoveWeak(Address dst, Address src); 3356 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value); 3357 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value); 3358 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value, 3359 bool resultIgnored); 3360 llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value, 3361 bool resultIgnored); 3362 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value); 3363 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value); 3364 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory); 3365 void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise); 3366 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise); 3367 llvm::Value *EmitARCAutorelease(llvm::Value *value); 3368 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value); 3369 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value); 3370 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value); 3371 llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value); 3372 3373 std::pair<LValue,llvm::Value*> 3374 EmitARCStoreAutoreleasing(const BinaryOperator *e); 3375 std::pair<LValue,llvm::Value*> 3376 EmitARCStoreStrong(const BinaryOperator *e, bool ignored); 3377 std::pair<LValue,llvm::Value*> 3378 EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored); 3379 3380 llvm::Value *EmitObjCThrowOperand(const Expr *expr); 3381 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr); 3382 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr); 3383 3384 llvm::Value *EmitARCExtendBlockObject(const Expr *expr); 3385 llvm::Value *EmitARCReclaimReturnedObject(const Expr *e, 3386 bool allowUnsafeClaim); 3387 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr); 3388 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr); 3389 llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr); 3390 3391 void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values); 3392 3393 static Destroyer destroyARCStrongImprecise; 3394 static Destroyer destroyARCStrongPrecise; 3395 static Destroyer destroyARCWeak; 3396 static Destroyer emitARCIntrinsicUse; 3397 3398 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr); 3399 llvm::Value *EmitObjCAutoreleasePoolPush(); 3400 llvm::Value *EmitObjCMRRAutoreleasePoolPush(); 3401 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr); 3402 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr); 3403 3404 /// \brief Emits a reference binding to the passed in expression. 3405 RValue EmitReferenceBindingToExpr(const Expr *E); 3406 3407 //===--------------------------------------------------------------------===// 3408 // Expression Emission 3409 //===--------------------------------------------------------------------===// 3410 3411 // Expressions are broken into three classes: scalar, complex, aggregate. 3412 3413 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM 3414 /// scalar type, returning the result. 3415 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false); 3416 3417 /// Emit a conversion from the specified type to the specified destination 3418 /// type, both of which are LLVM scalar types. 3419 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy, 3420 QualType DstTy, SourceLocation Loc); 3421 3422 /// Emit a conversion from the specified complex type to the specified 3423 /// destination type, where the destination type is an LLVM scalar type. 3424 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy, 3425 QualType DstTy, 3426 SourceLocation Loc); 3427 3428 /// EmitAggExpr - Emit the computation of the specified expression 3429 /// of aggregate type. The result is computed into the given slot, 3430 /// which may be null to indicate that the value is not needed. 3431 void EmitAggExpr(const Expr *E, AggValueSlot AS); 3432 3433 /// EmitAggExprToLValue - Emit the computation of the specified expression of 3434 /// aggregate type into a temporary LValue. 3435 LValue EmitAggExprToLValue(const Expr *E); 3436 3437 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object, 3438 /// make sure it survives garbage collection until this point. 3439 void EmitExtendGCLifetime(llvm::Value *object); 3440 3441 /// EmitComplexExpr - Emit the computation of the specified expression of 3442 /// complex type, returning the result. 3443 ComplexPairTy EmitComplexExpr(const Expr *E, 3444 bool IgnoreReal = false, 3445 bool IgnoreImag = false); 3446 3447 /// EmitComplexExprIntoLValue - Emit the given expression of complex 3448 /// type and place its result into the specified l-value. 3449 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit); 3450 3451 /// EmitStoreOfComplex - Store a complex number into the specified l-value. 3452 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit); 3453 3454 /// EmitLoadOfComplex - Load a complex number from the specified l-value. 3455 ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc); 3456 3457 Address emitAddrOfRealComponent(Address complex, QualType complexType); 3458 Address emitAddrOfImagComponent(Address complex, QualType complexType); 3459 3460 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the 3461 /// global variable that has already been created for it. If the initializer 3462 /// has a different type than GV does, this may free GV and return a different 3463 /// one. Otherwise it just returns GV. 3464 llvm::GlobalVariable * 3465 AddInitializerToStaticVarDecl(const VarDecl &D, 3466 llvm::GlobalVariable *GV); 3467 3468 3469 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++ 3470 /// variable with global storage. 3471 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr, 3472 bool PerformInit); 3473 3474 llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor, 3475 llvm::Constant *Addr); 3476 3477 /// Call atexit() with a function that passes the given argument to 3478 /// the given function. 3479 void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn, 3480 llvm::Constant *addr); 3481 3482 /// Emit code in this function to perform a guarded variable 3483 /// initialization. Guarded initializations are used when it's not 3484 /// possible to prove that an initialization will be done exactly 3485 /// once, e.g. with a static local variable or a static data member 3486 /// of a class template. 3487 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr, 3488 bool PerformInit); 3489 3490 /// GenerateCXXGlobalInitFunc - Generates code for initializing global 3491 /// variables. 3492 void GenerateCXXGlobalInitFunc(llvm::Function *Fn, 3493 ArrayRef<llvm::Function *> CXXThreadLocals, 3494 Address Guard = Address::invalid()); 3495 3496 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global 3497 /// variables. 3498 void GenerateCXXGlobalDtorsFunc( 3499 llvm::Function *Fn, 3500 const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>> 3501 &DtorsAndObjects); 3502 3503 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn, 3504 const VarDecl *D, 3505 llvm::GlobalVariable *Addr, 3506 bool PerformInit); 3507 3508 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest); 3509 3510 void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp); 3511 3512 void enterFullExpression(const ExprWithCleanups *E) { 3513 if (E->getNumObjects() == 0) return; 3514 enterNonTrivialFullExpression(E); 3515 } 3516 void enterNonTrivialFullExpression(const ExprWithCleanups *E); 3517 3518 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true); 3519 3520 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest); 3521 3522 RValue EmitAtomicExpr(AtomicExpr *E); 3523 3524 //===--------------------------------------------------------------------===// 3525 // Annotations Emission 3526 //===--------------------------------------------------------------------===// 3527 3528 /// Emit an annotation call (intrinsic or builtin). 3529 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn, 3530 llvm::Value *AnnotatedVal, 3531 StringRef AnnotationStr, 3532 SourceLocation Location); 3533 3534 /// Emit local annotations for the local variable V, declared by D. 3535 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V); 3536 3537 /// Emit field annotations for the given field & value. Returns the 3538 /// annotation result. 3539 Address EmitFieldAnnotations(const FieldDecl *D, Address V); 3540 3541 //===--------------------------------------------------------------------===// 3542 // Internal Helpers 3543 //===--------------------------------------------------------------------===// 3544 3545 /// ContainsLabel - Return true if the statement contains a label in it. If 3546 /// this statement is not executed normally, it not containing a label means 3547 /// that we can just remove the code. 3548 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false); 3549 3550 /// containsBreak - Return true if the statement contains a break out of it. 3551 /// If the statement (recursively) contains a switch or loop with a break 3552 /// inside of it, this is fine. 3553 static bool containsBreak(const Stmt *S); 3554 3555 /// Determine if the given statement might introduce a declaration into the 3556 /// current scope, by being a (possibly-labelled) DeclStmt. 3557 static bool mightAddDeclToScope(const Stmt *S); 3558 3559 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 3560 /// to a constant, or if it does but contains a label, return false. If it 3561 /// constant folds return true and set the boolean result in Result. 3562 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result, 3563 bool AllowLabels = false); 3564 3565 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 3566 /// to a constant, or if it does but contains a label, return false. If it 3567 /// constant folds return true and set the folded value. 3568 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result, 3569 bool AllowLabels = false); 3570 3571 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an 3572 /// if statement) to the specified blocks. Based on the condition, this might 3573 /// try to simplify the codegen of the conditional based on the branch. 3574 /// TrueCount should be the number of times we expect the condition to 3575 /// evaluate to true based on PGO data. 3576 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock, 3577 llvm::BasicBlock *FalseBlock, uint64_t TrueCount); 3578 3579 /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is 3580 /// nonnull, if \p LHS is marked _Nonnull. 3581 void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc); 3582 3583 /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to 3584 /// detect undefined behavior when the pointer overflow sanitizer is enabled. 3585 /// \p SignedIndices indicates whether any of the GEP indices are signed. 3586 llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr, 3587 ArrayRef<llvm::Value *> IdxList, 3588 bool SignedIndices, 3589 SourceLocation Loc, 3590 const Twine &Name = ""); 3591 3592 /// \brief Emit a description of a type in a format suitable for passing to 3593 /// a runtime sanitizer handler. 3594 llvm::Constant *EmitCheckTypeDescriptor(QualType T); 3595 3596 /// \brief Convert a value into a format suitable for passing to a runtime 3597 /// sanitizer handler. 3598 llvm::Value *EmitCheckValue(llvm::Value *V); 3599 3600 /// \brief Emit a description of a source location in a format suitable for 3601 /// passing to a runtime sanitizer handler. 3602 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc); 3603 3604 /// \brief Create a basic block that will call a handler function in a 3605 /// sanitizer runtime with the provided arguments, and create a conditional 3606 /// branch to it. 3607 void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked, 3608 SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs, 3609 ArrayRef<llvm::Value *> DynamicArgs); 3610 3611 /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath 3612 /// if Cond if false. 3613 void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond, 3614 llvm::ConstantInt *TypeId, llvm::Value *Ptr, 3615 ArrayRef<llvm::Constant *> StaticArgs); 3616 3617 /// \brief Create a basic block that will call the trap intrinsic, and emit a 3618 /// conditional branch to it, for the -ftrapv checks. 3619 void EmitTrapCheck(llvm::Value *Checked); 3620 3621 /// \brief Emit a call to trap or debugtrap and attach function attribute 3622 /// "trap-func-name" if specified. 3623 llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID); 3624 3625 /// \brief Emit a stub for the cross-DSO CFI check function. 3626 void EmitCfiCheckStub(); 3627 3628 /// \brief Emit a cross-DSO CFI failure handling function. 3629 void EmitCfiCheckFail(); 3630 3631 /// \brief Create a check for a function parameter that may potentially be 3632 /// declared as non-null. 3633 void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc, 3634 AbstractCallee AC, unsigned ParmNum); 3635 3636 /// EmitCallArg - Emit a single call argument. 3637 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType); 3638 3639 /// EmitDelegateCallArg - We are performing a delegate call; that 3640 /// is, the current function is delegating to another one. Produce 3641 /// a r-value suitable for passing the given parameter. 3642 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param, 3643 SourceLocation loc); 3644 3645 /// SetFPAccuracy - Set the minimum required accuracy of the given floating 3646 /// point operation, expressed as the maximum relative error in ulp. 3647 void SetFPAccuracy(llvm::Value *Val, float Accuracy); 3648 3649 private: 3650 llvm::MDNode *getRangeForLoadFromType(QualType Ty); 3651 void EmitReturnOfRValue(RValue RV, QualType Ty); 3652 3653 void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New); 3654 3655 llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4> 3656 DeferredReplacements; 3657 3658 /// Set the address of a local variable. 3659 void setAddrOfLocalVar(const VarDecl *VD, Address Addr) { 3660 assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!"); 3661 LocalDeclMap.insert({VD, Addr}); 3662 } 3663 3664 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty 3665 /// from function arguments into \arg Dst. See ABIArgInfo::Expand. 3666 /// 3667 /// \param AI - The first function argument of the expansion. 3668 void ExpandTypeFromArgs(QualType Ty, LValue Dst, 3669 SmallVectorImpl<llvm::Value *>::iterator &AI); 3670 3671 /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg 3672 /// Ty, into individual arguments on the provided vector \arg IRCallArgs, 3673 /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand. 3674 void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy, 3675 SmallVectorImpl<llvm::Value *> &IRCallArgs, 3676 unsigned &IRCallArgPos); 3677 3678 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info, 3679 const Expr *InputExpr, std::string &ConstraintStr); 3680 3681 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info, 3682 LValue InputValue, QualType InputType, 3683 std::string &ConstraintStr, 3684 SourceLocation Loc); 3685 3686 /// \brief Attempts to statically evaluate the object size of E. If that 3687 /// fails, emits code to figure the size of E out for us. This is 3688 /// pass_object_size aware. 3689 /// 3690 /// If EmittedExpr is non-null, this will use that instead of re-emitting E. 3691 llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type, 3692 llvm::IntegerType *ResType, 3693 llvm::Value *EmittedE); 3694 3695 /// \brief Emits the size of E, as required by __builtin_object_size. This 3696 /// function is aware of pass_object_size parameters, and will act accordingly 3697 /// if E is a parameter with the pass_object_size attribute. 3698 llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type, 3699 llvm::IntegerType *ResType, 3700 llvm::Value *EmittedE); 3701 3702 public: 3703 #ifndef NDEBUG 3704 // Determine whether the given argument is an Objective-C method 3705 // that may have type parameters in its signature. 3706 static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) { 3707 const DeclContext *dc = method->getDeclContext(); 3708 if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) { 3709 return classDecl->getTypeParamListAsWritten(); 3710 } 3711 3712 if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) { 3713 return catDecl->getTypeParamList(); 3714 } 3715 3716 return false; 3717 } 3718 3719 template<typename T> 3720 static bool isObjCMethodWithTypeParams(const T *) { return false; } 3721 #endif 3722 3723 enum class EvaluationOrder { 3724 ///! No language constraints on evaluation order. 3725 Default, 3726 ///! Language semantics require left-to-right evaluation. 3727 ForceLeftToRight, 3728 ///! Language semantics require right-to-left evaluation. 3729 ForceRightToLeft 3730 }; 3731 3732 /// EmitCallArgs - Emit call arguments for a function. 3733 template <typename T> 3734 void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo, 3735 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange, 3736 AbstractCallee AC = AbstractCallee(), 3737 unsigned ParamsToSkip = 0, 3738 EvaluationOrder Order = EvaluationOrder::Default) { 3739 SmallVector<QualType, 16> ArgTypes; 3740 CallExpr::const_arg_iterator Arg = ArgRange.begin(); 3741 3742 assert((ParamsToSkip == 0 || CallArgTypeInfo) && 3743 "Can't skip parameters if type info is not provided"); 3744 if (CallArgTypeInfo) { 3745 #ifndef NDEBUG 3746 bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo); 3747 #endif 3748 3749 // First, use the argument types that the type info knows about 3750 for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip, 3751 E = CallArgTypeInfo->param_type_end(); 3752 I != E; ++I, ++Arg) { 3753 assert(Arg != ArgRange.end() && "Running over edge of argument list!"); 3754 assert((isGenericMethod || 3755 ((*I)->isVariablyModifiedType() || 3756 (*I).getNonReferenceType()->isObjCRetainableType() || 3757 getContext() 3758 .getCanonicalType((*I).getNonReferenceType()) 3759 .getTypePtr() == 3760 getContext() 3761 .getCanonicalType((*Arg)->getType()) 3762 .getTypePtr())) && 3763 "type mismatch in call argument!"); 3764 ArgTypes.push_back(*I); 3765 } 3766 } 3767 3768 // Either we've emitted all the call args, or we have a call to variadic 3769 // function. 3770 assert((Arg == ArgRange.end() || !CallArgTypeInfo || 3771 CallArgTypeInfo->isVariadic()) && 3772 "Extra arguments in non-variadic function!"); 3773 3774 // If we still have any arguments, emit them using the type of the argument. 3775 for (auto *A : llvm::make_range(Arg, ArgRange.end())) 3776 ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType()); 3777 3778 EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order); 3779 } 3780 3781 void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes, 3782 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange, 3783 AbstractCallee AC = AbstractCallee(), 3784 unsigned ParamsToSkip = 0, 3785 EvaluationOrder Order = EvaluationOrder::Default); 3786 3787 /// EmitPointerWithAlignment - Given an expression with a pointer type, 3788 /// emit the value and compute our best estimate of the alignment of the 3789 /// pointee. 3790 /// 3791 /// \param BaseInfo - If non-null, this will be initialized with 3792 /// information about the source of the alignment and the may-alias 3793 /// attribute. Note that this function will conservatively fall back on 3794 /// the type when it doesn't recognize the expression and may-alias will 3795 /// be set to false. 3796 /// 3797 /// One reasonable way to use this information is when there's a language 3798 /// guarantee that the pointer must be aligned to some stricter value, and 3799 /// we're simply trying to ensure that sufficiently obvious uses of under- 3800 /// aligned objects don't get miscompiled; for example, a placement new 3801 /// into the address of a local variable. In such a case, it's quite 3802 /// reasonable to just ignore the returned alignment when it isn't from an 3803 /// explicit source. 3804 Address EmitPointerWithAlignment(const Expr *Addr, 3805 LValueBaseInfo *BaseInfo = nullptr); 3806 3807 void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK); 3808 3809 private: 3810 QualType getVarArgType(const Expr *Arg); 3811 3812 const TargetCodeGenInfo &getTargetHooks() const { 3813 return CGM.getTargetCodeGenInfo(); 3814 } 3815 3816 void EmitDeclMetadata(); 3817 3818 BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType, 3819 const AutoVarEmission &emission); 3820 3821 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst); 3822 3823 llvm::Value *GetValueForARMHint(unsigned BuiltinID); 3824 }; 3825 3826 /// Helper class with most of the code for saving a value for a 3827 /// conditional expression cleanup. 3828 struct DominatingLLVMValue { 3829 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type; 3830 3831 /// Answer whether the given value needs extra work to be saved. 3832 static bool needsSaving(llvm::Value *value) { 3833 // If it's not an instruction, we don't need to save. 3834 if (!isa<llvm::Instruction>(value)) return false; 3835 3836 // If it's an instruction in the entry block, we don't need to save. 3837 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent(); 3838 return (block != &block->getParent()->getEntryBlock()); 3839 } 3840 3841 /// Try to save the given value. 3842 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) { 3843 if (!needsSaving(value)) return saved_type(value, false); 3844 3845 // Otherwise, we need an alloca. 3846 auto align = CharUnits::fromQuantity( 3847 CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType())); 3848 Address alloca = 3849 CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save"); 3850 CGF.Builder.CreateStore(value, alloca); 3851 3852 return saved_type(alloca.getPointer(), true); 3853 } 3854 3855 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) { 3856 // If the value says it wasn't saved, trust that it's still dominating. 3857 if (!value.getInt()) return value.getPointer(); 3858 3859 // Otherwise, it should be an alloca instruction, as set up in save(). 3860 auto alloca = cast<llvm::AllocaInst>(value.getPointer()); 3861 return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment()); 3862 } 3863 }; 3864 3865 /// A partial specialization of DominatingValue for llvm::Values that 3866 /// might be llvm::Instructions. 3867 template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue { 3868 typedef T *type; 3869 static type restore(CodeGenFunction &CGF, saved_type value) { 3870 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value)); 3871 } 3872 }; 3873 3874 /// A specialization of DominatingValue for Address. 3875 template <> struct DominatingValue<Address> { 3876 typedef Address type; 3877 3878 struct saved_type { 3879 DominatingLLVMValue::saved_type SavedValue; 3880 CharUnits Alignment; 3881 }; 3882 3883 static bool needsSaving(type value) { 3884 return DominatingLLVMValue::needsSaving(value.getPointer()); 3885 } 3886 static saved_type save(CodeGenFunction &CGF, type value) { 3887 return { DominatingLLVMValue::save(CGF, value.getPointer()), 3888 value.getAlignment() }; 3889 } 3890 static type restore(CodeGenFunction &CGF, saved_type value) { 3891 return Address(DominatingLLVMValue::restore(CGF, value.SavedValue), 3892 value.Alignment); 3893 } 3894 }; 3895 3896 /// A specialization of DominatingValue for RValue. 3897 template <> struct DominatingValue<RValue> { 3898 typedef RValue type; 3899 class saved_type { 3900 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral, 3901 AggregateAddress, ComplexAddress }; 3902 3903 llvm::Value *Value; 3904 unsigned K : 3; 3905 unsigned Align : 29; 3906 saved_type(llvm::Value *v, Kind k, unsigned a = 0) 3907 : Value(v), K(k), Align(a) {} 3908 3909 public: 3910 static bool needsSaving(RValue value); 3911 static saved_type save(CodeGenFunction &CGF, RValue value); 3912 RValue restore(CodeGenFunction &CGF); 3913 3914 // implementations in CGCleanup.cpp 3915 }; 3916 3917 static bool needsSaving(type value) { 3918 return saved_type::needsSaving(value); 3919 } 3920 static saved_type save(CodeGenFunction &CGF, type value) { 3921 return saved_type::save(CGF, value); 3922 } 3923 static type restore(CodeGenFunction &CGF, saved_type value) { 3924 return value.restore(CGF); 3925 } 3926 }; 3927 3928 } // end namespace CodeGen 3929 } // end namespace clang 3930 3931 #endif 3932