blob: 9acfc5e93cb04f592cfa4f49b5e72d9d279f2820 [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
Eli Friedmancec5ebd2012-02-11 02:57:39 +0000602 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
603 FieldDecl *LambdaThisCaptureField;
604
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000605 /// \brief A mapping from NRVO variables to the flags used to indicate
606 /// when the NRVO has been applied to this variable.
607 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000608
John McCallf1549f62010-07-06 01:34:17 +0000609 EHScopeStack EHStack;
610
John McCallff8e1152010-07-23 21:56:41 +0000611 /// i32s containing the indexes of the cleanup destinations.
612 llvm::AllocaInst *NormalCleanupDest;
John McCallff8e1152010-07-23 21:56:41 +0000613
614 unsigned NextCleanupDestIndex;
615
John McCall1a343eb2011-11-10 08:15:53 +0000616 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
617 CGBlockInfo *FirstBlockInfo;
618
John McCall777d6e52011-08-11 02:22:43 +0000619 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
620 llvm::BasicBlock *EHResumeBlock;
621
Bill Wendling285cfd82011-09-19 20:31:14 +0000622 /// The exception slot. All landing pads write the current exception pointer
623 /// into this alloca.
John McCallf1549f62010-07-06 01:34:17 +0000624 llvm::Value *ExceptionSlot;
625
Bill Wendling285cfd82011-09-19 20:31:14 +0000626 /// The selector slot. Under the MandatoryCleanup model, all landing pads
627 /// write the current selector value into this alloca.
John McCall93c332a2011-05-28 21:13:02 +0000628 llvm::AllocaInst *EHSelectorSlot;
629
John McCallf1549f62010-07-06 01:34:17 +0000630 /// Emits a landing pad for the current EH stack.
631 llvm::BasicBlock *EmitLandingPad();
632
633 llvm::BasicBlock *getInvokeDestImpl();
634
John McCall150b4622011-01-26 04:00:11 +0000635 template <class T>
John McCall804b8072011-01-28 10:53:53 +0000636 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
637 return DominatingValue<T>::save(*this, value);
John McCall150b4622011-01-26 04:00:11 +0000638 }
639
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000640public:
Anders Carlssonfa1f7562009-02-10 06:07:49 +0000641 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
642 /// rethrows.
Chris Lattner686775d2011-07-20 06:58:45 +0000643 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stump0dd9e882009-02-08 23:14:22 +0000644
John McCalld768e9d2011-06-22 02:32:12 +0000645 /// A class controlling the emission of a finally block.
646 class FinallyInfo {
647 /// Where the catchall's edge through the cleanup should go.
648 JumpDest RethrowDest;
Anders Carlssonbb66f9f2009-02-08 07:46:24 +0000649
John McCalld768e9d2011-06-22 02:32:12 +0000650 /// A function to call to enter the catch.
651 llvm::Constant *BeginCatchFn;
652
653 /// An i1 variable indicating whether or not the @finally is
654 /// running for an exception.
655 llvm::AllocaInst *ForEHVar;
656
657 /// An i8* variable into which the exception pointer to rethrow
658 /// has been saved.
659 llvm::AllocaInst *SavedExnVar;
660
661 public:
662 void enter(CodeGenFunction &CGF, const Stmt *Finally,
663 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
664 llvm::Constant *rethrowFn);
665 void exit(CodeGenFunction &CGF);
666 };
Mike Stumpd88ea562009-12-09 03:35:49 +0000667
John McCall150b4622011-01-26 04:00:11 +0000668 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
669 /// current full-expression. Safe against the possibility that
670 /// we're currently inside a conditionally-evaluated expression.
John McCall3ad32c82011-01-28 08:37:24 +0000671 template <class T, class A0>
672 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
673 // If we're not in a conditional branch, or if none of the
674 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000675 if (!isInConditionalBranch())
676 return EHStack.pushCleanup<T>(kind, a0);
John McCall3ad32c82011-01-28 08:37:24 +0000677
John McCall804b8072011-01-28 10:53:53 +0000678 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCall3ad32c82011-01-28 08:37:24 +0000679
680 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
681 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
682 initFullExprCleanup();
683 }
684
685 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
686 /// current full-expression. Safe against the possibility that
687 /// we're currently inside a conditionally-evaluated expression.
John McCall150b4622011-01-26 04:00:11 +0000688 template <class T, class A0, class A1>
689 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
690 // If we're not in a conditional branch, or if none of the
691 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000692 if (!isInConditionalBranch())
693 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCall150b4622011-01-26 04:00:11 +0000694
John McCall804b8072011-01-28 10:53:53 +0000695 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
696 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCall150b4622011-01-26 04:00:11 +0000697
698 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCall3ad32c82011-01-28 08:37:24 +0000699 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
700 initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000701 }
702
Douglas Gregord7b23162011-06-22 16:12:01 +0000703 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
704 /// current full-expression. Safe against the possibility that
705 /// we're currently inside a conditionally-evaluated expression.
706 template <class T, class A0, class A1, class A2>
707 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
708 // If we're not in a conditional branch, or if none of the
709 // arguments requires saving, then use the unconditional cleanup.
710 if (!isInConditionalBranch()) {
John McCallc4a1a842011-07-12 00:15:30 +0000711 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregord7b23162011-06-22 16:12:01 +0000712 }
713
714 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
715 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
716 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
717
718 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
719 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
720 initFullExprCleanup();
721 }
722
John McCall9928c482011-07-12 16:41:08 +0000723 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
724 /// current full-expression. Safe against the possibility that
725 /// we're currently inside a conditionally-evaluated expression.
726 template <class T, class A0, class A1, class A2, class A3>
727 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
728 // If we're not in a conditional branch, or if none of the
729 // arguments requires saving, then use the unconditional cleanup.
730 if (!isInConditionalBranch()) {
731 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
732 }
733
734 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
735 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
736 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
737 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
738
739 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
740 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
741 a2_saved, a3_saved);
742 initFullExprCleanup();
743 }
744
John McCall6f103ba2011-11-10 10:43:54 +0000745 /// Set up the last cleaup that was pushed as a conditional
746 /// full-expression cleanup.
747 void initFullExprCleanup();
748
John McCallf1549f62010-07-06 01:34:17 +0000749 /// PushDestructorCleanup - Push a cleanup to call the
750 /// complete-object destructor of an object of the given type at the
751 /// given address. Does nothing if T is not a C++ class type with a
752 /// non-trivial destructor.
753 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
754
John McCall81407d42010-07-21 06:29:51 +0000755 /// PushDestructorCleanup - Push a cleanup to call the
756 /// complete-object variant of the given destructor on the object at
757 /// the given address.
758 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
759 llvm::Value *Addr);
760
John McCallf1549f62010-07-06 01:34:17 +0000761 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
762 /// process all branch fixups.
John McCallff8e1152010-07-23 21:56:41 +0000763 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallf1549f62010-07-06 01:34:17 +0000764
John McCall7d8647f2010-09-14 07:57:04 +0000765 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
766 /// The block cannot be reactivated. Pops it if it's the top of the
767 /// stack.
John McCall6f103ba2011-11-10 10:43:54 +0000768 ///
769 /// \param DominatingIP - An instruction which is known to
770 /// dominate the current IP (if set) and which lies along
771 /// all paths of execution between the current IP and the
772 /// the point at which the cleanup comes into scope.
773 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
774 llvm::Instruction *DominatingIP);
John McCall7d8647f2010-09-14 07:57:04 +0000775
776 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
777 /// Cannot be used to resurrect a deactivated cleanup.
John McCall6f103ba2011-11-10 10:43:54 +0000778 ///
779 /// \param DominatingIP - An instruction which is known to
780 /// dominate the current IP (if set) and which lies along
781 /// all paths of execution between the current IP and the
782 /// the point at which the cleanup comes into scope.
783 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
784 llvm::Instruction *DominatingIP);
John McCallcd2d2b72010-08-13 21:20:51 +0000785
John McCallf1549f62010-07-06 01:34:17 +0000786 /// \brief Enters a new scope for capturing cleanups, all of which
787 /// will be executed once the scope is exited.
788 class RunCleanupsScope {
John McCallf1549f62010-07-06 01:34:17 +0000789 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000790 bool OldDidCallStackSave;
Douglas Gregor5656e142009-11-24 21:15:44 +0000791 bool PerformCleanup;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000792
John McCallf1549f62010-07-06 01:34:17 +0000793 RunCleanupsScope(const RunCleanupsScope &); // DO NOT IMPLEMENT
794 RunCleanupsScope &operator=(const RunCleanupsScope &); // DO NOT IMPLEMENT
Douglas Gregor01234bb2009-11-24 16:43:22 +0000795
Eric Christopherc3287792011-10-19 00:43:52 +0000796 protected:
797 CodeGenFunction& CGF;
798
Douglas Gregor01234bb2009-11-24 16:43:22 +0000799 public:
800 /// \brief Enter a new cleanup scope.
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000801 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christopherc3287792011-10-19 00:43:52 +0000802 : PerformCleanup(true), CGF(CGF)
Douglas Gregor5656e142009-11-24 21:15:44 +0000803 {
John McCallf1549f62010-07-06 01:34:17 +0000804 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor01234bb2009-11-24 16:43:22 +0000805 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis4ada2ca2010-09-14 00:42:34 +0000806 CGF.DidCallStackSave = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000807 }
808
809 /// \brief Exit this cleanup scope, emitting any accumulated
810 /// cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000811 ~RunCleanupsScope() {
Douglas Gregor5656e142009-11-24 21:15:44 +0000812 if (PerformCleanup) {
813 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000814 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000815 }
816 }
817
818 /// \brief Determine whether this scope requires any cleanups.
819 bool requiresCleanups() const {
John McCallf1549f62010-07-06 01:34:17 +0000820 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor5656e142009-11-24 21:15:44 +0000821 }
822
823 /// \brief Force the emission of cleanups now, instead of waiting
824 /// until this object is destroyed.
825 void ForceCleanup() {
826 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor01234bb2009-11-24 16:43:22 +0000827 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000828 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000829 PerformCleanup = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000830 }
831 };
832
Eric Christopherc3287792011-10-19 00:43:52 +0000833 class LexicalScope: protected RunCleanupsScope {
834 SourceRange Range;
835 bool PopDebugStack;
836
837 LexicalScope(const LexicalScope &); // DO NOT IMPLEMENT THESE
838 LexicalScope &operator=(const LexicalScope &);
839
840 public:
841 /// \brief Enter a new cleanup scope.
842 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
843 : RunCleanupsScope(CGF), Range(Range), PopDebugStack(true) {
844 if (CGDebugInfo *DI = CGF.getDebugInfo())
845 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
846 }
847
848 /// \brief Exit this cleanup scope, emitting any accumulated
849 /// cleanups.
850 ~LexicalScope() {
851 if (PopDebugStack) {
852 CGDebugInfo *DI = CGF.getDebugInfo();
853 if (DI) DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
854 }
855 }
856
857 /// \brief Force the emission of cleanups now, instead of waiting
858 /// until this object is destroyed.
859 void ForceCleanup() {
860 RunCleanupsScope::ForceCleanup();
861 if (CGDebugInfo *DI = CGF.getDebugInfo()) {
862 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
863 PopDebugStack = false;
864 }
865 }
866 };
867
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000868
John McCallf1549f62010-07-06 01:34:17 +0000869 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
870 /// the cleanup blocks that have been added.
871 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000872
John McCallff8e1152010-07-23 21:56:41 +0000873 void ResolveBranchFixups(llvm::BasicBlock *Target);
874
John McCallf1549f62010-07-06 01:34:17 +0000875 /// The given basic block lies in the current EH scope, but may be a
876 /// target of a potentially scope-crossing jump; get a stable handle
877 /// to which we can perform this jump later.
John McCallff8e1152010-07-23 21:56:41 +0000878 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCall413e6772010-07-28 01:07:35 +0000879 return JumpDest(Target,
880 EHStack.getInnermostNormalCleanup(),
881 NextCleanupDestIndex++);
John McCallf1549f62010-07-06 01:34:17 +0000882 }
Anders Carlssonc71c8452009-02-07 23:50:39 +0000883
John McCallf1549f62010-07-06 01:34:17 +0000884 /// The given basic block lies in the current EH scope, but may be a
885 /// target of a potentially scope-crossing jump; get a stable handle
886 /// to which we can perform this jump later.
Chris Lattner686775d2011-07-20 06:58:45 +0000887 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallff8e1152010-07-23 21:56:41 +0000888 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallf1549f62010-07-06 01:34:17 +0000889 }
890
891 /// EmitBranchThroughCleanup - Emit a branch from the current insert
892 /// block through the normal cleanup handling code (if any) and then
893 /// on to \arg Dest.
894 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerb11f9192011-04-17 00:54:30 +0000895
896 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
897 /// specified destination obviously has no cleanups to run. 'false' is always
898 /// a conservatively correct answer for this method.
899 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallf1549f62010-07-06 01:34:17 +0000900
John McCall777d6e52011-08-11 02:22:43 +0000901 /// popCatchScope - Pops the catch scope at the top of the EHScope
902 /// stack, emitting any required code (other than the catch handlers
903 /// themselves).
904 void popCatchScope();
John McCallff8e1152010-07-23 21:56:41 +0000905
John McCall777d6e52011-08-11 02:22:43 +0000906 llvm::BasicBlock *getEHResumeBlock();
907 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stump0dd9e882009-02-08 23:14:22 +0000908
John McCall150b4622011-01-26 04:00:11 +0000909 /// An object to manage conditionally-evaluated expressions.
910 class ConditionalEvaluation {
911 llvm::BasicBlock *StartBB;
Mike Stump1eb44332009-09-09 15:08:12 +0000912
John McCall150b4622011-01-26 04:00:11 +0000913 public:
914 ConditionalEvaluation(CodeGenFunction &CGF)
915 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000916
John McCall150b4622011-01-26 04:00:11 +0000917 void begin(CodeGenFunction &CGF) {
918 assert(CGF.OutermostConditional != this);
919 if (!CGF.OutermostConditional)
920 CGF.OutermostConditional = this;
921 }
922
923 void end(CodeGenFunction &CGF) {
924 assert(CGF.OutermostConditional != 0);
925 if (CGF.OutermostConditional == this)
926 CGF.OutermostConditional = 0;
927 }
928
929 /// Returns a block which will be executed prior to each
930 /// evaluation of the conditional code.
931 llvm::BasicBlock *getStartingBlock() const {
932 return StartBB;
933 }
934 };
Mike Stump1eb44332009-09-09 15:08:12 +0000935
John McCall3019c442010-09-17 00:50:28 +0000936 /// isInConditionalBranch - Return true if we're currently emitting
937 /// one branch or the other of a conditional expression.
John McCall150b4622011-01-26 04:00:11 +0000938 bool isInConditionalBranch() const { return OutermostConditional != 0; }
939
John McCall6f103ba2011-11-10 10:43:54 +0000940 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
941 assert(isInConditionalBranch());
942 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
943 new llvm::StoreInst(value, addr, &block->back());
944 }
945
John McCall150b4622011-01-26 04:00:11 +0000946 /// An RAII object to record that we're evaluating a statement
947 /// expression.
948 class StmtExprEvaluation {
949 CodeGenFunction &CGF;
950
951 /// We have to save the outermost conditional: cleanups in a
952 /// statement expression aren't conditional just because the
953 /// StmtExpr is.
954 ConditionalEvaluation *SavedOutermostConditional;
955
956 public:
957 StmtExprEvaluation(CodeGenFunction &CGF)
958 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
959 CGF.OutermostConditional = 0;
960 }
961
962 ~StmtExprEvaluation() {
963 CGF.OutermostConditional = SavedOutermostConditional;
964 CGF.EnsureInsertPoint();
965 }
966 };
John McCalle996ffd2011-02-16 08:02:54 +0000967
John McCall56ca35d2011-02-17 10:25:35 +0000968 /// An object which temporarily prevents a value from being
969 /// destroyed by aggressive peephole optimizations that assume that
970 /// all uses of a value have been realized in the IR.
971 class PeepholeProtection {
972 llvm::Instruction *Inst;
973 friend class CodeGenFunction;
974
975 public:
976 PeepholeProtection() : Inst(0) {}
John McCall4b9c2d22011-11-06 09:01:30 +0000977 };
John McCall56ca35d2011-02-17 10:25:35 +0000978
John McCall4b9c2d22011-11-06 09:01:30 +0000979 /// A non-RAII class containing all the information about a bound
980 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
981 /// this which makes individual mappings very simple; using this
982 /// class directly is useful when you have a variable number of
983 /// opaque values or don't want the RAII functionality for some
984 /// reason.
985 class OpaqueValueMappingData {
John McCalle996ffd2011-02-16 08:02:54 +0000986 const OpaqueValueExpr *OpaqueValue;
John McCall56ca35d2011-02-17 10:25:35 +0000987 bool BoundLValue;
988 CodeGenFunction::PeepholeProtection Protection;
John McCalle996ffd2011-02-16 08:02:54 +0000989
John McCall4b9c2d22011-11-06 09:01:30 +0000990 OpaqueValueMappingData(const OpaqueValueExpr *ov,
991 bool boundLValue)
992 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCalle996ffd2011-02-16 08:02:54 +0000993 public:
John McCall4b9c2d22011-11-06 09:01:30 +0000994 OpaqueValueMappingData() : OpaqueValue(0) {}
995
John McCall56ca35d2011-02-17 10:25:35 +0000996 static bool shouldBindAsLValue(const Expr *expr) {
John McCalla5493f82011-11-08 22:54:08 +0000997 // gl-values should be bound as l-values for obvious reasons.
998 // Records should be bound as l-values because IR generation
999 // always keeps them in memory. Expressions of function type
1000 // act exactly like l-values but are formally required to be
1001 // r-values in C.
1002 return expr->isGLValue() ||
1003 expr->getType()->isRecordType() ||
1004 expr->getType()->isFunctionType();
John McCall56ca35d2011-02-17 10:25:35 +00001005 }
1006
John McCall4b9c2d22011-11-06 09:01:30 +00001007 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1008 const OpaqueValueExpr *ov,
1009 const Expr *e) {
1010 if (shouldBindAsLValue(ov))
1011 return bind(CGF, ov, CGF.EmitLValue(e));
1012 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1013 }
1014
1015 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1016 const OpaqueValueExpr *ov,
1017 const LValue &lv) {
1018 assert(shouldBindAsLValue(ov));
1019 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1020 return OpaqueValueMappingData(ov, true);
1021 }
1022
1023 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1024 const OpaqueValueExpr *ov,
1025 const RValue &rv) {
1026 assert(!shouldBindAsLValue(ov));
1027 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1028
1029 OpaqueValueMappingData data(ov, false);
1030
1031 // Work around an extremely aggressive peephole optimization in
1032 // EmitScalarConversion which assumes that all other uses of a
1033 // value are extant.
1034 data.Protection = CGF.protectFromPeepholes(rv);
1035
1036 return data;
1037 }
1038
1039 bool isValid() const { return OpaqueValue != 0; }
1040 void clear() { OpaqueValue = 0; }
1041
1042 void unbind(CodeGenFunction &CGF) {
1043 assert(OpaqueValue && "no data to unbind!");
1044
1045 if (BoundLValue) {
1046 CGF.OpaqueLValues.erase(OpaqueValue);
1047 } else {
1048 CGF.OpaqueRValues.erase(OpaqueValue);
1049 CGF.unprotectFromPeepholes(Protection);
1050 }
1051 }
1052 };
1053
1054 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1055 class OpaqueValueMapping {
1056 CodeGenFunction &CGF;
1057 OpaqueValueMappingData Data;
1058
1059 public:
1060 static bool shouldBindAsLValue(const Expr *expr) {
1061 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1062 }
1063
John McCall56ca35d2011-02-17 10:25:35 +00001064 /// Build the opaque value mapping for the given conditional
1065 /// operator if it's the GNU ?: extension. This is a common
1066 /// enough pattern that the convenience operator is really
1067 /// helpful.
1068 ///
1069 OpaqueValueMapping(CodeGenFunction &CGF,
1070 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCall4b9c2d22011-11-06 09:01:30 +00001071 if (isa<ConditionalOperator>(op))
1072 // Leave Data empty.
John McCall56ca35d2011-02-17 10:25:35 +00001073 return;
John McCall56ca35d2011-02-17 10:25:35 +00001074
1075 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCall4b9c2d22011-11-06 09:01:30 +00001076 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1077 e->getCommon());
John McCall56ca35d2011-02-17 10:25:35 +00001078 }
1079
John McCalle996ffd2011-02-16 08:02:54 +00001080 OpaqueValueMapping(CodeGenFunction &CGF,
1081 const OpaqueValueExpr *opaqueValue,
John McCall56ca35d2011-02-17 10:25:35 +00001082 LValue lvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001083 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCall56ca35d2011-02-17 10:25:35 +00001084 }
1085
1086 OpaqueValueMapping(CodeGenFunction &CGF,
1087 const OpaqueValueExpr *opaqueValue,
1088 RValue rvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001089 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCalle996ffd2011-02-16 08:02:54 +00001090 }
1091
1092 void pop() {
John McCall4b9c2d22011-11-06 09:01:30 +00001093 Data.unbind(CGF);
1094 Data.clear();
John McCalle996ffd2011-02-16 08:02:54 +00001095 }
1096
1097 ~OpaqueValueMapping() {
John McCall4b9c2d22011-11-06 09:01:30 +00001098 if (Data.isValid()) Data.unbind(CGF);
John McCalle996ffd2011-02-16 08:02:54 +00001099 }
1100 };
Fariborz Jahaniane2204552010-11-16 19:29:39 +00001101
1102 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1103 /// number that holds the value.
1104 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian52a80e12011-01-26 23:08:27 +00001105
1106 /// BuildBlockByrefAddress - Computes address location of the
1107 /// variable which is declared as __block.
1108 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1109 const VarDecl *V);
Chris Lattner7f02f722007-08-24 05:35:26 +00001110private:
Chris Lattnerd9becd12009-10-28 23:59:40 +00001111 CGDebugInfo *DebugInfo;
Devang Patelaa112892011-03-07 18:45:56 +00001112 bool DisableDebugInfo;
Mike Stump09429b92009-02-17 17:00:02 +00001113
John McCall93c332a2011-05-28 21:13:02 +00001114 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1115 /// calling llvm.stacksave for multiple VLAs in the same scope.
1116 bool DidCallStackSave;
1117
Mike Stumpf71d2322009-11-30 20:08:49 +00001118 /// IndirectBranch - The first time an indirect goto is seen we create a block
1119 /// with an indirect branch. Every time we see the address of a label taken,
1120 /// we add the label to the indirect goto. Every subsequent indirect goto is
1121 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattnerd9becd12009-10-28 23:59:40 +00001122 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001123
Mike Stump0dd9e882009-02-08 23:14:22 +00001124 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1125 /// decls.
John McCall6b5a61b2011-02-07 10:33:21 +00001126 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1127 DeclMapTy LocalDeclMap;
Reid Spencer5f016e22007-07-11 17:01:13 +00001128
1129 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001130 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001131
Mike Stump0dd9e882009-02-08 23:14:22 +00001132 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone4b6d342009-02-10 05:52:02 +00001133 // statements should jump to.
Chris Lattnerda138702007-07-16 21:28:45 +00001134 struct BreakContinue {
John McCallf1549f62010-07-06 01:34:17 +00001135 BreakContinue(JumpDest Break, JumpDest Continue)
1136 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stump0dd9e882009-02-08 23:14:22 +00001137
John McCallf1549f62010-07-06 01:34:17 +00001138 JumpDest BreakBlock;
1139 JumpDest ContinueBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001140 };
Chris Lattner686775d2011-07-20 06:58:45 +00001141 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +00001142
Zhongxing Xu170fd492012-01-14 09:08:15 +00001143 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stump0dd9e882009-02-08 23:14:22 +00001144 /// current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +00001145 llvm::SwitchInst *SwitchInsn;
1146
Mike Stump0dd9e882009-02-08 23:14:22 +00001147 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel80fd5f92007-10-09 17:08:50 +00001148 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +00001149 llvm::BasicBlock *CaseRangeBlock;
1150
John McCall56ca35d2011-02-17 10:25:35 +00001151 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCalle996ffd2011-02-16 08:02:54 +00001152 /// expressions.
John McCall56ca35d2011-02-17 10:25:35 +00001153 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1154 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCalle996ffd2011-02-16 08:02:54 +00001155
Mike Stump0dd9e882009-02-08 23:14:22 +00001156 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001157 // We track this by the size expression rather than the type itself because
1158 // in certain situations, like a const qualifier applied to an VLA typedef,
1159 // multiple VLA types can share the same size expression.
Mike Stump0dd9e882009-02-08 23:14:22 +00001160 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1161 // enter/leave scopes.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001162 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001163
John McCallf1549f62010-07-06 01:34:17 +00001164 /// A block containing a single 'unreachable' instruction. Created
1165 /// lazily by getUnreachableBlock().
1166 llvm::BasicBlock *UnreachableBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001167
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001168 /// CXXThisDecl - When generating code for a C++ member function,
1169 /// this will hold the implicit 'this' declaration.
Eli Friedmancec5ebd2012-02-11 02:57:39 +00001170 ImplicitParamDecl *CXXABIThisDecl;
1171 llvm::Value *CXXABIThisValue;
John McCall25049412010-02-16 22:04:33 +00001172 llvm::Value *CXXThisValue;
Mike Stump1eb44332009-09-09 15:08:12 +00001173
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001174 /// CXXVTTDecl - When generating code for a base object constructor or
1175 /// base object destructor with virtual bases, this will hold the implicit
1176 /// VTT parameter.
1177 ImplicitParamDecl *CXXVTTDecl;
John McCall25049412010-02-16 22:04:33 +00001178 llvm::Value *CXXVTTValue;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001179
John McCall150b4622011-01-26 04:00:11 +00001180 /// OutermostConditional - Points to the outermost active
1181 /// conditional control. This is used so that we know if a
1182 /// temporary should be destroyed conditionally.
1183 ConditionalEvaluation *OutermostConditional;
Mike Stump1eb44332009-09-09 15:08:12 +00001184
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001185
1186 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1187 /// type as well as the field number that contains the actual data.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001188 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001189 unsigned> > ByRefValueInfo;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001190
John McCallf1549f62010-07-06 01:34:17 +00001191 llvm::BasicBlock *TerminateLandingPad;
Mike Stump182f3832009-12-10 00:02:42 +00001192 llvm::BasicBlock *TerminateHandler;
Chris Lattner83252dc2010-07-20 21:07:09 +00001193 llvm::BasicBlock *TrapBB;
Eli Friedman94067052009-12-10 02:21:21 +00001194
Reid Spencer5f016e22007-07-11 17:01:13 +00001195public:
1196 CodeGenFunction(CodeGenModule &cgm);
John McCall1a343eb2011-11-10 08:15:53 +00001197 ~CodeGenFunction();
Mike Stump0dd9e882009-02-08 23:14:22 +00001198
John McCall1e7fe752010-09-02 09:58:18 +00001199 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCallf2aac842011-05-15 02:34:36 +00001200 ASTContext &getContext() const { return CGM.getContext(); }
Devang Patelaa112892011-03-07 18:45:56 +00001201 CGDebugInfo *getDebugInfo() {
1202 if (DisableDebugInfo)
1203 return NULL;
1204 return DebugInfo;
1205 }
1206 void disableDebugInfo() { DisableDebugInfo = true; }
1207 void enableDebugInfo() { DisableDebugInfo = false; }
1208
John McCallf85e1932011-06-15 23:02:42 +00001209 bool shouldUseFusedARCCalls() {
1210 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1211 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001212
David Blaikie4e4d0842012-03-11 07:00:24 +00001213 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCalld16c2cf2011-02-08 08:22:06 +00001214
Bill Wendling285cfd82011-09-19 20:31:14 +00001215 /// Returns a pointer to the function's exception object and selector slot,
1216 /// which is assigned in every landing pad.
John McCallf1549f62010-07-06 01:34:17 +00001217 llvm::Value *getExceptionSlot();
John McCall93c332a2011-05-28 21:13:02 +00001218 llvm::Value *getEHSelectorSlot();
John McCallf1549f62010-07-06 01:34:17 +00001219
Bill Wendlingae270592011-09-15 18:57:19 +00001220 /// Returns the contents of the function's exception object and selector
1221 /// slots.
1222 llvm::Value *getExceptionFromSlot();
1223 llvm::Value *getSelectorFromSlot();
1224
John McCallff8e1152010-07-23 21:56:41 +00001225 llvm::Value *getNormalCleanupDestSlot();
John McCallff8e1152010-07-23 21:56:41 +00001226
John McCallf1549f62010-07-06 01:34:17 +00001227 llvm::BasicBlock *getUnreachableBlock() {
1228 if (!UnreachableBlock) {
1229 UnreachableBlock = createBasicBlock("unreachable");
1230 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1231 }
1232 return UnreachableBlock;
1233 }
1234
1235 llvm::BasicBlock *getInvokeDest() {
1236 if (!EHStack.requiresLandingPad()) return 0;
1237 return getInvokeDestImpl();
1238 }
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001239
John McCalld16c2cf2011-02-08 08:22:06 +00001240 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Anderson69243822009-07-13 04:10:07 +00001241
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001242 //===--------------------------------------------------------------------===//
John McCallbdc4d802011-07-09 01:37:26 +00001243 // Cleanups
1244 //===--------------------------------------------------------------------===//
1245
1246 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1247
John McCall2673c682011-07-11 08:38:19 +00001248 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1249 llvm::Value *arrayEndPointer,
1250 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001251 Destroyer *destroyer);
John McCall2673c682011-07-11 08:38:19 +00001252 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1253 llvm::Value *arrayEnd,
1254 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001255 Destroyer *destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001256
John McCall9928c482011-07-12 16:41:08 +00001257 void pushDestroy(QualType::DestructionKind dtorKind,
1258 llvm::Value *addr, QualType type);
John McCallbdc4d802011-07-09 01:37:26 +00001259 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001260 Destroyer *destroyer, bool useEHCleanupForArray);
1261 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001262 bool useEHCleanupForArray);
John McCalla91f6662011-07-13 03:01:35 +00001263 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1264 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001265 Destroyer *destroyer,
John McCalla91f6662011-07-13 03:01:35 +00001266 bool useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001267 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001268 QualType type, Destroyer *destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001269 bool checkZeroLength, bool useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001270
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001271 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall9928c482011-07-12 16:41:08 +00001272
John McCallbdc4d802011-07-09 01:37:26 +00001273 /// Determines whether an EH cleanup is required to destroy a type
1274 /// with the given destruction kind.
1275 bool needsEHCleanup(QualType::DestructionKind kind) {
1276 switch (kind) {
1277 case QualType::DK_none:
1278 return false;
1279 case QualType::DK_cxx_destructor:
1280 case QualType::DK_objc_weak_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001281 return getLangOpts().Exceptions;
John McCallbdc4d802011-07-09 01:37:26 +00001282 case QualType::DK_objc_strong_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001283 return getLangOpts().Exceptions &&
John McCallbdc4d802011-07-09 01:37:26 +00001284 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1285 }
1286 llvm_unreachable("bad destruction kind");
1287 }
1288
John McCall9928c482011-07-12 16:41:08 +00001289 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1290 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1291 }
1292
John McCallbdc4d802011-07-09 01:37:26 +00001293 //===--------------------------------------------------------------------===//
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001294 // Objective-C
1295 //===--------------------------------------------------------------------===//
1296
Chris Lattner391d77a2008-03-30 23:03:07 +00001297 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001298
Mike Stump0dd9e882009-02-08 23:14:22 +00001299 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patel8d3f8972011-05-19 23:37:41 +00001300 const ObjCContainerDecl *CD,
1301 SourceLocation StartLoc);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001302
Mike Stump0dd9e882009-02-08 23:14:22 +00001303 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001304 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1305 const ObjCPropertyImplDecl *PID);
John McCall1e1f4872011-09-13 03:34:09 +00001306 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001307 const ObjCPropertyImplDecl *propImpl,
1308 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian2846b972011-02-18 19:15:13 +00001309
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001310 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1311 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001312
Mike Stump0dd9e882009-02-08 23:14:22 +00001313 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1314 /// for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001315 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1316 const ObjCPropertyImplDecl *PID);
John McCall71c758d2011-09-10 09:17:20 +00001317 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001318 const ObjCPropertyImplDecl *propImpl,
1319 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001320 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001321 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001322
Mike Stump4e7a1f72009-02-21 20:00:35 +00001323 //===--------------------------------------------------------------------===//
1324 // Block Bits
1325 //===--------------------------------------------------------------------===//
1326
John McCall6b5a61b2011-02-07 10:33:21 +00001327 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall1a343eb2011-11-10 08:15:53 +00001328 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1329 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garst2a7eb282010-02-23 21:51:17 +00001330 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00001331 const CGBlockInfo &Info,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001332 llvm::StructType *,
John McCalld16c2cf2011-02-08 08:22:06 +00001333 llvm::Constant *BlockVarLayout);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001334
Fariborz Jahanian564360b2010-06-24 00:08:06 +00001335 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall6b5a61b2011-02-07 10:33:21 +00001336 const CGBlockInfo &Info,
Mike Stump6cc88f72009-03-20 21:53:12 +00001337 const Decl *OuterFuncDecl,
Eli Friedman64bee652012-02-25 02:48:22 +00001338 const DeclMapTy &ldm,
1339 bool IsLambdaConversionToBlock);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001340
John McCalld16c2cf2011-02-08 08:22:06 +00001341 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1342 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00001343 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1344 const ObjCPropertyImplDecl *PID);
1345 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1346 const ObjCPropertyImplDecl *PID);
Eli Friedmancae40c42012-02-28 01:08:45 +00001347 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCalld16c2cf2011-02-08 08:22:06 +00001348
John McCalld16c2cf2011-02-08 08:22:06 +00001349 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1350
John McCall5af02db2011-03-31 01:59:53 +00001351 class AutoVarEmission;
1352
1353 void emitByrefStructureInit(const AutoVarEmission &emission);
1354 void enterByrefCleanup(const AutoVarEmission &emission);
1355
John McCall6b5a61b2011-02-07 10:33:21 +00001356 llvm::Value *LoadBlockStruct() {
1357 assert(BlockPointer && "no block pointer set!");
1358 return BlockPointer;
1359 }
Mike Stump4e7a1f72009-02-21 20:00:35 +00001360
John McCallea1471e2010-05-20 01:18:31 +00001361 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCallf4b88a42012-03-10 09:33:50 +00001362 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall6b5a61b2011-02-07 10:33:21 +00001363 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001364 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stumpdab514f2009-03-04 03:23:46 +00001365
John McCalld26bc762011-03-09 04:27:21 +00001366 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1367 const CGFunctionInfo &FnInfo);
Anders Carlsson0ff8baf2009-09-11 00:07:24 +00001368 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbar7c086512008-09-09 23:14:03 +00001369 llvm::Function *Fn,
John McCalld26bc762011-03-09 04:27:21 +00001370 const CGFunctionInfo &FnInfo,
Daniel Dunbar2284ac92008-10-18 18:22:23 +00001371 const FunctionArgList &Args,
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00001372 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001373
John McCall9fc6a772010-02-19 09:25:03 +00001374 void EmitConstructorBody(FunctionArgList &Args);
1375 void EmitDestructorBody(FunctionArgList &Args);
1376 void EmitFunctionBody(FunctionArgList &Args);
John McCalla355e072010-02-18 03:17:58 +00001377
Eli Friedman64bee652012-02-25 02:48:22 +00001378 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1379 CallArgList &CallArgs);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001380 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman64bee652012-02-25 02:48:22 +00001381 void EmitLambdaBlockInvokeBody();
Douglas Gregor27dd7d92012-02-17 03:02:34 +00001382 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1383 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001384
Mike Stump0dd9e882009-02-08 23:14:22 +00001385 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1386 /// emission when possible.
Daniel Dunbar1c1d6072009-01-26 23:27:52 +00001387 void EmitReturnBlock();
1388
Mike Stump0dd9e882009-02-08 23:14:22 +00001389 /// FinishFunction - Complete IR generation of the current function. It is
1390 /// legal to call this function even if there is no current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001391 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001392
Anders Carlsson519c3282010-03-24 00:39:18 +00001393 /// GenerateThunk - Generate a thunk for the given method.
John McCalld26bc762011-03-09 04:27:21 +00001394 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1395 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001396
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00001397 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1398 GlobalDecl GD, const ThunkInfo &Thunk);
1399
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001400 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1401 FunctionArgList &Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001402
Eli Friedmanb74ed082012-02-14 02:31:03 +00001403 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1404 ArrayRef<VarDecl *> ArrayIndexes);
1405
Anders Carlssond103f9f2010-03-28 19:40:00 +00001406 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1407 /// subobject.
1408 ///
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001409 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001410 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001411 CharUnits OffsetFromNearestVBase,
Anders Carlssond103f9f2010-03-28 19:40:00 +00001412 llvm::Constant *VTable,
1413 const CXXRecordDecl *VTableClass);
1414
1415 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001416 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001417 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001418 CharUnits OffsetFromNearestVBase,
Anders Carlsson603d6d12010-03-28 21:07:49 +00001419 bool BaseIsNonVirtualPrimaryBase,
1420 llvm::Constant *VTable,
1421 const CXXRecordDecl *VTableClass,
1422 VisitedVirtualBasesSetTy& VBases);
Eli Friedman77a259c2009-12-08 06:46:18 +00001423
Anders Carlsson603d6d12010-03-28 21:07:49 +00001424 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001425
Dan Gohman043fb9a2010-10-26 18:44:08 +00001426 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1427 /// to by This.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001428 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001429
John McCall50da2ca2010-07-21 05:30:47 +00001430 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1431 /// given phase of destruction for a destructor. The end result
1432 /// should call destructors on members and base classes in reverse
1433 /// order of their construction.
1434 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001435
Chris Lattner7255a2d2010-06-22 00:03:40 +00001436 /// ShouldInstrumentFunction - Return true if the current function should be
1437 /// instrumented with __cyg_profile_func_* calls
1438 bool ShouldInstrumentFunction();
1439
1440 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1441 /// instrumentation function with the current function and the call site, if
1442 /// function instrumentation is enabled.
1443 void EmitFunctionInstrumentation(const char *Fn);
1444
Roman Divackybe4c8702011-02-10 16:52:03 +00001445 /// EmitMCountInstrumentation - Emit call to .mcount.
1446 void EmitMCountInstrumentation();
1447
Mike Stump0dd9e882009-02-08 23:14:22 +00001448 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1449 /// arguments for the given function. This is also responsible for naming the
1450 /// LLVM function arguments.
Daniel Dunbar88b53962009-02-02 22:03:45 +00001451 void EmitFunctionProlog(const CGFunctionInfo &FI,
1452 llvm::Function *Fn,
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001453 const FunctionArgList &Args);
1454
Mike Stump0dd9e882009-02-08 23:14:22 +00001455 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1456 /// given temporary.
Chris Lattner35b21b82010-06-27 01:06:27 +00001457 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001458
Mike Stumpcce3d4f2009-12-07 23:38:24 +00001459 /// EmitStartEHSpec - Emit the start of the exception spec.
1460 void EmitStartEHSpec(const Decl *D);
1461
1462 /// EmitEndEHSpec - Emit the end of the exception spec.
1463 void EmitEndEHSpec(const Decl *D);
1464
John McCallf1549f62010-07-06 01:34:17 +00001465 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1466 llvm::BasicBlock *getTerminateLandingPad();
1467
1468 /// getTerminateHandler - Return a handler (not a landing pad, just
1469 /// a catch handler) that just calls terminate. This is used when
1470 /// a terminate scope encloses a try.
Mike Stump9b39c512009-12-09 22:59:31 +00001471 llvm::BasicBlock *getTerminateHandler();
1472
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001473 llvm::Type *ConvertTypeForMem(QualType T);
1474 llvm::Type *ConvertType(QualType T);
1475 llvm::Type *ConvertType(const TypeDecl *T) {
John McCallbff225e2010-02-16 04:15:37 +00001476 return ConvertType(getContext().getTypeDeclType(T));
1477 }
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001478
Mike Stump0dd9e882009-02-08 23:14:22 +00001479 /// LoadObjCSelf - Load the value of self. This function is only valid while
1480 /// generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001481 llvm::Value *LoadObjCSelf();
Mike Stump0dd9e882009-02-08 23:14:22 +00001482
1483 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001484 QualType TypeOfSelfObject();
Chris Lattner41110242008-06-17 18:05:57 +00001485
Reid Spencer5f016e22007-07-11 17:01:13 +00001486 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1487 /// an aggregate LLVM type or is void.
1488 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar55e87422008-11-11 02:29:29 +00001489
1490 /// createBasicBlock - Create an LLVM basic block.
Chris Lattner686775d2011-07-20 06:58:45 +00001491 llvm::BasicBlock *createBasicBlock(StringRef name = "",
John McCalld16c2cf2011-02-08 08:22:06 +00001492 llvm::Function *parent = 0,
1493 llvm::BasicBlock *before = 0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001494#ifdef NDEBUG
John McCalld16c2cf2011-02-08 08:22:06 +00001495 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001496#else
John McCalld16c2cf2011-02-08 08:22:06 +00001497 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001498#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +00001499 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001500
Reid Spencer5f016e22007-07-11 17:01:13 +00001501 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1502 /// label maps to.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001503 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001504
Mike Stumpf71d2322009-11-30 20:08:49 +00001505 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1506 /// another basic block, simplify it. This assumes that no other code could
1507 /// potentially reference the basic block.
Daniel Dunbaraa5bd872009-04-01 04:37:47 +00001508 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1509
Mike Stump0dd9e882009-02-08 23:14:22 +00001510 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1511 /// adding a fall-through branch from the current insert block if
1512 /// necessary. It is legal to call this function even if there is no current
1513 /// insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001514 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001515 /// IsFinished - If true, indicates that the caller has finished emitting
1516 /// branches to the given block and does not expect to emit code into it. This
1517 /// means the block can be ignored if it is unreachable.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001518 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +00001519
John McCall777d6e52011-08-11 02:22:43 +00001520 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1521 /// near its uses, and leave the insertion point in it.
1522 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1523
Mike Stump0dd9e882009-02-08 23:14:22 +00001524 /// EmitBranch - Emit a branch to the specified basic block from the current
1525 /// insert block, taking care to avoid creation of branches from dummy
1526 /// blocks. It is legal to call this function even if there is no current
1527 /// insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +00001528 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001529 /// This function clears the current insertion point. The caller should follow
1530 /// calls to this function with calls to Emit*Block prior to generation new
1531 /// code.
Daniel Dunbard57a8712008-11-11 09:41:28 +00001532 void EmitBranch(llvm::BasicBlock *Block);
1533
Mike Stump0dd9e882009-02-08 23:14:22 +00001534 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1535 /// indicates that the current code being emitted is unreachable.
1536 bool HaveInsertPoint() const {
Daniel Dunbara448fb22008-11-11 23:11:34 +00001537 return Builder.GetInsertBlock() != 0;
1538 }
1539
Mike Stump0dd9e882009-02-08 23:14:22 +00001540 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1541 /// emitted IR has a place to go. Note that by definition, if this function
1542 /// creates a block then that block is unreachable; callers may do better to
1543 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001544 void EnsureInsertPoint() {
1545 if (!HaveInsertPoint())
1546 EmitBlock(createBasicBlock());
1547 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001548
Daniel Dunbar488e9932008-08-16 00:56:44 +00001549 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +00001550 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +00001551 void ErrorUnsupported(const Stmt *S, const char *Type,
1552 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +00001553
1554 //===--------------------------------------------------------------------===//
1555 // Helpers
1556 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001557
Eli Friedman6da2c712011-12-03 04:14:32 +00001558 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1559 CharUnits Alignment = CharUnits()) {
Dan Gohman3d5aff52010-10-14 23:06:10 +00001560 return LValue::MakeAddr(V, T, Alignment, getContext(),
1561 CGM.getTBAAInfo(T));
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001562 }
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001563 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001564 CharUnits Alignment;
1565 if (!T->isIncompleteType())
1566 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001567 return LValue::MakeAddr(V, T, Alignment, getContext(),
1568 CGM.getTBAAInfo(T));
1569 }
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001570
Reid Spencer5f016e22007-07-11 17:01:13 +00001571 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbar195337d2010-02-09 02:48:28 +00001572 /// block. The caller is responsible for setting an appropriate alignment on
1573 /// the alloca.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001574 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner8cc488f2011-07-20 07:06:53 +00001575 const Twine &Name = "tmp");
Mike Stump0dd9e882009-02-08 23:14:22 +00001576
John McCallac418162010-04-22 01:10:34 +00001577 /// InitTempAlloca - Provide an initial value for the given alloca.
1578 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1579
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001580 /// CreateIRTemp - Create a temporary IR object of the given type, with
1581 /// appropriate alignment. This routine should only be used when an temporary
1582 /// value needs to be stored into an alloca (for example, to avoid explicit
1583 /// PHI construction), but the type is the IR type, not the type appropriate
1584 /// for storing in memory.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001585 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001586
Daniel Dunbar195337d2010-02-09 02:48:28 +00001587 /// CreateMemTemp - Create a temporary memory object of the given type, with
1588 /// appropriate alignment.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001589 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar195337d2010-02-09 02:48:28 +00001590
John McCall558d2ab2010-09-15 10:14:12 +00001591 /// CreateAggTemp - Create a temporary memory object for the given
1592 /// aggregate type.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001593 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedmand7722d92011-12-03 02:13:40 +00001594 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanf3940782011-12-03 00:54:26 +00001595 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1596 T.getQualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +00001597 AggValueSlot::IsNotDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001598 AggValueSlot::DoesNotNeedGCBarriers,
John McCall57cd1b82012-03-28 23:30:44 +00001599 AggValueSlot::IsNotAliased,
1600 AggValueSlot::IsCompleteObject,
1601 AggValueSlot::IsNotZeroed);
John McCall558d2ab2010-09-15 10:14:12 +00001602 }
1603
John McCalld16c2cf2011-02-08 08:22:06 +00001604 /// Emit a cast to void* in the appropriate address space.
1605 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1606
Reid Spencer5f016e22007-07-11 17:01:13 +00001607 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1608 /// expression and compare the result against zero, returning an Int1Ty value.
1609 llvm::Value *EvaluateExprAsBool(const Expr *E);
1610
John McCall2a416372010-12-05 02:00:02 +00001611 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1612 void EmitIgnoredExpr(const Expr *E);
1613
Chris Lattner9b655512007-08-31 22:49:20 +00001614 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1615 /// any type. The result is returned as an RValue struct. If this is an
1616 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1617 /// the result should be returned.
Mike Stump49d1cd52009-05-26 22:03:21 +00001618 ///
1619 /// \param IgnoreResult - True if the resulting value isn't used.
John McCall558d2ab2010-09-15 10:14:12 +00001620 RValue EmitAnyExpr(const Expr *E,
1621 AggValueSlot AggSlot = AggValueSlot::ignored(),
1622 bool IgnoreResult = false);
Devang Pateld9363c32007-09-28 21:49:18 +00001623
Mike Stump0dd9e882009-02-08 23:14:22 +00001624 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1625 // or the value of the expression, depending on how va_list is defined.
Eli Friedman4fd0aa52009-01-20 17:46:04 +00001626 llvm::Value *EmitVAListRef(const Expr *E);
1627
Mike Stump0dd9e882009-02-08 23:14:22 +00001628 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1629 /// always be accessible even if no aggregate location is provided.
John McCall558d2ab2010-09-15 10:14:12 +00001630 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar46f45b92008-09-09 01:06:48 +00001631
John McCall60d33652011-03-08 09:11:50 +00001632 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
John McCall57cd1b82012-03-28 23:30:44 +00001633 /// arbitrary expression as an initialization of the given memory
1634 /// location.
John McCall3d3ec1c2010-04-21 10:05:39 +00001635 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
John McCall57cd1b82012-03-28 23:30:44 +00001636 Qualifiers Quals);
John McCall3d3ec1c2010-04-21 10:05:39 +00001637
John McCall60d33652011-03-08 09:11:50 +00001638 /// EmitExprAsInit - Emits the code necessary to initialize a
1639 /// location in memory with the given initializer.
John McCallf85e1932011-06-15 23:02:42 +00001640 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001641 LValue lvalue, bool capturedByInit);
John McCall60d33652011-03-08 09:11:50 +00001642
Mike Stump27fe2e62009-05-23 22:29:41 +00001643 /// EmitAggregateCopy - Emit an aggrate copy.
1644 ///
1645 /// \param isVolatile - True iff either the source or the destination is
1646 /// volatile.
John McCall57cd1b82012-03-28 23:30:44 +00001647 /// \param destIsCompleteObject - True if the destination is known to be
1648 /// a complete object.
Daniel Dunbar7482d122008-09-09 20:49:46 +00001649 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedmanbd7d8282011-12-05 22:23:28 +00001650 QualType EltTy, bool isVolatile=false,
John McCall57cd1b82012-03-28 23:30:44 +00001651 unsigned alignment = 0,
1652 bool destIsCompleteObject = false);
Daniel Dunbar7482d122008-09-09 20:49:46 +00001653
Devang Patel51b09f22007-10-04 23:45:31 +00001654 /// StartBlock - Start new block named N. If insert block is a dummy block
1655 /// then reuse it.
1656 void StartBlock(const char *N);
1657
Lauro Ramos Venancio81373352008-02-26 21:41:45 +00001658 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
John McCall4c40d982010-08-31 07:33:07 +00001659 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD) {
1660 return cast<llvm::Constant>(GetAddrOfLocalVar(BVD));
1661 }
Dan Gohman4f8d1232008-05-22 00:50:06 +00001662
Anders Carlssondde0a942008-09-11 09:15:33 +00001663 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall4c40d982010-08-31 07:33:07 +00001664 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1665 llvm::Value *Res = LocalDeclMap[VD];
1666 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1667 return Res;
1668 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001669
John McCall56ca35d2011-02-17 10:25:35 +00001670 /// getOpaqueLValueMapping - Given an opaque value expression (which
1671 /// must be mapped to an l-value), return its mapping.
1672 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1673 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1674
1675 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1676 it = OpaqueLValues.find(e);
1677 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1678 return it->second;
1679 }
1680
1681 /// getOpaqueRValueMapping - Given an opaque value expression (which
1682 /// must be mapped to an r-value), return its mapping.
1683 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1684 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1685
1686 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1687 it = OpaqueRValues.find(e);
1688 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCalle996ffd2011-02-16 08:02:54 +00001689 return it->second;
1690 }
1691
Dan Gohman4f8d1232008-05-22 00:50:06 +00001692 /// getAccessedFieldNo - Given an encoded value and a result number, return
1693 /// the input field number being accessed.
1694 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1695
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001696 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner3d00fdc2009-10-13 06:55:33 +00001697 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001698
Anders Carlsson1884eb02010-05-22 17:35:42 +00001699 /// EmitNullInitialization - Generate code to set a value of the given type to
1700 /// null, If the type contains data member pointers, they will be initialized
1701 /// to -1 in accordance with the Itanium C++ ABI.
1702 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001703
1704 // EmitVAArg - Generate code to get an argument from the passed in pointer
1705 // and update it accordingly. The return value is a pointer to the argument.
1706 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stump0dd9e882009-02-08 23:14:22 +00001707 // instruction in LLVM instead once it works well enough.
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001708 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +00001709
John McCallbdc4d802011-07-09 01:37:26 +00001710 /// emitArrayLength - Compute the length of an array, even if it's a
1711 /// VLA, and drill down to the base element type.
1712 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1713 QualType &baseType,
1714 llvm::Value *&addr);
1715
John McCallbc8d40d2011-06-24 21:55:10 +00001716 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1717 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbard286f052009-07-19 06:58:07 +00001718 ///
1719 /// This function can be called with a null (unreachable) insert point.
John McCallbc8d40d2011-06-24 21:55:10 +00001720 void EmitVariablyModifiedType(QualType Ty);
Mike Stump0dd9e882009-02-08 23:14:22 +00001721
John McCallbc8d40d2011-06-24 21:55:10 +00001722 /// getVLASize - Returns an LLVM value that corresponds to the size,
1723 /// in non-variably-sized elements, of a variable length array type,
1724 /// plus that largest non-variably-sized element type. Assumes that
1725 /// the type has already been emitted with EmitVariablyModifiedType.
1726 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1727 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssondcc90d82008-12-12 07:19:02 +00001728
Anders Carlsson5f4307b2009-04-14 16:58:56 +00001729 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1730 /// generating code for an C++ member function.
John McCall25049412010-02-16 22:04:33 +00001731 llvm::Value *LoadCXXThis() {
1732 assert(CXXThisValue && "no 'this' value for this function");
1733 return CXXThisValue;
1734 }
Mike Stump1eb44332009-09-09 15:08:12 +00001735
Anders Carlssonc997d422010-01-02 01:01:18 +00001736 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1737 /// virtual bases.
John McCall25049412010-02-16 22:04:33 +00001738 llvm::Value *LoadCXXVTT() {
1739 assert(CXXVTTValue && "no VTT value for this function");
1740 return CXXVTTValue;
1741 }
John McCallbff225e2010-02-16 04:15:37 +00001742
1743 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlsson8561a862010-04-24 23:01:49 +00001744 /// complete class to the given direct base.
1745 llvm::Value *
1746 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1747 const CXXRecordDecl *Derived,
1748 const CXXRecordDecl *Base,
1749 bool BaseIsVirtual);
Anders Carlssona88ad562010-04-24 21:51:08 +00001750
Mike Stumpf71d2322009-11-30 20:08:49 +00001751 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1752 /// load of 'this' and returns address of the base class.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001753 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001754 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001755 CastExpr::path_const_iterator PathBegin,
1756 CastExpr::path_const_iterator PathEnd,
Anders Carlsson34a2d382010-04-24 21:06:20 +00001757 bool NullCheckValue);
1758
Anders Carlssona3697c92009-11-23 17:57:54 +00001759 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001760 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001761 CastExpr::path_const_iterator PathBegin,
1762 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +00001763 bool NullCheckValue);
1764
Anders Carlssonbb7e17b2010-01-31 01:36:53 +00001765 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1766 const CXXRecordDecl *ClassDecl,
1767 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001768
John McCallc0bf4622010-02-23 00:48:20 +00001769 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1770 CXXCtorType CtorType,
1771 const FunctionArgList &Args);
Sean Hunt059ce0d2011-05-01 07:04:31 +00001772 // It's important not to confuse this and the previous function. Delegating
1773 // constructors are the C++0x feature. The constructor delegate optimization
1774 // is used to reduce duplication in the base and complete consturctors where
1775 // they are substantially the same.
1776 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1777 const FunctionArgList &Args);
Anders Carlsson155ed4a2010-05-02 23:20:53 +00001778 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1779 bool ForVirtualBase, llvm::Value *This,
Anders Carlssonb14095a2009-04-17 00:06:03 +00001780 CallExpr::const_arg_iterator ArgBeg,
1781 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahanian34999872010-11-13 21:53:34 +00001782
1783 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1784 llvm::Value *This, llvm::Value *Src,
1785 CallExpr::const_arg_iterator ArgBeg,
1786 CallExpr::const_arg_iterator ArgEnd);
Mike Stump1eb44332009-09-09 15:08:12 +00001787
Fariborz Jahanian288dcaf2009-08-19 20:55:16 +00001788 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlsson569c1f42009-09-23 02:45:36 +00001789 const ConstantArrayType *ArrayTy,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001790 llvm::Value *ArrayPtr,
1791 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001792 CallExpr::const_arg_iterator ArgEnd,
1793 bool ZeroInitialization = false);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001794
Anders Carlsson569c1f42009-09-23 02:45:36 +00001795 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1796 llvm::Value *NumElements,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001797 llvm::Value *ArrayPtr,
1798 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001799 CallExpr::const_arg_iterator ArgEnd,
1800 bool ZeroInitialization = false);
Anders Carlssonb14095a2009-04-17 00:06:03 +00001801
John McCallbdc4d802011-07-09 01:37:26 +00001802 static Destroyer destroyCXXObject;
1803
Anders Carlsson7267c162009-05-29 21:03:38 +00001804 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Anders Carlsson8e6404c2010-05-02 23:29:11 +00001805 bool ForVirtualBase, llvm::Value *This);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001806
John McCall19705672011-09-15 06:49:18 +00001807 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1808 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump1eb44332009-09-09 15:08:12 +00001809
Peter Collingbourne86811602011-11-27 22:09:22 +00001810 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1811 llvm::Value *Ptr);
Mike Stump1eb44332009-09-09 15:08:12 +00001812
Anders Carlssona00703d2009-05-31 01:40:14 +00001813 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson60e282c2009-08-16 21:13:42 +00001814 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump1eb44332009-09-09 15:08:12 +00001815
Eli Friedman4bf81522009-11-18 00:57:03 +00001816 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1817 QualType DeleteTy);
1818
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001819 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stumpc849c052009-11-16 06:50:58 +00001820 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001821
Sebastian Redl972edf02012-02-19 16:03:09 +00001822 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
Sebastian Redlaf130fd2012-02-19 12:28:02 +00001823 void EmitStdInitializerListCleanup(llvm::Value *loc,
1824 const InitListExpr *init);
Sebastian Redl32cf1f22012-02-17 08:42:25 +00001825
Mike Stumpb14e62d2009-12-16 02:57:00 +00001826 void EmitCheck(llvm::Value *, unsigned Size);
1827
Chris Lattnerdd36d322010-01-09 21:40:03 +00001828 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1829 bool isInc, bool isPre);
1830 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1831 bool isInc, bool isPre);
Reid Spencer5f016e22007-07-11 17:01:13 +00001832 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +00001833 // Declaration Emission
1834 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001835
Daniel Dunbard286f052009-07-19 06:58:07 +00001836 /// EmitDecl - Emit a declaration.
1837 ///
1838 /// This function can be called with a null (unreachable) insert point.
Reid Spencer5f016e22007-07-11 17:01:13 +00001839 void EmitDecl(const Decl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001840
John McCallb6bbcc92010-10-15 04:57:14 +00001841 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001842 ///
1843 /// This function can be called with a null (unreachable) insert point.
John McCallb6bbcc92010-10-15 04:57:14 +00001844 void EmitVarDecl(const VarDecl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001845
John McCallf85e1932011-06-15 23:02:42 +00001846 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001847 LValue lvalue, bool capturedByInit);
John McCall7acddac2011-06-17 06:42:21 +00001848 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCallf85e1932011-06-15 23:02:42 +00001849
John McCallf1549f62010-07-06 01:34:17 +00001850 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1851 llvm::Value *Address);
1852
John McCallb6bbcc92010-10-15 04:57:14 +00001853 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001854 ///
1855 /// This function can be called with a null (unreachable) insert point.
John McCall34695852011-02-22 06:44:22 +00001856 void EmitAutoVarDecl(const VarDecl &D);
1857
1858 class AutoVarEmission {
1859 friend class CodeGenFunction;
1860
John McCall57b3b6a2011-02-22 07:16:58 +00001861 const VarDecl *Variable;
John McCall34695852011-02-22 06:44:22 +00001862
1863 /// The alignment of the variable.
1864 CharUnits Alignment;
1865
1866 /// The address of the alloca. Null if the variable was emitted
1867 /// as a global constant.
1868 llvm::Value *Address;
1869
1870 llvm::Value *NRVOFlag;
1871
1872 /// True if the variable is a __block variable.
1873 bool IsByRef;
1874
1875 /// True if the variable is of aggregate type and has a constant
1876 /// initializer.
1877 bool IsConstantAggregate;
1878
John McCall57b3b6a2011-02-22 07:16:58 +00001879 struct Invalid {};
1880 AutoVarEmission(Invalid) : Variable(0) {}
1881
John McCall34695852011-02-22 06:44:22 +00001882 AutoVarEmission(const VarDecl &variable)
John McCall57b3b6a2011-02-22 07:16:58 +00001883 : Variable(&variable), Address(0), NRVOFlag(0),
John McCall34695852011-02-22 06:44:22 +00001884 IsByRef(false), IsConstantAggregate(false) {}
1885
1886 bool wasEmittedAsGlobal() const { return Address == 0; }
1887
1888 public:
John McCall57b3b6a2011-02-22 07:16:58 +00001889 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1890
John McCall34695852011-02-22 06:44:22 +00001891 /// Returns the address of the object within this declaration.
1892 /// Note that this does not chase the forwarding pointer for
1893 /// __block decls.
1894 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1895 if (!IsByRef) return Address;
1896
1897 return CGF.Builder.CreateStructGEP(Address,
John McCall57b3b6a2011-02-22 07:16:58 +00001898 CGF.getByRefValueLLVMField(Variable),
1899 Variable->getNameAsString());
John McCall34695852011-02-22 06:44:22 +00001900 }
1901 };
1902 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1903 void EmitAutoVarInit(const AutoVarEmission &emission);
1904 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCallbdc4d802011-07-09 01:37:26 +00001905 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1906 QualType::DestructionKind dtorKind);
Daniel Dunbard286f052009-07-19 06:58:07 +00001907
John McCallb6bbcc92010-10-15 04:57:14 +00001908 void EmitStaticVarDecl(const VarDecl &D,
1909 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001910
1911 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel093ac462011-03-03 20:13:15 +00001912 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stump0dd9e882009-02-08 23:14:22 +00001913
John McCall56ca35d2011-02-17 10:25:35 +00001914 /// protectFromPeepholes - Protect a value that we're intending to
1915 /// store to the side, but which will probably be used later, from
1916 /// aggressive peepholing optimizations that might delete it.
1917 ///
1918 /// Pass the result to unprotectFromPeepholes to declare that
1919 /// protection is no longer required.
1920 ///
1921 /// There's no particular reason why this shouldn't apply to
1922 /// l-values, it's just that no existing peepholes work on pointers.
1923 PeepholeProtection protectFromPeepholes(RValue rvalue);
1924 void unprotectFromPeepholes(PeepholeProtection protection);
1925
Reid Spencer5f016e22007-07-11 17:01:13 +00001926 //===--------------------------------------------------------------------===//
1927 // Statement Emission
1928 //===--------------------------------------------------------------------===//
1929
Mike Stump0dd9e882009-02-08 23:14:22 +00001930 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar09124252008-11-12 08:21:33 +00001931 void EmitStopPoint(const Stmt *S);
1932
Mike Stump0dd9e882009-02-08 23:14:22 +00001933 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1934 /// this function even if there is no current insertion point.
1935 ///
1936 /// This function may clear the current insertion point; callers should use
1937 /// EnsureInsertPoint if they wish to subsequently generate code without first
1938 /// calling EmitBlock, EmitBranch, or EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +00001939 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001940
Daniel Dunbar09124252008-11-12 08:21:33 +00001941 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stump0dd9e882009-02-08 23:14:22 +00001942 /// necessarily require an insertion point or debug information; typically
1943 /// because the statement amounts to a jump or a container of other
1944 /// statements.
Daniel Dunbar09124252008-11-12 08:21:33 +00001945 ///
1946 /// \return True if the statement was handled.
1947 bool EmitSimpleStmt(const Stmt *S);
1948
Chris Lattner9b655512007-08-31 22:49:20 +00001949 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall558d2ab2010-09-15 10:14:12 +00001950 AggValueSlot AVS = AggValueSlot::ignored());
Daniel Dunbara448fb22008-11-11 23:11:34 +00001951
Mike Stump0dd9e882009-02-08 23:14:22 +00001952 /// EmitLabel - Emit the block for the given label. It is legal to call this
1953 /// function even if there is no current insertion point.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001954 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001955
Reid Spencer5f016e22007-07-11 17:01:13 +00001956 void EmitLabelStmt(const LabelStmt &S);
1957 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001958 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00001959 void EmitIfStmt(const IfStmt &S);
1960 void EmitWhileStmt(const WhileStmt &S);
1961 void EmitDoStmt(const DoStmt &S);
1962 void EmitForStmt(const ForStmt &S);
1963 void EmitReturnStmt(const ReturnStmt &S);
1964 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +00001965 void EmitBreakStmt(const BreakStmt &S);
1966 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +00001967 void EmitSwitchStmt(const SwitchStmt &S);
1968 void EmitDefaultStmt(const DefaultStmt &S);
1969 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +00001970 void EmitCaseStmtRange(const CaseStmt &S);
Anders Carlssonfb1aeb82008-02-05 16:35:33 +00001971 void EmitAsmStmt(const AsmStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001972
Anders Carlsson3d8400d2008-08-30 19:51:14 +00001973 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001974 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1975 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00001976 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCallf85e1932011-06-15 23:02:42 +00001977 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001978
John McCall93c332a2011-05-28 21:13:02 +00001979 llvm::Constant *getUnwindResumeFn();
Douglas Gregor86a3a032010-05-16 01:24:12 +00001980 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCall59a70002010-07-07 06:56:46 +00001981 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1982 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCall9fc6a772010-02-19 09:25:03 +00001983
Anders Carlsson6815e942009-09-27 18:58:34 +00001984 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smithad762fc2011-04-14 22:09:26 +00001985 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001986
Reid Spencer5f016e22007-07-11 17:01:13 +00001987 //===--------------------------------------------------------------------===//
1988 // LValue Expression Emission
1989 //===--------------------------------------------------------------------===//
1990
Daniel Dunbar13e81732009-02-05 07:09:07 +00001991 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1992 RValue GetUndefRValue(QualType Ty);
1993
Daniel Dunbarce1d38b2009-01-09 16:50:52 +00001994 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1995 /// and issue an ErrorUnsupported style diagnostic (using the
1996 /// provided Name).
1997 RValue EmitUnsupportedRValue(const Expr *E,
1998 const char *Name);
1999
Mike Stump0dd9e882009-02-08 23:14:22 +00002000 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2001 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbar6ba82a42008-08-25 20:45:57 +00002002 LValue EmitUnsupportedLValue(const Expr *E,
2003 const char *Name);
2004
Reid Spencer5f016e22007-07-11 17:01:13 +00002005 /// EmitLValue - Emit code to compute a designator that specifies the location
2006 /// of the expression.
2007 ///
2008 /// This can return one of two things: a simple address or a bitfield
2009 /// reference. In either case, the LLVM Value* in the LValue structure is
2010 /// guaranteed to be an LLVM pointer type.
2011 ///
2012 /// If this returns a bitfield reference, nothing about the pointee type of
2013 /// the LLVM value is known: For example, it may not be a pointer to an
2014 /// integer.
2015 ///
2016 /// If this returns a normal address, and if the lvalue's C type is fixed
2017 /// size, this method guarantees that the returned pointer type will point to
2018 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2019 /// variable length type, this is not possible.
2020 ///
2021 LValue EmitLValue(const Expr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002022
Mike Stumpb14e62d2009-12-16 02:57:00 +00002023 /// EmitCheckedLValue - Same as EmitLValue but additionally we generate
2024 /// checking code to guard against undefined behavior. This is only
2025 /// suitable when we know that the address will be used to access the
2026 /// object.
2027 LValue EmitCheckedLValue(const Expr *E);
2028
John McCall26815d92010-10-27 20:58:56 +00002029 /// EmitToMemory - Change a scalar value from its value
2030 /// representation to its in-memory representation.
2031 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2032
2033 /// EmitFromMemory - Change a scalar value from its memory
2034 /// representation to its value representation.
2035 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2036
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002037 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2038 /// care to appropriately convert from the memory representation to
2039 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002040 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002041 unsigned Alignment, QualType Ty,
2042 llvm::MDNode *TBAAInfo = 0);
John McCall545d9962011-06-25 02:11:03 +00002043
2044 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2045 /// care to appropriately convert from the memory representation to
2046 /// the LLVM value representation. The l-value must be a simple
2047 /// l-value.
John McCalla07398e2011-06-16 04:16:24 +00002048 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002049
2050 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2051 /// care to appropriately convert from the memory representation to
2052 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002053 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002054 bool Volatile, unsigned Alignment, QualType Ty,
David Chisnall7a7ee302012-01-16 17:27:18 +00002055 llvm::MDNode *TBAAInfo = 0, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00002056
2057 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2058 /// care to appropriately convert from the memory representation to
2059 /// the LLVM value representation. The l-value must be a simple
David Chisnall7a7ee302012-01-16 17:27:18 +00002060 /// l-value. The isInit flag indicates whether this is an initialization.
2061 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2062 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002063
Reid Spencer5f016e22007-07-11 17:01:13 +00002064 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2065 /// this method emits the address of the lvalue, then loads the result as an
2066 /// rvalue, returning the rvalue.
John McCall545d9962011-06-25 02:11:03 +00002067 RValue EmitLoadOfLValue(LValue V);
2068 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2069 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stump0dd9e882009-02-08 23:14:22 +00002070
Reid Spencer5f016e22007-07-11 17:01:13 +00002071 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2072 /// lvalue, where both are guaranteed to the have the same type, and that type
2073 /// is 'Ty'.
David Chisnall7a7ee302012-01-16 17:27:18 +00002074 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00002075 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbared3849b2008-11-19 09:36:46 +00002076
Mike Stump0dd9e882009-02-08 23:14:22 +00002077 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2078 /// EmitStoreThroughLValue.
Daniel Dunbared3849b2008-11-19 09:36:46 +00002079 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00002080 /// \param Result [out] - If non-null, this will be set to a Value* for the
2081 /// bit-field contents after the store, appropriate for use as the result of
2082 /// an assignment to the bit-field.
John McCall545d9962011-06-25 02:11:03 +00002083 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbared3849b2008-11-19 09:36:46 +00002084 llvm::Value **Result=0);
Mike Stump0dd9e882009-02-08 23:14:22 +00002085
John McCall83ce9d42010-11-16 23:07:28 +00002086 /// Emit an l-value for an assignment (simple or compound) of complex type.
2087 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002088 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall83ce9d42010-11-16 23:07:28 +00002089
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00002090 // Note: only available for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +00002091 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002092 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002093 // Note: only available for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +00002094 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002095 // Note: only available for agg return types
2096 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002097 LValue EmitDeclRefLValue(const DeclRefExpr *E);
2098 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnereaf2bb82009-02-24 22:18:39 +00002099 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattnerd9f69102008-08-10 01:53:14 +00002100 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002101 LValue EmitUnaryOpLValue(const UnaryOperator *E);
2102 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begeman213541a2008-04-18 23:10:10 +00002103 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +00002104 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian820bca42009-12-09 23:35:29 +00002105 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +00002106 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
John McCall56ca35d2011-02-17 10:25:35 +00002107 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner75dfeda2009-03-18 18:28:57 +00002108 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregored8abf12010-07-08 06:14:04 +00002109 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregor03e80032011-06-21 17:03:29 +00002110 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCalle996ffd2011-02-16 08:02:54 +00002111 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002112
John McCalldd2ecee2012-03-10 03:05:10 +00002113 class ConstantEmission {
2114 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2115 ConstantEmission(llvm::Constant *C, bool isReference)
2116 : ValueAndIsReference(C, isReference) {}
2117 public:
2118 ConstantEmission() {}
2119 static ConstantEmission forReference(llvm::Constant *C) {
2120 return ConstantEmission(C, true);
2121 }
2122 static ConstantEmission forValue(llvm::Constant *C) {
2123 return ConstantEmission(C, false);
2124 }
2125
2126 operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
2127
2128 bool isReference() const { return ValueAndIsReference.getInt(); }
2129 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2130 assert(isReference());
2131 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2132 refExpr->getType());
2133 }
2134
2135 llvm::Constant *getValue() const {
2136 assert(!isReference());
2137 return ValueAndIsReference.getPointer();
2138 }
2139 };
2140
John McCallf4b88a42012-03-10 09:33:50 +00002141 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCalldd2ecee2012-03-10 03:05:10 +00002142
John McCall4b9c2d22011-11-06 09:01:30 +00002143 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2144 AggValueSlot slot = AggValueSlot::ignored());
2145 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2146
Daniel Dunbar2a031922009-04-22 05:08:15 +00002147 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002148 const ObjCIvarDecl *Ivar);
John McCalla9976d32010-05-21 01:18:57 +00002149 LValue EmitLValueForAnonRecordField(llvm::Value* Base,
Francois Pichet00eb3f92010-12-04 09:14:42 +00002150 const IndirectFieldDecl* Field,
John McCalla9976d32010-05-21 01:18:57 +00002151 unsigned CVRQualifiers);
Anders Carlsson0ed303c2009-11-17 03:57:07 +00002152 LValue EmitLValueForField(llvm::Value* Base, const FieldDecl* Field,
Anders Carlssone6d2a532010-01-29 05:05:36 +00002153 unsigned CVRQualifiers);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002154
Anders Carlsson06a29702010-01-29 05:24:29 +00002155 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2156 /// if the Field is a reference, this will return the address of the reference
2157 /// and not the address of the value stored in the reference.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002158 LValue EmitLValueForFieldInitialization(llvm::Value* Base,
Anders Carlsson06a29702010-01-29 05:24:29 +00002159 const FieldDecl* Field,
2160 unsigned CVRQualifiers);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002161
Fariborz Jahanian45012a72009-02-03 00:09:52 +00002162 LValue EmitLValueForIvar(QualType ObjectTy,
2163 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002164 unsigned CVRQualifiers);
2165
Anders Carlsson0ed303c2009-11-17 03:57:07 +00002166 LValue EmitLValueForBitfield(llvm::Value* Base, const FieldDecl* Field,
Fariborz Jahanian598d3f62009-02-03 19:03:09 +00002167 unsigned CVRQualifiers);
Fariborz Jahanianfd64bb62008-12-15 20:35:07 +00002168
Anders Carlssonb58d0172009-05-30 23:23:33 +00002169 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssone61c9e82009-05-30 23:30:54 +00002170 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman31a37022012-02-08 05:34:55 +00002171 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002172 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002173
Daniel Dunbar0a04d772008-08-23 10:51:21 +00002174 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +00002175 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattner65459942009-04-25 19:35:26 +00002176 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanian8bfd31f2009-10-22 22:57:31 +00002177 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian03b29602010-06-17 19:56:20 +00002178 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCall189d6ef2010-10-09 01:34:31 +00002179 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCall56ca35d2011-02-17 10:25:35 +00002180
Reid Spencer5f016e22007-07-11 17:01:13 +00002181 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +00002182 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +00002183 //===--------------------------------------------------------------------===//
2184
Mike Stump0dd9e882009-02-08 23:14:22 +00002185 /// EmitCall - Generate a call of the given function, expecting the given
2186 /// result type, and using the given argument list which specifies both the
2187 /// LLVM arguments and the types they were derived from.
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002188 ///
Mike Stumpf71d2322009-11-30 20:08:49 +00002189 /// \param TargetDecl - If given, the decl of the function in a direct call;
2190 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbar88b53962009-02-02 22:03:45 +00002191 RValue EmitCall(const CGFunctionInfo &FnInfo,
2192 llvm::Value *Callee,
Anders Carlssonf3c47c92009-12-24 19:25:24 +00002193 ReturnValueSlot ReturnValue,
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002194 const CallArgList &Args,
David Chisnalldd5c98f2010-05-01 11:15:56 +00002195 const Decl *TargetDecl = 0,
David Chisnall4b02afc2010-05-02 13:41:58 +00002196 llvm::Instruction **callOrInvoke = 0);
Mike Stump1eb44332009-09-09 15:08:12 +00002197
Anders Carlsson31777a22009-12-24 19:08:58 +00002198 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlssond2490a92009-12-24 20:40:36 +00002199 ReturnValueSlot ReturnValue,
Anders Carlsson98647712009-05-27 01:22:39 +00002200 CallExpr::const_arg_iterator ArgBeg,
2201 CallExpr::const_arg_iterator ArgEnd,
2202 const Decl *TargetDecl = 0);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002203 RValue EmitCallExpr(const CallExpr *E,
Anders Carlssond2490a92009-12-24 20:40:36 +00002204 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump1eb44332009-09-09 15:08:12 +00002205
John McCallf1549f62010-07-06 01:34:17 +00002206 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner2d3ba4f2011-07-23 17:14:25 +00002207 ArrayRef<llvm::Value *> Args,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002208 const Twine &Name = "");
Jay Foad4c7d9f12011-07-15 08:37:34 +00002209 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002210 const Twine &Name = "");
John McCallf1549f62010-07-06 01:34:17 +00002211
Anders Carlsson566abee2009-11-13 04:45:41 +00002212 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002213 llvm::Type *Ty);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002214 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002215 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian27262672011-01-20 17:19:02 +00002216 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2217 NestedNameSpecifier *Qual,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002218 llvm::Type *Ty);
Fariborz Jahanianccd52592011-02-01 23:22:34 +00002219
2220 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2221 CXXDtorType Type,
Fariborz Jahanian771c6782011-02-03 19:27:17 +00002222 const CXXRecordDecl *RD);
Anders Carlsson566abee2009-11-13 04:45:41 +00002223
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002224 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
2225 llvm::Value *Callee,
Anders Carlssona1736c02009-12-24 21:13:40 +00002226 ReturnValueSlot ReturnValue,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002227 llvm::Value *This,
Anders Carlssonc997d422010-01-02 01:01:18 +00002228 llvm::Value *VTT,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002229 CallExpr::const_arg_iterator ArgBeg,
2230 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssona1736c02009-12-24 21:13:40 +00002231 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2232 ReturnValueSlot ReturnValue);
2233 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2234 ReturnValueSlot ReturnValue);
Ted Kremenek55499762008-06-17 02:43:46 +00002235
Anders Carlssona2447e02011-05-08 20:32:23 +00002236 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2237 const CXXMethodDecl *MD,
2238 llvm::Value *This);
Anders Carlsson0f294632009-05-27 04:18:27 +00002239 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssona1736c02009-12-24 21:13:40 +00002240 const CXXMethodDecl *MD,
2241 ReturnValueSlot ReturnValue);
Mike Stump1eb44332009-09-09 15:08:12 +00002242
Peter Collingbourne6c0aa5f2011-10-06 18:29:37 +00002243 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2244 ReturnValueSlot ReturnValue);
2245
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002246
Mike Stump1eb44332009-09-09 15:08:12 +00002247 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbaref2abfe2009-02-16 22:43:43 +00002248 unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002249
Anders Carlssona1736c02009-12-24 21:13:40 +00002250 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stump09429b92009-02-17 17:00:02 +00002251
Mike Stump0dd9e882009-02-08 23:14:22 +00002252 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2253 /// is unhandled by the current target.
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +00002254 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2255
Chris Lattner2752c012010-03-03 19:03:45 +00002256 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002257 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner686775d2011-07-20 06:58:45 +00002258 SmallVectorImpl<llvm::Value*> &O,
Bob Wilsondb3d4d02010-12-08 22:37:56 +00002259 const char *name,
Nate Begeman61eecf52010-06-14 05:21:25 +00002260 unsigned shift = 0, bool rightshift = false);
Bob Wilsoncf556522010-12-07 22:40:02 +00002261 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2acc6e32011-07-18 04:24:23 +00002262 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman61eecf52010-06-14 05:21:25 +00002263 bool negateForRightShift);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002264
Bill Wendling795b1002012-02-22 09:30:11 +00002265 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002266 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Tony Linthicum96319392011-12-12 21:14:55 +00002267 llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002268 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002269
Daniel Dunbared7c6182008-08-20 00:28:19 +00002270 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +00002271 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Ted Kremenekebcb57a2012-03-06 20:05:56 +00002272 llvm::Value *EmitObjCNumericLiteral(const ObjCNumericLiteral *E);
2273 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2274 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2275 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2276 const ObjCMethodDecl *MethodWithObjects);
Chris Lattner8fdf3282008-06-24 17:04:18 +00002277 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCallef072fd2010-05-22 01:48:05 +00002278 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2279 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattner8fdf3282008-06-24 17:04:18 +00002280
John McCallf85e1932011-06-15 23:02:42 +00002281 /// Retrieves the default cleanup kind for an ARC cleanup.
2282 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2283 CleanupKind getARCCleanupKind() {
2284 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2285 ? NormalAndEHCleanup : NormalCleanup;
2286 }
2287
2288 // ARC primitives.
2289 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2290 void EmitARCDestroyWeak(llvm::Value *addr);
2291 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2292 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2293 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2294 bool ignored);
2295 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2296 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2297 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2298 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall545d9962011-06-25 02:11:03 +00002299 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
2300 bool ignored);
John McCallf85e1932011-06-15 23:02:42 +00002301 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2302 bool ignored);
2303 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2304 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCall348f16f2011-10-04 06:23:45 +00002305 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallf85e1932011-06-15 23:02:42 +00002306 void EmitARCRelease(llvm::Value *value, bool precise);
2307 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2308 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2309 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2310 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2311
2312 std::pair<LValue,llvm::Value*>
2313 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2314 std::pair<LValue,llvm::Value*>
2315 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2316
John McCall2b014d62011-10-01 10:32:24 +00002317 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2318
John McCallf85e1932011-06-15 23:02:42 +00002319 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2320 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2321 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2322
John McCall348f16f2011-10-04 06:23:45 +00002323 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCallf85e1932011-06-15 23:02:42 +00002324 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2325 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2326
John McCallbdc4d802011-07-09 01:37:26 +00002327 static Destroyer destroyARCStrongImprecise;
2328 static Destroyer destroyARCStrongPrecise;
2329 static Destroyer destroyARCWeak;
2330
John McCallf85e1932011-06-15 23:02:42 +00002331 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2332 llvm::Value *EmitObjCAutoreleasePoolPush();
2333 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2334 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2335 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2336
Anders Carlsson4029ca72009-05-20 00:24:07 +00002337 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2338 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002339 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson32f36ba2010-06-26 16:35:32 +00002340 const NamedDecl *InitializedDecl);
Anders Carlsson3aba0932010-01-31 18:34:51 +00002341
Chris Lattner883f6a72007-08-11 00:04:45 +00002342 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002343 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +00002344 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002345
2346 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stump0dd9e882009-02-08 23:14:22 +00002347
2348 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2349 /// scalar type, returning the result.
Anders Carlsson14c5cbf2009-08-16 07:36:22 +00002350 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002351
Chris Lattner3707b252007-08-26 06:48:56 +00002352 /// EmitScalarConversion - Emit a conversion from the specified type to the
2353 /// specified destination type, both of which are LLVM scalar types.
2354 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2355 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002356
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002357 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stump0dd9e882009-02-08 23:14:22 +00002358 /// complex type to the specified destination type, where the destination type
2359 /// is an LLVM scalar type.
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002360 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2361 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002362
2363
John McCall558d2ab2010-09-15 10:14:12 +00002364 /// EmitAggExpr - Emit the computation of the specified expression
2365 /// of aggregate type. The result is computed into the given slot,
2366 /// which may be null to indicate that the value is not needed.
Fariborz Jahanian474e2fe2010-09-16 00:20:07 +00002367 void EmitAggExpr(const Expr *E, AggValueSlot AS, bool IgnoreResult = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002368
Daniel Dunbar18aba0d2010-02-05 19:38:31 +00002369 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2370 /// aggregate type into a temporary LValue.
2371 LValue EmitAggExprToLValue(const Expr *E);
2372
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002373 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2374 /// pointers.
2375 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian08c32132009-08-31 19:33:16 +00002376 QualType Ty);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002377
John McCall0c24c802011-06-24 23:21:27 +00002378 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2379 /// make sure it survives garbage collection until this point.
2380 void EmitExtendGCLifetime(llvm::Value *object);
2381
Chris Lattnerb6ef18a2007-08-21 05:54:00 +00002382 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002383 /// complex type, returning the result.
John McCallb418d742010-11-16 10:08:07 +00002384 ComplexPairTy EmitComplexExpr(const Expr *E,
2385 bool IgnoreReal = false,
2386 bool IgnoreImag = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002387
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002388 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
2389 /// of complex type, storing into the specified Value*.
Chris Lattner190dbe22007-08-26 16:22:13 +00002390 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
2391 bool DestIsVolatile);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00002392
2393 /// StoreComplexToAddr - Store a complex number into the specified address.
2394 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
2395 bool DestIsVolatile);
Chris Lattner9b655512007-08-31 22:49:20 +00002396 /// LoadComplexFromAddr - Load a complex number from the specified address.
2397 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattner2621fd12008-05-08 05:58:21 +00002398
John McCallb6bbcc92010-10-15 04:57:14 +00002399 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2400 /// a static local variable.
2401 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2402 const char *Separator,
Mike Stumpf71d2322009-11-30 20:08:49 +00002403 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002404
John McCallb6bbcc92010-10-15 04:57:14 +00002405 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
Chris Lattner761acc12009-12-05 08:22:11 +00002406 /// global variable that has already been created for it. If the initializer
2407 /// has a different type than GV does, this may free GV and return a different
2408 /// one. Otherwise it just returns GV.
2409 llvm::GlobalVariable *
John McCallb6bbcc92010-10-15 04:57:14 +00002410 AddInitializerToStaticVarDecl(const VarDecl &D,
2411 llvm::GlobalVariable *GV);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002412
Daniel Dunbar0096acf2009-02-25 19:24:29 +00002413
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002414 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2415 /// variable with global storage.
Richard Smith7ca48502012-02-13 22:16:19 +00002416 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2417 bool PerformInit);
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002418
2419 /// EmitCXXGlobalDtorRegistration - Emits a call to register the global ptr
2420 /// with the C++ runtime so that its destructor will be called at exit.
Fariborz Jahanian88f42802009-11-10 19:24:06 +00002421 void EmitCXXGlobalDtorRegistration(llvm::Constant *DtorFn,
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002422 llvm::Constant *DeclPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00002423
John McCall3030eb82010-11-06 09:44:32 +00002424 /// Emit code in this function to perform a guarded variable
2425 /// initialization. Guarded initializations are used when it's not
2426 /// possible to prove that an initialization will be done exactly
2427 /// once, e.g. with a static local variable or a static data member
2428 /// of a class template.
Richard Smith7ca48502012-02-13 22:16:19 +00002429 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
2430 bool PerformInit);
John McCall5cd91b52010-09-08 01:44:27 +00002431
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002432 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2433 /// variables.
2434 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2435 llvm::Constant **Decls,
2436 unsigned NumDecls);
2437
2438 /// GenerateCXXGlobalDtorFunc - Generates code for destroying global
2439 /// variables.
2440 void GenerateCXXGlobalDtorFunc(llvm::Function *Fn,
Chris Lattner810112e2010-06-19 05:52:45 +00002441 const std::vector<std::pair<llvm::WeakVH,
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002442 llvm::Constant*> > &DtorsAndObjects);
2443
John McCalld26bc762011-03-09 04:27:21 +00002444 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2445 const VarDecl *D,
Richard Smith7ca48502012-02-13 22:16:19 +00002446 llvm::GlobalVariable *Addr,
2447 bool PerformInit);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002448
John McCall558d2ab2010-09-15 10:14:12 +00002449 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002450
2451 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian830937b2010-12-02 17:02:11 +00002452 const Expr *Exp);
Mike Stump1eb44332009-09-09 15:08:12 +00002453
John McCall1a343eb2011-11-10 08:15:53 +00002454 void enterFullExpression(const ExprWithCleanups *E) {
2455 if (E->getNumObjects() == 0) return;
2456 enterNonTrivialFullExpression(E);
2457 }
2458 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump1eb44332009-09-09 15:08:12 +00002459
Anders Carlsson756b5c42009-10-30 01:42:31 +00002460 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregor1eb2e592010-05-16 00:44:00 +00002461
Eli Friedman4c5d8af2012-02-09 03:32:31 +00002462 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2463
Eli Friedman276b0612011-10-11 02:20:01 +00002464 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2465
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002466 //===--------------------------------------------------------------------===//
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002467 // Annotations Emission
2468 //===--------------------------------------------------------------------===//
2469
2470 /// Emit an annotation call (intrinsic or builtin).
2471 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2472 llvm::Value *AnnotatedVal,
2473 llvm::StringRef AnnotationStr,
2474 SourceLocation Location);
2475
2476 /// Emit local annotations for the local variable V, declared by D.
2477 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2478
2479 /// Emit field annotations for the given field & value. Returns the
2480 /// annotation result.
2481 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2482
2483 //===--------------------------------------------------------------------===//
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002484 // Internal Helpers
2485 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002486
Chris Lattner0946ccd2008-11-11 07:41:27 +00002487 /// ContainsLabel - Return true if the statement contains a label in it. If
2488 /// this statement is not executed normally, it not containing a label means
2489 /// that we can just remove the code.
2490 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002491
Chris Lattneref425a62011-02-28 00:18:40 +00002492 /// containsBreak - Return true if the statement contains a break out of it.
2493 /// If the statement (recursively) contains a switch or loop with a break
2494 /// inside of it, this is fine.
2495 static bool containsBreak(const Stmt *S);
2496
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002497 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnerc2c90012011-02-27 23:02:32 +00002498 /// to a constant, or if it does but contains a label, return false. If it
2499 /// constant folds return true and set the boolean result in Result.
2500 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stump0dd9e882009-02-08 23:14:22 +00002501
Chris Lattneref425a62011-02-28 00:18:40 +00002502 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2503 /// to a constant, or if it does but contains a label, return false. If it
2504 /// constant folds return true and set the folded value.
2505 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APInt &Result);
2506
Chris Lattner31a09842008-11-12 08:04:58 +00002507 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2508 /// if statement) to the specified blocks. Based on the condition, this might
2509 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattner9bc47e22008-11-12 07:46:33 +00002510 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002511 llvm::BasicBlock *FalseBlock);
Mike Stumpbe07f602009-12-14 21:58:14 +00002512
Mike Stump15037ca2009-12-15 00:35:12 +00002513 /// getTrapBB - Create a basic block that will call the trap intrinsic. We'll
2514 /// generate a branch around the created basic block as necessary.
Chris Lattner6c552c12010-07-20 20:19:24 +00002515 llvm::BasicBlock *getTrapBB();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002516
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002517 /// EmitCallArg - Emit a single call argument.
John McCall413ebdb2011-03-11 20:59:21 +00002518 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002519
John McCall27360712010-05-26 22:34:26 +00002520 /// EmitDelegateCallArg - We are performing a delegate call; that
2521 /// is, the current function is delegating to another one. Produce
2522 /// a r-value suitable for passing the given parameter.
John McCall413ebdb2011-03-11 20:59:21 +00002523 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall27360712010-05-26 22:34:26 +00002524
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002525 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2526 /// point operation, expressed as the maximum relative error in ulp.
2527 void SetFPAccuracy(llvm::Value *Val, unsigned AccuracyN,
2528 unsigned AccuracyD = 1);
2529
Chris Lattner31a09842008-11-12 08:04:58 +00002530private:
Rafael Espindolac3f89552012-03-24 16:50:34 +00002531 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002532 void EmitReturnOfRValue(RValue RV, QualType Ty);
2533
Daniel Dunbar56273772008-09-17 00:51:38 +00002534 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2535 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2536 ///
2537 /// \param AI - The first function argument of the expansion.
2538 /// \return The argument following the last expanded function
2539 /// argument.
Mike Stump0dd9e882009-02-08 23:14:22 +00002540 llvm::Function::arg_iterator
Daniel Dunbar56273772008-09-17 00:51:38 +00002541 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2542 llvm::Function::arg_iterator AI);
2543
Mike Stump0dd9e882009-02-08 23:14:22 +00002544 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2545 /// Ty, into individual arguments on the provided vector \arg Args. See
2546 /// ABIArgInfo::Expand.
2547 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner686775d2011-07-20 06:58:45 +00002548 SmallVector<llvm::Value*, 16> &Args,
Chris Lattner811bf362011-07-12 06:29:11 +00002549 llvm::FunctionType *IRFuncTy);
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002550
Mike Stump1eb44332009-09-09 15:08:12 +00002551 llvm::Value* EmitAsmInput(const AsmStmt &S,
Daniel Dunbarb84e8a62009-05-04 06:56:16 +00002552 const TargetInfo::ConstraintInfo &Info,
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002553 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stump0dd9e882009-02-08 23:14:22 +00002554
Eli Friedman6d7cfd72010-07-16 00:55:21 +00002555 llvm::Value* EmitAsmInputLValue(const AsmStmt &S,
2556 const TargetInfo::ConstraintInfo &Info,
2557 LValue InputValue, QualType InputType,
2558 std::string &ConstraintStr);
2559
Anders Carlsson0139bb92009-04-08 20:47:54 +00002560 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump1eb44332009-09-09 15:08:12 +00002561 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlssonaf23f692009-04-18 20:20:22 +00002562 /// argument types of the function being called.
2563 template<typename T>
2564 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson0139bb92009-04-08 20:47:54 +00002565 CallExpr::const_arg_iterator ArgBeg,
Anders Carlssonaf23f692009-04-18 20:20:22 +00002566 CallExpr::const_arg_iterator ArgEnd) {
2567 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson0139bb92009-04-08 20:47:54 +00002568
Anders Carlssonaf23f692009-04-18 20:20:22 +00002569 // First, use the argument types that the type info knows about
2570 if (CallArgTypeInfo) {
2571 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2572 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman44b0a3e2009-11-18 03:42:04 +00002573 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlssonaf23f692009-04-18 20:20:22 +00002574 QualType ArgType = *I;
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002575#ifndef NDEBUG
2576 QualType ActualArgType = Arg->getType();
2577 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002578 QualType ActualBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002579 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002580 QualType ArgBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002581 ArgType->getAs<PointerType>()->getPointeeType();
2582 if (ArgBaseType->isVariableArrayType()) {
2583 if (const VariableArrayType *VAT =
2584 getContext().getAsVariableArrayType(ActualBaseType)) {
2585 if (!VAT->getSizeExpr())
2586 ActualArgType = ArgType;
2587 }
2588 }
2589 }
Anders Carlssonaf23f692009-04-18 20:20:22 +00002590 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump1eb44332009-09-09 15:08:12 +00002591 getTypePtr() ==
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002592 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002593 "type mismatch in call argument!");
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002594#endif
John McCall413ebdb2011-03-11 20:59:21 +00002595 EmitCallArg(Args, *Arg, ArgType);
Anders Carlssonaf23f692009-04-18 20:20:22 +00002596 }
Mike Stump1eb44332009-09-09 15:08:12 +00002597
2598 // Either we've emitted all the call args, or we have a call to a
Anders Carlssonaf23f692009-04-18 20:20:22 +00002599 // variadic function.
Mike Stump1eb44332009-09-09 15:08:12 +00002600 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002601 "Extra arguments in non-variadic function!");
Mike Stump1eb44332009-09-09 15:08:12 +00002602
Anders Carlssonaf23f692009-04-18 20:20:22 +00002603 }
Mike Stump1eb44332009-09-09 15:08:12 +00002604
Anders Carlssonaf23f692009-04-18 20:20:22 +00002605 // If we still have any arguments, emit them using the type of the argument.
John McCall413ebdb2011-03-11 20:59:21 +00002606 for (; Arg != ArgEnd; ++Arg)
2607 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlssonaf23f692009-04-18 20:20:22 +00002608 }
John McCall492c4f92010-03-03 04:15:11 +00002609
2610 const TargetCodeGenInfo &getTargetHooks() const {
2611 return CGM.getTargetCodeGenInfo();
2612 }
John McCall744016d2010-07-06 23:57:41 +00002613
2614 void EmitDeclMetadata();
John McCallf0c11f72011-03-31 08:03:29 +00002615
2616 CodeGenModule::ByrefHelpers *
Chris Lattner2acc6e32011-07-18 04:24:23 +00002617 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf0c11f72011-03-31 08:03:29 +00002618 const AutoVarEmission &emission);
Dan Gohmanb49bd272012-02-16 00:57:37 +00002619
2620 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadf4c3db12012-03-02 18:34:30 +00002621
2622 /// GetPointeeAlignment - Given an expression with a pointer type, find the
2623 /// alignment of the type referenced by the pointer. Skip over implicit
2624 /// casts.
2625 unsigned GetPointeeAlignment(const Expr *Addr);
2626
2627 /// GetPointeeAlignmentValue - Given an expression with a pointer type, find
2628 /// the alignment of the type referenced by the pointer. Skip over implicit
2629 /// casts. Return the alignment as an llvm::Value.
2630 llvm::Value *GetPointeeAlignmentValue(const Expr *Addr);
Reid Spencer5f016e22007-07-11 17:01:13 +00002631};
Mike Stump1eb44332009-09-09 15:08:12 +00002632
John McCall150b4622011-01-26 04:00:11 +00002633/// Helper class with most of the code for saving a value for a
2634/// conditional expression cleanup.
John McCall804b8072011-01-28 10:53:53 +00002635struct DominatingLLVMValue {
John McCall150b4622011-01-26 04:00:11 +00002636 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2637
2638 /// Answer whether the given value needs extra work to be saved.
2639 static bool needsSaving(llvm::Value *value) {
2640 // If it's not an instruction, we don't need to save.
2641 if (!isa<llvm::Instruction>(value)) return false;
2642
2643 // If it's an instruction in the entry block, we don't need to save.
2644 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2645 return (block != &block->getParent()->getEntryBlock());
2646 }
2647
2648 /// Try to save the given value.
2649 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2650 if (!needsSaving(value)) return saved_type(value, false);
2651
2652 // Otherwise we need an alloca.
2653 llvm::Value *alloca =
2654 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2655 CGF.Builder.CreateStore(value, alloca);
2656
2657 return saved_type(alloca, true);
2658 }
2659
2660 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2661 if (!value.getInt()) return value.getPointer();
2662 return CGF.Builder.CreateLoad(value.getPointer());
2663 }
2664};
2665
John McCall804b8072011-01-28 10:53:53 +00002666/// A partial specialization of DominatingValue for llvm::Values that
2667/// might be llvm::Instructions.
2668template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2669 typedef T *type;
John McCall150b4622011-01-26 04:00:11 +00002670 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCall804b8072011-01-28 10:53:53 +00002671 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2672 }
2673};
2674
2675/// A specialization of DominatingValue for RValue.
2676template <> struct DominatingValue<RValue> {
2677 typedef RValue type;
2678 class saved_type {
2679 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2680 AggregateAddress, ComplexAddress };
2681
2682 llvm::Value *Value;
2683 Kind K;
2684 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2685
2686 public:
2687 static bool needsSaving(RValue value);
2688 static saved_type save(CodeGenFunction &CGF, RValue value);
2689 RValue restore(CodeGenFunction &CGF);
2690
2691 // implementations in CGExprCXX.cpp
2692 };
2693
2694 static bool needsSaving(type value) {
2695 return saved_type::needsSaving(value);
2696 }
2697 static saved_type save(CodeGenFunction &CGF, type value) {
2698 return saved_type::save(CGF, value);
2699 }
2700 static type restore(CodeGenFunction &CGF, saved_type value) {
2701 return value.restore(CGF);
John McCall150b4622011-01-26 04:00:11 +00002702 }
2703};
2704
Reid Spencer5f016e22007-07-11 17:01:13 +00002705} // end namespace CodeGen
2706} // end namespace clang
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00002707
Reid Spencer5f016e22007-07-11 17:01:13 +00002708#endif