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 CLANG_CODEGEN_CODEGENFUNCTION_H 15 #define CLANG_CODEGEN_CODEGENFUNCTION_H 16 17 #include "CGBuilder.h" 18 #include "CGDebugInfo.h" 19 #include "CGValue.h" 20 #include "CodeGenModule.h" 21 #include "clang/AST/CharUnits.h" 22 #include "clang/AST/ExprCXX.h" 23 #include "clang/AST/ExprObjC.h" 24 #include "clang/AST/Type.h" 25 #include "clang/Basic/ABI.h" 26 #include "clang/Basic/TargetInfo.h" 27 #include "clang/Frontend/CodeGenOptions.h" 28 #include "llvm/ADT/ArrayRef.h" 29 #include "llvm/ADT/DenseMap.h" 30 #include "llvm/ADT/SmallVector.h" 31 #include "llvm/Support/Debug.h" 32 #include "llvm/Support/ValueHandle.h" 33 34 namespace llvm { 35 class BasicBlock; 36 class LLVMContext; 37 class MDNode; 38 class Module; 39 class SwitchInst; 40 class Twine; 41 class Value; 42 class CallSite; 43 } 44 45 namespace clang { 46 class ASTContext; 47 class BlockDecl; 48 class CXXDestructorDecl; 49 class CXXForRangeStmt; 50 class CXXTryStmt; 51 class Decl; 52 class LabelDecl; 53 class EnumConstantDecl; 54 class FunctionDecl; 55 class FunctionProtoType; 56 class LabelStmt; 57 class ObjCContainerDecl; 58 class ObjCInterfaceDecl; 59 class ObjCIvarDecl; 60 class ObjCMethodDecl; 61 class ObjCImplementationDecl; 62 class ObjCPropertyImplDecl; 63 class TargetInfo; 64 class TargetCodeGenInfo; 65 class VarDecl; 66 class ObjCForCollectionStmt; 67 class ObjCAtTryStmt; 68 class ObjCAtThrowStmt; 69 class ObjCAtSynchronizedStmt; 70 class ObjCAutoreleasePoolStmt; 71 72 namespace CodeGen { 73 class CodeGenTypes; 74 class CGFunctionInfo; 75 class CGRecordLayout; 76 class CGBlockInfo; 77 class CGCXXABI; 78 class BlockFlags; 79 class BlockFieldFlags; 80 81 /// The kind of evaluation to perform on values of a particular 82 /// type. Basically, is the code in CGExprScalar, CGExprComplex, or 83 /// CGExprAgg? 84 /// 85 /// TODO: should vectors maybe be split out into their own thing? 86 enum TypeEvaluationKind { 87 TEK_Scalar, 88 TEK_Complex, 89 TEK_Aggregate 90 }; 91 92 /// A branch fixup. These are required when emitting a goto to a 93 /// label which hasn't been emitted yet. The goto is optimistically 94 /// emitted as a branch to the basic block for the label, and (if it 95 /// occurs in a scope with non-trivial cleanups) a fixup is added to 96 /// the innermost cleanup. When a (normal) cleanup is popped, any 97 /// unresolved fixups in that scope are threaded through the cleanup. 98 struct BranchFixup { 99 /// The block containing the terminator which needs to be modified 100 /// into a switch if this fixup is resolved into the current scope. 101 /// If null, LatestBranch points directly to the destination. 102 llvm::BasicBlock *OptimisticBranchBlock; 103 104 /// The ultimate destination of the branch. 105 /// 106 /// This can be set to null to indicate that this fixup was 107 /// successfully resolved. 108 llvm::BasicBlock *Destination; 109 110 /// The destination index value. 111 unsigned DestinationIndex; 112 113 /// The initial branch of the fixup. 114 llvm::BranchInst *InitialBranch; 115 }; 116 117 template <class T> struct InvariantValue { 118 typedef T type; 119 typedef T saved_type; 120 static bool needsSaving(type value) { return false; } 121 static saved_type save(CodeGenFunction &CGF, type value) { return value; } 122 static type restore(CodeGenFunction &CGF, saved_type value) { return value; } 123 }; 124 125 /// A metaprogramming class for ensuring that a value will dominate an 126 /// arbitrary position in a function. 127 template <class T> struct DominatingValue : InvariantValue<T> {}; 128 129 template <class T, bool mightBeInstruction = 130 llvm::is_base_of<llvm::Value, T>::value && 131 !llvm::is_base_of<llvm::Constant, T>::value && 132 !llvm::is_base_of<llvm::BasicBlock, T>::value> 133 struct DominatingPointer; 134 template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {}; 135 // template <class T> struct DominatingPointer<T,true> at end of file 136 137 template <class T> struct DominatingValue<T*> : DominatingPointer<T> {}; 138 139 enum CleanupKind { 140 EHCleanup = 0x1, 141 NormalCleanup = 0x2, 142 NormalAndEHCleanup = EHCleanup | NormalCleanup, 143 144 InactiveCleanup = 0x4, 145 InactiveEHCleanup = EHCleanup | InactiveCleanup, 146 InactiveNormalCleanup = NormalCleanup | InactiveCleanup, 147 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup 148 }; 149 150 /// A stack of scopes which respond to exceptions, including cleanups 151 /// and catch blocks. 152 class EHScopeStack { 153 public: 154 /// A saved depth on the scope stack. This is necessary because 155 /// pushing scopes onto the stack invalidates iterators. 156 class stable_iterator { 157 friend class EHScopeStack; 158 159 /// Offset from StartOfData to EndOfBuffer. 160 ptrdiff_t Size; 161 162 stable_iterator(ptrdiff_t Size) : Size(Size) {} 163 164 public: 165 static stable_iterator invalid() { return stable_iterator(-1); } 166 stable_iterator() : Size(-1) {} 167 168 bool isValid() const { return Size >= 0; } 169 170 /// Returns true if this scope encloses I. 171 /// Returns false if I is invalid. 172 /// This scope must be valid. 173 bool encloses(stable_iterator I) const { return Size <= I.Size; } 174 175 /// Returns true if this scope strictly encloses I: that is, 176 /// if it encloses I and is not I. 177 /// Returns false is I is invalid. 178 /// This scope must be valid. 179 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; } 180 181 friend bool operator==(stable_iterator A, stable_iterator B) { 182 return A.Size == B.Size; 183 } 184 friend bool operator!=(stable_iterator A, stable_iterator B) { 185 return A.Size != B.Size; 186 } 187 }; 188 189 /// Information for lazily generating a cleanup. Subclasses must be 190 /// POD-like: cleanups will not be destructed, and they will be 191 /// allocated on the cleanup stack and freely copied and moved 192 /// around. 193 /// 194 /// Cleanup implementations should generally be declared in an 195 /// anonymous namespace. 196 class Cleanup { 197 // Anchor the construction vtable. 198 virtual void anchor(); 199 public: 200 /// Generation flags. 201 class Flags { 202 enum { 203 F_IsForEH = 0x1, 204 F_IsNormalCleanupKind = 0x2, 205 F_IsEHCleanupKind = 0x4 206 }; 207 unsigned flags; 208 209 public: 210 Flags() : flags(0) {} 211 212 /// isForEH - true if the current emission is for an EH cleanup. 213 bool isForEHCleanup() const { return flags & F_IsForEH; } 214 bool isForNormalCleanup() const { return !isForEHCleanup(); } 215 void setIsForEHCleanup() { flags |= F_IsForEH; } 216 217 bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; } 218 void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; } 219 220 /// isEHCleanupKind - true if the cleanup was pushed as an EH 221 /// cleanup. 222 bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; } 223 void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; } 224 }; 225 226 // Provide a virtual destructor to suppress a very common warning 227 // that unfortunately cannot be suppressed without this. Cleanups 228 // should not rely on this destructor ever being called. 229 virtual ~Cleanup() {} 230 231 /// Emit the cleanup. For normal cleanups, this is run in the 232 /// same EH context as when the cleanup was pushed, i.e. the 233 /// immediately-enclosing context of the cleanup scope. For 234 /// EH cleanups, this is run in a terminate context. 235 /// 236 // \param flags cleanup kind. 237 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0; 238 }; 239 240 /// ConditionalCleanupN stores the saved form of its N parameters, 241 /// then restores them and performs the cleanup. 242 template <class T, class A0> 243 class ConditionalCleanup1 : public Cleanup { 244 typedef typename DominatingValue<A0>::saved_type A0_saved; 245 A0_saved a0_saved; 246 247 void Emit(CodeGenFunction &CGF, Flags flags) { 248 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved); 249 T(a0).Emit(CGF, flags); 250 } 251 252 public: 253 ConditionalCleanup1(A0_saved a0) 254 : a0_saved(a0) {} 255 }; 256 257 template <class T, class A0, class A1> 258 class ConditionalCleanup2 : public Cleanup { 259 typedef typename DominatingValue<A0>::saved_type A0_saved; 260 typedef typename DominatingValue<A1>::saved_type A1_saved; 261 A0_saved a0_saved; 262 A1_saved a1_saved; 263 264 void Emit(CodeGenFunction &CGF, Flags flags) { 265 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved); 266 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved); 267 T(a0, a1).Emit(CGF, flags); 268 } 269 270 public: 271 ConditionalCleanup2(A0_saved a0, A1_saved a1) 272 : a0_saved(a0), a1_saved(a1) {} 273 }; 274 275 template <class T, class A0, class A1, class A2> 276 class ConditionalCleanup3 : public Cleanup { 277 typedef typename DominatingValue<A0>::saved_type A0_saved; 278 typedef typename DominatingValue<A1>::saved_type A1_saved; 279 typedef typename DominatingValue<A2>::saved_type A2_saved; 280 A0_saved a0_saved; 281 A1_saved a1_saved; 282 A2_saved a2_saved; 283 284 void Emit(CodeGenFunction &CGF, Flags flags) { 285 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved); 286 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved); 287 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved); 288 T(a0, a1, a2).Emit(CGF, flags); 289 } 290 291 public: 292 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2) 293 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {} 294 }; 295 296 template <class T, class A0, class A1, class A2, class A3> 297 class ConditionalCleanup4 : public Cleanup { 298 typedef typename DominatingValue<A0>::saved_type A0_saved; 299 typedef typename DominatingValue<A1>::saved_type A1_saved; 300 typedef typename DominatingValue<A2>::saved_type A2_saved; 301 typedef typename DominatingValue<A3>::saved_type A3_saved; 302 A0_saved a0_saved; 303 A1_saved a1_saved; 304 A2_saved a2_saved; 305 A3_saved a3_saved; 306 307 void Emit(CodeGenFunction &CGF, Flags flags) { 308 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved); 309 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved); 310 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved); 311 A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved); 312 T(a0, a1, a2, a3).Emit(CGF, flags); 313 } 314 315 public: 316 ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3) 317 : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {} 318 }; 319 320 private: 321 // The implementation for this class is in CGException.h and 322 // CGException.cpp; the definition is here because it's used as a 323 // member of CodeGenFunction. 324 325 /// The start of the scope-stack buffer, i.e. the allocated pointer 326 /// for the buffer. All of these pointers are either simultaneously 327 /// null or simultaneously valid. 328 char *StartOfBuffer; 329 330 /// The end of the buffer. 331 char *EndOfBuffer; 332 333 /// The first valid entry in the buffer. 334 char *StartOfData; 335 336 /// The innermost normal cleanup on the stack. 337 stable_iterator InnermostNormalCleanup; 338 339 /// The innermost EH scope on the stack. 340 stable_iterator InnermostEHScope; 341 342 /// The current set of branch fixups. A branch fixup is a jump to 343 /// an as-yet unemitted label, i.e. a label for which we don't yet 344 /// know the EH stack depth. Whenever we pop a cleanup, we have 345 /// to thread all the current branch fixups through it. 346 /// 347 /// Fixups are recorded as the Use of the respective branch or 348 /// switch statement. The use points to the final destination. 349 /// When popping out of a cleanup, these uses are threaded through 350 /// the cleanup and adjusted to point to the new cleanup. 351 /// 352 /// Note that branches are allowed to jump into protected scopes 353 /// in certain situations; e.g. the following code is legal: 354 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor 355 /// goto foo; 356 /// A a; 357 /// foo: 358 /// bar(); 359 SmallVector<BranchFixup, 8> BranchFixups; 360 361 char *allocate(size_t Size); 362 363 void *pushCleanup(CleanupKind K, size_t DataSize); 364 365 public: 366 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0), 367 InnermostNormalCleanup(stable_end()), 368 InnermostEHScope(stable_end()) {} 369 ~EHScopeStack() { delete[] StartOfBuffer; } 370 371 // Variadic templates would make this not terrible. 372 373 /// Push a lazily-created cleanup on the stack. 374 template <class T> 375 void pushCleanup(CleanupKind Kind) { 376 void *Buffer = pushCleanup(Kind, sizeof(T)); 377 Cleanup *Obj = new(Buffer) T(); 378 (void) Obj; 379 } 380 381 /// Push a lazily-created cleanup on the stack. 382 template <class T, class A0> 383 void pushCleanup(CleanupKind Kind, A0 a0) { 384 void *Buffer = pushCleanup(Kind, sizeof(T)); 385 Cleanup *Obj = new(Buffer) T(a0); 386 (void) Obj; 387 } 388 389 /// Push a lazily-created cleanup on the stack. 390 template <class T, class A0, class A1> 391 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) { 392 void *Buffer = pushCleanup(Kind, sizeof(T)); 393 Cleanup *Obj = new(Buffer) T(a0, a1); 394 (void) Obj; 395 } 396 397 /// Push a lazily-created cleanup on the stack. 398 template <class T, class A0, class A1, class A2> 399 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) { 400 void *Buffer = pushCleanup(Kind, sizeof(T)); 401 Cleanup *Obj = new(Buffer) T(a0, a1, a2); 402 (void) Obj; 403 } 404 405 /// Push a lazily-created cleanup on the stack. 406 template <class T, class A0, class A1, class A2, class A3> 407 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) { 408 void *Buffer = pushCleanup(Kind, sizeof(T)); 409 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3); 410 (void) Obj; 411 } 412 413 /// Push a lazily-created cleanup on the stack. 414 template <class T, class A0, class A1, class A2, class A3, class A4> 415 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) { 416 void *Buffer = pushCleanup(Kind, sizeof(T)); 417 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4); 418 (void) Obj; 419 } 420 421 // Feel free to add more variants of the following: 422 423 /// Push a cleanup with non-constant storage requirements on the 424 /// stack. The cleanup type must provide an additional static method: 425 /// static size_t getExtraSize(size_t); 426 /// The argument to this method will be the value N, which will also 427 /// be passed as the first argument to the constructor. 428 /// 429 /// The data stored in the extra storage must obey the same 430 /// restrictions as normal cleanup member data. 431 /// 432 /// The pointer returned from this method is valid until the cleanup 433 /// stack is modified. 434 template <class T, class A0, class A1, class A2> 435 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) { 436 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N)); 437 return new (Buffer) T(N, a0, a1, a2); 438 } 439 440 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp. 441 void popCleanup(); 442 443 /// Push a set of catch handlers on the stack. The catch is 444 /// uninitialized and will need to have the given number of handlers 445 /// set on it. 446 class EHCatchScope *pushCatch(unsigned NumHandlers); 447 448 /// Pops a catch scope off the stack. This is private to CGException.cpp. 449 void popCatch(); 450 451 /// Push an exceptions filter on the stack. 452 class EHFilterScope *pushFilter(unsigned NumFilters); 453 454 /// Pops an exceptions filter off the stack. 455 void popFilter(); 456 457 /// Push a terminate handler on the stack. 458 void pushTerminate(); 459 460 /// Pops a terminate handler off the stack. 461 void popTerminate(); 462 463 /// Determines whether the exception-scopes stack is empty. 464 bool empty() const { return StartOfData == EndOfBuffer; } 465 466 bool requiresLandingPad() const { 467 return InnermostEHScope != stable_end(); 468 } 469 470 /// Determines whether there are any normal cleanups on the stack. 471 bool hasNormalCleanups() const { 472 return InnermostNormalCleanup != stable_end(); 473 } 474 475 /// Returns the innermost normal cleanup on the stack, or 476 /// stable_end() if there are no normal cleanups. 477 stable_iterator getInnermostNormalCleanup() const { 478 return InnermostNormalCleanup; 479 } 480 stable_iterator getInnermostActiveNormalCleanup() const; 481 482 stable_iterator getInnermostEHScope() const { 483 return InnermostEHScope; 484 } 485 486 stable_iterator getInnermostActiveEHScope() const; 487 488 /// An unstable reference to a scope-stack depth. Invalidated by 489 /// pushes but not pops. 490 class iterator; 491 492 /// Returns an iterator pointing to the innermost EH scope. 493 iterator begin() const; 494 495 /// Returns an iterator pointing to the outermost EH scope. 496 iterator end() const; 497 498 /// Create a stable reference to the top of the EH stack. The 499 /// returned reference is valid until that scope is popped off the 500 /// stack. 501 stable_iterator stable_begin() const { 502 return stable_iterator(EndOfBuffer - StartOfData); 503 } 504 505 /// Create a stable reference to the bottom of the EH stack. 506 static stable_iterator stable_end() { 507 return stable_iterator(0); 508 } 509 510 /// Translates an iterator into a stable_iterator. 511 stable_iterator stabilize(iterator it) const; 512 513 /// Turn a stable reference to a scope depth into a unstable pointer 514 /// to the EH stack. 515 iterator find(stable_iterator save) const; 516 517 /// Removes the cleanup pointed to by the given stable_iterator. 518 void removeCleanup(stable_iterator save); 519 520 /// Add a branch fixup to the current cleanup scope. 521 BranchFixup &addBranchFixup() { 522 assert(hasNormalCleanups() && "adding fixup in scope without cleanups"); 523 BranchFixups.push_back(BranchFixup()); 524 return BranchFixups.back(); 525 } 526 527 unsigned getNumBranchFixups() const { return BranchFixups.size(); } 528 BranchFixup &getBranchFixup(unsigned I) { 529 assert(I < getNumBranchFixups()); 530 return BranchFixups[I]; 531 } 532 533 /// Pops lazily-removed fixups from the end of the list. This 534 /// should only be called by procedures which have just popped a 535 /// cleanup or resolved one or more fixups. 536 void popNullFixups(); 537 538 /// Clears the branch-fixups list. This should only be called by 539 /// ResolveAllBranchFixups. 540 void clearFixups() { BranchFixups.clear(); } 541 }; 542 543 /// CodeGenFunction - This class organizes the per-function state that is used 544 /// while generating LLVM code. 545 class CodeGenFunction : public CodeGenTypeCache { 546 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION; 547 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION; 548 549 friend class CGCXXABI; 550 public: 551 /// A jump destination is an abstract label, branching to which may 552 /// require a jump out through normal cleanups. 553 struct JumpDest { 554 JumpDest() : Block(0), ScopeDepth(), Index(0) {} 555 JumpDest(llvm::BasicBlock *Block, 556 EHScopeStack::stable_iterator Depth, 557 unsigned Index) 558 : Block(Block), ScopeDepth(Depth), Index(Index) {} 559 560 bool isValid() const { return Block != 0; } 561 llvm::BasicBlock *getBlock() const { return Block; } 562 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; } 563 unsigned getDestIndex() const { return Index; } 564 565 private: 566 llvm::BasicBlock *Block; 567 EHScopeStack::stable_iterator ScopeDepth; 568 unsigned Index; 569 }; 570 571 CodeGenModule &CGM; // Per-module state. 572 const TargetInfo &Target; 573 574 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy; 575 CGBuilderTy Builder; 576 577 /// CurFuncDecl - Holds the Decl for the current function or ObjC method. 578 /// This excludes BlockDecls. 579 const Decl *CurFuncDecl; 580 /// CurCodeDecl - This is the inner-most code context, which includes blocks. 581 const Decl *CurCodeDecl; 582 const CGFunctionInfo *CurFnInfo; 583 QualType FnRetTy; 584 llvm::Function *CurFn; 585 586 /// CurGD - The GlobalDecl for the current function being compiled. 587 GlobalDecl CurGD; 588 589 /// PrologueCleanupDepth - The cleanup depth enclosing all the 590 /// cleanups associated with the parameters. 591 EHScopeStack::stable_iterator PrologueCleanupDepth; 592 593 /// ReturnBlock - Unified return block. 594 JumpDest ReturnBlock; 595 596 /// ReturnValue - The temporary alloca to hold the return value. This is null 597 /// iff the function has no return value. 598 llvm::Value *ReturnValue; 599 600 /// AllocaInsertPoint - This is an instruction in the entry block before which 601 /// we prefer to insert allocas. 602 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt; 603 604 /// BoundsChecking - Emit run-time bounds checks. Higher values mean 605 /// potentially higher performance penalties. 606 unsigned char BoundsChecking; 607 608 /// \brief Whether any type-checking sanitizers are enabled. If \c false, 609 /// calls to EmitTypeCheck can be skipped. 610 bool SanitizePerformTypeCheck; 611 612 /// \brief Sanitizer options to use for this function. 613 const SanitizerOptions *SanOpts; 614 615 /// In ARC, whether we should autorelease the return value. 616 bool AutoreleaseResult; 617 618 const CodeGen::CGBlockInfo *BlockInfo; 619 llvm::Value *BlockPointer; 620 621 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields; 622 FieldDecl *LambdaThisCaptureField; 623 624 /// \brief A mapping from NRVO variables to the flags used to indicate 625 /// when the NRVO has been applied to this variable. 626 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags; 627 628 EHScopeStack EHStack; 629 630 /// i32s containing the indexes of the cleanup destinations. 631 llvm::AllocaInst *NormalCleanupDest; 632 633 unsigned NextCleanupDestIndex; 634 635 /// FirstBlockInfo - The head of a singly-linked-list of block layouts. 636 CGBlockInfo *FirstBlockInfo; 637 638 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume. 639 llvm::BasicBlock *EHResumeBlock; 640 641 /// The exception slot. All landing pads write the current exception pointer 642 /// into this alloca. 643 llvm::Value *ExceptionSlot; 644 645 /// The selector slot. Under the MandatoryCleanup model, all landing pads 646 /// write the current selector value into this alloca. 647 llvm::AllocaInst *EHSelectorSlot; 648 649 /// Emits a landing pad for the current EH stack. 650 llvm::BasicBlock *EmitLandingPad(); 651 652 llvm::BasicBlock *getInvokeDestImpl(); 653 654 template <class T> 655 typename DominatingValue<T>::saved_type saveValueInCond(T value) { 656 return DominatingValue<T>::save(*this, value); 657 } 658 659 public: 660 /// ObjCEHValueStack - Stack of Objective-C exception values, used for 661 /// rethrows. 662 SmallVector<llvm::Value*, 8> ObjCEHValueStack; 663 664 /// A class controlling the emission of a finally block. 665 class FinallyInfo { 666 /// Where the catchall's edge through the cleanup should go. 667 JumpDest RethrowDest; 668 669 /// A function to call to enter the catch. 670 llvm::Constant *BeginCatchFn; 671 672 /// An i1 variable indicating whether or not the @finally is 673 /// running for an exception. 674 llvm::AllocaInst *ForEHVar; 675 676 /// An i8* variable into which the exception pointer to rethrow 677 /// has been saved. 678 llvm::AllocaInst *SavedExnVar; 679 680 public: 681 void enter(CodeGenFunction &CGF, const Stmt *Finally, 682 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn, 683 llvm::Constant *rethrowFn); 684 void exit(CodeGenFunction &CGF); 685 }; 686 687 /// pushFullExprCleanup - Push a cleanup to be run at the end of the 688 /// current full-expression. Safe against the possibility that 689 /// we're currently inside a conditionally-evaluated expression. 690 template <class T, class A0> 691 void pushFullExprCleanup(CleanupKind kind, A0 a0) { 692 // If we're not in a conditional branch, or if none of the 693 // arguments requires saving, then use the unconditional cleanup. 694 if (!isInConditionalBranch()) 695 return EHStack.pushCleanup<T>(kind, a0); 696 697 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0); 698 699 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType; 700 EHStack.pushCleanup<CleanupType>(kind, a0_saved); 701 initFullExprCleanup(); 702 } 703 704 /// pushFullExprCleanup - Push a cleanup to be run at the end of the 705 /// current full-expression. Safe against the possibility that 706 /// we're currently inside a conditionally-evaluated expression. 707 template <class T, class A0, class A1> 708 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) { 709 // If we're not in a conditional branch, or if none of the 710 // arguments requires saving, then use the unconditional cleanup. 711 if (!isInConditionalBranch()) 712 return EHStack.pushCleanup<T>(kind, a0, a1); 713 714 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0); 715 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1); 716 717 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType; 718 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved); 719 initFullExprCleanup(); 720 } 721 722 /// pushFullExprCleanup - Push a cleanup to be run at the end of the 723 /// current full-expression. Safe against the possibility that 724 /// we're currently inside a conditionally-evaluated expression. 725 template <class T, class A0, class A1, class A2> 726 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) { 727 // If we're not in a conditional branch, or if none of the 728 // arguments requires saving, then use the unconditional cleanup. 729 if (!isInConditionalBranch()) { 730 return EHStack.pushCleanup<T>(kind, a0, a1, a2); 731 } 732 733 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0); 734 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1); 735 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2); 736 737 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType; 738 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved); 739 initFullExprCleanup(); 740 } 741 742 /// pushFullExprCleanup - Push a cleanup to be run at the end of the 743 /// current full-expression. Safe against the possibility that 744 /// we're currently inside a conditionally-evaluated expression. 745 template <class T, class A0, class A1, class A2, class A3> 746 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) { 747 // If we're not in a conditional branch, or if none of the 748 // arguments requires saving, then use the unconditional cleanup. 749 if (!isInConditionalBranch()) { 750 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3); 751 } 752 753 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0); 754 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1); 755 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2); 756 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3); 757 758 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType; 759 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, 760 a2_saved, a3_saved); 761 initFullExprCleanup(); 762 } 763 764 /// Set up the last cleaup that was pushed as a conditional 765 /// full-expression cleanup. 766 void initFullExprCleanup(); 767 768 /// PushDestructorCleanup - Push a cleanup to call the 769 /// complete-object destructor of an object of the given type at the 770 /// given address. Does nothing if T is not a C++ class type with a 771 /// non-trivial destructor. 772 void PushDestructorCleanup(QualType T, llvm::Value *Addr); 773 774 /// PushDestructorCleanup - Push a cleanup to call the 775 /// complete-object variant of the given destructor on the object at 776 /// the given address. 777 void PushDestructorCleanup(const CXXDestructorDecl *Dtor, 778 llvm::Value *Addr); 779 780 /// PopCleanupBlock - Will pop the cleanup entry on the stack and 781 /// process all branch fixups. 782 void PopCleanupBlock(bool FallThroughIsBranchThrough = false); 783 784 /// DeactivateCleanupBlock - Deactivates the given cleanup block. 785 /// The block cannot be reactivated. Pops it if it's the top of the 786 /// stack. 787 /// 788 /// \param DominatingIP - An instruction which is known to 789 /// dominate the current IP (if set) and which lies along 790 /// all paths of execution between the current IP and the 791 /// the point at which the cleanup comes into scope. 792 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup, 793 llvm::Instruction *DominatingIP); 794 795 /// ActivateCleanupBlock - Activates an initially-inactive cleanup. 796 /// Cannot be used to resurrect a deactivated cleanup. 797 /// 798 /// \param DominatingIP - An instruction which is known to 799 /// dominate the current IP (if set) and which lies along 800 /// all paths of execution between the current IP and the 801 /// the point at which the cleanup comes into scope. 802 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup, 803 llvm::Instruction *DominatingIP); 804 805 /// \brief Enters a new scope for capturing cleanups, all of which 806 /// will be executed once the scope is exited. 807 class RunCleanupsScope { 808 EHScopeStack::stable_iterator CleanupStackDepth; 809 bool OldDidCallStackSave; 810 protected: 811 bool PerformCleanup; 812 private: 813 814 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION; 815 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION; 816 817 protected: 818 CodeGenFunction& CGF; 819 820 public: 821 /// \brief Enter a new cleanup scope. 822 explicit RunCleanupsScope(CodeGenFunction &CGF) 823 : PerformCleanup(true), CGF(CGF) 824 { 825 CleanupStackDepth = CGF.EHStack.stable_begin(); 826 OldDidCallStackSave = CGF.DidCallStackSave; 827 CGF.DidCallStackSave = false; 828 } 829 830 /// \brief Exit this cleanup scope, emitting any accumulated 831 /// cleanups. 832 ~RunCleanupsScope() { 833 if (PerformCleanup) { 834 CGF.DidCallStackSave = OldDidCallStackSave; 835 CGF.PopCleanupBlocks(CleanupStackDepth); 836 } 837 } 838 839 /// \brief Determine whether this scope requires any cleanups. 840 bool requiresCleanups() const { 841 return CGF.EHStack.stable_begin() != CleanupStackDepth; 842 } 843 844 /// \brief Force the emission of cleanups now, instead of waiting 845 /// until this object is destroyed. 846 void ForceCleanup() { 847 assert(PerformCleanup && "Already forced cleanup"); 848 CGF.DidCallStackSave = OldDidCallStackSave; 849 CGF.PopCleanupBlocks(CleanupStackDepth); 850 PerformCleanup = false; 851 } 852 }; 853 854 class LexicalScope: protected RunCleanupsScope { 855 SourceRange Range; 856 857 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION; 858 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION; 859 860 public: 861 /// \brief Enter a new cleanup scope. 862 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range) 863 : RunCleanupsScope(CGF), Range(Range) { 864 if (CGDebugInfo *DI = CGF.getDebugInfo()) 865 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin()); 866 } 867 868 /// \brief Exit this cleanup scope, emitting any accumulated 869 /// cleanups. 870 ~LexicalScope() { 871 if (PerformCleanup) endLexicalScope(); 872 } 873 874 /// \brief Force the emission of cleanups now, instead of waiting 875 /// until this object is destroyed. 876 void ForceCleanup() { 877 RunCleanupsScope::ForceCleanup(); 878 endLexicalScope(); 879 } 880 881 private: 882 void endLexicalScope() { 883 if (CGDebugInfo *DI = CGF.getDebugInfo()) 884 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd()); 885 } 886 }; 887 888 889 /// PopCleanupBlocks - Takes the old cleanup stack size and emits 890 /// the cleanup blocks that have been added. 891 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize); 892 893 void ResolveBranchFixups(llvm::BasicBlock *Target); 894 895 /// The given basic block lies in the current EH scope, but may be a 896 /// target of a potentially scope-crossing jump; get a stable handle 897 /// to which we can perform this jump later. 898 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) { 899 return JumpDest(Target, 900 EHStack.getInnermostNormalCleanup(), 901 NextCleanupDestIndex++); 902 } 903 904 /// The given basic block lies in the current EH scope, but may be a 905 /// target of a potentially scope-crossing jump; get a stable handle 906 /// to which we can perform this jump later. 907 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) { 908 return getJumpDestInCurrentScope(createBasicBlock(Name)); 909 } 910 911 /// EmitBranchThroughCleanup - Emit a branch from the current insert 912 /// block through the normal cleanup handling code (if any) and then 913 /// on to \arg Dest. 914 void EmitBranchThroughCleanup(JumpDest Dest); 915 916 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the 917 /// specified destination obviously has no cleanups to run. 'false' is always 918 /// a conservatively correct answer for this method. 919 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const; 920 921 /// popCatchScope - Pops the catch scope at the top of the EHScope 922 /// stack, emitting any required code (other than the catch handlers 923 /// themselves). 924 void popCatchScope(); 925 926 llvm::BasicBlock *getEHResumeBlock(bool isCleanup); 927 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope); 928 929 /// An object to manage conditionally-evaluated expressions. 930 class ConditionalEvaluation { 931 llvm::BasicBlock *StartBB; 932 933 public: 934 ConditionalEvaluation(CodeGenFunction &CGF) 935 : StartBB(CGF.Builder.GetInsertBlock()) {} 936 937 void begin(CodeGenFunction &CGF) { 938 assert(CGF.OutermostConditional != this); 939 if (!CGF.OutermostConditional) 940 CGF.OutermostConditional = this; 941 } 942 943 void end(CodeGenFunction &CGF) { 944 assert(CGF.OutermostConditional != 0); 945 if (CGF.OutermostConditional == this) 946 CGF.OutermostConditional = 0; 947 } 948 949 /// Returns a block which will be executed prior to each 950 /// evaluation of the conditional code. 951 llvm::BasicBlock *getStartingBlock() const { 952 return StartBB; 953 } 954 }; 955 956 /// isInConditionalBranch - Return true if we're currently emitting 957 /// one branch or the other of a conditional expression. 958 bool isInConditionalBranch() const { return OutermostConditional != 0; } 959 960 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) { 961 assert(isInConditionalBranch()); 962 llvm::BasicBlock *block = OutermostConditional->getStartingBlock(); 963 new llvm::StoreInst(value, addr, &block->back()); 964 } 965 966 /// An RAII object to record that we're evaluating a statement 967 /// expression. 968 class StmtExprEvaluation { 969 CodeGenFunction &CGF; 970 971 /// We have to save the outermost conditional: cleanups in a 972 /// statement expression aren't conditional just because the 973 /// StmtExpr is. 974 ConditionalEvaluation *SavedOutermostConditional; 975 976 public: 977 StmtExprEvaluation(CodeGenFunction &CGF) 978 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) { 979 CGF.OutermostConditional = 0; 980 } 981 982 ~StmtExprEvaluation() { 983 CGF.OutermostConditional = SavedOutermostConditional; 984 CGF.EnsureInsertPoint(); 985 } 986 }; 987 988 /// An object which temporarily prevents a value from being 989 /// destroyed by aggressive peephole optimizations that assume that 990 /// all uses of a value have been realized in the IR. 991 class PeepholeProtection { 992 llvm::Instruction *Inst; 993 friend class CodeGenFunction; 994 995 public: 996 PeepholeProtection() : Inst(0) {} 997 }; 998 999 /// A non-RAII class containing all the information about a bound 1000 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for 1001 /// this which makes individual mappings very simple; using this 1002 /// class directly is useful when you have a variable number of 1003 /// opaque values or don't want the RAII functionality for some 1004 /// reason. 1005 class OpaqueValueMappingData { 1006 const OpaqueValueExpr *OpaqueValue; 1007 bool BoundLValue; 1008 CodeGenFunction::PeepholeProtection Protection; 1009 1010 OpaqueValueMappingData(const OpaqueValueExpr *ov, 1011 bool boundLValue) 1012 : OpaqueValue(ov), BoundLValue(boundLValue) {} 1013 public: 1014 OpaqueValueMappingData() : OpaqueValue(0) {} 1015 1016 static bool shouldBindAsLValue(const Expr *expr) { 1017 // gl-values should be bound as l-values for obvious reasons. 1018 // Records should be bound as l-values because IR generation 1019 // always keeps them in memory. Expressions of function type 1020 // act exactly like l-values but are formally required to be 1021 // r-values in C. 1022 return expr->isGLValue() || 1023 expr->getType()->isRecordType() || 1024 expr->getType()->isFunctionType(); 1025 } 1026 1027 static OpaqueValueMappingData bind(CodeGenFunction &CGF, 1028 const OpaqueValueExpr *ov, 1029 const Expr *e) { 1030 if (shouldBindAsLValue(ov)) 1031 return bind(CGF, ov, CGF.EmitLValue(e)); 1032 return bind(CGF, ov, CGF.EmitAnyExpr(e)); 1033 } 1034 1035 static OpaqueValueMappingData bind(CodeGenFunction &CGF, 1036 const OpaqueValueExpr *ov, 1037 const LValue &lv) { 1038 assert(shouldBindAsLValue(ov)); 1039 CGF.OpaqueLValues.insert(std::make_pair(ov, lv)); 1040 return OpaqueValueMappingData(ov, true); 1041 } 1042 1043 static OpaqueValueMappingData bind(CodeGenFunction &CGF, 1044 const OpaqueValueExpr *ov, 1045 const RValue &rv) { 1046 assert(!shouldBindAsLValue(ov)); 1047 CGF.OpaqueRValues.insert(std::make_pair(ov, rv)); 1048 1049 OpaqueValueMappingData data(ov, false); 1050 1051 // Work around an extremely aggressive peephole optimization in 1052 // EmitScalarConversion which assumes that all other uses of a 1053 // value are extant. 1054 data.Protection = CGF.protectFromPeepholes(rv); 1055 1056 return data; 1057 } 1058 1059 bool isValid() const { return OpaqueValue != 0; } 1060 void clear() { OpaqueValue = 0; } 1061 1062 void unbind(CodeGenFunction &CGF) { 1063 assert(OpaqueValue && "no data to unbind!"); 1064 1065 if (BoundLValue) { 1066 CGF.OpaqueLValues.erase(OpaqueValue); 1067 } else { 1068 CGF.OpaqueRValues.erase(OpaqueValue); 1069 CGF.unprotectFromPeepholes(Protection); 1070 } 1071 } 1072 }; 1073 1074 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr. 1075 class OpaqueValueMapping { 1076 CodeGenFunction &CGF; 1077 OpaqueValueMappingData Data; 1078 1079 public: 1080 static bool shouldBindAsLValue(const Expr *expr) { 1081 return OpaqueValueMappingData::shouldBindAsLValue(expr); 1082 } 1083 1084 /// Build the opaque value mapping for the given conditional 1085 /// operator if it's the GNU ?: extension. This is a common 1086 /// enough pattern that the convenience operator is really 1087 /// helpful. 1088 /// 1089 OpaqueValueMapping(CodeGenFunction &CGF, 1090 const AbstractConditionalOperator *op) : CGF(CGF) { 1091 if (isa<ConditionalOperator>(op)) 1092 // Leave Data empty. 1093 return; 1094 1095 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op); 1096 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(), 1097 e->getCommon()); 1098 } 1099 1100 OpaqueValueMapping(CodeGenFunction &CGF, 1101 const OpaqueValueExpr *opaqueValue, 1102 LValue lvalue) 1103 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) { 1104 } 1105 1106 OpaqueValueMapping(CodeGenFunction &CGF, 1107 const OpaqueValueExpr *opaqueValue, 1108 RValue rvalue) 1109 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) { 1110 } 1111 1112 void pop() { 1113 Data.unbind(CGF); 1114 Data.clear(); 1115 } 1116 1117 ~OpaqueValueMapping() { 1118 if (Data.isValid()) Data.unbind(CGF); 1119 } 1120 }; 1121 1122 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field 1123 /// number that holds the value. 1124 unsigned getByRefValueLLVMField(const ValueDecl *VD) const; 1125 1126 /// BuildBlockByrefAddress - Computes address location of the 1127 /// variable which is declared as __block. 1128 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr, 1129 const VarDecl *V); 1130 private: 1131 CGDebugInfo *DebugInfo; 1132 bool DisableDebugInfo; 1133 1134 /// If the current function returns 'this', use the field to keep track of 1135 /// the callee that returns 'this'. 1136 llvm::Value *CalleeWithThisReturn; 1137 1138 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid 1139 /// calling llvm.stacksave for multiple VLAs in the same scope. 1140 bool DidCallStackSave; 1141 1142 /// IndirectBranch - The first time an indirect goto is seen we create a block 1143 /// with an indirect branch. Every time we see the address of a label taken, 1144 /// we add the label to the indirect goto. Every subsequent indirect goto is 1145 /// codegen'd as a jump to the IndirectBranch's basic block. 1146 llvm::IndirectBrInst *IndirectBranch; 1147 1148 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C 1149 /// decls. 1150 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy; 1151 DeclMapTy LocalDeclMap; 1152 1153 /// LabelMap - This keeps track of the LLVM basic block for each C label. 1154 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap; 1155 1156 // BreakContinueStack - This keeps track of where break and continue 1157 // statements should jump to. 1158 struct BreakContinue { 1159 BreakContinue(JumpDest Break, JumpDest Continue) 1160 : BreakBlock(Break), ContinueBlock(Continue) {} 1161 1162 JumpDest BreakBlock; 1163 JumpDest ContinueBlock; 1164 }; 1165 SmallVector<BreakContinue, 8> BreakContinueStack; 1166 1167 /// SwitchInsn - This is nearest current switch instruction. It is null if 1168 /// current context is not in a switch. 1169 llvm::SwitchInst *SwitchInsn; 1170 1171 /// CaseRangeBlock - This block holds if condition check for last case 1172 /// statement range in current switch instruction. 1173 llvm::BasicBlock *CaseRangeBlock; 1174 1175 /// OpaqueLValues - Keeps track of the current set of opaque value 1176 /// expressions. 1177 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues; 1178 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues; 1179 1180 // VLASizeMap - This keeps track of the associated size for each VLA type. 1181 // We track this by the size expression rather than the type itself because 1182 // in certain situations, like a const qualifier applied to an VLA typedef, 1183 // multiple VLA types can share the same size expression. 1184 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we 1185 // enter/leave scopes. 1186 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap; 1187 1188 /// A block containing a single 'unreachable' instruction. Created 1189 /// lazily by getUnreachableBlock(). 1190 llvm::BasicBlock *UnreachableBlock; 1191 1192 /// CXXThisDecl - When generating code for a C++ member function, 1193 /// this will hold the implicit 'this' declaration. 1194 ImplicitParamDecl *CXXABIThisDecl; 1195 llvm::Value *CXXABIThisValue; 1196 llvm::Value *CXXThisValue; 1197 1198 /// CXXStructorImplicitParamDecl - When generating code for a constructor or 1199 /// destructor, this will hold the implicit argument (e.g. VTT). 1200 ImplicitParamDecl *CXXStructorImplicitParamDecl; 1201 llvm::Value *CXXStructorImplicitParamValue; 1202 1203 /// OutermostConditional - Points to the outermost active 1204 /// conditional control. This is used so that we know if a 1205 /// temporary should be destroyed conditionally. 1206 ConditionalEvaluation *OutermostConditional; 1207 1208 1209 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM 1210 /// type as well as the field number that contains the actual data. 1211 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *, 1212 unsigned> > ByRefValueInfo; 1213 1214 llvm::BasicBlock *TerminateLandingPad; 1215 llvm::BasicBlock *TerminateHandler; 1216 llvm::BasicBlock *TrapBB; 1217 1218 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'. 1219 /// In the kernel metadata node, reference the kernel function and metadata 1220 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2): 1221 /// - A node for the vec_type_hint(<type>) qualifier contains string 1222 /// "vec_type_hint", an undefined value of the <type> data type, 1223 /// and a Boolean that is true if the <type> is integer and signed. 1224 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string 1225 /// "work_group_size_hint", and three 32-bit integers X, Y and Z. 1226 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string 1227 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z. 1228 void EmitOpenCLKernelMetadata(const FunctionDecl *FD, 1229 llvm::Function *Fn); 1230 1231 public: 1232 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false); 1233 ~CodeGenFunction(); 1234 1235 CodeGenTypes &getTypes() const { return CGM.getTypes(); } 1236 ASTContext &getContext() const { return CGM.getContext(); } 1237 /// Returns true if DebugInfo is actually initialized. 1238 bool maybeInitializeDebugInfo() { 1239 if (CGM.getModuleDebugInfo()) { 1240 DebugInfo = CGM.getModuleDebugInfo(); 1241 return true; 1242 } 1243 return false; 1244 } 1245 CGDebugInfo *getDebugInfo() { 1246 if (DisableDebugInfo) 1247 return NULL; 1248 return DebugInfo; 1249 } 1250 void disableDebugInfo() { DisableDebugInfo = true; } 1251 void enableDebugInfo() { DisableDebugInfo = false; } 1252 1253 bool shouldUseFusedARCCalls() { 1254 return CGM.getCodeGenOpts().OptimizationLevel == 0; 1255 } 1256 1257 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); } 1258 1259 /// Returns a pointer to the function's exception object and selector slot, 1260 /// which is assigned in every landing pad. 1261 llvm::Value *getExceptionSlot(); 1262 llvm::Value *getEHSelectorSlot(); 1263 1264 /// Returns the contents of the function's exception object and selector 1265 /// slots. 1266 llvm::Value *getExceptionFromSlot(); 1267 llvm::Value *getSelectorFromSlot(); 1268 1269 llvm::Value *getNormalCleanupDestSlot(); 1270 1271 llvm::BasicBlock *getUnreachableBlock() { 1272 if (!UnreachableBlock) { 1273 UnreachableBlock = createBasicBlock("unreachable"); 1274 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock); 1275 } 1276 return UnreachableBlock; 1277 } 1278 1279 llvm::BasicBlock *getInvokeDest() { 1280 if (!EHStack.requiresLandingPad()) return 0; 1281 return getInvokeDestImpl(); 1282 } 1283 1284 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); } 1285 1286 //===--------------------------------------------------------------------===// 1287 // Cleanups 1288 //===--------------------------------------------------------------------===// 1289 1290 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty); 1291 1292 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin, 1293 llvm::Value *arrayEndPointer, 1294 QualType elementType, 1295 Destroyer *destroyer); 1296 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin, 1297 llvm::Value *arrayEnd, 1298 QualType elementType, 1299 Destroyer *destroyer); 1300 1301 void pushDestroy(QualType::DestructionKind dtorKind, 1302 llvm::Value *addr, QualType type); 1303 void pushEHDestroy(QualType::DestructionKind dtorKind, 1304 llvm::Value *addr, QualType type); 1305 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type, 1306 Destroyer *destroyer, bool useEHCleanupForArray); 1307 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer, 1308 bool useEHCleanupForArray); 1309 llvm::Function *generateDestroyHelper(llvm::Constant *addr, 1310 QualType type, 1311 Destroyer *destroyer, 1312 bool useEHCleanupForArray); 1313 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end, 1314 QualType type, Destroyer *destroyer, 1315 bool checkZeroLength, bool useEHCleanup); 1316 1317 Destroyer *getDestroyer(QualType::DestructionKind destructionKind); 1318 1319 /// Determines whether an EH cleanup is required to destroy a type 1320 /// with the given destruction kind. 1321 bool needsEHCleanup(QualType::DestructionKind kind) { 1322 switch (kind) { 1323 case QualType::DK_none: 1324 return false; 1325 case QualType::DK_cxx_destructor: 1326 case QualType::DK_objc_weak_lifetime: 1327 return getLangOpts().Exceptions; 1328 case QualType::DK_objc_strong_lifetime: 1329 return getLangOpts().Exceptions && 1330 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions; 1331 } 1332 llvm_unreachable("bad destruction kind"); 1333 } 1334 1335 CleanupKind getCleanupKind(QualType::DestructionKind kind) { 1336 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup); 1337 } 1338 1339 //===--------------------------------------------------------------------===// 1340 // Objective-C 1341 //===--------------------------------------------------------------------===// 1342 1343 void GenerateObjCMethod(const ObjCMethodDecl *OMD); 1344 1345 void StartObjCMethod(const ObjCMethodDecl *MD, 1346 const ObjCContainerDecl *CD, 1347 SourceLocation StartLoc); 1348 1349 /// GenerateObjCGetter - Synthesize an Objective-C property getter function. 1350 void GenerateObjCGetter(ObjCImplementationDecl *IMP, 1351 const ObjCPropertyImplDecl *PID); 1352 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl, 1353 const ObjCPropertyImplDecl *propImpl, 1354 const ObjCMethodDecl *GetterMothodDecl, 1355 llvm::Constant *AtomicHelperFn); 1356 1357 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP, 1358 ObjCMethodDecl *MD, bool ctor); 1359 1360 /// GenerateObjCSetter - Synthesize an Objective-C property setter function 1361 /// for the given property. 1362 void GenerateObjCSetter(ObjCImplementationDecl *IMP, 1363 const ObjCPropertyImplDecl *PID); 1364 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl, 1365 const ObjCPropertyImplDecl *propImpl, 1366 llvm::Constant *AtomicHelperFn); 1367 bool IndirectObjCSetterArg(const CGFunctionInfo &FI); 1368 bool IvarTypeWithAggrGCObjects(QualType Ty); 1369 1370 //===--------------------------------------------------------------------===// 1371 // Block Bits 1372 //===--------------------------------------------------------------------===// 1373 1374 llvm::Value *EmitBlockLiteral(const BlockExpr *); 1375 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info); 1376 static void destroyBlockInfos(CGBlockInfo *info); 1377 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *, 1378 const CGBlockInfo &Info, 1379 llvm::StructType *, 1380 llvm::Constant *BlockVarLayout); 1381 1382 llvm::Function *GenerateBlockFunction(GlobalDecl GD, 1383 const CGBlockInfo &Info, 1384 const Decl *OuterFuncDecl, 1385 const DeclMapTy &ldm, 1386 bool IsLambdaConversionToBlock); 1387 1388 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo); 1389 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo); 1390 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction( 1391 const ObjCPropertyImplDecl *PID); 1392 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction( 1393 const ObjCPropertyImplDecl *PID); 1394 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty); 1395 1396 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags); 1397 1398 class AutoVarEmission; 1399 1400 void emitByrefStructureInit(const AutoVarEmission &emission); 1401 void enterByrefCleanup(const AutoVarEmission &emission); 1402 1403 llvm::Value *LoadBlockStruct() { 1404 assert(BlockPointer && "no block pointer set!"); 1405 return BlockPointer; 1406 } 1407 1408 void AllocateBlockCXXThisPointer(const CXXThisExpr *E); 1409 void AllocateBlockDecl(const DeclRefExpr *E); 1410 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef); 1411 llvm::Type *BuildByRefType(const VarDecl *var); 1412 1413 void GenerateCode(GlobalDecl GD, llvm::Function *Fn, 1414 const CGFunctionInfo &FnInfo); 1415 void StartFunction(GlobalDecl GD, QualType RetTy, 1416 llvm::Function *Fn, 1417 const CGFunctionInfo &FnInfo, 1418 const FunctionArgList &Args, 1419 SourceLocation StartLoc); 1420 1421 void EmitConstructorBody(FunctionArgList &Args); 1422 void EmitDestructorBody(FunctionArgList &Args); 1423 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args); 1424 void EmitFunctionBody(FunctionArgList &Args); 1425 1426 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda, 1427 CallArgList &CallArgs); 1428 void EmitLambdaToBlockPointerBody(FunctionArgList &Args); 1429 void EmitLambdaBlockInvokeBody(); 1430 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD); 1431 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD); 1432 1433 /// EmitReturnBlock - Emit the unified return block, trying to avoid its 1434 /// emission when possible. 1435 void EmitReturnBlock(); 1436 1437 /// FinishFunction - Complete IR generation of the current function. It is 1438 /// legal to call this function even if there is no current insertion point. 1439 void FinishFunction(SourceLocation EndLoc=SourceLocation()); 1440 1441 /// GenerateThunk - Generate a thunk for the given method. 1442 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo, 1443 GlobalDecl GD, const ThunkInfo &Thunk); 1444 1445 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo, 1446 GlobalDecl GD, const ThunkInfo &Thunk); 1447 1448 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type, 1449 FunctionArgList &Args); 1450 1451 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init, 1452 ArrayRef<VarDecl *> ArrayIndexes); 1453 1454 /// InitializeVTablePointer - Initialize the vtable pointer of the given 1455 /// subobject. 1456 /// 1457 void InitializeVTablePointer(BaseSubobject Base, 1458 const CXXRecordDecl *NearestVBase, 1459 CharUnits OffsetFromNearestVBase, 1460 llvm::Constant *VTable, 1461 const CXXRecordDecl *VTableClass); 1462 1463 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy; 1464 void InitializeVTablePointers(BaseSubobject Base, 1465 const CXXRecordDecl *NearestVBase, 1466 CharUnits OffsetFromNearestVBase, 1467 bool BaseIsNonVirtualPrimaryBase, 1468 llvm::Constant *VTable, 1469 const CXXRecordDecl *VTableClass, 1470 VisitedVirtualBasesSetTy& VBases); 1471 1472 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl); 1473 1474 /// GetVTablePtr - Return the Value of the vtable pointer member pointed 1475 /// to by This. 1476 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty); 1477 1478 /// EnterDtorCleanups - Enter the cleanups necessary to complete the 1479 /// given phase of destruction for a destructor. The end result 1480 /// should call destructors on members and base classes in reverse 1481 /// order of their construction. 1482 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type); 1483 1484 /// ShouldInstrumentFunction - Return true if the current function should be 1485 /// instrumented with __cyg_profile_func_* calls 1486 bool ShouldInstrumentFunction(); 1487 1488 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified 1489 /// instrumentation function with the current function and the call site, if 1490 /// function instrumentation is enabled. 1491 void EmitFunctionInstrumentation(const char *Fn); 1492 1493 /// EmitMCountInstrumentation - Emit call to .mcount. 1494 void EmitMCountInstrumentation(); 1495 1496 /// EmitFunctionProlog - Emit the target specific LLVM code to load the 1497 /// arguments for the given function. This is also responsible for naming the 1498 /// LLVM function arguments. 1499 void EmitFunctionProlog(const CGFunctionInfo &FI, 1500 llvm::Function *Fn, 1501 const FunctionArgList &Args); 1502 1503 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the 1504 /// given temporary. 1505 void EmitFunctionEpilog(const CGFunctionInfo &FI); 1506 1507 /// EmitStartEHSpec - Emit the start of the exception spec. 1508 void EmitStartEHSpec(const Decl *D); 1509 1510 /// EmitEndEHSpec - Emit the end of the exception spec. 1511 void EmitEndEHSpec(const Decl *D); 1512 1513 /// getTerminateLandingPad - Return a landing pad that just calls terminate. 1514 llvm::BasicBlock *getTerminateLandingPad(); 1515 1516 /// getTerminateHandler - Return a handler (not a landing pad, just 1517 /// a catch handler) that just calls terminate. This is used when 1518 /// a terminate scope encloses a try. 1519 llvm::BasicBlock *getTerminateHandler(); 1520 1521 llvm::Type *ConvertTypeForMem(QualType T); 1522 llvm::Type *ConvertType(QualType T); 1523 llvm::Type *ConvertType(const TypeDecl *T) { 1524 return ConvertType(getContext().getTypeDeclType(T)); 1525 } 1526 1527 /// LoadObjCSelf - Load the value of self. This function is only valid while 1528 /// generating code for an Objective-C method. 1529 llvm::Value *LoadObjCSelf(); 1530 1531 /// TypeOfSelfObject - Return type of object that this self represents. 1532 QualType TypeOfSelfObject(); 1533 1534 /// hasAggregateLLVMType - Return true if the specified AST type will map into 1535 /// an aggregate LLVM type or is void. 1536 static TypeEvaluationKind getEvaluationKind(QualType T); 1537 1538 static bool hasScalarEvaluationKind(QualType T) { 1539 return getEvaluationKind(T) == TEK_Scalar; 1540 } 1541 1542 static bool hasAggregateEvaluationKind(QualType T) { 1543 return getEvaluationKind(T) == TEK_Aggregate; 1544 } 1545 1546 /// createBasicBlock - Create an LLVM basic block. 1547 llvm::BasicBlock *createBasicBlock(const Twine &name = "", 1548 llvm::Function *parent = 0, 1549 llvm::BasicBlock *before = 0) { 1550 #ifdef NDEBUG 1551 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before); 1552 #else 1553 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before); 1554 #endif 1555 } 1556 1557 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified 1558 /// label maps to. 1559 JumpDest getJumpDestForLabel(const LabelDecl *S); 1560 1561 /// SimplifyForwardingBlocks - If the given basic block is only a branch to 1562 /// another basic block, simplify it. This assumes that no other code could 1563 /// potentially reference the basic block. 1564 void SimplifyForwardingBlocks(llvm::BasicBlock *BB); 1565 1566 /// EmitBlock - Emit the given block \arg BB and set it as the insert point, 1567 /// adding a fall-through branch from the current insert block if 1568 /// necessary. It is legal to call this function even if there is no current 1569 /// insertion point. 1570 /// 1571 /// IsFinished - If true, indicates that the caller has finished emitting 1572 /// branches to the given block and does not expect to emit code into it. This 1573 /// means the block can be ignored if it is unreachable. 1574 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false); 1575 1576 /// EmitBlockAfterUses - Emit the given block somewhere hopefully 1577 /// near its uses, and leave the insertion point in it. 1578 void EmitBlockAfterUses(llvm::BasicBlock *BB); 1579 1580 /// EmitBranch - Emit a branch to the specified basic block from the current 1581 /// insert block, taking care to avoid creation of branches from dummy 1582 /// blocks. It is legal to call this function even if there is no current 1583 /// insertion point. 1584 /// 1585 /// This function clears the current insertion point. The caller should follow 1586 /// calls to this function with calls to Emit*Block prior to generation new 1587 /// code. 1588 void EmitBranch(llvm::BasicBlock *Block); 1589 1590 /// HaveInsertPoint - True if an insertion point is defined. If not, this 1591 /// indicates that the current code being emitted is unreachable. 1592 bool HaveInsertPoint() const { 1593 return Builder.GetInsertBlock() != 0; 1594 } 1595 1596 /// EnsureInsertPoint - Ensure that an insertion point is defined so that 1597 /// emitted IR has a place to go. Note that by definition, if this function 1598 /// creates a block then that block is unreachable; callers may do better to 1599 /// detect when no insertion point is defined and simply skip IR generation. 1600 void EnsureInsertPoint() { 1601 if (!HaveInsertPoint()) 1602 EmitBlock(createBasicBlock()); 1603 } 1604 1605 /// ErrorUnsupported - Print out an error that codegen doesn't support the 1606 /// specified stmt yet. 1607 void ErrorUnsupported(const Stmt *S, const char *Type, 1608 bool OmitOnError=false); 1609 1610 //===--------------------------------------------------------------------===// 1611 // Helpers 1612 //===--------------------------------------------------------------------===// 1613 1614 LValue MakeAddrLValue(llvm::Value *V, QualType T, 1615 CharUnits Alignment = CharUnits()) { 1616 return LValue::MakeAddr(V, T, Alignment, getContext(), 1617 CGM.getTBAAInfo(T)); 1618 } 1619 1620 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) { 1621 CharUnits Alignment; 1622 if (!T->isIncompleteType()) 1623 Alignment = getContext().getTypeAlignInChars(T); 1624 return LValue::MakeAddr(V, T, Alignment, getContext(), 1625 CGM.getTBAAInfo(T)); 1626 } 1627 1628 /// CreateTempAlloca - This creates a alloca and inserts it into the entry 1629 /// block. The caller is responsible for setting an appropriate alignment on 1630 /// the alloca. 1631 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, 1632 const Twine &Name = "tmp"); 1633 1634 /// InitTempAlloca - Provide an initial value for the given alloca. 1635 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value); 1636 1637 /// CreateIRTemp - Create a temporary IR object of the given type, with 1638 /// appropriate alignment. This routine should only be used when an temporary 1639 /// value needs to be stored into an alloca (for example, to avoid explicit 1640 /// PHI construction), but the type is the IR type, not the type appropriate 1641 /// for storing in memory. 1642 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp"); 1643 1644 /// CreateMemTemp - Create a temporary memory object of the given type, with 1645 /// appropriate alignment. 1646 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp"); 1647 1648 /// CreateAggTemp - Create a temporary memory object for the given 1649 /// aggregate type. 1650 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") { 1651 CharUnits Alignment = getContext().getTypeAlignInChars(T); 1652 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment, 1653 T.getQualifiers(), 1654 AggValueSlot::IsNotDestructed, 1655 AggValueSlot::DoesNotNeedGCBarriers, 1656 AggValueSlot::IsNotAliased); 1657 } 1658 1659 /// Emit a cast to void* in the appropriate address space. 1660 llvm::Value *EmitCastToVoidPtr(llvm::Value *value); 1661 1662 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified 1663 /// expression and compare the result against zero, returning an Int1Ty value. 1664 llvm::Value *EvaluateExprAsBool(const Expr *E); 1665 1666 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result. 1667 void EmitIgnoredExpr(const Expr *E); 1668 1669 /// EmitAnyExpr - Emit code to compute the specified expression which can have 1670 /// any type. The result is returned as an RValue struct. If this is an 1671 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where 1672 /// the result should be returned. 1673 /// 1674 /// \param ignoreResult True if the resulting value isn't used. 1675 RValue EmitAnyExpr(const Expr *E, 1676 AggValueSlot aggSlot = AggValueSlot::ignored(), 1677 bool ignoreResult = false); 1678 1679 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address 1680 // or the value of the expression, depending on how va_list is defined. 1681 llvm::Value *EmitVAListRef(const Expr *E); 1682 1683 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will 1684 /// always be accessible even if no aggregate location is provided. 1685 RValue EmitAnyExprToTemp(const Expr *E); 1686 1687 /// EmitAnyExprToMem - Emits the code necessary to evaluate an 1688 /// arbitrary expression into the given memory location. 1689 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location, 1690 Qualifiers Quals, bool IsInitializer); 1691 1692 /// EmitExprAsInit - Emits the code necessary to initialize a 1693 /// location in memory with the given initializer. 1694 void EmitExprAsInit(const Expr *init, const ValueDecl *D, 1695 LValue lvalue, bool capturedByInit); 1696 1697 /// hasVolatileMember - returns true if aggregate type has a volatile 1698 /// member. 1699 bool hasVolatileMember(QualType T) { 1700 if (const RecordType *RT = T->getAs<RecordType>()) { 1701 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl()); 1702 return RD->hasVolatileMember(); 1703 } 1704 return false; 1705 } 1706 /// EmitAggregateCopy - Emit an aggregate assignment. 1707 /// 1708 /// The difference to EmitAggregateCopy is that tail padding is not copied. 1709 /// This is required for correctness when assigning non-POD structures in C++. 1710 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr, 1711 QualType EltTy) { 1712 bool IsVolatile = hasVolatileMember(EltTy); 1713 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(), 1714 true); 1715 } 1716 1717 /// EmitAggregateCopy - Emit an aggregate copy. 1718 /// 1719 /// \param isVolatile - True iff either the source or the destination is 1720 /// volatile. 1721 /// \param isAssignment - If false, allow padding to be copied. This often 1722 /// yields more efficient. 1723 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr, 1724 QualType EltTy, bool isVolatile=false, 1725 CharUnits Alignment = CharUnits::Zero(), 1726 bool isAssignment = false); 1727 1728 /// StartBlock - Start new block named N. If insert block is a dummy block 1729 /// then reuse it. 1730 void StartBlock(const char *N); 1731 1732 /// GetAddrOfLocalVar - Return the address of a local variable. 1733 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) { 1734 llvm::Value *Res = LocalDeclMap[VD]; 1735 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!"); 1736 return Res; 1737 } 1738 1739 /// getOpaqueLValueMapping - Given an opaque value expression (which 1740 /// must be mapped to an l-value), return its mapping. 1741 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) { 1742 assert(OpaqueValueMapping::shouldBindAsLValue(e)); 1743 1744 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator 1745 it = OpaqueLValues.find(e); 1746 assert(it != OpaqueLValues.end() && "no mapping for opaque value!"); 1747 return it->second; 1748 } 1749 1750 /// getOpaqueRValueMapping - Given an opaque value expression (which 1751 /// must be mapped to an r-value), return its mapping. 1752 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) { 1753 assert(!OpaqueValueMapping::shouldBindAsLValue(e)); 1754 1755 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator 1756 it = OpaqueRValues.find(e); 1757 assert(it != OpaqueRValues.end() && "no mapping for opaque value!"); 1758 return it->second; 1759 } 1760 1761 /// getAccessedFieldNo - Given an encoded value and a result number, return 1762 /// the input field number being accessed. 1763 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts); 1764 1765 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L); 1766 llvm::BasicBlock *GetIndirectGotoBlock(); 1767 1768 /// EmitNullInitialization - Generate code to set a value of the given type to 1769 /// null, If the type contains data member pointers, they will be initialized 1770 /// to -1 in accordance with the Itanium C++ ABI. 1771 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty); 1772 1773 // EmitVAArg - Generate code to get an argument from the passed in pointer 1774 // and update it accordingly. The return value is a pointer to the argument. 1775 // FIXME: We should be able to get rid of this method and use the va_arg 1776 // instruction in LLVM instead once it works well enough. 1777 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty); 1778 1779 /// emitArrayLength - Compute the length of an array, even if it's a 1780 /// VLA, and drill down to the base element type. 1781 llvm::Value *emitArrayLength(const ArrayType *arrayType, 1782 QualType &baseType, 1783 llvm::Value *&addr); 1784 1785 /// EmitVLASize - Capture all the sizes for the VLA expressions in 1786 /// the given variably-modified type and store them in the VLASizeMap. 1787 /// 1788 /// This function can be called with a null (unreachable) insert point. 1789 void EmitVariablyModifiedType(QualType Ty); 1790 1791 /// getVLASize - Returns an LLVM value that corresponds to the size, 1792 /// in non-variably-sized elements, of a variable length array type, 1793 /// plus that largest non-variably-sized element type. Assumes that 1794 /// the type has already been emitted with EmitVariablyModifiedType. 1795 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla); 1796 std::pair<llvm::Value*,QualType> getVLASize(QualType vla); 1797 1798 /// LoadCXXThis - Load the value of 'this'. This function is only valid while 1799 /// generating code for an C++ member function. 1800 llvm::Value *LoadCXXThis() { 1801 assert(CXXThisValue && "no 'this' value for this function"); 1802 return CXXThisValue; 1803 } 1804 1805 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have 1806 /// virtual bases. 1807 // FIXME: Every place that calls LoadCXXVTT is something 1808 // that needs to be abstracted properly. 1809 llvm::Value *LoadCXXVTT() { 1810 assert(CXXStructorImplicitParamValue && "no VTT value for this function"); 1811 return CXXStructorImplicitParamValue; 1812 } 1813 1814 /// LoadCXXStructorImplicitParam - Load the implicit parameter 1815 /// for a constructor/destructor. 1816 llvm::Value *LoadCXXStructorImplicitParam() { 1817 assert(CXXStructorImplicitParamValue && 1818 "no implicit argument value for this function"); 1819 return CXXStructorImplicitParamValue; 1820 } 1821 1822 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a 1823 /// complete class to the given direct base. 1824 llvm::Value * 1825 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value, 1826 const CXXRecordDecl *Derived, 1827 const CXXRecordDecl *Base, 1828 bool BaseIsVirtual); 1829 1830 /// GetAddressOfBaseClass - This function will add the necessary delta to the 1831 /// load of 'this' and returns address of the base class. 1832 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value, 1833 const CXXRecordDecl *Derived, 1834 CastExpr::path_const_iterator PathBegin, 1835 CastExpr::path_const_iterator PathEnd, 1836 bool NullCheckValue); 1837 1838 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value, 1839 const CXXRecordDecl *Derived, 1840 CastExpr::path_const_iterator PathBegin, 1841 CastExpr::path_const_iterator PathEnd, 1842 bool NullCheckValue); 1843 1844 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This, 1845 const CXXRecordDecl *ClassDecl, 1846 const CXXRecordDecl *BaseClassDecl); 1847 1848 /// GetVTTParameter - Return the VTT parameter that should be passed to a 1849 /// base constructor/destructor with virtual bases. 1850 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move 1851 /// to ItaniumCXXABI.cpp together with all the references to VTT. 1852 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase, 1853 bool Delegating); 1854 1855 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor, 1856 CXXCtorType CtorType, 1857 const FunctionArgList &Args); 1858 // It's important not to confuse this and the previous function. Delegating 1859 // constructors are the C++0x feature. The constructor delegate optimization 1860 // is used to reduce duplication in the base and complete consturctors where 1861 // they are substantially the same. 1862 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor, 1863 const FunctionArgList &Args); 1864 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type, 1865 bool ForVirtualBase, bool Delegating, 1866 llvm::Value *This, 1867 CallExpr::const_arg_iterator ArgBeg, 1868 CallExpr::const_arg_iterator ArgEnd); 1869 1870 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D, 1871 llvm::Value *This, llvm::Value *Src, 1872 CallExpr::const_arg_iterator ArgBeg, 1873 CallExpr::const_arg_iterator ArgEnd); 1874 1875 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D, 1876 const ConstantArrayType *ArrayTy, 1877 llvm::Value *ArrayPtr, 1878 CallExpr::const_arg_iterator ArgBeg, 1879 CallExpr::const_arg_iterator ArgEnd, 1880 bool ZeroInitialization = false); 1881 1882 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D, 1883 llvm::Value *NumElements, 1884 llvm::Value *ArrayPtr, 1885 CallExpr::const_arg_iterator ArgBeg, 1886 CallExpr::const_arg_iterator ArgEnd, 1887 bool ZeroInitialization = false); 1888 1889 static Destroyer destroyCXXObject; 1890 1891 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type, 1892 bool ForVirtualBase, bool Delegating, 1893 llvm::Value *This); 1894 1895 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType, 1896 llvm::Value *NewPtr, llvm::Value *NumElements); 1897 1898 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType, 1899 llvm::Value *Ptr); 1900 1901 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E); 1902 void EmitCXXDeleteExpr(const CXXDeleteExpr *E); 1903 1904 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr, 1905 QualType DeleteTy); 1906 1907 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E); 1908 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE); 1909 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E); 1910 1911 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init); 1912 void EmitStdInitializerListCleanup(llvm::Value *loc, 1913 const InitListExpr *init); 1914 1915 /// \brief Situations in which we might emit a check for the suitability of a 1916 /// pointer or glvalue. 1917 enum TypeCheckKind { 1918 /// Checking the operand of a load. Must be suitably sized and aligned. 1919 TCK_Load, 1920 /// Checking the destination of a store. Must be suitably sized and aligned. 1921 TCK_Store, 1922 /// Checking the bound value in a reference binding. Must be suitably sized 1923 /// and aligned, but is not required to refer to an object (until the 1924 /// reference is used), per core issue 453. 1925 TCK_ReferenceBinding, 1926 /// Checking the object expression in a non-static data member access. Must 1927 /// be an object within its lifetime. 1928 TCK_MemberAccess, 1929 /// Checking the 'this' pointer for a call to a non-static member function. 1930 /// Must be an object within its lifetime. 1931 TCK_MemberCall, 1932 /// Checking the 'this' pointer for a constructor call. 1933 TCK_ConstructorCall, 1934 /// Checking the operand of a static_cast to a derived pointer type. Must be 1935 /// null or an object within its lifetime. 1936 TCK_DowncastPointer, 1937 /// Checking the operand of a static_cast to a derived reference type. Must 1938 /// be an object within its lifetime. 1939 TCK_DowncastReference 1940 }; 1941 1942 /// \brief Emit a check that \p V is the address of storage of the 1943 /// appropriate size and alignment for an object of type \p Type. 1944 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V, 1945 QualType Type, CharUnits Alignment = CharUnits::Zero()); 1946 1947 /// \brief Emit a check that \p Base points into an array object, which 1948 /// we can access at index \p Index. \p Accessed should be \c false if we 1949 /// this expression is used as an lvalue, for instance in "&Arr[Idx]". 1950 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index, 1951 QualType IndexType, bool Accessed); 1952 1953 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV, 1954 bool isInc, bool isPre); 1955 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV, 1956 bool isInc, bool isPre); 1957 //===--------------------------------------------------------------------===// 1958 // Declaration Emission 1959 //===--------------------------------------------------------------------===// 1960 1961 /// EmitDecl - Emit a declaration. 1962 /// 1963 /// This function can be called with a null (unreachable) insert point. 1964 void EmitDecl(const Decl &D); 1965 1966 /// EmitVarDecl - Emit a local variable declaration. 1967 /// 1968 /// This function can be called with a null (unreachable) insert point. 1969 void EmitVarDecl(const VarDecl &D); 1970 1971 void EmitScalarInit(const Expr *init, const ValueDecl *D, 1972 LValue lvalue, bool capturedByInit); 1973 void EmitScalarInit(llvm::Value *init, LValue lvalue); 1974 1975 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D, 1976 llvm::Value *Address); 1977 1978 /// EmitAutoVarDecl - Emit an auto variable declaration. 1979 /// 1980 /// This function can be called with a null (unreachable) insert point. 1981 void EmitAutoVarDecl(const VarDecl &D); 1982 1983 class AutoVarEmission { 1984 friend class CodeGenFunction; 1985 1986 const VarDecl *Variable; 1987 1988 /// The alignment of the variable. 1989 CharUnits Alignment; 1990 1991 /// The address of the alloca. Null if the variable was emitted 1992 /// as a global constant. 1993 llvm::Value *Address; 1994 1995 llvm::Value *NRVOFlag; 1996 1997 /// True if the variable is a __block variable. 1998 bool IsByRef; 1999 2000 /// True if the variable is of aggregate type and has a constant 2001 /// initializer. 2002 bool IsConstantAggregate; 2003 2004 struct Invalid {}; 2005 AutoVarEmission(Invalid) : Variable(0) {} 2006 2007 AutoVarEmission(const VarDecl &variable) 2008 : Variable(&variable), Address(0), NRVOFlag(0), 2009 IsByRef(false), IsConstantAggregate(false) {} 2010 2011 bool wasEmittedAsGlobal() const { return Address == 0; } 2012 2013 public: 2014 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); } 2015 2016 /// Returns the address of the object within this declaration. 2017 /// Note that this does not chase the forwarding pointer for 2018 /// __block decls. 2019 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const { 2020 if (!IsByRef) return Address; 2021 2022 return CGF.Builder.CreateStructGEP(Address, 2023 CGF.getByRefValueLLVMField(Variable), 2024 Variable->getNameAsString()); 2025 } 2026 }; 2027 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var); 2028 void EmitAutoVarInit(const AutoVarEmission &emission); 2029 void EmitAutoVarCleanups(const AutoVarEmission &emission); 2030 void emitAutoVarTypeCleanup(const AutoVarEmission &emission, 2031 QualType::DestructionKind dtorKind); 2032 2033 void EmitStaticVarDecl(const VarDecl &D, 2034 llvm::GlobalValue::LinkageTypes Linkage); 2035 2036 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl. 2037 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo); 2038 2039 /// protectFromPeepholes - Protect a value that we're intending to 2040 /// store to the side, but which will probably be used later, from 2041 /// aggressive peepholing optimizations that might delete it. 2042 /// 2043 /// Pass the result to unprotectFromPeepholes to declare that 2044 /// protection is no longer required. 2045 /// 2046 /// There's no particular reason why this shouldn't apply to 2047 /// l-values, it's just that no existing peepholes work on pointers. 2048 PeepholeProtection protectFromPeepholes(RValue rvalue); 2049 void unprotectFromPeepholes(PeepholeProtection protection); 2050 2051 //===--------------------------------------------------------------------===// 2052 // Statement Emission 2053 //===--------------------------------------------------------------------===// 2054 2055 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info. 2056 void EmitStopPoint(const Stmt *S); 2057 2058 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call 2059 /// this function even if there is no current insertion point. 2060 /// 2061 /// This function may clear the current insertion point; callers should use 2062 /// EnsureInsertPoint if they wish to subsequently generate code without first 2063 /// calling EmitBlock, EmitBranch, or EmitStmt. 2064 void EmitStmt(const Stmt *S); 2065 2066 /// EmitSimpleStmt - Try to emit a "simple" statement which does not 2067 /// necessarily require an insertion point or debug information; typically 2068 /// because the statement amounts to a jump or a container of other 2069 /// statements. 2070 /// 2071 /// \return True if the statement was handled. 2072 bool EmitSimpleStmt(const Stmt *S); 2073 2074 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false, 2075 AggValueSlot AVS = AggValueSlot::ignored()); 2076 RValue EmitCompoundStmtWithoutScope(const CompoundStmt &S, 2077 bool GetLast = false, AggValueSlot AVS = 2078 AggValueSlot::ignored()); 2079 2080 /// EmitLabel - Emit the block for the given label. It is legal to call this 2081 /// function even if there is no current insertion point. 2082 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt. 2083 2084 void EmitLabelStmt(const LabelStmt &S); 2085 void EmitAttributedStmt(const AttributedStmt &S); 2086 void EmitGotoStmt(const GotoStmt &S); 2087 void EmitIndirectGotoStmt(const IndirectGotoStmt &S); 2088 void EmitIfStmt(const IfStmt &S); 2089 void EmitWhileStmt(const WhileStmt &S); 2090 void EmitDoStmt(const DoStmt &S); 2091 void EmitForStmt(const ForStmt &S); 2092 void EmitReturnStmt(const ReturnStmt &S); 2093 void EmitDeclStmt(const DeclStmt &S); 2094 void EmitBreakStmt(const BreakStmt &S); 2095 void EmitContinueStmt(const ContinueStmt &S); 2096 void EmitSwitchStmt(const SwitchStmt &S); 2097 void EmitDefaultStmt(const DefaultStmt &S); 2098 void EmitCaseStmt(const CaseStmt &S); 2099 void EmitCaseStmtRange(const CaseStmt &S); 2100 void EmitAsmStmt(const AsmStmt &S); 2101 2102 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S); 2103 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S); 2104 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S); 2105 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S); 2106 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S); 2107 2108 llvm::Constant *getUnwindResumeFn(); 2109 llvm::Constant *getUnwindResumeOrRethrowFn(); 2110 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false); 2111 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false); 2112 2113 void EmitCXXTryStmt(const CXXTryStmt &S); 2114 void EmitCXXForRangeStmt(const CXXForRangeStmt &S); 2115 2116 //===--------------------------------------------------------------------===// 2117 // LValue Expression Emission 2118 //===--------------------------------------------------------------------===// 2119 2120 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type. 2121 RValue GetUndefRValue(QualType Ty); 2122 2123 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E 2124 /// and issue an ErrorUnsupported style diagnostic (using the 2125 /// provided Name). 2126 RValue EmitUnsupportedRValue(const Expr *E, 2127 const char *Name); 2128 2129 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue 2130 /// an ErrorUnsupported style diagnostic (using the provided Name). 2131 LValue EmitUnsupportedLValue(const Expr *E, 2132 const char *Name); 2133 2134 /// EmitLValue - Emit code to compute a designator that specifies the location 2135 /// of the expression. 2136 /// 2137 /// This can return one of two things: a simple address or a bitfield 2138 /// reference. In either case, the LLVM Value* in the LValue structure is 2139 /// guaranteed to be an LLVM pointer type. 2140 /// 2141 /// If this returns a bitfield reference, nothing about the pointee type of 2142 /// the LLVM value is known: For example, it may not be a pointer to an 2143 /// integer. 2144 /// 2145 /// If this returns a normal address, and if the lvalue's C type is fixed 2146 /// size, this method guarantees that the returned pointer type will point to 2147 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a 2148 /// variable length type, this is not possible. 2149 /// 2150 LValue EmitLValue(const Expr *E); 2151 2152 /// \brief Same as EmitLValue but additionally we generate checking code to 2153 /// guard against undefined behavior. This is only suitable when we know 2154 /// that the address will be used to access the object. 2155 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK); 2156 2157 RValue convertTempToRValue(llvm::Value *addr, QualType type); 2158 2159 void EmitAtomicInit(Expr *E, LValue lvalue); 2160 2161 RValue EmitAtomicLoad(LValue lvalue, 2162 AggValueSlot slot = AggValueSlot::ignored()); 2163 2164 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit); 2165 2166 /// EmitToMemory - Change a scalar value from its value 2167 /// representation to its in-memory representation. 2168 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty); 2169 2170 /// EmitFromMemory - Change a scalar value from its memory 2171 /// representation to its value representation. 2172 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty); 2173 2174 /// EmitLoadOfScalar - Load a scalar value from an address, taking 2175 /// care to appropriately convert from the memory representation to 2176 /// the LLVM value representation. 2177 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile, 2178 unsigned Alignment, QualType Ty, 2179 llvm::MDNode *TBAAInfo = 0); 2180 2181 /// EmitLoadOfScalar - Load a scalar value from an address, taking 2182 /// care to appropriately convert from the memory representation to 2183 /// the LLVM value representation. The l-value must be a simple 2184 /// l-value. 2185 llvm::Value *EmitLoadOfScalar(LValue lvalue); 2186 2187 /// EmitStoreOfScalar - Store a scalar value to an address, taking 2188 /// care to appropriately convert from the memory representation to 2189 /// the LLVM value representation. 2190 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr, 2191 bool Volatile, unsigned Alignment, QualType Ty, 2192 llvm::MDNode *TBAAInfo = 0, bool isInit=false); 2193 2194 /// EmitStoreOfScalar - Store a scalar value to an address, taking 2195 /// care to appropriately convert from the memory representation to 2196 /// the LLVM value representation. The l-value must be a simple 2197 /// l-value. The isInit flag indicates whether this is an initialization. 2198 /// If so, atomic qualifiers are ignored and the store is always non-atomic. 2199 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false); 2200 2201 /// EmitLoadOfLValue - Given an expression that represents a value lvalue, 2202 /// this method emits the address of the lvalue, then loads the result as an 2203 /// rvalue, returning the rvalue. 2204 RValue EmitLoadOfLValue(LValue V); 2205 RValue EmitLoadOfExtVectorElementLValue(LValue V); 2206 RValue EmitLoadOfBitfieldLValue(LValue LV); 2207 2208 /// EmitStoreThroughLValue - Store the specified rvalue into the specified 2209 /// lvalue, where both are guaranteed to the have the same type, and that type 2210 /// is 'Ty'. 2211 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false); 2212 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst); 2213 2214 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as 2215 /// EmitStoreThroughLValue. 2216 /// 2217 /// \param Result [out] - If non-null, this will be set to a Value* for the 2218 /// bit-field contents after the store, appropriate for use as the result of 2219 /// an assignment to the bit-field. 2220 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, 2221 llvm::Value **Result=0); 2222 2223 /// Emit an l-value for an assignment (simple or compound) of complex type. 2224 LValue EmitComplexAssignmentLValue(const BinaryOperator *E); 2225 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E); 2226 2227 // Note: only available for agg return types 2228 LValue EmitBinaryOperatorLValue(const BinaryOperator *E); 2229 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E); 2230 // Note: only available for agg return types 2231 LValue EmitCallExprLValue(const CallExpr *E); 2232 // Note: only available for agg return types 2233 LValue EmitVAArgExprLValue(const VAArgExpr *E); 2234 LValue EmitDeclRefLValue(const DeclRefExpr *E); 2235 LValue EmitStringLiteralLValue(const StringLiteral *E); 2236 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E); 2237 LValue EmitPredefinedLValue(const PredefinedExpr *E); 2238 LValue EmitUnaryOpLValue(const UnaryOperator *E); 2239 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E, 2240 bool Accessed = false); 2241 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E); 2242 LValue EmitMemberExpr(const MemberExpr *E); 2243 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E); 2244 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E); 2245 LValue EmitInitListLValue(const InitListExpr *E); 2246 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E); 2247 LValue EmitCastLValue(const CastExpr *E); 2248 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E); 2249 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E); 2250 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e); 2251 2252 RValue EmitRValueForField(LValue LV, const FieldDecl *FD); 2253 2254 class ConstantEmission { 2255 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference; 2256 ConstantEmission(llvm::Constant *C, bool isReference) 2257 : ValueAndIsReference(C, isReference) {} 2258 public: 2259 ConstantEmission() {} 2260 static ConstantEmission forReference(llvm::Constant *C) { 2261 return ConstantEmission(C, true); 2262 } 2263 static ConstantEmission forValue(llvm::Constant *C) { 2264 return ConstantEmission(C, false); 2265 } 2266 2267 operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; } 2268 2269 bool isReference() const { return ValueAndIsReference.getInt(); } 2270 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const { 2271 assert(isReference()); 2272 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(), 2273 refExpr->getType()); 2274 } 2275 2276 llvm::Constant *getValue() const { 2277 assert(!isReference()); 2278 return ValueAndIsReference.getPointer(); 2279 } 2280 }; 2281 2282 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr); 2283 2284 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e, 2285 AggValueSlot slot = AggValueSlot::ignored()); 2286 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e); 2287 2288 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface, 2289 const ObjCIvarDecl *Ivar); 2290 LValue EmitLValueForField(LValue Base, const FieldDecl* Field); 2291 2292 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that 2293 /// if the Field is a reference, this will return the address of the reference 2294 /// and not the address of the value stored in the reference. 2295 LValue EmitLValueForFieldInitialization(LValue Base, 2296 const FieldDecl* Field); 2297 2298 LValue EmitLValueForIvar(QualType ObjectTy, 2299 llvm::Value* Base, const ObjCIvarDecl *Ivar, 2300 unsigned CVRQualifiers); 2301 2302 LValue EmitCXXConstructLValue(const CXXConstructExpr *E); 2303 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E); 2304 LValue EmitLambdaLValue(const LambdaExpr *E); 2305 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E); 2306 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E); 2307 2308 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E); 2309 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E); 2310 LValue EmitStmtExprLValue(const StmtExpr *E); 2311 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E); 2312 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E); 2313 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init); 2314 2315 //===--------------------------------------------------------------------===// 2316 // Scalar Expression Emission 2317 //===--------------------------------------------------------------------===// 2318 2319 /// EmitCall - Generate a call of the given function, expecting the given 2320 /// result type, and using the given argument list which specifies both the 2321 /// LLVM arguments and the types they were derived from. 2322 /// 2323 /// \param TargetDecl - If given, the decl of the function in a direct call; 2324 /// used to set attributes on the call (noreturn, etc.). 2325 RValue EmitCall(const CGFunctionInfo &FnInfo, 2326 llvm::Value *Callee, 2327 ReturnValueSlot ReturnValue, 2328 const CallArgList &Args, 2329 const Decl *TargetDecl = 0, 2330 llvm::Instruction **callOrInvoke = 0); 2331 2332 RValue EmitCall(QualType FnType, llvm::Value *Callee, 2333 ReturnValueSlot ReturnValue, 2334 CallExpr::const_arg_iterator ArgBeg, 2335 CallExpr::const_arg_iterator ArgEnd, 2336 const Decl *TargetDecl = 0); 2337 RValue EmitCallExpr(const CallExpr *E, 2338 ReturnValueSlot ReturnValue = ReturnValueSlot()); 2339 2340 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee, 2341 const Twine &name = ""); 2342 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee, 2343 ArrayRef<llvm::Value*> args, 2344 const Twine &name = ""); 2345 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee, 2346 const Twine &name = ""); 2347 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee, 2348 ArrayRef<llvm::Value*> args, 2349 const Twine &name = ""); 2350 2351 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee, 2352 ArrayRef<llvm::Value *> Args, 2353 const Twine &Name = ""); 2354 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee, 2355 const Twine &Name = ""); 2356 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee, 2357 ArrayRef<llvm::Value*> args, 2358 const Twine &name = ""); 2359 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee, 2360 const Twine &name = ""); 2361 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee, 2362 ArrayRef<llvm::Value*> args); 2363 2364 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This, 2365 llvm::Type *Ty); 2366 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type, 2367 llvm::Value *This, llvm::Type *Ty); 2368 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD, 2369 NestedNameSpecifier *Qual, 2370 llvm::Type *Ty); 2371 2372 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD, 2373 CXXDtorType Type, 2374 const CXXRecordDecl *RD); 2375 2376 RValue EmitCXXMemberCall(const CXXMethodDecl *MD, 2377 SourceLocation CallLoc, 2378 llvm::Value *Callee, 2379 ReturnValueSlot ReturnValue, 2380 llvm::Value *This, 2381 llvm::Value *ImplicitParam, 2382 QualType ImplicitParamTy, 2383 CallExpr::const_arg_iterator ArgBeg, 2384 CallExpr::const_arg_iterator ArgEnd); 2385 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E, 2386 ReturnValueSlot ReturnValue); 2387 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E, 2388 ReturnValueSlot ReturnValue); 2389 2390 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E, 2391 const CXXMethodDecl *MD, 2392 llvm::Value *This); 2393 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E, 2394 const CXXMethodDecl *MD, 2395 ReturnValueSlot ReturnValue); 2396 2397 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E, 2398 ReturnValueSlot ReturnValue); 2399 2400 2401 RValue EmitBuiltinExpr(const FunctionDecl *FD, 2402 unsigned BuiltinID, const CallExpr *E); 2403 2404 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue); 2405 2406 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call 2407 /// is unhandled by the current target. 2408 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 2409 2410 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 2411 llvm::Value *EmitNeonCall(llvm::Function *F, 2412 SmallVectorImpl<llvm::Value*> &O, 2413 const char *name, 2414 unsigned shift = 0, bool rightshift = false); 2415 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx); 2416 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty, 2417 bool negateForRightShift); 2418 2419 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops); 2420 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E); 2421 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 2422 2423 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E); 2424 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E); 2425 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E); 2426 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E); 2427 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E); 2428 llvm::Value *EmitObjCCollectionLiteral(const Expr *E, 2429 const ObjCMethodDecl *MethodWithObjects); 2430 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E); 2431 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E, 2432 ReturnValueSlot Return = ReturnValueSlot()); 2433 2434 /// Retrieves the default cleanup kind for an ARC cleanup. 2435 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only. 2436 CleanupKind getARCCleanupKind() { 2437 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions 2438 ? NormalAndEHCleanup : NormalCleanup; 2439 } 2440 2441 // ARC primitives. 2442 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr); 2443 void EmitARCDestroyWeak(llvm::Value *addr); 2444 llvm::Value *EmitARCLoadWeak(llvm::Value *addr); 2445 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr); 2446 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr, 2447 bool ignored); 2448 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src); 2449 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src); 2450 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value); 2451 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value); 2452 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value, 2453 bool resultIgnored); 2454 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value, 2455 bool resultIgnored); 2456 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value); 2457 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value); 2458 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory); 2459 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise); 2460 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise); 2461 llvm::Value *EmitARCAutorelease(llvm::Value *value); 2462 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value); 2463 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value); 2464 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value); 2465 2466 std::pair<LValue,llvm::Value*> 2467 EmitARCStoreAutoreleasing(const BinaryOperator *e); 2468 std::pair<LValue,llvm::Value*> 2469 EmitARCStoreStrong(const BinaryOperator *e, bool ignored); 2470 2471 llvm::Value *EmitObjCThrowOperand(const Expr *expr); 2472 2473 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr); 2474 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr); 2475 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr); 2476 2477 llvm::Value *EmitARCExtendBlockObject(const Expr *expr); 2478 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr); 2479 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr); 2480 2481 static Destroyer destroyARCStrongImprecise; 2482 static Destroyer destroyARCStrongPrecise; 2483 static Destroyer destroyARCWeak; 2484 2485 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr); 2486 llvm::Value *EmitObjCAutoreleasePoolPush(); 2487 llvm::Value *EmitObjCMRRAutoreleasePoolPush(); 2488 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr); 2489 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr); 2490 2491 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in 2492 /// expression. Will emit a temporary variable if E is not an LValue. 2493 RValue EmitReferenceBindingToExpr(const Expr* E, 2494 const NamedDecl *InitializedDecl); 2495 2496 //===--------------------------------------------------------------------===// 2497 // Expression Emission 2498 //===--------------------------------------------------------------------===// 2499 2500 // Expressions are broken into three classes: scalar, complex, aggregate. 2501 2502 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM 2503 /// scalar type, returning the result. 2504 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false); 2505 2506 /// EmitScalarConversion - Emit a conversion from the specified type to the 2507 /// specified destination type, both of which are LLVM scalar types. 2508 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy, 2509 QualType DstTy); 2510 2511 /// EmitComplexToScalarConversion - Emit a conversion from the specified 2512 /// complex type to the specified destination type, where the destination type 2513 /// is an LLVM scalar type. 2514 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy, 2515 QualType DstTy); 2516 2517 2518 /// EmitAggExpr - Emit the computation of the specified expression 2519 /// of aggregate type. The result is computed into the given slot, 2520 /// which may be null to indicate that the value is not needed. 2521 void EmitAggExpr(const Expr *E, AggValueSlot AS); 2522 2523 /// EmitAggExprToLValue - Emit the computation of the specified expression of 2524 /// aggregate type into a temporary LValue. 2525 LValue EmitAggExprToLValue(const Expr *E); 2526 2527 /// EmitGCMemmoveCollectable - Emit special API for structs with object 2528 /// pointers. 2529 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr, 2530 QualType Ty); 2531 2532 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object, 2533 /// make sure it survives garbage collection until this point. 2534 void EmitExtendGCLifetime(llvm::Value *object); 2535 2536 /// EmitComplexExpr - Emit the computation of the specified expression of 2537 /// complex type, returning the result. 2538 ComplexPairTy EmitComplexExpr(const Expr *E, 2539 bool IgnoreReal = false, 2540 bool IgnoreImag = false); 2541 2542 /// EmitComplexExprIntoLValue - Emit the given expression of complex 2543 /// type and place its result into the specified l-value. 2544 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit); 2545 2546 /// EmitStoreOfComplex - Store a complex number into the specified l-value. 2547 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit); 2548 2549 /// EmitLoadOfComplex - Load a complex number from the specified l-value. 2550 ComplexPairTy EmitLoadOfComplex(LValue src); 2551 2552 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for 2553 /// a static local variable. 2554 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D, 2555 const char *Separator, 2556 llvm::GlobalValue::LinkageTypes Linkage); 2557 2558 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the 2559 /// global variable that has already been created for it. If the initializer 2560 /// has a different type than GV does, this may free GV and return a different 2561 /// one. Otherwise it just returns GV. 2562 llvm::GlobalVariable * 2563 AddInitializerToStaticVarDecl(const VarDecl &D, 2564 llvm::GlobalVariable *GV); 2565 2566 2567 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++ 2568 /// variable with global storage. 2569 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr, 2570 bool PerformInit); 2571 2572 /// Call atexit() with a function that passes the given argument to 2573 /// the given function. 2574 void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr); 2575 2576 /// Emit code in this function to perform a guarded variable 2577 /// initialization. Guarded initializations are used when it's not 2578 /// possible to prove that an initialization will be done exactly 2579 /// once, e.g. with a static local variable or a static data member 2580 /// of a class template. 2581 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr, 2582 bool PerformInit); 2583 2584 /// GenerateCXXGlobalInitFunc - Generates code for initializing global 2585 /// variables. 2586 void GenerateCXXGlobalInitFunc(llvm::Function *Fn, 2587 llvm::Constant **Decls, 2588 unsigned NumDecls); 2589 2590 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global 2591 /// variables. 2592 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn, 2593 const std::vector<std::pair<llvm::WeakVH, 2594 llvm::Constant*> > &DtorsAndObjects); 2595 2596 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn, 2597 const VarDecl *D, 2598 llvm::GlobalVariable *Addr, 2599 bool PerformInit); 2600 2601 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest); 2602 2603 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src, 2604 const Expr *Exp); 2605 2606 void enterFullExpression(const ExprWithCleanups *E) { 2607 if (E->getNumObjects() == 0) return; 2608 enterNonTrivialFullExpression(E); 2609 } 2610 void enterNonTrivialFullExpression(const ExprWithCleanups *E); 2611 2612 void EmitCXXThrowExpr(const CXXThrowExpr *E); 2613 2614 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest); 2615 2616 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0); 2617 2618 //===--------------------------------------------------------------------===// 2619 // Annotations Emission 2620 //===--------------------------------------------------------------------===// 2621 2622 /// Emit an annotation call (intrinsic or builtin). 2623 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn, 2624 llvm::Value *AnnotatedVal, 2625 StringRef AnnotationStr, 2626 SourceLocation Location); 2627 2628 /// Emit local annotations for the local variable V, declared by D. 2629 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V); 2630 2631 /// Emit field annotations for the given field & value. Returns the 2632 /// annotation result. 2633 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V); 2634 2635 //===--------------------------------------------------------------------===// 2636 // Internal Helpers 2637 //===--------------------------------------------------------------------===// 2638 2639 /// ContainsLabel - Return true if the statement contains a label in it. If 2640 /// this statement is not executed normally, it not containing a label means 2641 /// that we can just remove the code. 2642 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false); 2643 2644 /// containsBreak - Return true if the statement contains a break out of it. 2645 /// If the statement (recursively) contains a switch or loop with a break 2646 /// inside of it, this is fine. 2647 static bool containsBreak(const Stmt *S); 2648 2649 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 2650 /// to a constant, or if it does but contains a label, return false. If it 2651 /// constant folds return true and set the boolean result in Result. 2652 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result); 2653 2654 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 2655 /// to a constant, or if it does but contains a label, return false. If it 2656 /// constant folds return true and set the folded value. 2657 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result); 2658 2659 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an 2660 /// if statement) to the specified blocks. Based on the condition, this might 2661 /// try to simplify the codegen of the conditional based on the branch. 2662 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock, 2663 llvm::BasicBlock *FalseBlock); 2664 2665 /// \brief Emit a description of a type in a format suitable for passing to 2666 /// a runtime sanitizer handler. 2667 llvm::Constant *EmitCheckTypeDescriptor(QualType T); 2668 2669 /// \brief Convert a value into a format suitable for passing to a runtime 2670 /// sanitizer handler. 2671 llvm::Value *EmitCheckValue(llvm::Value *V); 2672 2673 /// \brief Emit a description of a source location in a format suitable for 2674 /// passing to a runtime sanitizer handler. 2675 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc); 2676 2677 /// \brief Specify under what conditions this check can be recovered 2678 enum CheckRecoverableKind { 2679 /// Always terminate program execution if this check fails 2680 CRK_Unrecoverable, 2681 /// Check supports recovering, allows user to specify which 2682 CRK_Recoverable, 2683 /// Runtime conditionally aborts, always need to support recovery. 2684 CRK_AlwaysRecoverable 2685 }; 2686 2687 /// \brief Create a basic block that will call a handler function in a 2688 /// sanitizer runtime with the provided arguments, and create a conditional 2689 /// branch to it. 2690 void EmitCheck(llvm::Value *Checked, StringRef CheckName, 2691 ArrayRef<llvm::Constant *> StaticArgs, 2692 ArrayRef<llvm::Value *> DynamicArgs, 2693 CheckRecoverableKind Recoverable); 2694 2695 /// \brief Create a basic block that will call the trap intrinsic, and emit a 2696 /// conditional branch to it, for the -ftrapv checks. 2697 void EmitTrapCheck(llvm::Value *Checked); 2698 2699 /// EmitCallArg - Emit a single call argument. 2700 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType); 2701 2702 /// EmitDelegateCallArg - We are performing a delegate call; that 2703 /// is, the current function is delegating to another one. Produce 2704 /// a r-value suitable for passing the given parameter. 2705 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param); 2706 2707 /// SetFPAccuracy - Set the minimum required accuracy of the given floating 2708 /// point operation, expressed as the maximum relative error in ulp. 2709 void SetFPAccuracy(llvm::Value *Val, float Accuracy); 2710 2711 private: 2712 llvm::MDNode *getRangeForLoadFromType(QualType Ty); 2713 void EmitReturnOfRValue(RValue RV, QualType Ty); 2714 2715 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty 2716 /// from function arguments into \arg Dst. See ABIArgInfo::Expand. 2717 /// 2718 /// \param AI - The first function argument of the expansion. 2719 /// \return The argument following the last expanded function 2720 /// argument. 2721 llvm::Function::arg_iterator 2722 ExpandTypeFromArgs(QualType Ty, LValue Dst, 2723 llvm::Function::arg_iterator AI); 2724 2725 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg 2726 /// Ty, into individual arguments on the provided vector \arg Args. See 2727 /// ABIArgInfo::Expand. 2728 void ExpandTypeToArgs(QualType Ty, RValue Src, 2729 SmallVector<llvm::Value*, 16> &Args, 2730 llvm::FunctionType *IRFuncTy); 2731 2732 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info, 2733 const Expr *InputExpr, std::string &ConstraintStr); 2734 2735 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info, 2736 LValue InputValue, QualType InputType, 2737 std::string &ConstraintStr); 2738 2739 /// EmitCallArgs - Emit call arguments for a function. 2740 /// The CallArgTypeInfo parameter is used for iterating over the known 2741 /// argument types of the function being called. 2742 template<typename T> 2743 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo, 2744 CallExpr::const_arg_iterator ArgBeg, 2745 CallExpr::const_arg_iterator ArgEnd) { 2746 CallExpr::const_arg_iterator Arg = ArgBeg; 2747 2748 // First, use the argument types that the type info knows about 2749 if (CallArgTypeInfo) { 2750 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(), 2751 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) { 2752 assert(Arg != ArgEnd && "Running over edge of argument list!"); 2753 QualType ArgType = *I; 2754 #ifndef NDEBUG 2755 QualType ActualArgType = Arg->getType(); 2756 if (ArgType->isPointerType() && ActualArgType->isPointerType()) { 2757 QualType ActualBaseType = 2758 ActualArgType->getAs<PointerType>()->getPointeeType(); 2759 QualType ArgBaseType = 2760 ArgType->getAs<PointerType>()->getPointeeType(); 2761 if (ArgBaseType->isVariableArrayType()) { 2762 if (const VariableArrayType *VAT = 2763 getContext().getAsVariableArrayType(ActualBaseType)) { 2764 if (!VAT->getSizeExpr()) 2765 ActualArgType = ArgType; 2766 } 2767 } 2768 } 2769 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()). 2770 getTypePtr() == 2771 getContext().getCanonicalType(ActualArgType).getTypePtr() && 2772 "type mismatch in call argument!"); 2773 #endif 2774 EmitCallArg(Args, *Arg, ArgType); 2775 } 2776 2777 // Either we've emitted all the call args, or we have a call to a 2778 // variadic function. 2779 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) && 2780 "Extra arguments in non-variadic function!"); 2781 2782 } 2783 2784 // If we still have any arguments, emit them using the type of the argument. 2785 for (; Arg != ArgEnd; ++Arg) 2786 EmitCallArg(Args, *Arg, Arg->getType()); 2787 } 2788 2789 const TargetCodeGenInfo &getTargetHooks() const { 2790 return CGM.getTargetCodeGenInfo(); 2791 } 2792 2793 void EmitDeclMetadata(); 2794 2795 CodeGenModule::ByrefHelpers * 2796 buildByrefHelpers(llvm::StructType &byrefType, 2797 const AutoVarEmission &emission); 2798 2799 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst); 2800 2801 /// GetPointeeAlignment - Given an expression with a pointer type, emit the 2802 /// value and compute our best estimate of the alignment of the pointee. 2803 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr); 2804 }; 2805 2806 /// Helper class with most of the code for saving a value for a 2807 /// conditional expression cleanup. 2808 struct DominatingLLVMValue { 2809 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type; 2810 2811 /// Answer whether the given value needs extra work to be saved. 2812 static bool needsSaving(llvm::Value *value) { 2813 // If it's not an instruction, we don't need to save. 2814 if (!isa<llvm::Instruction>(value)) return false; 2815 2816 // If it's an instruction in the entry block, we don't need to save. 2817 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent(); 2818 return (block != &block->getParent()->getEntryBlock()); 2819 } 2820 2821 /// Try to save the given value. 2822 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) { 2823 if (!needsSaving(value)) return saved_type(value, false); 2824 2825 // Otherwise we need an alloca. 2826 llvm::Value *alloca = 2827 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save"); 2828 CGF.Builder.CreateStore(value, alloca); 2829 2830 return saved_type(alloca, true); 2831 } 2832 2833 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) { 2834 if (!value.getInt()) return value.getPointer(); 2835 return CGF.Builder.CreateLoad(value.getPointer()); 2836 } 2837 }; 2838 2839 /// A partial specialization of DominatingValue for llvm::Values that 2840 /// might be llvm::Instructions. 2841 template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue { 2842 typedef T *type; 2843 static type restore(CodeGenFunction &CGF, saved_type value) { 2844 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value)); 2845 } 2846 }; 2847 2848 /// A specialization of DominatingValue for RValue. 2849 template <> struct DominatingValue<RValue> { 2850 typedef RValue type; 2851 class saved_type { 2852 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral, 2853 AggregateAddress, ComplexAddress }; 2854 2855 llvm::Value *Value; 2856 Kind K; 2857 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {} 2858 2859 public: 2860 static bool needsSaving(RValue value); 2861 static saved_type save(CodeGenFunction &CGF, RValue value); 2862 RValue restore(CodeGenFunction &CGF); 2863 2864 // implementations in CGExprCXX.cpp 2865 }; 2866 2867 static bool needsSaving(type value) { 2868 return saved_type::needsSaving(value); 2869 } 2870 static saved_type save(CodeGenFunction &CGF, type value) { 2871 return saved_type::save(CGF, value); 2872 } 2873 static type restore(CodeGenFunction &CGF, saved_type value) { 2874 return value.restore(CGF); 2875 } 2876 }; 2877 2878 } // end namespace CodeGen 2879 } // end namespace clang 2880 2881 #endif 2882