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