CodeGenFunction.h revision ef66872797e46ced3ffdb428e582bc7f00474f99
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 "clang/AST/Type.h" 18#include "clang/AST/ExprCXX.h" 19#include "clang/AST/ExprObjC.h" 20#include "clang/AST/CharUnits.h" 21#include "clang/Basic/TargetInfo.h" 22#include "llvm/ADT/DenseMap.h" 23#include "llvm/ADT/SmallVector.h" 24#include "llvm/Support/ValueHandle.h" 25#include "CodeGenModule.h" 26#include "CGBlocks.h" 27#include "CGBuilder.h" 28#include "CGCall.h" 29#include "CGCXX.h" 30#include "CGValue.h" 31 32namespace llvm { 33 class BasicBlock; 34 class LLVMContext; 35 class MDNode; 36 class Module; 37 class SwitchInst; 38 class Twine; 39 class Value; 40} 41 42namespace clang { 43 class ASTContext; 44 class CXXDestructorDecl; 45 class CXXTryStmt; 46 class Decl; 47 class EnumConstantDecl; 48 class FunctionDecl; 49 class FunctionProtoType; 50 class LabelStmt; 51 class ObjCContainerDecl; 52 class ObjCInterfaceDecl; 53 class ObjCIvarDecl; 54 class ObjCMethodDecl; 55 class ObjCImplementationDecl; 56 class ObjCPropertyImplDecl; 57 class TargetInfo; 58 class TargetCodeGenInfo; 59 class VarDecl; 60 class ObjCForCollectionStmt; 61 class ObjCAtTryStmt; 62 class ObjCAtThrowStmt; 63 class ObjCAtSynchronizedStmt; 64 65namespace CodeGen { 66 class CodeGenTypes; 67 class CGDebugInfo; 68 class CGFunctionInfo; 69 class CGRecordLayout; 70 class CGBlockInfo; 71 72/// CodeGenFunction - This class organizes the per-function state that is used 73/// while generating LLVM code. 74class CodeGenFunction : public BlockFunction { 75 CodeGenFunction(const CodeGenFunction&); // DO NOT IMPLEMENT 76 void operator=(const CodeGenFunction&); // DO NOT IMPLEMENT 77public: 78 CodeGenModule &CGM; // Per-module state. 79 const TargetInfo &Target; 80 81 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy; 82 CGBuilderTy Builder; 83 84 /// CurFuncDecl - Holds the Decl for the current function or ObjC method. 85 /// This excludes BlockDecls. 86 const Decl *CurFuncDecl; 87 /// CurCodeDecl - This is the inner-most code context, which includes blocks. 88 const Decl *CurCodeDecl; 89 const CGFunctionInfo *CurFnInfo; 90 QualType FnRetTy; 91 llvm::Function *CurFn; 92 93 /// CurGD - The GlobalDecl for the current function being compiled. 94 GlobalDecl CurGD; 95 96 /// ReturnBlock - Unified return block. 97 llvm::BasicBlock *ReturnBlock; 98 /// ReturnValue - The temporary alloca to hold the return value. This is null 99 /// iff the function has no return value. 100 llvm::Value *ReturnValue; 101 102 /// AllocaInsertPoint - This is an instruction in the entry block before which 103 /// we prefer to insert allocas. 104 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt; 105 106 const llvm::Type *LLVMIntTy; 107 uint32_t LLVMPointerWidth; 108 109 bool Exceptions; 110 bool CatchUndefined; 111 112 /// \brief A mapping from NRVO variables to the flags used to indicate 113 /// when the NRVO has been applied to this variable. 114 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags; 115 116public: 117 /// ObjCEHValueStack - Stack of Objective-C exception values, used for 118 /// rethrows. 119 llvm::SmallVector<llvm::Value*, 8> ObjCEHValueStack; 120 121 /// PushCleanupBlock - Push a new cleanup entry on the stack and set the 122 /// passed in block as the cleanup block. 123 void PushCleanupBlock(llvm::BasicBlock *CleanupEntryBlock, 124 llvm::BasicBlock *CleanupExitBlock, 125 llvm::BasicBlock *PreviousInvokeDest, 126 bool EHOnly = false); 127 void PushCleanupBlock(llvm::BasicBlock *CleanupEntryBlock) { 128 PushCleanupBlock(CleanupEntryBlock, 0, getInvokeDest(), false); 129 } 130 131 /// CleanupBlockInfo - A struct representing a popped cleanup block. 132 struct CleanupBlockInfo { 133 /// CleanupEntryBlock - the cleanup entry block 134 llvm::BasicBlock *CleanupBlock; 135 136 /// SwitchBlock - the block (if any) containing the switch instruction used 137 /// for jumping to the final destination. 138 llvm::BasicBlock *SwitchBlock; 139 140 /// EndBlock - the default destination for the switch instruction. 141 llvm::BasicBlock *EndBlock; 142 143 /// EHOnly - True iff this cleanup should only be performed on the 144 /// exceptional edge. 145 bool EHOnly; 146 147 CleanupBlockInfo(llvm::BasicBlock *cb, llvm::BasicBlock *sb, 148 llvm::BasicBlock *eb, bool ehonly = false) 149 : CleanupBlock(cb), SwitchBlock(sb), EndBlock(eb), EHOnly(ehonly) {} 150 }; 151 152 /// EHCleanupBlock - RAII object that will create a cleanup block for the 153 /// exceptional edge and set the insert point to that block. When destroyed, 154 /// it creates the cleanup edge and sets the insert point to the previous 155 /// block. 156 class EHCleanupBlock { 157 CodeGenFunction& CGF; 158 llvm::BasicBlock *PreviousInsertionBlock; 159 llvm::BasicBlock *CleanupHandler; 160 llvm::BasicBlock *PreviousInvokeDest; 161 public: 162 EHCleanupBlock(CodeGenFunction &cgf) 163 : CGF(cgf), 164 PreviousInsertionBlock(CGF.Builder.GetInsertBlock()), 165 CleanupHandler(CGF.createBasicBlock("ehcleanup", CGF.CurFn)), 166 PreviousInvokeDest(CGF.getInvokeDest()) { 167 llvm::BasicBlock *TerminateHandler = CGF.getTerminateHandler(); 168 CGF.Builder.SetInsertPoint(CleanupHandler); 169 CGF.setInvokeDest(TerminateHandler); 170 } 171 ~EHCleanupBlock(); 172 }; 173 174 /// PopCleanupBlock - Will pop the cleanup entry on the stack, process all 175 /// branch fixups and return a block info struct with the switch block and end 176 /// block. This will also reset the invoke handler to the previous value 177 /// from when the cleanup block was created. 178 CleanupBlockInfo PopCleanupBlock(); 179 180 /// DelayedCleanupBlock - RAII object that will create a cleanup block and set 181 /// the insert point to that block. When destructed, it sets the insert point 182 /// to the previous block and pushes a new cleanup entry on the stack. 183 class DelayedCleanupBlock { 184 CodeGenFunction& CGF; 185 llvm::BasicBlock *CurBB; 186 llvm::BasicBlock *CleanupEntryBB; 187 llvm::BasicBlock *CleanupExitBB; 188 llvm::BasicBlock *CurInvokeDest; 189 bool EHOnly; 190 191 public: 192 DelayedCleanupBlock(CodeGenFunction &cgf, bool ehonly = false) 193 : CGF(cgf), CurBB(CGF.Builder.GetInsertBlock()), 194 CleanupEntryBB(CGF.createBasicBlock("cleanup")), 195 CleanupExitBB(0), 196 CurInvokeDest(CGF.getInvokeDest()), 197 EHOnly(ehonly) { 198 CGF.Builder.SetInsertPoint(CleanupEntryBB); 199 } 200 201 llvm::BasicBlock *getCleanupExitBlock() { 202 if (!CleanupExitBB) 203 CleanupExitBB = CGF.createBasicBlock("cleanup.exit"); 204 return CleanupExitBB; 205 } 206 207 ~DelayedCleanupBlock() { 208 CGF.PushCleanupBlock(CleanupEntryBB, CleanupExitBB, CurInvokeDest, 209 EHOnly); 210 // FIXME: This is silly, move this into the builder. 211 if (CurBB) 212 CGF.Builder.SetInsertPoint(CurBB); 213 else 214 CGF.Builder.ClearInsertionPoint(); 215 } 216 }; 217 218 /// \brief Enters a new scope for capturing cleanups, all of which will be 219 /// executed once the scope is exited. 220 class CleanupScope { 221 CodeGenFunction& CGF; 222 size_t CleanupStackDepth; 223 bool OldDidCallStackSave; 224 bool PerformCleanup; 225 226 CleanupScope(const CleanupScope &); // DO NOT IMPLEMENT 227 CleanupScope &operator=(const CleanupScope &); // DO NOT IMPLEMENT 228 229 public: 230 /// \brief Enter a new cleanup scope. 231 explicit CleanupScope(CodeGenFunction &CGF) 232 : CGF(CGF), PerformCleanup(true) 233 { 234 CleanupStackDepth = CGF.CleanupEntries.size(); 235 OldDidCallStackSave = CGF.DidCallStackSave; 236 } 237 238 /// \brief Exit this cleanup scope, emitting any accumulated 239 /// cleanups. 240 ~CleanupScope() { 241 if (PerformCleanup) { 242 CGF.DidCallStackSave = OldDidCallStackSave; 243 CGF.EmitCleanupBlocks(CleanupStackDepth); 244 } 245 } 246 247 /// \brief Determine whether this scope requires any cleanups. 248 bool requiresCleanups() const { 249 return CGF.CleanupEntries.size() > CleanupStackDepth; 250 } 251 252 /// \brief Force the emission of cleanups now, instead of waiting 253 /// until this object is destroyed. 254 void ForceCleanup() { 255 assert(PerformCleanup && "Already forced cleanup"); 256 CGF.DidCallStackSave = OldDidCallStackSave; 257 CGF.EmitCleanupBlocks(CleanupStackDepth); 258 PerformCleanup = false; 259 } 260 }; 261 262 /// CXXTemporariesCleanupScope - Enters a new scope for catching live 263 /// temporaries, all of which will be popped once the scope is exited. 264 class CXXTemporariesCleanupScope { 265 CodeGenFunction &CGF; 266 size_t NumLiveTemporaries; 267 268 // DO NOT IMPLEMENT 269 CXXTemporariesCleanupScope(const CXXTemporariesCleanupScope &); 270 CXXTemporariesCleanupScope &operator=(const CXXTemporariesCleanupScope &); 271 272 public: 273 explicit CXXTemporariesCleanupScope(CodeGenFunction &CGF) 274 : CGF(CGF), NumLiveTemporaries(CGF.LiveTemporaries.size()) { } 275 276 ~CXXTemporariesCleanupScope() { 277 while (CGF.LiveTemporaries.size() > NumLiveTemporaries) 278 CGF.PopCXXTemporary(); 279 } 280 }; 281 282 283 /// EmitCleanupBlocks - Takes the old cleanup stack size and emits the cleanup 284 /// blocks that have been added. 285 void EmitCleanupBlocks(size_t OldCleanupStackSize); 286 287 /// EmitBranchThroughCleanup - Emit a branch from the current insert block 288 /// through the cleanup handling code (if any) and then on to \arg Dest. 289 /// 290 /// FIXME: Maybe this should really be in EmitBranch? Don't we always want 291 /// this behavior for branches? 292 void EmitBranchThroughCleanup(llvm::BasicBlock *Dest); 293 294 /// BeginConditionalBranch - Should be called before a conditional part of an 295 /// expression is emitted. For example, before the RHS of the expression below 296 /// is emitted: 297 /// 298 /// b && f(T()); 299 /// 300 /// This is used to make sure that any temporaries created in the conditional 301 /// branch are only destroyed if the branch is taken. 302 void BeginConditionalBranch() { 303 ++ConditionalBranchLevel; 304 } 305 306 /// EndConditionalBranch - Should be called after a conditional part of an 307 /// expression has been emitted. 308 void EndConditionalBranch() { 309 assert(ConditionalBranchLevel != 0 && 310 "Conditional branch mismatch!"); 311 312 --ConditionalBranchLevel; 313 } 314 315private: 316 CGDebugInfo *DebugInfo; 317 318 /// IndirectBranch - The first time an indirect goto is seen we create a block 319 /// with an indirect branch. Every time we see the address of a label taken, 320 /// we add the label to the indirect goto. Every subsequent indirect goto is 321 /// codegen'd as a jump to the IndirectBranch's basic block. 322 llvm::IndirectBrInst *IndirectBranch; 323 324 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C 325 /// decls. 326 llvm::DenseMap<const Decl*, llvm::Value*> LocalDeclMap; 327 328 /// LabelMap - This keeps track of the LLVM basic block for each C label. 329 llvm::DenseMap<const LabelStmt*, llvm::BasicBlock*> LabelMap; 330 331 // BreakContinueStack - This keeps track of where break and continue 332 // statements should jump to. 333 struct BreakContinue { 334 BreakContinue(llvm::BasicBlock *bb, llvm::BasicBlock *cb) 335 : BreakBlock(bb), ContinueBlock(cb) {} 336 337 llvm::BasicBlock *BreakBlock; 338 llvm::BasicBlock *ContinueBlock; 339 }; 340 llvm::SmallVector<BreakContinue, 8> BreakContinueStack; 341 342 /// SwitchInsn - This is nearest current switch instruction. It is null if if 343 /// current context is not in a switch. 344 llvm::SwitchInst *SwitchInsn; 345 346 /// CaseRangeBlock - This block holds if condition check for last case 347 /// statement range in current switch instruction. 348 llvm::BasicBlock *CaseRangeBlock; 349 350 /// InvokeDest - This is the nearest exception target for calls 351 /// which can unwind, when exceptions are being used. 352 llvm::BasicBlock *InvokeDest; 353 354 // VLASizeMap - This keeps track of the associated size for each VLA type. 355 // We track this by the size expression rather than the type itself because 356 // in certain situations, like a const qualifier applied to an VLA typedef, 357 // multiple VLA types can share the same size expression. 358 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we 359 // enter/leave scopes. 360 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap; 361 362 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid 363 /// calling llvm.stacksave for multiple VLAs in the same scope. 364 bool DidCallStackSave; 365 366 struct CleanupEntry { 367 /// CleanupEntryBlock - The block of code that does the actual cleanup. 368 llvm::BasicBlock *CleanupEntryBlock; 369 370 /// CleanupExitBlock - The cleanup exit block. 371 llvm::BasicBlock *CleanupExitBlock; 372 373 /// Blocks - Basic blocks that were emitted in the current cleanup scope. 374 std::vector<llvm::BasicBlock *> Blocks; 375 376 /// BranchFixups - Branch instructions to basic blocks that haven't been 377 /// inserted into the current function yet. 378 std::vector<llvm::BranchInst *> BranchFixups; 379 380 /// PreviousInvokeDest - The invoke handler from the start of the cleanup 381 /// region. 382 llvm::BasicBlock *PreviousInvokeDest; 383 384 /// EHOnly - Perform this only on the exceptional edge, not the main edge. 385 bool EHOnly; 386 387 explicit CleanupEntry(llvm::BasicBlock *CleanupEntryBlock, 388 llvm::BasicBlock *CleanupExitBlock, 389 llvm::BasicBlock *PreviousInvokeDest, 390 bool ehonly) 391 : CleanupEntryBlock(CleanupEntryBlock), 392 CleanupExitBlock(CleanupExitBlock), 393 PreviousInvokeDest(PreviousInvokeDest), 394 EHOnly(ehonly) {} 395 }; 396 397 /// CleanupEntries - Stack of cleanup entries. 398 llvm::SmallVector<CleanupEntry, 8> CleanupEntries; 399 400 typedef llvm::DenseMap<llvm::BasicBlock*, size_t> BlockScopeMap; 401 402 /// BlockScopes - Map of which "cleanup scope" scope basic blocks have. 403 BlockScopeMap BlockScopes; 404 405 /// CXXThisDecl - When generating code for a C++ member function, 406 /// this will hold the implicit 'this' declaration. 407 ImplicitParamDecl *CXXThisDecl; 408 llvm::Value *CXXThisValue; 409 410 /// CXXVTTDecl - When generating code for a base object constructor or 411 /// base object destructor with virtual bases, this will hold the implicit 412 /// VTT parameter. 413 ImplicitParamDecl *CXXVTTDecl; 414 llvm::Value *CXXVTTValue; 415 416 /// CXXLiveTemporaryInfo - Holds information about a live C++ temporary. 417 struct CXXLiveTemporaryInfo { 418 /// Temporary - The live temporary. 419 const CXXTemporary *Temporary; 420 421 /// ThisPtr - The pointer to the temporary. 422 llvm::Value *ThisPtr; 423 424 /// DtorBlock - The destructor block. 425 llvm::BasicBlock *DtorBlock; 426 427 /// CondPtr - If this is a conditional temporary, this is the pointer to the 428 /// condition variable that states whether the destructor should be called 429 /// or not. 430 llvm::Value *CondPtr; 431 432 CXXLiveTemporaryInfo(const CXXTemporary *temporary, 433 llvm::Value *thisptr, llvm::BasicBlock *dtorblock, 434 llvm::Value *condptr) 435 : Temporary(temporary), ThisPtr(thisptr), DtorBlock(dtorblock), 436 CondPtr(condptr) { } 437 }; 438 439 llvm::SmallVector<CXXLiveTemporaryInfo, 4> LiveTemporaries; 440 441 /// ConditionalBranchLevel - Contains the nesting level of the current 442 /// conditional branch. This is used so that we know if a temporary should be 443 /// destroyed conditionally. 444 unsigned ConditionalBranchLevel; 445 446 447 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM 448 /// type as well as the field number that contains the actual data. 449 llvm::DenseMap<const ValueDecl *, std::pair<const llvm::Type *, 450 unsigned> > ByRefValueInfo; 451 452 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field 453 /// number that holds the value. 454 unsigned getByRefValueLLVMField(const ValueDecl *VD) const; 455 456 llvm::BasicBlock *TerminateHandler; 457 llvm::BasicBlock *TrapBB; 458 459public: 460 CodeGenFunction(CodeGenModule &cgm); 461 462 ASTContext &getContext() const; 463 CGDebugInfo *getDebugInfo() { return DebugInfo; } 464 465 llvm::BasicBlock *getInvokeDest() { return InvokeDest; } 466 void setInvokeDest(llvm::BasicBlock *B) { InvokeDest = B; } 467 468 llvm::LLVMContext &getLLVMContext() { return VMContext; } 469 470 //===--------------------------------------------------------------------===// 471 // Objective-C 472 //===--------------------------------------------------------------------===// 473 474 void GenerateObjCMethod(const ObjCMethodDecl *OMD); 475 476 void StartObjCMethod(const ObjCMethodDecl *MD, 477 const ObjCContainerDecl *CD); 478 479 /// GenerateObjCGetter - Synthesize an Objective-C property getter function. 480 void GenerateObjCGetter(ObjCImplementationDecl *IMP, 481 const ObjCPropertyImplDecl *PID); 482 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP, 483 ObjCMethodDecl *MD, bool ctor); 484 485 /// GenerateObjCSetter - Synthesize an Objective-C property setter function 486 /// for the given property. 487 void GenerateObjCSetter(ObjCImplementationDecl *IMP, 488 const ObjCPropertyImplDecl *PID); 489 bool IndirectObjCSetterArg(const CGFunctionInfo &FI); 490 bool IvarTypeWithAggrGCObjects(QualType Ty); 491 492 //===--------------------------------------------------------------------===// 493 // Block Bits 494 //===--------------------------------------------------------------------===// 495 496 llvm::Value *BuildBlockLiteralTmp(const BlockExpr *); 497 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *, 498 bool BlockHasCopyDispose, 499 CharUnits Size, 500 const llvm::StructType *, 501 std::vector<HelperInfo> *); 502 503 llvm::Function *GenerateBlockFunction(GlobalDecl GD, 504 const BlockExpr *BExpr, 505 CGBlockInfo &Info, 506 const Decl *OuterFuncDecl, 507 llvm::DenseMap<const Decl*, llvm::Value*> ldm); 508 509 llvm::Value *LoadBlockStruct(); 510 511 void AllocateBlockCXXThisPointer(const CXXThisExpr *E); 512 void AllocateBlockDecl(const BlockDeclRefExpr *E); 513 llvm::Value *GetAddrOfBlockDecl(const BlockDeclRefExpr *E) { 514 return GetAddrOfBlockDecl(E->getDecl(), E->isByRef()); 515 } 516 llvm::Value *GetAddrOfBlockDecl(const ValueDecl *D, bool ByRef); 517 const llvm::Type *BuildByRefType(const ValueDecl *D); 518 519 void GenerateCode(GlobalDecl GD, llvm::Function *Fn); 520 void StartFunction(GlobalDecl GD, QualType RetTy, 521 llvm::Function *Fn, 522 const FunctionArgList &Args, 523 SourceLocation StartLoc); 524 525 void EmitConstructorBody(FunctionArgList &Args); 526 void EmitDestructorBody(FunctionArgList &Args); 527 void EmitFunctionBody(FunctionArgList &Args); 528 529 /// EmitReturnBlock - Emit the unified return block, trying to avoid its 530 /// emission when possible. 531 void EmitReturnBlock(); 532 533 /// FinishFunction - Complete IR generation of the current function. It is 534 /// legal to call this function even if there is no current insertion point. 535 void FinishFunction(SourceLocation EndLoc=SourceLocation()); 536 537 /// GenerateThunk - Generate a thunk for the given method. 538 void GenerateThunk(llvm::Function *Fn, GlobalDecl GD, const ThunkInfo &Thunk); 539 540 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type, 541 FunctionArgList &Args); 542 543 /// InitializeVTablePointer - Initialize the vtable pointer of the given 544 /// subobject. 545 /// 546 void InitializeVTablePointer(BaseSubobject Base, 547 const CXXRecordDecl *NearestVBase, 548 uint64_t OffsetFromNearestVBase, 549 llvm::Constant *VTable, 550 const CXXRecordDecl *VTableClass); 551 552 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy; 553 void InitializeVTablePointers(BaseSubobject Base, 554 const CXXRecordDecl *NearestVBase, 555 uint64_t OffsetFromNearestVBase, 556 bool BaseIsNonVirtualPrimaryBase, 557 llvm::Constant *VTable, 558 const CXXRecordDecl *VTableClass, 559 VisitedVirtualBasesSetTy& VBases); 560 561 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl); 562 563 564 /// EmitDtorEpilogue - Emit all code that comes at the end of class's 565 /// destructor. This is to call destructors on members and base classes in 566 /// reverse order of their construction. 567 void EmitDtorEpilogue(const CXXDestructorDecl *Dtor, 568 CXXDtorType Type); 569 570 /// ShouldInstrumentFunction - Return true if the current function should be 571 /// instrumented with __cyg_profile_func_* calls 572 bool ShouldInstrumentFunction(); 573 574 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified 575 /// instrumentation function with the current function and the call site, if 576 /// function instrumentation is enabled. 577 void EmitFunctionInstrumentation(const char *Fn); 578 579 /// EmitFunctionProlog - Emit the target specific LLVM code to load the 580 /// arguments for the given function. This is also responsible for naming the 581 /// LLVM function arguments. 582 void EmitFunctionProlog(const CGFunctionInfo &FI, 583 llvm::Function *Fn, 584 const FunctionArgList &Args); 585 586 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the 587 /// given temporary. 588 void EmitFunctionEpilog(const CGFunctionInfo &FI, llvm::Value *ReturnValue); 589 590 /// EmitStartEHSpec - Emit the start of the exception spec. 591 void EmitStartEHSpec(const Decl *D); 592 593 /// EmitEndEHSpec - Emit the end of the exception spec. 594 void EmitEndEHSpec(const Decl *D); 595 596 /// getTerminateHandler - Return a handler that just calls terminate. 597 llvm::BasicBlock *getTerminateHandler(); 598 599 const llvm::Type *ConvertTypeForMem(QualType T); 600 const llvm::Type *ConvertType(QualType T); 601 const llvm::Type *ConvertType(const TypeDecl *T) { 602 return ConvertType(getContext().getTypeDeclType(T)); 603 } 604 605 /// LoadObjCSelf - Load the value of self. This function is only valid while 606 /// generating code for an Objective-C method. 607 llvm::Value *LoadObjCSelf(); 608 609 /// TypeOfSelfObject - Return type of object that this self represents. 610 QualType TypeOfSelfObject(); 611 612 /// hasAggregateLLVMType - Return true if the specified AST type will map into 613 /// an aggregate LLVM type or is void. 614 static bool hasAggregateLLVMType(QualType T); 615 616 /// createBasicBlock - Create an LLVM basic block. 617 llvm::BasicBlock *createBasicBlock(const char *Name="", 618 llvm::Function *Parent=0, 619 llvm::BasicBlock *InsertBefore=0) { 620#ifdef NDEBUG 621 return llvm::BasicBlock::Create(VMContext, "", Parent, InsertBefore); 622#else 623 return llvm::BasicBlock::Create(VMContext, Name, Parent, InsertBefore); 624#endif 625 } 626 627 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified 628 /// label maps to. 629 llvm::BasicBlock *getBasicBlockForLabel(const LabelStmt *S); 630 631 /// SimplifyForwardingBlocks - If the given basic block is only a branch to 632 /// another basic block, simplify it. This assumes that no other code could 633 /// potentially reference the basic block. 634 void SimplifyForwardingBlocks(llvm::BasicBlock *BB); 635 636 /// EmitBlock - Emit the given block \arg BB and set it as the insert point, 637 /// adding a fall-through branch from the current insert block if 638 /// necessary. It is legal to call this function even if there is no current 639 /// insertion point. 640 /// 641 /// IsFinished - If true, indicates that the caller has finished emitting 642 /// branches to the given block and does not expect to emit code into it. This 643 /// means the block can be ignored if it is unreachable. 644 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false); 645 646 /// EmitBranch - Emit a branch to the specified basic block from the current 647 /// insert block, taking care to avoid creation of branches from dummy 648 /// blocks. It is legal to call this function even if there is no current 649 /// insertion point. 650 /// 651 /// This function clears the current insertion point. The caller should follow 652 /// calls to this function with calls to Emit*Block prior to generation new 653 /// code. 654 void EmitBranch(llvm::BasicBlock *Block); 655 656 /// HaveInsertPoint - True if an insertion point is defined. If not, this 657 /// indicates that the current code being emitted is unreachable. 658 bool HaveInsertPoint() const { 659 return Builder.GetInsertBlock() != 0; 660 } 661 662 /// EnsureInsertPoint - Ensure that an insertion point is defined so that 663 /// emitted IR has a place to go. Note that by definition, if this function 664 /// creates a block then that block is unreachable; callers may do better to 665 /// detect when no insertion point is defined and simply skip IR generation. 666 void EnsureInsertPoint() { 667 if (!HaveInsertPoint()) 668 EmitBlock(createBasicBlock()); 669 } 670 671 /// ErrorUnsupported - Print out an error that codegen doesn't support the 672 /// specified stmt yet. 673 void ErrorUnsupported(const Stmt *S, const char *Type, 674 bool OmitOnError=false); 675 676 //===--------------------------------------------------------------------===// 677 // Helpers 678 //===--------------------------------------------------------------------===// 679 680 Qualifiers MakeQualifiers(QualType T) { 681 Qualifiers Quals = getContext().getCanonicalType(T).getQualifiers(); 682 Quals.setObjCGCAttr(getContext().getObjCGCAttrKind(T)); 683 return Quals; 684 } 685 686 /// CreateTempAlloca - This creates a alloca and inserts it into the entry 687 /// block. The caller is responsible for setting an appropriate alignment on 688 /// the alloca. 689 llvm::AllocaInst *CreateTempAlloca(const llvm::Type *Ty, 690 const llvm::Twine &Name = "tmp"); 691 692 /// InitTempAlloca - Provide an initial value for the given alloca. 693 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value); 694 695 /// CreateIRTemp - Create a temporary IR object of the given type, with 696 /// appropriate alignment. This routine should only be used when an temporary 697 /// value needs to be stored into an alloca (for example, to avoid explicit 698 /// PHI construction), but the type is the IR type, not the type appropriate 699 /// for storing in memory. 700 llvm::Value *CreateIRTemp(QualType T, const llvm::Twine &Name = "tmp"); 701 702 /// CreateMemTemp - Create a temporary memory object of the given type, with 703 /// appropriate alignment. 704 llvm::Value *CreateMemTemp(QualType T, const llvm::Twine &Name = "tmp"); 705 706 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified 707 /// expression and compare the result against zero, returning an Int1Ty value. 708 llvm::Value *EvaluateExprAsBool(const Expr *E); 709 710 /// EmitAnyExpr - Emit code to compute the specified expression which can have 711 /// any type. The result is returned as an RValue struct. If this is an 712 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where 713 /// the result should be returned. 714 /// 715 /// \param IgnoreResult - True if the resulting value isn't used. 716 RValue EmitAnyExpr(const Expr *E, llvm::Value *AggLoc = 0, 717 bool IsAggLocVolatile = false, bool IgnoreResult = false, 718 bool IsInitializer = false); 719 720 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address 721 // or the value of the expression, depending on how va_list is defined. 722 llvm::Value *EmitVAListRef(const Expr *E); 723 724 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will 725 /// always be accessible even if no aggregate location is provided. 726 RValue EmitAnyExprToTemp(const Expr *E, bool IsAggLocVolatile = false, 727 bool IsInitializer = false); 728 729 /// EmitsAnyExprToMem - Emits the code necessary to evaluate an 730 /// arbitrary expression into the given memory location. 731 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location, 732 bool IsLocationVolatile = false, 733 bool IsInitializer = false); 734 735 /// EmitAggregateCopy - Emit an aggrate copy. 736 /// 737 /// \param isVolatile - True iff either the source or the destination is 738 /// volatile. 739 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr, 740 QualType EltTy, bool isVolatile=false); 741 742 /// StartBlock - Start new block named N. If insert block is a dummy block 743 /// then reuse it. 744 void StartBlock(const char *N); 745 746 /// GetAddrOfStaticLocalVar - Return the address of a static local variable. 747 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD); 748 749 /// GetAddrOfLocalVar - Return the address of a local variable. 750 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD); 751 752 /// getAccessedFieldNo - Given an encoded value and a result number, return 753 /// the input field number being accessed. 754 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts); 755 756 llvm::BlockAddress *GetAddrOfLabel(const LabelStmt *L); 757 llvm::BasicBlock *GetIndirectGotoBlock(); 758 759 /// EmitNullInitialization - Generate code to set a value of the given type to 760 /// null, If the type contains data member pointers, they will be initialized 761 /// to -1 in accordance with the Itanium C++ ABI. 762 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty); 763 764 // EmitVAArg - Generate code to get an argument from the passed in pointer 765 // and update it accordingly. The return value is a pointer to the argument. 766 // FIXME: We should be able to get rid of this method and use the va_arg 767 // instruction in LLVM instead once it works well enough. 768 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty); 769 770 /// EmitVLASize - Generate code for any VLA size expressions that might occur 771 /// in a variably modified type. If Ty is a VLA, will return the value that 772 /// corresponds to the size in bytes of the VLA type. Will return 0 otherwise. 773 /// 774 /// This function can be called with a null (unreachable) insert point. 775 llvm::Value *EmitVLASize(QualType Ty); 776 777 // GetVLASize - Returns an LLVM value that corresponds to the size in bytes 778 // of a variable length array type. 779 llvm::Value *GetVLASize(const VariableArrayType *); 780 781 /// LoadCXXThis - Load the value of 'this'. This function is only valid while 782 /// generating code for an C++ member function. 783 llvm::Value *LoadCXXThis() { 784 assert(CXXThisValue && "no 'this' value for this function"); 785 return CXXThisValue; 786 } 787 788 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have 789 /// virtual bases. 790 llvm::Value *LoadCXXVTT() { 791 assert(CXXVTTValue && "no VTT value for this function"); 792 return CXXVTTValue; 793 } 794 795 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a 796 /// complete class to the given direct base. 797 llvm::Value * 798 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value, 799 const CXXRecordDecl *Derived, 800 const CXXRecordDecl *Base, 801 bool BaseIsVirtual); 802 803 /// GetAddressOfBaseClass - This function will add the necessary delta to the 804 /// load of 'this' and returns address of the base class. 805 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value, 806 const CXXRecordDecl *Derived, 807 const CXXBaseSpecifierArray &BasePath, 808 bool NullCheckValue); 809 810 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value, 811 const CXXRecordDecl *Derived, 812 const CXXBaseSpecifierArray &BasePath, 813 bool NullCheckValue); 814 815 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This, 816 const CXXRecordDecl *ClassDecl, 817 const CXXRecordDecl *BaseClassDecl); 818 819 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor, 820 CXXCtorType CtorType, 821 const FunctionArgList &Args); 822 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type, 823 bool ForVirtualBase, llvm::Value *This, 824 CallExpr::const_arg_iterator ArgBeg, 825 CallExpr::const_arg_iterator ArgEnd); 826 827 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D, 828 const ConstantArrayType *ArrayTy, 829 llvm::Value *ArrayPtr, 830 CallExpr::const_arg_iterator ArgBeg, 831 CallExpr::const_arg_iterator ArgEnd); 832 833 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D, 834 llvm::Value *NumElements, 835 llvm::Value *ArrayPtr, 836 CallExpr::const_arg_iterator ArgBeg, 837 CallExpr::const_arg_iterator ArgEnd); 838 839 void EmitCXXAggrDestructorCall(const CXXDestructorDecl *D, 840 const ArrayType *Array, 841 llvm::Value *This); 842 843 void EmitCXXAggrDestructorCall(const CXXDestructorDecl *D, 844 llvm::Value *NumElements, 845 llvm::Value *This); 846 847 llvm::Function *GenerateCXXAggrDestructorHelper(const CXXDestructorDecl *D, 848 const ArrayType *Array, 849 llvm::Value *This); 850 851 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type, 852 bool ForVirtualBase, llvm::Value *This); 853 854 void EmitNewArrayInitializer(const CXXNewExpr *E, llvm::Value *NewPtr, 855 llvm::Value *NumElements); 856 857 void PushCXXTemporary(const CXXTemporary *Temporary, llvm::Value *Ptr); 858 void PopCXXTemporary(); 859 860 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E); 861 void EmitCXXDeleteExpr(const CXXDeleteExpr *E); 862 863 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr, 864 QualType DeleteTy); 865 866 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E); 867 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE); 868 869 void EmitCheck(llvm::Value *, unsigned Size); 870 871 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV, 872 bool isInc, bool isPre); 873 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV, 874 bool isInc, bool isPre); 875 //===--------------------------------------------------------------------===// 876 // Declaration Emission 877 //===--------------------------------------------------------------------===// 878 879 /// EmitDecl - Emit a declaration. 880 /// 881 /// This function can be called with a null (unreachable) insert point. 882 void EmitDecl(const Decl &D); 883 884 /// EmitBlockVarDecl - Emit a block variable declaration. 885 /// 886 /// This function can be called with a null (unreachable) insert point. 887 void EmitBlockVarDecl(const VarDecl &D); 888 889 /// EmitLocalBlockVarDecl - Emit a local block variable declaration. 890 /// 891 /// This function can be called with a null (unreachable) insert point. 892 void EmitLocalBlockVarDecl(const VarDecl &D); 893 894 void EmitStaticBlockVarDecl(const VarDecl &D, 895 llvm::GlobalValue::LinkageTypes Linkage); 896 897 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl. 898 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg); 899 900 //===--------------------------------------------------------------------===// 901 // Statement Emission 902 //===--------------------------------------------------------------------===// 903 904 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info. 905 void EmitStopPoint(const Stmt *S); 906 907 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call 908 /// this function even if there is no current insertion point. 909 /// 910 /// This function may clear the current insertion point; callers should use 911 /// EnsureInsertPoint if they wish to subsequently generate code without first 912 /// calling EmitBlock, EmitBranch, or EmitStmt. 913 void EmitStmt(const Stmt *S); 914 915 /// EmitSimpleStmt - Try to emit a "simple" statement which does not 916 /// necessarily require an insertion point or debug information; typically 917 /// because the statement amounts to a jump or a container of other 918 /// statements. 919 /// 920 /// \return True if the statement was handled. 921 bool EmitSimpleStmt(const Stmt *S); 922 923 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false, 924 llvm::Value *AggLoc = 0, bool isAggVol = false); 925 926 /// EmitLabel - Emit the block for the given label. It is legal to call this 927 /// function even if there is no current insertion point. 928 void EmitLabel(const LabelStmt &S); // helper for EmitLabelStmt. 929 930 void EmitLabelStmt(const LabelStmt &S); 931 void EmitGotoStmt(const GotoStmt &S); 932 void EmitIndirectGotoStmt(const IndirectGotoStmt &S); 933 void EmitIfStmt(const IfStmt &S); 934 void EmitWhileStmt(const WhileStmt &S); 935 void EmitDoStmt(const DoStmt &S); 936 void EmitForStmt(const ForStmt &S); 937 void EmitReturnStmt(const ReturnStmt &S); 938 void EmitDeclStmt(const DeclStmt &S); 939 void EmitBreakStmt(const BreakStmt &S); 940 void EmitContinueStmt(const ContinueStmt &S); 941 void EmitSwitchStmt(const SwitchStmt &S); 942 void EmitDefaultStmt(const DefaultStmt &S); 943 void EmitCaseStmt(const CaseStmt &S); 944 void EmitCaseStmtRange(const CaseStmt &S); 945 void EmitAsmStmt(const AsmStmt &S); 946 947 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S); 948 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S); 949 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S); 950 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S); 951 952 llvm::Constant *getUnwindResumeOrRethrowFn(); 953 struct CXXTryStmtInfo { 954 llvm::BasicBlock *SavedLandingPad; 955 llvm::BasicBlock *HandlerBlock; 956 llvm::BasicBlock *FinallyBlock; 957 }; 958 CXXTryStmtInfo EnterCXXTryStmt(const CXXTryStmt &S); 959 void ExitCXXTryStmt(const CXXTryStmt &S, CXXTryStmtInfo Info); 960 961 void EmitCXXTryStmt(const CXXTryStmt &S); 962 963 //===--------------------------------------------------------------------===// 964 // LValue Expression Emission 965 //===--------------------------------------------------------------------===// 966 967 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type. 968 RValue GetUndefRValue(QualType Ty); 969 970 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E 971 /// and issue an ErrorUnsupported style diagnostic (using the 972 /// provided Name). 973 RValue EmitUnsupportedRValue(const Expr *E, 974 const char *Name); 975 976 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue 977 /// an ErrorUnsupported style diagnostic (using the provided Name). 978 LValue EmitUnsupportedLValue(const Expr *E, 979 const char *Name); 980 981 /// EmitLValue - Emit code to compute a designator that specifies the location 982 /// of the expression. 983 /// 984 /// This can return one of two things: a simple address or a bitfield 985 /// reference. In either case, the LLVM Value* in the LValue structure is 986 /// guaranteed to be an LLVM pointer type. 987 /// 988 /// If this returns a bitfield reference, nothing about the pointee type of 989 /// the LLVM value is known: For example, it may not be a pointer to an 990 /// integer. 991 /// 992 /// If this returns a normal address, and if the lvalue's C type is fixed 993 /// size, this method guarantees that the returned pointer type will point to 994 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a 995 /// variable length type, this is not possible. 996 /// 997 LValue EmitLValue(const Expr *E); 998 999 /// EmitCheckedLValue - Same as EmitLValue but additionally we generate 1000 /// checking code to guard against undefined behavior. This is only 1001 /// suitable when we know that the address will be used to access the 1002 /// object. 1003 LValue EmitCheckedLValue(const Expr *E); 1004 1005 /// EmitLoadOfScalar - Load a scalar value from an address, taking 1006 /// care to appropriately convert from the memory representation to 1007 /// the LLVM value representation. 1008 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile, 1009 QualType Ty); 1010 1011 /// EmitStoreOfScalar - Store a scalar value to an address, taking 1012 /// care to appropriately convert from the memory representation to 1013 /// the LLVM value representation. 1014 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr, 1015 bool Volatile, QualType Ty); 1016 1017 /// EmitLoadOfLValue - Given an expression that represents a value lvalue, 1018 /// this method emits the address of the lvalue, then loads the result as an 1019 /// rvalue, returning the rvalue. 1020 RValue EmitLoadOfLValue(LValue V, QualType LVType); 1021 RValue EmitLoadOfExtVectorElementLValue(LValue V, QualType LVType); 1022 RValue EmitLoadOfBitfieldLValue(LValue LV, QualType ExprType); 1023 RValue EmitLoadOfPropertyRefLValue(LValue LV, QualType ExprType); 1024 RValue EmitLoadOfKVCRefLValue(LValue LV, QualType ExprType); 1025 1026 1027 /// EmitStoreThroughLValue - Store the specified rvalue into the specified 1028 /// lvalue, where both are guaranteed to the have the same type, and that type 1029 /// is 'Ty'. 1030 void EmitStoreThroughLValue(RValue Src, LValue Dst, QualType Ty); 1031 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst, 1032 QualType Ty); 1033 void EmitStoreThroughPropertyRefLValue(RValue Src, LValue Dst, QualType Ty); 1034 void EmitStoreThroughKVCRefLValue(RValue Src, LValue Dst, QualType Ty); 1035 1036 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as 1037 /// EmitStoreThroughLValue. 1038 /// 1039 /// \param Result [out] - If non-null, this will be set to a Value* for the 1040 /// bit-field contents after the store, appropriate for use as the result of 1041 /// an assignment to the bit-field. 1042 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, QualType Ty, 1043 llvm::Value **Result=0); 1044 1045 // Note: only availabe for agg return types 1046 LValue EmitBinaryOperatorLValue(const BinaryOperator *E); 1047 LValue EmitCompoundAssignOperatorLValue(const CompoundAssignOperator *E); 1048 // Note: only available for agg return types 1049 LValue EmitCallExprLValue(const CallExpr *E); 1050 // Note: only available for agg return types 1051 LValue EmitVAArgExprLValue(const VAArgExpr *E); 1052 LValue EmitDeclRefLValue(const DeclRefExpr *E); 1053 LValue EmitStringLiteralLValue(const StringLiteral *E); 1054 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E); 1055 LValue EmitPredefinedFunctionName(unsigned Type); 1056 LValue EmitPredefinedLValue(const PredefinedExpr *E); 1057 LValue EmitUnaryOpLValue(const UnaryOperator *E); 1058 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E); 1059 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E); 1060 LValue EmitMemberExpr(const MemberExpr *E); 1061 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E); 1062 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E); 1063 LValue EmitConditionalOperatorLValue(const ConditionalOperator *E); 1064 LValue EmitCastLValue(const CastExpr *E); 1065 LValue EmitNullInitializationLValue(const CXXZeroInitValueExpr *E); 1066 1067 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface, 1068 const ObjCIvarDecl *Ivar); 1069 LValue EmitLValueForAnonRecordField(llvm::Value* Base, 1070 const FieldDecl* Field, 1071 unsigned CVRQualifiers); 1072 LValue EmitLValueForField(llvm::Value* Base, const FieldDecl* Field, 1073 unsigned CVRQualifiers); 1074 1075 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that 1076 /// if the Field is a reference, this will return the address of the reference 1077 /// and not the address of the value stored in the reference. 1078 LValue EmitLValueForFieldInitialization(llvm::Value* Base, 1079 const FieldDecl* Field, 1080 unsigned CVRQualifiers); 1081 1082 LValue EmitLValueForIvar(QualType ObjectTy, 1083 llvm::Value* Base, const ObjCIvarDecl *Ivar, 1084 unsigned CVRQualifiers); 1085 1086 LValue EmitLValueForBitfield(llvm::Value* Base, const FieldDecl* Field, 1087 unsigned CVRQualifiers); 1088 1089 LValue EmitBlockDeclRefLValue(const BlockDeclRefExpr *E); 1090 1091 LValue EmitCXXConstructLValue(const CXXConstructExpr *E); 1092 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E); 1093 LValue EmitCXXExprWithTemporariesLValue(const CXXExprWithTemporaries *E); 1094 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E); 1095 1096 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E); 1097 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E); 1098 LValue EmitObjCPropertyRefLValue(const ObjCPropertyRefExpr *E); 1099 LValue EmitObjCKVCRefLValue(const ObjCImplicitSetterGetterRefExpr *E); 1100 LValue EmitObjCSuperExprLValue(const ObjCSuperExpr *E); 1101 LValue EmitStmtExprLValue(const StmtExpr *E); 1102 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E); 1103 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E); 1104 1105 //===--------------------------------------------------------------------===// 1106 // Scalar Expression Emission 1107 //===--------------------------------------------------------------------===// 1108 1109 /// EmitCall - Generate a call of the given function, expecting the given 1110 /// result type, and using the given argument list which specifies both the 1111 /// LLVM arguments and the types they were derived from. 1112 /// 1113 /// \param TargetDecl - If given, the decl of the function in a direct call; 1114 /// used to set attributes on the call (noreturn, etc.). 1115 RValue EmitCall(const CGFunctionInfo &FnInfo, 1116 llvm::Value *Callee, 1117 ReturnValueSlot ReturnValue, 1118 const CallArgList &Args, 1119 const Decl *TargetDecl = 0, 1120 llvm::Instruction **callOrInvoke = 0); 1121 1122 RValue EmitCall(QualType FnType, llvm::Value *Callee, 1123 ReturnValueSlot ReturnValue, 1124 CallExpr::const_arg_iterator ArgBeg, 1125 CallExpr::const_arg_iterator ArgEnd, 1126 const Decl *TargetDecl = 0); 1127 RValue EmitCallExpr(const CallExpr *E, 1128 ReturnValueSlot ReturnValue = ReturnValueSlot()); 1129 1130 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This, 1131 const llvm::Type *Ty); 1132 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type, 1133 llvm::Value *&This, const llvm::Type *Ty); 1134 1135 RValue EmitCXXMemberCall(const CXXMethodDecl *MD, 1136 llvm::Value *Callee, 1137 ReturnValueSlot ReturnValue, 1138 llvm::Value *This, 1139 llvm::Value *VTT, 1140 CallExpr::const_arg_iterator ArgBeg, 1141 CallExpr::const_arg_iterator ArgEnd); 1142 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E, 1143 ReturnValueSlot ReturnValue); 1144 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E, 1145 ReturnValueSlot ReturnValue); 1146 1147 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E, 1148 const CXXMethodDecl *MD, 1149 ReturnValueSlot ReturnValue); 1150 1151 1152 RValue EmitBuiltinExpr(const FunctionDecl *FD, 1153 unsigned BuiltinID, const CallExpr *E); 1154 1155 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue); 1156 1157 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call 1158 /// is unhandled by the current target. 1159 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 1160 1161 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 1162 llvm::Value *EmitNeonCall(llvm::Function *F, 1163 llvm::SmallVectorImpl<llvm::Value*> &O, 1164 const char *name, bool splat = false, 1165 unsigned shift = 0, bool rightshift = false); 1166 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx); 1167 llvm::Value *EmitNeonShiftVector(llvm::Value *V, const llvm::Type *Ty, 1168 bool negateForRightShift); 1169 1170 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E); 1171 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E); 1172 1173 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E); 1174 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E); 1175 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E); 1176 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E, 1177 ReturnValueSlot Return = ReturnValueSlot()); 1178 RValue EmitObjCPropertyGet(const Expr *E, 1179 ReturnValueSlot Return = ReturnValueSlot()); 1180 RValue EmitObjCSuperPropertyGet(const Expr *Exp, const Selector &S, 1181 ReturnValueSlot Return = ReturnValueSlot()); 1182 void EmitObjCPropertySet(const Expr *E, RValue Src); 1183 void EmitObjCSuperPropertySet(const Expr *E, const Selector &S, RValue Src); 1184 1185 1186 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in 1187 /// expression. Will emit a temporary variable if E is not an LValue. 1188 RValue EmitReferenceBindingToExpr(const Expr* E, bool IsInitializer = false); 1189 1190 //===--------------------------------------------------------------------===// 1191 // Expression Emission 1192 //===--------------------------------------------------------------------===// 1193 1194 // Expressions are broken into three classes: scalar, complex, aggregate. 1195 1196 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM 1197 /// scalar type, returning the result. 1198 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false); 1199 1200 /// EmitScalarConversion - Emit a conversion from the specified type to the 1201 /// specified destination type, both of which are LLVM scalar types. 1202 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy, 1203 QualType DstTy); 1204 1205 /// EmitComplexToScalarConversion - Emit a conversion from the specified 1206 /// complex type to the specified destination type, where the destination type 1207 /// is an LLVM scalar type. 1208 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy, 1209 QualType DstTy); 1210 1211 1212 /// EmitAggExpr - Emit the computation of the specified expression of 1213 /// aggregate type. The result is computed into DestPtr. Note that if 1214 /// DestPtr is null, the value of the aggregate expression is not needed. 1215 void EmitAggExpr(const Expr *E, llvm::Value *DestPtr, bool VolatileDest, 1216 bool IgnoreResult = false, bool IsInitializer = false, 1217 bool RequiresGCollection = false); 1218 1219 /// EmitAggExprToLValue - Emit the computation of the specified expression of 1220 /// aggregate type into a temporary LValue. 1221 LValue EmitAggExprToLValue(const Expr *E); 1222 1223 /// EmitGCMemmoveCollectable - Emit special API for structs with object 1224 /// pointers. 1225 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr, 1226 QualType Ty); 1227 1228 /// EmitComplexExpr - Emit the computation of the specified expression of 1229 /// complex type, returning the result. 1230 ComplexPairTy EmitComplexExpr(const Expr *E, bool IgnoreReal = false, 1231 bool IgnoreImag = false, 1232 bool IgnoreRealAssign = false, 1233 bool IgnoreImagAssign = false); 1234 1235 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression 1236 /// of complex type, storing into the specified Value*. 1237 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr, 1238 bool DestIsVolatile); 1239 1240 /// StoreComplexToAddr - Store a complex number into the specified address. 1241 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr, 1242 bool DestIsVolatile); 1243 /// LoadComplexFromAddr - Load a complex number from the specified address. 1244 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile); 1245 1246 /// CreateStaticBlockVarDecl - Create a zero-initialized LLVM global for a 1247 /// static block var decl. 1248 llvm::GlobalVariable *CreateStaticBlockVarDecl(const VarDecl &D, 1249 const char *Separator, 1250 llvm::GlobalValue::LinkageTypes Linkage); 1251 1252 /// AddInitializerToGlobalBlockVarDecl - Add the initializer for 'D' to the 1253 /// global variable that has already been created for it. If the initializer 1254 /// has a different type than GV does, this may free GV and return a different 1255 /// one. Otherwise it just returns GV. 1256 llvm::GlobalVariable * 1257 AddInitializerToGlobalBlockVarDecl(const VarDecl &D, 1258 llvm::GlobalVariable *GV); 1259 1260 1261 /// EmitStaticCXXBlockVarDeclInit - Create the initializer for a C++ runtime 1262 /// initialized static block var decl. 1263 void EmitStaticCXXBlockVarDeclInit(const VarDecl &D, 1264 llvm::GlobalVariable *GV); 1265 1266 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++ 1267 /// variable with global storage. 1268 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr); 1269 1270 /// EmitCXXGlobalDtorRegistration - Emits a call to register the global ptr 1271 /// with the C++ runtime so that its destructor will be called at exit. 1272 void EmitCXXGlobalDtorRegistration(llvm::Constant *DtorFn, 1273 llvm::Constant *DeclPtr); 1274 1275 /// GenerateCXXGlobalInitFunc - Generates code for initializing global 1276 /// variables. 1277 void GenerateCXXGlobalInitFunc(llvm::Function *Fn, 1278 llvm::Constant **Decls, 1279 unsigned NumDecls); 1280 1281 /// GenerateCXXGlobalDtorFunc - Generates code for destroying global 1282 /// variables. 1283 void GenerateCXXGlobalDtorFunc(llvm::Function *Fn, 1284 const std::vector<std::pair<llvm::WeakVH, 1285 llvm::Constant*> > &DtorsAndObjects); 1286 1287 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn, const VarDecl *D); 1288 1289 void EmitCXXConstructExpr(llvm::Value *Dest, const CXXConstructExpr *E); 1290 1291 RValue EmitCXXExprWithTemporaries(const CXXExprWithTemporaries *E, 1292 llvm::Value *AggLoc = 0, 1293 bool IsAggLocVolatile = false, 1294 bool IsInitializer = false); 1295 1296 void EmitCXXThrowExpr(const CXXThrowExpr *E); 1297 1298 //===--------------------------------------------------------------------===// 1299 // Internal Helpers 1300 //===--------------------------------------------------------------------===// 1301 1302 /// ContainsLabel - Return true if the statement contains a label in it. If 1303 /// this statement is not executed normally, it not containing a label means 1304 /// that we can just remove the code. 1305 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false); 1306 1307 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold 1308 /// to a constant, or if it does but contains a label, return 0. If it 1309 /// constant folds to 'true' and does not contain a label, return 1, if it 1310 /// constant folds to 'false' and does not contain a label, return -1. 1311 int ConstantFoldsToSimpleInteger(const Expr *Cond); 1312 1313 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an 1314 /// if statement) to the specified blocks. Based on the condition, this might 1315 /// try to simplify the codegen of the conditional based on the branch. 1316 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock, 1317 llvm::BasicBlock *FalseBlock); 1318 1319 /// getTrapBB - Create a basic block that will call the trap intrinsic. We'll 1320 /// generate a branch around the created basic block as necessary. 1321 llvm::BasicBlock* getTrapBB(); 1322 1323 /// EmitCallArg - Emit a single call argument. 1324 RValue EmitCallArg(const Expr *E, QualType ArgType); 1325 1326 /// EmitDelegateCallArg - We are performing a delegate call; that 1327 /// is, the current function is delegating to another one. Produce 1328 /// a r-value suitable for passing the given parameter. 1329 RValue EmitDelegateCallArg(const VarDecl *Param); 1330 1331private: 1332 1333 void EmitReturnOfRValue(RValue RV, QualType Ty); 1334 1335 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty 1336 /// from function arguments into \arg Dst. See ABIArgInfo::Expand. 1337 /// 1338 /// \param AI - The first function argument of the expansion. 1339 /// \return The argument following the last expanded function 1340 /// argument. 1341 llvm::Function::arg_iterator 1342 ExpandTypeFromArgs(QualType Ty, LValue Dst, 1343 llvm::Function::arg_iterator AI); 1344 1345 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg 1346 /// Ty, into individual arguments on the provided vector \arg Args. See 1347 /// ABIArgInfo::Expand. 1348 void ExpandTypeToArgs(QualType Ty, RValue Src, 1349 llvm::SmallVector<llvm::Value*, 16> &Args); 1350 1351 llvm::Value* EmitAsmInput(const AsmStmt &S, 1352 const TargetInfo::ConstraintInfo &Info, 1353 const Expr *InputExpr, std::string &ConstraintStr); 1354 1355 /// EmitCleanupBlock - emits a single cleanup block. 1356 void EmitCleanupBlock(); 1357 1358 /// AddBranchFixup - adds a branch instruction to the list of fixups for the 1359 /// current cleanup scope. 1360 void AddBranchFixup(llvm::BranchInst *BI); 1361 1362 /// EmitCallArgs - Emit call arguments for a function. 1363 /// The CallArgTypeInfo parameter is used for iterating over the known 1364 /// argument types of the function being called. 1365 template<typename T> 1366 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo, 1367 CallExpr::const_arg_iterator ArgBeg, 1368 CallExpr::const_arg_iterator ArgEnd) { 1369 CallExpr::const_arg_iterator Arg = ArgBeg; 1370 1371 // First, use the argument types that the type info knows about 1372 if (CallArgTypeInfo) { 1373 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(), 1374 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) { 1375 assert(Arg != ArgEnd && "Running over edge of argument list!"); 1376 QualType ArgType = *I; 1377 1378 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()). 1379 getTypePtr() == 1380 getContext().getCanonicalType(Arg->getType()).getTypePtr() && 1381 "type mismatch in call argument!"); 1382 1383 Args.push_back(std::make_pair(EmitCallArg(*Arg, ArgType), 1384 ArgType)); 1385 } 1386 1387 // Either we've emitted all the call args, or we have a call to a 1388 // variadic function. 1389 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) && 1390 "Extra arguments in non-variadic function!"); 1391 1392 } 1393 1394 // If we still have any arguments, emit them using the type of the argument. 1395 for (; Arg != ArgEnd; ++Arg) { 1396 QualType ArgType = Arg->getType(); 1397 Args.push_back(std::make_pair(EmitCallArg(*Arg, ArgType), 1398 ArgType)); 1399 } 1400 } 1401 1402 const TargetCodeGenInfo &getTargetHooks() const { 1403 return CGM.getTargetCodeGenInfo(); 1404 } 1405}; 1406 1407 1408} // end namespace CodeGen 1409} // end namespace clang 1410 1411#endif 1412