blob: 9a24426e75509595721c7c975902497104442058 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattnerc18bfbb2008-02-29 17:10:38 +000014#ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15#define CLANG_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Chris Lattner4bd55962008-03-30 23:03:07 +000017#include "clang/AST/Type.h"
Argyrios Kyrtzidis07052352008-09-10 02:36:38 +000018#include "clang/AST/ExprCXX.h"
Ted Kremenek08e17112008-06-17 02:43:46 +000019#include "clang/AST/ExprObjC.h"
Ken Dyck40775002010-01-11 17:06:35 +000020#include "clang/AST/CharUnits.h"
John McCall31168b02011-06-15 23:02:42 +000021#include "clang/Frontend/CodeGenOptions.h"
Peter Collingbourne0ff0b372011-01-13 18:57:25 +000022#include "clang/Basic/ABI.h"
Chris Lattner2739d2b2009-03-31 22:17:44 +000023#include "clang/Basic/TargetInfo.h"
Jay Foad5bd375a2011-07-15 08:37:34 +000024#include "llvm/ADT/ArrayRef.h"
Chris Lattner2739d2b2009-03-31 22:17:44 +000025#include "llvm/ADT/DenseMap.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/Support/ValueHandle.h"
Eric Christophera9d34972011-10-19 00:43:52 +000028#include "llvm/Support/Debug.h"
Owen Andersonae86c192009-07-13 04:10:07 +000029#include "CodeGenModule.h"
Daniel Dunbarcb463852008-11-01 01:53:16 +000030#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000031#include "CGDebugInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000032#include "CGValue.h"
33
Chris Lattnerbed31442007-05-28 01:07:47 +000034namespace llvm {
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000035 class BasicBlock;
Benjamin Kramer9cd050a2009-08-11 17:46:57 +000036 class LLVMContext;
David Chisnall9eecafa2010-05-01 11:15:56 +000037 class MDNode;
Chris Lattnerbed31442007-05-28 01:07:47 +000038 class Module;
Daniel Dunbar2efd5382008-09-30 01:06:03 +000039 class SwitchInst;
Daniel Dunbarb5aacc22009-10-19 01:21:05 +000040 class Twine;
Daniel Dunbar9b1335e2008-11-19 09:36:46 +000041 class Value;
John McCallbd309292010-07-06 01:34:17 +000042 class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000043}
44
Chris Lattnerbed31442007-05-28 01:07:47 +000045namespace clang {
46 class ASTContext;
John McCall08ef4662011-11-10 08:15:53 +000047 class BlockDecl;
Anders Carlsson0a637412009-05-29 21:03:38 +000048 class CXXDestructorDecl;
Richard Smith02e85f32011-04-14 22:09:26 +000049 class CXXForRangeStmt;
Anders Carlsson52d78a52009-09-27 18:58:34 +000050 class CXXTryStmt;
Chris Lattner84915fa2007-06-02 04:16:21 +000051 class Decl;
Chris Lattnerc8e630e2011-02-17 07:39:24 +000052 class LabelDecl;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000053 class EnumConstantDecl;
Chris Lattnerbed31442007-05-28 01:07:47 +000054 class FunctionDecl;
Douglas Gregordeaad8c2009-02-26 23:50:07 +000055 class FunctionProtoType;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000056 class LabelStmt;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +000057 class ObjCContainerDecl;
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +000058 class ObjCInterfaceDecl;
59 class ObjCIvarDecl;
Chris Lattner4bd55962008-03-30 23:03:07 +000060 class ObjCMethodDecl;
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +000061 class ObjCImplementationDecl;
Daniel Dunbar89654ee2008-08-26 08:29:31 +000062 class ObjCPropertyImplDecl;
Chris Lattner2ccb73b2007-06-16 00:16:26 +000063 class TargetInfo;
John McCalld4f4b7f2010-03-03 04:15:11 +000064 class TargetCodeGenInfo;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000065 class VarDecl;
Chris Lattnerf0b64d72009-04-26 01:32:48 +000066 class ObjCForCollectionStmt;
67 class ObjCAtTryStmt;
68 class ObjCAtThrowStmt;
69 class ObjCAtSynchronizedStmt;
John McCall31168b02011-06-15 23:02:42 +000070 class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000071
Chris Lattnerbed31442007-05-28 01:07:47 +000072namespace CodeGen {
Devang Patel3e11cce2007-10-23 02:10:49 +000073 class CodeGenTypes;
Daniel Dunbar7633cbf2009-02-02 21:43:58 +000074 class CGFunctionInfo;
Mike Stumpfc496822009-02-08 23:14:22 +000075 class CGRecordLayout;
John McCall9d42f0f2010-05-21 04:11:14 +000076 class CGBlockInfo;
John McCall5d865c322010-08-31 07:33:07 +000077 class CGCXXABI;
John McCallad7c5c12011-02-08 08:22:06 +000078 class BlockFlags;
79 class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000080
John McCallbd309292010-07-06 01:34:17 +000081/// 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.
87struct BranchFixup {
John McCallad5d61e2010-07-23 21:56:41 +000088 /// 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;
John McCallbd309292010-07-06 01:34:17 +000092
John McCallad5d61e2010-07-23 21:56:41 +000093 /// The ultimate destination of the branch.
John McCallbd309292010-07-06 01:34:17 +000094 ///
95 /// This can be set to null to indicate that this fixup was
96 /// successfully resolved.
97 llvm::BasicBlock *Destination;
98
John McCallad5d61e2010-07-23 21:56:41 +000099 /// The destination index value.
100 unsigned DestinationIndex;
101
102 /// The initial branch of the fixup.
103 llvm::BranchInst *InitialBranch;
John McCallbd309292010-07-06 01:34:17 +0000104};
105
John McCallcb5f77f2011-01-28 10:53:53 +0000106template <class T> struct InvariantValue {
John McCallce1de612011-01-26 04:00:11 +0000107 typedef T type;
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; }
112};
John McCallcb5f77f2011-01-28 10:53:53 +0000113
114/// A metaprogramming class for ensuring that a value will dominate an
115/// arbitrary position in a function.
116template <class T> struct DominatingValue : InvariantValue<T> {};
117
118template <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>
122struct DominatingPointer;
123template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
124// template <class T> struct DominatingPointer<T,true> at end of file
125
126template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
John McCallce1de612011-01-26 04:00:11 +0000127
John McCall612942d2010-08-13 21:20:51 +0000128enum CleanupKind {
129 EHCleanup = 0x1,
130 NormalCleanup = 0x2,
131 NormalAndEHCleanup = EHCleanup | NormalCleanup,
132
133 InactiveCleanup = 0x4,
134 InactiveEHCleanup = EHCleanup | InactiveCleanup,
135 InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
136 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
137};
John McCall2b7fc382010-07-13 20:32:21 +0000138
John McCallbd309292010-07-06 01:34:17 +0000139/// A stack of scopes which respond to exceptions, including cleanups
140/// and catch blocks.
141class EHScopeStack {
142public:
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;
147
148 /// Offset from StartOfData to EndOfBuffer.
149 ptrdiff_t Size;
150
151 stable_iterator(ptrdiff_t Size) : Size(Size) {}
152
153 public:
154 static stable_iterator invalid() { return stable_iterator(-1); }
155 stable_iterator() : Size(-1) {}
156
157 bool isValid() const { return Size >= 0; }
158
John McCall324277852010-08-14 07:46:19 +0000159 /// Returns true if this scope encloses I.
160 /// Returns false if I is invalid.
161 /// This scope must be valid.
John McCallad5d61e2010-07-23 21:56:41 +0000162 bool encloses(stable_iterator I) const { return Size <= I.Size; }
John McCall324277852010-08-14 07:46:19 +0000163
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.
John McCallad5d61e2010-07-23 21:56:41 +0000168 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
John McCall8f510412010-07-21 00:40:03 +0000169
John McCallbd309292010-07-06 01:34:17 +0000170 friend bool operator==(stable_iterator A, stable_iterator B) {
171 return A.Size == B.Size;
172 }
173 friend bool operator!=(stable_iterator A, stable_iterator B) {
174 return A.Size != B.Size;
175 }
176 };
177
John McCallcda666c2010-07-21 07:22:38 +0000178 /// 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
181 /// around.
John McCall2b7fc382010-07-13 20:32:21 +0000182 ///
John McCallcda666c2010-07-21 07:22:38 +0000183 /// Cleanup implementations should generally be declared in an
John McCall2b7fc382010-07-13 20:32:21 +0000184 /// anonymous namespace.
John McCallcda666c2010-07-21 07:22:38 +0000185 class Cleanup {
John McCall5fcf8da2011-07-12 00:15:30 +0000186 // Anchor the construction vtable.
187 virtual void anchor();
John McCall2b7fc382010-07-13 20:32:21 +0000188 public:
John McCall30317fd2011-07-12 20:27:29 +0000189 /// Generation flags.
190 class Flags {
191 enum {
192 F_IsForEH = 0x1,
193 F_IsNormalCleanupKind = 0x2,
194 F_IsEHCleanupKind = 0x4
195 };
196 unsigned flags;
197
198 public:
199 Flags() : flags(0) {}
200
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; }
205
206 bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; }
207 void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; }
208
209 /// isEHCleanupKind - true if the cleanup was pushed as an EH
210 /// cleanup.
211 bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; }
212 void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; }
213 };
214
John McCall5fcf8da2011-07-12 00:15:30 +0000215 // 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() {}
John McCall11e577b2010-07-13 23:19:49 +0000219
John McCall2b7fc382010-07-13 20:32:21 +0000220 /// 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.
224 ///
225 // \param IsForEHCleanup true if this is for an EH cleanup, false
226 /// if for a normal cleanup.
John McCall30317fd2011-07-12 20:27:29 +0000227 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
John McCall2b7fc382010-07-13 20:32:21 +0000228 };
229
John McCallce1de612011-01-26 04:00:11 +0000230 /// ConditionalCleanupN stores the saved form of its N parameters,
231 /// then restores them and performs the cleanup.
John McCalle4df6c82011-01-28 08:37:24 +0000232 template <class T, class A0>
233 class ConditionalCleanup1 : public Cleanup {
John McCallcb5f77f2011-01-28 10:53:53 +0000234 typedef typename DominatingValue<A0>::saved_type A0_saved;
John McCalle4df6c82011-01-28 08:37:24 +0000235 A0_saved a0_saved;
236
John McCall30317fd2011-07-12 20:27:29 +0000237 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallcb5f77f2011-01-28 10:53:53 +0000238 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
John McCall30317fd2011-07-12 20:27:29 +0000239 T(a0).Emit(CGF, flags);
John McCalle4df6c82011-01-28 08:37:24 +0000240 }
241
242 public:
243 ConditionalCleanup1(A0_saved a0)
244 : a0_saved(a0) {}
245 };
246
John McCallce1de612011-01-26 04:00:11 +0000247 template <class T, class A0, class A1>
John McCalle4df6c82011-01-28 08:37:24 +0000248 class ConditionalCleanup2 : public Cleanup {
John McCallcb5f77f2011-01-28 10:53:53 +0000249 typedef typename DominatingValue<A0>::saved_type A0_saved;
250 typedef typename DominatingValue<A1>::saved_type A1_saved;
John McCallf256eb52011-01-26 19:15:39 +0000251 A0_saved a0_saved;
252 A1_saved a1_saved;
John McCallce1de612011-01-26 04:00:11 +0000253
John McCall30317fd2011-07-12 20:27:29 +0000254 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallcb5f77f2011-01-28 10:53:53 +0000255 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
256 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
John McCall30317fd2011-07-12 20:27:29 +0000257 T(a0, a1).Emit(CGF, flags);
John McCallce1de612011-01-26 04:00:11 +0000258 }
259
260 public:
John McCalle4df6c82011-01-28 08:37:24 +0000261 ConditionalCleanup2(A0_saved a0, A1_saved a1)
262 : a0_saved(a0), a1_saved(a1) {}
John McCallce1de612011-01-26 04:00:11 +0000263 };
264
Douglas Gregor58df5092011-06-22 16:12:01 +0000265 template <class T, class A0, class A1, class A2>
266 class ConditionalCleanup3 : public Cleanup {
267 typedef typename DominatingValue<A0>::saved_type A0_saved;
268 typedef typename DominatingValue<A1>::saved_type A1_saved;
269 typedef typename DominatingValue<A2>::saved_type A2_saved;
270 A0_saved a0_saved;
271 A1_saved a1_saved;
272 A2_saved a2_saved;
273
John McCall30317fd2011-07-12 20:27:29 +0000274 void Emit(CodeGenFunction &CGF, Flags flags) {
Douglas Gregor58df5092011-06-22 16:12:01 +0000275 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
276 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
277 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
John McCall30317fd2011-07-12 20:27:29 +0000278 T(a0, a1, a2).Emit(CGF, flags);
Douglas Gregor58df5092011-06-22 16:12:01 +0000279 }
280
281 public:
282 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
John McCall5fcf8da2011-07-12 00:15:30 +0000283 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
Douglas Gregor58df5092011-06-22 16:12:01 +0000284 };
285
John McCall4bd0fb12011-07-12 16:41:08 +0000286 template <class T, class A0, class A1, class A2, class A3>
287 class ConditionalCleanup4 : public Cleanup {
288 typedef typename DominatingValue<A0>::saved_type A0_saved;
289 typedef typename DominatingValue<A1>::saved_type A1_saved;
290 typedef typename DominatingValue<A2>::saved_type A2_saved;
291 typedef typename DominatingValue<A3>::saved_type A3_saved;
292 A0_saved a0_saved;
293 A1_saved a1_saved;
294 A2_saved a2_saved;
295 A3_saved a3_saved;
296
John McCall30317fd2011-07-12 20:27:29 +0000297 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall4bd0fb12011-07-12 16:41:08 +0000298 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
299 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
300 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
301 A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved);
John McCall30317fd2011-07-12 20:27:29 +0000302 T(a0, a1, a2, a3).Emit(CGF, flags);
John McCall4bd0fb12011-07-12 16:41:08 +0000303 }
304
305 public:
306 ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3)
307 : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {}
308 };
309
John McCallbd309292010-07-06 01:34:17 +0000310private:
311 // The implementation for this class is in CGException.h and
312 // CGException.cpp; the definition is here because it's used as a
313 // member of CodeGenFunction.
314
315 /// The start of the scope-stack buffer, i.e. the allocated pointer
316 /// for the buffer. All of these pointers are either simultaneously
317 /// null or simultaneously valid.
318 char *StartOfBuffer;
319
320 /// The end of the buffer.
321 char *EndOfBuffer;
322
323 /// The first valid entry in the buffer.
324 char *StartOfData;
325
326 /// The innermost normal cleanup on the stack.
327 stable_iterator InnermostNormalCleanup;
328
John McCall8e4c74b2011-08-11 02:22:43 +0000329 /// The innermost EH scope on the stack.
330 stable_iterator InnermostEHScope;
John McCallad5d61e2010-07-23 21:56:41 +0000331
John McCallbd309292010-07-06 01:34:17 +0000332 /// The current set of branch fixups. A branch fixup is a jump to
333 /// an as-yet unemitted label, i.e. a label for which we don't yet
334 /// know the EH stack depth. Whenever we pop a cleanup, we have
335 /// to thread all the current branch fixups through it.
336 ///
337 /// Fixups are recorded as the Use of the respective branch or
338 /// switch statement. The use points to the final destination.
339 /// When popping out of a cleanup, these uses are threaded through
340 /// the cleanup and adjusted to point to the new cleanup.
341 ///
342 /// Note that branches are allowed to jump into protected scopes
343 /// in certain situations; e.g. the following code is legal:
344 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
345 /// goto foo;
346 /// A a;
347 /// foo:
348 /// bar();
Chris Lattner01cf8db2011-07-20 06:58:45 +0000349 SmallVector<BranchFixup, 8> BranchFixups;
John McCallbd309292010-07-06 01:34:17 +0000350
351 char *allocate(size_t Size);
352
John McCallcda666c2010-07-21 07:22:38 +0000353 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCall2b7fc382010-07-13 20:32:21 +0000354
John McCallbd309292010-07-06 01:34:17 +0000355public:
356 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
357 InnermostNormalCleanup(stable_end()),
John McCall8e4c74b2011-08-11 02:22:43 +0000358 InnermostEHScope(stable_end()) {}
John McCallbd309292010-07-06 01:34:17 +0000359 ~EHScopeStack() { delete[] StartOfBuffer; }
360
John McCall2b7fc382010-07-13 20:32:21 +0000361 // Variadic templates would make this not terrible.
362
363 /// Push a lazily-created cleanup on the stack.
John McCall5c08ab92010-07-13 22:12:14 +0000364 template <class T>
John McCallcda666c2010-07-21 07:22:38 +0000365 void pushCleanup(CleanupKind Kind) {
366 void *Buffer = pushCleanup(Kind, sizeof(T));
367 Cleanup *Obj = new(Buffer) T();
John McCall5c08ab92010-07-13 22:12:14 +0000368 (void) Obj;
369 }
370
371 /// Push a lazily-created cleanup on the stack.
372 template <class T, class A0>
John McCallcda666c2010-07-21 07:22:38 +0000373 void pushCleanup(CleanupKind Kind, A0 a0) {
374 void *Buffer = pushCleanup(Kind, sizeof(T));
375 Cleanup *Obj = new(Buffer) T(a0);
John McCall5c08ab92010-07-13 22:12:14 +0000376 (void) Obj;
377 }
378
379 /// Push a lazily-created cleanup on the stack.
John McCall2b7fc382010-07-13 20:32:21 +0000380 template <class T, class A0, class A1>
John McCallcda666c2010-07-21 07:22:38 +0000381 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
382 void *Buffer = pushCleanup(Kind, sizeof(T));
383 Cleanup *Obj = new(Buffer) T(a0, a1);
John McCall2b7fc382010-07-13 20:32:21 +0000384 (void) Obj;
385 }
386
387 /// Push a lazily-created cleanup on the stack.
388 template <class T, class A0, class A1, class A2>
John McCallcda666c2010-07-21 07:22:38 +0000389 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
390 void *Buffer = pushCleanup(Kind, sizeof(T));
391 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
John McCall2b7fc382010-07-13 20:32:21 +0000392 (void) Obj;
393 }
394
395 /// Push a lazily-created cleanup on the stack.
396 template <class T, class A0, class A1, class A2, class A3>
John McCallcda666c2010-07-21 07:22:38 +0000397 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
398 void *Buffer = pushCleanup(Kind, sizeof(T));
399 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
John McCall2b7fc382010-07-13 20:32:21 +0000400 (void) Obj;
401 }
402
John McCall906da4b2010-07-21 05:47:49 +0000403 /// Push a lazily-created cleanup on the stack.
404 template <class T, class A0, class A1, class A2, class A3, class A4>
John McCallcda666c2010-07-21 07:22:38 +0000405 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
406 void *Buffer = pushCleanup(Kind, sizeof(T));
407 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
John McCall906da4b2010-07-21 05:47:49 +0000408 (void) Obj;
409 }
410
John McCall824c2f52010-09-14 07:57:04 +0000411 // Feel free to add more variants of the following:
412
413 /// Push a cleanup with non-constant storage requirements on the
414 /// stack. The cleanup type must provide an additional static method:
415 /// static size_t getExtraSize(size_t);
416 /// The argument to this method will be the value N, which will also
417 /// be passed as the first argument to the constructor.
418 ///
419 /// The data stored in the extra storage must obey the same
420 /// restrictions as normal cleanup member data.
421 ///
422 /// The pointer returned from this method is valid until the cleanup
423 /// stack is modified.
424 template <class T, class A0, class A1, class A2>
425 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
426 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
427 return new (Buffer) T(N, a0, a1, a2);
428 }
429
John McCall8e4c74b2011-08-11 02:22:43 +0000430 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp.
John McCallbd309292010-07-06 01:34:17 +0000431 void popCleanup();
432
433 /// Push a set of catch handlers on the stack. The catch is
434 /// uninitialized and will need to have the given number of handlers
435 /// set on it.
436 class EHCatchScope *pushCatch(unsigned NumHandlers);
437
John McCall8e4c74b2011-08-11 02:22:43 +0000438 /// Pops a catch scope off the stack. This is private to CGException.cpp.
John McCallbd309292010-07-06 01:34:17 +0000439 void popCatch();
440
441 /// Push an exceptions filter on the stack.
442 class EHFilterScope *pushFilter(unsigned NumFilters);
443
444 /// Pops an exceptions filter off the stack.
445 void popFilter();
446
447 /// Push a terminate handler on the stack.
448 void pushTerminate();
449
450 /// Pops a terminate handler off the stack.
451 void popTerminate();
452
453 /// Determines whether the exception-scopes stack is empty.
454 bool empty() const { return StartOfData == EndOfBuffer; }
455
456 bool requiresLandingPad() const {
John McCall8e4c74b2011-08-11 02:22:43 +0000457 return InnermostEHScope != stable_end();
John McCallbd309292010-07-06 01:34:17 +0000458 }
459
460 /// Determines whether there are any normal cleanups on the stack.
461 bool hasNormalCleanups() const {
462 return InnermostNormalCleanup != stable_end();
463 }
464
465 /// Returns the innermost normal cleanup on the stack, or
466 /// stable_end() if there are no normal cleanups.
467 stable_iterator getInnermostNormalCleanup() const {
468 return InnermostNormalCleanup;
469 }
John McCall8e4c74b2011-08-11 02:22:43 +0000470 stable_iterator getInnermostActiveNormalCleanup() const;
John McCallbd309292010-07-06 01:34:17 +0000471
John McCall8e4c74b2011-08-11 02:22:43 +0000472 stable_iterator getInnermostEHScope() const {
473 return InnermostEHScope;
John McCallbd309292010-07-06 01:34:17 +0000474 }
475
John McCall8e4c74b2011-08-11 02:22:43 +0000476 stable_iterator getInnermostActiveEHScope() const;
John McCallbd309292010-07-06 01:34:17 +0000477
478 /// An unstable reference to a scope-stack depth. Invalidated by
479 /// pushes but not pops.
480 class iterator;
481
482 /// Returns an iterator pointing to the innermost EH scope.
483 iterator begin() const;
484
485 /// Returns an iterator pointing to the outermost EH scope.
486 iterator end() const;
487
488 /// Create a stable reference to the top of the EH stack. The
489 /// returned reference is valid until that scope is popped off the
490 /// stack.
491 stable_iterator stable_begin() const {
492 return stable_iterator(EndOfBuffer - StartOfData);
493 }
494
495 /// Create a stable reference to the bottom of the EH stack.
496 static stable_iterator stable_end() {
497 return stable_iterator(0);
498 }
499
500 /// Translates an iterator into a stable_iterator.
501 stable_iterator stabilize(iterator it) const;
502
John McCallbd309292010-07-06 01:34:17 +0000503 /// Turn a stable reference to a scope depth into a unstable pointer
504 /// to the EH stack.
505 iterator find(stable_iterator save) const;
506
507 /// Removes the cleanup pointed to by the given stable_iterator.
508 void removeCleanup(stable_iterator save);
509
510 /// Add a branch fixup to the current cleanup scope.
511 BranchFixup &addBranchFixup() {
512 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
513 BranchFixups.push_back(BranchFixup());
514 return BranchFixups.back();
515 }
516
517 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
518 BranchFixup &getBranchFixup(unsigned I) {
519 assert(I < getNumBranchFixups());
520 return BranchFixups[I];
521 }
522
John McCallad5d61e2010-07-23 21:56:41 +0000523 /// Pops lazily-removed fixups from the end of the list. This
524 /// should only be called by procedures which have just popped a
525 /// cleanup or resolved one or more fixups.
526 void popNullFixups();
527
528 /// Clears the branch-fixups list. This should only be called by
John McCallf09d96f2010-09-18 02:24:39 +0000529 /// ResolveAllBranchFixups.
John McCallad5d61e2010-07-23 21:56:41 +0000530 void clearFixups() { BranchFixups.clear(); }
John McCallbd309292010-07-06 01:34:17 +0000531};
532
Chris Lattnerbed31442007-05-28 01:07:47 +0000533/// CodeGenFunction - This class organizes the per-function state that is used
534/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000535class CodeGenFunction : public CodeGenTypeCache {
Anders Carlsson729a8202009-02-24 04:21:31 +0000536 CodeGenFunction(const CodeGenFunction&); // DO NOT IMPLEMENT
537 void operator=(const CodeGenFunction&); // DO NOT IMPLEMENT
John McCall5d865c322010-08-31 07:33:07 +0000538
539 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000540public:
John McCallad5d61e2010-07-23 21:56:41 +0000541 /// A jump destination is an abstract label, branching to which may
542 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000543 struct JumpDest {
John McCallad5d61e2010-07-23 21:56:41 +0000544 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
545 JumpDest(llvm::BasicBlock *Block,
546 EHScopeStack::stable_iterator Depth,
547 unsigned Index)
548 : Block(Block), ScopeDepth(Depth), Index(Index) {}
549
550 bool isValid() const { return Block != 0; }
551 llvm::BasicBlock *getBlock() const { return Block; }
552 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
553 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000554
John McCallad5d61e2010-07-23 21:56:41 +0000555 private:
John McCallbd309292010-07-06 01:34:17 +0000556 llvm::BasicBlock *Block;
557 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000558 unsigned Index;
559 };
560
Chris Lattnerbed31442007-05-28 01:07:47 +0000561 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000562 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000563
Chris Lattner96d72562007-08-21 16:57:55 +0000564 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000565 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000566
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000567 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
568 /// This excludes BlockDecls.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000569 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000570 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
571 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000572 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000573 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000574 llvm::Function *CurFn;
575
Mike Stumpbee78dd2009-12-04 23:26:17 +0000576 /// CurGD - The GlobalDecl for the current function being compiled.
577 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000578
John McCall31168b02011-06-15 23:02:42 +0000579 /// PrologueCleanupDepth - The cleanup depth enclosing all the
580 /// cleanups associated with the parameters.
581 EHScopeStack::stable_iterator PrologueCleanupDepth;
582
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000583 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000584 JumpDest ReturnBlock;
585
Mike Stumpfc496822009-02-08 23:14:22 +0000586 /// ReturnValue - The temporary alloca to hold the return value. This is null
587 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000588 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000589
Chris Lattner03df1222007-06-02 04:53:11 +0000590 /// AllocaInsertPoint - This is an instruction in the entry block before which
591 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000592 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000593
Mike Stumpd9546382009-12-12 01:27:46 +0000594 bool CatchUndefined;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000595
John McCall31168b02011-06-15 23:02:42 +0000596 /// In ARC, whether we should autorelease the return value.
597 bool AutoreleaseResult;
598
John McCallad7c5c12011-02-08 08:22:06 +0000599 const CodeGen::CGBlockInfo *BlockInfo;
600 llvm::Value *BlockPointer;
601
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000602 /// \brief A mapping from NRVO variables to the flags used to indicate
603 /// when the NRVO has been applied to this variable.
604 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000605
John McCallbd309292010-07-06 01:34:17 +0000606 EHScopeStack EHStack;
607
John McCallad5d61e2010-07-23 21:56:41 +0000608 /// i32s containing the indexes of the cleanup destinations.
609 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000610
611 unsigned NextCleanupDestIndex;
612
John McCall08ef4662011-11-10 08:15:53 +0000613 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
614 CGBlockInfo *FirstBlockInfo;
615
John McCall8e4c74b2011-08-11 02:22:43 +0000616 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
617 llvm::BasicBlock *EHResumeBlock;
618
Bill Wendlingf0724e82011-09-19 20:31:14 +0000619 /// The exception slot. All landing pads write the current exception pointer
620 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000621 llvm::Value *ExceptionSlot;
622
Bill Wendlingf0724e82011-09-19 20:31:14 +0000623 /// The selector slot. Under the MandatoryCleanup model, all landing pads
624 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000625 llvm::AllocaInst *EHSelectorSlot;
626
John McCallbd309292010-07-06 01:34:17 +0000627 /// Emits a landing pad for the current EH stack.
628 llvm::BasicBlock *EmitLandingPad();
629
630 llvm::BasicBlock *getInvokeDestImpl();
631
John McCallce1de612011-01-26 04:00:11 +0000632 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000633 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
634 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000635 }
636
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000637public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000638 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
639 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000640 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000641
John McCall6b0feb72011-06-22 02:32:12 +0000642 /// A class controlling the emission of a finally block.
643 class FinallyInfo {
644 /// Where the catchall's edge through the cleanup should go.
645 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000646
John McCall6b0feb72011-06-22 02:32:12 +0000647 /// A function to call to enter the catch.
648 llvm::Constant *BeginCatchFn;
649
650 /// An i1 variable indicating whether or not the @finally is
651 /// running for an exception.
652 llvm::AllocaInst *ForEHVar;
653
654 /// An i8* variable into which the exception pointer to rethrow
655 /// has been saved.
656 llvm::AllocaInst *SavedExnVar;
657
658 public:
659 void enter(CodeGenFunction &CGF, const Stmt *Finally,
660 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
661 llvm::Constant *rethrowFn);
662 void exit(CodeGenFunction &CGF);
663 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000664
John McCallce1de612011-01-26 04:00:11 +0000665 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
666 /// current full-expression. Safe against the possibility that
667 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000668 template <class T, class A0>
669 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
670 // If we're not in a conditional branch, or if none of the
671 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000672 if (!isInConditionalBranch())
673 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000674
John McCallcb5f77f2011-01-28 10:53:53 +0000675 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000676
677 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
678 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
679 initFullExprCleanup();
680 }
681
682 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
683 /// current full-expression. Safe against the possibility that
684 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000685 template <class T, class A0, class A1>
686 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
687 // If we're not in a conditional branch, or if none of the
688 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000689 if (!isInConditionalBranch())
690 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000691
John McCallcb5f77f2011-01-28 10:53:53 +0000692 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
693 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000694
695 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000696 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
697 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000698 }
699
Douglas Gregor58df5092011-06-22 16:12:01 +0000700 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
701 /// current full-expression. Safe against the possibility that
702 /// we're currently inside a conditionally-evaluated expression.
703 template <class T, class A0, class A1, class A2>
704 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
705 // If we're not in a conditional branch, or if none of the
706 // arguments requires saving, then use the unconditional cleanup.
707 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000708 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000709 }
710
711 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
712 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
713 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
714
715 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
716 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
717 initFullExprCleanup();
718 }
719
John McCall4bd0fb12011-07-12 16:41:08 +0000720 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
721 /// current full-expression. Safe against the possibility that
722 /// we're currently inside a conditionally-evaluated expression.
723 template <class T, class A0, class A1, class A2, class A3>
724 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
725 // If we're not in a conditional branch, or if none of the
726 // arguments requires saving, then use the unconditional cleanup.
727 if (!isInConditionalBranch()) {
728 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
729 }
730
731 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
732 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
733 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
734 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
735
736 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
737 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
738 a2_saved, a3_saved);
739 initFullExprCleanup();
740 }
741
John McCallf4beacd2011-11-10 10:43:54 +0000742 /// Set up the last cleaup that was pushed as a conditional
743 /// full-expression cleanup.
744 void initFullExprCleanup();
745
John McCallbd309292010-07-06 01:34:17 +0000746 /// PushDestructorCleanup - Push a cleanup to call the
747 /// complete-object destructor of an object of the given type at the
748 /// given address. Does nothing if T is not a C++ class type with a
749 /// non-trivial destructor.
750 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
751
John McCall8680f872010-07-21 06:29:51 +0000752 /// PushDestructorCleanup - Push a cleanup to call the
753 /// complete-object variant of the given destructor on the object at
754 /// the given address.
755 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
756 llvm::Value *Addr);
757
John McCallbd309292010-07-06 01:34:17 +0000758 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
759 /// process all branch fixups.
John McCallad5d61e2010-07-23 21:56:41 +0000760 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000761
John McCall824c2f52010-09-14 07:57:04 +0000762 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
763 /// The block cannot be reactivated. Pops it if it's the top of the
764 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000765 ///
766 /// \param DominatingIP - An instruction which is known to
767 /// dominate the current IP (if set) and which lies along
768 /// all paths of execution between the current IP and the
769 /// the point at which the cleanup comes into scope.
770 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
771 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000772
773 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
774 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000775 ///
776 /// \param DominatingIP - An instruction which is known to
777 /// dominate the current IP (if set) and which lies along
778 /// all paths of execution between the current IP and the
779 /// the point at which the cleanup comes into scope.
780 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
781 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000782
John McCallbd309292010-07-06 01:34:17 +0000783 /// \brief Enters a new scope for capturing cleanups, all of which
784 /// will be executed once the scope is exited.
785 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000786 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000787 bool OldDidCallStackSave;
Douglas Gregor680f8612009-11-24 21:15:44 +0000788 bool PerformCleanup;
Douglas Gregor965f4502009-11-24 16:43:22 +0000789
John McCallbd309292010-07-06 01:34:17 +0000790 RunCleanupsScope(const RunCleanupsScope &); // DO NOT IMPLEMENT
791 RunCleanupsScope &operator=(const RunCleanupsScope &); // DO NOT IMPLEMENT
Douglas Gregor965f4502009-11-24 16:43:22 +0000792
Eric Christophera9d34972011-10-19 00:43:52 +0000793 protected:
794 CodeGenFunction& CGF;
795
Douglas Gregor965f4502009-11-24 16:43:22 +0000796 public:
797 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000798 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000799 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000800 {
John McCallbd309292010-07-06 01:34:17 +0000801 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor965f4502009-11-24 16:43:22 +0000802 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000803 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000804 }
805
806 /// \brief Exit this cleanup scope, emitting any accumulated
807 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000808 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000809 if (PerformCleanup) {
810 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallbd309292010-07-06 01:34:17 +0000811 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor680f8612009-11-24 21:15:44 +0000812 }
813 }
814
815 /// \brief Determine whether this scope requires any cleanups.
816 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000817 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000818 }
819
820 /// \brief Force the emission of cleanups now, instead of waiting
821 /// until this object is destroyed.
822 void ForceCleanup() {
823 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000824 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallbd309292010-07-06 01:34:17 +0000825 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor680f8612009-11-24 21:15:44 +0000826 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000827 }
828 };
829
Eric Christophera9d34972011-10-19 00:43:52 +0000830 class LexicalScope: protected RunCleanupsScope {
831 SourceRange Range;
832 bool PopDebugStack;
833
834 LexicalScope(const LexicalScope &); // DO NOT IMPLEMENT THESE
835 LexicalScope &operator=(const LexicalScope &);
836
837 public:
838 /// \brief Enter a new cleanup scope.
839 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
840 : RunCleanupsScope(CGF), Range(Range), PopDebugStack(true) {
841 if (CGDebugInfo *DI = CGF.getDebugInfo())
842 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
843 }
844
845 /// \brief Exit this cleanup scope, emitting any accumulated
846 /// cleanups.
847 ~LexicalScope() {
848 if (PopDebugStack) {
849 CGDebugInfo *DI = CGF.getDebugInfo();
850 if (DI) DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
851 }
852 }
853
854 /// \brief Force the emission of cleanups now, instead of waiting
855 /// until this object is destroyed.
856 void ForceCleanup() {
857 RunCleanupsScope::ForceCleanup();
858 if (CGDebugInfo *DI = CGF.getDebugInfo()) {
859 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
860 PopDebugStack = false;
861 }
862 }
863 };
864
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000865
John McCallbd309292010-07-06 01:34:17 +0000866 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
867 /// the cleanup blocks that have been added.
868 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000869
John McCallad5d61e2010-07-23 21:56:41 +0000870 void ResolveBranchFixups(llvm::BasicBlock *Target);
871
John McCallbd309292010-07-06 01:34:17 +0000872 /// The given basic block lies in the current EH scope, but may be a
873 /// target of a potentially scope-crossing jump; get a stable handle
874 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000875 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000876 return JumpDest(Target,
877 EHStack.getInnermostNormalCleanup(),
878 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000879 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000880
John McCallbd309292010-07-06 01:34:17 +0000881 /// The given basic block lies in the current EH scope, but may be a
882 /// target of a potentially scope-crossing jump; get a stable handle
883 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000884 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000885 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000886 }
887
888 /// EmitBranchThroughCleanup - Emit a branch from the current insert
889 /// block through the normal cleanup handling code (if any) and then
890 /// on to \arg Dest.
891 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000892
893 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
894 /// specified destination obviously has no cleanups to run. 'false' is always
895 /// a conservatively correct answer for this method.
896 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallbd309292010-07-06 01:34:17 +0000897
John McCall8e4c74b2011-08-11 02:22:43 +0000898 /// popCatchScope - Pops the catch scope at the top of the EHScope
899 /// stack, emitting any required code (other than the catch handlers
900 /// themselves).
901 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000902
John McCall8e4c74b2011-08-11 02:22:43 +0000903 llvm::BasicBlock *getEHResumeBlock();
904 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000905
John McCallce1de612011-01-26 04:00:11 +0000906 /// An object to manage conditionally-evaluated expressions.
907 class ConditionalEvaluation {
908 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000909
John McCallce1de612011-01-26 04:00:11 +0000910 public:
911 ConditionalEvaluation(CodeGenFunction &CGF)
912 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000913
John McCallce1de612011-01-26 04:00:11 +0000914 void begin(CodeGenFunction &CGF) {
915 assert(CGF.OutermostConditional != this);
916 if (!CGF.OutermostConditional)
917 CGF.OutermostConditional = this;
918 }
919
920 void end(CodeGenFunction &CGF) {
921 assert(CGF.OutermostConditional != 0);
922 if (CGF.OutermostConditional == this)
923 CGF.OutermostConditional = 0;
924 }
925
926 /// Returns a block which will be executed prior to each
927 /// evaluation of the conditional code.
928 llvm::BasicBlock *getStartingBlock() const {
929 return StartBB;
930 }
931 };
Mike Stump11289f42009-09-09 15:08:12 +0000932
John McCall7f9c92a2010-09-17 00:50:28 +0000933 /// isInConditionalBranch - Return true if we're currently emitting
934 /// one branch or the other of a conditional expression.
John McCallce1de612011-01-26 04:00:11 +0000935 bool isInConditionalBranch() const { return OutermostConditional != 0; }
936
John McCallf4beacd2011-11-10 10:43:54 +0000937 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
938 assert(isInConditionalBranch());
939 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
940 new llvm::StoreInst(value, addr, &block->back());
941 }
942
John McCallce1de612011-01-26 04:00:11 +0000943 /// An RAII object to record that we're evaluating a statement
944 /// expression.
945 class StmtExprEvaluation {
946 CodeGenFunction &CGF;
947
948 /// We have to save the outermost conditional: cleanups in a
949 /// statement expression aren't conditional just because the
950 /// StmtExpr is.
951 ConditionalEvaluation *SavedOutermostConditional;
952
953 public:
954 StmtExprEvaluation(CodeGenFunction &CGF)
955 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
956 CGF.OutermostConditional = 0;
957 }
958
959 ~StmtExprEvaluation() {
960 CGF.OutermostConditional = SavedOutermostConditional;
961 CGF.EnsureInsertPoint();
962 }
963 };
John McCall1bf58462011-02-16 08:02:54 +0000964
John McCallc07a0c72011-02-17 10:25:35 +0000965 /// An object which temporarily prevents a value from being
966 /// destroyed by aggressive peephole optimizations that assume that
967 /// all uses of a value have been realized in the IR.
968 class PeepholeProtection {
969 llvm::Instruction *Inst;
970 friend class CodeGenFunction;
971
972 public:
973 PeepholeProtection() : Inst(0) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000974 };
John McCallc07a0c72011-02-17 10:25:35 +0000975
John McCallfe96e0b2011-11-06 09:01:30 +0000976 /// A non-RAII class containing all the information about a bound
977 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
978 /// this which makes individual mappings very simple; using this
979 /// class directly is useful when you have a variable number of
980 /// opaque values or don't want the RAII functionality for some
981 /// reason.
982 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +0000983 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +0000984 bool BoundLValue;
985 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +0000986
John McCallfe96e0b2011-11-06 09:01:30 +0000987 OpaqueValueMappingData(const OpaqueValueExpr *ov,
988 bool boundLValue)
989 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +0000990 public:
John McCallfe96e0b2011-11-06 09:01:30 +0000991 OpaqueValueMappingData() : OpaqueValue(0) {}
992
John McCallc07a0c72011-02-17 10:25:35 +0000993 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +0000994 // gl-values should be bound as l-values for obvious reasons.
995 // Records should be bound as l-values because IR generation
996 // always keeps them in memory. Expressions of function type
997 // act exactly like l-values but are formally required to be
998 // r-values in C.
999 return expr->isGLValue() ||
1000 expr->getType()->isRecordType() ||
1001 expr->getType()->isFunctionType();
John McCallc07a0c72011-02-17 10:25:35 +00001002 }
1003
John McCallfe96e0b2011-11-06 09:01:30 +00001004 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1005 const OpaqueValueExpr *ov,
1006 const Expr *e) {
1007 if (shouldBindAsLValue(ov))
1008 return bind(CGF, ov, CGF.EmitLValue(e));
1009 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1010 }
1011
1012 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1013 const OpaqueValueExpr *ov,
1014 const LValue &lv) {
1015 assert(shouldBindAsLValue(ov));
1016 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1017 return OpaqueValueMappingData(ov, true);
1018 }
1019
1020 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1021 const OpaqueValueExpr *ov,
1022 const RValue &rv) {
1023 assert(!shouldBindAsLValue(ov));
1024 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1025
1026 OpaqueValueMappingData data(ov, false);
1027
1028 // Work around an extremely aggressive peephole optimization in
1029 // EmitScalarConversion which assumes that all other uses of a
1030 // value are extant.
1031 data.Protection = CGF.protectFromPeepholes(rv);
1032
1033 return data;
1034 }
1035
1036 bool isValid() const { return OpaqueValue != 0; }
1037 void clear() { OpaqueValue = 0; }
1038
1039 void unbind(CodeGenFunction &CGF) {
1040 assert(OpaqueValue && "no data to unbind!");
1041
1042 if (BoundLValue) {
1043 CGF.OpaqueLValues.erase(OpaqueValue);
1044 } else {
1045 CGF.OpaqueRValues.erase(OpaqueValue);
1046 CGF.unprotectFromPeepholes(Protection);
1047 }
1048 }
1049 };
1050
1051 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1052 class OpaqueValueMapping {
1053 CodeGenFunction &CGF;
1054 OpaqueValueMappingData Data;
1055
1056 public:
1057 static bool shouldBindAsLValue(const Expr *expr) {
1058 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1059 }
1060
John McCallc07a0c72011-02-17 10:25:35 +00001061 /// Build the opaque value mapping for the given conditional
1062 /// operator if it's the GNU ?: extension. This is a common
1063 /// enough pattern that the convenience operator is really
1064 /// helpful.
1065 ///
1066 OpaqueValueMapping(CodeGenFunction &CGF,
1067 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001068 if (isa<ConditionalOperator>(op))
1069 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001070 return;
John McCallc07a0c72011-02-17 10:25:35 +00001071
1072 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001073 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1074 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001075 }
1076
John McCall1bf58462011-02-16 08:02:54 +00001077 OpaqueValueMapping(CodeGenFunction &CGF,
1078 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001079 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001080 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001081 }
1082
1083 OpaqueValueMapping(CodeGenFunction &CGF,
1084 const OpaqueValueExpr *opaqueValue,
1085 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001086 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001087 }
1088
1089 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001090 Data.unbind(CGF);
1091 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001092 }
1093
1094 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001095 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001096 }
1097 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +00001098
1099 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1100 /// number that holds the value.
1101 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +00001102
1103 /// BuildBlockByrefAddress - Computes address location of the
1104 /// variable which is declared as __block.
1105 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1106 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +00001107private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001108 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001109 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001110
John McCall9b382dd2011-05-28 21:13:02 +00001111 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1112 /// calling llvm.stacksave for multiple VLAs in the same scope.
1113 bool DidCallStackSave;
1114
Mike Stumpe5311b02009-11-30 20:08:49 +00001115 /// IndirectBranch - The first time an indirect goto is seen we create a block
1116 /// with an indirect branch. Every time we see the address of a label taken,
1117 /// we add the label to the indirect goto. Every subsequent indirect goto is
1118 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001119 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001120
Mike Stumpfc496822009-02-08 23:14:22 +00001121 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1122 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001123 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1124 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001125
Chris Lattnerac248202007-05-30 00:13:02 +00001126 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001127 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001128
Mike Stumpfc496822009-02-08 23:14:22 +00001129 // BreakContinueStack - This keeps track of where break and continue
Anders Carlsson33747b62009-02-10 05:52:02 +00001130 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001131 struct BreakContinue {
John McCallbd309292010-07-06 01:34:17 +00001132 BreakContinue(JumpDest Break, JumpDest Continue)
1133 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001134
John McCallbd309292010-07-06 01:34:17 +00001135 JumpDest BreakBlock;
1136 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001137 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001138 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001139
Mike Stumpfc496822009-02-08 23:14:22 +00001140 /// SwitchInsn - This is nearest current switch instruction. It is null if if
1141 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001142 llvm::SwitchInst *SwitchInsn;
1143
Mike Stumpfc496822009-02-08 23:14:22 +00001144 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001145 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001146 llvm::BasicBlock *CaseRangeBlock;
1147
John McCallc07a0c72011-02-17 10:25:35 +00001148 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001149 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001150 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1151 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001152
Mike Stumpfc496822009-02-08 23:14:22 +00001153 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001154 // We track this by the size expression rather than the type itself because
1155 // in certain situations, like a const qualifier applied to an VLA typedef,
1156 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001157 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1158 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001159 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001160
John McCallbd309292010-07-06 01:34:17 +00001161 /// A block containing a single 'unreachable' instruction. Created
1162 /// lazily by getUnreachableBlock().
1163 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001164
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001165 /// CXXThisDecl - When generating code for a C++ member function,
1166 /// this will hold the implicit 'this' declaration.
Anders Carlsson468fa632009-04-04 20:47:02 +00001167 ImplicitParamDecl *CXXThisDecl;
John McCall347132b2010-02-16 22:04:33 +00001168 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001169
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001170 /// CXXVTTDecl - When generating code for a base object constructor or
1171 /// base object destructor with virtual bases, this will hold the implicit
1172 /// VTT parameter.
1173 ImplicitParamDecl *CXXVTTDecl;
John McCall347132b2010-02-16 22:04:33 +00001174 llvm::Value *CXXVTTValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001175
John McCallce1de612011-01-26 04:00:11 +00001176 /// OutermostConditional - Points to the outermost active
1177 /// conditional control. This is used so that we know if a
1178 /// temporary should be destroyed conditionally.
1179 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001180
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001181
1182 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1183 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001184 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001185 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001186
John McCallbd309292010-07-06 01:34:17 +00001187 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001188 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001189 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001190
Chris Lattnerbed31442007-05-28 01:07:47 +00001191public:
Chris Lattnerd1af2d22007-05-29 23:17:50 +00001192 CodeGenFunction(CodeGenModule &cgm);
John McCall08ef4662011-11-10 08:15:53 +00001193 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001194
John McCall8ed55a52010-09-02 09:58:18 +00001195 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001196 ASTContext &getContext() const { return CGM.getContext(); }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001197 CGDebugInfo *getDebugInfo() {
1198 if (DisableDebugInfo)
1199 return NULL;
1200 return DebugInfo;
1201 }
1202 void disableDebugInfo() { DisableDebugInfo = true; }
1203 void enableDebugInfo() { DisableDebugInfo = false; }
1204
John McCall31168b02011-06-15 23:02:42 +00001205 bool shouldUseFusedARCCalls() {
1206 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1207 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001208
John McCallad7c5c12011-02-08 08:22:06 +00001209 const LangOptions &getLangOptions() const { return CGM.getLangOptions(); }
1210
Bill Wendlingf0724e82011-09-19 20:31:14 +00001211 /// Returns a pointer to the function's exception object and selector slot,
1212 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001213 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001214 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001215
Bill Wendling79a70e42011-09-15 18:57:19 +00001216 /// Returns the contents of the function's exception object and selector
1217 /// slots.
1218 llvm::Value *getExceptionFromSlot();
1219 llvm::Value *getSelectorFromSlot();
1220
John McCallad5d61e2010-07-23 21:56:41 +00001221 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001222
John McCallbd309292010-07-06 01:34:17 +00001223 llvm::BasicBlock *getUnreachableBlock() {
1224 if (!UnreachableBlock) {
1225 UnreachableBlock = createBasicBlock("unreachable");
1226 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1227 }
1228 return UnreachableBlock;
1229 }
1230
1231 llvm::BasicBlock *getInvokeDest() {
1232 if (!EHStack.requiresLandingPad()) return 0;
1233 return getInvokeDestImpl();
1234 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001235
John McCallad7c5c12011-02-08 08:22:06 +00001236 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001237
Daniel Dunbar12347492009-02-23 17:26:39 +00001238 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001239 // Cleanups
1240 //===--------------------------------------------------------------------===//
1241
1242 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1243
John McCall178360e2011-07-11 08:38:19 +00001244 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1245 llvm::Value *arrayEndPointer,
1246 QualType elementType,
1247 Destroyer &destroyer);
1248 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1249 llvm::Value *arrayEnd,
1250 QualType elementType,
1251 Destroyer &destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001252
John McCall4bd0fb12011-07-12 16:41:08 +00001253 void pushDestroy(QualType::DestructionKind dtorKind,
1254 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001255 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
John McCall178360e2011-07-11 08:38:19 +00001256 Destroyer &destroyer, bool useEHCleanupForArray);
1257 void emitDestroy(llvm::Value *addr, QualType type, Destroyer &destroyer,
1258 bool useEHCleanupForArray);
John McCall98de3d72011-07-13 03:01:35 +00001259 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1260 QualType type,
1261 Destroyer &destroyer,
1262 bool useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001263 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall178360e2011-07-11 08:38:19 +00001264 QualType type, Destroyer &destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001265 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001266
John McCall4bd0fb12011-07-12 16:41:08 +00001267 Destroyer &getDestroyer(QualType::DestructionKind destructionKind);
1268
John McCall82fe67b2011-07-09 01:37:26 +00001269 /// Determines whether an EH cleanup is required to destroy a type
1270 /// with the given destruction kind.
1271 bool needsEHCleanup(QualType::DestructionKind kind) {
1272 switch (kind) {
1273 case QualType::DK_none:
1274 return false;
1275 case QualType::DK_cxx_destructor:
1276 case QualType::DK_objc_weak_lifetime:
1277 return getLangOptions().Exceptions;
1278 case QualType::DK_objc_strong_lifetime:
1279 return getLangOptions().Exceptions &&
1280 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1281 }
1282 llvm_unreachable("bad destruction kind");
1283 }
1284
John McCall4bd0fb12011-07-12 16:41:08 +00001285 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1286 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1287 }
1288
John McCall82fe67b2011-07-09 01:37:26 +00001289 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001290 // Objective-C
1291 //===--------------------------------------------------------------------===//
1292
Chris Lattner4bd55962008-03-30 23:03:07 +00001293 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001294
Mike Stumpfc496822009-02-08 23:14:22 +00001295 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patele7ce5402011-05-19 23:37:41 +00001296 const ObjCContainerDecl *CD,
1297 SourceLocation StartLoc);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001298
Mike Stumpfc496822009-02-08 23:14:22 +00001299 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001300 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1301 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001302 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1303 const ObjCPropertyImplDecl *propImpl);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001304
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001305 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1306 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001307
Mike Stumpfc496822009-02-08 23:14:22 +00001308 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1309 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001310 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1311 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001312 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1313 const ObjCPropertyImplDecl *propImpl);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001314 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001315 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001316
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001317 //===--------------------------------------------------------------------===//
1318 // Block Bits
1319 //===--------------------------------------------------------------------===//
1320
John McCall351762c2011-02-07 10:33:21 +00001321 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001322 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1323 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001324 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001325 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001326 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001327 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001328
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001329 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001330 const CGBlockInfo &Info,
Mike Stump692c6e32009-03-20 21:53:12 +00001331 const Decl *OuterFuncDecl,
John McCall351762c2011-02-07 10:33:21 +00001332 const DeclMapTy &ldm);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001333
John McCallad7c5c12011-02-08 08:22:06 +00001334 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1335 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001336 llvm::Constant *GenerateObjCAtomicCopyHelperFunction(
1337 const ObjCPropertyImplDecl *PID);
John McCallad7c5c12011-02-08 08:22:06 +00001338
John McCallad7c5c12011-02-08 08:22:06 +00001339 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1340
John McCall73064872011-03-31 01:59:53 +00001341 class AutoVarEmission;
1342
1343 void emitByrefStructureInit(const AutoVarEmission &emission);
1344 void enterByrefCleanup(const AutoVarEmission &emission);
1345
John McCall351762c2011-02-07 10:33:21 +00001346 llvm::Value *LoadBlockStruct() {
1347 assert(BlockPointer && "no block pointer set!");
1348 return BlockPointer;
1349 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001350
John McCall87fe5d52010-05-20 01:18:31 +00001351 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
1352 void AllocateBlockDecl(const BlockDeclRefExpr *E);
John McCall9d42f0f2010-05-21 04:11:14 +00001353 llvm::Value *GetAddrOfBlockDecl(const BlockDeclRefExpr *E) {
1354 return GetAddrOfBlockDecl(E->getDecl(), E->isByRef());
1355 }
John McCall351762c2011-02-07 10:33:21 +00001356 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001357 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001358
John McCalla738c252011-03-09 04:27:21 +00001359 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1360 const CGFunctionInfo &FnInfo);
Anders Carlsson73fcc952009-09-11 00:07:24 +00001361 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001362 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001363 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001364 const FunctionArgList &Args,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +00001365 SourceLocation StartLoc);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001366
John McCallb81884d2010-02-19 09:25:03 +00001367 void EmitConstructorBody(FunctionArgList &Args);
1368 void EmitDestructorBody(FunctionArgList &Args);
1369 void EmitFunctionBody(FunctionArgList &Args);
John McCall89b12b32010-02-18 03:17:58 +00001370
Mike Stumpfc496822009-02-08 23:14:22 +00001371 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1372 /// emission when possible.
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001373 void EmitReturnBlock();
1374
Mike Stumpfc496822009-02-08 23:14:22 +00001375 /// FinishFunction - Complete IR generation of the current function. It is
1376 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001377 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001378
Anders Carlssonbad991d2010-03-24 00:39:18 +00001379 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001380 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1381 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001382
Eli Friedman49a94b12011-05-06 17:27:27 +00001383 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1384 GlobalDecl GD, const ThunkInfo &Thunk);
1385
Douglas Gregor94f9a482010-05-05 05:51:00 +00001386 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1387 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001388
Anders Carlssone87fae92010-03-28 19:40:00 +00001389 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1390 /// subobject.
1391 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001392 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001393 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001394 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001395 llvm::Constant *VTable,
1396 const CXXRecordDecl *VTableClass);
1397
1398 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001399 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001400 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001401 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001402 bool BaseIsNonVirtualPrimaryBase,
1403 llvm::Constant *VTable,
1404 const CXXRecordDecl *VTableClass,
1405 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001406
Anders Carlssond5895932010-03-28 21:07:49 +00001407 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001408
Dan Gohman8fc50c22010-10-26 18:44:08 +00001409 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1410 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001411 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001412
John McCallf99a6312010-07-21 05:30:47 +00001413 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1414 /// given phase of destruction for a destructor. The end result
1415 /// should call destructors on members and base classes in reverse
1416 /// order of their construction.
1417 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001418
Chris Lattner3c77a352010-06-22 00:03:40 +00001419 /// ShouldInstrumentFunction - Return true if the current function should be
1420 /// instrumented with __cyg_profile_func_* calls
1421 bool ShouldInstrumentFunction();
1422
1423 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1424 /// instrumentation function with the current function and the call site, if
1425 /// function instrumentation is enabled.
1426 void EmitFunctionInstrumentation(const char *Fn);
1427
Roman Divacky178e01602011-02-10 16:52:03 +00001428 /// EmitMCountInstrumentation - Emit call to .mcount.
1429 void EmitMCountInstrumentation();
1430
Mike Stumpfc496822009-02-08 23:14:22 +00001431 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1432 /// arguments for the given function. This is also responsible for naming the
1433 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001434 void EmitFunctionProlog(const CGFunctionInfo &FI,
1435 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001436 const FunctionArgList &Args);
1437
Mike Stumpfc496822009-02-08 23:14:22 +00001438 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1439 /// given temporary.
Chris Lattner3fcc7902010-06-27 01:06:27 +00001440 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001441
Mike Stump1d849212009-12-07 23:38:24 +00001442 /// EmitStartEHSpec - Emit the start of the exception spec.
1443 void EmitStartEHSpec(const Decl *D);
1444
1445 /// EmitEndEHSpec - Emit the end of the exception spec.
1446 void EmitEndEHSpec(const Decl *D);
1447
John McCallbd309292010-07-06 01:34:17 +00001448 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1449 llvm::BasicBlock *getTerminateLandingPad();
1450
1451 /// getTerminateHandler - Return a handler (not a landing pad, just
1452 /// a catch handler) that just calls terminate. This is used when
1453 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001454 llvm::BasicBlock *getTerminateHandler();
1455
Chris Lattnera5f58b02011-07-09 17:41:47 +00001456 llvm::Type *ConvertTypeForMem(QualType T);
1457 llvm::Type *ConvertType(QualType T);
1458 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001459 return ConvertType(getContext().getTypeDeclType(T));
1460 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001461
Mike Stumpfc496822009-02-08 23:14:22 +00001462 /// LoadObjCSelf - Load the value of self. This function is only valid while
1463 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001464 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001465
1466 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001467 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001468
Chris Lattner54fb19e2007-06-22 22:02:34 +00001469 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1470 /// an aggregate LLVM type or is void.
1471 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001472
1473 /// createBasicBlock - Create an LLVM basic block.
Chris Lattner01cf8db2011-07-20 06:58:45 +00001474 llvm::BasicBlock *createBasicBlock(StringRef name = "",
John McCallad7c5c12011-02-08 08:22:06 +00001475 llvm::Function *parent = 0,
1476 llvm::BasicBlock *before = 0) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001477#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001478 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001479#else
John McCallad7c5c12011-02-08 08:22:06 +00001480 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001481#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001482 }
Mike Stumpfc496822009-02-08 23:14:22 +00001483
Chris Lattnerac248202007-05-30 00:13:02 +00001484 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1485 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001486 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001487
Mike Stumpe5311b02009-11-30 20:08:49 +00001488 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1489 /// another basic block, simplify it. This assumes that no other code could
1490 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001491 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1492
Mike Stumpfc496822009-02-08 23:14:22 +00001493 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1494 /// adding a fall-through branch from the current insert block if
1495 /// necessary. It is legal to call this function even if there is no current
1496 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001497 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001498 /// IsFinished - If true, indicates that the caller has finished emitting
1499 /// branches to the given block and does not expect to emit code into it. This
1500 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001501 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001502
John McCall8e4c74b2011-08-11 02:22:43 +00001503 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1504 /// near its uses, and leave the insertion point in it.
1505 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1506
Mike Stumpfc496822009-02-08 23:14:22 +00001507 /// EmitBranch - Emit a branch to the specified basic block from the current
1508 /// insert block, taking care to avoid creation of branches from dummy
1509 /// blocks. It is legal to call this function even if there is no current
1510 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001511 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001512 /// This function clears the current insertion point. The caller should follow
1513 /// calls to this function with calls to Emit*Block prior to generation new
1514 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001515 void EmitBranch(llvm::BasicBlock *Block);
1516
Mike Stumpfc496822009-02-08 23:14:22 +00001517 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1518 /// indicates that the current code being emitted is unreachable.
1519 bool HaveInsertPoint() const {
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001520 return Builder.GetInsertBlock() != 0;
1521 }
1522
Mike Stumpfc496822009-02-08 23:14:22 +00001523 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1524 /// emitted IR has a place to go. Note that by definition, if this function
1525 /// creates a block then that block is unreachable; callers may do better to
1526 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001527 void EnsureInsertPoint() {
1528 if (!HaveInsertPoint())
1529 EmitBlock(createBasicBlock());
1530 }
Mike Stumpfc496822009-02-08 23:14:22 +00001531
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001532 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001533 /// specified stmt yet.
Daniel Dunbarf2cf6d12008-09-04 03:43:08 +00001534 void ErrorUnsupported(const Stmt *S, const char *Type,
1535 bool OmitOnError=false);
Chris Lattner84915fa2007-06-02 04:16:21 +00001536
Chris Lattnere9a64532007-06-22 21:44:33 +00001537 //===--------------------------------------------------------------------===//
1538 // Helpers
1539 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001540
Eli Friedmana0544d62011-12-03 04:14:32 +00001541 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1542 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001543 return LValue::MakeAddr(V, T, Alignment, getContext(),
1544 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001545 }
Eli Friedmand20adbd2011-11-16 00:42:57 +00001546 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedmana0544d62011-12-03 04:14:32 +00001547 CharUnits Alignment;
1548 if (!T->isIncompleteType())
1549 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmand20adbd2011-11-16 00:42:57 +00001550 return LValue::MakeAddr(V, T, Alignment, getContext(),
1551 CGM.getTBAAInfo(T));
1552 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001553
Chris Lattnere9a64532007-06-22 21:44:33 +00001554 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001555 /// block. The caller is responsible for setting an appropriate alignment on
1556 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001557 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001558 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001559
John McCall2e6567a2010-04-22 01:10:34 +00001560 /// InitTempAlloca - Provide an initial value for the given alloca.
1561 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1562
Daniel Dunbard0049182010-02-16 19:44:13 +00001563 /// CreateIRTemp - Create a temporary IR object of the given type, with
1564 /// appropriate alignment. This routine should only be used when an temporary
1565 /// value needs to be stored into an alloca (for example, to avoid explicit
1566 /// PHI construction), but the type is the IR type, not the type appropriate
1567 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001568 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001569
Daniel Dunbara7566f12010-02-09 02:48:28 +00001570 /// CreateMemTemp - Create a temporary memory object of the given type, with
1571 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001572 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001573
John McCall7a626f62010-09-15 10:14:12 +00001574 /// CreateAggTemp - Create a temporary memory object for the given
1575 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001576 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001577 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001578 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1579 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001580 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001581 AggValueSlot::DoesNotNeedGCBarriers,
1582 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001583 }
1584
John McCallad7c5c12011-02-08 08:22:06 +00001585 /// Emit a cast to void* in the appropriate address space.
1586 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1587
Chris Lattner8394d792007-06-05 20:53:16 +00001588 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1589 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001590 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001591
John McCalla2342eb2010-12-05 02:00:02 +00001592 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1593 void EmitIgnoredExpr(const Expr *E);
1594
Chris Lattner4647a212007-08-31 22:49:20 +00001595 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1596 /// any type. The result is returned as an RValue struct. If this is an
1597 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1598 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001599 ///
1600 /// \param IgnoreResult - True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001601 RValue EmitAnyExpr(const Expr *E,
1602 AggValueSlot AggSlot = AggValueSlot::ignored(),
1603 bool IgnoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001604
Mike Stumpfc496822009-02-08 23:14:22 +00001605 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1606 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001607 llvm::Value *EmitVAListRef(const Expr *E);
1608
Mike Stumpfc496822009-02-08 23:14:22 +00001609 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1610 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001611 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001612
John McCall91ca10f2011-03-08 09:11:50 +00001613 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
John McCall21886962010-04-21 10:05:39 +00001614 /// arbitrary expression into the given memory location.
1615 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
John McCall31168b02011-06-15 23:02:42 +00001616 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001617
John McCall91ca10f2011-03-08 09:11:50 +00001618 /// EmitExprAsInit - Emits the code necessary to initialize a
1619 /// location in memory with the given initializer.
John McCall31168b02011-06-15 23:02:42 +00001620 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001621 LValue lvalue, bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001622
Mike Stump5e9e61b2009-05-23 22:29:41 +00001623 /// EmitAggregateCopy - Emit an aggrate copy.
1624 ///
1625 /// \param isVolatile - True iff either the source or the destination is
1626 /// volatile.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001627 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001628 QualType EltTy, bool isVolatile=false,
1629 unsigned Alignment = 0);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001630
Devang Patelda5d6bb2007-10-04 23:45:31 +00001631 /// StartBlock - Start new block named N. If insert block is a dummy block
1632 /// then reuse it.
1633 void StartBlock(const char *N);
1634
Lauro Ramos Venancio01a72ff2008-02-26 21:41:45 +00001635 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
John McCall5d865c322010-08-31 07:33:07 +00001636 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD) {
1637 return cast<llvm::Constant>(GetAddrOfLocalVar(BVD));
1638 }
Dan Gohman75d69da2008-05-22 00:50:06 +00001639
Anders Carlsson9396a892008-09-11 09:15:33 +00001640 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001641 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1642 llvm::Value *Res = LocalDeclMap[VD];
1643 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1644 return Res;
1645 }
Mike Stumpfc496822009-02-08 23:14:22 +00001646
John McCallc07a0c72011-02-17 10:25:35 +00001647 /// getOpaqueLValueMapping - Given an opaque value expression (which
1648 /// must be mapped to an l-value), return its mapping.
1649 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1650 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1651
1652 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1653 it = OpaqueLValues.find(e);
1654 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1655 return it->second;
1656 }
1657
1658 /// getOpaqueRValueMapping - Given an opaque value expression (which
1659 /// must be mapped to an r-value), return its mapping.
1660 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1661 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1662
1663 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1664 it = OpaqueRValues.find(e);
1665 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001666 return it->second;
1667 }
1668
Dan Gohman75d69da2008-05-22 00:50:06 +00001669 /// getAccessedFieldNo - Given an encoded value and a result number, return
1670 /// the input field number being accessed.
1671 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1672
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001673 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001674 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001675
Anders Carlssonc0964b62010-05-22 17:35:42 +00001676 /// EmitNullInitialization - Generate code to set a value of the given type to
1677 /// null, If the type contains data member pointers, they will be initialized
1678 /// to -1 in accordance with the Itanium C++ ABI.
1679 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001680
1681 // EmitVAArg - Generate code to get an argument from the passed in pointer
1682 // and update it accordingly. The return value is a pointer to the argument.
1683 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001684 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001685 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001686
John McCall82fe67b2011-07-09 01:37:26 +00001687 /// emitArrayLength - Compute the length of an array, even if it's a
1688 /// VLA, and drill down to the base element type.
1689 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1690 QualType &baseType,
1691 llvm::Value *&addr);
1692
John McCall23c29fe2011-06-24 21:55:10 +00001693 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1694 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001695 ///
1696 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001697 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001698
John McCall23c29fe2011-06-24 21:55:10 +00001699 /// getVLASize - Returns an LLVM value that corresponds to the size,
1700 /// in non-variably-sized elements, of a variable length array type,
1701 /// plus that largest non-variably-sized element type. Assumes that
1702 /// the type has already been emitted with EmitVariablyModifiedType.
1703 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1704 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001705
Anders Carlssona5d077d2009-04-14 16:58:56 +00001706 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1707 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001708 llvm::Value *LoadCXXThis() {
1709 assert(CXXThisValue && "no 'this' value for this function");
1710 return CXXThisValue;
1711 }
Mike Stump11289f42009-09-09 15:08:12 +00001712
Anders Carlssone36a6b32010-01-02 01:01:18 +00001713 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1714 /// virtual bases.
John McCall347132b2010-02-16 22:04:33 +00001715 llvm::Value *LoadCXXVTT() {
1716 assert(CXXVTTValue && "no VTT value for this function");
1717 return CXXVTTValue;
1718 }
John McCall6ce74722010-02-16 04:15:37 +00001719
1720 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001721 /// complete class to the given direct base.
1722 llvm::Value *
1723 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1724 const CXXRecordDecl *Derived,
1725 const CXXRecordDecl *Base,
1726 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001727
Mike Stumpe5311b02009-11-30 20:08:49 +00001728 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1729 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001730 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001731 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001732 CastExpr::path_const_iterator PathBegin,
1733 CastExpr::path_const_iterator PathEnd,
Anders Carlssond829a022010-04-24 21:06:20 +00001734 bool NullCheckValue);
1735
Anders Carlsson8c793172009-11-23 17:57:54 +00001736 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001737 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001738 CastExpr::path_const_iterator PathBegin,
1739 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001740 bool NullCheckValue);
1741
Anders Carlsson84673e22010-01-31 01:36:53 +00001742 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1743 const CXXRecordDecl *ClassDecl,
1744 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001745
John McCallf8ff7b92010-02-23 00:48:20 +00001746 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1747 CXXCtorType CtorType,
1748 const FunctionArgList &Args);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001749 // It's important not to confuse this and the previous function. Delegating
1750 // constructors are the C++0x feature. The constructor delegate optimization
1751 // is used to reduce duplication in the base and complete consturctors where
1752 // they are substantially the same.
1753 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1754 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001755 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1756 bool ForVirtualBase, llvm::Value *This,
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001757 CallExpr::const_arg_iterator ArgBeg,
1758 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001759
1760 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1761 llvm::Value *This, llvm::Value *Src,
1762 CallExpr::const_arg_iterator ArgBeg,
1763 CallExpr::const_arg_iterator ArgEnd);
Mike Stump11289f42009-09-09 15:08:12 +00001764
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001765 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001766 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001767 llvm::Value *ArrayPtr,
1768 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001769 CallExpr::const_arg_iterator ArgEnd,
1770 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001771
Anders Carlssond49844b2009-09-23 02:45:36 +00001772 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1773 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001774 llvm::Value *ArrayPtr,
1775 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001776 CallExpr::const_arg_iterator ArgEnd,
1777 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001778
John McCall82fe67b2011-07-09 01:37:26 +00001779 static Destroyer destroyCXXObject;
1780
Anders Carlsson0a637412009-05-29 21:03:38 +00001781 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Anders Carlssonf8a71f02010-05-02 23:29:11 +00001782 bool ForVirtualBase, llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001783
John McCall99210dc2011-09-15 06:49:18 +00001784 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1785 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump11289f42009-09-09 15:08:12 +00001786
Peter Collingbourne702b2842011-11-27 22:09:22 +00001787 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1788 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001789
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001790 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001791 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001792
Eli Friedman24f55432009-11-18 00:57:03 +00001793 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1794 QualType DeleteTy);
1795
Mike Stumpc9b231c2009-11-15 08:09:41 +00001796 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001797 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001798
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001799 void EmitCheck(llvm::Value *, unsigned Size);
1800
Chris Lattner116ce8f2010-01-09 21:40:03 +00001801 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1802 bool isInc, bool isPre);
1803 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1804 bool isInc, bool isPre);
Chris Lattner8394d792007-06-05 20:53:16 +00001805 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001806 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001807 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001808
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001809 /// EmitDecl - Emit a declaration.
1810 ///
1811 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001812 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001813
John McCall1c9c3fd2010-10-15 04:57:14 +00001814 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001815 ///
1816 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001817 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001818
John McCall31168b02011-06-15 23:02:42 +00001819 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001820 LValue lvalue, bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001821 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001822
John McCallbd309292010-07-06 01:34:17 +00001823 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1824 llvm::Value *Address);
1825
John McCall1c9c3fd2010-10-15 04:57:14 +00001826 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001827 ///
1828 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001829 void EmitAutoVarDecl(const VarDecl &D);
1830
1831 class AutoVarEmission {
1832 friend class CodeGenFunction;
1833
John McCall9e2e22f2011-02-22 07:16:58 +00001834 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001835
1836 /// The alignment of the variable.
1837 CharUnits Alignment;
1838
1839 /// The address of the alloca. Null if the variable was emitted
1840 /// as a global constant.
1841 llvm::Value *Address;
1842
1843 llvm::Value *NRVOFlag;
1844
1845 /// True if the variable is a __block variable.
1846 bool IsByRef;
1847
1848 /// True if the variable is of aggregate type and has a constant
1849 /// initializer.
1850 bool IsConstantAggregate;
1851
John McCall9e2e22f2011-02-22 07:16:58 +00001852 struct Invalid {};
1853 AutoVarEmission(Invalid) : Variable(0) {}
1854
John McCallc533cb72011-02-22 06:44:22 +00001855 AutoVarEmission(const VarDecl &variable)
John McCall9e2e22f2011-02-22 07:16:58 +00001856 : Variable(&variable), Address(0), NRVOFlag(0),
John McCallc533cb72011-02-22 06:44:22 +00001857 IsByRef(false), IsConstantAggregate(false) {}
1858
1859 bool wasEmittedAsGlobal() const { return Address == 0; }
1860
1861 public:
John McCall9e2e22f2011-02-22 07:16:58 +00001862 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1863
John McCallc533cb72011-02-22 06:44:22 +00001864 /// Returns the address of the object within this declaration.
1865 /// Note that this does not chase the forwarding pointer for
1866 /// __block decls.
1867 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1868 if (!IsByRef) return Address;
1869
1870 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00001871 CGF.getByRefValueLLVMField(Variable),
1872 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00001873 }
1874 };
1875 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1876 void EmitAutoVarInit(const AutoVarEmission &emission);
1877 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00001878 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1879 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001880
John McCall1c9c3fd2010-10-15 04:57:14 +00001881 void EmitStaticVarDecl(const VarDecl &D,
1882 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001883
1884 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel68a15252011-03-03 20:13:15 +00001885 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00001886
John McCallc07a0c72011-02-17 10:25:35 +00001887 /// protectFromPeepholes - Protect a value that we're intending to
1888 /// store to the side, but which will probably be used later, from
1889 /// aggressive peepholing optimizations that might delete it.
1890 ///
1891 /// Pass the result to unprotectFromPeepholes to declare that
1892 /// protection is no longer required.
1893 ///
1894 /// There's no particular reason why this shouldn't apply to
1895 /// l-values, it's just that no existing peepholes work on pointers.
1896 PeepholeProtection protectFromPeepholes(RValue rvalue);
1897 void unprotectFromPeepholes(PeepholeProtection protection);
1898
Chris Lattner84915fa2007-06-02 04:16:21 +00001899 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001900 // Statement Emission
1901 //===--------------------------------------------------------------------===//
1902
Mike Stumpfc496822009-02-08 23:14:22 +00001903 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001904 void EmitStopPoint(const Stmt *S);
1905
Mike Stumpfc496822009-02-08 23:14:22 +00001906 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1907 /// this function even if there is no current insertion point.
1908 ///
1909 /// This function may clear the current insertion point; callers should use
1910 /// EnsureInsertPoint if they wish to subsequently generate code without first
1911 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001912 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001913
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001914 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001915 /// necessarily require an insertion point or debug information; typically
1916 /// because the statement amounts to a jump or a container of other
1917 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001918 ///
1919 /// \return True if the statement was handled.
1920 bool EmitSimpleStmt(const Stmt *S);
1921
Chris Lattner4647a212007-08-31 22:49:20 +00001922 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall7a626f62010-09-15 10:14:12 +00001923 AggValueSlot AVS = AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001924
Mike Stumpfc496822009-02-08 23:14:22 +00001925 /// EmitLabel - Emit the block for the given label. It is legal to call this
1926 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001927 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001928
Chris Lattnerac248202007-05-30 00:13:02 +00001929 void EmitLabelStmt(const LabelStmt &S);
1930 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001931 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00001932 void EmitIfStmt(const IfStmt &S);
Chris Lattner946aa312007-06-05 03:59:43 +00001933 void EmitWhileStmt(const WhileStmt &S);
Chris Lattner8394d792007-06-05 20:53:16 +00001934 void EmitDoStmt(const DoStmt &S);
1935 void EmitForStmt(const ForStmt &S);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00001936 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00001937 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001938 void EmitBreakStmt(const BreakStmt &S);
1939 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00001940 void EmitSwitchStmt(const SwitchStmt &S);
1941 void EmitDefaultStmt(const DefaultStmt &S);
1942 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00001943 void EmitCaseStmtRange(const CaseStmt &S);
Anders Carlsson952a9952008-02-05 16:35:33 +00001944 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001945
Anders Carlsson2e744e82008-08-30 19:51:14 +00001946 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001947 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1948 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00001949 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00001950 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001951
John McCall9b382dd2011-05-28 21:13:02 +00001952 llvm::Constant *getUnwindResumeFn();
Douglas Gregor51150ab2010-05-16 01:24:12 +00001953 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCallb609d3f2010-07-07 06:56:46 +00001954 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1955 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00001956
Anders Carlsson52d78a52009-09-27 18:58:34 +00001957 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smith02e85f32011-04-14 22:09:26 +00001958 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001959
Chris Lattner208ae962007-05-30 17:57:17 +00001960 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00001961 // LValue Expression Emission
1962 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00001963
Daniel Dunbarc79407f2009-02-05 07:09:07 +00001964 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1965 RValue GetUndefRValue(QualType Ty);
1966
Daniel Dunbarbb197e42009-01-09 16:50:52 +00001967 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1968 /// and issue an ErrorUnsupported style diagnostic (using the
1969 /// provided Name).
1970 RValue EmitUnsupportedRValue(const Expr *E,
1971 const char *Name);
1972
Mike Stumpfc496822009-02-08 23:14:22 +00001973 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
1974 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00001975 LValue EmitUnsupportedLValue(const Expr *E,
1976 const char *Name);
1977
Chris Lattner8394d792007-06-05 20:53:16 +00001978 /// EmitLValue - Emit code to compute a designator that specifies the location
1979 /// of the expression.
1980 ///
1981 /// This can return one of two things: a simple address or a bitfield
1982 /// reference. In either case, the LLVM Value* in the LValue structure is
1983 /// guaranteed to be an LLVM pointer type.
1984 ///
1985 /// If this returns a bitfield reference, nothing about the pointee type of
1986 /// the LLVM value is known: For example, it may not be a pointer to an
1987 /// integer.
1988 ///
1989 /// If this returns a normal address, and if the lvalue's C type is fixed
1990 /// size, this method guarantees that the returned pointer type will point to
1991 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
1992 /// variable length type, this is not possible.
1993 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00001994 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00001995
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001996 /// EmitCheckedLValue - Same as EmitLValue but additionally we generate
1997 /// checking code to guard against undefined behavior. This is only
1998 /// suitable when we know that the address will be used to access the
1999 /// object.
2000 LValue EmitCheckedLValue(const Expr *E);
2001
John McCall3a7f6922010-10-27 20:58:56 +00002002 /// EmitToMemory - Change a scalar value from its value
2003 /// representation to its in-memory representation.
2004 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2005
2006 /// EmitFromMemory - Change a scalar value from its memory
2007 /// representation to its value representation.
2008 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2009
Daniel Dunbar1d425462009-02-10 00:57:50 +00002010 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2011 /// care to appropriately convert from the memory representation to
2012 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002013 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002014 unsigned Alignment, QualType Ty,
2015 llvm::MDNode *TBAAInfo = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002016
2017 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2018 /// care to appropriately convert from the memory representation to
2019 /// the LLVM value representation. The l-value must be a simple
2020 /// l-value.
John McCall1553b192011-06-16 04:16:24 +00002021 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002022
2023 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2024 /// care to appropriately convert from the memory representation to
2025 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002026 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002027 bool Volatile, unsigned Alignment, QualType Ty,
2028 llvm::MDNode *TBAAInfo = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002029
2030 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2031 /// care to appropriately convert from the memory representation to
2032 /// the LLVM value representation. The l-value must be a simple
2033 /// l-value.
John McCall1553b192011-06-16 04:16:24 +00002034 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002035
Chris Lattner8394d792007-06-05 20:53:16 +00002036 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2037 /// this method emits the address of the lvalue, then loads the result as an
2038 /// rvalue, returning the rvalue.
John McCall55e1fbc2011-06-25 02:11:03 +00002039 RValue EmitLoadOfLValue(LValue V);
2040 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2041 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002042
Chris Lattner8394d792007-06-05 20:53:16 +00002043 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2044 /// lvalue, where both are guaranteed to the have the same type, and that type
2045 /// is 'Ty'.
John McCall55e1fbc2011-06-25 02:11:03 +00002046 void EmitStoreThroughLValue(RValue Src, LValue Dst);
2047 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002048
Mike Stumpfc496822009-02-08 23:14:22 +00002049 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2050 /// EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002051 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002052 /// \param Result [out] - If non-null, this will be set to a Value* for the
2053 /// bit-field contents after the store, appropriate for use as the result of
2054 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002055 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002056 llvm::Value **Result=0);
Mike Stumpfc496822009-02-08 23:14:22 +00002057
John McCall4f29b492010-11-16 23:07:28 +00002058 /// Emit an l-value for an assignment (simple or compound) of complex type.
2059 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002060 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall4f29b492010-11-16 23:07:28 +00002061
Chris Lattner57540c52011-04-15 05:22:18 +00002062 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002063 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002064 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002065 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002066 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002067 // Note: only available for agg return types
2068 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002069 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002070 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002071 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002072 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002073 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Chris Lattnerd9d2fb12007-06-08 23:31:14 +00002074 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002075 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002076 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002077 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002078 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002079 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002080 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregor747eb782010-07-08 06:14:04 +00002081 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002082 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002083 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002084
John McCallfe96e0b2011-11-06 09:01:30 +00002085 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2086 AggValueSlot slot = AggValueSlot::ignored());
2087 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2088
Daniel Dunbar722f4242009-04-22 05:08:15 +00002089 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002090 const ObjCIvarDecl *Ivar);
John McCallc4094932010-05-21 01:18:57 +00002091 LValue EmitLValueForAnonRecordField(llvm::Value* Base,
Francois Pichetd583da02010-12-04 09:14:42 +00002092 const IndirectFieldDecl* Field,
John McCallc4094932010-05-21 01:18:57 +00002093 unsigned CVRQualifiers);
Anders Carlssoncfd30122009-11-17 03:57:07 +00002094 LValue EmitLValueForField(llvm::Value* Base, const FieldDecl* Field,
Anders Carlsson5d8645b2010-01-29 05:05:36 +00002095 unsigned CVRQualifiers);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002096
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002097 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2098 /// if the Field is a reference, this will return the address of the reference
2099 /// and not the address of the value stored in the reference.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002100 LValue EmitLValueForFieldInitialization(llvm::Value* Base,
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002101 const FieldDecl* Field,
2102 unsigned CVRQualifiers);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002103
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002104 LValue EmitLValueForIvar(QualType ObjectTy,
2105 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002106 unsigned CVRQualifiers);
2107
Anders Carlssoncfd30122009-11-17 03:57:07 +00002108 LValue EmitLValueForBitfield(llvm::Value* Base, const FieldDecl* Field,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00002109 unsigned CVRQualifiers);
Fariborz Jahanianb517e902008-12-15 20:35:07 +00002110
Mike Stump1db7d042009-02-28 09:07:16 +00002111 LValue EmitBlockDeclRefLValue(const BlockDeclRefExpr *E);
2112
Anders Carlsson3be22e22009-05-30 23:23:33 +00002113 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002114 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002115 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002116
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002117 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002118 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002119 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002120 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002121 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCalla2fabff2010-10-09 01:34:31 +00002122 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002123
Chris Lattnerd7f58862007-06-02 05:24:33 +00002124 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002125 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002126 //===--------------------------------------------------------------------===//
2127
Mike Stumpfc496822009-02-08 23:14:22 +00002128 /// EmitCall - Generate a call of the given function, expecting the given
2129 /// result type, and using the given argument list which specifies both the
2130 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002131 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002132 /// \param TargetDecl - If given, the decl of the function in a direct call;
2133 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002134 RValue EmitCall(const CGFunctionInfo &FnInfo,
2135 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002136 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002137 const CallArgList &Args,
David Chisnall9eecafa2010-05-01 11:15:56 +00002138 const Decl *TargetDecl = 0,
David Chisnallff5f88c2010-05-02 13:41:58 +00002139 llvm::Instruction **callOrInvoke = 0);
Mike Stump11289f42009-09-09 15:08:12 +00002140
Anders Carlsson0435ed52009-12-24 19:08:58 +00002141 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlsson17490832009-12-24 20:40:36 +00002142 ReturnValueSlot ReturnValue,
Anders Carlsson3a9463b2009-05-27 01:22:39 +00002143 CallExpr::const_arg_iterator ArgBeg,
2144 CallExpr::const_arg_iterator ArgEnd,
2145 const Decl *TargetDecl = 0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002146 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002147 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002148
John McCallbd309292010-07-06 01:34:17 +00002149 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002150 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002151 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002152 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002153 const Twine &Name = "");
John McCallbd309292010-07-06 01:34:17 +00002154
Anders Carlssone828c362009-11-13 04:45:41 +00002155 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2192fe52011-07-18 04:24:23 +00002156 llvm::Type *Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002157 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2192fe52011-07-18 04:24:23 +00002158 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002159 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2160 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002161 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002162
2163 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2164 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002165 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002166
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002167 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
2168 llvm::Value *Callee,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002169 ReturnValueSlot ReturnValue,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002170 llvm::Value *This,
Anders Carlssone36a6b32010-01-02 01:01:18 +00002171 llvm::Value *VTT,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002172 CallExpr::const_arg_iterator ArgBeg,
2173 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002174 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2175 ReturnValueSlot ReturnValue);
2176 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2177 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002178
Anders Carlssonc36783e2011-05-08 20:32:23 +00002179 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2180 const CXXMethodDecl *MD,
2181 llvm::Value *This);
Anders Carlsson4034a952009-05-27 04:18:27 +00002182 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002183 const CXXMethodDecl *MD,
2184 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002185
Peter Collingbournefe883422011-10-06 18:29:37 +00002186 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2187 ReturnValueSlot ReturnValue);
2188
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002189
Mike Stump11289f42009-09-09 15:08:12 +00002190 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbar8eb018a2009-02-16 22:43:43 +00002191 unsigned BuiltinID, const CallExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002192
Anders Carlssonbfb36712009-12-24 21:13:40 +00002193 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002194
Mike Stumpfc496822009-02-08 23:14:22 +00002195 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2196 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002197 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2198
Chris Lattner5cc15e02010-03-03 19:03:45 +00002199 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002200 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002201 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002202 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002203 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002204 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002205 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002206 bool negateForRightShift);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002207
Chris Lattner01cf8db2011-07-20 06:58:45 +00002208 llvm::Value *BuildVector(const SmallVectorImpl<llvm::Value*> &Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002209 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tony Linthicum76329bf2011-12-12 21:14:55 +00002210 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Anders Carlsson895af082007-12-09 23:17:02 +00002211 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002212
Daniel Dunbar66912a12008-08-20 00:28:19 +00002213 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002214 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002215 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002216 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2217 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002218
John McCall31168b02011-06-15 23:02:42 +00002219 /// Retrieves the default cleanup kind for an ARC cleanup.
2220 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2221 CleanupKind getARCCleanupKind() {
2222 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2223 ? NormalAndEHCleanup : NormalCleanup;
2224 }
2225
2226 // ARC primitives.
2227 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2228 void EmitARCDestroyWeak(llvm::Value *addr);
2229 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2230 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2231 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2232 bool ignored);
2233 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2234 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2235 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2236 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002237 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
2238 bool ignored);
John McCall31168b02011-06-15 23:02:42 +00002239 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2240 bool ignored);
2241 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2242 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002243 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall31168b02011-06-15 23:02:42 +00002244 void EmitARCRelease(llvm::Value *value, bool precise);
2245 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2246 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2247 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2248 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2249
2250 std::pair<LValue,llvm::Value*>
2251 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2252 std::pair<LValue,llvm::Value*>
2253 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2254
John McCall248512a2011-10-01 10:32:24 +00002255 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2256
John McCall31168b02011-06-15 23:02:42 +00002257 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2258 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2259 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2260
John McCallff613032011-10-04 06:23:45 +00002261 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002262 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2263 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2264
John McCall82fe67b2011-07-09 01:37:26 +00002265 static Destroyer destroyARCStrongImprecise;
2266 static Destroyer destroyARCStrongPrecise;
2267 static Destroyer destroyARCWeak;
2268
John McCall31168b02011-06-15 23:02:42 +00002269 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2270 llvm::Value *EmitObjCAutoreleasePoolPush();
2271 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2272 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2273 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2274
Anders Carlsson6f5a0152009-05-20 00:24:07 +00002275 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2276 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002277 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson04775f82010-06-26 16:35:32 +00002278 const NamedDecl *InitializedDecl);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002279
Chris Lattner6278e6a2007-08-11 00:04:45 +00002280 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002281 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002282 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002283
2284 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002285
2286 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2287 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002288 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002289
Chris Lattner3474c202007-08-26 06:48:56 +00002290 /// EmitScalarConversion - Emit a conversion from the specified type to the
2291 /// specified destination type, both of which are LLVM scalar types.
2292 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2293 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002294
Chris Lattner42e6b812007-08-26 16:34:22 +00002295 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002296 /// complex type to the specified destination type, where the destination type
2297 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002298 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2299 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002300
2301
John McCall7a626f62010-09-15 10:14:12 +00002302 /// EmitAggExpr - Emit the computation of the specified expression
2303 /// of aggregate type. The result is computed into the given slot,
2304 /// which may be null to indicate that the value is not needed.
Fariborz Jahanianb60e70f2010-09-16 00:20:07 +00002305 void EmitAggExpr(const Expr *E, AggValueSlot AS, bool IgnoreResult = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002306
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002307 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2308 /// aggregate type into a temporary LValue.
2309 LValue EmitAggExprToLValue(const Expr *E);
2310
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002311 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2312 /// pointers.
2313 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002314 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002315
John McCall1bd25562011-06-24 23:21:27 +00002316 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2317 /// make sure it survives garbage collection until this point.
2318 void EmitExtendGCLifetime(llvm::Value *object);
2319
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002320 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002321 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002322 ComplexPairTy EmitComplexExpr(const Expr *E,
2323 bool IgnoreReal = false,
2324 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002325
Chris Lattner08b15df2007-08-23 23:43:33 +00002326 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
2327 /// of complex type, storing into the specified Value*.
Chris Lattnerb84bb952007-08-26 16:22:13 +00002328 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
2329 bool DestIsVolatile);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002330
2331 /// StoreComplexToAddr - Store a complex number into the specified address.
2332 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
2333 bool DestIsVolatile);
Chris Lattner4647a212007-08-31 22:49:20 +00002334 /// LoadComplexFromAddr - Load a complex number from the specified address.
2335 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002336
John McCall1c9c3fd2010-10-15 04:57:14 +00002337 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2338 /// a static local variable.
2339 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2340 const char *Separator,
Mike Stumpe5311b02009-11-30 20:08:49 +00002341 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002342
John McCall1c9c3fd2010-10-15 04:57:14 +00002343 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
Chris Lattnere99c1102009-12-05 08:22:11 +00002344 /// global variable that has already been created for it. If the initializer
2345 /// has a different type than GV does, this may free GV and return a different
2346 /// one. Otherwise it just returns GV.
2347 llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +00002348 AddInitializerToStaticVarDecl(const VarDecl &D,
2349 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002350
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002351
Anders Carlssonf40886a2009-08-08 21:45:14 +00002352 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2353 /// variable with global storage.
2354 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr);
2355
2356 /// EmitCXXGlobalDtorRegistration - Emits a call to register the global ptr
2357 /// with the C++ runtime so that its destructor will be called at exit.
Fariborz Jahanian1254a092009-11-10 19:24:06 +00002358 void EmitCXXGlobalDtorRegistration(llvm::Constant *DtorFn,
Anders Carlssonf40886a2009-08-08 21:45:14 +00002359 llvm::Constant *DeclPtr);
Mike Stump11289f42009-09-09 15:08:12 +00002360
John McCallcdf7ef52010-11-06 09:44:32 +00002361 /// Emit code in this function to perform a guarded variable
2362 /// initialization. Guarded initializations are used when it's not
2363 /// possible to prove that an initialization will be done exactly
2364 /// once, e.g. with a static local variable or a static data member
2365 /// of a class template.
2366 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr);
John McCall68ff0372010-09-08 01:44:27 +00002367
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002368 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2369 /// variables.
2370 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2371 llvm::Constant **Decls,
2372 unsigned NumDecls);
2373
2374 /// GenerateCXXGlobalDtorFunc - Generates code for destroying global
2375 /// variables.
2376 void GenerateCXXGlobalDtorFunc(llvm::Function *Fn,
Chris Lattner87233f72010-06-19 05:52:45 +00002377 const std::vector<std::pair<llvm::WeakVH,
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002378 llvm::Constant*> > &DtorsAndObjects);
2379
John McCalla738c252011-03-09 04:27:21 +00002380 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2381 const VarDecl *D,
John McCallcdf7ef52010-11-06 09:44:32 +00002382 llvm::GlobalVariable *Addr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002383
John McCall7a626f62010-09-15 10:14:12 +00002384 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002385
2386 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002387 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002388
John McCall08ef4662011-11-10 08:15:53 +00002389 void enterFullExpression(const ExprWithCleanups *E) {
2390 if (E->getNumObjects() == 0) return;
2391 enterNonTrivialFullExpression(E);
2392 }
2393 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002394
Anders Carlsson4b08db72009-10-30 01:42:31 +00002395 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002396
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002397 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2398
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002399 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002400 // Annotations Emission
2401 //===--------------------------------------------------------------------===//
2402
2403 /// Emit an annotation call (intrinsic or builtin).
2404 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2405 llvm::Value *AnnotatedVal,
2406 llvm::StringRef AnnotationStr,
2407 SourceLocation Location);
2408
2409 /// Emit local annotations for the local variable V, declared by D.
2410 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2411
2412 /// Emit field annotations for the given field & value. Returns the
2413 /// annotation result.
2414 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2415
2416 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002417 // Internal Helpers
2418 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002419
Chris Lattner5b1964b2008-11-11 07:41:27 +00002420 /// ContainsLabel - Return true if the statement contains a label in it. If
2421 /// this statement is not executed normally, it not containing a label means
2422 /// that we can just remove the code.
2423 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002424
Chris Lattner29911cc2011-02-28 00:18:40 +00002425 /// containsBreak - Return true if the statement contains a break out of it.
2426 /// If the statement (recursively) contains a switch or loop with a break
2427 /// inside of it, this is fine.
2428 static bool containsBreak(const Stmt *S);
2429
Daniel Dunbar682712c2008-11-12 10:12:14 +00002430 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002431 /// to a constant, or if it does but contains a label, return false. If it
2432 /// constant folds return true and set the boolean result in Result.
2433 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002434
Chris Lattner29911cc2011-02-28 00:18:40 +00002435 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2436 /// to a constant, or if it does but contains a label, return false. If it
2437 /// constant folds return true and set the folded value.
2438 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APInt &Result);
2439
Chris Lattnercd439292008-11-12 08:04:58 +00002440 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2441 /// if statement) to the specified blocks. Based on the condition, this might
2442 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002443 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar682712c2008-11-12 10:12:14 +00002444 llvm::BasicBlock *FalseBlock);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002445
Mike Stumpe8c3b3e2009-12-15 00:35:12 +00002446 /// getTrapBB - Create a basic block that will call the trap intrinsic. We'll
2447 /// generate a branch around the created basic block as necessary.
Chris Lattner26008e02010-07-20 20:19:24 +00002448 llvm::BasicBlock *getTrapBB();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002449
Anders Carlsson093bdff2010-03-30 03:27:09 +00002450 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002451 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002452
John McCall23f66262010-05-26 22:34:26 +00002453 /// EmitDelegateCallArg - We are performing a delegate call; that
2454 /// is, the current function is delegating to another one. Produce
2455 /// a r-value suitable for passing the given parameter.
John McCall32ea9692011-03-11 20:59:21 +00002456 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall23f66262010-05-26 22:34:26 +00002457
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002458 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2459 /// point operation, expressed as the maximum relative error in ulp.
2460 void SetFPAccuracy(llvm::Value *Val, unsigned AccuracyN,
2461 unsigned AccuracyD = 1);
2462
Chris Lattnercd439292008-11-12 08:04:58 +00002463private:
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002464 void EmitReturnOfRValue(RValue RV, QualType Ty);
2465
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002466 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2467 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2468 ///
2469 /// \param AI - The first function argument of the expansion.
2470 /// \return The argument following the last expanded function
2471 /// argument.
Mike Stumpfc496822009-02-08 23:14:22 +00002472 llvm::Function::arg_iterator
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002473 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2474 llvm::Function::arg_iterator AI);
2475
Mike Stumpfc496822009-02-08 23:14:22 +00002476 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2477 /// Ty, into individual arguments on the provided vector \arg Args. See
2478 /// ABIArgInfo::Expand.
2479 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002480 SmallVector<llvm::Value*, 16> &Args,
Chris Lattnerd59d8672011-07-12 06:29:11 +00002481 llvm::FunctionType *IRFuncTy);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002482
Mike Stump11289f42009-09-09 15:08:12 +00002483 llvm::Value* EmitAsmInput(const AsmStmt &S,
Daniel Dunbard53e07b2009-05-04 06:56:16 +00002484 const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002485 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002486
Eli Friedmaneca55af2010-07-16 00:55:21 +00002487 llvm::Value* EmitAsmInputLValue(const AsmStmt &S,
2488 const TargetInfo::ConstraintInfo &Info,
2489 LValue InputValue, QualType InputType,
2490 std::string &ConstraintStr);
2491
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002492 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump11289f42009-09-09 15:08:12 +00002493 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlsson603d6af2009-04-18 20:20:22 +00002494 /// argument types of the function being called.
2495 template<typename T>
2496 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002497 CallExpr::const_arg_iterator ArgBeg,
Anders Carlsson603d6af2009-04-18 20:20:22 +00002498 CallExpr::const_arg_iterator ArgEnd) {
2499 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002500
Anders Carlsson603d6af2009-04-18 20:20:22 +00002501 // First, use the argument types that the type info knows about
2502 if (CallArgTypeInfo) {
2503 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2504 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman794290c2009-11-18 03:42:04 +00002505 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlsson603d6af2009-04-18 20:20:22 +00002506 QualType ArgType = *I;
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002507#ifndef NDEBUG
2508 QualType ActualArgType = Arg->getType();
2509 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002510 QualType ActualBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002511 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002512 QualType ArgBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002513 ArgType->getAs<PointerType>()->getPointeeType();
2514 if (ArgBaseType->isVariableArrayType()) {
2515 if (const VariableArrayType *VAT =
2516 getContext().getAsVariableArrayType(ActualBaseType)) {
2517 if (!VAT->getSizeExpr())
2518 ActualArgType = ArgType;
2519 }
2520 }
2521 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002522 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump11289f42009-09-09 15:08:12 +00002523 getTypePtr() ==
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002524 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlsson603d6af2009-04-18 20:20:22 +00002525 "type mismatch in call argument!");
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002526#endif
John McCall32ea9692011-03-11 20:59:21 +00002527 EmitCallArg(Args, *Arg, ArgType);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002528 }
Mike Stump11289f42009-09-09 15:08:12 +00002529
2530 // Either we've emitted all the call args, or we have a call to a
Anders Carlsson603d6af2009-04-18 20:20:22 +00002531 // variadic function.
Mike Stump11289f42009-09-09 15:08:12 +00002532 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlsson603d6af2009-04-18 20:20:22 +00002533 "Extra arguments in non-variadic function!");
Mike Stump11289f42009-09-09 15:08:12 +00002534
Anders Carlsson603d6af2009-04-18 20:20:22 +00002535 }
Mike Stump11289f42009-09-09 15:08:12 +00002536
Anders Carlsson603d6af2009-04-18 20:20:22 +00002537 // If we still have any arguments, emit them using the type of the argument.
John McCall32ea9692011-03-11 20:59:21 +00002538 for (; Arg != ArgEnd; ++Arg)
2539 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlsson603d6af2009-04-18 20:20:22 +00002540 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002541
2542 const TargetCodeGenInfo &getTargetHooks() const {
2543 return CGM.getTargetCodeGenInfo();
2544 }
John McCall09ae0322010-07-06 23:57:41 +00002545
2546 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002547
2548 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002549 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002550 const AutoVarEmission &emission);
Chris Lattnerbed31442007-05-28 01:07:47 +00002551};
Mike Stump11289f42009-09-09 15:08:12 +00002552
John McCallce1de612011-01-26 04:00:11 +00002553/// Helper class with most of the code for saving a value for a
2554/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002555struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002556 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2557
2558 /// Answer whether the given value needs extra work to be saved.
2559 static bool needsSaving(llvm::Value *value) {
2560 // If it's not an instruction, we don't need to save.
2561 if (!isa<llvm::Instruction>(value)) return false;
2562
2563 // If it's an instruction in the entry block, we don't need to save.
2564 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2565 return (block != &block->getParent()->getEntryBlock());
2566 }
2567
2568 /// Try to save the given value.
2569 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2570 if (!needsSaving(value)) return saved_type(value, false);
2571
2572 // Otherwise we need an alloca.
2573 llvm::Value *alloca =
2574 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2575 CGF.Builder.CreateStore(value, alloca);
2576
2577 return saved_type(alloca, true);
2578 }
2579
2580 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2581 if (!value.getInt()) return value.getPointer();
2582 return CGF.Builder.CreateLoad(value.getPointer());
2583 }
2584};
2585
John McCallcb5f77f2011-01-28 10:53:53 +00002586/// A partial specialization of DominatingValue for llvm::Values that
2587/// might be llvm::Instructions.
2588template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2589 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002590 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002591 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2592 }
2593};
2594
2595/// A specialization of DominatingValue for RValue.
2596template <> struct DominatingValue<RValue> {
2597 typedef RValue type;
2598 class saved_type {
2599 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2600 AggregateAddress, ComplexAddress };
2601
2602 llvm::Value *Value;
2603 Kind K;
2604 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2605
2606 public:
2607 static bool needsSaving(RValue value);
2608 static saved_type save(CodeGenFunction &CGF, RValue value);
2609 RValue restore(CodeGenFunction &CGF);
2610
2611 // implementations in CGExprCXX.cpp
2612 };
2613
2614 static bool needsSaving(type value) {
2615 return saved_type::needsSaving(value);
2616 }
2617 static saved_type save(CodeGenFunction &CGF, type value) {
2618 return saved_type::save(CGF, value);
2619 }
2620 static type restore(CodeGenFunction &CGF, saved_type value) {
2621 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002622 }
2623};
2624
Chris Lattnerbed31442007-05-28 01:07:47 +00002625} // end namespace CodeGen
2626} // end namespace clang
Chris Lattnerbed31442007-05-28 01:07:47 +00002627
2628#endif