1 //===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the internal per-function state used for llvm translation.
12 //===----------------------------------------------------------------------===//
14 #ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15 #define CLANG_CODEGEN_CODEGENFUNCTION_H
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/Frontend/CodeGenOptions.h"
22 #include "clang/Basic/ABI.h"
23 #include "clang/Basic/TargetInfo.h"
24 #include "llvm/ADT/ArrayRef.h"
25 #include "llvm/ADT/DenseMap.h"
26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/Support/ValueHandle.h"
28 #include "llvm/Support/Debug.h"
29 #include "CodeGenModule.h"
30 #include "CGBuilder.h"
31 #include "CGDebugInfo.h"
48 class CXXDestructorDecl;
49 class CXXForRangeStmt;
53 class EnumConstantDecl;
55 class FunctionProtoType;
57 class ObjCContainerDecl;
58 class ObjCInterfaceDecl;
61 class ObjCImplementationDecl;
62 class ObjCPropertyImplDecl;
64 class TargetCodeGenInfo;
66 class ObjCForCollectionStmt;
68 class ObjCAtThrowStmt;
69 class ObjCAtSynchronizedStmt;
70 class ObjCAutoreleasePoolStmt;
79 class BlockFieldFlags;
81 /// A branch fixup. These are required when emitting a goto to a
82 /// label which hasn't been emitted yet. The goto is optimistically
83 /// emitted as a branch to the basic block for the label, and (if it
84 /// occurs in a scope with non-trivial cleanups) a fixup is added to
85 /// the innermost cleanup. When a (normal) cleanup is popped, any
86 /// unresolved fixups in that scope are threaded through the cleanup.
88 /// The block containing the terminator which needs to be modified
89 /// into a switch if this fixup is resolved into the current scope.
90 /// If null, LatestBranch points directly to the destination.
91 llvm::BasicBlock *OptimisticBranchBlock;
93 /// The ultimate destination of the branch.
95 /// This can be set to null to indicate that this fixup was
96 /// successfully resolved.
97 llvm::BasicBlock *Destination;
99 /// The destination index value.
100 unsigned DestinationIndex;
102 /// The initial branch of the fixup.
103 llvm::BranchInst *InitialBranch;
106 template <class T> struct InvariantValue {
108 typedef T saved_type;
109 static bool needsSaving(type value) { return false; }
110 static saved_type save(CodeGenFunction &CGF, type value) { return value; }
111 static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
114 /// A metaprogramming class for ensuring that a value will dominate an
115 /// arbitrary position in a function.
116 template <class T> struct DominatingValue : InvariantValue<T> {};
118 template <class T, bool mightBeInstruction =
119 llvm::is_base_of<llvm::Value, T>::value &&
120 !llvm::is_base_of<llvm::Constant, T>::value &&
121 !llvm::is_base_of<llvm::BasicBlock, T>::value>
122 struct DominatingPointer;
123 template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
124 // template <class T> struct DominatingPointer<T,true> at end of file
126 template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
131 NormalAndEHCleanup = EHCleanup | NormalCleanup,
133 InactiveCleanup = 0x4,
134 InactiveEHCleanup = EHCleanup | InactiveCleanup,
135 InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
136 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
139 /// A stack of scopes which respond to exceptions, including cleanups
140 /// and catch blocks.
143 /// A saved depth on the scope stack. This is necessary because
144 /// pushing scopes onto the stack invalidates iterators.
145 class stable_iterator {
146 friend class EHScopeStack;
148 /// Offset from StartOfData to EndOfBuffer.
151 stable_iterator(ptrdiff_t Size) : Size(Size) {}
154 static stable_iterator invalid() { return stable_iterator(-1); }
155 stable_iterator() : Size(-1) {}
157 bool isValid() const { return Size >= 0; }
159 /// Returns true if this scope encloses I.
160 /// Returns false if I is invalid.
161 /// This scope must be valid.
162 bool encloses(stable_iterator I) const { return Size <= I.Size; }
164 /// Returns true if this scope strictly encloses I: that is,
165 /// if it encloses I and is not I.
166 /// Returns false is I is invalid.
167 /// This scope must be valid.
168 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
170 friend bool operator==(stable_iterator A, stable_iterator B) {
171 return A.Size == B.Size;
173 friend bool operator!=(stable_iterator A, stable_iterator B) {
174 return A.Size != B.Size;
178 /// Information for lazily generating a cleanup. Subclasses must be
179 /// POD-like: cleanups will not be destructed, and they will be
180 /// allocated on the cleanup stack and freely copied and moved
183 /// Cleanup implementations should generally be declared in an
184 /// anonymous namespace.
186 // Anchor the construction vtable.
187 virtual void anchor();
189 /// Generation flags.
193 F_IsNormalCleanupKind = 0x2,
194 F_IsEHCleanupKind = 0x4
199 Flags() : flags(0) {}
201 /// isForEH - true if the current emission is for an EH cleanup.
202 bool isForEHCleanup() const { return flags & F_IsForEH; }
203 bool isForNormalCleanup() const { return !isForEHCleanup(); }
204 void setIsForEHCleanup() { flags |= F_IsForEH; }
206 bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; }
207 void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; }
209 /// isEHCleanupKind - true if the cleanup was pushed as an EH
211 bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; }
212 void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; }
215 // Provide a virtual destructor to suppress a very common warning
216 // that unfortunately cannot be suppressed without this. Cleanups
217 // should not rely on this destructor ever being called.
218 virtual ~Cleanup() {}
220 /// Emit the cleanup. For normal cleanups, this is run in the
221 /// same EH context as when the cleanup was pushed, i.e. the
222 /// immediately-enclosing context of the cleanup scope. For
223 /// EH cleanups, this is run in a terminate context.
225 // \param flags cleanup kind.
226 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
229 /// ConditionalCleanupN stores the saved form of its N parameters,
230 /// then restores them and performs the cleanup.
231 template <class T, class A0>
232 class ConditionalCleanup1 : public Cleanup {
233 typedef typename DominatingValue<A0>::saved_type A0_saved;
236 void Emit(CodeGenFunction &CGF, Flags flags) {
237 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
238 T(a0).Emit(CGF, flags);
242 ConditionalCleanup1(A0_saved a0)
246 template <class T, class A0, class A1>
247 class ConditionalCleanup2 : public Cleanup {
248 typedef typename DominatingValue<A0>::saved_type A0_saved;
249 typedef typename DominatingValue<A1>::saved_type A1_saved;
253 void Emit(CodeGenFunction &CGF, Flags flags) {
254 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
255 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
256 T(a0, a1).Emit(CGF, flags);
260 ConditionalCleanup2(A0_saved a0, A1_saved a1)
261 : a0_saved(a0), a1_saved(a1) {}
264 template <class T, class A0, class A1, class A2>
265 class ConditionalCleanup3 : public Cleanup {
266 typedef typename DominatingValue<A0>::saved_type A0_saved;
267 typedef typename DominatingValue<A1>::saved_type A1_saved;
268 typedef typename DominatingValue<A2>::saved_type A2_saved;
273 void Emit(CodeGenFunction &CGF, Flags flags) {
274 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
275 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
276 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
277 T(a0, a1, a2).Emit(CGF, flags);
281 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
282 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
285 template <class T, class A0, class A1, class A2, class A3>
286 class ConditionalCleanup4 : public Cleanup {
287 typedef typename DominatingValue<A0>::saved_type A0_saved;
288 typedef typename DominatingValue<A1>::saved_type A1_saved;
289 typedef typename DominatingValue<A2>::saved_type A2_saved;
290 typedef typename DominatingValue<A3>::saved_type A3_saved;
296 void Emit(CodeGenFunction &CGF, Flags flags) {
297 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
298 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
299 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
300 A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved);
301 T(a0, a1, a2, a3).Emit(CGF, flags);
305 ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3)
306 : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {}
310 // The implementation for this class is in CGException.h and
311 // CGException.cpp; the definition is here because it's used as a
312 // member of CodeGenFunction.
314 /// The start of the scope-stack buffer, i.e. the allocated pointer
315 /// for the buffer. All of these pointers are either simultaneously
316 /// null or simultaneously valid.
319 /// The end of the buffer.
322 /// The first valid entry in the buffer.
325 /// The innermost normal cleanup on the stack.
326 stable_iterator InnermostNormalCleanup;
328 /// The innermost EH scope on the stack.
329 stable_iterator InnermostEHScope;
331 /// The current set of branch fixups. A branch fixup is a jump to
332 /// an as-yet unemitted label, i.e. a label for which we don't yet
333 /// know the EH stack depth. Whenever we pop a cleanup, we have
334 /// to thread all the current branch fixups through it.
336 /// Fixups are recorded as the Use of the respective branch or
337 /// switch statement. The use points to the final destination.
338 /// When popping out of a cleanup, these uses are threaded through
339 /// the cleanup and adjusted to point to the new cleanup.
341 /// Note that branches are allowed to jump into protected scopes
342 /// in certain situations; e.g. the following code is legal:
343 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
348 SmallVector<BranchFixup, 8> BranchFixups;
350 char *allocate(size_t Size);
352 void *pushCleanup(CleanupKind K, size_t DataSize);
355 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
356 InnermostNormalCleanup(stable_end()),
357 InnermostEHScope(stable_end()) {}
358 ~EHScopeStack() { delete[] StartOfBuffer; }
360 // Variadic templates would make this not terrible.
362 /// Push a lazily-created cleanup on the stack.
364 void pushCleanup(CleanupKind Kind) {
365 void *Buffer = pushCleanup(Kind, sizeof(T));
366 Cleanup *Obj = new(Buffer) T();
370 /// Push a lazily-created cleanup on the stack.
371 template <class T, class A0>
372 void pushCleanup(CleanupKind Kind, A0 a0) {
373 void *Buffer = pushCleanup(Kind, sizeof(T));
374 Cleanup *Obj = new(Buffer) T(a0);
378 /// Push a lazily-created cleanup on the stack.
379 template <class T, class A0, class A1>
380 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
381 void *Buffer = pushCleanup(Kind, sizeof(T));
382 Cleanup *Obj = new(Buffer) T(a0, a1);
386 /// Push a lazily-created cleanup on the stack.
387 template <class T, class A0, class A1, class A2>
388 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
389 void *Buffer = pushCleanup(Kind, sizeof(T));
390 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
394 /// Push a lazily-created cleanup on the stack.
395 template <class T, class A0, class A1, class A2, class A3>
396 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
397 void *Buffer = pushCleanup(Kind, sizeof(T));
398 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
402 /// Push a lazily-created cleanup on the stack.
403 template <class T, class A0, class A1, class A2, class A3, class A4>
404 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
405 void *Buffer = pushCleanup(Kind, sizeof(T));
406 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
410 // Feel free to add more variants of the following:
412 /// Push a cleanup with non-constant storage requirements on the
413 /// stack. The cleanup type must provide an additional static method:
414 /// static size_t getExtraSize(size_t);
415 /// The argument to this method will be the value N, which will also
416 /// be passed as the first argument to the constructor.
418 /// The data stored in the extra storage must obey the same
419 /// restrictions as normal cleanup member data.
421 /// The pointer returned from this method is valid until the cleanup
422 /// stack is modified.
423 template <class T, class A0, class A1, class A2>
424 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
425 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
426 return new (Buffer) T(N, a0, a1, a2);
429 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp.
432 /// Push a set of catch handlers on the stack. The catch is
433 /// uninitialized and will need to have the given number of handlers
435 class EHCatchScope *pushCatch(unsigned NumHandlers);
437 /// Pops a catch scope off the stack. This is private to CGException.cpp.
440 /// Push an exceptions filter on the stack.
441 class EHFilterScope *pushFilter(unsigned NumFilters);
443 /// Pops an exceptions filter off the stack.
446 /// Push a terminate handler on the stack.
447 void pushTerminate();
449 /// Pops a terminate handler off the stack.
452 /// Determines whether the exception-scopes stack is empty.
453 bool empty() const { return StartOfData == EndOfBuffer; }
455 bool requiresLandingPad() const {
456 return InnermostEHScope != stable_end();
459 /// Determines whether there are any normal cleanups on the stack.
460 bool hasNormalCleanups() const {
461 return InnermostNormalCleanup != stable_end();
464 /// Returns the innermost normal cleanup on the stack, or
465 /// stable_end() if there are no normal cleanups.
466 stable_iterator getInnermostNormalCleanup() const {
467 return InnermostNormalCleanup;
469 stable_iterator getInnermostActiveNormalCleanup() const;
471 stable_iterator getInnermostEHScope() const {
472 return InnermostEHScope;
475 stable_iterator getInnermostActiveEHScope() const;
477 /// An unstable reference to a scope-stack depth. Invalidated by
478 /// pushes but not pops.
481 /// Returns an iterator pointing to the innermost EH scope.
482 iterator begin() const;
484 /// Returns an iterator pointing to the outermost EH scope.
485 iterator end() const;
487 /// Create a stable reference to the top of the EH stack. The
488 /// returned reference is valid until that scope is popped off the
490 stable_iterator stable_begin() const {
491 return stable_iterator(EndOfBuffer - StartOfData);
494 /// Create a stable reference to the bottom of the EH stack.
495 static stable_iterator stable_end() {
496 return stable_iterator(0);
499 /// Translates an iterator into a stable_iterator.
500 stable_iterator stabilize(iterator it) const;
502 /// Turn a stable reference to a scope depth into a unstable pointer
504 iterator find(stable_iterator save) const;
506 /// Removes the cleanup pointed to by the given stable_iterator.
507 void removeCleanup(stable_iterator save);
509 /// Add a branch fixup to the current cleanup scope.
510 BranchFixup &addBranchFixup() {
511 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
512 BranchFixups.push_back(BranchFixup());
513 return BranchFixups.back();
516 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
517 BranchFixup &getBranchFixup(unsigned I) {
518 assert(I < getNumBranchFixups());
519 return BranchFixups[I];
522 /// Pops lazily-removed fixups from the end of the list. This
523 /// should only be called by procedures which have just popped a
524 /// cleanup or resolved one or more fixups.
525 void popNullFixups();
527 /// Clears the branch-fixups list. This should only be called by
528 /// ResolveAllBranchFixups.
529 void clearFixups() { BranchFixups.clear(); }
532 /// CodeGenFunction - This class organizes the per-function state that is used
533 /// while generating LLVM code.
534 class CodeGenFunction : public CodeGenTypeCache {
535 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
536 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
538 friend class CGCXXABI;
540 /// A jump destination is an abstract label, branching to which may
541 /// require a jump out through normal cleanups.
543 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
544 JumpDest(llvm::BasicBlock *Block,
545 EHScopeStack::stable_iterator Depth,
547 : Block(Block), ScopeDepth(Depth), Index(Index) {}
549 bool isValid() const { return Block != 0; }
550 llvm::BasicBlock *getBlock() const { return Block; }
551 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
552 unsigned getDestIndex() const { return Index; }
555 llvm::BasicBlock *Block;
556 EHScopeStack::stable_iterator ScopeDepth;
560 CodeGenModule &CGM; // Per-module state.
561 const TargetInfo &Target;
563 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
566 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
567 /// This excludes BlockDecls.
568 const Decl *CurFuncDecl;
569 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
570 const Decl *CurCodeDecl;
571 const CGFunctionInfo *CurFnInfo;
573 llvm::Function *CurFn;
575 /// CurGD - The GlobalDecl for the current function being compiled.
578 /// PrologueCleanupDepth - The cleanup depth enclosing all the
579 /// cleanups associated with the parameters.
580 EHScopeStack::stable_iterator PrologueCleanupDepth;
582 /// ReturnBlock - Unified return block.
583 JumpDest ReturnBlock;
585 /// ReturnValue - The temporary alloca to hold the return value. This is null
586 /// iff the function has no return value.
587 llvm::Value *ReturnValue;
589 /// AllocaInsertPoint - This is an instruction in the entry block before which
590 /// we prefer to insert allocas.
591 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
593 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
594 /// potentially higher performance penalties.
595 unsigned char BoundsChecking;
597 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
598 /// calls to EmitTypeCheck can be skipped.
599 bool SanitizePerformTypeCheck;
601 /// In ARC, whether we should autorelease the return value.
602 bool AutoreleaseResult;
604 const CodeGen::CGBlockInfo *BlockInfo;
605 llvm::Value *BlockPointer;
607 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
608 FieldDecl *LambdaThisCaptureField;
610 /// \brief A mapping from NRVO variables to the flags used to indicate
611 /// when the NRVO has been applied to this variable.
612 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
614 EHScopeStack EHStack;
616 /// i32s containing the indexes of the cleanup destinations.
617 llvm::AllocaInst *NormalCleanupDest;
619 unsigned NextCleanupDestIndex;
621 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
622 CGBlockInfo *FirstBlockInfo;
624 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
625 llvm::BasicBlock *EHResumeBlock;
627 /// The exception slot. All landing pads write the current exception pointer
628 /// into this alloca.
629 llvm::Value *ExceptionSlot;
631 /// The selector slot. Under the MandatoryCleanup model, all landing pads
632 /// write the current selector value into this alloca.
633 llvm::AllocaInst *EHSelectorSlot;
635 /// Emits a landing pad for the current EH stack.
636 llvm::BasicBlock *EmitLandingPad();
638 llvm::BasicBlock *getInvokeDestImpl();
641 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
642 return DominatingValue<T>::save(*this, value);
646 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
648 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
650 /// A class controlling the emission of a finally block.
652 /// Where the catchall's edge through the cleanup should go.
653 JumpDest RethrowDest;
655 /// A function to call to enter the catch.
656 llvm::Constant *BeginCatchFn;
658 /// An i1 variable indicating whether or not the @finally is
659 /// running for an exception.
660 llvm::AllocaInst *ForEHVar;
662 /// An i8* variable into which the exception pointer to rethrow
664 llvm::AllocaInst *SavedExnVar;
667 void enter(CodeGenFunction &CGF, const Stmt *Finally,
668 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
669 llvm::Constant *rethrowFn);
670 void exit(CodeGenFunction &CGF);
673 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
674 /// current full-expression. Safe against the possibility that
675 /// we're currently inside a conditionally-evaluated expression.
676 template <class T, class A0>
677 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
678 // If we're not in a conditional branch, or if none of the
679 // arguments requires saving, then use the unconditional cleanup.
680 if (!isInConditionalBranch())
681 return EHStack.pushCleanup<T>(kind, a0);
683 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
685 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
686 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
687 initFullExprCleanup();
690 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
691 /// current full-expression. Safe against the possibility that
692 /// we're currently inside a conditionally-evaluated expression.
693 template <class T, class A0, class A1>
694 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
695 // If we're not in a conditional branch, or if none of the
696 // arguments requires saving, then use the unconditional cleanup.
697 if (!isInConditionalBranch())
698 return EHStack.pushCleanup<T>(kind, a0, a1);
700 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
701 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
703 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
704 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
705 initFullExprCleanup();
708 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
709 /// current full-expression. Safe against the possibility that
710 /// we're currently inside a conditionally-evaluated expression.
711 template <class T, class A0, class A1, class A2>
712 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
713 // If we're not in a conditional branch, or if none of the
714 // arguments requires saving, then use the unconditional cleanup.
715 if (!isInConditionalBranch()) {
716 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
719 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
720 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
721 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
723 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
724 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
725 initFullExprCleanup();
728 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
729 /// current full-expression. Safe against the possibility that
730 /// we're currently inside a conditionally-evaluated expression.
731 template <class T, class A0, class A1, class A2, class A3>
732 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
733 // If we're not in a conditional branch, or if none of the
734 // arguments requires saving, then use the unconditional cleanup.
735 if (!isInConditionalBranch()) {
736 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
739 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
740 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
741 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
742 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
744 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
745 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
747 initFullExprCleanup();
750 /// Set up the last cleaup that was pushed as a conditional
751 /// full-expression cleanup.
752 void initFullExprCleanup();
754 /// PushDestructorCleanup - Push a cleanup to call the
755 /// complete-object destructor of an object of the given type at the
756 /// given address. Does nothing if T is not a C++ class type with a
757 /// non-trivial destructor.
758 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
760 /// PushDestructorCleanup - Push a cleanup to call the
761 /// complete-object variant of the given destructor on the object at
762 /// the given address.
763 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
766 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
767 /// process all branch fixups.
768 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
770 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
771 /// The block cannot be reactivated. Pops it if it's the top of the
774 /// \param DominatingIP - An instruction which is known to
775 /// dominate the current IP (if set) and which lies along
776 /// all paths of execution between the current IP and the
777 /// the point at which the cleanup comes into scope.
778 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
779 llvm::Instruction *DominatingIP);
781 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
782 /// Cannot be used to resurrect a deactivated cleanup.
784 /// \param DominatingIP - An instruction which is known to
785 /// dominate the current IP (if set) and which lies along
786 /// all paths of execution between the current IP and the
787 /// the point at which the cleanup comes into scope.
788 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
789 llvm::Instruction *DominatingIP);
791 /// \brief Enters a new scope for capturing cleanups, all of which
792 /// will be executed once the scope is exited.
793 class RunCleanupsScope {
794 EHScopeStack::stable_iterator CleanupStackDepth;
795 bool OldDidCallStackSave;
798 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
799 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
802 CodeGenFunction& CGF;
805 /// \brief Enter a new cleanup scope.
806 explicit RunCleanupsScope(CodeGenFunction &CGF)
807 : PerformCleanup(true), CGF(CGF)
809 CleanupStackDepth = CGF.EHStack.stable_begin();
810 OldDidCallStackSave = CGF.DidCallStackSave;
811 CGF.DidCallStackSave = false;
814 /// \brief Exit this cleanup scope, emitting any accumulated
816 ~RunCleanupsScope() {
817 if (PerformCleanup) {
818 CGF.DidCallStackSave = OldDidCallStackSave;
819 CGF.PopCleanupBlocks(CleanupStackDepth);
823 /// \brief Determine whether this scope requires any cleanups.
824 bool requiresCleanups() const {
825 return CGF.EHStack.stable_begin() != CleanupStackDepth;
828 /// \brief Force the emission of cleanups now, instead of waiting
829 /// until this object is destroyed.
830 void ForceCleanup() {
831 assert(PerformCleanup && "Already forced cleanup");
832 CGF.DidCallStackSave = OldDidCallStackSave;
833 CGF.PopCleanupBlocks(CleanupStackDepth);
834 PerformCleanup = false;
838 class LexicalScope: protected RunCleanupsScope {
842 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
843 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
846 /// \brief Enter a new cleanup scope.
847 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
848 : RunCleanupsScope(CGF), Range(Range), PopDebugStack(true) {
849 if (CGDebugInfo *DI = CGF.getDebugInfo())
850 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
853 /// \brief Exit this cleanup scope, emitting any accumulated
857 CGDebugInfo *DI = CGF.getDebugInfo();
858 if (DI) DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
862 /// \brief Force the emission of cleanups now, instead of waiting
863 /// until this object is destroyed.
864 void ForceCleanup() {
865 RunCleanupsScope::ForceCleanup();
866 if (CGDebugInfo *DI = CGF.getDebugInfo()) {
867 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
868 PopDebugStack = false;
874 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
875 /// the cleanup blocks that have been added.
876 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
878 void ResolveBranchFixups(llvm::BasicBlock *Target);
880 /// The given basic block lies in the current EH scope, but may be a
881 /// target of a potentially scope-crossing jump; get a stable handle
882 /// to which we can perform this jump later.
883 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
884 return JumpDest(Target,
885 EHStack.getInnermostNormalCleanup(),
886 NextCleanupDestIndex++);
889 /// The given basic block lies in the current EH scope, but may be a
890 /// target of a potentially scope-crossing jump; get a stable handle
891 /// to which we can perform this jump later.
892 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
893 return getJumpDestInCurrentScope(createBasicBlock(Name));
896 /// EmitBranchThroughCleanup - Emit a branch from the current insert
897 /// block through the normal cleanup handling code (if any) and then
899 void EmitBranchThroughCleanup(JumpDest Dest);
901 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
902 /// specified destination obviously has no cleanups to run. 'false' is always
903 /// a conservatively correct answer for this method.
904 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
906 /// popCatchScope - Pops the catch scope at the top of the EHScope
907 /// stack, emitting any required code (other than the catch handlers
909 void popCatchScope();
911 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
912 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
914 /// An object to manage conditionally-evaluated expressions.
915 class ConditionalEvaluation {
916 llvm::BasicBlock *StartBB;
919 ConditionalEvaluation(CodeGenFunction &CGF)
920 : StartBB(CGF.Builder.GetInsertBlock()) {}
922 void begin(CodeGenFunction &CGF) {
923 assert(CGF.OutermostConditional != this);
924 if (!CGF.OutermostConditional)
925 CGF.OutermostConditional = this;
928 void end(CodeGenFunction &CGF) {
929 assert(CGF.OutermostConditional != 0);
930 if (CGF.OutermostConditional == this)
931 CGF.OutermostConditional = 0;
934 /// Returns a block which will be executed prior to each
935 /// evaluation of the conditional code.
936 llvm::BasicBlock *getStartingBlock() const {
941 /// isInConditionalBranch - Return true if we're currently emitting
942 /// one branch or the other of a conditional expression.
943 bool isInConditionalBranch() const { return OutermostConditional != 0; }
945 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
946 assert(isInConditionalBranch());
947 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
948 new llvm::StoreInst(value, addr, &block->back());
951 /// An RAII object to record that we're evaluating a statement
953 class StmtExprEvaluation {
954 CodeGenFunction &CGF;
956 /// We have to save the outermost conditional: cleanups in a
957 /// statement expression aren't conditional just because the
959 ConditionalEvaluation *SavedOutermostConditional;
962 StmtExprEvaluation(CodeGenFunction &CGF)
963 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
964 CGF.OutermostConditional = 0;
967 ~StmtExprEvaluation() {
968 CGF.OutermostConditional = SavedOutermostConditional;
969 CGF.EnsureInsertPoint();
973 /// An object which temporarily prevents a value from being
974 /// destroyed by aggressive peephole optimizations that assume that
975 /// all uses of a value have been realized in the IR.
976 class PeepholeProtection {
977 llvm::Instruction *Inst;
978 friend class CodeGenFunction;
981 PeepholeProtection() : Inst(0) {}
984 /// A non-RAII class containing all the information about a bound
985 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
986 /// this which makes individual mappings very simple; using this
987 /// class directly is useful when you have a variable number of
988 /// opaque values or don't want the RAII functionality for some
990 class OpaqueValueMappingData {
991 const OpaqueValueExpr *OpaqueValue;
993 CodeGenFunction::PeepholeProtection Protection;
995 OpaqueValueMappingData(const OpaqueValueExpr *ov,
997 : OpaqueValue(ov), BoundLValue(boundLValue) {}
999 OpaqueValueMappingData() : OpaqueValue(0) {}
1001 static bool shouldBindAsLValue(const Expr *expr) {
1002 // gl-values should be bound as l-values for obvious reasons.
1003 // Records should be bound as l-values because IR generation
1004 // always keeps them in memory. Expressions of function type
1005 // act exactly like l-values but are formally required to be
1007 return expr->isGLValue() ||
1008 expr->getType()->isRecordType() ||
1009 expr->getType()->isFunctionType();
1012 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1013 const OpaqueValueExpr *ov,
1015 if (shouldBindAsLValue(ov))
1016 return bind(CGF, ov, CGF.EmitLValue(e));
1017 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1020 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1021 const OpaqueValueExpr *ov,
1023 assert(shouldBindAsLValue(ov));
1024 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1025 return OpaqueValueMappingData(ov, true);
1028 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1029 const OpaqueValueExpr *ov,
1031 assert(!shouldBindAsLValue(ov));
1032 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1034 OpaqueValueMappingData data(ov, false);
1036 // Work around an extremely aggressive peephole optimization in
1037 // EmitScalarConversion which assumes that all other uses of a
1038 // value are extant.
1039 data.Protection = CGF.protectFromPeepholes(rv);
1044 bool isValid() const { return OpaqueValue != 0; }
1045 void clear() { OpaqueValue = 0; }
1047 void unbind(CodeGenFunction &CGF) {
1048 assert(OpaqueValue && "no data to unbind!");
1051 CGF.OpaqueLValues.erase(OpaqueValue);
1053 CGF.OpaqueRValues.erase(OpaqueValue);
1054 CGF.unprotectFromPeepholes(Protection);
1059 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1060 class OpaqueValueMapping {
1061 CodeGenFunction &CGF;
1062 OpaqueValueMappingData Data;
1065 static bool shouldBindAsLValue(const Expr *expr) {
1066 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1069 /// Build the opaque value mapping for the given conditional
1070 /// operator if it's the GNU ?: extension. This is a common
1071 /// enough pattern that the convenience operator is really
1074 OpaqueValueMapping(CodeGenFunction &CGF,
1075 const AbstractConditionalOperator *op) : CGF(CGF) {
1076 if (isa<ConditionalOperator>(op))
1077 // Leave Data empty.
1080 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
1081 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1085 OpaqueValueMapping(CodeGenFunction &CGF,
1086 const OpaqueValueExpr *opaqueValue,
1088 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
1091 OpaqueValueMapping(CodeGenFunction &CGF,
1092 const OpaqueValueExpr *opaqueValue,
1094 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
1102 ~OpaqueValueMapping() {
1103 if (Data.isValid()) Data.unbind(CGF);
1107 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1108 /// number that holds the value.
1109 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
1111 /// BuildBlockByrefAddress - Computes address location of the
1112 /// variable which is declared as __block.
1113 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1116 CGDebugInfo *DebugInfo;
1117 bool DisableDebugInfo;
1119 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1120 /// calling llvm.stacksave for multiple VLAs in the same scope.
1121 bool DidCallStackSave;
1123 /// IndirectBranch - The first time an indirect goto is seen we create a block
1124 /// with an indirect branch. Every time we see the address of a label taken,
1125 /// we add the label to the indirect goto. Every subsequent indirect goto is
1126 /// codegen'd as a jump to the IndirectBranch's basic block.
1127 llvm::IndirectBrInst *IndirectBranch;
1129 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1131 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1132 DeclMapTy LocalDeclMap;
1134 /// LabelMap - This keeps track of the LLVM basic block for each C label.
1135 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
1137 // BreakContinueStack - This keeps track of where break and continue
1138 // statements should jump to.
1139 struct BreakContinue {
1140 BreakContinue(JumpDest Break, JumpDest Continue)
1141 : BreakBlock(Break), ContinueBlock(Continue) {}
1143 JumpDest BreakBlock;
1144 JumpDest ContinueBlock;
1146 SmallVector<BreakContinue, 8> BreakContinueStack;
1148 /// SwitchInsn - This is nearest current switch instruction. It is null if
1149 /// current context is not in a switch.
1150 llvm::SwitchInst *SwitchInsn;
1152 /// CaseRangeBlock - This block holds if condition check for last case
1153 /// statement range in current switch instruction.
1154 llvm::BasicBlock *CaseRangeBlock;
1156 /// OpaqueLValues - Keeps track of the current set of opaque value
1158 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1159 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
1161 // VLASizeMap - This keeps track of the associated size for each VLA type.
1162 // We track this by the size expression rather than the type itself because
1163 // in certain situations, like a const qualifier applied to an VLA typedef,
1164 // multiple VLA types can share the same size expression.
1165 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1166 // enter/leave scopes.
1167 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
1169 /// A block containing a single 'unreachable' instruction. Created
1170 /// lazily by getUnreachableBlock().
1171 llvm::BasicBlock *UnreachableBlock;
1173 /// CXXThisDecl - When generating code for a C++ member function,
1174 /// this will hold the implicit 'this' declaration.
1175 ImplicitParamDecl *CXXABIThisDecl;
1176 llvm::Value *CXXABIThisValue;
1177 llvm::Value *CXXThisValue;
1179 /// CXXVTTDecl - When generating code for a base object constructor or
1180 /// base object destructor with virtual bases, this will hold the implicit
1182 ImplicitParamDecl *CXXVTTDecl;
1183 llvm::Value *CXXVTTValue;
1185 /// OutermostConditional - Points to the outermost active
1186 /// conditional control. This is used so that we know if a
1187 /// temporary should be destroyed conditionally.
1188 ConditionalEvaluation *OutermostConditional;
1191 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1192 /// type as well as the field number that contains the actual data.
1193 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
1194 unsigned> > ByRefValueInfo;
1196 llvm::BasicBlock *TerminateLandingPad;
1197 llvm::BasicBlock *TerminateHandler;
1198 llvm::BasicBlock *TrapBB;
1200 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1201 /// In the kernel metadata node, reference the kernel function and metadata
1202 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
1203 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1204 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1205 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1206 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1207 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1208 llvm::Function *Fn);
1211 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
1214 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
1215 ASTContext &getContext() const { return CGM.getContext(); }
1216 /// Returns true if DebugInfo is actually initialized.
1217 bool maybeInitializeDebugInfo() {
1218 if (CGM.getModuleDebugInfo()) {
1219 DebugInfo = CGM.getModuleDebugInfo();
1224 CGDebugInfo *getDebugInfo() {
1225 if (DisableDebugInfo)
1229 void disableDebugInfo() { DisableDebugInfo = true; }
1230 void enableDebugInfo() { DisableDebugInfo = false; }
1232 bool shouldUseFusedARCCalls() {
1233 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1236 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
1238 /// Returns a pointer to the function's exception object and selector slot,
1239 /// which is assigned in every landing pad.
1240 llvm::Value *getExceptionSlot();
1241 llvm::Value *getEHSelectorSlot();
1243 /// Returns the contents of the function's exception object and selector
1245 llvm::Value *getExceptionFromSlot();
1246 llvm::Value *getSelectorFromSlot();
1248 llvm::Value *getNormalCleanupDestSlot();
1250 llvm::BasicBlock *getUnreachableBlock() {
1251 if (!UnreachableBlock) {
1252 UnreachableBlock = createBasicBlock("unreachable");
1253 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1255 return UnreachableBlock;
1258 llvm::BasicBlock *getInvokeDest() {
1259 if (!EHStack.requiresLandingPad()) return 0;
1260 return getInvokeDestImpl();
1263 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
1265 //===--------------------------------------------------------------------===//
1267 //===--------------------------------------------------------------------===//
1269 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1271 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1272 llvm::Value *arrayEndPointer,
1273 QualType elementType,
1274 Destroyer *destroyer);
1275 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1276 llvm::Value *arrayEnd,
1277 QualType elementType,
1278 Destroyer *destroyer);
1280 void pushDestroy(QualType::DestructionKind dtorKind,
1281 llvm::Value *addr, QualType type);
1282 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
1283 Destroyer *destroyer, bool useEHCleanupForArray);
1284 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
1285 bool useEHCleanupForArray);
1286 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1288 Destroyer *destroyer,
1289 bool useEHCleanupForArray);
1290 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
1291 QualType type, Destroyer *destroyer,
1292 bool checkZeroLength, bool useEHCleanup);
1294 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
1296 /// Determines whether an EH cleanup is required to destroy a type
1297 /// with the given destruction kind.
1298 bool needsEHCleanup(QualType::DestructionKind kind) {
1300 case QualType::DK_none:
1302 case QualType::DK_cxx_destructor:
1303 case QualType::DK_objc_weak_lifetime:
1304 return getLangOpts().Exceptions;
1305 case QualType::DK_objc_strong_lifetime:
1306 return getLangOpts().Exceptions &&
1307 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1309 llvm_unreachable("bad destruction kind");
1312 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1313 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1316 //===--------------------------------------------------------------------===//
1318 //===--------------------------------------------------------------------===//
1320 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
1322 void StartObjCMethod(const ObjCMethodDecl *MD,
1323 const ObjCContainerDecl *CD,
1324 SourceLocation StartLoc);
1326 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
1327 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1328 const ObjCPropertyImplDecl *PID);
1329 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1330 const ObjCPropertyImplDecl *propImpl,
1331 const ObjCMethodDecl *GetterMothodDecl,
1332 llvm::Constant *AtomicHelperFn);
1334 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1335 ObjCMethodDecl *MD, bool ctor);
1337 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1338 /// for the given property.
1339 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1340 const ObjCPropertyImplDecl *PID);
1341 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1342 const ObjCPropertyImplDecl *propImpl,
1343 llvm::Constant *AtomicHelperFn);
1344 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
1345 bool IvarTypeWithAggrGCObjects(QualType Ty);
1347 //===--------------------------------------------------------------------===//
1349 //===--------------------------------------------------------------------===//
1351 llvm::Value *EmitBlockLiteral(const BlockExpr *);
1352 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1353 static void destroyBlockInfos(CGBlockInfo *info);
1354 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
1355 const CGBlockInfo &Info,
1357 llvm::Constant *BlockVarLayout);
1359 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
1360 const CGBlockInfo &Info,
1361 const Decl *OuterFuncDecl,
1362 const DeclMapTy &ldm,
1363 bool IsLambdaConversionToBlock);
1365 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1366 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
1367 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1368 const ObjCPropertyImplDecl *PID);
1369 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1370 const ObjCPropertyImplDecl *PID);
1371 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
1373 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1375 class AutoVarEmission;
1377 void emitByrefStructureInit(const AutoVarEmission &emission);
1378 void enterByrefCleanup(const AutoVarEmission &emission);
1380 llvm::Value *LoadBlockStruct() {
1381 assert(BlockPointer && "no block pointer set!");
1382 return BlockPointer;
1385 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
1386 void AllocateBlockDecl(const DeclRefExpr *E);
1387 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1388 llvm::Type *BuildByRefType(const VarDecl *var);
1390 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1391 const CGFunctionInfo &FnInfo);
1392 void StartFunction(GlobalDecl GD, QualType RetTy,
1394 const CGFunctionInfo &FnInfo,
1395 const FunctionArgList &Args,
1396 SourceLocation StartLoc);
1398 void EmitConstructorBody(FunctionArgList &Args);
1399 void EmitDestructorBody(FunctionArgList &Args);
1400 void EmitFunctionBody(FunctionArgList &Args);
1402 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1403 CallArgList &CallArgs);
1404 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
1405 void EmitLambdaBlockInvokeBody();
1406 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1407 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
1409 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1410 /// emission when possible.
1411 void EmitReturnBlock();
1413 /// FinishFunction - Complete IR generation of the current function. It is
1414 /// legal to call this function even if there is no current insertion point.
1415 void FinishFunction(SourceLocation EndLoc=SourceLocation());
1417 /// GenerateThunk - Generate a thunk for the given method.
1418 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1419 GlobalDecl GD, const ThunkInfo &Thunk);
1421 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1422 GlobalDecl GD, const ThunkInfo &Thunk);
1424 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1425 FunctionArgList &Args);
1427 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1428 ArrayRef<VarDecl *> ArrayIndexes);
1430 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1433 void InitializeVTablePointer(BaseSubobject Base,
1434 const CXXRecordDecl *NearestVBase,
1435 CharUnits OffsetFromNearestVBase,
1436 llvm::Constant *VTable,
1437 const CXXRecordDecl *VTableClass);
1439 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1440 void InitializeVTablePointers(BaseSubobject Base,
1441 const CXXRecordDecl *NearestVBase,
1442 CharUnits OffsetFromNearestVBase,
1443 bool BaseIsNonVirtualPrimaryBase,
1444 llvm::Constant *VTable,
1445 const CXXRecordDecl *VTableClass,
1446 VisitedVirtualBasesSetTy& VBases);
1448 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
1450 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1452 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
1454 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1455 /// given phase of destruction for a destructor. The end result
1456 /// should call destructors on members and base classes in reverse
1457 /// order of their construction.
1458 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
1460 /// ShouldInstrumentFunction - Return true if the current function should be
1461 /// instrumented with __cyg_profile_func_* calls
1462 bool ShouldInstrumentFunction();
1464 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1465 /// instrumentation function with the current function and the call site, if
1466 /// function instrumentation is enabled.
1467 void EmitFunctionInstrumentation(const char *Fn);
1469 /// EmitMCountInstrumentation - Emit call to .mcount.
1470 void EmitMCountInstrumentation();
1472 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1473 /// arguments for the given function. This is also responsible for naming the
1474 /// LLVM function arguments.
1475 void EmitFunctionProlog(const CGFunctionInfo &FI,
1477 const FunctionArgList &Args);
1479 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1480 /// given temporary.
1481 void EmitFunctionEpilog(const CGFunctionInfo &FI);
1483 /// EmitStartEHSpec - Emit the start of the exception spec.
1484 void EmitStartEHSpec(const Decl *D);
1486 /// EmitEndEHSpec - Emit the end of the exception spec.
1487 void EmitEndEHSpec(const Decl *D);
1489 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1490 llvm::BasicBlock *getTerminateLandingPad();
1492 /// getTerminateHandler - Return a handler (not a landing pad, just
1493 /// a catch handler) that just calls terminate. This is used when
1494 /// a terminate scope encloses a try.
1495 llvm::BasicBlock *getTerminateHandler();
1497 llvm::Type *ConvertTypeForMem(QualType T);
1498 llvm::Type *ConvertType(QualType T);
1499 llvm::Type *ConvertType(const TypeDecl *T) {
1500 return ConvertType(getContext().getTypeDeclType(T));
1503 /// LoadObjCSelf - Load the value of self. This function is only valid while
1504 /// generating code for an Objective-C method.
1505 llvm::Value *LoadObjCSelf();
1507 /// TypeOfSelfObject - Return type of object that this self represents.
1508 QualType TypeOfSelfObject();
1510 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1511 /// an aggregate LLVM type or is void.
1512 static bool hasAggregateLLVMType(QualType T);
1514 /// createBasicBlock - Create an LLVM basic block.
1515 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
1516 llvm::Function *parent = 0,
1517 llvm::BasicBlock *before = 0) {
1519 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
1521 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
1525 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1527 JumpDest getJumpDestForLabel(const LabelDecl *S);
1529 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1530 /// another basic block, simplify it. This assumes that no other code could
1531 /// potentially reference the basic block.
1532 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1534 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1535 /// adding a fall-through branch from the current insert block if
1536 /// necessary. It is legal to call this function even if there is no current
1537 /// insertion point.
1539 /// IsFinished - If true, indicates that the caller has finished emitting
1540 /// branches to the given block and does not expect to emit code into it. This
1541 /// means the block can be ignored if it is unreachable.
1542 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
1544 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1545 /// near its uses, and leave the insertion point in it.
1546 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1548 /// EmitBranch - Emit a branch to the specified basic block from the current
1549 /// insert block, taking care to avoid creation of branches from dummy
1550 /// blocks. It is legal to call this function even if there is no current
1551 /// insertion point.
1553 /// This function clears the current insertion point. The caller should follow
1554 /// calls to this function with calls to Emit*Block prior to generation new
1556 void EmitBranch(llvm::BasicBlock *Block);
1558 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1559 /// indicates that the current code being emitted is unreachable.
1560 bool HaveInsertPoint() const {
1561 return Builder.GetInsertBlock() != 0;
1564 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1565 /// emitted IR has a place to go. Note that by definition, if this function
1566 /// creates a block then that block is unreachable; callers may do better to
1567 /// detect when no insertion point is defined and simply skip IR generation.
1568 void EnsureInsertPoint() {
1569 if (!HaveInsertPoint())
1570 EmitBlock(createBasicBlock());
1573 /// ErrorUnsupported - Print out an error that codegen doesn't support the
1574 /// specified stmt yet.
1575 void ErrorUnsupported(const Stmt *S, const char *Type,
1576 bool OmitOnError=false);
1578 //===--------------------------------------------------------------------===//
1580 //===--------------------------------------------------------------------===//
1582 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1583 CharUnits Alignment = CharUnits()) {
1584 return LValue::MakeAddr(V, T, Alignment, getContext(),
1585 CGM.getTBAAInfo(T));
1588 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
1589 CharUnits Alignment;
1590 if (!T->isIncompleteType())
1591 Alignment = getContext().getTypeAlignInChars(T);
1592 return LValue::MakeAddr(V, T, Alignment, getContext(),
1593 CGM.getTBAAInfo(T));
1596 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
1597 /// block. The caller is responsible for setting an appropriate alignment on
1599 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
1600 const Twine &Name = "tmp");
1602 /// InitTempAlloca - Provide an initial value for the given alloca.
1603 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1605 /// CreateIRTemp - Create a temporary IR object of the given type, with
1606 /// appropriate alignment. This routine should only be used when an temporary
1607 /// value needs to be stored into an alloca (for example, to avoid explicit
1608 /// PHI construction), but the type is the IR type, not the type appropriate
1609 /// for storing in memory.
1610 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
1612 /// CreateMemTemp - Create a temporary memory object of the given type, with
1613 /// appropriate alignment.
1614 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
1616 /// CreateAggTemp - Create a temporary memory object for the given
1618 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
1619 CharUnits Alignment = getContext().getTypeAlignInChars(T);
1620 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1622 AggValueSlot::IsNotDestructed,
1623 AggValueSlot::DoesNotNeedGCBarriers,
1624 AggValueSlot::IsNotAliased);
1627 /// Emit a cast to void* in the appropriate address space.
1628 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1630 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1631 /// expression and compare the result against zero, returning an Int1Ty value.
1632 llvm::Value *EvaluateExprAsBool(const Expr *E);
1634 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1635 void EmitIgnoredExpr(const Expr *E);
1637 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1638 /// any type. The result is returned as an RValue struct. If this is an
1639 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1640 /// the result should be returned.
1642 /// \param ignoreResult True if the resulting value isn't used.
1643 RValue EmitAnyExpr(const Expr *E,
1644 AggValueSlot aggSlot = AggValueSlot::ignored(),
1645 bool ignoreResult = false);
1647 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1648 // or the value of the expression, depending on how va_list is defined.
1649 llvm::Value *EmitVAListRef(const Expr *E);
1651 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1652 /// always be accessible even if no aggregate location is provided.
1653 RValue EmitAnyExprToTemp(const Expr *E);
1655 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
1656 /// arbitrary expression into the given memory location.
1657 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
1658 Qualifiers Quals, bool IsInitializer);
1660 /// EmitExprAsInit - Emits the code necessary to initialize a
1661 /// location in memory with the given initializer.
1662 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
1663 LValue lvalue, bool capturedByInit);
1665 /// EmitAggregateCopy - Emit an aggrate assignment.
1667 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1668 /// This is required for correctness when assigning non-POD structures in C++.
1669 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1670 QualType EltTy, bool isVolatile=false,
1671 CharUnits Alignment = CharUnits::Zero()) {
1672 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, isVolatile, Alignment, true);
1675 /// EmitAggregateCopy - Emit an aggrate copy.
1677 /// \param isVolatile - True iff either the source or the destination is
1679 /// \param isAssignment - If false, allow padding to be copied. This often
1680 /// yields more efficient.
1681 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
1682 QualType EltTy, bool isVolatile=false,
1683 CharUnits Alignment = CharUnits::Zero(),
1684 bool isAssignment = false);
1686 /// StartBlock - Start new block named N. If insert block is a dummy block
1688 void StartBlock(const char *N);
1690 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
1691 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD) {
1692 return cast<llvm::Constant>(GetAddrOfLocalVar(BVD));
1695 /// GetAddrOfLocalVar - Return the address of a local variable.
1696 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1697 llvm::Value *Res = LocalDeclMap[VD];
1698 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1702 /// getOpaqueLValueMapping - Given an opaque value expression (which
1703 /// must be mapped to an l-value), return its mapping.
1704 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1705 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1707 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1708 it = OpaqueLValues.find(e);
1709 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1713 /// getOpaqueRValueMapping - Given an opaque value expression (which
1714 /// must be mapped to an r-value), return its mapping.
1715 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1716 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1718 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1719 it = OpaqueRValues.find(e);
1720 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
1724 /// getAccessedFieldNo - Given an encoded value and a result number, return
1725 /// the input field number being accessed.
1726 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1728 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
1729 llvm::BasicBlock *GetIndirectGotoBlock();
1731 /// EmitNullInitialization - Generate code to set a value of the given type to
1732 /// null, If the type contains data member pointers, they will be initialized
1733 /// to -1 in accordance with the Itanium C++ ABI.
1734 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
1736 // EmitVAArg - Generate code to get an argument from the passed in pointer
1737 // and update it accordingly. The return value is a pointer to the argument.
1738 // FIXME: We should be able to get rid of this method and use the va_arg
1739 // instruction in LLVM instead once it works well enough.
1740 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
1742 /// emitArrayLength - Compute the length of an array, even if it's a
1743 /// VLA, and drill down to the base element type.
1744 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1746 llvm::Value *&addr);
1748 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1749 /// the given variably-modified type and store them in the VLASizeMap.
1751 /// This function can be called with a null (unreachable) insert point.
1752 void EmitVariablyModifiedType(QualType Ty);
1754 /// getVLASize - Returns an LLVM value that corresponds to the size,
1755 /// in non-variably-sized elements, of a variable length array type,
1756 /// plus that largest non-variably-sized element type. Assumes that
1757 /// the type has already been emitted with EmitVariablyModifiedType.
1758 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1759 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
1761 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1762 /// generating code for an C++ member function.
1763 llvm::Value *LoadCXXThis() {
1764 assert(CXXThisValue && "no 'this' value for this function");
1765 return CXXThisValue;
1768 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1770 llvm::Value *LoadCXXVTT() {
1771 assert(CXXVTTValue && "no VTT value for this function");
1775 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
1776 /// complete class to the given direct base.
1778 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1779 const CXXRecordDecl *Derived,
1780 const CXXRecordDecl *Base,
1781 bool BaseIsVirtual);
1783 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1784 /// load of 'this' and returns address of the base class.
1785 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
1786 const CXXRecordDecl *Derived,
1787 CastExpr::path_const_iterator PathBegin,
1788 CastExpr::path_const_iterator PathEnd,
1789 bool NullCheckValue);
1791 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
1792 const CXXRecordDecl *Derived,
1793 CastExpr::path_const_iterator PathBegin,
1794 CastExpr::path_const_iterator PathEnd,
1795 bool NullCheckValue);
1797 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1798 const CXXRecordDecl *ClassDecl,
1799 const CXXRecordDecl *BaseClassDecl);
1801 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1802 CXXCtorType CtorType,
1803 const FunctionArgList &Args);
1804 // It's important not to confuse this and the previous function. Delegating
1805 // constructors are the C++0x feature. The constructor delegate optimization
1806 // is used to reduce duplication in the base and complete consturctors where
1807 // they are substantially the same.
1808 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1809 const FunctionArgList &Args);
1810 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1811 bool ForVirtualBase, llvm::Value *This,
1812 CallExpr::const_arg_iterator ArgBeg,
1813 CallExpr::const_arg_iterator ArgEnd);
1815 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1816 llvm::Value *This, llvm::Value *Src,
1817 CallExpr::const_arg_iterator ArgBeg,
1818 CallExpr::const_arg_iterator ArgEnd);
1820 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1821 const ConstantArrayType *ArrayTy,
1822 llvm::Value *ArrayPtr,
1823 CallExpr::const_arg_iterator ArgBeg,
1824 CallExpr::const_arg_iterator ArgEnd,
1825 bool ZeroInitialization = false);
1827 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1828 llvm::Value *NumElements,
1829 llvm::Value *ArrayPtr,
1830 CallExpr::const_arg_iterator ArgBeg,
1831 CallExpr::const_arg_iterator ArgEnd,
1832 bool ZeroInitialization = false);
1834 static Destroyer destroyCXXObject;
1836 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
1837 bool ForVirtualBase, llvm::Value *This);
1839 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1840 llvm::Value *NewPtr, llvm::Value *NumElements);
1842 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1845 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
1846 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
1848 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1851 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
1852 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
1853 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
1855 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
1856 void EmitStdInitializerListCleanup(llvm::Value *loc,
1857 const InitListExpr *init);
1859 /// \brief Situations in which we might emit a check for the suitability of a
1860 /// pointer or glvalue.
1861 enum TypeCheckKind {
1862 /// Checking the operand of a load. Must be suitably sized and aligned.
1864 /// Checking the destination of a store. Must be suitably sized and aligned.
1866 /// Checking the bound value in a reference binding. Must be suitably sized
1867 /// and aligned, but is not required to refer to an object (until the
1868 /// reference is used), per core issue 453.
1869 TCK_ReferenceBinding,
1870 /// Checking the object expression in a non-static data member access. Must
1871 /// be an object within its lifetime.
1873 /// Checking the 'this' pointer for a call to a non-static member function.
1874 /// Must be an object within its lifetime.
1876 /// Checking the 'this' pointer for a constructor call.
1880 /// \brief Emit a check that \p V is the address of storage of the
1881 /// appropriate size and alignment for an object of type \p Type.
1882 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
1883 QualType Type, CharUnits Alignment = CharUnits::Zero());
1885 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1886 bool isInc, bool isPre);
1887 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1888 bool isInc, bool isPre);
1889 //===--------------------------------------------------------------------===//
1890 // Declaration Emission
1891 //===--------------------------------------------------------------------===//
1893 /// EmitDecl - Emit a declaration.
1895 /// This function can be called with a null (unreachable) insert point.
1896 void EmitDecl(const Decl &D);
1898 /// EmitVarDecl - Emit a local variable declaration.
1900 /// This function can be called with a null (unreachable) insert point.
1901 void EmitVarDecl(const VarDecl &D);
1903 void EmitScalarInit(const Expr *init, const ValueDecl *D,
1904 LValue lvalue, bool capturedByInit);
1905 void EmitScalarInit(llvm::Value *init, LValue lvalue);
1907 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1908 llvm::Value *Address);
1910 /// EmitAutoVarDecl - Emit an auto variable declaration.
1912 /// This function can be called with a null (unreachable) insert point.
1913 void EmitAutoVarDecl(const VarDecl &D);
1915 class AutoVarEmission {
1916 friend class CodeGenFunction;
1918 const VarDecl *Variable;
1920 /// The alignment of the variable.
1921 CharUnits Alignment;
1923 /// The address of the alloca. Null if the variable was emitted
1924 /// as a global constant.
1925 llvm::Value *Address;
1927 llvm::Value *NRVOFlag;
1929 /// True if the variable is a __block variable.
1932 /// True if the variable is of aggregate type and has a constant
1934 bool IsConstantAggregate;
1937 AutoVarEmission(Invalid) : Variable(0) {}
1939 AutoVarEmission(const VarDecl &variable)
1940 : Variable(&variable), Address(0), NRVOFlag(0),
1941 IsByRef(false), IsConstantAggregate(false) {}
1943 bool wasEmittedAsGlobal() const { return Address == 0; }
1946 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1948 /// Returns the address of the object within this declaration.
1949 /// Note that this does not chase the forwarding pointer for
1951 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1952 if (!IsByRef) return Address;
1954 return CGF.Builder.CreateStructGEP(Address,
1955 CGF.getByRefValueLLVMField(Variable),
1956 Variable->getNameAsString());
1959 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1960 void EmitAutoVarInit(const AutoVarEmission &emission);
1961 void EmitAutoVarCleanups(const AutoVarEmission &emission);
1962 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1963 QualType::DestructionKind dtorKind);
1965 void EmitStaticVarDecl(const VarDecl &D,
1966 llvm::GlobalValue::LinkageTypes Linkage);
1968 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
1969 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
1971 /// protectFromPeepholes - Protect a value that we're intending to
1972 /// store to the side, but which will probably be used later, from
1973 /// aggressive peepholing optimizations that might delete it.
1975 /// Pass the result to unprotectFromPeepholes to declare that
1976 /// protection is no longer required.
1978 /// There's no particular reason why this shouldn't apply to
1979 /// l-values, it's just that no existing peepholes work on pointers.
1980 PeepholeProtection protectFromPeepholes(RValue rvalue);
1981 void unprotectFromPeepholes(PeepholeProtection protection);
1983 //===--------------------------------------------------------------------===//
1984 // Statement Emission
1985 //===--------------------------------------------------------------------===//
1987 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
1988 void EmitStopPoint(const Stmt *S);
1990 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1991 /// this function even if there is no current insertion point.
1993 /// This function may clear the current insertion point; callers should use
1994 /// EnsureInsertPoint if they wish to subsequently generate code without first
1995 /// calling EmitBlock, EmitBranch, or EmitStmt.
1996 void EmitStmt(const Stmt *S);
1998 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
1999 /// necessarily require an insertion point or debug information; typically
2000 /// because the statement amounts to a jump or a container of other
2003 /// \return True if the statement was handled.
2004 bool EmitSimpleStmt(const Stmt *S);
2006 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
2007 AggValueSlot AVS = AggValueSlot::ignored());
2009 /// EmitLabel - Emit the block for the given label. It is legal to call this
2010 /// function even if there is no current insertion point.
2011 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
2013 void EmitLabelStmt(const LabelStmt &S);
2014 void EmitAttributedStmt(const AttributedStmt &S);
2015 void EmitGotoStmt(const GotoStmt &S);
2016 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
2017 void EmitIfStmt(const IfStmt &S);
2018 void EmitWhileStmt(const WhileStmt &S);
2019 void EmitDoStmt(const DoStmt &S);
2020 void EmitForStmt(const ForStmt &S);
2021 void EmitReturnStmt(const ReturnStmt &S);
2022 void EmitDeclStmt(const DeclStmt &S);
2023 void EmitBreakStmt(const BreakStmt &S);
2024 void EmitContinueStmt(const ContinueStmt &S);
2025 void EmitSwitchStmt(const SwitchStmt &S);
2026 void EmitDefaultStmt(const DefaultStmt &S);
2027 void EmitCaseStmt(const CaseStmt &S);
2028 void EmitCaseStmtRange(const CaseStmt &S);
2029 void EmitAsmStmt(const AsmStmt &S);
2031 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
2032 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2033 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
2034 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
2035 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
2037 llvm::Constant *getUnwindResumeFn();
2038 llvm::Constant *getUnwindResumeOrRethrowFn();
2039 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2040 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2042 void EmitCXXTryStmt(const CXXTryStmt &S);
2043 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
2045 //===--------------------------------------------------------------------===//
2046 // LValue Expression Emission
2047 //===--------------------------------------------------------------------===//
2049 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2050 RValue GetUndefRValue(QualType Ty);
2052 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2053 /// and issue an ErrorUnsupported style diagnostic (using the
2055 RValue EmitUnsupportedRValue(const Expr *E,
2058 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2059 /// an ErrorUnsupported style diagnostic (using the provided Name).
2060 LValue EmitUnsupportedLValue(const Expr *E,
2063 /// EmitLValue - Emit code to compute a designator that specifies the location
2064 /// of the expression.
2066 /// This can return one of two things: a simple address or a bitfield
2067 /// reference. In either case, the LLVM Value* in the LValue structure is
2068 /// guaranteed to be an LLVM pointer type.
2070 /// If this returns a bitfield reference, nothing about the pointee type of
2071 /// the LLVM value is known: For example, it may not be a pointer to an
2074 /// If this returns a normal address, and if the lvalue's C type is fixed
2075 /// size, this method guarantees that the returned pointer type will point to
2076 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2077 /// variable length type, this is not possible.
2079 LValue EmitLValue(const Expr *E);
2081 /// \brief Same as EmitLValue but additionally we generate checking code to
2082 /// guard against undefined behavior. This is only suitable when we know
2083 /// that the address will be used to access the object.
2084 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
2086 /// EmitToMemory - Change a scalar value from its value
2087 /// representation to its in-memory representation.
2088 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2090 /// EmitFromMemory - Change a scalar value from its memory
2091 /// representation to its value representation.
2092 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2094 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2095 /// care to appropriately convert from the memory representation to
2096 /// the LLVM value representation.
2097 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
2098 unsigned Alignment, QualType Ty,
2099 llvm::MDNode *TBAAInfo = 0);
2101 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2102 /// care to appropriately convert from the memory representation to
2103 /// the LLVM value representation. The l-value must be a simple
2105 llvm::Value *EmitLoadOfScalar(LValue lvalue);
2107 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2108 /// care to appropriately convert from the memory representation to
2109 /// the LLVM value representation.
2110 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
2111 bool Volatile, unsigned Alignment, QualType Ty,
2112 llvm::MDNode *TBAAInfo = 0, bool isInit=false);
2114 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2115 /// care to appropriately convert from the memory representation to
2116 /// the LLVM value representation. The l-value must be a simple
2117 /// l-value. The isInit flag indicates whether this is an initialization.
2118 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2119 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
2121 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2122 /// this method emits the address of the lvalue, then loads the result as an
2123 /// rvalue, returning the rvalue.
2124 RValue EmitLoadOfLValue(LValue V);
2125 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2126 RValue EmitLoadOfBitfieldLValue(LValue LV);
2128 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2129 /// lvalue, where both are guaranteed to the have the same type, and that type
2131 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
2132 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
2134 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2135 /// EmitStoreThroughLValue.
2137 /// \param Result [out] - If non-null, this will be set to a Value* for the
2138 /// bit-field contents after the store, appropriate for use as the result of
2139 /// an assignment to the bit-field.
2140 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
2141 llvm::Value **Result=0);
2143 /// Emit an l-value for an assignment (simple or compound) of complex type.
2144 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
2145 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
2147 // Note: only available for agg return types
2148 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
2149 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
2150 // Note: only available for agg return types
2151 LValue EmitCallExprLValue(const CallExpr *E);
2152 // Note: only available for agg return types
2153 LValue EmitVAArgExprLValue(const VAArgExpr *E);
2154 LValue EmitDeclRefLValue(const DeclRefExpr *E);
2155 LValue EmitStringLiteralLValue(const StringLiteral *E);
2156 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
2157 LValue EmitPredefinedLValue(const PredefinedExpr *E);
2158 LValue EmitUnaryOpLValue(const UnaryOperator *E);
2159 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
2160 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
2161 LValue EmitMemberExpr(const MemberExpr *E);
2162 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
2163 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
2164 LValue EmitInitListLValue(const InitListExpr *E);
2165 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
2166 LValue EmitCastLValue(const CastExpr *E);
2167 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
2168 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
2169 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
2171 RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
2173 class ConstantEmission {
2174 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2175 ConstantEmission(llvm::Constant *C, bool isReference)
2176 : ValueAndIsReference(C, isReference) {}
2178 ConstantEmission() {}
2179 static ConstantEmission forReference(llvm::Constant *C) {
2180 return ConstantEmission(C, true);
2182 static ConstantEmission forValue(llvm::Constant *C) {
2183 return ConstantEmission(C, false);
2186 operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
2188 bool isReference() const { return ValueAndIsReference.getInt(); }
2189 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2190 assert(isReference());
2191 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2192 refExpr->getType());
2195 llvm::Constant *getValue() const {
2196 assert(!isReference());
2197 return ValueAndIsReference.getPointer();
2201 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
2203 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2204 AggValueSlot slot = AggValueSlot::ignored());
2205 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2207 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
2208 const ObjCIvarDecl *Ivar);
2209 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
2211 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2212 /// if the Field is a reference, this will return the address of the reference
2213 /// and not the address of the value stored in the reference.
2214 LValue EmitLValueForFieldInitialization(LValue Base,
2215 const FieldDecl* Field);
2217 LValue EmitLValueForIvar(QualType ObjectTy,
2218 llvm::Value* Base, const ObjCIvarDecl *Ivar,
2219 unsigned CVRQualifiers);
2221 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
2222 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
2223 LValue EmitLambdaLValue(const LambdaExpr *E);
2224 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
2225 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
2227 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
2228 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
2229 LValue EmitStmtExprLValue(const StmtExpr *E);
2230 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
2231 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
2232 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
2234 //===--------------------------------------------------------------------===//
2235 // Scalar Expression Emission
2236 //===--------------------------------------------------------------------===//
2238 /// EmitCall - Generate a call of the given function, expecting the given
2239 /// result type, and using the given argument list which specifies both the
2240 /// LLVM arguments and the types they were derived from.
2242 /// \param TargetDecl - If given, the decl of the function in a direct call;
2243 /// used to set attributes on the call (noreturn, etc.).
2244 RValue EmitCall(const CGFunctionInfo &FnInfo,
2245 llvm::Value *Callee,
2246 ReturnValueSlot ReturnValue,
2247 const CallArgList &Args,
2248 const Decl *TargetDecl = 0,
2249 llvm::Instruction **callOrInvoke = 0);
2251 RValue EmitCall(QualType FnType, llvm::Value *Callee,
2252 ReturnValueSlot ReturnValue,
2253 CallExpr::const_arg_iterator ArgBeg,
2254 CallExpr::const_arg_iterator ArgEnd,
2255 const Decl *TargetDecl = 0);
2256 RValue EmitCallExpr(const CallExpr *E,
2257 ReturnValueSlot ReturnValue = ReturnValueSlot());
2259 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
2260 ArrayRef<llvm::Value *> Args,
2261 const Twine &Name = "");
2262 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
2263 const Twine &Name = "");
2265 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
2267 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
2268 llvm::Value *This, llvm::Type *Ty);
2269 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2270 NestedNameSpecifier *Qual,
2273 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2275 const CXXRecordDecl *RD);
2277 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
2278 SourceLocation CallLoc,
2279 llvm::Value *Callee,
2280 ReturnValueSlot ReturnValue,
2283 CallExpr::const_arg_iterator ArgBeg,
2284 CallExpr::const_arg_iterator ArgEnd);
2285 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2286 ReturnValueSlot ReturnValue);
2287 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2288 ReturnValueSlot ReturnValue);
2290 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2291 const CXXMethodDecl *MD,
2293 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
2294 const CXXMethodDecl *MD,
2295 ReturnValueSlot ReturnValue);
2297 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2298 ReturnValueSlot ReturnValue);
2301 RValue EmitBuiltinExpr(const FunctionDecl *FD,
2302 unsigned BuiltinID, const CallExpr *E);
2304 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
2306 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2307 /// is unhandled by the current target.
2308 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2310 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2311 llvm::Value *EmitNeonCall(llvm::Function *F,
2312 SmallVectorImpl<llvm::Value*> &O,
2314 unsigned shift = 0, bool rightshift = false);
2315 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
2316 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
2317 bool negateForRightShift);
2319 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
2320 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2321 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2323 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
2324 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
2325 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
2326 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2327 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2328 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2329 const ObjCMethodDecl *MethodWithObjects);
2330 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
2331 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2332 ReturnValueSlot Return = ReturnValueSlot());
2334 /// Retrieves the default cleanup kind for an ARC cleanup.
2335 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2336 CleanupKind getARCCleanupKind() {
2337 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2338 ? NormalAndEHCleanup : NormalCleanup;
2342 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2343 void EmitARCDestroyWeak(llvm::Value *addr);
2344 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2345 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2346 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2348 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2349 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2350 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2351 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
2352 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
2354 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2356 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2357 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
2358 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
2359 void EmitARCDestroyStrong(llvm::Value *addr, bool precise);
2360 void EmitARCRelease(llvm::Value *value, bool precise);
2361 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2362 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2363 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2364 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2366 std::pair<LValue,llvm::Value*>
2367 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2368 std::pair<LValue,llvm::Value*>
2369 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2371 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2373 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2374 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2375 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2377 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
2378 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2379 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2381 static Destroyer destroyARCStrongImprecise;
2382 static Destroyer destroyARCStrongPrecise;
2383 static Destroyer destroyARCWeak;
2385 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2386 llvm::Value *EmitObjCAutoreleasePoolPush();
2387 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2388 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2389 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2391 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2392 /// expression. Will emit a temporary variable if E is not an LValue.
2393 RValue EmitReferenceBindingToExpr(const Expr* E,
2394 const NamedDecl *InitializedDecl);
2396 //===--------------------------------------------------------------------===//
2397 // Expression Emission
2398 //===--------------------------------------------------------------------===//
2400 // Expressions are broken into three classes: scalar, complex, aggregate.
2402 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2403 /// scalar type, returning the result.
2404 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
2406 /// EmitScalarConversion - Emit a conversion from the specified type to the
2407 /// specified destination type, both of which are LLVM scalar types.
2408 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2411 /// EmitComplexToScalarConversion - Emit a conversion from the specified
2412 /// complex type to the specified destination type, where the destination type
2413 /// is an LLVM scalar type.
2414 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2418 /// EmitAggExpr - Emit the computation of the specified expression
2419 /// of aggregate type. The result is computed into the given slot,
2420 /// which may be null to indicate that the value is not needed.
2421 void EmitAggExpr(const Expr *E, AggValueSlot AS);
2423 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2424 /// aggregate type into a temporary LValue.
2425 LValue EmitAggExprToLValue(const Expr *E);
2427 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2429 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
2432 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2433 /// make sure it survives garbage collection until this point.
2434 void EmitExtendGCLifetime(llvm::Value *object);
2436 /// EmitComplexExpr - Emit the computation of the specified expression of
2437 /// complex type, returning the result.
2438 ComplexPairTy EmitComplexExpr(const Expr *E,
2439 bool IgnoreReal = false,
2440 bool IgnoreImag = false);
2442 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
2443 /// of complex type, storing into the specified Value*.
2444 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
2445 bool DestIsVolatile);
2447 /// StoreComplexToAddr - Store a complex number into the specified address.
2448 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
2449 bool DestIsVolatile);
2450 /// LoadComplexFromAddr - Load a complex number from the specified address.
2451 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
2453 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2454 /// a static local variable.
2455 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2456 const char *Separator,
2457 llvm::GlobalValue::LinkageTypes Linkage);
2459 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2460 /// global variable that has already been created for it. If the initializer
2461 /// has a different type than GV does, this may free GV and return a different
2462 /// one. Otherwise it just returns GV.
2463 llvm::GlobalVariable *
2464 AddInitializerToStaticVarDecl(const VarDecl &D,
2465 llvm::GlobalVariable *GV);
2468 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2469 /// variable with global storage.
2470 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2473 /// Call atexit() with a function that passes the given argument to
2474 /// the given function.
2475 void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr);
2477 /// Emit code in this function to perform a guarded variable
2478 /// initialization. Guarded initializations are used when it's not
2479 /// possible to prove that an initialization will be done exactly
2480 /// once, e.g. with a static local variable or a static data member
2481 /// of a class template.
2482 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
2485 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2487 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2488 llvm::Constant **Decls,
2491 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
2493 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2494 const std::vector<std::pair<llvm::WeakVH,
2495 llvm::Constant*> > &DtorsAndObjects);
2497 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2499 llvm::GlobalVariable *Addr,
2502 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
2504 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
2507 void enterFullExpression(const ExprWithCleanups *E) {
2508 if (E->getNumObjects() == 0) return;
2509 enterNonTrivialFullExpression(E);
2511 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
2513 void EmitCXXThrowExpr(const CXXThrowExpr *E);
2515 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2517 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2519 //===--------------------------------------------------------------------===//
2520 // Annotations Emission
2521 //===--------------------------------------------------------------------===//
2523 /// Emit an annotation call (intrinsic or builtin).
2524 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2525 llvm::Value *AnnotatedVal,
2526 llvm::StringRef AnnotationStr,
2527 SourceLocation Location);
2529 /// Emit local annotations for the local variable V, declared by D.
2530 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2532 /// Emit field annotations for the given field & value. Returns the
2533 /// annotation result.
2534 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2536 //===--------------------------------------------------------------------===//
2538 //===--------------------------------------------------------------------===//
2540 /// ContainsLabel - Return true if the statement contains a label in it. If
2541 /// this statement is not executed normally, it not containing a label means
2542 /// that we can just remove the code.
2543 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
2545 /// containsBreak - Return true if the statement contains a break out of it.
2546 /// If the statement (recursively) contains a switch or loop with a break
2547 /// inside of it, this is fine.
2548 static bool containsBreak(const Stmt *S);
2550 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2551 /// to a constant, or if it does but contains a label, return false. If it
2552 /// constant folds return true and set the boolean result in Result.
2553 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
2555 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2556 /// to a constant, or if it does but contains a label, return false. If it
2557 /// constant folds return true and set the folded value.
2558 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
2560 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2561 /// if statement) to the specified blocks. Based on the condition, this might
2562 /// try to simplify the codegen of the conditional based on the branch.
2563 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
2564 llvm::BasicBlock *FalseBlock);
2566 /// \brief Emit a description of a type in a format suitable for passing to
2567 /// a runtime sanitizer handler.
2568 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2570 /// \brief Convert a value into a format suitable for passing to a runtime
2571 /// sanitizer handler.
2572 llvm::Value *EmitCheckValue(llvm::Value *V);
2574 /// \brief Emit a description of a source location in a format suitable for
2575 /// passing to a runtime sanitizer handler.
2576 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2578 /// \brief Create a basic block that will call a handler function in a
2579 /// sanitizer runtime with the provided arguments, and create a conditional
2581 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
2582 llvm::ArrayRef<llvm::Constant *> StaticArgs,
2583 llvm::ArrayRef<llvm::Value *> DynamicArgs,
2584 bool Recoverable = false);
2586 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2587 /// conditional branch to it, for the -ftrapv checks.
2588 void EmitTrapvCheck(llvm::Value *Checked);
2590 /// EmitCallArg - Emit a single call argument.
2591 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
2593 /// EmitDelegateCallArg - We are performing a delegate call; that
2594 /// is, the current function is delegating to another one. Produce
2595 /// a r-value suitable for passing the given parameter.
2596 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
2598 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2599 /// point operation, expressed as the maximum relative error in ulp.
2600 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
2603 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
2604 void EmitReturnOfRValue(RValue RV, QualType Ty);
2606 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2607 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2609 /// \param AI - The first function argument of the expansion.
2610 /// \return The argument following the last expanded function
2612 llvm::Function::arg_iterator
2613 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2614 llvm::Function::arg_iterator AI);
2616 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2617 /// Ty, into individual arguments on the provided vector \arg Args. See
2618 /// ABIArgInfo::Expand.
2619 void ExpandTypeToArgs(QualType Ty, RValue Src,
2620 SmallVector<llvm::Value*, 16> &Args,
2621 llvm::FunctionType *IRFuncTy);
2623 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
2624 const Expr *InputExpr, std::string &ConstraintStr);
2626 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
2627 LValue InputValue, QualType InputType,
2628 std::string &ConstraintStr);
2630 /// EmitCallArgs - Emit call arguments for a function.
2631 /// The CallArgTypeInfo parameter is used for iterating over the known
2632 /// argument types of the function being called.
2633 template<typename T>
2634 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
2635 CallExpr::const_arg_iterator ArgBeg,
2636 CallExpr::const_arg_iterator ArgEnd) {
2637 CallExpr::const_arg_iterator Arg = ArgBeg;
2639 // First, use the argument types that the type info knows about
2640 if (CallArgTypeInfo) {
2641 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2642 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
2643 assert(Arg != ArgEnd && "Running over edge of argument list!");
2644 QualType ArgType = *I;
2646 QualType ActualArgType = Arg->getType();
2647 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
2648 QualType ActualBaseType =
2649 ActualArgType->getAs<PointerType>()->getPointeeType();
2650 QualType ArgBaseType =
2651 ArgType->getAs<PointerType>()->getPointeeType();
2652 if (ArgBaseType->isVariableArrayType()) {
2653 if (const VariableArrayType *VAT =
2654 getContext().getAsVariableArrayType(ActualBaseType)) {
2655 if (!VAT->getSizeExpr())
2656 ActualArgType = ArgType;
2660 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
2662 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
2663 "type mismatch in call argument!");
2665 EmitCallArg(Args, *Arg, ArgType);
2668 // Either we've emitted all the call args, or we have a call to a
2669 // variadic function.
2670 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
2671 "Extra arguments in non-variadic function!");
2675 // If we still have any arguments, emit them using the type of the argument.
2676 for (; Arg != ArgEnd; ++Arg)
2677 EmitCallArg(Args, *Arg, Arg->getType());
2680 const TargetCodeGenInfo &getTargetHooks() const {
2681 return CGM.getTargetCodeGenInfo();
2684 void EmitDeclMetadata();
2686 CodeGenModule::ByrefHelpers *
2687 buildByrefHelpers(llvm::StructType &byrefType,
2688 const AutoVarEmission &emission);
2690 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
2692 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2693 /// value and compute our best estimate of the alignment of the pointee.
2694 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
2697 /// Helper class with most of the code for saving a value for a
2698 /// conditional expression cleanup.
2699 struct DominatingLLVMValue {
2700 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2702 /// Answer whether the given value needs extra work to be saved.
2703 static bool needsSaving(llvm::Value *value) {
2704 // If it's not an instruction, we don't need to save.
2705 if (!isa<llvm::Instruction>(value)) return false;
2707 // If it's an instruction in the entry block, we don't need to save.
2708 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2709 return (block != &block->getParent()->getEntryBlock());
2712 /// Try to save the given value.
2713 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2714 if (!needsSaving(value)) return saved_type(value, false);
2716 // Otherwise we need an alloca.
2717 llvm::Value *alloca =
2718 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2719 CGF.Builder.CreateStore(value, alloca);
2721 return saved_type(alloca, true);
2724 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2725 if (!value.getInt()) return value.getPointer();
2726 return CGF.Builder.CreateLoad(value.getPointer());
2730 /// A partial specialization of DominatingValue for llvm::Values that
2731 /// might be llvm::Instructions.
2732 template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2734 static type restore(CodeGenFunction &CGF, saved_type value) {
2735 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2739 /// A specialization of DominatingValue for RValue.
2740 template <> struct DominatingValue<RValue> {
2741 typedef RValue type;
2743 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2744 AggregateAddress, ComplexAddress };
2748 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2751 static bool needsSaving(RValue value);
2752 static saved_type save(CodeGenFunction &CGF, RValue value);
2753 RValue restore(CodeGenFunction &CGF);
2755 // implementations in CGExprCXX.cpp
2758 static bool needsSaving(type value) {
2759 return saved_type::needsSaving(value);
2761 static saved_type save(CodeGenFunction &CGF, type value) {
2762 return saved_type::save(CGF, value);
2764 static type restore(CodeGenFunction &CGF, saved_type value) {
2765 return value.restore(CGF);
2769 } // end namespace CodeGen
2770 } // end namespace clang