blob: 717f319fd35f36cf960f7e253844fa0aa8f966a4 [file] [log] [blame]
Daniel Dunbarbd012ff2008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Reid Spencer5f016e22007-07-11 17:01:13 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stump0dd9e882009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Reid Spencer5f016e22007-07-11 17:01:13 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattneref52a2f2008-02-29 17:10:38 +000014#ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15#define CLANG_CODEGEN_CODEGENFUNCTION_H
Reid Spencer5f016e22007-07-11 17:01:13 +000016
Chris Lattner391d77a2008-03-30 23:03:07 +000017#include "clang/AST/Type.h"
Argyrios Kyrtzidise3a09e62008-09-10 02:36:38 +000018#include "clang/AST/ExprCXX.h"
Ted Kremenek55499762008-06-17 02:43:46 +000019#include "clang/AST/ExprObjC.h"
Ken Dyck199c3d62010-01-11 17:06:35 +000020#include "clang/AST/CharUnits.h"
John McCallf85e1932011-06-15 23:02:42 +000021#include "clang/Frontend/CodeGenOptions.h"
Peter Collingbourne14110472011-01-13 18:57:25 +000022#include "clang/Basic/ABI.h"
Chris Lattner481769b2009-03-31 22:17:44 +000023#include "clang/Basic/TargetInfo.h"
24#include "llvm/ADT/DenseMap.h"
25#include "llvm/ADT/SmallVector.h"
26#include "llvm/Support/ValueHandle.h"
Owen Anderson69243822009-07-13 04:10:07 +000027#include "CodeGenModule.h"
Daniel Dunbar45d196b2008-11-01 01:53:16 +000028#include "CGBuilder.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000029#include "CGValue.h"
30
Reid Spencer5f016e22007-07-11 17:01:13 +000031namespace llvm {
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000032 class BasicBlock;
Benjamin Kramerf21efe92009-08-11 17:46:57 +000033 class LLVMContext;
David Chisnalldd5c98f2010-05-01 11:15:56 +000034 class MDNode;
Reid Spencer5f016e22007-07-11 17:01:13 +000035 class Module;
Daniel Dunbar898d5082008-09-30 01:06:03 +000036 class SwitchInst;
Daniel Dunbar259e9cc2009-10-19 01:21:05 +000037 class Twine;
Daniel Dunbared3849b2008-11-19 09:36:46 +000038 class Value;
John McCallf1549f62010-07-06 01:34:17 +000039 class CallSite;
Reid Spencer5f016e22007-07-11 17:01:13 +000040}
41
42namespace clang {
Devang Patel8d308382010-08-10 07:24:25 +000043 class APValue;
Reid Spencer5f016e22007-07-11 17:01:13 +000044 class ASTContext;
Anders Carlsson7267c162009-05-29 21:03:38 +000045 class CXXDestructorDecl;
Richard Smithad762fc2011-04-14 22:09:26 +000046 class CXXForRangeStmt;
Anders Carlsson6815e942009-09-27 18:58:34 +000047 class CXXTryStmt;
Reid Spencer5f016e22007-07-11 17:01:13 +000048 class Decl;
Chris Lattnerad8dcf42011-02-17 07:39:24 +000049 class LabelDecl;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000050 class EnumConstantDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000051 class FunctionDecl;
Douglas Gregor72564e72009-02-26 23:50:07 +000052 class FunctionProtoType;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000053 class LabelStmt;
Fariborz Jahanian679a5022009-01-10 21:06:09 +000054 class ObjCContainerDecl;
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +000055 class ObjCInterfaceDecl;
56 class ObjCIvarDecl;
Chris Lattner391d77a2008-03-30 23:03:07 +000057 class ObjCMethodDecl;
Fariborz Jahanianfef30b52008-12-09 20:23:04 +000058 class ObjCImplementationDecl;
Daniel Dunbaraf05bb92008-08-26 08:29:31 +000059 class ObjCPropertyImplDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000060 class TargetInfo;
John McCall492c4f92010-03-03 04:15:11 +000061 class TargetCodeGenInfo;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000062 class VarDecl;
Chris Lattner16f00492009-04-26 01:32:48 +000063 class ObjCForCollectionStmt;
64 class ObjCAtTryStmt;
65 class ObjCAtThrowStmt;
66 class ObjCAtSynchronizedStmt;
John McCallf85e1932011-06-15 23:02:42 +000067 class ObjCAutoreleasePoolStmt;
Devang Patelb84a06e2007-10-23 02:10:49 +000068
Reid Spencer5f016e22007-07-11 17:01:13 +000069namespace CodeGen {
Devang Patelb84a06e2007-10-23 02:10:49 +000070 class CodeGenTypes;
Anders Carlssone896d982009-02-13 08:11:52 +000071 class CGDebugInfo;
Daniel Dunbarbb36d332009-02-02 21:43:58 +000072 class CGFunctionInfo;
Mike Stump0dd9e882009-02-08 23:14:22 +000073 class CGRecordLayout;
John McCallee504292010-05-21 04:11:14 +000074 class CGBlockInfo;
John McCall4c40d982010-08-31 07:33:07 +000075 class CGCXXABI;
John McCalld16c2cf2011-02-08 08:22:06 +000076 class BlockFlags;
77 class BlockFieldFlags;
Mike Stump0dd9e882009-02-08 23:14:22 +000078
John McCallf1549f62010-07-06 01:34:17 +000079/// A branch fixup. These are required when emitting a goto to a
80/// label which hasn't been emitted yet. The goto is optimistically
81/// emitted as a branch to the basic block for the label, and (if it
82/// occurs in a scope with non-trivial cleanups) a fixup is added to
83/// the innermost cleanup. When a (normal) cleanup is popped, any
84/// unresolved fixups in that scope are threaded through the cleanup.
85struct BranchFixup {
John McCallff8e1152010-07-23 21:56:41 +000086 /// The block containing the terminator which needs to be modified
87 /// into a switch if this fixup is resolved into the current scope.
88 /// If null, LatestBranch points directly to the destination.
89 llvm::BasicBlock *OptimisticBranchBlock;
John McCallf1549f62010-07-06 01:34:17 +000090
John McCallff8e1152010-07-23 21:56:41 +000091 /// The ultimate destination of the branch.
John McCallf1549f62010-07-06 01:34:17 +000092 ///
93 /// This can be set to null to indicate that this fixup was
94 /// successfully resolved.
95 llvm::BasicBlock *Destination;
96
John McCallff8e1152010-07-23 21:56:41 +000097 /// The destination index value.
98 unsigned DestinationIndex;
99
100 /// The initial branch of the fixup.
101 llvm::BranchInst *InitialBranch;
John McCallf1549f62010-07-06 01:34:17 +0000102};
103
John McCall804b8072011-01-28 10:53:53 +0000104template <class T> struct InvariantValue {
John McCall150b4622011-01-26 04:00:11 +0000105 typedef T type;
106 typedef T saved_type;
107 static bool needsSaving(type value) { return false; }
108 static saved_type save(CodeGenFunction &CGF, type value) { return value; }
109 static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
110};
John McCall804b8072011-01-28 10:53:53 +0000111
112/// A metaprogramming class for ensuring that a value will dominate an
113/// arbitrary position in a function.
114template <class T> struct DominatingValue : InvariantValue<T> {};
115
116template <class T, bool mightBeInstruction =
117 llvm::is_base_of<llvm::Value, T>::value &&
118 !llvm::is_base_of<llvm::Constant, T>::value &&
119 !llvm::is_base_of<llvm::BasicBlock, T>::value>
120struct DominatingPointer;
121template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
122// template <class T> struct DominatingPointer<T,true> at end of file
123
124template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
John McCall150b4622011-01-26 04:00:11 +0000125
John McCallcd2d2b72010-08-13 21:20:51 +0000126enum CleanupKind {
127 EHCleanup = 0x1,
128 NormalCleanup = 0x2,
129 NormalAndEHCleanup = EHCleanup | NormalCleanup,
130
131 InactiveCleanup = 0x4,
132 InactiveEHCleanup = EHCleanup | InactiveCleanup,
133 InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
134 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
135};
John McCallda65ea82010-07-13 20:32:21 +0000136
John McCallf1549f62010-07-06 01:34:17 +0000137/// A stack of scopes which respond to exceptions, including cleanups
138/// and catch blocks.
139class EHScopeStack {
140public:
141 /// A saved depth on the scope stack. This is necessary because
142 /// pushing scopes onto the stack invalidates iterators.
143 class stable_iterator {
144 friend class EHScopeStack;
145
146 /// Offset from StartOfData to EndOfBuffer.
147 ptrdiff_t Size;
148
149 stable_iterator(ptrdiff_t Size) : Size(Size) {}
150
151 public:
152 static stable_iterator invalid() { return stable_iterator(-1); }
153 stable_iterator() : Size(-1) {}
154
155 bool isValid() const { return Size >= 0; }
156
John McCall838d7962010-08-14 07:46:19 +0000157 /// Returns true if this scope encloses I.
158 /// Returns false if I is invalid.
159 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000160 bool encloses(stable_iterator I) const { return Size <= I.Size; }
John McCall838d7962010-08-14 07:46:19 +0000161
162 /// Returns true if this scope strictly encloses I: that is,
163 /// if it encloses I and is not I.
164 /// Returns false is I is invalid.
165 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000166 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
John McCall1bda6622010-07-21 00:40:03 +0000167
John McCallf1549f62010-07-06 01:34:17 +0000168 friend bool operator==(stable_iterator A, stable_iterator B) {
169 return A.Size == B.Size;
170 }
171 friend bool operator!=(stable_iterator A, stable_iterator B) {
172 return A.Size != B.Size;
173 }
174 };
175
John McCall1f0fca52010-07-21 07:22:38 +0000176 /// Information for lazily generating a cleanup. Subclasses must be
177 /// POD-like: cleanups will not be destructed, and they will be
178 /// allocated on the cleanup stack and freely copied and moved
179 /// around.
John McCallda65ea82010-07-13 20:32:21 +0000180 ///
John McCall1f0fca52010-07-21 07:22:38 +0000181 /// Cleanup implementations should generally be declared in an
John McCallda65ea82010-07-13 20:32:21 +0000182 /// anonymous namespace.
John McCall1f0fca52010-07-21 07:22:38 +0000183 class Cleanup {
John McCallda65ea82010-07-13 20:32:21 +0000184 public:
John McCall3e29f962010-07-13 23:19:49 +0000185 // Anchor the construction vtable. We use the destructor because
186 // gcc gives an obnoxious warning if there are virtual methods
187 // with an accessible non-virtual destructor. Unfortunately,
188 // declaring this destructor makes it non-trivial, but there
189 // doesn't seem to be any other way around this warning.
190 //
191 // This destructor will never be called.
John McCall1f0fca52010-07-21 07:22:38 +0000192 virtual ~Cleanup();
John McCall3e29f962010-07-13 23:19:49 +0000193
John McCallda65ea82010-07-13 20:32:21 +0000194 /// Emit the cleanup. For normal cleanups, this is run in the
195 /// same EH context as when the cleanup was pushed, i.e. the
196 /// immediately-enclosing context of the cleanup scope. For
197 /// EH cleanups, this is run in a terminate context.
198 ///
199 // \param IsForEHCleanup true if this is for an EH cleanup, false
200 /// if for a normal cleanup.
201 virtual void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) = 0;
202 };
203
John McCall150b4622011-01-26 04:00:11 +0000204 /// UnconditionalCleanupN stores its N parameters and just passes
205 /// them to the real cleanup function.
John McCall3ad32c82011-01-28 08:37:24 +0000206 template <class T, class A0>
207 class UnconditionalCleanup1 : public Cleanup {
208 A0 a0;
209 public:
210 UnconditionalCleanup1(A0 a0) : a0(a0) {}
211 void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) {
212 T::Emit(CGF, IsForEHCleanup, a0);
213 }
214 };
215
John McCall150b4622011-01-26 04:00:11 +0000216 template <class T, class A0, class A1>
217 class UnconditionalCleanup2 : public Cleanup {
218 A0 a0; A1 a1;
John McCall4bbcbda2011-01-26 19:15:39 +0000219 public:
John McCall150b4622011-01-26 04:00:11 +0000220 UnconditionalCleanup2(A0 a0, A1 a1) : a0(a0), a1(a1) {}
221 void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) {
222 T::Emit(CGF, IsForEHCleanup, a0, a1);
223 }
224 };
225
Douglas Gregord7b23162011-06-22 16:12:01 +0000226 template <class T, class A0, class A1, class A2>
227 class UnconditionalCleanup3 : public Cleanup {
228 A0 a0; A1 a1; A2 a2;
229 public:
230 UnconditionalCleanup3(A0 a0, A1 a1, A2 a2) : a0(a0), a1(a1), a2(a2) {}
231 void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) {
232 T::Emit(CGF, IsForEHCleanup, a0, a1, a2);
233 }
234 };
235
John McCall150b4622011-01-26 04:00:11 +0000236 /// ConditionalCleanupN stores the saved form of its N parameters,
237 /// then restores them and performs the cleanup.
John McCall3ad32c82011-01-28 08:37:24 +0000238 template <class T, class A0>
239 class ConditionalCleanup1 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000240 typedef typename DominatingValue<A0>::saved_type A0_saved;
John McCall3ad32c82011-01-28 08:37:24 +0000241 A0_saved a0_saved;
242
243 void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) {
John McCall804b8072011-01-28 10:53:53 +0000244 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
John McCall3ad32c82011-01-28 08:37:24 +0000245 T::Emit(CGF, IsForEHCleanup, a0);
246 }
247
248 public:
249 ConditionalCleanup1(A0_saved a0)
250 : a0_saved(a0) {}
251 };
252
John McCall150b4622011-01-26 04:00:11 +0000253 template <class T, class A0, class A1>
John McCall3ad32c82011-01-28 08:37:24 +0000254 class ConditionalCleanup2 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000255 typedef typename DominatingValue<A0>::saved_type A0_saved;
256 typedef typename DominatingValue<A1>::saved_type A1_saved;
John McCall4bbcbda2011-01-26 19:15:39 +0000257 A0_saved a0_saved;
258 A1_saved a1_saved;
John McCall150b4622011-01-26 04:00:11 +0000259
John McCall3ad32c82011-01-28 08:37:24 +0000260 void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) {
John McCall804b8072011-01-28 10:53:53 +0000261 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
262 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
John McCall150b4622011-01-26 04:00:11 +0000263 T::Emit(CGF, IsForEHCleanup, a0, a1);
264 }
265
266 public:
John McCall3ad32c82011-01-28 08:37:24 +0000267 ConditionalCleanup2(A0_saved a0, A1_saved a1)
268 : a0_saved(a0), a1_saved(a1) {}
John McCall150b4622011-01-26 04:00:11 +0000269 };
270
Douglas Gregord7b23162011-06-22 16:12:01 +0000271 template <class T, class A0, class A1, class A2>
272 class ConditionalCleanup3 : public Cleanup {
273 typedef typename DominatingValue<A0>::saved_type A0_saved;
274 typedef typename DominatingValue<A1>::saved_type A1_saved;
275 typedef typename DominatingValue<A2>::saved_type A2_saved;
276 A0_saved a0_saved;
277 A1_saved a1_saved;
278 A2_saved a2_saved;
279
280 void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) {
281 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
282 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
283 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
284 T::Emit(CGF, IsForEHCleanup, a0, a1, a2);
285 }
286
287 public:
288 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
289 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
290 };
291
John McCallf1549f62010-07-06 01:34:17 +0000292private:
293 // The implementation for this class is in CGException.h and
294 // CGException.cpp; the definition is here because it's used as a
295 // member of CodeGenFunction.
296
297 /// The start of the scope-stack buffer, i.e. the allocated pointer
298 /// for the buffer. All of these pointers are either simultaneously
299 /// null or simultaneously valid.
300 char *StartOfBuffer;
301
302 /// The end of the buffer.
303 char *EndOfBuffer;
304
305 /// The first valid entry in the buffer.
306 char *StartOfData;
307
308 /// The innermost normal cleanup on the stack.
309 stable_iterator InnermostNormalCleanup;
310
311 /// The innermost EH cleanup on the stack.
312 stable_iterator InnermostEHCleanup;
313
314 /// The number of catches on the stack.
315 unsigned CatchDepth;
316
John McCallff8e1152010-07-23 21:56:41 +0000317 /// The current EH destination index. Reset to FirstCatchIndex
318 /// whenever the last EH cleanup is popped.
319 unsigned NextEHDestIndex;
320 enum { FirstEHDestIndex = 1 };
321
John McCallf1549f62010-07-06 01:34:17 +0000322 /// The current set of branch fixups. A branch fixup is a jump to
323 /// an as-yet unemitted label, i.e. a label for which we don't yet
324 /// know the EH stack depth. Whenever we pop a cleanup, we have
325 /// to thread all the current branch fixups through it.
326 ///
327 /// Fixups are recorded as the Use of the respective branch or
328 /// switch statement. The use points to the final destination.
329 /// When popping out of a cleanup, these uses are threaded through
330 /// the cleanup and adjusted to point to the new cleanup.
331 ///
332 /// Note that branches are allowed to jump into protected scopes
333 /// in certain situations; e.g. the following code is legal:
334 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
335 /// goto foo;
336 /// A a;
337 /// foo:
338 /// bar();
339 llvm::SmallVector<BranchFixup, 8> BranchFixups;
340
341 char *allocate(size_t Size);
342
John McCall1f0fca52010-07-21 07:22:38 +0000343 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCallda65ea82010-07-13 20:32:21 +0000344
John McCallf1549f62010-07-06 01:34:17 +0000345public:
346 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
347 InnermostNormalCleanup(stable_end()),
348 InnermostEHCleanup(stable_end()),
John McCallff8e1152010-07-23 21:56:41 +0000349 CatchDepth(0), NextEHDestIndex(FirstEHDestIndex) {}
John McCallf1549f62010-07-06 01:34:17 +0000350 ~EHScopeStack() { delete[] StartOfBuffer; }
351
John McCallda65ea82010-07-13 20:32:21 +0000352 // Variadic templates would make this not terrible.
353
354 /// Push a lazily-created cleanup on the stack.
John McCall8e3f8612010-07-13 22:12:14 +0000355 template <class T>
John McCall1f0fca52010-07-21 07:22:38 +0000356 void pushCleanup(CleanupKind Kind) {
357 void *Buffer = pushCleanup(Kind, sizeof(T));
358 Cleanup *Obj = new(Buffer) T();
John McCall8e3f8612010-07-13 22:12:14 +0000359 (void) Obj;
360 }
361
362 /// Push a lazily-created cleanup on the stack.
363 template <class T, class A0>
John McCall1f0fca52010-07-21 07:22:38 +0000364 void pushCleanup(CleanupKind Kind, A0 a0) {
365 void *Buffer = pushCleanup(Kind, sizeof(T));
366 Cleanup *Obj = new(Buffer) T(a0);
John McCall8e3f8612010-07-13 22:12:14 +0000367 (void) Obj;
368 }
369
370 /// Push a lazily-created cleanup on the stack.
John McCallda65ea82010-07-13 20:32:21 +0000371 template <class T, class A0, class A1>
John McCall1f0fca52010-07-21 07:22:38 +0000372 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
373 void *Buffer = pushCleanup(Kind, sizeof(T));
374 Cleanup *Obj = new(Buffer) T(a0, a1);
John McCallda65ea82010-07-13 20:32:21 +0000375 (void) Obj;
376 }
377
378 /// Push a lazily-created cleanup on the stack.
379 template <class T, class A0, class A1, class A2>
John McCall1f0fca52010-07-21 07:22:38 +0000380 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
381 void *Buffer = pushCleanup(Kind, sizeof(T));
382 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
John McCallda65ea82010-07-13 20:32:21 +0000383 (void) Obj;
384 }
385
386 /// Push a lazily-created cleanup on the stack.
387 template <class T, class A0, class A1, class A2, class A3>
John McCall1f0fca52010-07-21 07:22:38 +0000388 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
389 void *Buffer = pushCleanup(Kind, sizeof(T));
390 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
John McCallda65ea82010-07-13 20:32:21 +0000391 (void) Obj;
392 }
393
John McCall77199712010-07-21 05:47:49 +0000394 /// Push a lazily-created cleanup on the stack.
395 template <class T, class A0, class A1, class A2, class A3, class A4>
John McCall1f0fca52010-07-21 07:22:38 +0000396 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
397 void *Buffer = pushCleanup(Kind, sizeof(T));
398 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
John McCall77199712010-07-21 05:47:49 +0000399 (void) Obj;
400 }
401
John McCall7d8647f2010-09-14 07:57:04 +0000402 // Feel free to add more variants of the following:
403
404 /// Push a cleanup with non-constant storage requirements on the
405 /// stack. The cleanup type must provide an additional static method:
406 /// static size_t getExtraSize(size_t);
407 /// The argument to this method will be the value N, which will also
408 /// be passed as the first argument to the constructor.
409 ///
410 /// The data stored in the extra storage must obey the same
411 /// restrictions as normal cleanup member data.
412 ///
413 /// The pointer returned from this method is valid until the cleanup
414 /// stack is modified.
415 template <class T, class A0, class A1, class A2>
416 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
417 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
418 return new (Buffer) T(N, a0, a1, a2);
419 }
420
John McCallf1549f62010-07-06 01:34:17 +0000421 /// Pops a cleanup scope off the stack. This should only be called
422 /// by CodeGenFunction::PopCleanupBlock.
423 void popCleanup();
424
425 /// Push a set of catch handlers on the stack. The catch is
426 /// uninitialized and will need to have the given number of handlers
427 /// set on it.
428 class EHCatchScope *pushCatch(unsigned NumHandlers);
429
430 /// Pops a catch scope off the stack.
431 void popCatch();
432
433 /// Push an exceptions filter on the stack.
434 class EHFilterScope *pushFilter(unsigned NumFilters);
435
436 /// Pops an exceptions filter off the stack.
437 void popFilter();
438
439 /// Push a terminate handler on the stack.
440 void pushTerminate();
441
442 /// Pops a terminate handler off the stack.
443 void popTerminate();
444
445 /// Determines whether the exception-scopes stack is empty.
446 bool empty() const { return StartOfData == EndOfBuffer; }
447
448 bool requiresLandingPad() const {
449 return (CatchDepth || hasEHCleanups());
450 }
451
452 /// Determines whether there are any normal cleanups on the stack.
453 bool hasNormalCleanups() const {
454 return InnermostNormalCleanup != stable_end();
455 }
456
457 /// Returns the innermost normal cleanup on the stack, or
458 /// stable_end() if there are no normal cleanups.
459 stable_iterator getInnermostNormalCleanup() const {
460 return InnermostNormalCleanup;
461 }
John McCall838d7962010-08-14 07:46:19 +0000462 stable_iterator getInnermostActiveNormalCleanup() const; // CGException.h
John McCallf1549f62010-07-06 01:34:17 +0000463
464 /// Determines whether there are any EH cleanups on the stack.
465 bool hasEHCleanups() const {
466 return InnermostEHCleanup != stable_end();
467 }
468
469 /// Returns the innermost EH cleanup on the stack, or stable_end()
470 /// if there are no EH cleanups.
471 stable_iterator getInnermostEHCleanup() const {
472 return InnermostEHCleanup;
473 }
John McCall838d7962010-08-14 07:46:19 +0000474 stable_iterator getInnermostActiveEHCleanup() const; // CGException.h
John McCallf1549f62010-07-06 01:34:17 +0000475
476 /// An unstable reference to a scope-stack depth. Invalidated by
477 /// pushes but not pops.
478 class iterator;
479
480 /// Returns an iterator pointing to the innermost EH scope.
481 iterator begin() const;
482
483 /// Returns an iterator pointing to the outermost EH scope.
484 iterator end() const;
485
486 /// Create a stable reference to the top of the EH stack. The
487 /// returned reference is valid until that scope is popped off the
488 /// stack.
489 stable_iterator stable_begin() const {
490 return stable_iterator(EndOfBuffer - StartOfData);
491 }
492
493 /// Create a stable reference to the bottom of the EH stack.
494 static stable_iterator stable_end() {
495 return stable_iterator(0);
496 }
497
498 /// Translates an iterator into a stable_iterator.
499 stable_iterator stabilize(iterator it) const;
500
501 /// Finds the nearest cleanup enclosing the given iterator.
502 /// Returns stable_iterator::invalid() if there are no such cleanups.
503 stable_iterator getEnclosingEHCleanup(iterator it) const;
504
505 /// Turn a stable reference to a scope depth into a unstable pointer
506 /// to the EH stack.
507 iterator find(stable_iterator save) const;
508
509 /// Removes the cleanup pointed to by the given stable_iterator.
510 void removeCleanup(stable_iterator save);
511
512 /// Add a branch fixup to the current cleanup scope.
513 BranchFixup &addBranchFixup() {
514 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
515 BranchFixups.push_back(BranchFixup());
516 return BranchFixups.back();
517 }
518
519 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
520 BranchFixup &getBranchFixup(unsigned I) {
521 assert(I < getNumBranchFixups());
522 return BranchFixups[I];
523 }
524
John McCallff8e1152010-07-23 21:56:41 +0000525 /// Pops lazily-removed fixups from the end of the list. This
526 /// should only be called by procedures which have just popped a
527 /// cleanup or resolved one or more fixups.
528 void popNullFixups();
529
530 /// Clears the branch-fixups list. This should only be called by
John McCall8abdbd82010-09-18 02:24:39 +0000531 /// ResolveAllBranchFixups.
John McCallff8e1152010-07-23 21:56:41 +0000532 void clearFixups() { BranchFixups.clear(); }
533
534 /// Gets the next EH destination index.
535 unsigned getNextEHDestIndex() { return NextEHDestIndex++; }
John McCallf1549f62010-07-06 01:34:17 +0000536};
537
Reid Spencer5f016e22007-07-11 17:01:13 +0000538/// CodeGenFunction - This class organizes the per-function state that is used
539/// while generating LLVM code.
John McCall5936e332011-02-15 09:22:45 +0000540class CodeGenFunction : public CodeGenTypeCache {
Anders Carlsson8a219ce2009-02-24 04:21:31 +0000541 CodeGenFunction(const CodeGenFunction&); // DO NOT IMPLEMENT
542 void operator=(const CodeGenFunction&); // DO NOT IMPLEMENT
John McCall4c40d982010-08-31 07:33:07 +0000543
544 friend class CGCXXABI;
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000545public:
John McCallff8e1152010-07-23 21:56:41 +0000546 /// A jump destination is an abstract label, branching to which may
547 /// require a jump out through normal cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000548 struct JumpDest {
John McCallff8e1152010-07-23 21:56:41 +0000549 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
550 JumpDest(llvm::BasicBlock *Block,
551 EHScopeStack::stable_iterator Depth,
552 unsigned Index)
553 : Block(Block), ScopeDepth(Depth), Index(Index) {}
554
555 bool isValid() const { return Block != 0; }
556 llvm::BasicBlock *getBlock() const { return Block; }
557 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
558 unsigned getDestIndex() const { return Index; }
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000559
John McCallff8e1152010-07-23 21:56:41 +0000560 private:
John McCallf1549f62010-07-06 01:34:17 +0000561 llvm::BasicBlock *Block;
562 EHScopeStack::stable_iterator ScopeDepth;
John McCallff8e1152010-07-23 21:56:41 +0000563 unsigned Index;
564 };
565
566 /// An unwind destination is an abstract label, branching to which
567 /// may require a jump out through EH cleanups.
568 struct UnwindDest {
569 UnwindDest() : Block(0), ScopeDepth(), Index(0) {}
570 UnwindDest(llvm::BasicBlock *Block,
571 EHScopeStack::stable_iterator Depth,
572 unsigned Index)
573 : Block(Block), ScopeDepth(Depth), Index(Index) {}
574
575 bool isValid() const { return Block != 0; }
576 llvm::BasicBlock *getBlock() const { return Block; }
577 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
578 unsigned getDestIndex() const { return Index; }
579
580 private:
581 llvm::BasicBlock *Block;
582 EHScopeStack::stable_iterator ScopeDepth;
583 unsigned Index;
John McCallf1549f62010-07-06 01:34:17 +0000584 };
585
Reid Spencer5f016e22007-07-11 17:01:13 +0000586 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar444be732009-11-13 05:51:54 +0000587 const TargetInfo &Target;
Mike Stump0dd9e882009-02-08 23:14:22 +0000588
Chris Lattner58dee102007-08-21 16:57:55 +0000589 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000590 CGBuilderTy Builder;
Mike Stump0dd9e882009-02-08 23:14:22 +0000591
Chris Lattnerb5437d22009-04-23 05:30:27 +0000592 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
593 /// This excludes BlockDecls.
Chris Lattner41110242008-06-17 18:05:57 +0000594 const Decl *CurFuncDecl;
Chris Lattnerb5437d22009-04-23 05:30:27 +0000595 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
596 const Decl *CurCodeDecl;
Daniel Dunbar88b53962009-02-02 22:03:45 +0000597 const CGFunctionInfo *CurFnInfo;
Chris Lattner391d77a2008-03-30 23:03:07 +0000598 QualType FnRetTy;
Reid Spencer5f016e22007-07-11 17:01:13 +0000599 llvm::Function *CurFn;
600
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000601 /// CurGD - The GlobalDecl for the current function being compiled.
602 GlobalDecl CurGD;
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000603
John McCallf85e1932011-06-15 23:02:42 +0000604 /// PrologueCleanupDepth - The cleanup depth enclosing all the
605 /// cleanups associated with the parameters.
606 EHScopeStack::stable_iterator PrologueCleanupDepth;
607
Daniel Dunbar5ca20842008-09-09 21:00:17 +0000608 /// ReturnBlock - Unified return block.
John McCallf1549f62010-07-06 01:34:17 +0000609 JumpDest ReturnBlock;
610
Mike Stump0dd9e882009-02-08 23:14:22 +0000611 /// ReturnValue - The temporary alloca to hold the return value. This is null
612 /// iff the function has no return value.
Eli Friedmanb17daf92009-12-04 02:43:40 +0000613 llvm::Value *ReturnValue;
Mike Stump0dd9e882009-02-08 23:14:22 +0000614
John McCallff8e1152010-07-23 21:56:41 +0000615 /// RethrowBlock - Unified rethrow block.
616 UnwindDest RethrowBlock;
617
Reid Spencer5f016e22007-07-11 17:01:13 +0000618 /// AllocaInsertPoint - This is an instruction in the entry block before which
619 /// we prefer to insert allocas.
Chris Lattner481769b2009-03-31 22:17:44 +0000620 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000621
Mike Stump9c276ae2009-12-12 01:27:46 +0000622 bool CatchUndefined;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000623
John McCallf85e1932011-06-15 23:02:42 +0000624 /// In ARC, whether we should autorelease the return value.
625 bool AutoreleaseResult;
626
John McCalld16c2cf2011-02-08 08:22:06 +0000627 const CodeGen::CGBlockInfo *BlockInfo;
628 llvm::Value *BlockPointer;
629
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000630 /// \brief A mapping from NRVO variables to the flags used to indicate
631 /// when the NRVO has been applied to this variable.
632 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000633
John McCallf1549f62010-07-06 01:34:17 +0000634 EHScopeStack EHStack;
635
John McCallff8e1152010-07-23 21:56:41 +0000636 /// i32s containing the indexes of the cleanup destinations.
637 llvm::AllocaInst *NormalCleanupDest;
638 llvm::AllocaInst *EHCleanupDest;
639
640 unsigned NextCleanupDestIndex;
641
John McCallf1549f62010-07-06 01:34:17 +0000642 /// The exception slot. All landing pads write the current
643 /// exception pointer into this alloca.
644 llvm::Value *ExceptionSlot;
645
John McCall93c332a2011-05-28 21:13:02 +0000646 /// The selector slot. Under the MandatoryCleanup model, all
647 /// landing pads write the current selector value into this alloca.
648 llvm::AllocaInst *EHSelectorSlot;
649
John McCallf1549f62010-07-06 01:34:17 +0000650 /// Emits a landing pad for the current EH stack.
651 llvm::BasicBlock *EmitLandingPad();
652
653 llvm::BasicBlock *getInvokeDestImpl();
654
John McCall3ad32c82011-01-28 08:37:24 +0000655 /// Set up the last cleaup that was pushed as a conditional
656 /// full-expression cleanup.
657 void initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000658
659 template <class T>
John McCall804b8072011-01-28 10:53:53 +0000660 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
661 return DominatingValue<T>::save(*this, value);
John McCall150b4622011-01-26 04:00:11 +0000662 }
663
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000664public:
Anders Carlssonfa1f7562009-02-10 06:07:49 +0000665 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
666 /// rethrows.
Anders Carlsson273558f2009-02-07 21:37:21 +0000667 llvm::SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stump0dd9e882009-02-08 23:14:22 +0000668
John McCalld768e9d2011-06-22 02:32:12 +0000669 /// A class controlling the emission of a finally block.
670 class FinallyInfo {
671 /// Where the catchall's edge through the cleanup should go.
672 JumpDest RethrowDest;
Anders Carlssonbb66f9f2009-02-08 07:46:24 +0000673
John McCalld768e9d2011-06-22 02:32:12 +0000674 /// A function to call to enter the catch.
675 llvm::Constant *BeginCatchFn;
676
677 /// An i1 variable indicating whether or not the @finally is
678 /// running for an exception.
679 llvm::AllocaInst *ForEHVar;
680
681 /// An i8* variable into which the exception pointer to rethrow
682 /// has been saved.
683 llvm::AllocaInst *SavedExnVar;
684
685 public:
686 void enter(CodeGenFunction &CGF, const Stmt *Finally,
687 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
688 llvm::Constant *rethrowFn);
689 void exit(CodeGenFunction &CGF);
690 };
Mike Stumpd88ea562009-12-09 03:35:49 +0000691
John McCall150b4622011-01-26 04:00:11 +0000692 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
693 /// current full-expression. Safe against the possibility that
694 /// we're currently inside a conditionally-evaluated expression.
John McCall3ad32c82011-01-28 08:37:24 +0000695 template <class T, class A0>
696 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
697 // If we're not in a conditional branch, or if none of the
698 // arguments requires saving, then use the unconditional cleanup.
699 if (!isInConditionalBranch()) {
700 typedef EHScopeStack::UnconditionalCleanup1<T, A0> CleanupType;
701 return EHStack.pushCleanup<CleanupType>(kind, a0);
702 }
703
John McCall804b8072011-01-28 10:53:53 +0000704 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCall3ad32c82011-01-28 08:37:24 +0000705
706 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
707 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
708 initFullExprCleanup();
709 }
710
711 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
712 /// current full-expression. Safe against the possibility that
713 /// we're currently inside a conditionally-evaluated expression.
John McCall150b4622011-01-26 04:00:11 +0000714 template <class T, class A0, class A1>
715 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
716 // If we're not in a conditional branch, or if none of the
717 // arguments requires saving, then use the unconditional cleanup.
John McCall3ad32c82011-01-28 08:37:24 +0000718 if (!isInConditionalBranch()) {
John McCall150b4622011-01-26 04:00:11 +0000719 typedef EHScopeStack::UnconditionalCleanup2<T, A0, A1> CleanupType;
720 return EHStack.pushCleanup<CleanupType>(kind, a0, a1);
721 }
722
John McCall804b8072011-01-28 10:53:53 +0000723 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
724 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCall150b4622011-01-26 04:00:11 +0000725
726 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCall3ad32c82011-01-28 08:37:24 +0000727 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
728 initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000729 }
730
Douglas Gregord7b23162011-06-22 16:12:01 +0000731 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
732 /// current full-expression. Safe against the possibility that
733 /// we're currently inside a conditionally-evaluated expression.
734 template <class T, class A0, class A1, class A2>
735 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
736 // If we're not in a conditional branch, or if none of the
737 // arguments requires saving, then use the unconditional cleanup.
738 if (!isInConditionalBranch()) {
739 typedef EHScopeStack::UnconditionalCleanup3<T, A0, A1, A2> CleanupType;
740 return EHStack.pushCleanup<CleanupType>(kind, a0, a1, a2);
741 }
742
743 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
744 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
745 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
746
747 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
748 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
749 initFullExprCleanup();
750 }
751
John McCallf1549f62010-07-06 01:34:17 +0000752 /// PushDestructorCleanup - Push a cleanup to call the
753 /// complete-object destructor of an object of the given type at the
754 /// given address. Does nothing if T is not a C++ class type with a
755 /// non-trivial destructor.
756 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
757
John McCall81407d42010-07-21 06:29:51 +0000758 /// PushDestructorCleanup - Push a cleanup to call the
759 /// complete-object variant of the given destructor on the object at
760 /// the given address.
761 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
762 llvm::Value *Addr);
763
John McCallf1549f62010-07-06 01:34:17 +0000764 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
765 /// process all branch fixups.
John McCallff8e1152010-07-23 21:56:41 +0000766 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallf1549f62010-07-06 01:34:17 +0000767
John McCall7d8647f2010-09-14 07:57:04 +0000768 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
769 /// The block cannot be reactivated. Pops it if it's the top of the
770 /// stack.
771 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup);
772
773 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
774 /// Cannot be used to resurrect a deactivated cleanup.
775 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup);
John McCallcd2d2b72010-08-13 21:20:51 +0000776
John McCallf1549f62010-07-06 01:34:17 +0000777 /// \brief Enters a new scope for capturing cleanups, all of which
778 /// will be executed once the scope is exited.
779 class RunCleanupsScope {
Douglas Gregor01234bb2009-11-24 16:43:22 +0000780 CodeGenFunction& CGF;
John McCallf1549f62010-07-06 01:34:17 +0000781 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000782 bool OldDidCallStackSave;
Douglas Gregor5656e142009-11-24 21:15:44 +0000783 bool PerformCleanup;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000784
John McCallf1549f62010-07-06 01:34:17 +0000785 RunCleanupsScope(const RunCleanupsScope &); // DO NOT IMPLEMENT
786 RunCleanupsScope &operator=(const RunCleanupsScope &); // DO NOT IMPLEMENT
Douglas Gregor01234bb2009-11-24 16:43:22 +0000787
788 public:
789 /// \brief Enter a new cleanup scope.
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000790 explicit RunCleanupsScope(CodeGenFunction &CGF)
791 : CGF(CGF), PerformCleanup(true)
Douglas Gregor5656e142009-11-24 21:15:44 +0000792 {
John McCallf1549f62010-07-06 01:34:17 +0000793 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor01234bb2009-11-24 16:43:22 +0000794 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis4ada2ca2010-09-14 00:42:34 +0000795 CGF.DidCallStackSave = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000796 }
797
798 /// \brief Exit this cleanup scope, emitting any accumulated
799 /// cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000800 ~RunCleanupsScope() {
Douglas Gregor5656e142009-11-24 21:15:44 +0000801 if (PerformCleanup) {
802 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000803 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000804 }
805 }
806
807 /// \brief Determine whether this scope requires any cleanups.
808 bool requiresCleanups() const {
John McCallf1549f62010-07-06 01:34:17 +0000809 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor5656e142009-11-24 21:15:44 +0000810 }
811
812 /// \brief Force the emission of cleanups now, instead of waiting
813 /// until this object is destroyed.
814 void ForceCleanup() {
815 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor01234bb2009-11-24 16:43:22 +0000816 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000817 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000818 PerformCleanup = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000819 }
820 };
821
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000822
John McCallf1549f62010-07-06 01:34:17 +0000823 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
824 /// the cleanup blocks that have been added.
825 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000826
John McCallff8e1152010-07-23 21:56:41 +0000827 void ResolveBranchFixups(llvm::BasicBlock *Target);
828
John McCallf1549f62010-07-06 01:34:17 +0000829 /// The given basic block lies in the current EH scope, but may be a
830 /// target of a potentially scope-crossing jump; get a stable handle
831 /// to which we can perform this jump later.
John McCallff8e1152010-07-23 21:56:41 +0000832 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCall413e6772010-07-28 01:07:35 +0000833 return JumpDest(Target,
834 EHStack.getInnermostNormalCleanup(),
835 NextCleanupDestIndex++);
John McCallf1549f62010-07-06 01:34:17 +0000836 }
Anders Carlssonc71c8452009-02-07 23:50:39 +0000837
John McCallf1549f62010-07-06 01:34:17 +0000838 /// The given basic block lies in the current EH scope, but may be a
839 /// target of a potentially scope-crossing jump; get a stable handle
840 /// to which we can perform this jump later.
Chris Lattnerad8dcf42011-02-17 07:39:24 +0000841 JumpDest getJumpDestInCurrentScope(llvm::StringRef Name = llvm::StringRef()) {
John McCallff8e1152010-07-23 21:56:41 +0000842 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallf1549f62010-07-06 01:34:17 +0000843 }
844
845 /// EmitBranchThroughCleanup - Emit a branch from the current insert
846 /// block through the normal cleanup handling code (if any) and then
847 /// on to \arg Dest.
848 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerb11f9192011-04-17 00:54:30 +0000849
850 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
851 /// specified destination obviously has no cleanups to run. 'false' is always
852 /// a conservatively correct answer for this method.
853 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallf1549f62010-07-06 01:34:17 +0000854
855 /// EmitBranchThroughEHCleanup - Emit a branch from the current
856 /// insert block through the EH cleanup handling code (if any) and
857 /// then on to \arg Dest.
John McCallff8e1152010-07-23 21:56:41 +0000858 void EmitBranchThroughEHCleanup(UnwindDest Dest);
859
860 /// getRethrowDest - Returns the unified outermost-scope rethrow
861 /// destination.
862 UnwindDest getRethrowDest();
Mike Stump0dd9e882009-02-08 23:14:22 +0000863
John McCall150b4622011-01-26 04:00:11 +0000864 /// An object to manage conditionally-evaluated expressions.
865 class ConditionalEvaluation {
866 llvm::BasicBlock *StartBB;
Mike Stump1eb44332009-09-09 15:08:12 +0000867
John McCall150b4622011-01-26 04:00:11 +0000868 public:
869 ConditionalEvaluation(CodeGenFunction &CGF)
870 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000871
John McCall150b4622011-01-26 04:00:11 +0000872 void begin(CodeGenFunction &CGF) {
873 assert(CGF.OutermostConditional != this);
874 if (!CGF.OutermostConditional)
875 CGF.OutermostConditional = this;
876 }
877
878 void end(CodeGenFunction &CGF) {
879 assert(CGF.OutermostConditional != 0);
880 if (CGF.OutermostConditional == this)
881 CGF.OutermostConditional = 0;
882 }
883
884 /// Returns a block which will be executed prior to each
885 /// evaluation of the conditional code.
886 llvm::BasicBlock *getStartingBlock() const {
887 return StartBB;
888 }
889 };
Mike Stump1eb44332009-09-09 15:08:12 +0000890
John McCall3019c442010-09-17 00:50:28 +0000891 /// isInConditionalBranch - Return true if we're currently emitting
892 /// one branch or the other of a conditional expression.
John McCall150b4622011-01-26 04:00:11 +0000893 bool isInConditionalBranch() const { return OutermostConditional != 0; }
894
895 /// An RAII object to record that we're evaluating a statement
896 /// expression.
897 class StmtExprEvaluation {
898 CodeGenFunction &CGF;
899
900 /// We have to save the outermost conditional: cleanups in a
901 /// statement expression aren't conditional just because the
902 /// StmtExpr is.
903 ConditionalEvaluation *SavedOutermostConditional;
904
905 public:
906 StmtExprEvaluation(CodeGenFunction &CGF)
907 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
908 CGF.OutermostConditional = 0;
909 }
910
911 ~StmtExprEvaluation() {
912 CGF.OutermostConditional = SavedOutermostConditional;
913 CGF.EnsureInsertPoint();
914 }
915 };
John McCalle996ffd2011-02-16 08:02:54 +0000916
John McCall56ca35d2011-02-17 10:25:35 +0000917 /// An object which temporarily prevents a value from being
918 /// destroyed by aggressive peephole optimizations that assume that
919 /// all uses of a value have been realized in the IR.
920 class PeepholeProtection {
921 llvm::Instruction *Inst;
922 friend class CodeGenFunction;
923
924 public:
925 PeepholeProtection() : Inst(0) {}
926 };
927
John McCalle996ffd2011-02-16 08:02:54 +0000928 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
929 class OpaqueValueMapping {
930 CodeGenFunction &CGF;
931 const OpaqueValueExpr *OpaqueValue;
John McCall56ca35d2011-02-17 10:25:35 +0000932 bool BoundLValue;
933 CodeGenFunction::PeepholeProtection Protection;
John McCalle996ffd2011-02-16 08:02:54 +0000934
935 public:
John McCall56ca35d2011-02-17 10:25:35 +0000936 static bool shouldBindAsLValue(const Expr *expr) {
937 return expr->isGLValue() || expr->getType()->isRecordType();
938 }
939
940 /// Build the opaque value mapping for the given conditional
941 /// operator if it's the GNU ?: extension. This is a common
942 /// enough pattern that the convenience operator is really
943 /// helpful.
944 ///
945 OpaqueValueMapping(CodeGenFunction &CGF,
946 const AbstractConditionalOperator *op) : CGF(CGF) {
947 if (isa<ConditionalOperator>(op)) {
948 OpaqueValue = 0;
949 BoundLValue = false;
950 return;
951 }
952
953 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
954 init(e->getOpaqueValue(), e->getCommon());
955 }
956
John McCalle996ffd2011-02-16 08:02:54 +0000957 OpaqueValueMapping(CodeGenFunction &CGF,
958 const OpaqueValueExpr *opaqueValue,
John McCall56ca35d2011-02-17 10:25:35 +0000959 LValue lvalue)
960 : CGF(CGF), OpaqueValue(opaqueValue), BoundLValue(true) {
John McCalle996ffd2011-02-16 08:02:54 +0000961 assert(opaqueValue && "no opaque value expression!");
John McCall56ca35d2011-02-17 10:25:35 +0000962 assert(shouldBindAsLValue(opaqueValue));
963 initLValue(lvalue);
964 }
965
966 OpaqueValueMapping(CodeGenFunction &CGF,
967 const OpaqueValueExpr *opaqueValue,
968 RValue rvalue)
969 : CGF(CGF), OpaqueValue(opaqueValue), BoundLValue(false) {
970 assert(opaqueValue && "no opaque value expression!");
971 assert(!shouldBindAsLValue(opaqueValue));
972 initRValue(rvalue);
John McCalle996ffd2011-02-16 08:02:54 +0000973 }
974
975 void pop() {
976 assert(OpaqueValue && "mapping already popped!");
John McCall56ca35d2011-02-17 10:25:35 +0000977 popImpl();
John McCalle996ffd2011-02-16 08:02:54 +0000978 OpaqueValue = 0;
979 }
980
981 ~OpaqueValueMapping() {
John McCall56ca35d2011-02-17 10:25:35 +0000982 if (OpaqueValue) popImpl();
983 }
984
985 private:
986 void popImpl() {
987 if (BoundLValue)
988 CGF.OpaqueLValues.erase(OpaqueValue);
989 else {
990 CGF.OpaqueRValues.erase(OpaqueValue);
991 CGF.unprotectFromPeepholes(Protection);
992 }
993 }
994
995 void init(const OpaqueValueExpr *ov, const Expr *e) {
996 OpaqueValue = ov;
997 BoundLValue = shouldBindAsLValue(ov);
998 assert(BoundLValue == shouldBindAsLValue(e)
999 && "inconsistent expression value kinds!");
1000 if (BoundLValue)
1001 initLValue(CGF.EmitLValue(e));
1002 else
1003 initRValue(CGF.EmitAnyExpr(e));
1004 }
1005
1006 void initLValue(const LValue &lv) {
1007 CGF.OpaqueLValues.insert(std::make_pair(OpaqueValue, lv));
1008 }
1009
1010 void initRValue(const RValue &rv) {
1011 // Work around an extremely aggressive peephole optimization in
1012 // EmitScalarConversion which assumes that all other uses of a
1013 // value are extant.
1014 Protection = CGF.protectFromPeepholes(rv);
1015 CGF.OpaqueRValues.insert(std::make_pair(OpaqueValue, rv));
John McCalle996ffd2011-02-16 08:02:54 +00001016 }
1017 };
Fariborz Jahaniane2204552010-11-16 19:29:39 +00001018
1019 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1020 /// number that holds the value.
1021 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian52a80e12011-01-26 23:08:27 +00001022
1023 /// BuildBlockByrefAddress - Computes address location of the
1024 /// variable which is declared as __block.
1025 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1026 const VarDecl *V);
Chris Lattner7f02f722007-08-24 05:35:26 +00001027private:
Chris Lattnerd9becd12009-10-28 23:59:40 +00001028 CGDebugInfo *DebugInfo;
Devang Patelaa112892011-03-07 18:45:56 +00001029 bool DisableDebugInfo;
Mike Stump09429b92009-02-17 17:00:02 +00001030
John McCall93c332a2011-05-28 21:13:02 +00001031 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1032 /// calling llvm.stacksave for multiple VLAs in the same scope.
1033 bool DidCallStackSave;
1034
Mike Stumpf71d2322009-11-30 20:08:49 +00001035 /// IndirectBranch - The first time an indirect goto is seen we create a block
1036 /// with an indirect branch. Every time we see the address of a label taken,
1037 /// we add the label to the indirect goto. Every subsequent indirect goto is
1038 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattnerd9becd12009-10-28 23:59:40 +00001039 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001040
Mike Stump0dd9e882009-02-08 23:14:22 +00001041 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1042 /// decls.
John McCall6b5a61b2011-02-07 10:33:21 +00001043 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1044 DeclMapTy LocalDeclMap;
Reid Spencer5f016e22007-07-11 17:01:13 +00001045
1046 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001047 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001048
Mike Stump0dd9e882009-02-08 23:14:22 +00001049 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone4b6d342009-02-10 05:52:02 +00001050 // statements should jump to.
Chris Lattnerda138702007-07-16 21:28:45 +00001051 struct BreakContinue {
John McCallf1549f62010-07-06 01:34:17 +00001052 BreakContinue(JumpDest Break, JumpDest Continue)
1053 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stump0dd9e882009-02-08 23:14:22 +00001054
John McCallf1549f62010-07-06 01:34:17 +00001055 JumpDest BreakBlock;
1056 JumpDest ContinueBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001057 };
Chris Lattnerda138702007-07-16 21:28:45 +00001058 llvm::SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +00001059
Mike Stump0dd9e882009-02-08 23:14:22 +00001060 /// SwitchInsn - This is nearest current switch instruction. It is null if if
1061 /// current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +00001062 llvm::SwitchInst *SwitchInsn;
1063
Mike Stump0dd9e882009-02-08 23:14:22 +00001064 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel80fd5f92007-10-09 17:08:50 +00001065 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +00001066 llvm::BasicBlock *CaseRangeBlock;
1067
John McCall56ca35d2011-02-17 10:25:35 +00001068 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCalle996ffd2011-02-16 08:02:54 +00001069 /// expressions.
John McCall56ca35d2011-02-17 10:25:35 +00001070 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1071 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCalle996ffd2011-02-16 08:02:54 +00001072
Mike Stump0dd9e882009-02-08 23:14:22 +00001073 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001074 // We track this by the size expression rather than the type itself because
1075 // in certain situations, like a const qualifier applied to an VLA typedef,
1076 // multiple VLA types can share the same size expression.
Mike Stump0dd9e882009-02-08 23:14:22 +00001077 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1078 // enter/leave scopes.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001079 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001080
John McCallf1549f62010-07-06 01:34:17 +00001081 /// A block containing a single 'unreachable' instruction. Created
1082 /// lazily by getUnreachableBlock().
1083 llvm::BasicBlock *UnreachableBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001084
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001085 /// CXXThisDecl - When generating code for a C++ member function,
1086 /// this will hold the implicit 'this' declaration.
Anders Carlsson2b77ba82009-04-04 20:47:02 +00001087 ImplicitParamDecl *CXXThisDecl;
John McCall25049412010-02-16 22:04:33 +00001088 llvm::Value *CXXThisValue;
Mike Stump1eb44332009-09-09 15:08:12 +00001089
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001090 /// CXXVTTDecl - When generating code for a base object constructor or
1091 /// base object destructor with virtual bases, this will hold the implicit
1092 /// VTT parameter.
1093 ImplicitParamDecl *CXXVTTDecl;
John McCall25049412010-02-16 22:04:33 +00001094 llvm::Value *CXXVTTValue;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001095
John McCall150b4622011-01-26 04:00:11 +00001096 /// OutermostConditional - Points to the outermost active
1097 /// conditional control. This is used so that we know if a
1098 /// temporary should be destroyed conditionally.
1099 ConditionalEvaluation *OutermostConditional;
Mike Stump1eb44332009-09-09 15:08:12 +00001100
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001101
1102 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1103 /// type as well as the field number that contains the actual data.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001104 llvm::DenseMap<const ValueDecl *, std::pair<const llvm::Type *,
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001105 unsigned> > ByRefValueInfo;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001106
John McCallf1549f62010-07-06 01:34:17 +00001107 llvm::BasicBlock *TerminateLandingPad;
Mike Stump182f3832009-12-10 00:02:42 +00001108 llvm::BasicBlock *TerminateHandler;
Chris Lattner83252dc2010-07-20 21:07:09 +00001109 llvm::BasicBlock *TrapBB;
Eli Friedman94067052009-12-10 02:21:21 +00001110
Reid Spencer5f016e22007-07-11 17:01:13 +00001111public:
1112 CodeGenFunction(CodeGenModule &cgm);
Mike Stump0dd9e882009-02-08 23:14:22 +00001113
John McCall1e7fe752010-09-02 09:58:18 +00001114 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCallf2aac842011-05-15 02:34:36 +00001115 ASTContext &getContext() const { return CGM.getContext(); }
Devang Patelaa112892011-03-07 18:45:56 +00001116 CGDebugInfo *getDebugInfo() {
1117 if (DisableDebugInfo)
1118 return NULL;
1119 return DebugInfo;
1120 }
1121 void disableDebugInfo() { DisableDebugInfo = true; }
1122 void enableDebugInfo() { DisableDebugInfo = false; }
1123
John McCallf85e1932011-06-15 23:02:42 +00001124 bool shouldUseFusedARCCalls() {
1125 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1126 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001127
John McCalld16c2cf2011-02-08 08:22:06 +00001128 const LangOptions &getLangOptions() const { return CGM.getLangOptions(); }
1129
John McCallf1549f62010-07-06 01:34:17 +00001130 /// Returns a pointer to the function's exception object slot, which
1131 /// is assigned in every landing pad.
1132 llvm::Value *getExceptionSlot();
John McCall93c332a2011-05-28 21:13:02 +00001133 llvm::Value *getEHSelectorSlot();
John McCallf1549f62010-07-06 01:34:17 +00001134
John McCallff8e1152010-07-23 21:56:41 +00001135 llvm::Value *getNormalCleanupDestSlot();
1136 llvm::Value *getEHCleanupDestSlot();
1137
John McCallf1549f62010-07-06 01:34:17 +00001138 llvm::BasicBlock *getUnreachableBlock() {
1139 if (!UnreachableBlock) {
1140 UnreachableBlock = createBasicBlock("unreachable");
1141 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1142 }
1143 return UnreachableBlock;
1144 }
1145
1146 llvm::BasicBlock *getInvokeDest() {
1147 if (!EHStack.requiresLandingPad()) return 0;
1148 return getInvokeDestImpl();
1149 }
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001150
John McCalld16c2cf2011-02-08 08:22:06 +00001151 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Anderson69243822009-07-13 04:10:07 +00001152
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001153 //===--------------------------------------------------------------------===//
1154 // Objective-C
1155 //===--------------------------------------------------------------------===//
1156
Chris Lattner391d77a2008-03-30 23:03:07 +00001157 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001158
Mike Stump0dd9e882009-02-08 23:14:22 +00001159 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patel8d3f8972011-05-19 23:37:41 +00001160 const ObjCContainerDecl *CD,
1161 SourceLocation StartLoc);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001162
Mike Stump0dd9e882009-02-08 23:14:22 +00001163 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001164 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1165 const ObjCPropertyImplDecl *PID);
Fariborz Jahanian2846b972011-02-18 19:15:13 +00001166 void GenerateObjCGetterBody(ObjCIvarDecl *Ivar, bool IsAtomic, bool IsStrong);
1167 void GenerateObjCAtomicSetterBody(ObjCMethodDecl *OMD,
1168 ObjCIvarDecl *Ivar);
1169
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001170 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1171 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001172
Mike Stump0dd9e882009-02-08 23:14:22 +00001173 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1174 /// for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001175 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1176 const ObjCPropertyImplDecl *PID);
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001177 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001178 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001179
Mike Stump4e7a1f72009-02-21 20:00:35 +00001180 //===--------------------------------------------------------------------===//
1181 // Block Bits
1182 //===--------------------------------------------------------------------===//
1183
John McCall6b5a61b2011-02-07 10:33:21 +00001184 llvm::Value *EmitBlockLiteral(const BlockExpr *);
Blaine Garst2a7eb282010-02-23 21:51:17 +00001185 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00001186 const CGBlockInfo &Info,
Mike Stump08920992009-03-07 02:35:30 +00001187 const llvm::StructType *,
John McCalld16c2cf2011-02-08 08:22:06 +00001188 llvm::Constant *BlockVarLayout);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001189
Fariborz Jahanian564360b2010-06-24 00:08:06 +00001190 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall6b5a61b2011-02-07 10:33:21 +00001191 const CGBlockInfo &Info,
Mike Stump6cc88f72009-03-20 21:53:12 +00001192 const Decl *OuterFuncDecl,
John McCall6b5a61b2011-02-07 10:33:21 +00001193 const DeclMapTy &ldm);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001194
John McCalld16c2cf2011-02-08 08:22:06 +00001195 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1196 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
1197
John McCalld16c2cf2011-02-08 08:22:06 +00001198 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1199
John McCall5af02db2011-03-31 01:59:53 +00001200 class AutoVarEmission;
1201
1202 void emitByrefStructureInit(const AutoVarEmission &emission);
1203 void enterByrefCleanup(const AutoVarEmission &emission);
1204
John McCall6b5a61b2011-02-07 10:33:21 +00001205 llvm::Value *LoadBlockStruct() {
1206 assert(BlockPointer && "no block pointer set!");
1207 return BlockPointer;
1208 }
Mike Stump4e7a1f72009-02-21 20:00:35 +00001209
John McCallea1471e2010-05-20 01:18:31 +00001210 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
1211 void AllocateBlockDecl(const BlockDeclRefExpr *E);
John McCallee504292010-05-21 04:11:14 +00001212 llvm::Value *GetAddrOfBlockDecl(const BlockDeclRefExpr *E) {
1213 return GetAddrOfBlockDecl(E->getDecl(), E->isByRef());
1214 }
John McCall6b5a61b2011-02-07 10:33:21 +00001215 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
1216 const llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stumpdab514f2009-03-04 03:23:46 +00001217
John McCalld26bc762011-03-09 04:27:21 +00001218 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1219 const CGFunctionInfo &FnInfo);
Anders Carlsson0ff8baf2009-09-11 00:07:24 +00001220 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbar7c086512008-09-09 23:14:03 +00001221 llvm::Function *Fn,
John McCalld26bc762011-03-09 04:27:21 +00001222 const CGFunctionInfo &FnInfo,
Daniel Dunbar2284ac92008-10-18 18:22:23 +00001223 const FunctionArgList &Args,
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00001224 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001225
John McCall9fc6a772010-02-19 09:25:03 +00001226 void EmitConstructorBody(FunctionArgList &Args);
1227 void EmitDestructorBody(FunctionArgList &Args);
1228 void EmitFunctionBody(FunctionArgList &Args);
John McCalla355e072010-02-18 03:17:58 +00001229
Mike Stump0dd9e882009-02-08 23:14:22 +00001230 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1231 /// emission when possible.
Daniel Dunbar1c1d6072009-01-26 23:27:52 +00001232 void EmitReturnBlock();
1233
Mike Stump0dd9e882009-02-08 23:14:22 +00001234 /// FinishFunction - Complete IR generation of the current function. It is
1235 /// legal to call this function even if there is no current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001236 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001237
Anders Carlsson519c3282010-03-24 00:39:18 +00001238 /// GenerateThunk - Generate a thunk for the given method.
John McCalld26bc762011-03-09 04:27:21 +00001239 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1240 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001241
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00001242 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1243 GlobalDecl GD, const ThunkInfo &Thunk);
1244
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001245 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1246 FunctionArgList &Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001247
Anders Carlssond103f9f2010-03-28 19:40:00 +00001248 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1249 /// subobject.
1250 ///
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001251 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001252 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001253 CharUnits OffsetFromNearestVBase,
Anders Carlssond103f9f2010-03-28 19:40:00 +00001254 llvm::Constant *VTable,
1255 const CXXRecordDecl *VTableClass);
1256
1257 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001258 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001259 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001260 CharUnits OffsetFromNearestVBase,
Anders Carlsson603d6d12010-03-28 21:07:49 +00001261 bool BaseIsNonVirtualPrimaryBase,
1262 llvm::Constant *VTable,
1263 const CXXRecordDecl *VTableClass,
1264 VisitedVirtualBasesSetTy& VBases);
Eli Friedman77a259c2009-12-08 06:46:18 +00001265
Anders Carlsson603d6d12010-03-28 21:07:49 +00001266 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001267
Dan Gohman043fb9a2010-10-26 18:44:08 +00001268 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1269 /// to by This.
1270 llvm::Value *GetVTablePtr(llvm::Value *This, const llvm::Type *Ty);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001271
John McCall50da2ca2010-07-21 05:30:47 +00001272 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1273 /// given phase of destruction for a destructor. The end result
1274 /// should call destructors on members and base classes in reverse
1275 /// order of their construction.
1276 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001277
Chris Lattner7255a2d2010-06-22 00:03:40 +00001278 /// ShouldInstrumentFunction - Return true if the current function should be
1279 /// instrumented with __cyg_profile_func_* calls
1280 bool ShouldInstrumentFunction();
1281
1282 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1283 /// instrumentation function with the current function and the call site, if
1284 /// function instrumentation is enabled.
1285 void EmitFunctionInstrumentation(const char *Fn);
1286
Roman Divackybe4c8702011-02-10 16:52:03 +00001287 /// EmitMCountInstrumentation - Emit call to .mcount.
1288 void EmitMCountInstrumentation();
1289
Mike Stump0dd9e882009-02-08 23:14:22 +00001290 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1291 /// arguments for the given function. This is also responsible for naming the
1292 /// LLVM function arguments.
Daniel Dunbar88b53962009-02-02 22:03:45 +00001293 void EmitFunctionProlog(const CGFunctionInfo &FI,
1294 llvm::Function *Fn,
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001295 const FunctionArgList &Args);
1296
Mike Stump0dd9e882009-02-08 23:14:22 +00001297 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1298 /// given temporary.
Chris Lattner35b21b82010-06-27 01:06:27 +00001299 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001300
Mike Stumpcce3d4f2009-12-07 23:38:24 +00001301 /// EmitStartEHSpec - Emit the start of the exception spec.
1302 void EmitStartEHSpec(const Decl *D);
1303
1304 /// EmitEndEHSpec - Emit the end of the exception spec.
1305 void EmitEndEHSpec(const Decl *D);
1306
John McCallf1549f62010-07-06 01:34:17 +00001307 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1308 llvm::BasicBlock *getTerminateLandingPad();
1309
1310 /// getTerminateHandler - Return a handler (not a landing pad, just
1311 /// a catch handler) that just calls terminate. This is used when
1312 /// a terminate scope encloses a try.
Mike Stump9b39c512009-12-09 22:59:31 +00001313 llvm::BasicBlock *getTerminateHandler();
1314
Daniel Dunbar8b1a3432009-02-03 23:03:55 +00001315 const llvm::Type *ConvertTypeForMem(QualType T);
Reid Spencer5f016e22007-07-11 17:01:13 +00001316 const llvm::Type *ConvertType(QualType T);
John McCallbff225e2010-02-16 04:15:37 +00001317 const llvm::Type *ConvertType(const TypeDecl *T) {
1318 return ConvertType(getContext().getTypeDeclType(T));
1319 }
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001320
Mike Stump0dd9e882009-02-08 23:14:22 +00001321 /// LoadObjCSelf - Load the value of self. This function is only valid while
1322 /// generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001323 llvm::Value *LoadObjCSelf();
Mike Stump0dd9e882009-02-08 23:14:22 +00001324
1325 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001326 QualType TypeOfSelfObject();
Chris Lattner41110242008-06-17 18:05:57 +00001327
Reid Spencer5f016e22007-07-11 17:01:13 +00001328 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1329 /// an aggregate LLVM type or is void.
1330 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar55e87422008-11-11 02:29:29 +00001331
1332 /// createBasicBlock - Create an LLVM basic block.
John McCalld16c2cf2011-02-08 08:22:06 +00001333 llvm::BasicBlock *createBasicBlock(llvm::StringRef name = "",
1334 llvm::Function *parent = 0,
1335 llvm::BasicBlock *before = 0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001336#ifdef NDEBUG
John McCalld16c2cf2011-02-08 08:22:06 +00001337 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001338#else
John McCalld16c2cf2011-02-08 08:22:06 +00001339 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001340#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +00001341 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001342
Reid Spencer5f016e22007-07-11 17:01:13 +00001343 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1344 /// label maps to.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001345 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001346
Mike Stumpf71d2322009-11-30 20:08:49 +00001347 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1348 /// another basic block, simplify it. This assumes that no other code could
1349 /// potentially reference the basic block.
Daniel Dunbaraa5bd872009-04-01 04:37:47 +00001350 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1351
Mike Stump0dd9e882009-02-08 23:14:22 +00001352 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1353 /// adding a fall-through branch from the current insert block if
1354 /// necessary. It is legal to call this function even if there is no current
1355 /// insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001356 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001357 /// IsFinished - If true, indicates that the caller has finished emitting
1358 /// branches to the given block and does not expect to emit code into it. This
1359 /// means the block can be ignored if it is unreachable.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001360 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +00001361
Mike Stump0dd9e882009-02-08 23:14:22 +00001362 /// EmitBranch - Emit a branch to the specified basic block from the current
1363 /// insert block, taking care to avoid creation of branches from dummy
1364 /// blocks. It is legal to call this function even if there is no current
1365 /// insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +00001366 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001367 /// This function clears the current insertion point. The caller should follow
1368 /// calls to this function with calls to Emit*Block prior to generation new
1369 /// code.
Daniel Dunbard57a8712008-11-11 09:41:28 +00001370 void EmitBranch(llvm::BasicBlock *Block);
1371
Mike Stump0dd9e882009-02-08 23:14:22 +00001372 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1373 /// indicates that the current code being emitted is unreachable.
1374 bool HaveInsertPoint() const {
Daniel Dunbara448fb22008-11-11 23:11:34 +00001375 return Builder.GetInsertBlock() != 0;
1376 }
1377
Mike Stump0dd9e882009-02-08 23:14:22 +00001378 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1379 /// emitted IR has a place to go. Note that by definition, if this function
1380 /// creates a block then that block is unreachable; callers may do better to
1381 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001382 void EnsureInsertPoint() {
1383 if (!HaveInsertPoint())
1384 EmitBlock(createBasicBlock());
1385 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001386
Daniel Dunbar488e9932008-08-16 00:56:44 +00001387 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +00001388 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +00001389 void ErrorUnsupported(const Stmt *S, const char *Type,
1390 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +00001391
1392 //===--------------------------------------------------------------------===//
1393 // Helpers
1394 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001395
Daniel Dunbar983e3d72010-08-21 04:20:22 +00001396 LValue MakeAddrLValue(llvm::Value *V, QualType T, unsigned Alignment = 0) {
Dan Gohman3d5aff52010-10-14 23:06:10 +00001397 return LValue::MakeAddr(V, T, Alignment, getContext(),
1398 CGM.getTBAAInfo(T));
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001399 }
1400
Reid Spencer5f016e22007-07-11 17:01:13 +00001401 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbar195337d2010-02-09 02:48:28 +00001402 /// block. The caller is responsible for setting an appropriate alignment on
1403 /// the alloca.
Reid Spencer5f016e22007-07-11 17:01:13 +00001404 llvm::AllocaInst *CreateTempAlloca(const llvm::Type *Ty,
Daniel Dunbar259e9cc2009-10-19 01:21:05 +00001405 const llvm::Twine &Name = "tmp");
Mike Stump0dd9e882009-02-08 23:14:22 +00001406
John McCallac418162010-04-22 01:10:34 +00001407 /// InitTempAlloca - Provide an initial value for the given alloca.
1408 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1409
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001410 /// CreateIRTemp - Create a temporary IR object of the given type, with
1411 /// appropriate alignment. This routine should only be used when an temporary
1412 /// value needs to be stored into an alloca (for example, to avoid explicit
1413 /// PHI construction), but the type is the IR type, not the type appropriate
1414 /// for storing in memory.
Chris Lattner121b3fa2010-07-05 20:21:00 +00001415 llvm::AllocaInst *CreateIRTemp(QualType T, const llvm::Twine &Name = "tmp");
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001416
Daniel Dunbar195337d2010-02-09 02:48:28 +00001417 /// CreateMemTemp - Create a temporary memory object of the given type, with
1418 /// appropriate alignment.
Chris Lattner121b3fa2010-07-05 20:21:00 +00001419 llvm::AllocaInst *CreateMemTemp(QualType T, const llvm::Twine &Name = "tmp");
Daniel Dunbar195337d2010-02-09 02:48:28 +00001420
John McCall558d2ab2010-09-15 10:14:12 +00001421 /// CreateAggTemp - Create a temporary memory object for the given
1422 /// aggregate type.
1423 AggValueSlot CreateAggTemp(QualType T, const llvm::Twine &Name = "tmp") {
John McCallf85e1932011-06-15 23:02:42 +00001424 return AggValueSlot::forAddr(CreateMemTemp(T, Name), T.getQualifiers(),
1425 false);
John McCall558d2ab2010-09-15 10:14:12 +00001426 }
1427
John McCalld16c2cf2011-02-08 08:22:06 +00001428 /// Emit a cast to void* in the appropriate address space.
1429 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1430
Reid Spencer5f016e22007-07-11 17:01:13 +00001431 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1432 /// expression and compare the result against zero, returning an Int1Ty value.
1433 llvm::Value *EvaluateExprAsBool(const Expr *E);
1434
John McCall2a416372010-12-05 02:00:02 +00001435 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1436 void EmitIgnoredExpr(const Expr *E);
1437
Chris Lattner9b655512007-08-31 22:49:20 +00001438 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1439 /// any type. The result is returned as an RValue struct. If this is an
1440 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1441 /// the result should be returned.
Mike Stump49d1cd52009-05-26 22:03:21 +00001442 ///
1443 /// \param IgnoreResult - True if the resulting value isn't used.
John McCall558d2ab2010-09-15 10:14:12 +00001444 RValue EmitAnyExpr(const Expr *E,
1445 AggValueSlot AggSlot = AggValueSlot::ignored(),
1446 bool IgnoreResult = false);
Devang Pateld9363c32007-09-28 21:49:18 +00001447
Mike Stump0dd9e882009-02-08 23:14:22 +00001448 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1449 // or the value of the expression, depending on how va_list is defined.
Eli Friedman4fd0aa52009-01-20 17:46:04 +00001450 llvm::Value *EmitVAListRef(const Expr *E);
1451
Mike Stump0dd9e882009-02-08 23:14:22 +00001452 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1453 /// always be accessible even if no aggregate location is provided.
John McCall558d2ab2010-09-15 10:14:12 +00001454 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar46f45b92008-09-09 01:06:48 +00001455
John McCall60d33652011-03-08 09:11:50 +00001456 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
John McCall3d3ec1c2010-04-21 10:05:39 +00001457 /// arbitrary expression into the given memory location.
1458 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
John McCallf85e1932011-06-15 23:02:42 +00001459 Qualifiers Quals, bool IsInitializer);
John McCall3d3ec1c2010-04-21 10:05:39 +00001460
John McCall60d33652011-03-08 09:11:50 +00001461 /// EmitExprAsInit - Emits the code necessary to initialize a
1462 /// location in memory with the given initializer.
John McCallf85e1932011-06-15 23:02:42 +00001463 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001464 LValue lvalue, bool capturedByInit);
John McCall60d33652011-03-08 09:11:50 +00001465
Mike Stump27fe2e62009-05-23 22:29:41 +00001466 /// EmitAggregateCopy - Emit an aggrate copy.
1467 ///
1468 /// \param isVolatile - True iff either the source or the destination is
1469 /// volatile.
Daniel Dunbar7482d122008-09-09 20:49:46 +00001470 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Mike Stump27fe2e62009-05-23 22:29:41 +00001471 QualType EltTy, bool isVolatile=false);
Daniel Dunbar7482d122008-09-09 20:49:46 +00001472
Devang Patel51b09f22007-10-04 23:45:31 +00001473 /// StartBlock - Start new block named N. If insert block is a dummy block
1474 /// then reuse it.
1475 void StartBlock(const char *N);
1476
Lauro Ramos Venancio81373352008-02-26 21:41:45 +00001477 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
John McCall4c40d982010-08-31 07:33:07 +00001478 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD) {
1479 return cast<llvm::Constant>(GetAddrOfLocalVar(BVD));
1480 }
Dan Gohman4f8d1232008-05-22 00:50:06 +00001481
Anders Carlssondde0a942008-09-11 09:15:33 +00001482 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall4c40d982010-08-31 07:33:07 +00001483 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1484 llvm::Value *Res = LocalDeclMap[VD];
1485 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1486 return Res;
1487 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001488
John McCall56ca35d2011-02-17 10:25:35 +00001489 /// getOpaqueLValueMapping - Given an opaque value expression (which
1490 /// must be mapped to an l-value), return its mapping.
1491 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1492 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1493
1494 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1495 it = OpaqueLValues.find(e);
1496 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1497 return it->second;
1498 }
1499
1500 /// getOpaqueRValueMapping - Given an opaque value expression (which
1501 /// must be mapped to an r-value), return its mapping.
1502 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1503 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1504
1505 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1506 it = OpaqueRValues.find(e);
1507 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCalle996ffd2011-02-16 08:02:54 +00001508 return it->second;
1509 }
1510
Dan Gohman4f8d1232008-05-22 00:50:06 +00001511 /// getAccessedFieldNo - Given an encoded value and a result number, return
1512 /// the input field number being accessed.
1513 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1514
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001515 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner3d00fdc2009-10-13 06:55:33 +00001516 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001517
Anders Carlsson1884eb02010-05-22 17:35:42 +00001518 /// EmitNullInitialization - Generate code to set a value of the given type to
1519 /// null, If the type contains data member pointers, they will be initialized
1520 /// to -1 in accordance with the Itanium C++ ABI.
1521 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001522
1523 // EmitVAArg - Generate code to get an argument from the passed in pointer
1524 // and update it accordingly. The return value is a pointer to the argument.
1525 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stump0dd9e882009-02-08 23:14:22 +00001526 // instruction in LLVM instead once it works well enough.
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001527 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +00001528
John McCallbc8d40d2011-06-24 21:55:10 +00001529 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1530 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbard286f052009-07-19 06:58:07 +00001531 ///
1532 /// This function can be called with a null (unreachable) insert point.
John McCallbc8d40d2011-06-24 21:55:10 +00001533 void EmitVariablyModifiedType(QualType Ty);
Mike Stump0dd9e882009-02-08 23:14:22 +00001534
John McCallbc8d40d2011-06-24 21:55:10 +00001535 /// getVLASize - Returns an LLVM value that corresponds to the size,
1536 /// in non-variably-sized elements, of a variable length array type,
1537 /// plus that largest non-variably-sized element type. Assumes that
1538 /// the type has already been emitted with EmitVariablyModifiedType.
1539 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1540 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssondcc90d82008-12-12 07:19:02 +00001541
Anders Carlsson5f4307b2009-04-14 16:58:56 +00001542 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1543 /// generating code for an C++ member function.
John McCall25049412010-02-16 22:04:33 +00001544 llvm::Value *LoadCXXThis() {
1545 assert(CXXThisValue && "no 'this' value for this function");
1546 return CXXThisValue;
1547 }
Mike Stump1eb44332009-09-09 15:08:12 +00001548
Anders Carlssonc997d422010-01-02 01:01:18 +00001549 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1550 /// virtual bases.
John McCall25049412010-02-16 22:04:33 +00001551 llvm::Value *LoadCXXVTT() {
1552 assert(CXXVTTValue && "no VTT value for this function");
1553 return CXXVTTValue;
1554 }
John McCallbff225e2010-02-16 04:15:37 +00001555
1556 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlsson8561a862010-04-24 23:01:49 +00001557 /// complete class to the given direct base.
1558 llvm::Value *
1559 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1560 const CXXRecordDecl *Derived,
1561 const CXXRecordDecl *Base,
1562 bool BaseIsVirtual);
Anders Carlssona88ad562010-04-24 21:51:08 +00001563
Mike Stumpf71d2322009-11-30 20:08:49 +00001564 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1565 /// load of 'this' and returns address of the base class.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001566 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001567 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001568 CastExpr::path_const_iterator PathBegin,
1569 CastExpr::path_const_iterator PathEnd,
Anders Carlsson34a2d382010-04-24 21:06:20 +00001570 bool NullCheckValue);
1571
Anders Carlssona3697c92009-11-23 17:57:54 +00001572 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001573 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001574 CastExpr::path_const_iterator PathBegin,
1575 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +00001576 bool NullCheckValue);
1577
Anders Carlssonbb7e17b2010-01-31 01:36:53 +00001578 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1579 const CXXRecordDecl *ClassDecl,
1580 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001581
John McCallc0bf4622010-02-23 00:48:20 +00001582 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1583 CXXCtorType CtorType,
1584 const FunctionArgList &Args);
Sean Hunt059ce0d2011-05-01 07:04:31 +00001585 // It's important not to confuse this and the previous function. Delegating
1586 // constructors are the C++0x feature. The constructor delegate optimization
1587 // is used to reduce duplication in the base and complete consturctors where
1588 // they are substantially the same.
1589 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1590 const FunctionArgList &Args);
Anders Carlsson155ed4a2010-05-02 23:20:53 +00001591 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1592 bool ForVirtualBase, llvm::Value *This,
Anders Carlssonb14095a2009-04-17 00:06:03 +00001593 CallExpr::const_arg_iterator ArgBeg,
1594 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahanian34999872010-11-13 21:53:34 +00001595
1596 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1597 llvm::Value *This, llvm::Value *Src,
1598 CallExpr::const_arg_iterator ArgBeg,
1599 CallExpr::const_arg_iterator ArgEnd);
Mike Stump1eb44332009-09-09 15:08:12 +00001600
Fariborz Jahanian288dcaf2009-08-19 20:55:16 +00001601 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlsson569c1f42009-09-23 02:45:36 +00001602 const ConstantArrayType *ArrayTy,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001603 llvm::Value *ArrayPtr,
1604 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001605 CallExpr::const_arg_iterator ArgEnd,
1606 bool ZeroInitialization = false);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001607
Anders Carlsson569c1f42009-09-23 02:45:36 +00001608 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1609 llvm::Value *NumElements,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001610 llvm::Value *ArrayPtr,
1611 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001612 CallExpr::const_arg_iterator ArgEnd,
1613 bool ZeroInitialization = false);
Anders Carlssonb14095a2009-04-17 00:06:03 +00001614
Fariborz Jahanianf800f6c2009-08-20 20:54:15 +00001615 void EmitCXXAggrDestructorCall(const CXXDestructorDecl *D,
1616 const ArrayType *Array,
1617 llvm::Value *This);
Mike Stump1eb44332009-09-09 15:08:12 +00001618
Fariborz Jahanian72c21532009-11-13 19:27:47 +00001619 void EmitCXXAggrDestructorCall(const CXXDestructorDecl *D,
1620 llvm::Value *NumElements,
1621 llvm::Value *This);
1622
Anders Carlsson02e370a2010-06-08 22:14:59 +00001623 llvm::Function *GenerateCXXAggrDestructorHelper(const CXXDestructorDecl *D,
1624 const ArrayType *Array,
1625 llvm::Value *This);
Fariborz Jahanian88f42802009-11-10 19:24:06 +00001626
Anders Carlsson7267c162009-05-29 21:03:38 +00001627 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Anders Carlsson8e6404c2010-05-02 23:29:11 +00001628 bool ForVirtualBase, llvm::Value *This);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001629
Fariborz Jahanianef668722010-06-25 18:26:07 +00001630 void EmitNewArrayInitializer(const CXXNewExpr *E, llvm::Value *NewPtr,
1631 llvm::Value *NumElements);
Mike Stump1eb44332009-09-09 15:08:12 +00001632
John McCallf1549f62010-07-06 01:34:17 +00001633 void EmitCXXTemporary(const CXXTemporary *Temporary, llvm::Value *Ptr);
Mike Stump1eb44332009-09-09 15:08:12 +00001634
Anders Carlssona00703d2009-05-31 01:40:14 +00001635 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson60e282c2009-08-16 21:13:42 +00001636 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump1eb44332009-09-09 15:08:12 +00001637
Eli Friedman4bf81522009-11-18 00:57:03 +00001638 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1639 QualType DeleteTy);
1640
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001641 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stumpc849c052009-11-16 06:50:58 +00001642 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001643
Mike Stumpb14e62d2009-12-16 02:57:00 +00001644 void EmitCheck(llvm::Value *, unsigned Size);
1645
Chris Lattnerdd36d322010-01-09 21:40:03 +00001646 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1647 bool isInc, bool isPre);
1648 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1649 bool isInc, bool isPre);
Reid Spencer5f016e22007-07-11 17:01:13 +00001650 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +00001651 // Declaration Emission
1652 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001653
Daniel Dunbard286f052009-07-19 06:58:07 +00001654 /// EmitDecl - Emit a declaration.
1655 ///
1656 /// This function can be called with a null (unreachable) insert point.
Reid Spencer5f016e22007-07-11 17:01:13 +00001657 void EmitDecl(const Decl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001658
John McCallb6bbcc92010-10-15 04:57:14 +00001659 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001660 ///
1661 /// This function can be called with a null (unreachable) insert point.
John McCallb6bbcc92010-10-15 04:57:14 +00001662 void EmitVarDecl(const VarDecl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001663
John McCallf85e1932011-06-15 23:02:42 +00001664 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001665 LValue lvalue, bool capturedByInit);
John McCall7acddac2011-06-17 06:42:21 +00001666 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCallf85e1932011-06-15 23:02:42 +00001667
John McCallf1549f62010-07-06 01:34:17 +00001668 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1669 llvm::Value *Address);
1670
John McCallb6bbcc92010-10-15 04:57:14 +00001671 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001672 ///
1673 /// This function can be called with a null (unreachable) insert point.
John McCall34695852011-02-22 06:44:22 +00001674 void EmitAutoVarDecl(const VarDecl &D);
1675
1676 class AutoVarEmission {
1677 friend class CodeGenFunction;
1678
John McCall57b3b6a2011-02-22 07:16:58 +00001679 const VarDecl *Variable;
John McCall34695852011-02-22 06:44:22 +00001680
1681 /// The alignment of the variable.
1682 CharUnits Alignment;
1683
1684 /// The address of the alloca. Null if the variable was emitted
1685 /// as a global constant.
1686 llvm::Value *Address;
1687
1688 llvm::Value *NRVOFlag;
1689
1690 /// True if the variable is a __block variable.
1691 bool IsByRef;
1692
1693 /// True if the variable is of aggregate type and has a constant
1694 /// initializer.
1695 bool IsConstantAggregate;
1696
John McCall57b3b6a2011-02-22 07:16:58 +00001697 struct Invalid {};
1698 AutoVarEmission(Invalid) : Variable(0) {}
1699
John McCall34695852011-02-22 06:44:22 +00001700 AutoVarEmission(const VarDecl &variable)
John McCall57b3b6a2011-02-22 07:16:58 +00001701 : Variable(&variable), Address(0), NRVOFlag(0),
John McCall34695852011-02-22 06:44:22 +00001702 IsByRef(false), IsConstantAggregate(false) {}
1703
1704 bool wasEmittedAsGlobal() const { return Address == 0; }
1705
1706 public:
John McCall57b3b6a2011-02-22 07:16:58 +00001707 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1708
John McCall34695852011-02-22 06:44:22 +00001709 /// Returns the address of the object within this declaration.
1710 /// Note that this does not chase the forwarding pointer for
1711 /// __block decls.
1712 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1713 if (!IsByRef) return Address;
1714
1715 return CGF.Builder.CreateStructGEP(Address,
John McCall57b3b6a2011-02-22 07:16:58 +00001716 CGF.getByRefValueLLVMField(Variable),
1717 Variable->getNameAsString());
John McCall34695852011-02-22 06:44:22 +00001718 }
1719 };
1720 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1721 void EmitAutoVarInit(const AutoVarEmission &emission);
1722 void EmitAutoVarCleanups(const AutoVarEmission &emission);
Daniel Dunbard286f052009-07-19 06:58:07 +00001723
John McCallb6bbcc92010-10-15 04:57:14 +00001724 void EmitStaticVarDecl(const VarDecl &D,
1725 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001726
1727 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel093ac462011-03-03 20:13:15 +00001728 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stump0dd9e882009-02-08 23:14:22 +00001729
John McCall56ca35d2011-02-17 10:25:35 +00001730 /// protectFromPeepholes - Protect a value that we're intending to
1731 /// store to the side, but which will probably be used later, from
1732 /// aggressive peepholing optimizations that might delete it.
1733 ///
1734 /// Pass the result to unprotectFromPeepholes to declare that
1735 /// protection is no longer required.
1736 ///
1737 /// There's no particular reason why this shouldn't apply to
1738 /// l-values, it's just that no existing peepholes work on pointers.
1739 PeepholeProtection protectFromPeepholes(RValue rvalue);
1740 void unprotectFromPeepholes(PeepholeProtection protection);
1741
Reid Spencer5f016e22007-07-11 17:01:13 +00001742 //===--------------------------------------------------------------------===//
1743 // Statement Emission
1744 //===--------------------------------------------------------------------===//
1745
Mike Stump0dd9e882009-02-08 23:14:22 +00001746 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar09124252008-11-12 08:21:33 +00001747 void EmitStopPoint(const Stmt *S);
1748
Mike Stump0dd9e882009-02-08 23:14:22 +00001749 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1750 /// this function even if there is no current insertion point.
1751 ///
1752 /// This function may clear the current insertion point; callers should use
1753 /// EnsureInsertPoint if they wish to subsequently generate code without first
1754 /// calling EmitBlock, EmitBranch, or EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +00001755 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001756
Daniel Dunbar09124252008-11-12 08:21:33 +00001757 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stump0dd9e882009-02-08 23:14:22 +00001758 /// necessarily require an insertion point or debug information; typically
1759 /// because the statement amounts to a jump or a container of other
1760 /// statements.
Daniel Dunbar09124252008-11-12 08:21:33 +00001761 ///
1762 /// \return True if the statement was handled.
1763 bool EmitSimpleStmt(const Stmt *S);
1764
Chris Lattner9b655512007-08-31 22:49:20 +00001765 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall558d2ab2010-09-15 10:14:12 +00001766 AggValueSlot AVS = AggValueSlot::ignored());
Daniel Dunbara448fb22008-11-11 23:11:34 +00001767
Mike Stump0dd9e882009-02-08 23:14:22 +00001768 /// EmitLabel - Emit the block for the given label. It is legal to call this
1769 /// function even if there is no current insertion point.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001770 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001771
Reid Spencer5f016e22007-07-11 17:01:13 +00001772 void EmitLabelStmt(const LabelStmt &S);
1773 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001774 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00001775 void EmitIfStmt(const IfStmt &S);
1776 void EmitWhileStmt(const WhileStmt &S);
1777 void EmitDoStmt(const DoStmt &S);
1778 void EmitForStmt(const ForStmt &S);
1779 void EmitReturnStmt(const ReturnStmt &S);
1780 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +00001781 void EmitBreakStmt(const BreakStmt &S);
1782 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +00001783 void EmitSwitchStmt(const SwitchStmt &S);
1784 void EmitDefaultStmt(const DefaultStmt &S);
1785 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +00001786 void EmitCaseStmtRange(const CaseStmt &S);
Anders Carlssonfb1aeb82008-02-05 16:35:33 +00001787 void EmitAsmStmt(const AsmStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001788
Anders Carlsson3d8400d2008-08-30 19:51:14 +00001789 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001790 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1791 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00001792 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCallf85e1932011-06-15 23:02:42 +00001793 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001794
John McCall93c332a2011-05-28 21:13:02 +00001795 llvm::Constant *getUnwindResumeFn();
Douglas Gregor86a3a032010-05-16 01:24:12 +00001796 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCall59a70002010-07-07 06:56:46 +00001797 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1798 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCall9fc6a772010-02-19 09:25:03 +00001799
Anders Carlsson6815e942009-09-27 18:58:34 +00001800 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smithad762fc2011-04-14 22:09:26 +00001801 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001802
Reid Spencer5f016e22007-07-11 17:01:13 +00001803 //===--------------------------------------------------------------------===//
1804 // LValue Expression Emission
1805 //===--------------------------------------------------------------------===//
1806
Daniel Dunbar13e81732009-02-05 07:09:07 +00001807 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1808 RValue GetUndefRValue(QualType Ty);
1809
Daniel Dunbarce1d38b2009-01-09 16:50:52 +00001810 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1811 /// and issue an ErrorUnsupported style diagnostic (using the
1812 /// provided Name).
1813 RValue EmitUnsupportedRValue(const Expr *E,
1814 const char *Name);
1815
Mike Stump0dd9e882009-02-08 23:14:22 +00001816 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
1817 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbar6ba82a42008-08-25 20:45:57 +00001818 LValue EmitUnsupportedLValue(const Expr *E,
1819 const char *Name);
1820
Reid Spencer5f016e22007-07-11 17:01:13 +00001821 /// EmitLValue - Emit code to compute a designator that specifies the location
1822 /// of the expression.
1823 ///
1824 /// This can return one of two things: a simple address or a bitfield
1825 /// reference. In either case, the LLVM Value* in the LValue structure is
1826 /// guaranteed to be an LLVM pointer type.
1827 ///
1828 /// If this returns a bitfield reference, nothing about the pointee type of
1829 /// the LLVM value is known: For example, it may not be a pointer to an
1830 /// integer.
1831 ///
1832 /// If this returns a normal address, and if the lvalue's C type is fixed
1833 /// size, this method guarantees that the returned pointer type will point to
1834 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
1835 /// variable length type, this is not possible.
1836 ///
1837 LValue EmitLValue(const Expr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00001838
Mike Stumpb14e62d2009-12-16 02:57:00 +00001839 /// EmitCheckedLValue - Same as EmitLValue but additionally we generate
1840 /// checking code to guard against undefined behavior. This is only
1841 /// suitable when we know that the address will be used to access the
1842 /// object.
1843 LValue EmitCheckedLValue(const Expr *E);
1844
John McCall26815d92010-10-27 20:58:56 +00001845 /// EmitToMemory - Change a scalar value from its value
1846 /// representation to its in-memory representation.
1847 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
1848
1849 /// EmitFromMemory - Change a scalar value from its memory
1850 /// representation to its value representation.
1851 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
1852
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00001853 /// EmitLoadOfScalar - Load a scalar value from an address, taking
1854 /// care to appropriately convert from the memory representation to
1855 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00001856 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman3d5aff52010-10-14 23:06:10 +00001857 unsigned Alignment, QualType Ty,
1858 llvm::MDNode *TBAAInfo = 0);
John McCalla07398e2011-06-16 04:16:24 +00001859 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00001860
1861 /// EmitStoreOfScalar - Store a scalar value to an address, taking
1862 /// care to appropriately convert from the memory representation to
1863 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00001864 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman3d5aff52010-10-14 23:06:10 +00001865 bool Volatile, unsigned Alignment, QualType Ty,
1866 llvm::MDNode *TBAAInfo = 0);
John McCalla07398e2011-06-16 04:16:24 +00001867 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00001868
Reid Spencer5f016e22007-07-11 17:01:13 +00001869 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
1870 /// this method emits the address of the lvalue, then loads the result as an
1871 /// rvalue, returning the rvalue.
Reid Spencer5f016e22007-07-11 17:01:13 +00001872 RValue EmitLoadOfLValue(LValue V, QualType LVType);
Nate Begeman213541a2008-04-18 23:10:10 +00001873 RValue EmitLoadOfExtVectorElementLValue(LValue V, QualType LVType);
Lauro Ramos Venancio3b8c22d2008-01-22 20:17:04 +00001874 RValue EmitLoadOfBitfieldLValue(LValue LV, QualType ExprType);
John McCall119a1c62010-12-04 02:32:38 +00001875 RValue EmitLoadOfPropertyRefLValue(LValue LV,
1876 ReturnValueSlot Return = ReturnValueSlot());
Mike Stump0dd9e882009-02-08 23:14:22 +00001877
Reid Spencer5f016e22007-07-11 17:01:13 +00001878 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
1879 /// lvalue, where both are guaranteed to the have the same type, and that type
1880 /// is 'Ty'.
1881 void EmitStoreThroughLValue(RValue Src, LValue Dst, QualType Ty);
Nate Begeman213541a2008-04-18 23:10:10 +00001882 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst,
1883 QualType Ty);
John McCall119a1c62010-12-04 02:32:38 +00001884 void EmitStoreThroughPropertyRefLValue(RValue Src, LValue Dst);
Daniel Dunbared3849b2008-11-19 09:36:46 +00001885
Mike Stump0dd9e882009-02-08 23:14:22 +00001886 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
1887 /// EmitStoreThroughLValue.
Daniel Dunbared3849b2008-11-19 09:36:46 +00001888 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001889 /// \param Result [out] - If non-null, this will be set to a Value* for the
1890 /// bit-field contents after the store, appropriate for use as the result of
1891 /// an assignment to the bit-field.
Daniel Dunbared3849b2008-11-19 09:36:46 +00001892 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, QualType Ty,
1893 llvm::Value **Result=0);
Mike Stump0dd9e882009-02-08 23:14:22 +00001894
John McCall83ce9d42010-11-16 23:07:28 +00001895 /// Emit an l-value for an assignment (simple or compound) of complex type.
1896 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00001897 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall83ce9d42010-11-16 23:07:28 +00001898
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00001899 // Note: only available for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +00001900 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00001901 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00001902 // Note: only available for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +00001903 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00001904 // Note: only available for agg return types
1905 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00001906 LValue EmitDeclRefLValue(const DeclRefExpr *E);
1907 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnereaf2bb82009-02-24 22:18:39 +00001908 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattnerd9f69102008-08-10 01:53:14 +00001909 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00001910 LValue EmitUnaryOpLValue(const UnaryOperator *E);
1911 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begeman213541a2008-04-18 23:10:10 +00001912 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +00001913 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian820bca42009-12-09 23:35:29 +00001914 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +00001915 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
John McCall56ca35d2011-02-17 10:25:35 +00001916 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner75dfeda2009-03-18 18:28:57 +00001917 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregored8abf12010-07-08 06:14:04 +00001918 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregor03e80032011-06-21 17:03:29 +00001919 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCalle996ffd2011-02-16 08:02:54 +00001920 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001921
Daniel Dunbar2a031922009-04-22 05:08:15 +00001922 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00001923 const ObjCIvarDecl *Ivar);
John McCalla9976d32010-05-21 01:18:57 +00001924 LValue EmitLValueForAnonRecordField(llvm::Value* Base,
Francois Pichet00eb3f92010-12-04 09:14:42 +00001925 const IndirectFieldDecl* Field,
John McCalla9976d32010-05-21 01:18:57 +00001926 unsigned CVRQualifiers);
Anders Carlsson0ed303c2009-11-17 03:57:07 +00001927 LValue EmitLValueForField(llvm::Value* Base, const FieldDecl* Field,
Anders Carlssone6d2a532010-01-29 05:05:36 +00001928 unsigned CVRQualifiers);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001929
Anders Carlsson06a29702010-01-29 05:24:29 +00001930 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
1931 /// if the Field is a reference, this will return the address of the reference
1932 /// and not the address of the value stored in the reference.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001933 LValue EmitLValueForFieldInitialization(llvm::Value* Base,
Anders Carlsson06a29702010-01-29 05:24:29 +00001934 const FieldDecl* Field,
1935 unsigned CVRQualifiers);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001936
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001937 LValue EmitLValueForIvar(QualType ObjectTy,
1938 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00001939 unsigned CVRQualifiers);
1940
Anders Carlsson0ed303c2009-11-17 03:57:07 +00001941 LValue EmitLValueForBitfield(llvm::Value* Base, const FieldDecl* Field,
Fariborz Jahanian598d3f62009-02-03 19:03:09 +00001942 unsigned CVRQualifiers);
Fariborz Jahanianfd64bb62008-12-15 20:35:07 +00001943
Mike Stumpa99038c2009-02-28 09:07:16 +00001944 LValue EmitBlockDeclRefLValue(const BlockDeclRefExpr *E);
1945
Anders Carlssonb58d0172009-05-30 23:23:33 +00001946 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssone61c9e82009-05-30 23:30:54 +00001947 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
John McCall4765fa02010-12-06 08:20:24 +00001948 LValue EmitExprWithCleanupsLValue(const ExprWithCleanups *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001949 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001950
Daniel Dunbar0a04d772008-08-23 10:51:21 +00001951 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +00001952 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Daniel Dunbar85c59ed2008-08-29 08:11:39 +00001953 LValue EmitObjCPropertyRefLValue(const ObjCPropertyRefExpr *E);
Chris Lattner65459942009-04-25 19:35:26 +00001954 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanian8bfd31f2009-10-22 22:57:31 +00001955 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian03b29602010-06-17 19:56:20 +00001956 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCall189d6ef2010-10-09 01:34:31 +00001957 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCall56ca35d2011-02-17 10:25:35 +00001958
Reid Spencer5f016e22007-07-11 17:01:13 +00001959 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +00001960 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +00001961 //===--------------------------------------------------------------------===//
1962
Mike Stump0dd9e882009-02-08 23:14:22 +00001963 /// EmitCall - Generate a call of the given function, expecting the given
1964 /// result type, and using the given argument list which specifies both the
1965 /// LLVM arguments and the types they were derived from.
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00001966 ///
Mike Stumpf71d2322009-11-30 20:08:49 +00001967 /// \param TargetDecl - If given, the decl of the function in a direct call;
1968 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbar88b53962009-02-02 22:03:45 +00001969 RValue EmitCall(const CGFunctionInfo &FnInfo,
1970 llvm::Value *Callee,
Anders Carlssonf3c47c92009-12-24 19:25:24 +00001971 ReturnValueSlot ReturnValue,
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00001972 const CallArgList &Args,
David Chisnalldd5c98f2010-05-01 11:15:56 +00001973 const Decl *TargetDecl = 0,
David Chisnall4b02afc2010-05-02 13:41:58 +00001974 llvm::Instruction **callOrInvoke = 0);
Mike Stump1eb44332009-09-09 15:08:12 +00001975
Anders Carlsson31777a22009-12-24 19:08:58 +00001976 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlssond2490a92009-12-24 20:40:36 +00001977 ReturnValueSlot ReturnValue,
Anders Carlsson98647712009-05-27 01:22:39 +00001978 CallExpr::const_arg_iterator ArgBeg,
1979 CallExpr::const_arg_iterator ArgEnd,
1980 const Decl *TargetDecl = 0);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001981 RValue EmitCallExpr(const CallExpr *E,
Anders Carlssond2490a92009-12-24 20:40:36 +00001982 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump1eb44332009-09-09 15:08:12 +00001983
John McCallf1549f62010-07-06 01:34:17 +00001984 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
1985 llvm::Value * const *ArgBegin,
1986 llvm::Value * const *ArgEnd,
1987 const llvm::Twine &Name = "");
1988
Anders Carlsson566abee2009-11-13 04:45:41 +00001989 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Mike Stumpf0070db2009-08-26 20:46:33 +00001990 const llvm::Type *Ty);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001991 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Anders Carlsson83eedd92010-11-28 17:53:32 +00001992 llvm::Value *This, const llvm::Type *Ty);
Fariborz Jahanian27262672011-01-20 17:19:02 +00001993 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
1994 NestedNameSpecifier *Qual,
Fariborz Jahanian27262672011-01-20 17:19:02 +00001995 const llvm::Type *Ty);
Fariborz Jahanianccd52592011-02-01 23:22:34 +00001996
1997 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
1998 CXXDtorType Type,
Fariborz Jahanian771c6782011-02-03 19:27:17 +00001999 const CXXRecordDecl *RD);
Anders Carlsson566abee2009-11-13 04:45:41 +00002000
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002001 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
2002 llvm::Value *Callee,
Anders Carlssona1736c02009-12-24 21:13:40 +00002003 ReturnValueSlot ReturnValue,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002004 llvm::Value *This,
Anders Carlssonc997d422010-01-02 01:01:18 +00002005 llvm::Value *VTT,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002006 CallExpr::const_arg_iterator ArgBeg,
2007 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssona1736c02009-12-24 21:13:40 +00002008 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2009 ReturnValueSlot ReturnValue);
2010 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2011 ReturnValueSlot ReturnValue);
Ted Kremenek55499762008-06-17 02:43:46 +00002012
Anders Carlssona2447e02011-05-08 20:32:23 +00002013 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2014 const CXXMethodDecl *MD,
2015 llvm::Value *This);
Anders Carlsson0f294632009-05-27 04:18:27 +00002016 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssona1736c02009-12-24 21:13:40 +00002017 const CXXMethodDecl *MD,
2018 ReturnValueSlot ReturnValue);
Mike Stump1eb44332009-09-09 15:08:12 +00002019
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002020
Mike Stump1eb44332009-09-09 15:08:12 +00002021 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbaref2abfe2009-02-16 22:43:43 +00002022 unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002023
Anders Carlssona1736c02009-12-24 21:13:40 +00002024 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stump09429b92009-02-17 17:00:02 +00002025
Mike Stump0dd9e882009-02-08 23:14:22 +00002026 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2027 /// is unhandled by the current target.
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +00002028 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2029
Chris Lattner2752c012010-03-03 19:03:45 +00002030 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002031 llvm::Value *EmitNeonCall(llvm::Function *F,
Nate Begeman30d91712010-06-08 06:03:01 +00002032 llvm::SmallVectorImpl<llvm::Value*> &O,
Bob Wilsondb3d4d02010-12-08 22:37:56 +00002033 const char *name,
Nate Begeman61eecf52010-06-14 05:21:25 +00002034 unsigned shift = 0, bool rightshift = false);
Bob Wilsoncf556522010-12-07 22:40:02 +00002035 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Nate Begeman464ccb62010-06-11 22:57:12 +00002036 llvm::Value *EmitNeonShiftVector(llvm::Value *V, const llvm::Type *Ty,
Nate Begeman61eecf52010-06-14 05:21:25 +00002037 bool negateForRightShift);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002038
Bill Wendlingaa51e512010-10-09 08:47:25 +00002039 llvm::Value *BuildVector(const llvm::SmallVectorImpl<llvm::Value*> &Ops);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002040 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2041 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002042
Daniel Dunbared7c6182008-08-20 00:28:19 +00002043 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +00002044 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Chris Lattner8fdf3282008-06-24 17:04:18 +00002045 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCallef072fd2010-05-22 01:48:05 +00002046 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2047 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattner8fdf3282008-06-24 17:04:18 +00002048
John McCallf85e1932011-06-15 23:02:42 +00002049 /// Retrieves the default cleanup kind for an ARC cleanup.
2050 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2051 CleanupKind getARCCleanupKind() {
2052 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2053 ? NormalAndEHCleanup : NormalCleanup;
2054 }
2055
2056 // ARC primitives.
2057 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2058 void EmitARCDestroyWeak(llvm::Value *addr);
2059 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2060 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2061 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2062 bool ignored);
2063 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2064 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2065 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2066 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
2067 llvm::Value *EmitARCStoreStrong(LValue addr, QualType type,
2068 llvm::Value *value, bool ignored);
2069 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2070 bool ignored);
2071 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2072 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
2073 llvm::Value *EmitARCRetainBlock(llvm::Value *value);
2074 void EmitARCRelease(llvm::Value *value, bool precise);
2075 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2076 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2077 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2078 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2079
2080 std::pair<LValue,llvm::Value*>
2081 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2082 std::pair<LValue,llvm::Value*>
2083 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2084
2085 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2086 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2087 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2088
2089 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2090 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2091
2092 void PushARCReleaseCleanup(CleanupKind kind, QualType type,
Douglas Gregord7b23162011-06-22 16:12:01 +00002093 llvm::Value *addr, bool precise,
2094 bool forFullExpr = false);
John McCallf85e1932011-06-15 23:02:42 +00002095 void PushARCWeakReleaseCleanup(CleanupKind kind, QualType type,
Douglas Gregord7b23162011-06-22 16:12:01 +00002096 llvm::Value *addr, bool forFullExpr = false);
John McCallf85e1932011-06-15 23:02:42 +00002097 void PushARCFieldReleaseCleanup(CleanupKind cleanupKind,
2098 const FieldDecl *Field);
2099 void PushARCFieldWeakReleaseCleanup(CleanupKind cleanupKind,
2100 const FieldDecl *Field);
2101
2102 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2103 llvm::Value *EmitObjCAutoreleasePoolPush();
2104 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2105 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2106 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2107
Anders Carlsson4029ca72009-05-20 00:24:07 +00002108 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2109 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002110 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson32f36ba2010-06-26 16:35:32 +00002111 const NamedDecl *InitializedDecl);
Anders Carlsson3aba0932010-01-31 18:34:51 +00002112
Chris Lattner883f6a72007-08-11 00:04:45 +00002113 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002114 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +00002115 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002116
2117 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stump0dd9e882009-02-08 23:14:22 +00002118
2119 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2120 /// scalar type, returning the result.
Anders Carlsson14c5cbf2009-08-16 07:36:22 +00002121 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002122
Chris Lattner3707b252007-08-26 06:48:56 +00002123 /// EmitScalarConversion - Emit a conversion from the specified type to the
2124 /// specified destination type, both of which are LLVM scalar types.
2125 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2126 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002127
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002128 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stump0dd9e882009-02-08 23:14:22 +00002129 /// complex type to the specified destination type, where the destination type
2130 /// is an LLVM scalar type.
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002131 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2132 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002133
2134
John McCall558d2ab2010-09-15 10:14:12 +00002135 /// EmitAggExpr - Emit the computation of the specified expression
2136 /// of aggregate type. The result is computed into the given slot,
2137 /// which may be null to indicate that the value is not needed.
Fariborz Jahanian474e2fe2010-09-16 00:20:07 +00002138 void EmitAggExpr(const Expr *E, AggValueSlot AS, bool IgnoreResult = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002139
Daniel Dunbar18aba0d2010-02-05 19:38:31 +00002140 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2141 /// aggregate type into a temporary LValue.
2142 LValue EmitAggExprToLValue(const Expr *E);
2143
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002144 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2145 /// pointers.
2146 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian08c32132009-08-31 19:33:16 +00002147 QualType Ty);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002148
John McCall0c24c802011-06-24 23:21:27 +00002149 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2150 /// make sure it survives garbage collection until this point.
2151 void EmitExtendGCLifetime(llvm::Value *object);
2152
Chris Lattnerb6ef18a2007-08-21 05:54:00 +00002153 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002154 /// complex type, returning the result.
John McCallb418d742010-11-16 10:08:07 +00002155 ComplexPairTy EmitComplexExpr(const Expr *E,
2156 bool IgnoreReal = false,
2157 bool IgnoreImag = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002158
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002159 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
2160 /// of complex type, storing into the specified Value*.
Chris Lattner190dbe22007-08-26 16:22:13 +00002161 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
2162 bool DestIsVolatile);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00002163
2164 /// StoreComplexToAddr - Store a complex number into the specified address.
2165 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
2166 bool DestIsVolatile);
Chris Lattner9b655512007-08-31 22:49:20 +00002167 /// LoadComplexFromAddr - Load a complex number from the specified address.
2168 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattner2621fd12008-05-08 05:58:21 +00002169
John McCallb6bbcc92010-10-15 04:57:14 +00002170 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2171 /// a static local variable.
2172 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2173 const char *Separator,
Mike Stumpf71d2322009-11-30 20:08:49 +00002174 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002175
John McCallb6bbcc92010-10-15 04:57:14 +00002176 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
Chris Lattner761acc12009-12-05 08:22:11 +00002177 /// global variable that has already been created for it. If the initializer
2178 /// has a different type than GV does, this may free GV and return a different
2179 /// one. Otherwise it just returns GV.
2180 llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +00002181 AddInitializerToStaticVarDecl(const VarDecl &D,
2182 llvm::GlobalVariable *GV);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002183
Daniel Dunbar0096acf2009-02-25 19:24:29 +00002184
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002185 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2186 /// variable with global storage.
2187 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr);
2188
2189 /// EmitCXXGlobalDtorRegistration - Emits a call to register the global ptr
2190 /// with the C++ runtime so that its destructor will be called at exit.
Fariborz Jahanian88f42802009-11-10 19:24:06 +00002191 void EmitCXXGlobalDtorRegistration(llvm::Constant *DtorFn,
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002192 llvm::Constant *DeclPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00002193
John McCall3030eb82010-11-06 09:44:32 +00002194 /// Emit code in this function to perform a guarded variable
2195 /// initialization. Guarded initializations are used when it's not
2196 /// possible to prove that an initialization will be done exactly
2197 /// once, e.g. with a static local variable or a static data member
2198 /// of a class template.
2199 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr);
John McCall5cd91b52010-09-08 01:44:27 +00002200
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002201 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2202 /// variables.
2203 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2204 llvm::Constant **Decls,
2205 unsigned NumDecls);
2206
2207 /// GenerateCXXGlobalDtorFunc - Generates code for destroying global
2208 /// variables.
2209 void GenerateCXXGlobalDtorFunc(llvm::Function *Fn,
Chris Lattner810112e2010-06-19 05:52:45 +00002210 const std::vector<std::pair<llvm::WeakVH,
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002211 llvm::Constant*> > &DtorsAndObjects);
2212
John McCalld26bc762011-03-09 04:27:21 +00002213 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2214 const VarDecl *D,
John McCall3030eb82010-11-06 09:44:32 +00002215 llvm::GlobalVariable *Addr);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002216
John McCall558d2ab2010-09-15 10:14:12 +00002217 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002218
2219 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian830937b2010-12-02 17:02:11 +00002220 const Expr *Exp);
Mike Stump1eb44332009-09-09 15:08:12 +00002221
John McCall4765fa02010-12-06 08:20:24 +00002222 RValue EmitExprWithCleanups(const ExprWithCleanups *E,
2223 AggValueSlot Slot =AggValueSlot::ignored());
Mike Stump1eb44332009-09-09 15:08:12 +00002224
Anders Carlsson756b5c42009-10-30 01:42:31 +00002225 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregor1eb2e592010-05-16 00:44:00 +00002226
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002227 //===--------------------------------------------------------------------===//
2228 // Internal Helpers
2229 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002230
Chris Lattner0946ccd2008-11-11 07:41:27 +00002231 /// ContainsLabel - Return true if the statement contains a label in it. If
2232 /// this statement is not executed normally, it not containing a label means
2233 /// that we can just remove the code.
2234 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002235
Chris Lattneref425a62011-02-28 00:18:40 +00002236 /// containsBreak - Return true if the statement contains a break out of it.
2237 /// If the statement (recursively) contains a switch or loop with a break
2238 /// inside of it, this is fine.
2239 static bool containsBreak(const Stmt *S);
2240
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002241 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnerc2c90012011-02-27 23:02:32 +00002242 /// to a constant, or if it does but contains a label, return false. If it
2243 /// constant folds return true and set the boolean result in Result.
2244 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stump0dd9e882009-02-08 23:14:22 +00002245
Chris Lattneref425a62011-02-28 00:18:40 +00002246 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2247 /// to a constant, or if it does but contains a label, return false. If it
2248 /// constant folds return true and set the folded value.
2249 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APInt &Result);
2250
Chris Lattner31a09842008-11-12 08:04:58 +00002251 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2252 /// if statement) to the specified blocks. Based on the condition, this might
2253 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattner9bc47e22008-11-12 07:46:33 +00002254 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002255 llvm::BasicBlock *FalseBlock);
Mike Stumpbe07f602009-12-14 21:58:14 +00002256
Mike Stump15037ca2009-12-15 00:35:12 +00002257 /// getTrapBB - Create a basic block that will call the trap intrinsic. We'll
2258 /// generate a branch around the created basic block as necessary.
Chris Lattner6c552c12010-07-20 20:19:24 +00002259 llvm::BasicBlock *getTrapBB();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002260
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002261 /// EmitCallArg - Emit a single call argument.
John McCall413ebdb2011-03-11 20:59:21 +00002262 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002263
John McCall27360712010-05-26 22:34:26 +00002264 /// EmitDelegateCallArg - We are performing a delegate call; that
2265 /// is, the current function is delegating to another one. Produce
2266 /// a r-value suitable for passing the given parameter.
John McCall413ebdb2011-03-11 20:59:21 +00002267 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall27360712010-05-26 22:34:26 +00002268
Chris Lattner31a09842008-11-12 08:04:58 +00002269private:
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002270 void EmitReturnOfRValue(RValue RV, QualType Ty);
2271
Daniel Dunbar56273772008-09-17 00:51:38 +00002272 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2273 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2274 ///
2275 /// \param AI - The first function argument of the expansion.
2276 /// \return The argument following the last expanded function
2277 /// argument.
Mike Stump0dd9e882009-02-08 23:14:22 +00002278 llvm::Function::arg_iterator
Daniel Dunbar56273772008-09-17 00:51:38 +00002279 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2280 llvm::Function::arg_iterator AI);
2281
Mike Stump0dd9e882009-02-08 23:14:22 +00002282 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2283 /// Ty, into individual arguments on the provided vector \arg Args. See
2284 /// ABIArgInfo::Expand.
2285 void ExpandTypeToArgs(QualType Ty, RValue Src,
Daniel Dunbar56273772008-09-17 00:51:38 +00002286 llvm::SmallVector<llvm::Value*, 16> &Args);
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002287
Mike Stump1eb44332009-09-09 15:08:12 +00002288 llvm::Value* EmitAsmInput(const AsmStmt &S,
Daniel Dunbarb84e8a62009-05-04 06:56:16 +00002289 const TargetInfo::ConstraintInfo &Info,
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002290 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stump0dd9e882009-02-08 23:14:22 +00002291
Eli Friedman6d7cfd72010-07-16 00:55:21 +00002292 llvm::Value* EmitAsmInputLValue(const AsmStmt &S,
2293 const TargetInfo::ConstraintInfo &Info,
2294 LValue InputValue, QualType InputType,
2295 std::string &ConstraintStr);
2296
Anders Carlsson0139bb92009-04-08 20:47:54 +00002297 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump1eb44332009-09-09 15:08:12 +00002298 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlssonaf23f692009-04-18 20:20:22 +00002299 /// argument types of the function being called.
2300 template<typename T>
2301 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson0139bb92009-04-08 20:47:54 +00002302 CallExpr::const_arg_iterator ArgBeg,
Anders Carlssonaf23f692009-04-18 20:20:22 +00002303 CallExpr::const_arg_iterator ArgEnd) {
2304 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson0139bb92009-04-08 20:47:54 +00002305
Anders Carlssonaf23f692009-04-18 20:20:22 +00002306 // First, use the argument types that the type info knows about
2307 if (CallArgTypeInfo) {
2308 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2309 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman44b0a3e2009-11-18 03:42:04 +00002310 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlssonaf23f692009-04-18 20:20:22 +00002311 QualType ArgType = *I;
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002312#ifndef NDEBUG
2313 QualType ActualArgType = Arg->getType();
2314 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002315 QualType ActualBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002316 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002317 QualType ArgBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002318 ArgType->getAs<PointerType>()->getPointeeType();
2319 if (ArgBaseType->isVariableArrayType()) {
2320 if (const VariableArrayType *VAT =
2321 getContext().getAsVariableArrayType(ActualBaseType)) {
2322 if (!VAT->getSizeExpr())
2323 ActualArgType = ArgType;
2324 }
2325 }
2326 }
Anders Carlssonaf23f692009-04-18 20:20:22 +00002327 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump1eb44332009-09-09 15:08:12 +00002328 getTypePtr() ==
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002329 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002330 "type mismatch in call argument!");
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002331#endif
John McCall413ebdb2011-03-11 20:59:21 +00002332 EmitCallArg(Args, *Arg, ArgType);
Anders Carlssonaf23f692009-04-18 20:20:22 +00002333 }
Mike Stump1eb44332009-09-09 15:08:12 +00002334
2335 // Either we've emitted all the call args, or we have a call to a
Anders Carlssonaf23f692009-04-18 20:20:22 +00002336 // variadic function.
Mike Stump1eb44332009-09-09 15:08:12 +00002337 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002338 "Extra arguments in non-variadic function!");
Mike Stump1eb44332009-09-09 15:08:12 +00002339
Anders Carlssonaf23f692009-04-18 20:20:22 +00002340 }
Mike Stump1eb44332009-09-09 15:08:12 +00002341
Anders Carlssonaf23f692009-04-18 20:20:22 +00002342 // If we still have any arguments, emit them using the type of the argument.
John McCall413ebdb2011-03-11 20:59:21 +00002343 for (; Arg != ArgEnd; ++Arg)
2344 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlssonaf23f692009-04-18 20:20:22 +00002345 }
John McCall492c4f92010-03-03 04:15:11 +00002346
2347 const TargetCodeGenInfo &getTargetHooks() const {
2348 return CGM.getTargetCodeGenInfo();
2349 }
John McCall744016d2010-07-06 23:57:41 +00002350
2351 void EmitDeclMetadata();
John McCallf0c11f72011-03-31 08:03:29 +00002352
2353 CodeGenModule::ByrefHelpers *
2354 buildByrefHelpers(const llvm::StructType &byrefType,
2355 const AutoVarEmission &emission);
Reid Spencer5f016e22007-07-11 17:01:13 +00002356};
Mike Stump1eb44332009-09-09 15:08:12 +00002357
John McCall150b4622011-01-26 04:00:11 +00002358/// Helper class with most of the code for saving a value for a
2359/// conditional expression cleanup.
John McCall804b8072011-01-28 10:53:53 +00002360struct DominatingLLVMValue {
John McCall150b4622011-01-26 04:00:11 +00002361 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2362
2363 /// Answer whether the given value needs extra work to be saved.
2364 static bool needsSaving(llvm::Value *value) {
2365 // If it's not an instruction, we don't need to save.
2366 if (!isa<llvm::Instruction>(value)) return false;
2367
2368 // If it's an instruction in the entry block, we don't need to save.
2369 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2370 return (block != &block->getParent()->getEntryBlock());
2371 }
2372
2373 /// Try to save the given value.
2374 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2375 if (!needsSaving(value)) return saved_type(value, false);
2376
2377 // Otherwise we need an alloca.
2378 llvm::Value *alloca =
2379 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2380 CGF.Builder.CreateStore(value, alloca);
2381
2382 return saved_type(alloca, true);
2383 }
2384
2385 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2386 if (!value.getInt()) return value.getPointer();
2387 return CGF.Builder.CreateLoad(value.getPointer());
2388 }
2389};
2390
John McCall804b8072011-01-28 10:53:53 +00002391/// A partial specialization of DominatingValue for llvm::Values that
2392/// might be llvm::Instructions.
2393template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2394 typedef T *type;
John McCall150b4622011-01-26 04:00:11 +00002395 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCall804b8072011-01-28 10:53:53 +00002396 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2397 }
2398};
2399
2400/// A specialization of DominatingValue for RValue.
2401template <> struct DominatingValue<RValue> {
2402 typedef RValue type;
2403 class saved_type {
2404 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2405 AggregateAddress, ComplexAddress };
2406
2407 llvm::Value *Value;
2408 Kind K;
2409 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2410
2411 public:
2412 static bool needsSaving(RValue value);
2413 static saved_type save(CodeGenFunction &CGF, RValue value);
2414 RValue restore(CodeGenFunction &CGF);
2415
2416 // implementations in CGExprCXX.cpp
2417 };
2418
2419 static bool needsSaving(type value) {
2420 return saved_type::needsSaving(value);
2421 }
2422 static saved_type save(CodeGenFunction &CGF, type value) {
2423 return saved_type::save(CGF, value);
2424 }
2425 static type restore(CodeGenFunction &CGF, saved_type value) {
2426 return value.restore(CGF);
John McCall150b4622011-01-26 04:00:11 +00002427 }
2428};
2429
Reid Spencer5f016e22007-07-11 17:01:13 +00002430} // end namespace CodeGen
2431} // end namespace clang
2432
2433#endif