blob: 105cfbec8239d33bd0b987d36d8fbdffdf51a998 [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"
Jay Foad4c7d9f12011-07-15 08:37:34 +000024#include "llvm/ADT/ArrayRef.h"
Chris Lattner481769b2009-03-31 22:17:44 +000025#include "llvm/ADT/DenseMap.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/Support/ValueHandle.h"
Eric Christopherc3287792011-10-19 00:43:52 +000028#include "llvm/Support/Debug.h"
Owen Anderson69243822009-07-13 04:10:07 +000029#include "CodeGenModule.h"
Daniel Dunbar45d196b2008-11-01 01:53:16 +000030#include "CGBuilder.h"
Eric Christopherc3287792011-10-19 00:43:52 +000031#include "CGDebugInfo.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000032#include "CGValue.h"
33
Reid Spencer5f016e22007-07-11 17:01:13 +000034namespace llvm {
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000035 class BasicBlock;
Benjamin Kramerf21efe92009-08-11 17:46:57 +000036 class LLVMContext;
David Chisnalldd5c98f2010-05-01 11:15:56 +000037 class MDNode;
Reid Spencer5f016e22007-07-11 17:01:13 +000038 class Module;
Daniel Dunbar898d5082008-09-30 01:06:03 +000039 class SwitchInst;
Daniel Dunbar259e9cc2009-10-19 01:21:05 +000040 class Twine;
Daniel Dunbared3849b2008-11-19 09:36:46 +000041 class Value;
John McCallf1549f62010-07-06 01:34:17 +000042 class CallSite;
Reid Spencer5f016e22007-07-11 17:01:13 +000043}
44
45namespace clang {
46 class ASTContext;
John McCall1a343eb2011-11-10 08:15:53 +000047 class BlockDecl;
Anders Carlsson7267c162009-05-29 21:03:38 +000048 class CXXDestructorDecl;
Richard Smithad762fc2011-04-14 22:09:26 +000049 class CXXForRangeStmt;
Anders Carlsson6815e942009-09-27 18:58:34 +000050 class CXXTryStmt;
Reid Spencer5f016e22007-07-11 17:01:13 +000051 class Decl;
Chris Lattnerad8dcf42011-02-17 07:39:24 +000052 class LabelDecl;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000053 class EnumConstantDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000054 class FunctionDecl;
Douglas Gregor72564e72009-02-26 23:50:07 +000055 class FunctionProtoType;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000056 class LabelStmt;
Fariborz Jahanian679a5022009-01-10 21:06:09 +000057 class ObjCContainerDecl;
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +000058 class ObjCInterfaceDecl;
59 class ObjCIvarDecl;
Chris Lattner391d77a2008-03-30 23:03:07 +000060 class ObjCMethodDecl;
Fariborz Jahanianfef30b52008-12-09 20:23:04 +000061 class ObjCImplementationDecl;
Daniel Dunbaraf05bb92008-08-26 08:29:31 +000062 class ObjCPropertyImplDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000063 class TargetInfo;
John McCall492c4f92010-03-03 04:15:11 +000064 class TargetCodeGenInfo;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000065 class VarDecl;
Chris Lattner16f00492009-04-26 01:32:48 +000066 class ObjCForCollectionStmt;
67 class ObjCAtTryStmt;
68 class ObjCAtThrowStmt;
69 class ObjCAtSynchronizedStmt;
John McCallf85e1932011-06-15 23:02:42 +000070 class ObjCAutoreleasePoolStmt;
Devang Patelb84a06e2007-10-23 02:10:49 +000071
Reid Spencer5f016e22007-07-11 17:01:13 +000072namespace CodeGen {
Devang Patelb84a06e2007-10-23 02:10:49 +000073 class CodeGenTypes;
Daniel Dunbarbb36d332009-02-02 21:43:58 +000074 class CGFunctionInfo;
Mike Stump0dd9e882009-02-08 23:14:22 +000075 class CGRecordLayout;
John McCallee504292010-05-21 04:11:14 +000076 class CGBlockInfo;
John McCall4c40d982010-08-31 07:33:07 +000077 class CGCXXABI;
John McCalld16c2cf2011-02-08 08:22:06 +000078 class BlockFlags;
79 class BlockFieldFlags;
Mike Stump0dd9e882009-02-08 23:14:22 +000080
John McCallf1549f62010-07-06 01:34:17 +000081/// A branch fixup. These are required when emitting a goto to a
82/// label which hasn't been emitted yet. The goto is optimistically
83/// emitted as a branch to the basic block for the label, and (if it
84/// occurs in a scope with non-trivial cleanups) a fixup is added to
85/// the innermost cleanup. When a (normal) cleanup is popped, any
86/// unresolved fixups in that scope are threaded through the cleanup.
87struct BranchFixup {
John McCallff8e1152010-07-23 21:56:41 +000088 /// The block containing the terminator which needs to be modified
89 /// into a switch if this fixup is resolved into the current scope.
90 /// If null, LatestBranch points directly to the destination.
91 llvm::BasicBlock *OptimisticBranchBlock;
John McCallf1549f62010-07-06 01:34:17 +000092
John McCallff8e1152010-07-23 21:56:41 +000093 /// The ultimate destination of the branch.
John McCallf1549f62010-07-06 01:34:17 +000094 ///
95 /// This can be set to null to indicate that this fixup was
96 /// successfully resolved.
97 llvm::BasicBlock *Destination;
98
John McCallff8e1152010-07-23 21:56:41 +000099 /// The destination index value.
100 unsigned DestinationIndex;
101
102 /// The initial branch of the fixup.
103 llvm::BranchInst *InitialBranch;
John McCallf1549f62010-07-06 01:34:17 +0000104};
105
John McCall804b8072011-01-28 10:53:53 +0000106template <class T> struct InvariantValue {
John McCall150b4622011-01-26 04:00:11 +0000107 typedef T type;
108 typedef T saved_type;
109 static bool needsSaving(type value) { return false; }
110 static saved_type save(CodeGenFunction &CGF, type value) { return value; }
111 static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
112};
John McCall804b8072011-01-28 10:53:53 +0000113
114/// A metaprogramming class for ensuring that a value will dominate an
115/// arbitrary position in a function.
116template <class T> struct DominatingValue : InvariantValue<T> {};
117
118template <class T, bool mightBeInstruction =
119 llvm::is_base_of<llvm::Value, T>::value &&
120 !llvm::is_base_of<llvm::Constant, T>::value &&
121 !llvm::is_base_of<llvm::BasicBlock, T>::value>
122struct DominatingPointer;
123template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
124// template <class T> struct DominatingPointer<T,true> at end of file
125
126template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
John McCall150b4622011-01-26 04:00:11 +0000127
John McCallcd2d2b72010-08-13 21:20:51 +0000128enum CleanupKind {
129 EHCleanup = 0x1,
130 NormalCleanup = 0x2,
131 NormalAndEHCleanup = EHCleanup | NormalCleanup,
132
133 InactiveCleanup = 0x4,
134 InactiveEHCleanup = EHCleanup | InactiveCleanup,
135 InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
136 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
137};
John McCallda65ea82010-07-13 20:32:21 +0000138
John McCallf1549f62010-07-06 01:34:17 +0000139/// A stack of scopes which respond to exceptions, including cleanups
140/// and catch blocks.
141class EHScopeStack {
142public:
143 /// A saved depth on the scope stack. This is necessary because
144 /// pushing scopes onto the stack invalidates iterators.
145 class stable_iterator {
146 friend class EHScopeStack;
147
148 /// Offset from StartOfData to EndOfBuffer.
149 ptrdiff_t Size;
150
151 stable_iterator(ptrdiff_t Size) : Size(Size) {}
152
153 public:
154 static stable_iterator invalid() { return stable_iterator(-1); }
155 stable_iterator() : Size(-1) {}
156
157 bool isValid() const { return Size >= 0; }
158
John McCall838d7962010-08-14 07:46:19 +0000159 /// Returns true if this scope encloses I.
160 /// Returns false if I is invalid.
161 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000162 bool encloses(stable_iterator I) const { return Size <= I.Size; }
John McCall838d7962010-08-14 07:46:19 +0000163
164 /// Returns true if this scope strictly encloses I: that is,
165 /// if it encloses I and is not I.
166 /// Returns false is I is invalid.
167 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000168 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
John McCall1bda6622010-07-21 00:40:03 +0000169
John McCallf1549f62010-07-06 01:34:17 +0000170 friend bool operator==(stable_iterator A, stable_iterator B) {
171 return A.Size == B.Size;
172 }
173 friend bool operator!=(stable_iterator A, stable_iterator B) {
174 return A.Size != B.Size;
175 }
176 };
177
John McCall1f0fca52010-07-21 07:22:38 +0000178 /// Information for lazily generating a cleanup. Subclasses must be
179 /// POD-like: cleanups will not be destructed, and they will be
180 /// allocated on the cleanup stack and freely copied and moved
181 /// around.
John McCallda65ea82010-07-13 20:32:21 +0000182 ///
John McCall1f0fca52010-07-21 07:22:38 +0000183 /// Cleanup implementations should generally be declared in an
John McCallda65ea82010-07-13 20:32:21 +0000184 /// anonymous namespace.
John McCall1f0fca52010-07-21 07:22:38 +0000185 class Cleanup {
John McCallc4a1a842011-07-12 00:15:30 +0000186 // Anchor the construction vtable.
187 virtual void anchor();
John McCallda65ea82010-07-13 20:32:21 +0000188 public:
John McCallad346f42011-07-12 20:27:29 +0000189 /// Generation flags.
190 class Flags {
191 enum {
192 F_IsForEH = 0x1,
193 F_IsNormalCleanupKind = 0x2,
194 F_IsEHCleanupKind = 0x4
195 };
196 unsigned flags;
197
198 public:
199 Flags() : flags(0) {}
200
201 /// isForEH - true if the current emission is for an EH cleanup.
202 bool isForEHCleanup() const { return flags & F_IsForEH; }
203 bool isForNormalCleanup() const { return !isForEHCleanup(); }
204 void setIsForEHCleanup() { flags |= F_IsForEH; }
205
206 bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; }
207 void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; }
208
209 /// isEHCleanupKind - true if the cleanup was pushed as an EH
210 /// cleanup.
211 bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; }
212 void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; }
213 };
214
John McCallc4a1a842011-07-12 00:15:30 +0000215 // Provide a virtual destructor to suppress a very common warning
216 // that unfortunately cannot be suppressed without this. Cleanups
217 // should not rely on this destructor ever being called.
218 virtual ~Cleanup() {}
John McCall3e29f962010-07-13 23:19:49 +0000219
John McCallda65ea82010-07-13 20:32:21 +0000220 /// Emit the cleanup. For normal cleanups, this is run in the
221 /// same EH context as when the cleanup was pushed, i.e. the
222 /// immediately-enclosing context of the cleanup scope. For
223 /// EH cleanups, this is run in a terminate context.
224 ///
225 // \param IsForEHCleanup true if this is for an EH cleanup, false
226 /// if for a normal cleanup.
John McCallad346f42011-07-12 20:27:29 +0000227 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
John McCallda65ea82010-07-13 20:32:21 +0000228 };
229
John McCall150b4622011-01-26 04:00:11 +0000230 /// ConditionalCleanupN stores the saved form of its N parameters,
231 /// then restores them and performs the cleanup.
John McCall3ad32c82011-01-28 08:37:24 +0000232 template <class T, class A0>
233 class ConditionalCleanup1 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000234 typedef typename DominatingValue<A0>::saved_type A0_saved;
John McCall3ad32c82011-01-28 08:37:24 +0000235 A0_saved a0_saved;
236
John McCallad346f42011-07-12 20:27:29 +0000237 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000238 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
John McCallad346f42011-07-12 20:27:29 +0000239 T(a0).Emit(CGF, flags);
John McCall3ad32c82011-01-28 08:37:24 +0000240 }
241
242 public:
243 ConditionalCleanup1(A0_saved a0)
244 : a0_saved(a0) {}
245 };
246
John McCall150b4622011-01-26 04:00:11 +0000247 template <class T, class A0, class A1>
John McCall3ad32c82011-01-28 08:37:24 +0000248 class ConditionalCleanup2 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000249 typedef typename DominatingValue<A0>::saved_type A0_saved;
250 typedef typename DominatingValue<A1>::saved_type A1_saved;
John McCall4bbcbda2011-01-26 19:15:39 +0000251 A0_saved a0_saved;
252 A1_saved a1_saved;
John McCall150b4622011-01-26 04:00:11 +0000253
John McCallad346f42011-07-12 20:27:29 +0000254 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000255 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
256 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
John McCallad346f42011-07-12 20:27:29 +0000257 T(a0, a1).Emit(CGF, flags);
John McCall150b4622011-01-26 04:00:11 +0000258 }
259
260 public:
John McCall3ad32c82011-01-28 08:37:24 +0000261 ConditionalCleanup2(A0_saved a0, A1_saved a1)
262 : a0_saved(a0), a1_saved(a1) {}
John McCall150b4622011-01-26 04:00:11 +0000263 };
264
Douglas Gregord7b23162011-06-22 16:12:01 +0000265 template <class T, class A0, class A1, class A2>
266 class ConditionalCleanup3 : public Cleanup {
267 typedef typename DominatingValue<A0>::saved_type A0_saved;
268 typedef typename DominatingValue<A1>::saved_type A1_saved;
269 typedef typename DominatingValue<A2>::saved_type A2_saved;
270 A0_saved a0_saved;
271 A1_saved a1_saved;
272 A2_saved a2_saved;
273
John McCallad346f42011-07-12 20:27:29 +0000274 void Emit(CodeGenFunction &CGF, Flags flags) {
Douglas Gregord7b23162011-06-22 16:12:01 +0000275 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
276 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
277 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
John McCallad346f42011-07-12 20:27:29 +0000278 T(a0, a1, a2).Emit(CGF, flags);
Douglas Gregord7b23162011-06-22 16:12:01 +0000279 }
280
281 public:
282 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
John McCallc4a1a842011-07-12 00:15:30 +0000283 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
Douglas Gregord7b23162011-06-22 16:12:01 +0000284 };
285
John McCall9928c482011-07-12 16:41:08 +0000286 template <class T, class A0, class A1, class A2, class A3>
287 class ConditionalCleanup4 : public Cleanup {
288 typedef typename DominatingValue<A0>::saved_type A0_saved;
289 typedef typename DominatingValue<A1>::saved_type A1_saved;
290 typedef typename DominatingValue<A2>::saved_type A2_saved;
291 typedef typename DominatingValue<A3>::saved_type A3_saved;
292 A0_saved a0_saved;
293 A1_saved a1_saved;
294 A2_saved a2_saved;
295 A3_saved a3_saved;
296
John McCallad346f42011-07-12 20:27:29 +0000297 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall9928c482011-07-12 16:41:08 +0000298 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
299 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
300 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
301 A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved);
John McCallad346f42011-07-12 20:27:29 +0000302 T(a0, a1, a2, a3).Emit(CGF, flags);
John McCall9928c482011-07-12 16:41:08 +0000303 }
304
305 public:
306 ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3)
307 : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {}
308 };
309
John McCallf1549f62010-07-06 01:34:17 +0000310private:
311 // The implementation for this class is in CGException.h and
312 // CGException.cpp; the definition is here because it's used as a
313 // member of CodeGenFunction.
314
315 /// The start of the scope-stack buffer, i.e. the allocated pointer
316 /// for the buffer. All of these pointers are either simultaneously
317 /// null or simultaneously valid.
318 char *StartOfBuffer;
319
320 /// The end of the buffer.
321 char *EndOfBuffer;
322
323 /// The first valid entry in the buffer.
324 char *StartOfData;
325
326 /// The innermost normal cleanup on the stack.
327 stable_iterator InnermostNormalCleanup;
328
John McCall777d6e52011-08-11 02:22:43 +0000329 /// The innermost EH scope on the stack.
330 stable_iterator InnermostEHScope;
John McCallff8e1152010-07-23 21:56:41 +0000331
John McCallf1549f62010-07-06 01:34:17 +0000332 /// The current set of branch fixups. A branch fixup is a jump to
333 /// an as-yet unemitted label, i.e. a label for which we don't yet
334 /// know the EH stack depth. Whenever we pop a cleanup, we have
335 /// to thread all the current branch fixups through it.
336 ///
337 /// Fixups are recorded as the Use of the respective branch or
338 /// switch statement. The use points to the final destination.
339 /// When popping out of a cleanup, these uses are threaded through
340 /// the cleanup and adjusted to point to the new cleanup.
341 ///
342 /// Note that branches are allowed to jump into protected scopes
343 /// in certain situations; e.g. the following code is legal:
344 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
345 /// goto foo;
346 /// A a;
347 /// foo:
348 /// bar();
Chris Lattner686775d2011-07-20 06:58:45 +0000349 SmallVector<BranchFixup, 8> BranchFixups;
John McCallf1549f62010-07-06 01:34:17 +0000350
351 char *allocate(size_t Size);
352
John McCall1f0fca52010-07-21 07:22:38 +0000353 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCallda65ea82010-07-13 20:32:21 +0000354
John McCallf1549f62010-07-06 01:34:17 +0000355public:
356 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
357 InnermostNormalCleanup(stable_end()),
John McCall777d6e52011-08-11 02:22:43 +0000358 InnermostEHScope(stable_end()) {}
John McCallf1549f62010-07-06 01:34:17 +0000359 ~EHScopeStack() { delete[] StartOfBuffer; }
360
John McCallda65ea82010-07-13 20:32:21 +0000361 // Variadic templates would make this not terrible.
362
363 /// Push a lazily-created cleanup on the stack.
John McCall8e3f8612010-07-13 22:12:14 +0000364 template <class T>
John McCall1f0fca52010-07-21 07:22:38 +0000365 void pushCleanup(CleanupKind Kind) {
366 void *Buffer = pushCleanup(Kind, sizeof(T));
367 Cleanup *Obj = new(Buffer) T();
John McCall8e3f8612010-07-13 22:12:14 +0000368 (void) Obj;
369 }
370
371 /// Push a lazily-created cleanup on the stack.
372 template <class T, class A0>
John McCall1f0fca52010-07-21 07:22:38 +0000373 void pushCleanup(CleanupKind Kind, A0 a0) {
374 void *Buffer = pushCleanup(Kind, sizeof(T));
375 Cleanup *Obj = new(Buffer) T(a0);
John McCall8e3f8612010-07-13 22:12:14 +0000376 (void) Obj;
377 }
378
379 /// Push a lazily-created cleanup on the stack.
John McCallda65ea82010-07-13 20:32:21 +0000380 template <class T, class A0, class A1>
John McCall1f0fca52010-07-21 07:22:38 +0000381 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
382 void *Buffer = pushCleanup(Kind, sizeof(T));
383 Cleanup *Obj = new(Buffer) T(a0, a1);
John McCallda65ea82010-07-13 20:32:21 +0000384 (void) Obj;
385 }
386
387 /// Push a lazily-created cleanup on the stack.
388 template <class T, class A0, class A1, class A2>
John McCall1f0fca52010-07-21 07:22:38 +0000389 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
390 void *Buffer = pushCleanup(Kind, sizeof(T));
391 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
John McCallda65ea82010-07-13 20:32:21 +0000392 (void) Obj;
393 }
394
395 /// Push a lazily-created cleanup on the stack.
396 template <class T, class A0, class A1, class A2, class A3>
John McCall1f0fca52010-07-21 07:22:38 +0000397 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
398 void *Buffer = pushCleanup(Kind, sizeof(T));
399 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
John McCallda65ea82010-07-13 20:32:21 +0000400 (void) Obj;
401 }
402
John McCall77199712010-07-21 05:47:49 +0000403 /// Push a lazily-created cleanup on the stack.
404 template <class T, class A0, class A1, class A2, class A3, class A4>
John McCall1f0fca52010-07-21 07:22:38 +0000405 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
406 void *Buffer = pushCleanup(Kind, sizeof(T));
407 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
John McCall77199712010-07-21 05:47:49 +0000408 (void) Obj;
409 }
410
John McCall7d8647f2010-09-14 07:57:04 +0000411 // Feel free to add more variants of the following:
412
413 /// Push a cleanup with non-constant storage requirements on the
414 /// stack. The cleanup type must provide an additional static method:
415 /// static size_t getExtraSize(size_t);
416 /// The argument to this method will be the value N, which will also
417 /// be passed as the first argument to the constructor.
418 ///
419 /// The data stored in the extra storage must obey the same
420 /// restrictions as normal cleanup member data.
421 ///
422 /// The pointer returned from this method is valid until the cleanup
423 /// stack is modified.
424 template <class T, class A0, class A1, class A2>
425 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
426 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
427 return new (Buffer) T(N, a0, a1, a2);
428 }
429
John McCall777d6e52011-08-11 02:22:43 +0000430 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000431 void popCleanup();
432
433 /// Push a set of catch handlers on the stack. The catch is
434 /// uninitialized and will need to have the given number of handlers
435 /// set on it.
436 class EHCatchScope *pushCatch(unsigned NumHandlers);
437
John McCall777d6e52011-08-11 02:22:43 +0000438 /// Pops a catch scope off the stack. This is private to CGException.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000439 void popCatch();
440
441 /// Push an exceptions filter on the stack.
442 class EHFilterScope *pushFilter(unsigned NumFilters);
443
444 /// Pops an exceptions filter off the stack.
445 void popFilter();
446
447 /// Push a terminate handler on the stack.
448 void pushTerminate();
449
450 /// Pops a terminate handler off the stack.
451 void popTerminate();
452
453 /// Determines whether the exception-scopes stack is empty.
454 bool empty() const { return StartOfData == EndOfBuffer; }
455
456 bool requiresLandingPad() const {
John McCall777d6e52011-08-11 02:22:43 +0000457 return InnermostEHScope != stable_end();
John McCallf1549f62010-07-06 01:34:17 +0000458 }
459
460 /// Determines whether there are any normal cleanups on the stack.
461 bool hasNormalCleanups() const {
462 return InnermostNormalCleanup != stable_end();
463 }
464
465 /// Returns the innermost normal cleanup on the stack, or
466 /// stable_end() if there are no normal cleanups.
467 stable_iterator getInnermostNormalCleanup() const {
468 return InnermostNormalCleanup;
469 }
John McCall777d6e52011-08-11 02:22:43 +0000470 stable_iterator getInnermostActiveNormalCleanup() const;
John McCallf1549f62010-07-06 01:34:17 +0000471
John McCall777d6e52011-08-11 02:22:43 +0000472 stable_iterator getInnermostEHScope() const {
473 return InnermostEHScope;
John McCallf1549f62010-07-06 01:34:17 +0000474 }
475
John McCall777d6e52011-08-11 02:22:43 +0000476 stable_iterator getInnermostActiveEHScope() const;
John McCallf1549f62010-07-06 01:34:17 +0000477
478 /// An unstable reference to a scope-stack depth. Invalidated by
479 /// pushes but not pops.
480 class iterator;
481
482 /// Returns an iterator pointing to the innermost EH scope.
483 iterator begin() const;
484
485 /// Returns an iterator pointing to the outermost EH scope.
486 iterator end() const;
487
488 /// Create a stable reference to the top of the EH stack. The
489 /// returned reference is valid until that scope is popped off the
490 /// stack.
491 stable_iterator stable_begin() const {
492 return stable_iterator(EndOfBuffer - StartOfData);
493 }
494
495 /// Create a stable reference to the bottom of the EH stack.
496 static stable_iterator stable_end() {
497 return stable_iterator(0);
498 }
499
500 /// Translates an iterator into a stable_iterator.
501 stable_iterator stabilize(iterator it) const;
502
John McCallf1549f62010-07-06 01:34:17 +0000503 /// Turn a stable reference to a scope depth into a unstable pointer
504 /// to the EH stack.
505 iterator find(stable_iterator save) const;
506
507 /// Removes the cleanup pointed to by the given stable_iterator.
508 void removeCleanup(stable_iterator save);
509
510 /// Add a branch fixup to the current cleanup scope.
511 BranchFixup &addBranchFixup() {
512 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
513 BranchFixups.push_back(BranchFixup());
514 return BranchFixups.back();
515 }
516
517 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
518 BranchFixup &getBranchFixup(unsigned I) {
519 assert(I < getNumBranchFixups());
520 return BranchFixups[I];
521 }
522
John McCallff8e1152010-07-23 21:56:41 +0000523 /// Pops lazily-removed fixups from the end of the list. This
524 /// should only be called by procedures which have just popped a
525 /// cleanup or resolved one or more fixups.
526 void popNullFixups();
527
528 /// Clears the branch-fixups list. This should only be called by
John McCall8abdbd82010-09-18 02:24:39 +0000529 /// ResolveAllBranchFixups.
John McCallff8e1152010-07-23 21:56:41 +0000530 void clearFixups() { BranchFixups.clear(); }
John McCallf1549f62010-07-06 01:34:17 +0000531};
532
Reid Spencer5f016e22007-07-11 17:01:13 +0000533/// CodeGenFunction - This class organizes the per-function state that is used
534/// while generating LLVM code.
John McCall5936e332011-02-15 09:22:45 +0000535class CodeGenFunction : public CodeGenTypeCache {
Anders Carlsson8a219ce2009-02-24 04:21:31 +0000536 CodeGenFunction(const CodeGenFunction&); // DO NOT IMPLEMENT
537 void operator=(const CodeGenFunction&); // DO NOT IMPLEMENT
John McCall4c40d982010-08-31 07:33:07 +0000538
539 friend class CGCXXABI;
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000540public:
John McCallff8e1152010-07-23 21:56:41 +0000541 /// A jump destination is an abstract label, branching to which may
542 /// require a jump out through normal cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000543 struct JumpDest {
John McCallff8e1152010-07-23 21:56:41 +0000544 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
545 JumpDest(llvm::BasicBlock *Block,
546 EHScopeStack::stable_iterator Depth,
547 unsigned Index)
548 : Block(Block), ScopeDepth(Depth), Index(Index) {}
549
550 bool isValid() const { return Block != 0; }
551 llvm::BasicBlock *getBlock() const { return Block; }
552 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
553 unsigned getDestIndex() const { return Index; }
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000554
John McCallff8e1152010-07-23 21:56:41 +0000555 private:
John McCallf1549f62010-07-06 01:34:17 +0000556 llvm::BasicBlock *Block;
557 EHScopeStack::stable_iterator ScopeDepth;
John McCallff8e1152010-07-23 21:56:41 +0000558 unsigned Index;
559 };
560
Reid Spencer5f016e22007-07-11 17:01:13 +0000561 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar444be732009-11-13 05:51:54 +0000562 const TargetInfo &Target;
Mike Stump0dd9e882009-02-08 23:14:22 +0000563
Chris Lattner58dee102007-08-21 16:57:55 +0000564 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000565 CGBuilderTy Builder;
Mike Stump0dd9e882009-02-08 23:14:22 +0000566
Chris Lattnerb5437d22009-04-23 05:30:27 +0000567 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
568 /// This excludes BlockDecls.
Chris Lattner41110242008-06-17 18:05:57 +0000569 const Decl *CurFuncDecl;
Chris Lattnerb5437d22009-04-23 05:30:27 +0000570 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
571 const Decl *CurCodeDecl;
Daniel Dunbar88b53962009-02-02 22:03:45 +0000572 const CGFunctionInfo *CurFnInfo;
Chris Lattner391d77a2008-03-30 23:03:07 +0000573 QualType FnRetTy;
Reid Spencer5f016e22007-07-11 17:01:13 +0000574 llvm::Function *CurFn;
575
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000576 /// CurGD - The GlobalDecl for the current function being compiled.
577 GlobalDecl CurGD;
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000578
John McCallf85e1932011-06-15 23:02:42 +0000579 /// PrologueCleanupDepth - The cleanup depth enclosing all the
580 /// cleanups associated with the parameters.
581 EHScopeStack::stable_iterator PrologueCleanupDepth;
582
Daniel Dunbar5ca20842008-09-09 21:00:17 +0000583 /// ReturnBlock - Unified return block.
John McCallf1549f62010-07-06 01:34:17 +0000584 JumpDest ReturnBlock;
585
Mike Stump0dd9e882009-02-08 23:14:22 +0000586 /// ReturnValue - The temporary alloca to hold the return value. This is null
587 /// iff the function has no return value.
Eli Friedmanb17daf92009-12-04 02:43:40 +0000588 llvm::Value *ReturnValue;
Mike Stump0dd9e882009-02-08 23:14:22 +0000589
Reid Spencer5f016e22007-07-11 17:01:13 +0000590 /// AllocaInsertPoint - This is an instruction in the entry block before which
591 /// we prefer to insert allocas.
Chris Lattner481769b2009-03-31 22:17:44 +0000592 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000593
Mike Stump9c276ae2009-12-12 01:27:46 +0000594 bool CatchUndefined;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000595
John McCallf85e1932011-06-15 23:02:42 +0000596 /// In ARC, whether we should autorelease the return value.
597 bool AutoreleaseResult;
598
John McCalld16c2cf2011-02-08 08:22:06 +0000599 const CodeGen::CGBlockInfo *BlockInfo;
600 llvm::Value *BlockPointer;
601
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000602 /// \brief A mapping from NRVO variables to the flags used to indicate
603 /// when the NRVO has been applied to this variable.
604 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000605
John McCallf1549f62010-07-06 01:34:17 +0000606 EHScopeStack EHStack;
607
John McCallff8e1152010-07-23 21:56:41 +0000608 /// i32s containing the indexes of the cleanup destinations.
609 llvm::AllocaInst *NormalCleanupDest;
John McCallff8e1152010-07-23 21:56:41 +0000610
611 unsigned NextCleanupDestIndex;
612
John McCall1a343eb2011-11-10 08:15:53 +0000613 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
614 CGBlockInfo *FirstBlockInfo;
615
John McCall777d6e52011-08-11 02:22:43 +0000616 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
617 llvm::BasicBlock *EHResumeBlock;
618
Bill Wendling285cfd82011-09-19 20:31:14 +0000619 /// The exception slot. All landing pads write the current exception pointer
620 /// into this alloca.
John McCallf1549f62010-07-06 01:34:17 +0000621 llvm::Value *ExceptionSlot;
622
Bill Wendling285cfd82011-09-19 20:31:14 +0000623 /// The selector slot. Under the MandatoryCleanup model, all landing pads
624 /// write the current selector value into this alloca.
John McCall93c332a2011-05-28 21:13:02 +0000625 llvm::AllocaInst *EHSelectorSlot;
626
John McCallf1549f62010-07-06 01:34:17 +0000627 /// Emits a landing pad for the current EH stack.
628 llvm::BasicBlock *EmitLandingPad();
629
630 llvm::BasicBlock *getInvokeDestImpl();
631
John McCall150b4622011-01-26 04:00:11 +0000632 template <class T>
John McCall804b8072011-01-28 10:53:53 +0000633 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
634 return DominatingValue<T>::save(*this, value);
John McCall150b4622011-01-26 04:00:11 +0000635 }
636
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000637public:
Anders Carlssonfa1f7562009-02-10 06:07:49 +0000638 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
639 /// rethrows.
Chris Lattner686775d2011-07-20 06:58:45 +0000640 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stump0dd9e882009-02-08 23:14:22 +0000641
John McCalld768e9d2011-06-22 02:32:12 +0000642 /// A class controlling the emission of a finally block.
643 class FinallyInfo {
644 /// Where the catchall's edge through the cleanup should go.
645 JumpDest RethrowDest;
Anders Carlssonbb66f9f2009-02-08 07:46:24 +0000646
John McCalld768e9d2011-06-22 02:32:12 +0000647 /// A function to call to enter the catch.
648 llvm::Constant *BeginCatchFn;
649
650 /// An i1 variable indicating whether or not the @finally is
651 /// running for an exception.
652 llvm::AllocaInst *ForEHVar;
653
654 /// An i8* variable into which the exception pointer to rethrow
655 /// has been saved.
656 llvm::AllocaInst *SavedExnVar;
657
658 public:
659 void enter(CodeGenFunction &CGF, const Stmt *Finally,
660 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
661 llvm::Constant *rethrowFn);
662 void exit(CodeGenFunction &CGF);
663 };
Mike Stumpd88ea562009-12-09 03:35:49 +0000664
John McCall150b4622011-01-26 04:00:11 +0000665 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
666 /// current full-expression. Safe against the possibility that
667 /// we're currently inside a conditionally-evaluated expression.
John McCall3ad32c82011-01-28 08:37:24 +0000668 template <class T, class A0>
669 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
670 // If we're not in a conditional branch, or if none of the
671 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000672 if (!isInConditionalBranch())
673 return EHStack.pushCleanup<T>(kind, a0);
John McCall3ad32c82011-01-28 08:37:24 +0000674
John McCall804b8072011-01-28 10:53:53 +0000675 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCall3ad32c82011-01-28 08:37:24 +0000676
677 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
678 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
679 initFullExprCleanup();
680 }
681
682 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
683 /// current full-expression. Safe against the possibility that
684 /// we're currently inside a conditionally-evaluated expression.
John McCall150b4622011-01-26 04:00:11 +0000685 template <class T, class A0, class A1>
686 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
687 // If we're not in a conditional branch, or if none of the
688 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000689 if (!isInConditionalBranch())
690 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCall150b4622011-01-26 04:00:11 +0000691
John McCall804b8072011-01-28 10:53:53 +0000692 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
693 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCall150b4622011-01-26 04:00:11 +0000694
695 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCall3ad32c82011-01-28 08:37:24 +0000696 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
697 initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000698 }
699
Douglas Gregord7b23162011-06-22 16:12:01 +0000700 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
701 /// current full-expression. Safe against the possibility that
702 /// we're currently inside a conditionally-evaluated expression.
703 template <class T, class A0, class A1, class A2>
704 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
705 // If we're not in a conditional branch, or if none of the
706 // arguments requires saving, then use the unconditional cleanup.
707 if (!isInConditionalBranch()) {
John McCallc4a1a842011-07-12 00:15:30 +0000708 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregord7b23162011-06-22 16:12:01 +0000709 }
710
711 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
712 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
713 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
714
715 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
716 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
717 initFullExprCleanup();
718 }
719
John McCall9928c482011-07-12 16:41:08 +0000720 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
721 /// current full-expression. Safe against the possibility that
722 /// we're currently inside a conditionally-evaluated expression.
723 template <class T, class A0, class A1, class A2, class A3>
724 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
725 // If we're not in a conditional branch, or if none of the
726 // arguments requires saving, then use the unconditional cleanup.
727 if (!isInConditionalBranch()) {
728 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
729 }
730
731 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
732 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
733 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
734 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
735
736 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
737 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
738 a2_saved, a3_saved);
739 initFullExprCleanup();
740 }
741
John McCall6f103ba2011-11-10 10:43:54 +0000742 /// Set up the last cleaup that was pushed as a conditional
743 /// full-expression cleanup.
744 void initFullExprCleanup();
745
John McCallf1549f62010-07-06 01:34:17 +0000746 /// PushDestructorCleanup - Push a cleanup to call the
747 /// complete-object destructor of an object of the given type at the
748 /// given address. Does nothing if T is not a C++ class type with a
749 /// non-trivial destructor.
750 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
751
John McCall81407d42010-07-21 06:29:51 +0000752 /// PushDestructorCleanup - Push a cleanup to call the
753 /// complete-object variant of the given destructor on the object at
754 /// the given address.
755 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
756 llvm::Value *Addr);
757
John McCallf1549f62010-07-06 01:34:17 +0000758 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
759 /// process all branch fixups.
John McCallff8e1152010-07-23 21:56:41 +0000760 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallf1549f62010-07-06 01:34:17 +0000761
John McCall7d8647f2010-09-14 07:57:04 +0000762 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
763 /// The block cannot be reactivated. Pops it if it's the top of the
764 /// stack.
John McCall6f103ba2011-11-10 10:43:54 +0000765 ///
766 /// \param DominatingIP - An instruction which is known to
767 /// dominate the current IP (if set) and which lies along
768 /// all paths of execution between the current IP and the
769 /// the point at which the cleanup comes into scope.
770 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
771 llvm::Instruction *DominatingIP);
John McCall7d8647f2010-09-14 07:57:04 +0000772
773 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
774 /// Cannot be used to resurrect a deactivated cleanup.
John McCall6f103ba2011-11-10 10:43:54 +0000775 ///
776 /// \param DominatingIP - An instruction which is known to
777 /// dominate the current IP (if set) and which lies along
778 /// all paths of execution between the current IP and the
779 /// the point at which the cleanup comes into scope.
780 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
781 llvm::Instruction *DominatingIP);
John McCallcd2d2b72010-08-13 21:20:51 +0000782
John McCallf1549f62010-07-06 01:34:17 +0000783 /// \brief Enters a new scope for capturing cleanups, all of which
784 /// will be executed once the scope is exited.
785 class RunCleanupsScope {
John McCallf1549f62010-07-06 01:34:17 +0000786 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000787 bool OldDidCallStackSave;
Douglas Gregor5656e142009-11-24 21:15:44 +0000788 bool PerformCleanup;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000789
John McCallf1549f62010-07-06 01:34:17 +0000790 RunCleanupsScope(const RunCleanupsScope &); // DO NOT IMPLEMENT
791 RunCleanupsScope &operator=(const RunCleanupsScope &); // DO NOT IMPLEMENT
Douglas Gregor01234bb2009-11-24 16:43:22 +0000792
Eric Christopherc3287792011-10-19 00:43:52 +0000793 protected:
794 CodeGenFunction& CGF;
795
Douglas Gregor01234bb2009-11-24 16:43:22 +0000796 public:
797 /// \brief Enter a new cleanup scope.
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000798 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christopherc3287792011-10-19 00:43:52 +0000799 : PerformCleanup(true), CGF(CGF)
Douglas Gregor5656e142009-11-24 21:15:44 +0000800 {
John McCallf1549f62010-07-06 01:34:17 +0000801 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor01234bb2009-11-24 16:43:22 +0000802 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis4ada2ca2010-09-14 00:42:34 +0000803 CGF.DidCallStackSave = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000804 }
805
806 /// \brief Exit this cleanup scope, emitting any accumulated
807 /// cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000808 ~RunCleanupsScope() {
Douglas Gregor5656e142009-11-24 21:15:44 +0000809 if (PerformCleanup) {
810 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000811 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000812 }
813 }
814
815 /// \brief Determine whether this scope requires any cleanups.
816 bool requiresCleanups() const {
John McCallf1549f62010-07-06 01:34:17 +0000817 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor5656e142009-11-24 21:15:44 +0000818 }
819
820 /// \brief Force the emission of cleanups now, instead of waiting
821 /// until this object is destroyed.
822 void ForceCleanup() {
823 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor01234bb2009-11-24 16:43:22 +0000824 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000825 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000826 PerformCleanup = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000827 }
828 };
829
Eric Christopherc3287792011-10-19 00:43:52 +0000830 class LexicalScope: protected RunCleanupsScope {
831 SourceRange Range;
832 bool PopDebugStack;
833
834 LexicalScope(const LexicalScope &); // DO NOT IMPLEMENT THESE
835 LexicalScope &operator=(const LexicalScope &);
836
837 public:
838 /// \brief Enter a new cleanup scope.
839 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
840 : RunCleanupsScope(CGF), Range(Range), PopDebugStack(true) {
841 if (CGDebugInfo *DI = CGF.getDebugInfo())
842 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
843 }
844
845 /// \brief Exit this cleanup scope, emitting any accumulated
846 /// cleanups.
847 ~LexicalScope() {
848 if (PopDebugStack) {
849 CGDebugInfo *DI = CGF.getDebugInfo();
850 if (DI) DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
851 }
852 }
853
854 /// \brief Force the emission of cleanups now, instead of waiting
855 /// until this object is destroyed.
856 void ForceCleanup() {
857 RunCleanupsScope::ForceCleanup();
858 if (CGDebugInfo *DI = CGF.getDebugInfo()) {
859 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
860 PopDebugStack = false;
861 }
862 }
863 };
864
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000865
John McCallf1549f62010-07-06 01:34:17 +0000866 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
867 /// the cleanup blocks that have been added.
868 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000869
John McCallff8e1152010-07-23 21:56:41 +0000870 void ResolveBranchFixups(llvm::BasicBlock *Target);
871
John McCallf1549f62010-07-06 01:34:17 +0000872 /// The given basic block lies in the current EH scope, but may be a
873 /// target of a potentially scope-crossing jump; get a stable handle
874 /// to which we can perform this jump later.
John McCallff8e1152010-07-23 21:56:41 +0000875 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCall413e6772010-07-28 01:07:35 +0000876 return JumpDest(Target,
877 EHStack.getInnermostNormalCleanup(),
878 NextCleanupDestIndex++);
John McCallf1549f62010-07-06 01:34:17 +0000879 }
Anders Carlssonc71c8452009-02-07 23:50:39 +0000880
John McCallf1549f62010-07-06 01:34:17 +0000881 /// The given basic block lies in the current EH scope, but may be a
882 /// target of a potentially scope-crossing jump; get a stable handle
883 /// to which we can perform this jump later.
Chris Lattner686775d2011-07-20 06:58:45 +0000884 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallff8e1152010-07-23 21:56:41 +0000885 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallf1549f62010-07-06 01:34:17 +0000886 }
887
888 /// EmitBranchThroughCleanup - Emit a branch from the current insert
889 /// block through the normal cleanup handling code (if any) and then
890 /// on to \arg Dest.
891 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerb11f9192011-04-17 00:54:30 +0000892
893 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
894 /// specified destination obviously has no cleanups to run. 'false' is always
895 /// a conservatively correct answer for this method.
896 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallf1549f62010-07-06 01:34:17 +0000897
John McCall777d6e52011-08-11 02:22:43 +0000898 /// popCatchScope - Pops the catch scope at the top of the EHScope
899 /// stack, emitting any required code (other than the catch handlers
900 /// themselves).
901 void popCatchScope();
John McCallff8e1152010-07-23 21:56:41 +0000902
John McCall777d6e52011-08-11 02:22:43 +0000903 llvm::BasicBlock *getEHResumeBlock();
904 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stump0dd9e882009-02-08 23:14:22 +0000905
John McCall150b4622011-01-26 04:00:11 +0000906 /// An object to manage conditionally-evaluated expressions.
907 class ConditionalEvaluation {
908 llvm::BasicBlock *StartBB;
Mike Stump1eb44332009-09-09 15:08:12 +0000909
John McCall150b4622011-01-26 04:00:11 +0000910 public:
911 ConditionalEvaluation(CodeGenFunction &CGF)
912 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000913
John McCall150b4622011-01-26 04:00:11 +0000914 void begin(CodeGenFunction &CGF) {
915 assert(CGF.OutermostConditional != this);
916 if (!CGF.OutermostConditional)
917 CGF.OutermostConditional = this;
918 }
919
920 void end(CodeGenFunction &CGF) {
921 assert(CGF.OutermostConditional != 0);
922 if (CGF.OutermostConditional == this)
923 CGF.OutermostConditional = 0;
924 }
925
926 /// Returns a block which will be executed prior to each
927 /// evaluation of the conditional code.
928 llvm::BasicBlock *getStartingBlock() const {
929 return StartBB;
930 }
931 };
Mike Stump1eb44332009-09-09 15:08:12 +0000932
John McCall3019c442010-09-17 00:50:28 +0000933 /// isInConditionalBranch - Return true if we're currently emitting
934 /// one branch or the other of a conditional expression.
John McCall150b4622011-01-26 04:00:11 +0000935 bool isInConditionalBranch() const { return OutermostConditional != 0; }
936
John McCall6f103ba2011-11-10 10:43:54 +0000937 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
938 assert(isInConditionalBranch());
939 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
940 new llvm::StoreInst(value, addr, &block->back());
941 }
942
John McCall150b4622011-01-26 04:00:11 +0000943 /// An RAII object to record that we're evaluating a statement
944 /// expression.
945 class StmtExprEvaluation {
946 CodeGenFunction &CGF;
947
948 /// We have to save the outermost conditional: cleanups in a
949 /// statement expression aren't conditional just because the
950 /// StmtExpr is.
951 ConditionalEvaluation *SavedOutermostConditional;
952
953 public:
954 StmtExprEvaluation(CodeGenFunction &CGF)
955 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
956 CGF.OutermostConditional = 0;
957 }
958
959 ~StmtExprEvaluation() {
960 CGF.OutermostConditional = SavedOutermostConditional;
961 CGF.EnsureInsertPoint();
962 }
963 };
John McCalle996ffd2011-02-16 08:02:54 +0000964
John McCall56ca35d2011-02-17 10:25:35 +0000965 /// An object which temporarily prevents a value from being
966 /// destroyed by aggressive peephole optimizations that assume that
967 /// all uses of a value have been realized in the IR.
968 class PeepholeProtection {
969 llvm::Instruction *Inst;
970 friend class CodeGenFunction;
971
972 public:
973 PeepholeProtection() : Inst(0) {}
John McCall4b9c2d22011-11-06 09:01:30 +0000974 };
John McCall56ca35d2011-02-17 10:25:35 +0000975
John McCall4b9c2d22011-11-06 09:01:30 +0000976 /// A non-RAII class containing all the information about a bound
977 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
978 /// this which makes individual mappings very simple; using this
979 /// class directly is useful when you have a variable number of
980 /// opaque values or don't want the RAII functionality for some
981 /// reason.
982 class OpaqueValueMappingData {
John McCalle996ffd2011-02-16 08:02:54 +0000983 const OpaqueValueExpr *OpaqueValue;
John McCall56ca35d2011-02-17 10:25:35 +0000984 bool BoundLValue;
985 CodeGenFunction::PeepholeProtection Protection;
John McCalle996ffd2011-02-16 08:02:54 +0000986
John McCall4b9c2d22011-11-06 09:01:30 +0000987 OpaqueValueMappingData(const OpaqueValueExpr *ov,
988 bool boundLValue)
989 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCalle996ffd2011-02-16 08:02:54 +0000990 public:
John McCall4b9c2d22011-11-06 09:01:30 +0000991 OpaqueValueMappingData() : OpaqueValue(0) {}
992
John McCall56ca35d2011-02-17 10:25:35 +0000993 static bool shouldBindAsLValue(const Expr *expr) {
John McCalla5493f82011-11-08 22:54:08 +0000994 // gl-values should be bound as l-values for obvious reasons.
995 // Records should be bound as l-values because IR generation
996 // always keeps them in memory. Expressions of function type
997 // act exactly like l-values but are formally required to be
998 // r-values in C.
999 return expr->isGLValue() ||
1000 expr->getType()->isRecordType() ||
1001 expr->getType()->isFunctionType();
John McCall56ca35d2011-02-17 10:25:35 +00001002 }
1003
John McCall4b9c2d22011-11-06 09:01:30 +00001004 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1005 const OpaqueValueExpr *ov,
1006 const Expr *e) {
1007 if (shouldBindAsLValue(ov))
1008 return bind(CGF, ov, CGF.EmitLValue(e));
1009 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1010 }
1011
1012 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1013 const OpaqueValueExpr *ov,
1014 const LValue &lv) {
1015 assert(shouldBindAsLValue(ov));
1016 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1017 return OpaqueValueMappingData(ov, true);
1018 }
1019
1020 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1021 const OpaqueValueExpr *ov,
1022 const RValue &rv) {
1023 assert(!shouldBindAsLValue(ov));
1024 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1025
1026 OpaqueValueMappingData data(ov, false);
1027
1028 // Work around an extremely aggressive peephole optimization in
1029 // EmitScalarConversion which assumes that all other uses of a
1030 // value are extant.
1031 data.Protection = CGF.protectFromPeepholes(rv);
1032
1033 return data;
1034 }
1035
1036 bool isValid() const { return OpaqueValue != 0; }
1037 void clear() { OpaqueValue = 0; }
1038
1039 void unbind(CodeGenFunction &CGF) {
1040 assert(OpaqueValue && "no data to unbind!");
1041
1042 if (BoundLValue) {
1043 CGF.OpaqueLValues.erase(OpaqueValue);
1044 } else {
1045 CGF.OpaqueRValues.erase(OpaqueValue);
1046 CGF.unprotectFromPeepholes(Protection);
1047 }
1048 }
1049 };
1050
1051 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1052 class OpaqueValueMapping {
1053 CodeGenFunction &CGF;
1054 OpaqueValueMappingData Data;
1055
1056 public:
1057 static bool shouldBindAsLValue(const Expr *expr) {
1058 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1059 }
1060
John McCall56ca35d2011-02-17 10:25:35 +00001061 /// Build the opaque value mapping for the given conditional
1062 /// operator if it's the GNU ?: extension. This is a common
1063 /// enough pattern that the convenience operator is really
1064 /// helpful.
1065 ///
1066 OpaqueValueMapping(CodeGenFunction &CGF,
1067 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCall4b9c2d22011-11-06 09:01:30 +00001068 if (isa<ConditionalOperator>(op))
1069 // Leave Data empty.
John McCall56ca35d2011-02-17 10:25:35 +00001070 return;
John McCall56ca35d2011-02-17 10:25:35 +00001071
1072 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCall4b9c2d22011-11-06 09:01:30 +00001073 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1074 e->getCommon());
John McCall56ca35d2011-02-17 10:25:35 +00001075 }
1076
John McCalle996ffd2011-02-16 08:02:54 +00001077 OpaqueValueMapping(CodeGenFunction &CGF,
1078 const OpaqueValueExpr *opaqueValue,
John McCall56ca35d2011-02-17 10:25:35 +00001079 LValue lvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001080 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCall56ca35d2011-02-17 10:25:35 +00001081 }
1082
1083 OpaqueValueMapping(CodeGenFunction &CGF,
1084 const OpaqueValueExpr *opaqueValue,
1085 RValue rvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001086 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCalle996ffd2011-02-16 08:02:54 +00001087 }
1088
1089 void pop() {
John McCall4b9c2d22011-11-06 09:01:30 +00001090 Data.unbind(CGF);
1091 Data.clear();
John McCalle996ffd2011-02-16 08:02:54 +00001092 }
1093
1094 ~OpaqueValueMapping() {
John McCall4b9c2d22011-11-06 09:01:30 +00001095 if (Data.isValid()) Data.unbind(CGF);
John McCalle996ffd2011-02-16 08:02:54 +00001096 }
1097 };
Fariborz Jahaniane2204552010-11-16 19:29:39 +00001098
1099 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1100 /// number that holds the value.
1101 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian52a80e12011-01-26 23:08:27 +00001102
1103 /// BuildBlockByrefAddress - Computes address location of the
1104 /// variable which is declared as __block.
1105 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1106 const VarDecl *V);
Chris Lattner7f02f722007-08-24 05:35:26 +00001107private:
Chris Lattnerd9becd12009-10-28 23:59:40 +00001108 CGDebugInfo *DebugInfo;
Devang Patelaa112892011-03-07 18:45:56 +00001109 bool DisableDebugInfo;
Mike Stump09429b92009-02-17 17:00:02 +00001110
John McCall93c332a2011-05-28 21:13:02 +00001111 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1112 /// calling llvm.stacksave for multiple VLAs in the same scope.
1113 bool DidCallStackSave;
1114
Mike Stumpf71d2322009-11-30 20:08:49 +00001115 /// IndirectBranch - The first time an indirect goto is seen we create a block
1116 /// with an indirect branch. Every time we see the address of a label taken,
1117 /// we add the label to the indirect goto. Every subsequent indirect goto is
1118 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattnerd9becd12009-10-28 23:59:40 +00001119 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001120
Mike Stump0dd9e882009-02-08 23:14:22 +00001121 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1122 /// decls.
John McCall6b5a61b2011-02-07 10:33:21 +00001123 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1124 DeclMapTy LocalDeclMap;
Reid Spencer5f016e22007-07-11 17:01:13 +00001125
1126 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001127 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001128
Mike Stump0dd9e882009-02-08 23:14:22 +00001129 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone4b6d342009-02-10 05:52:02 +00001130 // statements should jump to.
Chris Lattnerda138702007-07-16 21:28:45 +00001131 struct BreakContinue {
John McCallf1549f62010-07-06 01:34:17 +00001132 BreakContinue(JumpDest Break, JumpDest Continue)
1133 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stump0dd9e882009-02-08 23:14:22 +00001134
John McCallf1549f62010-07-06 01:34:17 +00001135 JumpDest BreakBlock;
1136 JumpDest ContinueBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001137 };
Chris Lattner686775d2011-07-20 06:58:45 +00001138 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +00001139
Mike Stump0dd9e882009-02-08 23:14:22 +00001140 /// SwitchInsn - This is nearest current switch instruction. It is null if if
1141 /// current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +00001142 llvm::SwitchInst *SwitchInsn;
1143
Mike Stump0dd9e882009-02-08 23:14:22 +00001144 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel80fd5f92007-10-09 17:08:50 +00001145 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +00001146 llvm::BasicBlock *CaseRangeBlock;
1147
John McCall56ca35d2011-02-17 10:25:35 +00001148 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCalle996ffd2011-02-16 08:02:54 +00001149 /// expressions.
John McCall56ca35d2011-02-17 10:25:35 +00001150 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1151 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCalle996ffd2011-02-16 08:02:54 +00001152
Mike Stump0dd9e882009-02-08 23:14:22 +00001153 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001154 // We track this by the size expression rather than the type itself because
1155 // in certain situations, like a const qualifier applied to an VLA typedef,
1156 // multiple VLA types can share the same size expression.
Mike Stump0dd9e882009-02-08 23:14:22 +00001157 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1158 // enter/leave scopes.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001159 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001160
John McCallf1549f62010-07-06 01:34:17 +00001161 /// A block containing a single 'unreachable' instruction. Created
1162 /// lazily by getUnreachableBlock().
1163 llvm::BasicBlock *UnreachableBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001164
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001165 /// CXXThisDecl - When generating code for a C++ member function,
1166 /// this will hold the implicit 'this' declaration.
Anders Carlsson2b77ba82009-04-04 20:47:02 +00001167 ImplicitParamDecl *CXXThisDecl;
John McCall25049412010-02-16 22:04:33 +00001168 llvm::Value *CXXThisValue;
Mike Stump1eb44332009-09-09 15:08:12 +00001169
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001170 /// CXXVTTDecl - When generating code for a base object constructor or
1171 /// base object destructor with virtual bases, this will hold the implicit
1172 /// VTT parameter.
1173 ImplicitParamDecl *CXXVTTDecl;
John McCall25049412010-02-16 22:04:33 +00001174 llvm::Value *CXXVTTValue;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001175
John McCall150b4622011-01-26 04:00:11 +00001176 /// OutermostConditional - Points to the outermost active
1177 /// conditional control. This is used so that we know if a
1178 /// temporary should be destroyed conditionally.
1179 ConditionalEvaluation *OutermostConditional;
Mike Stump1eb44332009-09-09 15:08:12 +00001180
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001181
1182 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1183 /// type as well as the field number that contains the actual data.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001184 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001185 unsigned> > ByRefValueInfo;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001186
John McCallf1549f62010-07-06 01:34:17 +00001187 llvm::BasicBlock *TerminateLandingPad;
Mike Stump182f3832009-12-10 00:02:42 +00001188 llvm::BasicBlock *TerminateHandler;
Chris Lattner83252dc2010-07-20 21:07:09 +00001189 llvm::BasicBlock *TrapBB;
Eli Friedman94067052009-12-10 02:21:21 +00001190
Reid Spencer5f016e22007-07-11 17:01:13 +00001191public:
1192 CodeGenFunction(CodeGenModule &cgm);
John McCall1a343eb2011-11-10 08:15:53 +00001193 ~CodeGenFunction();
Mike Stump0dd9e882009-02-08 23:14:22 +00001194
John McCall1e7fe752010-09-02 09:58:18 +00001195 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCallf2aac842011-05-15 02:34:36 +00001196 ASTContext &getContext() const { return CGM.getContext(); }
Devang Patelaa112892011-03-07 18:45:56 +00001197 CGDebugInfo *getDebugInfo() {
1198 if (DisableDebugInfo)
1199 return NULL;
1200 return DebugInfo;
1201 }
1202 void disableDebugInfo() { DisableDebugInfo = true; }
1203 void enableDebugInfo() { DisableDebugInfo = false; }
1204
John McCallf85e1932011-06-15 23:02:42 +00001205 bool shouldUseFusedARCCalls() {
1206 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1207 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001208
John McCalld16c2cf2011-02-08 08:22:06 +00001209 const LangOptions &getLangOptions() const { return CGM.getLangOptions(); }
1210
Bill Wendling285cfd82011-09-19 20:31:14 +00001211 /// Returns a pointer to the function's exception object and selector slot,
1212 /// which is assigned in every landing pad.
John McCallf1549f62010-07-06 01:34:17 +00001213 llvm::Value *getExceptionSlot();
John McCall93c332a2011-05-28 21:13:02 +00001214 llvm::Value *getEHSelectorSlot();
John McCallf1549f62010-07-06 01:34:17 +00001215
Bill Wendlingae270592011-09-15 18:57:19 +00001216 /// Returns the contents of the function's exception object and selector
1217 /// slots.
1218 llvm::Value *getExceptionFromSlot();
1219 llvm::Value *getSelectorFromSlot();
1220
John McCallff8e1152010-07-23 21:56:41 +00001221 llvm::Value *getNormalCleanupDestSlot();
John McCallff8e1152010-07-23 21:56:41 +00001222
John McCallf1549f62010-07-06 01:34:17 +00001223 llvm::BasicBlock *getUnreachableBlock() {
1224 if (!UnreachableBlock) {
1225 UnreachableBlock = createBasicBlock("unreachable");
1226 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1227 }
1228 return UnreachableBlock;
1229 }
1230
1231 llvm::BasicBlock *getInvokeDest() {
1232 if (!EHStack.requiresLandingPad()) return 0;
1233 return getInvokeDestImpl();
1234 }
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001235
John McCalld16c2cf2011-02-08 08:22:06 +00001236 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Anderson69243822009-07-13 04:10:07 +00001237
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001238 //===--------------------------------------------------------------------===//
John McCallbdc4d802011-07-09 01:37:26 +00001239 // Cleanups
1240 //===--------------------------------------------------------------------===//
1241
1242 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1243
John McCall2673c682011-07-11 08:38:19 +00001244 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1245 llvm::Value *arrayEndPointer,
1246 QualType elementType,
1247 Destroyer &destroyer);
1248 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1249 llvm::Value *arrayEnd,
1250 QualType elementType,
1251 Destroyer &destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001252
John McCall9928c482011-07-12 16:41:08 +00001253 void pushDestroy(QualType::DestructionKind dtorKind,
1254 llvm::Value *addr, QualType type);
John McCallbdc4d802011-07-09 01:37:26 +00001255 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
John McCall2673c682011-07-11 08:38:19 +00001256 Destroyer &destroyer, bool useEHCleanupForArray);
1257 void emitDestroy(llvm::Value *addr, QualType type, Destroyer &destroyer,
1258 bool useEHCleanupForArray);
John McCalla91f6662011-07-13 03:01:35 +00001259 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1260 QualType type,
1261 Destroyer &destroyer,
1262 bool useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001263 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
John McCall2673c682011-07-11 08:38:19 +00001264 QualType type, Destroyer &destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001265 bool checkZeroLength, bool useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001266
John McCall9928c482011-07-12 16:41:08 +00001267 Destroyer &getDestroyer(QualType::DestructionKind destructionKind);
1268
John McCallbdc4d802011-07-09 01:37:26 +00001269 /// Determines whether an EH cleanup is required to destroy a type
1270 /// with the given destruction kind.
1271 bool needsEHCleanup(QualType::DestructionKind kind) {
1272 switch (kind) {
1273 case QualType::DK_none:
1274 return false;
1275 case QualType::DK_cxx_destructor:
1276 case QualType::DK_objc_weak_lifetime:
1277 return getLangOptions().Exceptions;
1278 case QualType::DK_objc_strong_lifetime:
1279 return getLangOptions().Exceptions &&
1280 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1281 }
1282 llvm_unreachable("bad destruction kind");
1283 }
1284
John McCall9928c482011-07-12 16:41:08 +00001285 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1286 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1287 }
1288
John McCallbdc4d802011-07-09 01:37:26 +00001289 //===--------------------------------------------------------------------===//
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001290 // Objective-C
1291 //===--------------------------------------------------------------------===//
1292
Chris Lattner391d77a2008-03-30 23:03:07 +00001293 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001294
Mike Stump0dd9e882009-02-08 23:14:22 +00001295 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patel8d3f8972011-05-19 23:37:41 +00001296 const ObjCContainerDecl *CD,
1297 SourceLocation StartLoc);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001298
Mike Stump0dd9e882009-02-08 23:14:22 +00001299 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001300 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1301 const ObjCPropertyImplDecl *PID);
John McCall1e1f4872011-09-13 03:34:09 +00001302 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
1303 const ObjCPropertyImplDecl *propImpl);
Fariborz Jahanian2846b972011-02-18 19:15:13 +00001304
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001305 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1306 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001307
Mike Stump0dd9e882009-02-08 23:14:22 +00001308 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1309 /// for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001310 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1311 const ObjCPropertyImplDecl *PID);
John McCall71c758d2011-09-10 09:17:20 +00001312 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1313 const ObjCPropertyImplDecl *propImpl);
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001314 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001315 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001316
Mike Stump4e7a1f72009-02-21 20:00:35 +00001317 //===--------------------------------------------------------------------===//
1318 // Block Bits
1319 //===--------------------------------------------------------------------===//
1320
John McCall6b5a61b2011-02-07 10:33:21 +00001321 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall1a343eb2011-11-10 08:15:53 +00001322 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1323 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garst2a7eb282010-02-23 21:51:17 +00001324 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00001325 const CGBlockInfo &Info,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001326 llvm::StructType *,
John McCalld16c2cf2011-02-08 08:22:06 +00001327 llvm::Constant *BlockVarLayout);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001328
Fariborz Jahanian564360b2010-06-24 00:08:06 +00001329 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall6b5a61b2011-02-07 10:33:21 +00001330 const CGBlockInfo &Info,
Mike Stump6cc88f72009-03-20 21:53:12 +00001331 const Decl *OuterFuncDecl,
John McCall6b5a61b2011-02-07 10:33:21 +00001332 const DeclMapTy &ldm);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001333
John McCalld16c2cf2011-02-08 08:22:06 +00001334 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1335 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
1336
John McCalld16c2cf2011-02-08 08:22:06 +00001337 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1338
John McCall5af02db2011-03-31 01:59:53 +00001339 class AutoVarEmission;
1340
1341 void emitByrefStructureInit(const AutoVarEmission &emission);
1342 void enterByrefCleanup(const AutoVarEmission &emission);
1343
John McCall6b5a61b2011-02-07 10:33:21 +00001344 llvm::Value *LoadBlockStruct() {
1345 assert(BlockPointer && "no block pointer set!");
1346 return BlockPointer;
1347 }
Mike Stump4e7a1f72009-02-21 20:00:35 +00001348
John McCallea1471e2010-05-20 01:18:31 +00001349 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
1350 void AllocateBlockDecl(const BlockDeclRefExpr *E);
John McCallee504292010-05-21 04:11:14 +00001351 llvm::Value *GetAddrOfBlockDecl(const BlockDeclRefExpr *E) {
1352 return GetAddrOfBlockDecl(E->getDecl(), E->isByRef());
1353 }
John McCall6b5a61b2011-02-07 10:33:21 +00001354 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001355 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stumpdab514f2009-03-04 03:23:46 +00001356
John McCalld26bc762011-03-09 04:27:21 +00001357 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1358 const CGFunctionInfo &FnInfo);
Anders Carlsson0ff8baf2009-09-11 00:07:24 +00001359 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbar7c086512008-09-09 23:14:03 +00001360 llvm::Function *Fn,
John McCalld26bc762011-03-09 04:27:21 +00001361 const CGFunctionInfo &FnInfo,
Daniel Dunbar2284ac92008-10-18 18:22:23 +00001362 const FunctionArgList &Args,
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00001363 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001364
John McCall9fc6a772010-02-19 09:25:03 +00001365 void EmitConstructorBody(FunctionArgList &Args);
1366 void EmitDestructorBody(FunctionArgList &Args);
1367 void EmitFunctionBody(FunctionArgList &Args);
John McCalla355e072010-02-18 03:17:58 +00001368
Mike Stump0dd9e882009-02-08 23:14:22 +00001369 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1370 /// emission when possible.
Daniel Dunbar1c1d6072009-01-26 23:27:52 +00001371 void EmitReturnBlock();
1372
Mike Stump0dd9e882009-02-08 23:14:22 +00001373 /// FinishFunction - Complete IR generation of the current function. It is
1374 /// legal to call this function even if there is no current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001375 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001376
Anders Carlsson519c3282010-03-24 00:39:18 +00001377 /// GenerateThunk - Generate a thunk for the given method.
John McCalld26bc762011-03-09 04:27:21 +00001378 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1379 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001380
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00001381 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1382 GlobalDecl GD, const ThunkInfo &Thunk);
1383
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001384 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1385 FunctionArgList &Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001386
Anders Carlssond103f9f2010-03-28 19:40:00 +00001387 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1388 /// subobject.
1389 ///
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001390 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001391 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001392 CharUnits OffsetFromNearestVBase,
Anders Carlssond103f9f2010-03-28 19:40:00 +00001393 llvm::Constant *VTable,
1394 const CXXRecordDecl *VTableClass);
1395
1396 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001397 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001398 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001399 CharUnits OffsetFromNearestVBase,
Anders Carlsson603d6d12010-03-28 21:07:49 +00001400 bool BaseIsNonVirtualPrimaryBase,
1401 llvm::Constant *VTable,
1402 const CXXRecordDecl *VTableClass,
1403 VisitedVirtualBasesSetTy& VBases);
Eli Friedman77a259c2009-12-08 06:46:18 +00001404
Anders Carlsson603d6d12010-03-28 21:07:49 +00001405 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001406
Dan Gohman043fb9a2010-10-26 18:44:08 +00001407 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1408 /// to by This.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001409 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001410
John McCall50da2ca2010-07-21 05:30:47 +00001411 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1412 /// given phase of destruction for a destructor. The end result
1413 /// should call destructors on members and base classes in reverse
1414 /// order of their construction.
1415 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001416
Chris Lattner7255a2d2010-06-22 00:03:40 +00001417 /// ShouldInstrumentFunction - Return true if the current function should be
1418 /// instrumented with __cyg_profile_func_* calls
1419 bool ShouldInstrumentFunction();
1420
1421 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1422 /// instrumentation function with the current function and the call site, if
1423 /// function instrumentation is enabled.
1424 void EmitFunctionInstrumentation(const char *Fn);
1425
Roman Divackybe4c8702011-02-10 16:52:03 +00001426 /// EmitMCountInstrumentation - Emit call to .mcount.
1427 void EmitMCountInstrumentation();
1428
Mike Stump0dd9e882009-02-08 23:14:22 +00001429 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1430 /// arguments for the given function. This is also responsible for naming the
1431 /// LLVM function arguments.
Daniel Dunbar88b53962009-02-02 22:03:45 +00001432 void EmitFunctionProlog(const CGFunctionInfo &FI,
1433 llvm::Function *Fn,
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001434 const FunctionArgList &Args);
1435
Mike Stump0dd9e882009-02-08 23:14:22 +00001436 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1437 /// given temporary.
Chris Lattner35b21b82010-06-27 01:06:27 +00001438 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001439
Mike Stumpcce3d4f2009-12-07 23:38:24 +00001440 /// EmitStartEHSpec - Emit the start of the exception spec.
1441 void EmitStartEHSpec(const Decl *D);
1442
1443 /// EmitEndEHSpec - Emit the end of the exception spec.
1444 void EmitEndEHSpec(const Decl *D);
1445
John McCallf1549f62010-07-06 01:34:17 +00001446 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1447 llvm::BasicBlock *getTerminateLandingPad();
1448
1449 /// getTerminateHandler - Return a handler (not a landing pad, just
1450 /// a catch handler) that just calls terminate. This is used when
1451 /// a terminate scope encloses a try.
Mike Stump9b39c512009-12-09 22:59:31 +00001452 llvm::BasicBlock *getTerminateHandler();
1453
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001454 llvm::Type *ConvertTypeForMem(QualType T);
1455 llvm::Type *ConvertType(QualType T);
1456 llvm::Type *ConvertType(const TypeDecl *T) {
John McCallbff225e2010-02-16 04:15:37 +00001457 return ConvertType(getContext().getTypeDeclType(T));
1458 }
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001459
Mike Stump0dd9e882009-02-08 23:14:22 +00001460 /// LoadObjCSelf - Load the value of self. This function is only valid while
1461 /// generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001462 llvm::Value *LoadObjCSelf();
Mike Stump0dd9e882009-02-08 23:14:22 +00001463
1464 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001465 QualType TypeOfSelfObject();
Chris Lattner41110242008-06-17 18:05:57 +00001466
Reid Spencer5f016e22007-07-11 17:01:13 +00001467 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1468 /// an aggregate LLVM type or is void.
1469 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar55e87422008-11-11 02:29:29 +00001470
1471 /// createBasicBlock - Create an LLVM basic block.
Chris Lattner686775d2011-07-20 06:58:45 +00001472 llvm::BasicBlock *createBasicBlock(StringRef name = "",
John McCalld16c2cf2011-02-08 08:22:06 +00001473 llvm::Function *parent = 0,
1474 llvm::BasicBlock *before = 0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001475#ifdef NDEBUG
John McCalld16c2cf2011-02-08 08:22:06 +00001476 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001477#else
John McCalld16c2cf2011-02-08 08:22:06 +00001478 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001479#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +00001480 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001481
Reid Spencer5f016e22007-07-11 17:01:13 +00001482 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1483 /// label maps to.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001484 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001485
Mike Stumpf71d2322009-11-30 20:08:49 +00001486 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1487 /// another basic block, simplify it. This assumes that no other code could
1488 /// potentially reference the basic block.
Daniel Dunbaraa5bd872009-04-01 04:37:47 +00001489 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1490
Mike Stump0dd9e882009-02-08 23:14:22 +00001491 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1492 /// adding a fall-through branch from the current insert block if
1493 /// necessary. It is legal to call this function even if there is no current
1494 /// insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001495 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001496 /// IsFinished - If true, indicates that the caller has finished emitting
1497 /// branches to the given block and does not expect to emit code into it. This
1498 /// means the block can be ignored if it is unreachable.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001499 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +00001500
John McCall777d6e52011-08-11 02:22:43 +00001501 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1502 /// near its uses, and leave the insertion point in it.
1503 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1504
Mike Stump0dd9e882009-02-08 23:14:22 +00001505 /// EmitBranch - Emit a branch to the specified basic block from the current
1506 /// insert block, taking care to avoid creation of branches from dummy
1507 /// blocks. It is legal to call this function even if there is no current
1508 /// insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +00001509 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001510 /// This function clears the current insertion point. The caller should follow
1511 /// calls to this function with calls to Emit*Block prior to generation new
1512 /// code.
Daniel Dunbard57a8712008-11-11 09:41:28 +00001513 void EmitBranch(llvm::BasicBlock *Block);
1514
Mike Stump0dd9e882009-02-08 23:14:22 +00001515 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1516 /// indicates that the current code being emitted is unreachable.
1517 bool HaveInsertPoint() const {
Daniel Dunbara448fb22008-11-11 23:11:34 +00001518 return Builder.GetInsertBlock() != 0;
1519 }
1520
Mike Stump0dd9e882009-02-08 23:14:22 +00001521 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1522 /// emitted IR has a place to go. Note that by definition, if this function
1523 /// creates a block then that block is unreachable; callers may do better to
1524 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001525 void EnsureInsertPoint() {
1526 if (!HaveInsertPoint())
1527 EmitBlock(createBasicBlock());
1528 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001529
Daniel Dunbar488e9932008-08-16 00:56:44 +00001530 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +00001531 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +00001532 void ErrorUnsupported(const Stmt *S, const char *Type,
1533 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +00001534
1535 //===--------------------------------------------------------------------===//
1536 // Helpers
1537 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001538
Eli Friedman6da2c712011-12-03 04:14:32 +00001539 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1540 CharUnits Alignment = CharUnits()) {
Dan Gohman3d5aff52010-10-14 23:06:10 +00001541 return LValue::MakeAddr(V, T, Alignment, getContext(),
1542 CGM.getTBAAInfo(T));
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001543 }
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001544 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001545 CharUnits Alignment;
1546 if (!T->isIncompleteType())
1547 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001548 return LValue::MakeAddr(V, T, Alignment, getContext(),
1549 CGM.getTBAAInfo(T));
1550 }
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001551
Reid Spencer5f016e22007-07-11 17:01:13 +00001552 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbar195337d2010-02-09 02:48:28 +00001553 /// block. The caller is responsible for setting an appropriate alignment on
1554 /// the alloca.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001555 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner8cc488f2011-07-20 07:06:53 +00001556 const Twine &Name = "tmp");
Mike Stump0dd9e882009-02-08 23:14:22 +00001557
John McCallac418162010-04-22 01:10:34 +00001558 /// InitTempAlloca - Provide an initial value for the given alloca.
1559 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1560
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001561 /// CreateIRTemp - Create a temporary IR object of the given type, with
1562 /// appropriate alignment. This routine should only be used when an temporary
1563 /// value needs to be stored into an alloca (for example, to avoid explicit
1564 /// PHI construction), but the type is the IR type, not the type appropriate
1565 /// for storing in memory.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001566 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001567
Daniel Dunbar195337d2010-02-09 02:48:28 +00001568 /// CreateMemTemp - Create a temporary memory object of the given type, with
1569 /// appropriate alignment.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001570 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar195337d2010-02-09 02:48:28 +00001571
John McCall558d2ab2010-09-15 10:14:12 +00001572 /// CreateAggTemp - Create a temporary memory object for the given
1573 /// aggregate type.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001574 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedmand7722d92011-12-03 02:13:40 +00001575 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanf3940782011-12-03 00:54:26 +00001576 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1577 T.getQualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +00001578 AggValueSlot::IsNotDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001579 AggValueSlot::DoesNotNeedGCBarriers,
1580 AggValueSlot::IsNotAliased);
John McCall558d2ab2010-09-15 10:14:12 +00001581 }
1582
John McCalld16c2cf2011-02-08 08:22:06 +00001583 /// Emit a cast to void* in the appropriate address space.
1584 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1585
Reid Spencer5f016e22007-07-11 17:01:13 +00001586 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1587 /// expression and compare the result against zero, returning an Int1Ty value.
1588 llvm::Value *EvaluateExprAsBool(const Expr *E);
1589
John McCall2a416372010-12-05 02:00:02 +00001590 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1591 void EmitIgnoredExpr(const Expr *E);
1592
Chris Lattner9b655512007-08-31 22:49:20 +00001593 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1594 /// any type. The result is returned as an RValue struct. If this is an
1595 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1596 /// the result should be returned.
Mike Stump49d1cd52009-05-26 22:03:21 +00001597 ///
1598 /// \param IgnoreResult - True if the resulting value isn't used.
John McCall558d2ab2010-09-15 10:14:12 +00001599 RValue EmitAnyExpr(const Expr *E,
1600 AggValueSlot AggSlot = AggValueSlot::ignored(),
1601 bool IgnoreResult = false);
Devang Pateld9363c32007-09-28 21:49:18 +00001602
Mike Stump0dd9e882009-02-08 23:14:22 +00001603 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1604 // or the value of the expression, depending on how va_list is defined.
Eli Friedman4fd0aa52009-01-20 17:46:04 +00001605 llvm::Value *EmitVAListRef(const Expr *E);
1606
Mike Stump0dd9e882009-02-08 23:14:22 +00001607 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1608 /// always be accessible even if no aggregate location is provided.
John McCall558d2ab2010-09-15 10:14:12 +00001609 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar46f45b92008-09-09 01:06:48 +00001610
John McCall60d33652011-03-08 09:11:50 +00001611 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
John McCall3d3ec1c2010-04-21 10:05:39 +00001612 /// arbitrary expression into the given memory location.
1613 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
John McCallf85e1932011-06-15 23:02:42 +00001614 Qualifiers Quals, bool IsInitializer);
John McCall3d3ec1c2010-04-21 10:05:39 +00001615
John McCall60d33652011-03-08 09:11:50 +00001616 /// EmitExprAsInit - Emits the code necessary to initialize a
1617 /// location in memory with the given initializer.
John McCallf85e1932011-06-15 23:02:42 +00001618 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001619 LValue lvalue, bool capturedByInit);
John McCall60d33652011-03-08 09:11:50 +00001620
Mike Stump27fe2e62009-05-23 22:29:41 +00001621 /// EmitAggregateCopy - Emit an aggrate copy.
1622 ///
1623 /// \param isVolatile - True iff either the source or the destination is
1624 /// volatile.
Daniel Dunbar7482d122008-09-09 20:49:46 +00001625 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedmanbd7d8282011-12-05 22:23:28 +00001626 QualType EltTy, bool isVolatile=false,
1627 unsigned Alignment = 0);
Daniel Dunbar7482d122008-09-09 20:49:46 +00001628
Devang Patel51b09f22007-10-04 23:45:31 +00001629 /// StartBlock - Start new block named N. If insert block is a dummy block
1630 /// then reuse it.
1631 void StartBlock(const char *N);
1632
Lauro Ramos Venancio81373352008-02-26 21:41:45 +00001633 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
John McCall4c40d982010-08-31 07:33:07 +00001634 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD) {
1635 return cast<llvm::Constant>(GetAddrOfLocalVar(BVD));
1636 }
Dan Gohman4f8d1232008-05-22 00:50:06 +00001637
Anders Carlssondde0a942008-09-11 09:15:33 +00001638 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall4c40d982010-08-31 07:33:07 +00001639 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1640 llvm::Value *Res = LocalDeclMap[VD];
1641 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1642 return Res;
1643 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001644
John McCall56ca35d2011-02-17 10:25:35 +00001645 /// getOpaqueLValueMapping - Given an opaque value expression (which
1646 /// must be mapped to an l-value), return its mapping.
1647 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1648 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1649
1650 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1651 it = OpaqueLValues.find(e);
1652 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1653 return it->second;
1654 }
1655
1656 /// getOpaqueRValueMapping - Given an opaque value expression (which
1657 /// must be mapped to an r-value), return its mapping.
1658 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1659 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1660
1661 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1662 it = OpaqueRValues.find(e);
1663 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCalle996ffd2011-02-16 08:02:54 +00001664 return it->second;
1665 }
1666
Dan Gohman4f8d1232008-05-22 00:50:06 +00001667 /// getAccessedFieldNo - Given an encoded value and a result number, return
1668 /// the input field number being accessed.
1669 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1670
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001671 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner3d00fdc2009-10-13 06:55:33 +00001672 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001673
Anders Carlsson1884eb02010-05-22 17:35:42 +00001674 /// EmitNullInitialization - Generate code to set a value of the given type to
1675 /// null, If the type contains data member pointers, they will be initialized
1676 /// to -1 in accordance with the Itanium C++ ABI.
1677 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001678
1679 // EmitVAArg - Generate code to get an argument from the passed in pointer
1680 // and update it accordingly. The return value is a pointer to the argument.
1681 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stump0dd9e882009-02-08 23:14:22 +00001682 // instruction in LLVM instead once it works well enough.
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001683 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +00001684
John McCallbdc4d802011-07-09 01:37:26 +00001685 /// emitArrayLength - Compute the length of an array, even if it's a
1686 /// VLA, and drill down to the base element type.
1687 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1688 QualType &baseType,
1689 llvm::Value *&addr);
1690
John McCallbc8d40d2011-06-24 21:55:10 +00001691 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1692 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbard286f052009-07-19 06:58:07 +00001693 ///
1694 /// This function can be called with a null (unreachable) insert point.
John McCallbc8d40d2011-06-24 21:55:10 +00001695 void EmitVariablyModifiedType(QualType Ty);
Mike Stump0dd9e882009-02-08 23:14:22 +00001696
John McCallbc8d40d2011-06-24 21:55:10 +00001697 /// getVLASize - Returns an LLVM value that corresponds to the size,
1698 /// in non-variably-sized elements, of a variable length array type,
1699 /// plus that largest non-variably-sized element type. Assumes that
1700 /// the type has already been emitted with EmitVariablyModifiedType.
1701 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1702 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssondcc90d82008-12-12 07:19:02 +00001703
Anders Carlsson5f4307b2009-04-14 16:58:56 +00001704 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1705 /// generating code for an C++ member function.
John McCall25049412010-02-16 22:04:33 +00001706 llvm::Value *LoadCXXThis() {
1707 assert(CXXThisValue && "no 'this' value for this function");
1708 return CXXThisValue;
1709 }
Mike Stump1eb44332009-09-09 15:08:12 +00001710
Anders Carlssonc997d422010-01-02 01:01:18 +00001711 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1712 /// virtual bases.
John McCall25049412010-02-16 22:04:33 +00001713 llvm::Value *LoadCXXVTT() {
1714 assert(CXXVTTValue && "no VTT value for this function");
1715 return CXXVTTValue;
1716 }
John McCallbff225e2010-02-16 04:15:37 +00001717
1718 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlsson8561a862010-04-24 23:01:49 +00001719 /// complete class to the given direct base.
1720 llvm::Value *
1721 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1722 const CXXRecordDecl *Derived,
1723 const CXXRecordDecl *Base,
1724 bool BaseIsVirtual);
Anders Carlssona88ad562010-04-24 21:51:08 +00001725
Mike Stumpf71d2322009-11-30 20:08:49 +00001726 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1727 /// load of 'this' and returns address of the base class.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001728 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001729 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001730 CastExpr::path_const_iterator PathBegin,
1731 CastExpr::path_const_iterator PathEnd,
Anders Carlsson34a2d382010-04-24 21:06:20 +00001732 bool NullCheckValue);
1733
Anders Carlssona3697c92009-11-23 17:57:54 +00001734 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001735 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001736 CastExpr::path_const_iterator PathBegin,
1737 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +00001738 bool NullCheckValue);
1739
Anders Carlssonbb7e17b2010-01-31 01:36:53 +00001740 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1741 const CXXRecordDecl *ClassDecl,
1742 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001743
John McCallc0bf4622010-02-23 00:48:20 +00001744 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1745 CXXCtorType CtorType,
1746 const FunctionArgList &Args);
Sean Hunt059ce0d2011-05-01 07:04:31 +00001747 // It's important not to confuse this and the previous function. Delegating
1748 // constructors are the C++0x feature. The constructor delegate optimization
1749 // is used to reduce duplication in the base and complete consturctors where
1750 // they are substantially the same.
1751 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1752 const FunctionArgList &Args);
Anders Carlsson155ed4a2010-05-02 23:20:53 +00001753 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1754 bool ForVirtualBase, llvm::Value *This,
Anders Carlssonb14095a2009-04-17 00:06:03 +00001755 CallExpr::const_arg_iterator ArgBeg,
1756 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahanian34999872010-11-13 21:53:34 +00001757
1758 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1759 llvm::Value *This, llvm::Value *Src,
1760 CallExpr::const_arg_iterator ArgBeg,
1761 CallExpr::const_arg_iterator ArgEnd);
Mike Stump1eb44332009-09-09 15:08:12 +00001762
Fariborz Jahanian288dcaf2009-08-19 20:55:16 +00001763 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlsson569c1f42009-09-23 02:45:36 +00001764 const ConstantArrayType *ArrayTy,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001765 llvm::Value *ArrayPtr,
1766 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001767 CallExpr::const_arg_iterator ArgEnd,
1768 bool ZeroInitialization = false);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001769
Anders Carlsson569c1f42009-09-23 02:45:36 +00001770 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1771 llvm::Value *NumElements,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001772 llvm::Value *ArrayPtr,
1773 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001774 CallExpr::const_arg_iterator ArgEnd,
1775 bool ZeroInitialization = false);
Anders Carlssonb14095a2009-04-17 00:06:03 +00001776
John McCallbdc4d802011-07-09 01:37:26 +00001777 static Destroyer destroyCXXObject;
1778
Anders Carlsson7267c162009-05-29 21:03:38 +00001779 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Anders Carlsson8e6404c2010-05-02 23:29:11 +00001780 bool ForVirtualBase, llvm::Value *This);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001781
John McCall19705672011-09-15 06:49:18 +00001782 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1783 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump1eb44332009-09-09 15:08:12 +00001784
Peter Collingbourne86811602011-11-27 22:09:22 +00001785 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1786 llvm::Value *Ptr);
Mike Stump1eb44332009-09-09 15:08:12 +00001787
Anders Carlssona00703d2009-05-31 01:40:14 +00001788 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson60e282c2009-08-16 21:13:42 +00001789 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump1eb44332009-09-09 15:08:12 +00001790
Eli Friedman4bf81522009-11-18 00:57:03 +00001791 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1792 QualType DeleteTy);
1793
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001794 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stumpc849c052009-11-16 06:50:58 +00001795 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001796
Mike Stumpb14e62d2009-12-16 02:57:00 +00001797 void EmitCheck(llvm::Value *, unsigned Size);
1798
Chris Lattnerdd36d322010-01-09 21:40:03 +00001799 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1800 bool isInc, bool isPre);
1801 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1802 bool isInc, bool isPre);
Reid Spencer5f016e22007-07-11 17:01:13 +00001803 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +00001804 // Declaration Emission
1805 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001806
Daniel Dunbard286f052009-07-19 06:58:07 +00001807 /// EmitDecl - Emit a declaration.
1808 ///
1809 /// This function can be called with a null (unreachable) insert point.
Reid Spencer5f016e22007-07-11 17:01:13 +00001810 void EmitDecl(const Decl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001811
John McCallb6bbcc92010-10-15 04:57:14 +00001812 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001813 ///
1814 /// This function can be called with a null (unreachable) insert point.
John McCallb6bbcc92010-10-15 04:57:14 +00001815 void EmitVarDecl(const VarDecl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001816
John McCallf85e1932011-06-15 23:02:42 +00001817 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001818 LValue lvalue, bool capturedByInit);
John McCall7acddac2011-06-17 06:42:21 +00001819 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCallf85e1932011-06-15 23:02:42 +00001820
John McCallf1549f62010-07-06 01:34:17 +00001821 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1822 llvm::Value *Address);
1823
John McCallb6bbcc92010-10-15 04:57:14 +00001824 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001825 ///
1826 /// This function can be called with a null (unreachable) insert point.
John McCall34695852011-02-22 06:44:22 +00001827 void EmitAutoVarDecl(const VarDecl &D);
1828
1829 class AutoVarEmission {
1830 friend class CodeGenFunction;
1831
John McCall57b3b6a2011-02-22 07:16:58 +00001832 const VarDecl *Variable;
John McCall34695852011-02-22 06:44:22 +00001833
1834 /// The alignment of the variable.
1835 CharUnits Alignment;
1836
1837 /// The address of the alloca. Null if the variable was emitted
1838 /// as a global constant.
1839 llvm::Value *Address;
1840
1841 llvm::Value *NRVOFlag;
1842
1843 /// True if the variable is a __block variable.
1844 bool IsByRef;
1845
1846 /// True if the variable is of aggregate type and has a constant
1847 /// initializer.
1848 bool IsConstantAggregate;
1849
John McCall57b3b6a2011-02-22 07:16:58 +00001850 struct Invalid {};
1851 AutoVarEmission(Invalid) : Variable(0) {}
1852
John McCall34695852011-02-22 06:44:22 +00001853 AutoVarEmission(const VarDecl &variable)
John McCall57b3b6a2011-02-22 07:16:58 +00001854 : Variable(&variable), Address(0), NRVOFlag(0),
John McCall34695852011-02-22 06:44:22 +00001855 IsByRef(false), IsConstantAggregate(false) {}
1856
1857 bool wasEmittedAsGlobal() const { return Address == 0; }
1858
1859 public:
John McCall57b3b6a2011-02-22 07:16:58 +00001860 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1861
John McCall34695852011-02-22 06:44:22 +00001862 /// Returns the address of the object within this declaration.
1863 /// Note that this does not chase the forwarding pointer for
1864 /// __block decls.
1865 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1866 if (!IsByRef) return Address;
1867
1868 return CGF.Builder.CreateStructGEP(Address,
John McCall57b3b6a2011-02-22 07:16:58 +00001869 CGF.getByRefValueLLVMField(Variable),
1870 Variable->getNameAsString());
John McCall34695852011-02-22 06:44:22 +00001871 }
1872 };
1873 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1874 void EmitAutoVarInit(const AutoVarEmission &emission);
1875 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCallbdc4d802011-07-09 01:37:26 +00001876 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1877 QualType::DestructionKind dtorKind);
Daniel Dunbard286f052009-07-19 06:58:07 +00001878
John McCallb6bbcc92010-10-15 04:57:14 +00001879 void EmitStaticVarDecl(const VarDecl &D,
1880 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001881
1882 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel093ac462011-03-03 20:13:15 +00001883 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stump0dd9e882009-02-08 23:14:22 +00001884
John McCall56ca35d2011-02-17 10:25:35 +00001885 /// protectFromPeepholes - Protect a value that we're intending to
1886 /// store to the side, but which will probably be used later, from
1887 /// aggressive peepholing optimizations that might delete it.
1888 ///
1889 /// Pass the result to unprotectFromPeepholes to declare that
1890 /// protection is no longer required.
1891 ///
1892 /// There's no particular reason why this shouldn't apply to
1893 /// l-values, it's just that no existing peepholes work on pointers.
1894 PeepholeProtection protectFromPeepholes(RValue rvalue);
1895 void unprotectFromPeepholes(PeepholeProtection protection);
1896
Reid Spencer5f016e22007-07-11 17:01:13 +00001897 //===--------------------------------------------------------------------===//
1898 // Statement Emission
1899 //===--------------------------------------------------------------------===//
1900
Mike Stump0dd9e882009-02-08 23:14:22 +00001901 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar09124252008-11-12 08:21:33 +00001902 void EmitStopPoint(const Stmt *S);
1903
Mike Stump0dd9e882009-02-08 23:14:22 +00001904 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1905 /// this function even if there is no current insertion point.
1906 ///
1907 /// This function may clear the current insertion point; callers should use
1908 /// EnsureInsertPoint if they wish to subsequently generate code without first
1909 /// calling EmitBlock, EmitBranch, or EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +00001910 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001911
Daniel Dunbar09124252008-11-12 08:21:33 +00001912 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stump0dd9e882009-02-08 23:14:22 +00001913 /// necessarily require an insertion point or debug information; typically
1914 /// because the statement amounts to a jump or a container of other
1915 /// statements.
Daniel Dunbar09124252008-11-12 08:21:33 +00001916 ///
1917 /// \return True if the statement was handled.
1918 bool EmitSimpleStmt(const Stmt *S);
1919
Chris Lattner9b655512007-08-31 22:49:20 +00001920 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall558d2ab2010-09-15 10:14:12 +00001921 AggValueSlot AVS = AggValueSlot::ignored());
Daniel Dunbara448fb22008-11-11 23:11:34 +00001922
Mike Stump0dd9e882009-02-08 23:14:22 +00001923 /// EmitLabel - Emit the block for the given label. It is legal to call this
1924 /// function even if there is no current insertion point.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001925 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001926
Reid Spencer5f016e22007-07-11 17:01:13 +00001927 void EmitLabelStmt(const LabelStmt &S);
1928 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001929 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00001930 void EmitIfStmt(const IfStmt &S);
1931 void EmitWhileStmt(const WhileStmt &S);
1932 void EmitDoStmt(const DoStmt &S);
1933 void EmitForStmt(const ForStmt &S);
1934 void EmitReturnStmt(const ReturnStmt &S);
1935 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +00001936 void EmitBreakStmt(const BreakStmt &S);
1937 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +00001938 void EmitSwitchStmt(const SwitchStmt &S);
1939 void EmitDefaultStmt(const DefaultStmt &S);
1940 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +00001941 void EmitCaseStmtRange(const CaseStmt &S);
Anders Carlssonfb1aeb82008-02-05 16:35:33 +00001942 void EmitAsmStmt(const AsmStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001943
Anders Carlsson3d8400d2008-08-30 19:51:14 +00001944 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001945 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1946 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00001947 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCallf85e1932011-06-15 23:02:42 +00001948 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001949
John McCall93c332a2011-05-28 21:13:02 +00001950 llvm::Constant *getUnwindResumeFn();
Douglas Gregor86a3a032010-05-16 01:24:12 +00001951 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCall59a70002010-07-07 06:56:46 +00001952 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1953 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCall9fc6a772010-02-19 09:25:03 +00001954
Anders Carlsson6815e942009-09-27 18:58:34 +00001955 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smithad762fc2011-04-14 22:09:26 +00001956 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001957
Reid Spencer5f016e22007-07-11 17:01:13 +00001958 //===--------------------------------------------------------------------===//
1959 // LValue Expression Emission
1960 //===--------------------------------------------------------------------===//
1961
Daniel Dunbar13e81732009-02-05 07:09:07 +00001962 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1963 RValue GetUndefRValue(QualType Ty);
1964
Daniel Dunbarce1d38b2009-01-09 16:50:52 +00001965 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1966 /// and issue an ErrorUnsupported style diagnostic (using the
1967 /// provided Name).
1968 RValue EmitUnsupportedRValue(const Expr *E,
1969 const char *Name);
1970
Mike Stump0dd9e882009-02-08 23:14:22 +00001971 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
1972 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbar6ba82a42008-08-25 20:45:57 +00001973 LValue EmitUnsupportedLValue(const Expr *E,
1974 const char *Name);
1975
Reid Spencer5f016e22007-07-11 17:01:13 +00001976 /// EmitLValue - Emit code to compute a designator that specifies the location
1977 /// of the expression.
1978 ///
1979 /// This can return one of two things: a simple address or a bitfield
1980 /// reference. In either case, the LLVM Value* in the LValue structure is
1981 /// guaranteed to be an LLVM pointer type.
1982 ///
1983 /// If this returns a bitfield reference, nothing about the pointee type of
1984 /// the LLVM value is known: For example, it may not be a pointer to an
1985 /// integer.
1986 ///
1987 /// If this returns a normal address, and if the lvalue's C type is fixed
1988 /// size, this method guarantees that the returned pointer type will point to
1989 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
1990 /// variable length type, this is not possible.
1991 ///
1992 LValue EmitLValue(const Expr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00001993
Mike Stumpb14e62d2009-12-16 02:57:00 +00001994 /// EmitCheckedLValue - Same as EmitLValue but additionally we generate
1995 /// checking code to guard against undefined behavior. This is only
1996 /// suitable when we know that the address will be used to access the
1997 /// object.
1998 LValue EmitCheckedLValue(const Expr *E);
1999
John McCall26815d92010-10-27 20:58:56 +00002000 /// EmitToMemory - Change a scalar value from its value
2001 /// representation to its in-memory representation.
2002 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2003
2004 /// EmitFromMemory - Change a scalar value from its memory
2005 /// representation to its value representation.
2006 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2007
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002008 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2009 /// care to appropriately convert from the memory representation to
2010 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002011 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002012 unsigned Alignment, QualType Ty,
2013 llvm::MDNode *TBAAInfo = 0);
John McCall545d9962011-06-25 02:11:03 +00002014
2015 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2016 /// care to appropriately convert from the memory representation to
2017 /// the LLVM value representation. The l-value must be a simple
2018 /// l-value.
John McCalla07398e2011-06-16 04:16:24 +00002019 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002020
2021 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2022 /// care to appropriately convert from the memory representation to
2023 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002024 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002025 bool Volatile, unsigned Alignment, QualType Ty,
2026 llvm::MDNode *TBAAInfo = 0);
John McCall545d9962011-06-25 02:11:03 +00002027
2028 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2029 /// care to appropriately convert from the memory representation to
2030 /// the LLVM value representation. The l-value must be a simple
2031 /// l-value.
John McCalla07398e2011-06-16 04:16:24 +00002032 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002033
Reid Spencer5f016e22007-07-11 17:01:13 +00002034 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2035 /// this method emits the address of the lvalue, then loads the result as an
2036 /// rvalue, returning the rvalue.
John McCall545d9962011-06-25 02:11:03 +00002037 RValue EmitLoadOfLValue(LValue V);
2038 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2039 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stump0dd9e882009-02-08 23:14:22 +00002040
Reid Spencer5f016e22007-07-11 17:01:13 +00002041 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2042 /// lvalue, where both are guaranteed to the have the same type, and that type
2043 /// is 'Ty'.
John McCall545d9962011-06-25 02:11:03 +00002044 void EmitStoreThroughLValue(RValue Src, LValue Dst);
2045 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbared3849b2008-11-19 09:36:46 +00002046
Mike Stump0dd9e882009-02-08 23:14:22 +00002047 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2048 /// EmitStoreThroughLValue.
Daniel Dunbared3849b2008-11-19 09:36:46 +00002049 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00002050 /// \param Result [out] - If non-null, this will be set to a Value* for the
2051 /// bit-field contents after the store, appropriate for use as the result of
2052 /// an assignment to the bit-field.
John McCall545d9962011-06-25 02:11:03 +00002053 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbared3849b2008-11-19 09:36:46 +00002054 llvm::Value **Result=0);
Mike Stump0dd9e882009-02-08 23:14:22 +00002055
John McCall83ce9d42010-11-16 23:07:28 +00002056 /// Emit an l-value for an assignment (simple or compound) of complex type.
2057 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002058 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall83ce9d42010-11-16 23:07:28 +00002059
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00002060 // Note: only available for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +00002061 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002062 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002063 // Note: only available for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +00002064 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002065 // Note: only available for agg return types
2066 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002067 LValue EmitDeclRefLValue(const DeclRefExpr *E);
2068 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnereaf2bb82009-02-24 22:18:39 +00002069 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattnerd9f69102008-08-10 01:53:14 +00002070 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002071 LValue EmitUnaryOpLValue(const UnaryOperator *E);
2072 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begeman213541a2008-04-18 23:10:10 +00002073 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +00002074 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian820bca42009-12-09 23:35:29 +00002075 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +00002076 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
John McCall56ca35d2011-02-17 10:25:35 +00002077 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner75dfeda2009-03-18 18:28:57 +00002078 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregored8abf12010-07-08 06:14:04 +00002079 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregor03e80032011-06-21 17:03:29 +00002080 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCalle996ffd2011-02-16 08:02:54 +00002081 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002082
John McCall4b9c2d22011-11-06 09:01:30 +00002083 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2084 AggValueSlot slot = AggValueSlot::ignored());
2085 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2086
Daniel Dunbar2a031922009-04-22 05:08:15 +00002087 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002088 const ObjCIvarDecl *Ivar);
John McCalla9976d32010-05-21 01:18:57 +00002089 LValue EmitLValueForAnonRecordField(llvm::Value* Base,
Francois Pichet00eb3f92010-12-04 09:14:42 +00002090 const IndirectFieldDecl* Field,
John McCalla9976d32010-05-21 01:18:57 +00002091 unsigned CVRQualifiers);
Anders Carlsson0ed303c2009-11-17 03:57:07 +00002092 LValue EmitLValueForField(llvm::Value* Base, const FieldDecl* Field,
Anders Carlssone6d2a532010-01-29 05:05:36 +00002093 unsigned CVRQualifiers);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002094
Anders Carlsson06a29702010-01-29 05:24:29 +00002095 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2096 /// if the Field is a reference, this will return the address of the reference
2097 /// and not the address of the value stored in the reference.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002098 LValue EmitLValueForFieldInitialization(llvm::Value* Base,
Anders Carlsson06a29702010-01-29 05:24:29 +00002099 const FieldDecl* Field,
2100 unsigned CVRQualifiers);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002101
Fariborz Jahanian45012a72009-02-03 00:09:52 +00002102 LValue EmitLValueForIvar(QualType ObjectTy,
2103 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002104 unsigned CVRQualifiers);
2105
Anders Carlsson0ed303c2009-11-17 03:57:07 +00002106 LValue EmitLValueForBitfield(llvm::Value* Base, const FieldDecl* Field,
Fariborz Jahanian598d3f62009-02-03 19:03:09 +00002107 unsigned CVRQualifiers);
Fariborz Jahanianfd64bb62008-12-15 20:35:07 +00002108
Mike Stumpa99038c2009-02-28 09:07:16 +00002109 LValue EmitBlockDeclRefLValue(const BlockDeclRefExpr *E);
2110
Anders Carlssonb58d0172009-05-30 23:23:33 +00002111 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssone61c9e82009-05-30 23:30:54 +00002112 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002113 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002114
Daniel Dunbar0a04d772008-08-23 10:51:21 +00002115 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +00002116 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattner65459942009-04-25 19:35:26 +00002117 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanian8bfd31f2009-10-22 22:57:31 +00002118 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian03b29602010-06-17 19:56:20 +00002119 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCall189d6ef2010-10-09 01:34:31 +00002120 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCall56ca35d2011-02-17 10:25:35 +00002121
Reid Spencer5f016e22007-07-11 17:01:13 +00002122 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +00002123 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +00002124 //===--------------------------------------------------------------------===//
2125
Mike Stump0dd9e882009-02-08 23:14:22 +00002126 /// EmitCall - Generate a call of the given function, expecting the given
2127 /// result type, and using the given argument list which specifies both the
2128 /// LLVM arguments and the types they were derived from.
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002129 ///
Mike Stumpf71d2322009-11-30 20:08:49 +00002130 /// \param TargetDecl - If given, the decl of the function in a direct call;
2131 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbar88b53962009-02-02 22:03:45 +00002132 RValue EmitCall(const CGFunctionInfo &FnInfo,
2133 llvm::Value *Callee,
Anders Carlssonf3c47c92009-12-24 19:25:24 +00002134 ReturnValueSlot ReturnValue,
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002135 const CallArgList &Args,
David Chisnalldd5c98f2010-05-01 11:15:56 +00002136 const Decl *TargetDecl = 0,
David Chisnall4b02afc2010-05-02 13:41:58 +00002137 llvm::Instruction **callOrInvoke = 0);
Mike Stump1eb44332009-09-09 15:08:12 +00002138
Anders Carlsson31777a22009-12-24 19:08:58 +00002139 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlssond2490a92009-12-24 20:40:36 +00002140 ReturnValueSlot ReturnValue,
Anders Carlsson98647712009-05-27 01:22:39 +00002141 CallExpr::const_arg_iterator ArgBeg,
2142 CallExpr::const_arg_iterator ArgEnd,
2143 const Decl *TargetDecl = 0);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002144 RValue EmitCallExpr(const CallExpr *E,
Anders Carlssond2490a92009-12-24 20:40:36 +00002145 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump1eb44332009-09-09 15:08:12 +00002146
John McCallf1549f62010-07-06 01:34:17 +00002147 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner2d3ba4f2011-07-23 17:14:25 +00002148 ArrayRef<llvm::Value *> Args,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002149 const Twine &Name = "");
Jay Foad4c7d9f12011-07-15 08:37:34 +00002150 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002151 const Twine &Name = "");
John McCallf1549f62010-07-06 01:34:17 +00002152
Anders Carlsson566abee2009-11-13 04:45:41 +00002153 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002154 llvm::Type *Ty);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002155 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002156 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian27262672011-01-20 17:19:02 +00002157 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2158 NestedNameSpecifier *Qual,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002159 llvm::Type *Ty);
Fariborz Jahanianccd52592011-02-01 23:22:34 +00002160
2161 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2162 CXXDtorType Type,
Fariborz Jahanian771c6782011-02-03 19:27:17 +00002163 const CXXRecordDecl *RD);
Anders Carlsson566abee2009-11-13 04:45:41 +00002164
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002165 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
2166 llvm::Value *Callee,
Anders Carlssona1736c02009-12-24 21:13:40 +00002167 ReturnValueSlot ReturnValue,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002168 llvm::Value *This,
Anders Carlssonc997d422010-01-02 01:01:18 +00002169 llvm::Value *VTT,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002170 CallExpr::const_arg_iterator ArgBeg,
2171 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssona1736c02009-12-24 21:13:40 +00002172 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2173 ReturnValueSlot ReturnValue);
2174 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2175 ReturnValueSlot ReturnValue);
Ted Kremenek55499762008-06-17 02:43:46 +00002176
Anders Carlssona2447e02011-05-08 20:32:23 +00002177 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2178 const CXXMethodDecl *MD,
2179 llvm::Value *This);
Anders Carlsson0f294632009-05-27 04:18:27 +00002180 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssona1736c02009-12-24 21:13:40 +00002181 const CXXMethodDecl *MD,
2182 ReturnValueSlot ReturnValue);
Mike Stump1eb44332009-09-09 15:08:12 +00002183
Peter Collingbourne6c0aa5f2011-10-06 18:29:37 +00002184 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2185 ReturnValueSlot ReturnValue);
2186
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002187
Mike Stump1eb44332009-09-09 15:08:12 +00002188 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbaref2abfe2009-02-16 22:43:43 +00002189 unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002190
Anders Carlssona1736c02009-12-24 21:13:40 +00002191 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stump09429b92009-02-17 17:00:02 +00002192
Mike Stump0dd9e882009-02-08 23:14:22 +00002193 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2194 /// is unhandled by the current target.
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +00002195 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2196
Chris Lattner2752c012010-03-03 19:03:45 +00002197 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002198 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner686775d2011-07-20 06:58:45 +00002199 SmallVectorImpl<llvm::Value*> &O,
Bob Wilsondb3d4d02010-12-08 22:37:56 +00002200 const char *name,
Nate Begeman61eecf52010-06-14 05:21:25 +00002201 unsigned shift = 0, bool rightshift = false);
Bob Wilsoncf556522010-12-07 22:40:02 +00002202 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2acc6e32011-07-18 04:24:23 +00002203 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman61eecf52010-06-14 05:21:25 +00002204 bool negateForRightShift);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002205
Chris Lattner686775d2011-07-20 06:58:45 +00002206 llvm::Value *BuildVector(const SmallVectorImpl<llvm::Value*> &Ops);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002207 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tony Linthicum96319392011-12-12 21:14:55 +00002208 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002209 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002210
Daniel Dunbared7c6182008-08-20 00:28:19 +00002211 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +00002212 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Chris Lattner8fdf3282008-06-24 17:04:18 +00002213 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCallef072fd2010-05-22 01:48:05 +00002214 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2215 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattner8fdf3282008-06-24 17:04:18 +00002216
John McCallf85e1932011-06-15 23:02:42 +00002217 /// Retrieves the default cleanup kind for an ARC cleanup.
2218 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2219 CleanupKind getARCCleanupKind() {
2220 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2221 ? NormalAndEHCleanup : NormalCleanup;
2222 }
2223
2224 // ARC primitives.
2225 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2226 void EmitARCDestroyWeak(llvm::Value *addr);
2227 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2228 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2229 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2230 bool ignored);
2231 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2232 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2233 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2234 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall545d9962011-06-25 02:11:03 +00002235 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
2236 bool ignored);
John McCallf85e1932011-06-15 23:02:42 +00002237 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2238 bool ignored);
2239 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2240 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCall348f16f2011-10-04 06:23:45 +00002241 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallf85e1932011-06-15 23:02:42 +00002242 void EmitARCRelease(llvm::Value *value, bool precise);
2243 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2244 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2245 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2246 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2247
2248 std::pair<LValue,llvm::Value*>
2249 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2250 std::pair<LValue,llvm::Value*>
2251 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2252
John McCall2b014d62011-10-01 10:32:24 +00002253 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2254
John McCallf85e1932011-06-15 23:02:42 +00002255 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2256 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2257 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2258
John McCall348f16f2011-10-04 06:23:45 +00002259 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCallf85e1932011-06-15 23:02:42 +00002260 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2261 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2262
John McCallbdc4d802011-07-09 01:37:26 +00002263 static Destroyer destroyARCStrongImprecise;
2264 static Destroyer destroyARCStrongPrecise;
2265 static Destroyer destroyARCWeak;
2266
John McCallf85e1932011-06-15 23:02:42 +00002267 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2268 llvm::Value *EmitObjCAutoreleasePoolPush();
2269 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2270 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2271 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2272
Anders Carlsson4029ca72009-05-20 00:24:07 +00002273 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2274 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002275 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson32f36ba2010-06-26 16:35:32 +00002276 const NamedDecl *InitializedDecl);
Anders Carlsson3aba0932010-01-31 18:34:51 +00002277
Chris Lattner883f6a72007-08-11 00:04:45 +00002278 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002279 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +00002280 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002281
2282 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stump0dd9e882009-02-08 23:14:22 +00002283
2284 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2285 /// scalar type, returning the result.
Anders Carlsson14c5cbf2009-08-16 07:36:22 +00002286 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002287
Chris Lattner3707b252007-08-26 06:48:56 +00002288 /// EmitScalarConversion - Emit a conversion from the specified type to the
2289 /// specified destination type, both of which are LLVM scalar types.
2290 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2291 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002292
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002293 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stump0dd9e882009-02-08 23:14:22 +00002294 /// complex type to the specified destination type, where the destination type
2295 /// is an LLVM scalar type.
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002296 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2297 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002298
2299
John McCall558d2ab2010-09-15 10:14:12 +00002300 /// EmitAggExpr - Emit the computation of the specified expression
2301 /// of aggregate type. The result is computed into the given slot,
2302 /// which may be null to indicate that the value is not needed.
Fariborz Jahanian474e2fe2010-09-16 00:20:07 +00002303 void EmitAggExpr(const Expr *E, AggValueSlot AS, bool IgnoreResult = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002304
Daniel Dunbar18aba0d2010-02-05 19:38:31 +00002305 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2306 /// aggregate type into a temporary LValue.
2307 LValue EmitAggExprToLValue(const Expr *E);
2308
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002309 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2310 /// pointers.
2311 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian08c32132009-08-31 19:33:16 +00002312 QualType Ty);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002313
John McCall0c24c802011-06-24 23:21:27 +00002314 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2315 /// make sure it survives garbage collection until this point.
2316 void EmitExtendGCLifetime(llvm::Value *object);
2317
Chris Lattnerb6ef18a2007-08-21 05:54:00 +00002318 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002319 /// complex type, returning the result.
John McCallb418d742010-11-16 10:08:07 +00002320 ComplexPairTy EmitComplexExpr(const Expr *E,
2321 bool IgnoreReal = false,
2322 bool IgnoreImag = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002323
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002324 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
2325 /// of complex type, storing into the specified Value*.
Chris Lattner190dbe22007-08-26 16:22:13 +00002326 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
2327 bool DestIsVolatile);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00002328
2329 /// StoreComplexToAddr - Store a complex number into the specified address.
2330 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
2331 bool DestIsVolatile);
Chris Lattner9b655512007-08-31 22:49:20 +00002332 /// LoadComplexFromAddr - Load a complex number from the specified address.
2333 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattner2621fd12008-05-08 05:58:21 +00002334
John McCallb6bbcc92010-10-15 04:57:14 +00002335 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2336 /// a static local variable.
2337 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2338 const char *Separator,
Mike Stumpf71d2322009-11-30 20:08:49 +00002339 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002340
John McCallb6bbcc92010-10-15 04:57:14 +00002341 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
Chris Lattner761acc12009-12-05 08:22:11 +00002342 /// global variable that has already been created for it. If the initializer
2343 /// has a different type than GV does, this may free GV and return a different
2344 /// one. Otherwise it just returns GV.
2345 llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +00002346 AddInitializerToStaticVarDecl(const VarDecl &D,
2347 llvm::GlobalVariable *GV);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002348
Daniel Dunbar0096acf2009-02-25 19:24:29 +00002349
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002350 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2351 /// variable with global storage.
2352 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr);
2353
2354 /// EmitCXXGlobalDtorRegistration - Emits a call to register the global ptr
2355 /// with the C++ runtime so that its destructor will be called at exit.
Fariborz Jahanian88f42802009-11-10 19:24:06 +00002356 void EmitCXXGlobalDtorRegistration(llvm::Constant *DtorFn,
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002357 llvm::Constant *DeclPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00002358
John McCall3030eb82010-11-06 09:44:32 +00002359 /// Emit code in this function to perform a guarded variable
2360 /// initialization. Guarded initializations are used when it's not
2361 /// possible to prove that an initialization will be done exactly
2362 /// once, e.g. with a static local variable or a static data member
2363 /// of a class template.
2364 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr);
John McCall5cd91b52010-09-08 01:44:27 +00002365
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002366 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2367 /// variables.
2368 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2369 llvm::Constant **Decls,
2370 unsigned NumDecls);
2371
2372 /// GenerateCXXGlobalDtorFunc - Generates code for destroying global
2373 /// variables.
2374 void GenerateCXXGlobalDtorFunc(llvm::Function *Fn,
Chris Lattner810112e2010-06-19 05:52:45 +00002375 const std::vector<std::pair<llvm::WeakVH,
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002376 llvm::Constant*> > &DtorsAndObjects);
2377
John McCalld26bc762011-03-09 04:27:21 +00002378 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2379 const VarDecl *D,
John McCall3030eb82010-11-06 09:44:32 +00002380 llvm::GlobalVariable *Addr);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002381
John McCall558d2ab2010-09-15 10:14:12 +00002382 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002383
2384 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian830937b2010-12-02 17:02:11 +00002385 const Expr *Exp);
Mike Stump1eb44332009-09-09 15:08:12 +00002386
John McCall1a343eb2011-11-10 08:15:53 +00002387 void enterFullExpression(const ExprWithCleanups *E) {
2388 if (E->getNumObjects() == 0) return;
2389 enterNonTrivialFullExpression(E);
2390 }
2391 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump1eb44332009-09-09 15:08:12 +00002392
Anders Carlsson756b5c42009-10-30 01:42:31 +00002393 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregor1eb2e592010-05-16 00:44:00 +00002394
Eli Friedman276b0612011-10-11 02:20:01 +00002395 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2396
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002397 //===--------------------------------------------------------------------===//
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002398 // Annotations Emission
2399 //===--------------------------------------------------------------------===//
2400
2401 /// Emit an annotation call (intrinsic or builtin).
2402 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2403 llvm::Value *AnnotatedVal,
2404 llvm::StringRef AnnotationStr,
2405 SourceLocation Location);
2406
2407 /// Emit local annotations for the local variable V, declared by D.
2408 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2409
2410 /// Emit field annotations for the given field & value. Returns the
2411 /// annotation result.
2412 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2413
2414 //===--------------------------------------------------------------------===//
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002415 // Internal Helpers
2416 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002417
Chris Lattner0946ccd2008-11-11 07:41:27 +00002418 /// ContainsLabel - Return true if the statement contains a label in it. If
2419 /// this statement is not executed normally, it not containing a label means
2420 /// that we can just remove the code.
2421 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002422
Chris Lattneref425a62011-02-28 00:18:40 +00002423 /// containsBreak - Return true if the statement contains a break out of it.
2424 /// If the statement (recursively) contains a switch or loop with a break
2425 /// inside of it, this is fine.
2426 static bool containsBreak(const Stmt *S);
2427
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002428 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnerc2c90012011-02-27 23:02:32 +00002429 /// to a constant, or if it does but contains a label, return false. If it
2430 /// constant folds return true and set the boolean result in Result.
2431 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stump0dd9e882009-02-08 23:14:22 +00002432
Chris Lattneref425a62011-02-28 00:18:40 +00002433 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2434 /// to a constant, or if it does but contains a label, return false. If it
2435 /// constant folds return true and set the folded value.
2436 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APInt &Result);
2437
Chris Lattner31a09842008-11-12 08:04:58 +00002438 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2439 /// if statement) to the specified blocks. Based on the condition, this might
2440 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattner9bc47e22008-11-12 07:46:33 +00002441 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002442 llvm::BasicBlock *FalseBlock);
Mike Stumpbe07f602009-12-14 21:58:14 +00002443
Mike Stump15037ca2009-12-15 00:35:12 +00002444 /// getTrapBB - Create a basic block that will call the trap intrinsic. We'll
2445 /// generate a branch around the created basic block as necessary.
Chris Lattner6c552c12010-07-20 20:19:24 +00002446 llvm::BasicBlock *getTrapBB();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002447
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002448 /// EmitCallArg - Emit a single call argument.
John McCall413ebdb2011-03-11 20:59:21 +00002449 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002450
John McCall27360712010-05-26 22:34:26 +00002451 /// EmitDelegateCallArg - We are performing a delegate call; that
2452 /// is, the current function is delegating to another one. Produce
2453 /// a r-value suitable for passing the given parameter.
John McCall413ebdb2011-03-11 20:59:21 +00002454 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall27360712010-05-26 22:34:26 +00002455
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002456 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2457 /// point operation, expressed as the maximum relative error in ulp.
2458 void SetFPAccuracy(llvm::Value *Val, unsigned AccuracyN,
2459 unsigned AccuracyD = 1);
2460
Chris Lattner31a09842008-11-12 08:04:58 +00002461private:
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002462 void EmitReturnOfRValue(RValue RV, QualType Ty);
2463
Daniel Dunbar56273772008-09-17 00:51:38 +00002464 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2465 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2466 ///
2467 /// \param AI - The first function argument of the expansion.
2468 /// \return The argument following the last expanded function
2469 /// argument.
Mike Stump0dd9e882009-02-08 23:14:22 +00002470 llvm::Function::arg_iterator
Daniel Dunbar56273772008-09-17 00:51:38 +00002471 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2472 llvm::Function::arg_iterator AI);
2473
Mike Stump0dd9e882009-02-08 23:14:22 +00002474 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2475 /// Ty, into individual arguments on the provided vector \arg Args. See
2476 /// ABIArgInfo::Expand.
2477 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner686775d2011-07-20 06:58:45 +00002478 SmallVector<llvm::Value*, 16> &Args,
Chris Lattner811bf362011-07-12 06:29:11 +00002479 llvm::FunctionType *IRFuncTy);
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002480
Mike Stump1eb44332009-09-09 15:08:12 +00002481 llvm::Value* EmitAsmInput(const AsmStmt &S,
Daniel Dunbarb84e8a62009-05-04 06:56:16 +00002482 const TargetInfo::ConstraintInfo &Info,
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002483 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stump0dd9e882009-02-08 23:14:22 +00002484
Eli Friedman6d7cfd72010-07-16 00:55:21 +00002485 llvm::Value* EmitAsmInputLValue(const AsmStmt &S,
2486 const TargetInfo::ConstraintInfo &Info,
2487 LValue InputValue, QualType InputType,
2488 std::string &ConstraintStr);
2489
Anders Carlsson0139bb92009-04-08 20:47:54 +00002490 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump1eb44332009-09-09 15:08:12 +00002491 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlssonaf23f692009-04-18 20:20:22 +00002492 /// argument types of the function being called.
2493 template<typename T>
2494 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson0139bb92009-04-08 20:47:54 +00002495 CallExpr::const_arg_iterator ArgBeg,
Anders Carlssonaf23f692009-04-18 20:20:22 +00002496 CallExpr::const_arg_iterator ArgEnd) {
2497 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson0139bb92009-04-08 20:47:54 +00002498
Anders Carlssonaf23f692009-04-18 20:20:22 +00002499 // First, use the argument types that the type info knows about
2500 if (CallArgTypeInfo) {
2501 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2502 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman44b0a3e2009-11-18 03:42:04 +00002503 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlssonaf23f692009-04-18 20:20:22 +00002504 QualType ArgType = *I;
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002505#ifndef NDEBUG
2506 QualType ActualArgType = Arg->getType();
2507 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002508 QualType ActualBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002509 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002510 QualType ArgBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002511 ArgType->getAs<PointerType>()->getPointeeType();
2512 if (ArgBaseType->isVariableArrayType()) {
2513 if (const VariableArrayType *VAT =
2514 getContext().getAsVariableArrayType(ActualBaseType)) {
2515 if (!VAT->getSizeExpr())
2516 ActualArgType = ArgType;
2517 }
2518 }
2519 }
Anders Carlssonaf23f692009-04-18 20:20:22 +00002520 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump1eb44332009-09-09 15:08:12 +00002521 getTypePtr() ==
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002522 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002523 "type mismatch in call argument!");
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002524#endif
John McCall413ebdb2011-03-11 20:59:21 +00002525 EmitCallArg(Args, *Arg, ArgType);
Anders Carlssonaf23f692009-04-18 20:20:22 +00002526 }
Mike Stump1eb44332009-09-09 15:08:12 +00002527
2528 // Either we've emitted all the call args, or we have a call to a
Anders Carlssonaf23f692009-04-18 20:20:22 +00002529 // variadic function.
Mike Stump1eb44332009-09-09 15:08:12 +00002530 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002531 "Extra arguments in non-variadic function!");
Mike Stump1eb44332009-09-09 15:08:12 +00002532
Anders Carlssonaf23f692009-04-18 20:20:22 +00002533 }
Mike Stump1eb44332009-09-09 15:08:12 +00002534
Anders Carlssonaf23f692009-04-18 20:20:22 +00002535 // If we still have any arguments, emit them using the type of the argument.
John McCall413ebdb2011-03-11 20:59:21 +00002536 for (; Arg != ArgEnd; ++Arg)
2537 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlssonaf23f692009-04-18 20:20:22 +00002538 }
John McCall492c4f92010-03-03 04:15:11 +00002539
2540 const TargetCodeGenInfo &getTargetHooks() const {
2541 return CGM.getTargetCodeGenInfo();
2542 }
John McCall744016d2010-07-06 23:57:41 +00002543
2544 void EmitDeclMetadata();
John McCallf0c11f72011-03-31 08:03:29 +00002545
2546 CodeGenModule::ByrefHelpers *
Chris Lattner2acc6e32011-07-18 04:24:23 +00002547 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf0c11f72011-03-31 08:03:29 +00002548 const AutoVarEmission &emission);
Reid Spencer5f016e22007-07-11 17:01:13 +00002549};
Mike Stump1eb44332009-09-09 15:08:12 +00002550
John McCall150b4622011-01-26 04:00:11 +00002551/// Helper class with most of the code for saving a value for a
2552/// conditional expression cleanup.
John McCall804b8072011-01-28 10:53:53 +00002553struct DominatingLLVMValue {
John McCall150b4622011-01-26 04:00:11 +00002554 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2555
2556 /// Answer whether the given value needs extra work to be saved.
2557 static bool needsSaving(llvm::Value *value) {
2558 // If it's not an instruction, we don't need to save.
2559 if (!isa<llvm::Instruction>(value)) return false;
2560
2561 // If it's an instruction in the entry block, we don't need to save.
2562 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2563 return (block != &block->getParent()->getEntryBlock());
2564 }
2565
2566 /// Try to save the given value.
2567 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2568 if (!needsSaving(value)) return saved_type(value, false);
2569
2570 // Otherwise we need an alloca.
2571 llvm::Value *alloca =
2572 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2573 CGF.Builder.CreateStore(value, alloca);
2574
2575 return saved_type(alloca, true);
2576 }
2577
2578 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2579 if (!value.getInt()) return value.getPointer();
2580 return CGF.Builder.CreateLoad(value.getPointer());
2581 }
2582};
2583
John McCall804b8072011-01-28 10:53:53 +00002584/// A partial specialization of DominatingValue for llvm::Values that
2585/// might be llvm::Instructions.
2586template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2587 typedef T *type;
John McCall150b4622011-01-26 04:00:11 +00002588 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCall804b8072011-01-28 10:53:53 +00002589 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2590 }
2591};
2592
2593/// A specialization of DominatingValue for RValue.
2594template <> struct DominatingValue<RValue> {
2595 typedef RValue type;
2596 class saved_type {
2597 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2598 AggregateAddress, ComplexAddress };
2599
2600 llvm::Value *Value;
2601 Kind K;
2602 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2603
2604 public:
2605 static bool needsSaving(RValue value);
2606 static saved_type save(CodeGenFunction &CGF, RValue value);
2607 RValue restore(CodeGenFunction &CGF);
2608
2609 // implementations in CGExprCXX.cpp
2610 };
2611
2612 static bool needsSaving(type value) {
2613 return saved_type::needsSaving(value);
2614 }
2615 static saved_type save(CodeGenFunction &CGF, type value) {
2616 return saved_type::save(CGF, value);
2617 }
2618 static type restore(CodeGenFunction &CGF, saved_type value) {
2619 return value.restore(CGF);
John McCall150b4622011-01-26 04:00:11 +00002620 }
2621};
2622
Reid Spencer5f016e22007-07-11 17:01:13 +00002623} // end namespace CodeGen
2624} // end namespace clang
2625
2626#endif