blob: 99bb8e37f459ec39b0e2642d681b29a7341be0a6 [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
Daniel Dunbar45d196b2008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christopherc3287792011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000019#include "CGValue.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000020#include "CodeGenModule.h"
21#include "clang/AST/CharUnits.h"
22#include "clang/AST/ExprCXX.h"
23#include "clang/AST/ExprObjC.h"
24#include "clang/AST/Type.h"
25#include "clang/Basic/ABI.h"
26#include "clang/Basic/TargetInfo.h"
27#include "clang/Frontend/CodeGenOptions.h"
28#include "llvm/ADT/ArrayRef.h"
29#include "llvm/ADT/DenseMap.h"
30#include "llvm/ADT/SmallVector.h"
31#include "llvm/Support/Debug.h"
32#include "llvm/Support/ValueHandle.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000033
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 ///
Dmitri Gribenko70517ca2012-08-23 17:58:28 +0000225 // \param flags cleanup kind.
John McCallad346f42011-07-12 20:27:29 +0000226 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
John McCallda65ea82010-07-13 20:32:21 +0000227 };
228
John McCall150b4622011-01-26 04:00:11 +0000229 /// ConditionalCleanupN stores the saved form of its N parameters,
230 /// then restores them and performs the cleanup.
John McCall3ad32c82011-01-28 08:37:24 +0000231 template <class T, class A0>
232 class ConditionalCleanup1 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000233 typedef typename DominatingValue<A0>::saved_type A0_saved;
John McCall3ad32c82011-01-28 08:37:24 +0000234 A0_saved a0_saved;
235
John McCallad346f42011-07-12 20:27:29 +0000236 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000237 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
John McCallad346f42011-07-12 20:27:29 +0000238 T(a0).Emit(CGF, flags);
John McCall3ad32c82011-01-28 08:37:24 +0000239 }
240
241 public:
242 ConditionalCleanup1(A0_saved a0)
243 : a0_saved(a0) {}
244 };
245
John McCall150b4622011-01-26 04:00:11 +0000246 template <class T, class A0, class A1>
John McCall3ad32c82011-01-28 08:37:24 +0000247 class ConditionalCleanup2 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000248 typedef typename DominatingValue<A0>::saved_type A0_saved;
249 typedef typename DominatingValue<A1>::saved_type A1_saved;
John McCall4bbcbda2011-01-26 19:15:39 +0000250 A0_saved a0_saved;
251 A1_saved a1_saved;
John McCall150b4622011-01-26 04:00:11 +0000252
John McCallad346f42011-07-12 20:27:29 +0000253 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000254 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
255 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
John McCallad346f42011-07-12 20:27:29 +0000256 T(a0, a1).Emit(CGF, flags);
John McCall150b4622011-01-26 04:00:11 +0000257 }
258
259 public:
John McCall3ad32c82011-01-28 08:37:24 +0000260 ConditionalCleanup2(A0_saved a0, A1_saved a1)
261 : a0_saved(a0), a1_saved(a1) {}
John McCall150b4622011-01-26 04:00:11 +0000262 };
263
Douglas Gregord7b23162011-06-22 16:12:01 +0000264 template <class T, class A0, class A1, class A2>
265 class ConditionalCleanup3 : public Cleanup {
266 typedef typename DominatingValue<A0>::saved_type A0_saved;
267 typedef typename DominatingValue<A1>::saved_type A1_saved;
268 typedef typename DominatingValue<A2>::saved_type A2_saved;
269 A0_saved a0_saved;
270 A1_saved a1_saved;
271 A2_saved a2_saved;
272
John McCallad346f42011-07-12 20:27:29 +0000273 void Emit(CodeGenFunction &CGF, Flags flags) {
Douglas Gregord7b23162011-06-22 16:12:01 +0000274 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
275 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
276 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
John McCallad346f42011-07-12 20:27:29 +0000277 T(a0, a1, a2).Emit(CGF, flags);
Douglas Gregord7b23162011-06-22 16:12:01 +0000278 }
279
280 public:
281 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
John McCallc4a1a842011-07-12 00:15:30 +0000282 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
Douglas Gregord7b23162011-06-22 16:12:01 +0000283 };
284
John McCall9928c482011-07-12 16:41:08 +0000285 template <class T, class A0, class A1, class A2, class A3>
286 class ConditionalCleanup4 : public Cleanup {
287 typedef typename DominatingValue<A0>::saved_type A0_saved;
288 typedef typename DominatingValue<A1>::saved_type A1_saved;
289 typedef typename DominatingValue<A2>::saved_type A2_saved;
290 typedef typename DominatingValue<A3>::saved_type A3_saved;
291 A0_saved a0_saved;
292 A1_saved a1_saved;
293 A2_saved a2_saved;
294 A3_saved a3_saved;
295
John McCallad346f42011-07-12 20:27:29 +0000296 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall9928c482011-07-12 16:41:08 +0000297 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
298 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
299 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
300 A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved);
John McCallad346f42011-07-12 20:27:29 +0000301 T(a0, a1, a2, a3).Emit(CGF, flags);
John McCall9928c482011-07-12 16:41:08 +0000302 }
303
304 public:
305 ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3)
306 : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {}
307 };
308
John McCallf1549f62010-07-06 01:34:17 +0000309private:
310 // The implementation for this class is in CGException.h and
311 // CGException.cpp; the definition is here because it's used as a
312 // member of CodeGenFunction.
313
314 /// The start of the scope-stack buffer, i.e. the allocated pointer
315 /// for the buffer. All of these pointers are either simultaneously
316 /// null or simultaneously valid.
317 char *StartOfBuffer;
318
319 /// The end of the buffer.
320 char *EndOfBuffer;
321
322 /// The first valid entry in the buffer.
323 char *StartOfData;
324
325 /// The innermost normal cleanup on the stack.
326 stable_iterator InnermostNormalCleanup;
327
John McCall777d6e52011-08-11 02:22:43 +0000328 /// The innermost EH scope on the stack.
329 stable_iterator InnermostEHScope;
John McCallff8e1152010-07-23 21:56:41 +0000330
John McCallf1549f62010-07-06 01:34:17 +0000331 /// The current set of branch fixups. A branch fixup is a jump to
332 /// an as-yet unemitted label, i.e. a label for which we don't yet
333 /// know the EH stack depth. Whenever we pop a cleanup, we have
334 /// to thread all the current branch fixups through it.
335 ///
336 /// Fixups are recorded as the Use of the respective branch or
337 /// switch statement. The use points to the final destination.
338 /// When popping out of a cleanup, these uses are threaded through
339 /// the cleanup and adjusted to point to the new cleanup.
340 ///
341 /// Note that branches are allowed to jump into protected scopes
342 /// in certain situations; e.g. the following code is legal:
343 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
344 /// goto foo;
345 /// A a;
346 /// foo:
347 /// bar();
Chris Lattner686775d2011-07-20 06:58:45 +0000348 SmallVector<BranchFixup, 8> BranchFixups;
John McCallf1549f62010-07-06 01:34:17 +0000349
350 char *allocate(size_t Size);
351
John McCall1f0fca52010-07-21 07:22:38 +0000352 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCallda65ea82010-07-13 20:32:21 +0000353
John McCallf1549f62010-07-06 01:34:17 +0000354public:
355 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
356 InnermostNormalCleanup(stable_end()),
John McCall777d6e52011-08-11 02:22:43 +0000357 InnermostEHScope(stable_end()) {}
John McCallf1549f62010-07-06 01:34:17 +0000358 ~EHScopeStack() { delete[] StartOfBuffer; }
359
John McCallda65ea82010-07-13 20:32:21 +0000360 // Variadic templates would make this not terrible.
361
362 /// Push a lazily-created cleanup on the stack.
John McCall8e3f8612010-07-13 22:12:14 +0000363 template <class T>
John McCall1f0fca52010-07-21 07:22:38 +0000364 void pushCleanup(CleanupKind Kind) {
365 void *Buffer = pushCleanup(Kind, sizeof(T));
366 Cleanup *Obj = new(Buffer) T();
John McCall8e3f8612010-07-13 22:12:14 +0000367 (void) Obj;
368 }
369
370 /// Push a lazily-created cleanup on the stack.
371 template <class T, class A0>
John McCall1f0fca52010-07-21 07:22:38 +0000372 void pushCleanup(CleanupKind Kind, A0 a0) {
373 void *Buffer = pushCleanup(Kind, sizeof(T));
374 Cleanup *Obj = new(Buffer) T(a0);
John McCall8e3f8612010-07-13 22:12:14 +0000375 (void) Obj;
376 }
377
378 /// Push a lazily-created cleanup on the stack.
John McCallda65ea82010-07-13 20:32:21 +0000379 template <class T, class A0, class A1>
John McCall1f0fca52010-07-21 07:22:38 +0000380 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
381 void *Buffer = pushCleanup(Kind, sizeof(T));
382 Cleanup *Obj = new(Buffer) T(a0, a1);
John McCallda65ea82010-07-13 20:32:21 +0000383 (void) Obj;
384 }
385
386 /// Push a lazily-created cleanup on the stack.
387 template <class T, class A0, class A1, class A2>
John McCall1f0fca52010-07-21 07:22:38 +0000388 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
389 void *Buffer = pushCleanup(Kind, sizeof(T));
390 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
John McCallda65ea82010-07-13 20:32:21 +0000391 (void) Obj;
392 }
393
394 /// Push a lazily-created cleanup on the stack.
395 template <class T, class A0, class A1, class A2, class A3>
John McCall1f0fca52010-07-21 07:22:38 +0000396 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
397 void *Buffer = pushCleanup(Kind, sizeof(T));
398 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
John McCallda65ea82010-07-13 20:32:21 +0000399 (void) Obj;
400 }
401
John McCall77199712010-07-21 05:47:49 +0000402 /// Push a lazily-created cleanup on the stack.
403 template <class T, class A0, class A1, class A2, class A3, class A4>
John McCall1f0fca52010-07-21 07:22:38 +0000404 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
405 void *Buffer = pushCleanup(Kind, sizeof(T));
406 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
John McCall77199712010-07-21 05:47:49 +0000407 (void) Obj;
408 }
409
John McCall7d8647f2010-09-14 07:57:04 +0000410 // Feel free to add more variants of the following:
411
412 /// Push a cleanup with non-constant storage requirements on the
413 /// stack. The cleanup type must provide an additional static method:
414 /// static size_t getExtraSize(size_t);
415 /// The argument to this method will be the value N, which will also
416 /// be passed as the first argument to the constructor.
417 ///
418 /// The data stored in the extra storage must obey the same
419 /// restrictions as normal cleanup member data.
420 ///
421 /// The pointer returned from this method is valid until the cleanup
422 /// stack is modified.
423 template <class T, class A0, class A1, class A2>
424 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
425 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
426 return new (Buffer) T(N, a0, a1, a2);
427 }
428
John McCall777d6e52011-08-11 02:22:43 +0000429 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000430 void popCleanup();
431
432 /// Push a set of catch handlers on the stack. The catch is
433 /// uninitialized and will need to have the given number of handlers
434 /// set on it.
435 class EHCatchScope *pushCatch(unsigned NumHandlers);
436
John McCall777d6e52011-08-11 02:22:43 +0000437 /// Pops a catch scope off the stack. This is private to CGException.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000438 void popCatch();
439
440 /// Push an exceptions filter on the stack.
441 class EHFilterScope *pushFilter(unsigned NumFilters);
442
443 /// Pops an exceptions filter off the stack.
444 void popFilter();
445
446 /// Push a terminate handler on the stack.
447 void pushTerminate();
448
449 /// Pops a terminate handler off the stack.
450 void popTerminate();
451
452 /// Determines whether the exception-scopes stack is empty.
453 bool empty() const { return StartOfData == EndOfBuffer; }
454
455 bool requiresLandingPad() const {
John McCall777d6e52011-08-11 02:22:43 +0000456 return InnermostEHScope != stable_end();
John McCallf1549f62010-07-06 01:34:17 +0000457 }
458
459 /// Determines whether there are any normal cleanups on the stack.
460 bool hasNormalCleanups() const {
461 return InnermostNormalCleanup != stable_end();
462 }
463
464 /// Returns the innermost normal cleanup on the stack, or
465 /// stable_end() if there are no normal cleanups.
466 stable_iterator getInnermostNormalCleanup() const {
467 return InnermostNormalCleanup;
468 }
John McCall777d6e52011-08-11 02:22:43 +0000469 stable_iterator getInnermostActiveNormalCleanup() const;
John McCallf1549f62010-07-06 01:34:17 +0000470
John McCall777d6e52011-08-11 02:22:43 +0000471 stable_iterator getInnermostEHScope() const {
472 return InnermostEHScope;
John McCallf1549f62010-07-06 01:34:17 +0000473 }
474
John McCall777d6e52011-08-11 02:22:43 +0000475 stable_iterator getInnermostActiveEHScope() const;
John McCallf1549f62010-07-06 01:34:17 +0000476
477 /// An unstable reference to a scope-stack depth. Invalidated by
478 /// pushes but not pops.
479 class iterator;
480
481 /// Returns an iterator pointing to the innermost EH scope.
482 iterator begin() const;
483
484 /// Returns an iterator pointing to the outermost EH scope.
485 iterator end() const;
486
487 /// Create a stable reference to the top of the EH stack. The
488 /// returned reference is valid until that scope is popped off the
489 /// stack.
490 stable_iterator stable_begin() const {
491 return stable_iterator(EndOfBuffer - StartOfData);
492 }
493
494 /// Create a stable reference to the bottom of the EH stack.
495 static stable_iterator stable_end() {
496 return stable_iterator(0);
497 }
498
499 /// Translates an iterator into a stable_iterator.
500 stable_iterator stabilize(iterator it) const;
501
John McCallf1549f62010-07-06 01:34:17 +0000502 /// Turn a stable reference to a scope depth into a unstable pointer
503 /// to the EH stack.
504 iterator find(stable_iterator save) const;
505
506 /// Removes the cleanup pointed to by the given stable_iterator.
507 void removeCleanup(stable_iterator save);
508
509 /// Add a branch fixup to the current cleanup scope.
510 BranchFixup &addBranchFixup() {
511 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
512 BranchFixups.push_back(BranchFixup());
513 return BranchFixups.back();
514 }
515
516 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
517 BranchFixup &getBranchFixup(unsigned I) {
518 assert(I < getNumBranchFixups());
519 return BranchFixups[I];
520 }
521
John McCallff8e1152010-07-23 21:56:41 +0000522 /// Pops lazily-removed fixups from the end of the list. This
523 /// should only be called by procedures which have just popped a
524 /// cleanup or resolved one or more fixups.
525 void popNullFixups();
526
527 /// Clears the branch-fixups list. This should only be called by
John McCall8abdbd82010-09-18 02:24:39 +0000528 /// ResolveAllBranchFixups.
John McCallff8e1152010-07-23 21:56:41 +0000529 void clearFixups() { BranchFixups.clear(); }
John McCallf1549f62010-07-06 01:34:17 +0000530};
531
Reid Spencer5f016e22007-07-11 17:01:13 +0000532/// CodeGenFunction - This class organizes the per-function state that is used
533/// while generating LLVM code.
John McCall5936e332011-02-15 09:22:45 +0000534class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000535 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
536 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall4c40d982010-08-31 07:33:07 +0000537
538 friend class CGCXXABI;
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000539public:
John McCallff8e1152010-07-23 21:56:41 +0000540 /// A jump destination is an abstract label, branching to which may
541 /// require a jump out through normal cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000542 struct JumpDest {
John McCallff8e1152010-07-23 21:56:41 +0000543 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
544 JumpDest(llvm::BasicBlock *Block,
545 EHScopeStack::stable_iterator Depth,
546 unsigned Index)
547 : Block(Block), ScopeDepth(Depth), Index(Index) {}
548
549 bool isValid() const { return Block != 0; }
550 llvm::BasicBlock *getBlock() const { return Block; }
551 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
552 unsigned getDestIndex() const { return Index; }
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000553
John McCallff8e1152010-07-23 21:56:41 +0000554 private:
John McCallf1549f62010-07-06 01:34:17 +0000555 llvm::BasicBlock *Block;
556 EHScopeStack::stable_iterator ScopeDepth;
John McCallff8e1152010-07-23 21:56:41 +0000557 unsigned Index;
558 };
559
Reid Spencer5f016e22007-07-11 17:01:13 +0000560 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar444be732009-11-13 05:51:54 +0000561 const TargetInfo &Target;
Mike Stump0dd9e882009-02-08 23:14:22 +0000562
Chris Lattner58dee102007-08-21 16:57:55 +0000563 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000564 CGBuilderTy Builder;
Mike Stump0dd9e882009-02-08 23:14:22 +0000565
Chris Lattnerb5437d22009-04-23 05:30:27 +0000566 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
567 /// This excludes BlockDecls.
Chris Lattner41110242008-06-17 18:05:57 +0000568 const Decl *CurFuncDecl;
Chris Lattnerb5437d22009-04-23 05:30:27 +0000569 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
570 const Decl *CurCodeDecl;
Daniel Dunbar88b53962009-02-02 22:03:45 +0000571 const CGFunctionInfo *CurFnInfo;
Chris Lattner391d77a2008-03-30 23:03:07 +0000572 QualType FnRetTy;
Reid Spencer5f016e22007-07-11 17:01:13 +0000573 llvm::Function *CurFn;
574
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000575 /// CurGD - The GlobalDecl for the current function being compiled.
576 GlobalDecl CurGD;
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000577
John McCallf85e1932011-06-15 23:02:42 +0000578 /// PrologueCleanupDepth - The cleanup depth enclosing all the
579 /// cleanups associated with the parameters.
580 EHScopeStack::stable_iterator PrologueCleanupDepth;
581
Daniel Dunbar5ca20842008-09-09 21:00:17 +0000582 /// ReturnBlock - Unified return block.
John McCallf1549f62010-07-06 01:34:17 +0000583 JumpDest ReturnBlock;
584
Mike Stump0dd9e882009-02-08 23:14:22 +0000585 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledruf3477c12012-09-27 10:16:10 +0000586 /// iff the function has no return value.
Eli Friedmanb17daf92009-12-04 02:43:40 +0000587 llvm::Value *ReturnValue;
Mike Stump0dd9e882009-02-08 23:14:22 +0000588
Reid Spencer5f016e22007-07-11 17:01:13 +0000589 /// AllocaInsertPoint - This is an instruction in the entry block before which
590 /// we prefer to insert allocas.
Chris Lattner481769b2009-03-31 22:17:44 +0000591 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000592
Nuno Lopesb3198a82012-05-08 22:10:46 +0000593 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
594 /// potentially higher performance penalties.
595 unsigned char BoundsChecking;
596
Richard Smithd6396a62012-11-05 22:21:05 +0000597 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
598 /// calls to EmitTypeCheck can be skipped.
599 bool SanitizePerformTypeCheck;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000600
Will Dietz4f45bc02013-01-18 11:30:38 +0000601 /// \brief Sanitizer options to use for this function.
602 const SanitizerOptions *SanOpts;
603
John McCallf85e1932011-06-15 23:02:42 +0000604 /// In ARC, whether we should autorelease the return value.
605 bool AutoreleaseResult;
606
John McCalld16c2cf2011-02-08 08:22:06 +0000607 const CodeGen::CGBlockInfo *BlockInfo;
608 llvm::Value *BlockPointer;
609
Eli Friedmancec5ebd2012-02-11 02:57:39 +0000610 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
611 FieldDecl *LambdaThisCaptureField;
612
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000613 /// \brief A mapping from NRVO variables to the flags used to indicate
614 /// when the NRVO has been applied to this variable.
615 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000616
John McCallf1549f62010-07-06 01:34:17 +0000617 EHScopeStack EHStack;
618
John McCallff8e1152010-07-23 21:56:41 +0000619 /// i32s containing the indexes of the cleanup destinations.
620 llvm::AllocaInst *NormalCleanupDest;
John McCallff8e1152010-07-23 21:56:41 +0000621
622 unsigned NextCleanupDestIndex;
623
John McCall1a343eb2011-11-10 08:15:53 +0000624 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
625 CGBlockInfo *FirstBlockInfo;
626
John McCall777d6e52011-08-11 02:22:43 +0000627 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
628 llvm::BasicBlock *EHResumeBlock;
629
Bill Wendling285cfd82011-09-19 20:31:14 +0000630 /// The exception slot. All landing pads write the current exception pointer
631 /// into this alloca.
John McCallf1549f62010-07-06 01:34:17 +0000632 llvm::Value *ExceptionSlot;
633
Bill Wendling285cfd82011-09-19 20:31:14 +0000634 /// The selector slot. Under the MandatoryCleanup model, all landing pads
635 /// write the current selector value into this alloca.
John McCall93c332a2011-05-28 21:13:02 +0000636 llvm::AllocaInst *EHSelectorSlot;
637
John McCallf1549f62010-07-06 01:34:17 +0000638 /// Emits a landing pad for the current EH stack.
639 llvm::BasicBlock *EmitLandingPad();
640
641 llvm::BasicBlock *getInvokeDestImpl();
642
John McCall150b4622011-01-26 04:00:11 +0000643 template <class T>
John McCall804b8072011-01-28 10:53:53 +0000644 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
645 return DominatingValue<T>::save(*this, value);
John McCall150b4622011-01-26 04:00:11 +0000646 }
647
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000648public:
Anders Carlssonfa1f7562009-02-10 06:07:49 +0000649 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
650 /// rethrows.
Chris Lattner686775d2011-07-20 06:58:45 +0000651 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stump0dd9e882009-02-08 23:14:22 +0000652
John McCalld768e9d2011-06-22 02:32:12 +0000653 /// A class controlling the emission of a finally block.
654 class FinallyInfo {
655 /// Where the catchall's edge through the cleanup should go.
656 JumpDest RethrowDest;
Anders Carlssonbb66f9f2009-02-08 07:46:24 +0000657
John McCalld768e9d2011-06-22 02:32:12 +0000658 /// A function to call to enter the catch.
659 llvm::Constant *BeginCatchFn;
660
661 /// An i1 variable indicating whether or not the @finally is
662 /// running for an exception.
663 llvm::AllocaInst *ForEHVar;
664
665 /// An i8* variable into which the exception pointer to rethrow
666 /// has been saved.
667 llvm::AllocaInst *SavedExnVar;
668
669 public:
670 void enter(CodeGenFunction &CGF, const Stmt *Finally,
671 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
672 llvm::Constant *rethrowFn);
673 void exit(CodeGenFunction &CGF);
674 };
Mike Stumpd88ea562009-12-09 03:35:49 +0000675
John McCall150b4622011-01-26 04:00:11 +0000676 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
677 /// current full-expression. Safe against the possibility that
678 /// we're currently inside a conditionally-evaluated expression.
John McCall3ad32c82011-01-28 08:37:24 +0000679 template <class T, class A0>
680 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
681 // If we're not in a conditional branch, or if none of the
682 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000683 if (!isInConditionalBranch())
684 return EHStack.pushCleanup<T>(kind, a0);
John McCall3ad32c82011-01-28 08:37:24 +0000685
John McCall804b8072011-01-28 10:53:53 +0000686 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCall3ad32c82011-01-28 08:37:24 +0000687
688 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
689 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
690 initFullExprCleanup();
691 }
692
693 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
694 /// current full-expression. Safe against the possibility that
695 /// we're currently inside a conditionally-evaluated expression.
John McCall150b4622011-01-26 04:00:11 +0000696 template <class T, class A0, class A1>
697 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
698 // If we're not in a conditional branch, or if none of the
699 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000700 if (!isInConditionalBranch())
701 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCall150b4622011-01-26 04:00:11 +0000702
John McCall804b8072011-01-28 10:53:53 +0000703 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
704 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCall150b4622011-01-26 04:00:11 +0000705
706 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCall3ad32c82011-01-28 08:37:24 +0000707 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
708 initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000709 }
710
Douglas Gregord7b23162011-06-22 16:12:01 +0000711 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
712 /// current full-expression. Safe against the possibility that
713 /// we're currently inside a conditionally-evaluated expression.
714 template <class T, class A0, class A1, class A2>
715 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
716 // If we're not in a conditional branch, or if none of the
717 // arguments requires saving, then use the unconditional cleanup.
718 if (!isInConditionalBranch()) {
John McCallc4a1a842011-07-12 00:15:30 +0000719 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregord7b23162011-06-22 16:12:01 +0000720 }
721
722 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
723 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
724 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
725
726 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
727 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
728 initFullExprCleanup();
729 }
730
John McCall9928c482011-07-12 16:41:08 +0000731 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
732 /// current full-expression. Safe against the possibility that
733 /// we're currently inside a conditionally-evaluated expression.
734 template <class T, class A0, class A1, class A2, class A3>
735 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
736 // If we're not in a conditional branch, or if none of the
737 // arguments requires saving, then use the unconditional cleanup.
738 if (!isInConditionalBranch()) {
739 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
740 }
741
742 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
743 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
744 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
745 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
746
747 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
748 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
749 a2_saved, a3_saved);
750 initFullExprCleanup();
751 }
752
John McCall6f103ba2011-11-10 10:43:54 +0000753 /// Set up the last cleaup that was pushed as a conditional
754 /// full-expression cleanup.
755 void initFullExprCleanup();
756
John McCallf1549f62010-07-06 01:34:17 +0000757 /// PushDestructorCleanup - Push a cleanup to call the
758 /// complete-object destructor of an object of the given type at the
759 /// given address. Does nothing if T is not a C++ class type with a
760 /// non-trivial destructor.
761 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
762
John McCall81407d42010-07-21 06:29:51 +0000763 /// PushDestructorCleanup - Push a cleanup to call the
764 /// complete-object variant of the given destructor on the object at
765 /// the given address.
766 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
767 llvm::Value *Addr);
768
John McCallf1549f62010-07-06 01:34:17 +0000769 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
770 /// process all branch fixups.
John McCallff8e1152010-07-23 21:56:41 +0000771 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallf1549f62010-07-06 01:34:17 +0000772
John McCall7d8647f2010-09-14 07:57:04 +0000773 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
774 /// The block cannot be reactivated. Pops it if it's the top of the
775 /// stack.
John McCall6f103ba2011-11-10 10:43:54 +0000776 ///
777 /// \param DominatingIP - An instruction which is known to
778 /// dominate the current IP (if set) and which lies along
779 /// all paths of execution between the current IP and the
780 /// the point at which the cleanup comes into scope.
781 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
782 llvm::Instruction *DominatingIP);
John McCall7d8647f2010-09-14 07:57:04 +0000783
784 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
785 /// Cannot be used to resurrect a deactivated cleanup.
John McCall6f103ba2011-11-10 10:43:54 +0000786 ///
787 /// \param DominatingIP - An instruction which is known to
788 /// dominate the current IP (if set) and which lies along
789 /// all paths of execution between the current IP and the
790 /// the point at which the cleanup comes into scope.
791 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
792 llvm::Instruction *DominatingIP);
John McCallcd2d2b72010-08-13 21:20:51 +0000793
John McCallf1549f62010-07-06 01:34:17 +0000794 /// \brief Enters a new scope for capturing cleanups, all of which
795 /// will be executed once the scope is exited.
796 class RunCleanupsScope {
John McCallf1549f62010-07-06 01:34:17 +0000797 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000798 bool OldDidCallStackSave;
Douglas Gregor5656e142009-11-24 21:15:44 +0000799 bool PerformCleanup;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000800
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000801 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
802 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000803
Eric Christopherc3287792011-10-19 00:43:52 +0000804 protected:
805 CodeGenFunction& CGF;
Will Dietz4f45bc02013-01-18 11:30:38 +0000806
Douglas Gregor01234bb2009-11-24 16:43:22 +0000807 public:
808 /// \brief Enter a new cleanup scope.
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000809 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christopherc3287792011-10-19 00:43:52 +0000810 : PerformCleanup(true), CGF(CGF)
Douglas Gregor5656e142009-11-24 21:15:44 +0000811 {
John McCallf1549f62010-07-06 01:34:17 +0000812 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor01234bb2009-11-24 16:43:22 +0000813 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis4ada2ca2010-09-14 00:42:34 +0000814 CGF.DidCallStackSave = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000815 }
816
817 /// \brief Exit this cleanup scope, emitting any accumulated
818 /// cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000819 ~RunCleanupsScope() {
Douglas Gregor5656e142009-11-24 21:15:44 +0000820 if (PerformCleanup) {
821 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000822 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000823 }
824 }
825
826 /// \brief Determine whether this scope requires any cleanups.
827 bool requiresCleanups() const {
John McCallf1549f62010-07-06 01:34:17 +0000828 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor5656e142009-11-24 21:15:44 +0000829 }
830
831 /// \brief Force the emission of cleanups now, instead of waiting
832 /// until this object is destroyed.
833 void ForceCleanup() {
834 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor01234bb2009-11-24 16:43:22 +0000835 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000836 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000837 PerformCleanup = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000838 }
839 };
840
Eric Christopherc3287792011-10-19 00:43:52 +0000841 class LexicalScope: protected RunCleanupsScope {
842 SourceRange Range;
843 bool PopDebugStack;
844
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000845 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
846 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christopherc3287792011-10-19 00:43:52 +0000847
848 public:
849 /// \brief Enter a new cleanup scope.
850 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
851 : RunCleanupsScope(CGF), Range(Range), PopDebugStack(true) {
852 if (CGDebugInfo *DI = CGF.getDebugInfo())
853 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
854 }
855
856 /// \brief Exit this cleanup scope, emitting any accumulated
857 /// cleanups.
858 ~LexicalScope() {
859 if (PopDebugStack) {
Eric Christopherc852e9f2012-07-11 15:32:13 +0000860 CGDebugInfo *DI = CGF.getDebugInfo();
861 if (DI) DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
Eric Christopherc3287792011-10-19 00:43:52 +0000862 }
863 }
864
865 /// \brief Force the emission of cleanups now, instead of waiting
866 /// until this object is destroyed.
867 void ForceCleanup() {
868 RunCleanupsScope::ForceCleanup();
869 if (CGDebugInfo *DI = CGF.getDebugInfo()) {
870 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
871 PopDebugStack = false;
872 }
873 }
874 };
875
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000876
John McCallf1549f62010-07-06 01:34:17 +0000877 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
878 /// the cleanup blocks that have been added.
879 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000880
John McCallff8e1152010-07-23 21:56:41 +0000881 void ResolveBranchFixups(llvm::BasicBlock *Target);
882
John McCallf1549f62010-07-06 01:34:17 +0000883 /// The given basic block lies in the current EH scope, but may be a
884 /// target of a potentially scope-crossing jump; get a stable handle
885 /// to which we can perform this jump later.
John McCallff8e1152010-07-23 21:56:41 +0000886 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCall413e6772010-07-28 01:07:35 +0000887 return JumpDest(Target,
888 EHStack.getInnermostNormalCleanup(),
889 NextCleanupDestIndex++);
John McCallf1549f62010-07-06 01:34:17 +0000890 }
Anders Carlssonc71c8452009-02-07 23:50:39 +0000891
John McCallf1549f62010-07-06 01:34:17 +0000892 /// The given basic block lies in the current EH scope, but may be a
893 /// target of a potentially scope-crossing jump; get a stable handle
894 /// to which we can perform this jump later.
Chris Lattner686775d2011-07-20 06:58:45 +0000895 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallff8e1152010-07-23 21:56:41 +0000896 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallf1549f62010-07-06 01:34:17 +0000897 }
898
899 /// EmitBranchThroughCleanup - Emit a branch from the current insert
900 /// block through the normal cleanup handling code (if any) and then
901 /// on to \arg Dest.
902 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerb11f9192011-04-17 00:54:30 +0000903
904 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
905 /// specified destination obviously has no cleanups to run. 'false' is always
906 /// a conservatively correct answer for this method.
907 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallf1549f62010-07-06 01:34:17 +0000908
John McCall777d6e52011-08-11 02:22:43 +0000909 /// popCatchScope - Pops the catch scope at the top of the EHScope
910 /// stack, emitting any required code (other than the catch handlers
911 /// themselves).
912 void popCatchScope();
John McCallff8e1152010-07-23 21:56:41 +0000913
David Chisnallc6860042012-11-07 16:50:40 +0000914 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall777d6e52011-08-11 02:22:43 +0000915 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stump0dd9e882009-02-08 23:14:22 +0000916
John McCall150b4622011-01-26 04:00:11 +0000917 /// An object to manage conditionally-evaluated expressions.
918 class ConditionalEvaluation {
919 llvm::BasicBlock *StartBB;
Mike Stump1eb44332009-09-09 15:08:12 +0000920
John McCall150b4622011-01-26 04:00:11 +0000921 public:
922 ConditionalEvaluation(CodeGenFunction &CGF)
923 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000924
John McCall150b4622011-01-26 04:00:11 +0000925 void begin(CodeGenFunction &CGF) {
926 assert(CGF.OutermostConditional != this);
927 if (!CGF.OutermostConditional)
928 CGF.OutermostConditional = this;
929 }
930
931 void end(CodeGenFunction &CGF) {
932 assert(CGF.OutermostConditional != 0);
933 if (CGF.OutermostConditional == this)
934 CGF.OutermostConditional = 0;
935 }
936
937 /// Returns a block which will be executed prior to each
938 /// evaluation of the conditional code.
939 llvm::BasicBlock *getStartingBlock() const {
940 return StartBB;
941 }
942 };
Mike Stump1eb44332009-09-09 15:08:12 +0000943
John McCall3019c442010-09-17 00:50:28 +0000944 /// isInConditionalBranch - Return true if we're currently emitting
945 /// one branch or the other of a conditional expression.
John McCall150b4622011-01-26 04:00:11 +0000946 bool isInConditionalBranch() const { return OutermostConditional != 0; }
947
John McCall6f103ba2011-11-10 10:43:54 +0000948 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
949 assert(isInConditionalBranch());
950 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
951 new llvm::StoreInst(value, addr, &block->back());
952 }
953
John McCall150b4622011-01-26 04:00:11 +0000954 /// An RAII object to record that we're evaluating a statement
955 /// expression.
956 class StmtExprEvaluation {
957 CodeGenFunction &CGF;
958
959 /// We have to save the outermost conditional: cleanups in a
960 /// statement expression aren't conditional just because the
961 /// StmtExpr is.
962 ConditionalEvaluation *SavedOutermostConditional;
963
964 public:
965 StmtExprEvaluation(CodeGenFunction &CGF)
966 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
967 CGF.OutermostConditional = 0;
968 }
969
970 ~StmtExprEvaluation() {
971 CGF.OutermostConditional = SavedOutermostConditional;
972 CGF.EnsureInsertPoint();
973 }
974 };
John McCalle996ffd2011-02-16 08:02:54 +0000975
John McCall56ca35d2011-02-17 10:25:35 +0000976 /// An object which temporarily prevents a value from being
977 /// destroyed by aggressive peephole optimizations that assume that
978 /// all uses of a value have been realized in the IR.
979 class PeepholeProtection {
980 llvm::Instruction *Inst;
981 friend class CodeGenFunction;
982
983 public:
984 PeepholeProtection() : Inst(0) {}
John McCall4b9c2d22011-11-06 09:01:30 +0000985 };
John McCall56ca35d2011-02-17 10:25:35 +0000986
John McCall4b9c2d22011-11-06 09:01:30 +0000987 /// A non-RAII class containing all the information about a bound
988 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
989 /// this which makes individual mappings very simple; using this
990 /// class directly is useful when you have a variable number of
991 /// opaque values or don't want the RAII functionality for some
992 /// reason.
993 class OpaqueValueMappingData {
John McCalle996ffd2011-02-16 08:02:54 +0000994 const OpaqueValueExpr *OpaqueValue;
John McCall56ca35d2011-02-17 10:25:35 +0000995 bool BoundLValue;
996 CodeGenFunction::PeepholeProtection Protection;
John McCalle996ffd2011-02-16 08:02:54 +0000997
John McCall4b9c2d22011-11-06 09:01:30 +0000998 OpaqueValueMappingData(const OpaqueValueExpr *ov,
999 bool boundLValue)
1000 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCalle996ffd2011-02-16 08:02:54 +00001001 public:
John McCall4b9c2d22011-11-06 09:01:30 +00001002 OpaqueValueMappingData() : OpaqueValue(0) {}
1003
John McCall56ca35d2011-02-17 10:25:35 +00001004 static bool shouldBindAsLValue(const Expr *expr) {
John McCalla5493f82011-11-08 22:54:08 +00001005 // gl-values should be bound as l-values for obvious reasons.
1006 // Records should be bound as l-values because IR generation
1007 // always keeps them in memory. Expressions of function type
1008 // act exactly like l-values but are formally required to be
1009 // r-values in C.
1010 return expr->isGLValue() ||
1011 expr->getType()->isRecordType() ||
1012 expr->getType()->isFunctionType();
John McCall56ca35d2011-02-17 10:25:35 +00001013 }
1014
John McCall4b9c2d22011-11-06 09:01:30 +00001015 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1016 const OpaqueValueExpr *ov,
1017 const Expr *e) {
1018 if (shouldBindAsLValue(ov))
1019 return bind(CGF, ov, CGF.EmitLValue(e));
1020 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1021 }
1022
1023 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1024 const OpaqueValueExpr *ov,
1025 const LValue &lv) {
1026 assert(shouldBindAsLValue(ov));
1027 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1028 return OpaqueValueMappingData(ov, true);
1029 }
1030
1031 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1032 const OpaqueValueExpr *ov,
1033 const RValue &rv) {
1034 assert(!shouldBindAsLValue(ov));
1035 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1036
1037 OpaqueValueMappingData data(ov, false);
1038
1039 // Work around an extremely aggressive peephole optimization in
1040 // EmitScalarConversion which assumes that all other uses of a
1041 // value are extant.
1042 data.Protection = CGF.protectFromPeepholes(rv);
1043
1044 return data;
1045 }
1046
1047 bool isValid() const { return OpaqueValue != 0; }
1048 void clear() { OpaqueValue = 0; }
1049
1050 void unbind(CodeGenFunction &CGF) {
1051 assert(OpaqueValue && "no data to unbind!");
1052
1053 if (BoundLValue) {
1054 CGF.OpaqueLValues.erase(OpaqueValue);
1055 } else {
1056 CGF.OpaqueRValues.erase(OpaqueValue);
1057 CGF.unprotectFromPeepholes(Protection);
1058 }
1059 }
1060 };
1061
1062 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1063 class OpaqueValueMapping {
1064 CodeGenFunction &CGF;
1065 OpaqueValueMappingData Data;
1066
1067 public:
1068 static bool shouldBindAsLValue(const Expr *expr) {
1069 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1070 }
1071
John McCall56ca35d2011-02-17 10:25:35 +00001072 /// Build the opaque value mapping for the given conditional
1073 /// operator if it's the GNU ?: extension. This is a common
1074 /// enough pattern that the convenience operator is really
1075 /// helpful.
1076 ///
1077 OpaqueValueMapping(CodeGenFunction &CGF,
1078 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCall4b9c2d22011-11-06 09:01:30 +00001079 if (isa<ConditionalOperator>(op))
1080 // Leave Data empty.
John McCall56ca35d2011-02-17 10:25:35 +00001081 return;
John McCall56ca35d2011-02-17 10:25:35 +00001082
1083 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCall4b9c2d22011-11-06 09:01:30 +00001084 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1085 e->getCommon());
John McCall56ca35d2011-02-17 10:25:35 +00001086 }
1087
John McCalle996ffd2011-02-16 08:02:54 +00001088 OpaqueValueMapping(CodeGenFunction &CGF,
1089 const OpaqueValueExpr *opaqueValue,
John McCall56ca35d2011-02-17 10:25:35 +00001090 LValue lvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001091 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCall56ca35d2011-02-17 10:25:35 +00001092 }
1093
1094 OpaqueValueMapping(CodeGenFunction &CGF,
1095 const OpaqueValueExpr *opaqueValue,
1096 RValue rvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001097 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCalle996ffd2011-02-16 08:02:54 +00001098 }
1099
1100 void pop() {
John McCall4b9c2d22011-11-06 09:01:30 +00001101 Data.unbind(CGF);
1102 Data.clear();
John McCalle996ffd2011-02-16 08:02:54 +00001103 }
1104
1105 ~OpaqueValueMapping() {
John McCall4b9c2d22011-11-06 09:01:30 +00001106 if (Data.isValid()) Data.unbind(CGF);
John McCalle996ffd2011-02-16 08:02:54 +00001107 }
1108 };
Fariborz Jahaniane2204552010-11-16 19:29:39 +00001109
1110 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1111 /// number that holds the value.
1112 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian52a80e12011-01-26 23:08:27 +00001113
1114 /// BuildBlockByrefAddress - Computes address location of the
1115 /// variable which is declared as __block.
1116 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1117 const VarDecl *V);
Chris Lattner7f02f722007-08-24 05:35:26 +00001118private:
Chris Lattnerd9becd12009-10-28 23:59:40 +00001119 CGDebugInfo *DebugInfo;
Devang Patelaa112892011-03-07 18:45:56 +00001120 bool DisableDebugInfo;
Mike Stump09429b92009-02-17 17:00:02 +00001121
John McCall93c332a2011-05-28 21:13:02 +00001122 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1123 /// calling llvm.stacksave for multiple VLAs in the same scope.
1124 bool DidCallStackSave;
1125
Mike Stumpf71d2322009-11-30 20:08:49 +00001126 /// IndirectBranch - The first time an indirect goto is seen we create a block
1127 /// with an indirect branch. Every time we see the address of a label taken,
1128 /// we add the label to the indirect goto. Every subsequent indirect goto is
1129 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattnerd9becd12009-10-28 23:59:40 +00001130 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001131
Mike Stump0dd9e882009-02-08 23:14:22 +00001132 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1133 /// decls.
John McCall6b5a61b2011-02-07 10:33:21 +00001134 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1135 DeclMapTy LocalDeclMap;
Reid Spencer5f016e22007-07-11 17:01:13 +00001136
1137 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001138 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001139
Mike Stump0dd9e882009-02-08 23:14:22 +00001140 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone4b6d342009-02-10 05:52:02 +00001141 // statements should jump to.
Chris Lattnerda138702007-07-16 21:28:45 +00001142 struct BreakContinue {
John McCallf1549f62010-07-06 01:34:17 +00001143 BreakContinue(JumpDest Break, JumpDest Continue)
1144 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stump0dd9e882009-02-08 23:14:22 +00001145
John McCallf1549f62010-07-06 01:34:17 +00001146 JumpDest BreakBlock;
1147 JumpDest ContinueBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001148 };
Chris Lattner686775d2011-07-20 06:58:45 +00001149 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +00001150
Zhongxing Xu170fd492012-01-14 09:08:15 +00001151 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stump0dd9e882009-02-08 23:14:22 +00001152 /// current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +00001153 llvm::SwitchInst *SwitchInsn;
1154
Mike Stump0dd9e882009-02-08 23:14:22 +00001155 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel80fd5f92007-10-09 17:08:50 +00001156 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +00001157 llvm::BasicBlock *CaseRangeBlock;
1158
John McCall56ca35d2011-02-17 10:25:35 +00001159 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCalle996ffd2011-02-16 08:02:54 +00001160 /// expressions.
John McCall56ca35d2011-02-17 10:25:35 +00001161 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1162 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCalle996ffd2011-02-16 08:02:54 +00001163
Mike Stump0dd9e882009-02-08 23:14:22 +00001164 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001165 // We track this by the size expression rather than the type itself because
1166 // in certain situations, like a const qualifier applied to an VLA typedef,
1167 // multiple VLA types can share the same size expression.
Mike Stump0dd9e882009-02-08 23:14:22 +00001168 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1169 // enter/leave scopes.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001170 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001171
John McCallf1549f62010-07-06 01:34:17 +00001172 /// A block containing a single 'unreachable' instruction. Created
1173 /// lazily by getUnreachableBlock().
1174 llvm::BasicBlock *UnreachableBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001175
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001176 /// CXXThisDecl - When generating code for a C++ member function,
1177 /// this will hold the implicit 'this' declaration.
Eli Friedmancec5ebd2012-02-11 02:57:39 +00001178 ImplicitParamDecl *CXXABIThisDecl;
1179 llvm::Value *CXXABIThisValue;
John McCall25049412010-02-16 22:04:33 +00001180 llvm::Value *CXXThisValue;
Mike Stump1eb44332009-09-09 15:08:12 +00001181
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001182 /// CXXVTTDecl - When generating code for a base object constructor or
1183 /// base object destructor with virtual bases, this will hold the implicit
1184 /// VTT parameter.
1185 ImplicitParamDecl *CXXVTTDecl;
John McCall25049412010-02-16 22:04:33 +00001186 llvm::Value *CXXVTTValue;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001187
John McCall150b4622011-01-26 04:00:11 +00001188 /// OutermostConditional - Points to the outermost active
1189 /// conditional control. This is used so that we know if a
1190 /// temporary should be destroyed conditionally.
1191 ConditionalEvaluation *OutermostConditional;
Mike Stump1eb44332009-09-09 15:08:12 +00001192
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001193
1194 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1195 /// type as well as the field number that contains the actual data.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001196 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001197 unsigned> > ByRefValueInfo;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001198
John McCallf1549f62010-07-06 01:34:17 +00001199 llvm::BasicBlock *TerminateLandingPad;
Mike Stump182f3832009-12-10 00:02:42 +00001200 llvm::BasicBlock *TerminateHandler;
Chris Lattner83252dc2010-07-20 21:07:09 +00001201 llvm::BasicBlock *TrapBB;
Eli Friedman94067052009-12-10 02:21:21 +00001202
Tanya Lattner0df579e2012-07-09 22:06:01 +00001203 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1204 /// In the kernel metadata node, reference the kernel function and metadata
1205 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
1206 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1207 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1208 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1209 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1210 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1211 llvm::Function *Fn);
1212
Reid Spencer5f016e22007-07-11 17:01:13 +00001213public:
Fariborz Jahanian4904bf42012-06-26 16:06:38 +00001214 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall1a343eb2011-11-10 08:15:53 +00001215 ~CodeGenFunction();
Mike Stump0dd9e882009-02-08 23:14:22 +00001216
John McCall1e7fe752010-09-02 09:58:18 +00001217 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCallf2aac842011-05-15 02:34:36 +00001218 ASTContext &getContext() const { return CGM.getContext(); }
Alexey Samsonova240df22012-10-16 07:22:28 +00001219 /// Returns true if DebugInfo is actually initialized.
1220 bool maybeInitializeDebugInfo() {
1221 if (CGM.getModuleDebugInfo()) {
1222 DebugInfo = CGM.getModuleDebugInfo();
1223 return true;
1224 }
1225 return false;
1226 }
Devang Patelaa112892011-03-07 18:45:56 +00001227 CGDebugInfo *getDebugInfo() {
1228 if (DisableDebugInfo)
1229 return NULL;
1230 return DebugInfo;
1231 }
1232 void disableDebugInfo() { DisableDebugInfo = true; }
1233 void enableDebugInfo() { DisableDebugInfo = false; }
1234
John McCallf85e1932011-06-15 23:02:42 +00001235 bool shouldUseFusedARCCalls() {
1236 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1237 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001238
David Blaikie4e4d0842012-03-11 07:00:24 +00001239 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCalld16c2cf2011-02-08 08:22:06 +00001240
Bill Wendling285cfd82011-09-19 20:31:14 +00001241 /// Returns a pointer to the function's exception object and selector slot,
1242 /// which is assigned in every landing pad.
John McCallf1549f62010-07-06 01:34:17 +00001243 llvm::Value *getExceptionSlot();
John McCall93c332a2011-05-28 21:13:02 +00001244 llvm::Value *getEHSelectorSlot();
John McCallf1549f62010-07-06 01:34:17 +00001245
Bill Wendlingae270592011-09-15 18:57:19 +00001246 /// Returns the contents of the function's exception object and selector
1247 /// slots.
1248 llvm::Value *getExceptionFromSlot();
1249 llvm::Value *getSelectorFromSlot();
1250
John McCallff8e1152010-07-23 21:56:41 +00001251 llvm::Value *getNormalCleanupDestSlot();
John McCallff8e1152010-07-23 21:56:41 +00001252
John McCallf1549f62010-07-06 01:34:17 +00001253 llvm::BasicBlock *getUnreachableBlock() {
1254 if (!UnreachableBlock) {
1255 UnreachableBlock = createBasicBlock("unreachable");
1256 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1257 }
1258 return UnreachableBlock;
1259 }
1260
1261 llvm::BasicBlock *getInvokeDest() {
1262 if (!EHStack.requiresLandingPad()) return 0;
1263 return getInvokeDestImpl();
1264 }
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001265
John McCalld16c2cf2011-02-08 08:22:06 +00001266 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Anderson69243822009-07-13 04:10:07 +00001267
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001268 //===--------------------------------------------------------------------===//
John McCallbdc4d802011-07-09 01:37:26 +00001269 // Cleanups
1270 //===--------------------------------------------------------------------===//
1271
1272 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1273
John McCall2673c682011-07-11 08:38:19 +00001274 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1275 llvm::Value *arrayEndPointer,
1276 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001277 Destroyer *destroyer);
John McCall2673c682011-07-11 08:38:19 +00001278 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1279 llvm::Value *arrayEnd,
1280 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001281 Destroyer *destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001282
John McCall9928c482011-07-12 16:41:08 +00001283 void pushDestroy(QualType::DestructionKind dtorKind,
1284 llvm::Value *addr, QualType type);
John McCallbdc4d802011-07-09 01:37:26 +00001285 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001286 Destroyer *destroyer, bool useEHCleanupForArray);
1287 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001288 bool useEHCleanupForArray);
John McCalla91f6662011-07-13 03:01:35 +00001289 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1290 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001291 Destroyer *destroyer,
John McCalla91f6662011-07-13 03:01:35 +00001292 bool useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001293 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001294 QualType type, Destroyer *destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001295 bool checkZeroLength, bool useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001296
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001297 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall9928c482011-07-12 16:41:08 +00001298
John McCallbdc4d802011-07-09 01:37:26 +00001299 /// Determines whether an EH cleanup is required to destroy a type
1300 /// with the given destruction kind.
1301 bool needsEHCleanup(QualType::DestructionKind kind) {
1302 switch (kind) {
1303 case QualType::DK_none:
1304 return false;
1305 case QualType::DK_cxx_destructor:
1306 case QualType::DK_objc_weak_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001307 return getLangOpts().Exceptions;
John McCallbdc4d802011-07-09 01:37:26 +00001308 case QualType::DK_objc_strong_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001309 return getLangOpts().Exceptions &&
John McCallbdc4d802011-07-09 01:37:26 +00001310 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1311 }
1312 llvm_unreachable("bad destruction kind");
1313 }
1314
John McCall9928c482011-07-12 16:41:08 +00001315 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1316 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1317 }
1318
John McCallbdc4d802011-07-09 01:37:26 +00001319 //===--------------------------------------------------------------------===//
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001320 // Objective-C
1321 //===--------------------------------------------------------------------===//
1322
Chris Lattner391d77a2008-03-30 23:03:07 +00001323 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001324
Mike Stump0dd9e882009-02-08 23:14:22 +00001325 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patel8d3f8972011-05-19 23:37:41 +00001326 const ObjCContainerDecl *CD,
1327 SourceLocation StartLoc);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001328
Mike Stump0dd9e882009-02-08 23:14:22 +00001329 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001330 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1331 const ObjCPropertyImplDecl *PID);
John McCall1e1f4872011-09-13 03:34:09 +00001332 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001333 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanian490a52b2012-05-29 19:56:01 +00001334 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001335 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian2846b972011-02-18 19:15:13 +00001336
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001337 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1338 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001339
Mike Stump0dd9e882009-02-08 23:14:22 +00001340 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1341 /// for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001342 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1343 const ObjCPropertyImplDecl *PID);
John McCall71c758d2011-09-10 09:17:20 +00001344 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001345 const ObjCPropertyImplDecl *propImpl,
1346 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001347 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001348 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001349
Mike Stump4e7a1f72009-02-21 20:00:35 +00001350 //===--------------------------------------------------------------------===//
1351 // Block Bits
1352 //===--------------------------------------------------------------------===//
1353
John McCall6b5a61b2011-02-07 10:33:21 +00001354 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall1a343eb2011-11-10 08:15:53 +00001355 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1356 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garst2a7eb282010-02-23 21:51:17 +00001357 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00001358 const CGBlockInfo &Info,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001359 llvm::StructType *,
John McCalld16c2cf2011-02-08 08:22:06 +00001360 llvm::Constant *BlockVarLayout);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001361
Fariborz Jahanian564360b2010-06-24 00:08:06 +00001362 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall6b5a61b2011-02-07 10:33:21 +00001363 const CGBlockInfo &Info,
Mike Stump6cc88f72009-03-20 21:53:12 +00001364 const Decl *OuterFuncDecl,
Eli Friedman64bee652012-02-25 02:48:22 +00001365 const DeclMapTy &ldm,
1366 bool IsLambdaConversionToBlock);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001367
John McCalld16c2cf2011-02-08 08:22:06 +00001368 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1369 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00001370 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1371 const ObjCPropertyImplDecl *PID);
1372 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1373 const ObjCPropertyImplDecl *PID);
Eli Friedmancae40c42012-02-28 01:08:45 +00001374 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCalld16c2cf2011-02-08 08:22:06 +00001375
John McCalld16c2cf2011-02-08 08:22:06 +00001376 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1377
John McCall5af02db2011-03-31 01:59:53 +00001378 class AutoVarEmission;
1379
1380 void emitByrefStructureInit(const AutoVarEmission &emission);
1381 void enterByrefCleanup(const AutoVarEmission &emission);
1382
John McCall6b5a61b2011-02-07 10:33:21 +00001383 llvm::Value *LoadBlockStruct() {
1384 assert(BlockPointer && "no block pointer set!");
1385 return BlockPointer;
1386 }
Mike Stump4e7a1f72009-02-21 20:00:35 +00001387
John McCallea1471e2010-05-20 01:18:31 +00001388 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCallf4b88a42012-03-10 09:33:50 +00001389 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall6b5a61b2011-02-07 10:33:21 +00001390 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001391 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stumpdab514f2009-03-04 03:23:46 +00001392
John McCalld26bc762011-03-09 04:27:21 +00001393 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1394 const CGFunctionInfo &FnInfo);
Anders Carlsson0ff8baf2009-09-11 00:07:24 +00001395 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbar7c086512008-09-09 23:14:03 +00001396 llvm::Function *Fn,
John McCalld26bc762011-03-09 04:27:21 +00001397 const CGFunctionInfo &FnInfo,
Daniel Dunbar2284ac92008-10-18 18:22:23 +00001398 const FunctionArgList &Args,
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00001399 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001400
John McCall9fc6a772010-02-19 09:25:03 +00001401 void EmitConstructorBody(FunctionArgList &Args);
1402 void EmitDestructorBody(FunctionArgList &Args);
1403 void EmitFunctionBody(FunctionArgList &Args);
John McCalla355e072010-02-18 03:17:58 +00001404
Eli Friedman64bee652012-02-25 02:48:22 +00001405 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1406 CallArgList &CallArgs);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001407 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman64bee652012-02-25 02:48:22 +00001408 void EmitLambdaBlockInvokeBody();
Douglas Gregor27dd7d92012-02-17 03:02:34 +00001409 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1410 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001411
Mike Stump0dd9e882009-02-08 23:14:22 +00001412 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1413 /// emission when possible.
David Blaikiea6504852013-01-26 22:16:26 +00001414 bool EmitReturnBlock();
Daniel Dunbar1c1d6072009-01-26 23:27:52 +00001415
Mike Stump0dd9e882009-02-08 23:14:22 +00001416 /// FinishFunction - Complete IR generation of the current function. It is
1417 /// legal to call this function even if there is no current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001418 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001419
Anders Carlsson519c3282010-03-24 00:39:18 +00001420 /// GenerateThunk - Generate a thunk for the given method.
John McCalld26bc762011-03-09 04:27:21 +00001421 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1422 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001423
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00001424 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1425 GlobalDecl GD, const ThunkInfo &Thunk);
1426
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001427 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1428 FunctionArgList &Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001429
Eli Friedmanb74ed082012-02-14 02:31:03 +00001430 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1431 ArrayRef<VarDecl *> ArrayIndexes);
1432
Anders Carlssond103f9f2010-03-28 19:40:00 +00001433 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1434 /// subobject.
1435 ///
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001436 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001437 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001438 CharUnits OffsetFromNearestVBase,
Anders Carlssond103f9f2010-03-28 19:40:00 +00001439 llvm::Constant *VTable,
1440 const CXXRecordDecl *VTableClass);
1441
1442 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001443 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001444 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001445 CharUnits OffsetFromNearestVBase,
Anders Carlsson603d6d12010-03-28 21:07:49 +00001446 bool BaseIsNonVirtualPrimaryBase,
1447 llvm::Constant *VTable,
1448 const CXXRecordDecl *VTableClass,
1449 VisitedVirtualBasesSetTy& VBases);
Eli Friedman77a259c2009-12-08 06:46:18 +00001450
Anders Carlsson603d6d12010-03-28 21:07:49 +00001451 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001452
Dan Gohman043fb9a2010-10-26 18:44:08 +00001453 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1454 /// to by This.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001455 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001456
John McCall50da2ca2010-07-21 05:30:47 +00001457 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1458 /// given phase of destruction for a destructor. The end result
1459 /// should call destructors on members and base classes in reverse
1460 /// order of their construction.
1461 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001462
Chris Lattner7255a2d2010-06-22 00:03:40 +00001463 /// ShouldInstrumentFunction - Return true if the current function should be
1464 /// instrumented with __cyg_profile_func_* calls
1465 bool ShouldInstrumentFunction();
1466
1467 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1468 /// instrumentation function with the current function and the call site, if
1469 /// function instrumentation is enabled.
1470 void EmitFunctionInstrumentation(const char *Fn);
1471
Roman Divackybe4c8702011-02-10 16:52:03 +00001472 /// EmitMCountInstrumentation - Emit call to .mcount.
1473 void EmitMCountInstrumentation();
1474
Mike Stump0dd9e882009-02-08 23:14:22 +00001475 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1476 /// arguments for the given function. This is also responsible for naming the
1477 /// LLVM function arguments.
Daniel Dunbar88b53962009-02-02 22:03:45 +00001478 void EmitFunctionProlog(const CGFunctionInfo &FI,
1479 llvm::Function *Fn,
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001480 const FunctionArgList &Args);
1481
Mike Stump0dd9e882009-02-08 23:14:22 +00001482 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1483 /// given temporary.
Chris Lattner35b21b82010-06-27 01:06:27 +00001484 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001485
Mike Stumpcce3d4f2009-12-07 23:38:24 +00001486 /// EmitStartEHSpec - Emit the start of the exception spec.
1487 void EmitStartEHSpec(const Decl *D);
1488
1489 /// EmitEndEHSpec - Emit the end of the exception spec.
1490 void EmitEndEHSpec(const Decl *D);
1491
John McCallf1549f62010-07-06 01:34:17 +00001492 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1493 llvm::BasicBlock *getTerminateLandingPad();
1494
1495 /// getTerminateHandler - Return a handler (not a landing pad, just
1496 /// a catch handler) that just calls terminate. This is used when
1497 /// a terminate scope encloses a try.
Mike Stump9b39c512009-12-09 22:59:31 +00001498 llvm::BasicBlock *getTerminateHandler();
1499
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001500 llvm::Type *ConvertTypeForMem(QualType T);
1501 llvm::Type *ConvertType(QualType T);
1502 llvm::Type *ConvertType(const TypeDecl *T) {
John McCallbff225e2010-02-16 04:15:37 +00001503 return ConvertType(getContext().getTypeDeclType(T));
1504 }
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001505
Mike Stump0dd9e882009-02-08 23:14:22 +00001506 /// LoadObjCSelf - Load the value of self. This function is only valid while
1507 /// generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001508 llvm::Value *LoadObjCSelf();
Mike Stump0dd9e882009-02-08 23:14:22 +00001509
1510 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001511 QualType TypeOfSelfObject();
Chris Lattner41110242008-06-17 18:05:57 +00001512
Reid Spencer5f016e22007-07-11 17:01:13 +00001513 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1514 /// an aggregate LLVM type or is void.
1515 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar55e87422008-11-11 02:29:29 +00001516
1517 /// createBasicBlock - Create an LLVM basic block.
Richard Smith4def70d2012-10-09 19:52:38 +00001518 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
John McCalld16c2cf2011-02-08 08:22:06 +00001519 llvm::Function *parent = 0,
1520 llvm::BasicBlock *before = 0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001521#ifdef NDEBUG
John McCalld16c2cf2011-02-08 08:22:06 +00001522 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001523#else
John McCalld16c2cf2011-02-08 08:22:06 +00001524 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001525#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +00001526 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001527
Reid Spencer5f016e22007-07-11 17:01:13 +00001528 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1529 /// label maps to.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001530 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001531
Mike Stumpf71d2322009-11-30 20:08:49 +00001532 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1533 /// another basic block, simplify it. This assumes that no other code could
1534 /// potentially reference the basic block.
Daniel Dunbaraa5bd872009-04-01 04:37:47 +00001535 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1536
Mike Stump0dd9e882009-02-08 23:14:22 +00001537 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1538 /// adding a fall-through branch from the current insert block if
1539 /// necessary. It is legal to call this function even if there is no current
1540 /// insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001541 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001542 /// IsFinished - If true, indicates that the caller has finished emitting
1543 /// branches to the given block and does not expect to emit code into it. This
1544 /// means the block can be ignored if it is unreachable.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001545 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +00001546
John McCall777d6e52011-08-11 02:22:43 +00001547 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1548 /// near its uses, and leave the insertion point in it.
1549 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1550
Mike Stump0dd9e882009-02-08 23:14:22 +00001551 /// EmitBranch - Emit a branch to the specified basic block from the current
1552 /// insert block, taking care to avoid creation of branches from dummy
1553 /// blocks. It is legal to call this function even if there is no current
1554 /// insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +00001555 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001556 /// This function clears the current insertion point. The caller should follow
1557 /// calls to this function with calls to Emit*Block prior to generation new
1558 /// code.
Daniel Dunbard57a8712008-11-11 09:41:28 +00001559 void EmitBranch(llvm::BasicBlock *Block);
1560
Mike Stump0dd9e882009-02-08 23:14:22 +00001561 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1562 /// indicates that the current code being emitted is unreachable.
1563 bool HaveInsertPoint() const {
Daniel Dunbara448fb22008-11-11 23:11:34 +00001564 return Builder.GetInsertBlock() != 0;
1565 }
1566
Mike Stump0dd9e882009-02-08 23:14:22 +00001567 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1568 /// emitted IR has a place to go. Note that by definition, if this function
1569 /// creates a block then that block is unreachable; callers may do better to
1570 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001571 void EnsureInsertPoint() {
1572 if (!HaveInsertPoint())
1573 EmitBlock(createBasicBlock());
1574 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001575
Daniel Dunbar488e9932008-08-16 00:56:44 +00001576 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +00001577 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +00001578 void ErrorUnsupported(const Stmt *S, const char *Type,
1579 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +00001580
1581 //===--------------------------------------------------------------------===//
1582 // Helpers
1583 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001584
Eli Friedman6da2c712011-12-03 04:14:32 +00001585 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1586 CharUnits Alignment = CharUnits()) {
Dan Gohman3d5aff52010-10-14 23:06:10 +00001587 return LValue::MakeAddr(V, T, Alignment, getContext(),
1588 CGM.getTBAAInfo(T));
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001589 }
John McCalle0c11682012-07-02 23:58:38 +00001590
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001591 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001592 CharUnits Alignment;
1593 if (!T->isIncompleteType())
1594 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001595 return LValue::MakeAddr(V, T, Alignment, getContext(),
1596 CGM.getTBAAInfo(T));
1597 }
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001598
Reid Spencer5f016e22007-07-11 17:01:13 +00001599 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbar195337d2010-02-09 02:48:28 +00001600 /// block. The caller is responsible for setting an appropriate alignment on
1601 /// the alloca.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001602 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner8cc488f2011-07-20 07:06:53 +00001603 const Twine &Name = "tmp");
Mike Stump0dd9e882009-02-08 23:14:22 +00001604
John McCallac418162010-04-22 01:10:34 +00001605 /// InitTempAlloca - Provide an initial value for the given alloca.
1606 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1607
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001608 /// CreateIRTemp - Create a temporary IR object of the given type, with
1609 /// appropriate alignment. This routine should only be used when an temporary
1610 /// value needs to be stored into an alloca (for example, to avoid explicit
1611 /// PHI construction), but the type is the IR type, not the type appropriate
1612 /// for storing in memory.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001613 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001614
Daniel Dunbar195337d2010-02-09 02:48:28 +00001615 /// CreateMemTemp - Create a temporary memory object of the given type, with
1616 /// appropriate alignment.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001617 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar195337d2010-02-09 02:48:28 +00001618
John McCall558d2ab2010-09-15 10:14:12 +00001619 /// CreateAggTemp - Create a temporary memory object for the given
1620 /// aggregate type.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001621 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedmand7722d92011-12-03 02:13:40 +00001622 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanf3940782011-12-03 00:54:26 +00001623 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1624 T.getQualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +00001625 AggValueSlot::IsNotDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001626 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00001627 AggValueSlot::IsNotAliased);
John McCall558d2ab2010-09-15 10:14:12 +00001628 }
1629
John McCalld16c2cf2011-02-08 08:22:06 +00001630 /// Emit a cast to void* in the appropriate address space.
1631 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1632
Reid Spencer5f016e22007-07-11 17:01:13 +00001633 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1634 /// expression and compare the result against zero, returning an Int1Ty value.
1635 llvm::Value *EvaluateExprAsBool(const Expr *E);
1636
John McCall2a416372010-12-05 02:00:02 +00001637 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1638 void EmitIgnoredExpr(const Expr *E);
1639
Chris Lattner9b655512007-08-31 22:49:20 +00001640 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1641 /// any type. The result is returned as an RValue struct. If this is an
1642 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1643 /// the result should be returned.
Mike Stump49d1cd52009-05-26 22:03:21 +00001644 ///
Dmitri Gribenko70517ca2012-08-23 17:58:28 +00001645 /// \param ignoreResult True if the resulting value isn't used.
John McCall558d2ab2010-09-15 10:14:12 +00001646 RValue EmitAnyExpr(const Expr *E,
John McCalle0c11682012-07-02 23:58:38 +00001647 AggValueSlot aggSlot = AggValueSlot::ignored(),
1648 bool ignoreResult = false);
Devang Pateld9363c32007-09-28 21:49:18 +00001649
Mike Stump0dd9e882009-02-08 23:14:22 +00001650 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1651 // or the value of the expression, depending on how va_list is defined.
Eli Friedman4fd0aa52009-01-20 17:46:04 +00001652 llvm::Value *EmitVAListRef(const Expr *E);
1653
Mike Stump0dd9e882009-02-08 23:14:22 +00001654 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1655 /// always be accessible even if no aggregate location is provided.
John McCall558d2ab2010-09-15 10:14:12 +00001656 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar46f45b92008-09-09 01:06:48 +00001657
John McCall60d33652011-03-08 09:11:50 +00001658 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier649b4a12012-03-29 17:37:10 +00001659 /// arbitrary expression into the given memory location.
John McCall3d3ec1c2010-04-21 10:05:39 +00001660 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier649b4a12012-03-29 17:37:10 +00001661 Qualifiers Quals, bool IsInitializer);
John McCall3d3ec1c2010-04-21 10:05:39 +00001662
John McCall60d33652011-03-08 09:11:50 +00001663 /// EmitExprAsInit - Emits the code necessary to initialize a
1664 /// location in memory with the given initializer.
John McCallf85e1932011-06-15 23:02:42 +00001665 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001666 LValue lvalue, bool capturedByInit);
John McCall60d33652011-03-08 09:11:50 +00001667
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001668 /// hasVolatileMember - returns true if aggregate type has a volatile
1669 /// member.
1670 bool hasVolatileMember(QualType T) {
1671 if (const RecordType *RT = T->getAs<RecordType>()) {
1672 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1673 return RD->hasVolatileMember();
1674 }
1675 return false;
1676 }
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001677 /// EmitAggregateCopy - Emit an aggrate assignment.
1678 ///
1679 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1680 /// This is required for correctness when assigning non-POD structures in C++.
1681 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001682 QualType EltTy) {
1683 bool IsVolatile = hasVolatileMember(EltTy);
1684 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1685 true);
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001686 }
1687
Mike Stump27fe2e62009-05-23 22:29:41 +00001688 /// EmitAggregateCopy - Emit an aggrate copy.
1689 ///
Sylvestre Ledruf3477c12012-09-27 10:16:10 +00001690 /// \param isVolatile - True iff either the source or the destination is
Mike Stump27fe2e62009-05-23 22:29:41 +00001691 /// volatile.
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001692 /// \param isAssignment - If false, allow padding to be copied. This often
1693 /// yields more efficient.
Daniel Dunbar7482d122008-09-09 20:49:46 +00001694 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedmanbd7d8282011-12-05 22:23:28 +00001695 QualType EltTy, bool isVolatile=false,
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001696 CharUnits Alignment = CharUnits::Zero(),
1697 bool isAssignment = false);
Daniel Dunbar7482d122008-09-09 20:49:46 +00001698
Devang Patel51b09f22007-10-04 23:45:31 +00001699 /// StartBlock - Start new block named N. If insert block is a dummy block
1700 /// then reuse it.
1701 void StartBlock(const char *N);
1702
Anders Carlssondde0a942008-09-11 09:15:33 +00001703 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall4c40d982010-08-31 07:33:07 +00001704 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1705 llvm::Value *Res = LocalDeclMap[VD];
1706 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1707 return Res;
1708 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001709
John McCall56ca35d2011-02-17 10:25:35 +00001710 /// getOpaqueLValueMapping - Given an opaque value expression (which
1711 /// must be mapped to an l-value), return its mapping.
1712 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1713 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1714
1715 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1716 it = OpaqueLValues.find(e);
1717 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1718 return it->second;
1719 }
1720
1721 /// getOpaqueRValueMapping - Given an opaque value expression (which
1722 /// must be mapped to an r-value), return its mapping.
1723 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1724 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1725
1726 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1727 it = OpaqueRValues.find(e);
1728 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCalle996ffd2011-02-16 08:02:54 +00001729 return it->second;
1730 }
1731
Dan Gohman4f8d1232008-05-22 00:50:06 +00001732 /// getAccessedFieldNo - Given an encoded value and a result number, return
1733 /// the input field number being accessed.
1734 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1735
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001736 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner3d00fdc2009-10-13 06:55:33 +00001737 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001738
Anders Carlsson1884eb02010-05-22 17:35:42 +00001739 /// EmitNullInitialization - Generate code to set a value of the given type to
1740 /// null, If the type contains data member pointers, they will be initialized
1741 /// to -1 in accordance with the Itanium C++ ABI.
1742 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001743
1744 // EmitVAArg - Generate code to get an argument from the passed in pointer
1745 // and update it accordingly. The return value is a pointer to the argument.
1746 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stump0dd9e882009-02-08 23:14:22 +00001747 // instruction in LLVM instead once it works well enough.
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001748 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +00001749
John McCallbdc4d802011-07-09 01:37:26 +00001750 /// emitArrayLength - Compute the length of an array, even if it's a
1751 /// VLA, and drill down to the base element type.
1752 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1753 QualType &baseType,
1754 llvm::Value *&addr);
1755
John McCallbc8d40d2011-06-24 21:55:10 +00001756 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1757 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbard286f052009-07-19 06:58:07 +00001758 ///
1759 /// This function can be called with a null (unreachable) insert point.
John McCallbc8d40d2011-06-24 21:55:10 +00001760 void EmitVariablyModifiedType(QualType Ty);
Mike Stump0dd9e882009-02-08 23:14:22 +00001761
John McCallbc8d40d2011-06-24 21:55:10 +00001762 /// getVLASize - Returns an LLVM value that corresponds to the size,
1763 /// in non-variably-sized elements, of a variable length array type,
1764 /// plus that largest non-variably-sized element type. Assumes that
1765 /// the type has already been emitted with EmitVariablyModifiedType.
1766 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1767 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssondcc90d82008-12-12 07:19:02 +00001768
Anders Carlsson5f4307b2009-04-14 16:58:56 +00001769 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1770 /// generating code for an C++ member function.
John McCall25049412010-02-16 22:04:33 +00001771 llvm::Value *LoadCXXThis() {
1772 assert(CXXThisValue && "no 'this' value for this function");
1773 return CXXThisValue;
1774 }
Mike Stump1eb44332009-09-09 15:08:12 +00001775
Anders Carlssonc997d422010-01-02 01:01:18 +00001776 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1777 /// virtual bases.
John McCall25049412010-02-16 22:04:33 +00001778 llvm::Value *LoadCXXVTT() {
1779 assert(CXXVTTValue && "no VTT value for this function");
1780 return CXXVTTValue;
1781 }
John McCallbff225e2010-02-16 04:15:37 +00001782
1783 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlsson8561a862010-04-24 23:01:49 +00001784 /// complete class to the given direct base.
1785 llvm::Value *
1786 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1787 const CXXRecordDecl *Derived,
1788 const CXXRecordDecl *Base,
1789 bool BaseIsVirtual);
Anders Carlssona88ad562010-04-24 21:51:08 +00001790
Mike Stumpf71d2322009-11-30 20:08:49 +00001791 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1792 /// load of 'this' and returns address of the base class.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001793 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001794 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001795 CastExpr::path_const_iterator PathBegin,
1796 CastExpr::path_const_iterator PathEnd,
Anders Carlsson34a2d382010-04-24 21:06:20 +00001797 bool NullCheckValue);
1798
Anders Carlssona3697c92009-11-23 17:57:54 +00001799 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001800 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001801 CastExpr::path_const_iterator PathBegin,
1802 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +00001803 bool NullCheckValue);
1804
Anders Carlssonbb7e17b2010-01-31 01:36:53 +00001805 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1806 const CXXRecordDecl *ClassDecl,
1807 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001808
John McCallc0bf4622010-02-23 00:48:20 +00001809 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1810 CXXCtorType CtorType,
1811 const FunctionArgList &Args);
Sean Hunt059ce0d2011-05-01 07:04:31 +00001812 // It's important not to confuse this and the previous function. Delegating
1813 // constructors are the C++0x feature. The constructor delegate optimization
1814 // is used to reduce duplication in the base and complete consturctors where
1815 // they are substantially the same.
1816 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1817 const FunctionArgList &Args);
Anders Carlsson155ed4a2010-05-02 23:20:53 +00001818 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00001819 bool ForVirtualBase, bool Delegating,
1820 llvm::Value *This,
Anders Carlssonb14095a2009-04-17 00:06:03 +00001821 CallExpr::const_arg_iterator ArgBeg,
1822 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahanian34999872010-11-13 21:53:34 +00001823
1824 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1825 llvm::Value *This, llvm::Value *Src,
1826 CallExpr::const_arg_iterator ArgBeg,
1827 CallExpr::const_arg_iterator ArgEnd);
Mike Stump1eb44332009-09-09 15:08:12 +00001828
Fariborz Jahanian288dcaf2009-08-19 20:55:16 +00001829 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlsson569c1f42009-09-23 02:45:36 +00001830 const ConstantArrayType *ArrayTy,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001831 llvm::Value *ArrayPtr,
1832 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001833 CallExpr::const_arg_iterator ArgEnd,
1834 bool ZeroInitialization = false);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001835
Anders Carlsson569c1f42009-09-23 02:45:36 +00001836 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1837 llvm::Value *NumElements,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001838 llvm::Value *ArrayPtr,
1839 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001840 CallExpr::const_arg_iterator ArgEnd,
1841 bool ZeroInitialization = false);
Anders Carlssonb14095a2009-04-17 00:06:03 +00001842
John McCallbdc4d802011-07-09 01:37:26 +00001843 static Destroyer destroyCXXObject;
1844
Anders Carlsson7267c162009-05-29 21:03:38 +00001845 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00001846 bool ForVirtualBase, bool Delegating,
1847 llvm::Value *This);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001848
John McCall19705672011-09-15 06:49:18 +00001849 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1850 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump1eb44332009-09-09 15:08:12 +00001851
Peter Collingbourne86811602011-11-27 22:09:22 +00001852 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1853 llvm::Value *Ptr);
Mike Stump1eb44332009-09-09 15:08:12 +00001854
Anders Carlssona00703d2009-05-31 01:40:14 +00001855 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson60e282c2009-08-16 21:13:42 +00001856 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump1eb44332009-09-09 15:08:12 +00001857
Eli Friedman4bf81522009-11-18 00:57:03 +00001858 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1859 QualType DeleteTy);
1860
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001861 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stumpc849c052009-11-16 06:50:58 +00001862 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Weberc5f80462012-10-11 10:13:44 +00001863 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001864
Sebastian Redl972edf02012-02-19 16:03:09 +00001865 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
Sebastian Redlaf130fd2012-02-19 12:28:02 +00001866 void EmitStdInitializerListCleanup(llvm::Value *loc,
1867 const InitListExpr *init);
Sebastian Redl32cf1f22012-02-17 08:42:25 +00001868
Richard Smith2c9f87c2012-08-24 00:54:33 +00001869 /// \brief Situations in which we might emit a check for the suitability of a
1870 /// pointer or glvalue.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001871 enum TypeCheckKind {
Richard Smith2c9f87c2012-08-24 00:54:33 +00001872 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001873 TCK_Load,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001874 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001875 TCK_Store,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001876 /// Checking the bound value in a reference binding. Must be suitably sized
1877 /// and aligned, but is not required to refer to an object (until the
1878 /// reference is used), per core issue 453.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001879 TCK_ReferenceBinding,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001880 /// Checking the object expression in a non-static data member access. Must
1881 /// be an object within its lifetime.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001882 TCK_MemberAccess,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001883 /// Checking the 'this' pointer for a call to a non-static member function.
1884 /// Must be an object within its lifetime.
Richard Smith8e1cee62012-10-25 02:14:12 +00001885 TCK_MemberCall,
1886 /// Checking the 'this' pointer for a constructor call.
1887 TCK_ConstructorCall
Richard Smith2c9f87c2012-08-24 00:54:33 +00001888 };
1889
Richard Smith7ac9ef12012-09-08 02:08:36 +00001890 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith2c9f87c2012-08-24 00:54:33 +00001891 /// appropriate size and alignment for an object of type \p Type.
Richard Smith4def70d2012-10-09 19:52:38 +00001892 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Richard Smith7ac9ef12012-09-08 02:08:36 +00001893 QualType Type, CharUnits Alignment = CharUnits::Zero());
Mike Stumpb14e62d2009-12-16 02:57:00 +00001894
Chris Lattnerdd36d322010-01-09 21:40:03 +00001895 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1896 bool isInc, bool isPre);
1897 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1898 bool isInc, bool isPre);
Reid Spencer5f016e22007-07-11 17:01:13 +00001899 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +00001900 // Declaration Emission
1901 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001902
Daniel Dunbard286f052009-07-19 06:58:07 +00001903 /// EmitDecl - Emit a declaration.
1904 ///
1905 /// This function can be called with a null (unreachable) insert point.
Reid Spencer5f016e22007-07-11 17:01:13 +00001906 void EmitDecl(const Decl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001907
John McCallb6bbcc92010-10-15 04:57:14 +00001908 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001909 ///
1910 /// This function can be called with a null (unreachable) insert point.
John McCallb6bbcc92010-10-15 04:57:14 +00001911 void EmitVarDecl(const VarDecl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001912
John McCallf85e1932011-06-15 23:02:42 +00001913 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001914 LValue lvalue, bool capturedByInit);
John McCall7acddac2011-06-17 06:42:21 +00001915 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCallf85e1932011-06-15 23:02:42 +00001916
John McCallf1549f62010-07-06 01:34:17 +00001917 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1918 llvm::Value *Address);
1919
John McCallb6bbcc92010-10-15 04:57:14 +00001920 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001921 ///
1922 /// This function can be called with a null (unreachable) insert point.
John McCall34695852011-02-22 06:44:22 +00001923 void EmitAutoVarDecl(const VarDecl &D);
1924
1925 class AutoVarEmission {
1926 friend class CodeGenFunction;
1927
John McCall57b3b6a2011-02-22 07:16:58 +00001928 const VarDecl *Variable;
John McCall34695852011-02-22 06:44:22 +00001929
1930 /// The alignment of the variable.
1931 CharUnits Alignment;
1932
1933 /// The address of the alloca. Null if the variable was emitted
1934 /// as a global constant.
1935 llvm::Value *Address;
1936
1937 llvm::Value *NRVOFlag;
1938
1939 /// True if the variable is a __block variable.
1940 bool IsByRef;
1941
1942 /// True if the variable is of aggregate type and has a constant
1943 /// initializer.
1944 bool IsConstantAggregate;
1945
John McCall57b3b6a2011-02-22 07:16:58 +00001946 struct Invalid {};
1947 AutoVarEmission(Invalid) : Variable(0) {}
1948
John McCall34695852011-02-22 06:44:22 +00001949 AutoVarEmission(const VarDecl &variable)
John McCall57b3b6a2011-02-22 07:16:58 +00001950 : Variable(&variable), Address(0), NRVOFlag(0),
John McCall34695852011-02-22 06:44:22 +00001951 IsByRef(false), IsConstantAggregate(false) {}
1952
1953 bool wasEmittedAsGlobal() const { return Address == 0; }
1954
1955 public:
John McCall57b3b6a2011-02-22 07:16:58 +00001956 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
1957
John McCall34695852011-02-22 06:44:22 +00001958 /// Returns the address of the object within this declaration.
1959 /// Note that this does not chase the forwarding pointer for
1960 /// __block decls.
1961 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
1962 if (!IsByRef) return Address;
1963
1964 return CGF.Builder.CreateStructGEP(Address,
John McCall57b3b6a2011-02-22 07:16:58 +00001965 CGF.getByRefValueLLVMField(Variable),
1966 Variable->getNameAsString());
John McCall34695852011-02-22 06:44:22 +00001967 }
1968 };
1969 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
1970 void EmitAutoVarInit(const AutoVarEmission &emission);
1971 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCallbdc4d802011-07-09 01:37:26 +00001972 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
1973 QualType::DestructionKind dtorKind);
Daniel Dunbard286f052009-07-19 06:58:07 +00001974
John McCallb6bbcc92010-10-15 04:57:14 +00001975 void EmitStaticVarDecl(const VarDecl &D,
1976 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001977
1978 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel093ac462011-03-03 20:13:15 +00001979 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stump0dd9e882009-02-08 23:14:22 +00001980
John McCall56ca35d2011-02-17 10:25:35 +00001981 /// protectFromPeepholes - Protect a value that we're intending to
1982 /// store to the side, but which will probably be used later, from
1983 /// aggressive peepholing optimizations that might delete it.
1984 ///
1985 /// Pass the result to unprotectFromPeepholes to declare that
1986 /// protection is no longer required.
1987 ///
1988 /// There's no particular reason why this shouldn't apply to
1989 /// l-values, it's just that no existing peepholes work on pointers.
1990 PeepholeProtection protectFromPeepholes(RValue rvalue);
1991 void unprotectFromPeepholes(PeepholeProtection protection);
1992
Reid Spencer5f016e22007-07-11 17:01:13 +00001993 //===--------------------------------------------------------------------===//
1994 // Statement Emission
1995 //===--------------------------------------------------------------------===//
1996
Mike Stump0dd9e882009-02-08 23:14:22 +00001997 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar09124252008-11-12 08:21:33 +00001998 void EmitStopPoint(const Stmt *S);
1999
Mike Stump0dd9e882009-02-08 23:14:22 +00002000 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2001 /// this function even if there is no current insertion point.
2002 ///
2003 /// This function may clear the current insertion point; callers should use
2004 /// EnsureInsertPoint if they wish to subsequently generate code without first
2005 /// calling EmitBlock, EmitBranch, or EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +00002006 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +00002007
Daniel Dunbar09124252008-11-12 08:21:33 +00002008 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stump0dd9e882009-02-08 23:14:22 +00002009 /// necessarily require an insertion point or debug information; typically
2010 /// because the statement amounts to a jump or a container of other
2011 /// statements.
Daniel Dunbar09124252008-11-12 08:21:33 +00002012 ///
2013 /// \return True if the statement was handled.
2014 bool EmitSimpleStmt(const Stmt *S);
2015
Chris Lattner9b655512007-08-31 22:49:20 +00002016 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall558d2ab2010-09-15 10:14:12 +00002017 AggValueSlot AVS = AggValueSlot::ignored());
David Blaikiea6504852013-01-26 22:16:26 +00002018 RValue EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2019 bool GetLast = false, AggValueSlot AVS =
2020 AggValueSlot::ignored());
Daniel Dunbara448fb22008-11-11 23:11:34 +00002021
Mike Stump0dd9e882009-02-08 23:14:22 +00002022 /// EmitLabel - Emit the block for the given label. It is legal to call this
2023 /// function even if there is no current insertion point.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00002024 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +00002025
Reid Spencer5f016e22007-07-11 17:01:13 +00002026 void EmitLabelStmt(const LabelStmt &S);
Richard Smith534986f2012-04-14 00:33:13 +00002027 void EmitAttributedStmt(const AttributedStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00002028 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002029 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00002030 void EmitIfStmt(const IfStmt &S);
2031 void EmitWhileStmt(const WhileStmt &S);
2032 void EmitDoStmt(const DoStmt &S);
2033 void EmitForStmt(const ForStmt &S);
2034 void EmitReturnStmt(const ReturnStmt &S);
2035 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +00002036 void EmitBreakStmt(const BreakStmt &S);
2037 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +00002038 void EmitSwitchStmt(const SwitchStmt &S);
2039 void EmitDefaultStmt(const DefaultStmt &S);
2040 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +00002041 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosiera23b91d2012-08-28 18:54:39 +00002042 void EmitAsmStmt(const AsmStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00002043
Anders Carlsson3d8400d2008-08-30 19:51:14 +00002044 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00002045 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2046 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00002047 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCallf85e1932011-06-15 23:02:42 +00002048 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00002049
John McCall93c332a2011-05-28 21:13:02 +00002050 llvm::Constant *getUnwindResumeFn();
Douglas Gregor86a3a032010-05-16 01:24:12 +00002051 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCall59a70002010-07-07 06:56:46 +00002052 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2053 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCall9fc6a772010-02-19 09:25:03 +00002054
Anders Carlsson6815e942009-09-27 18:58:34 +00002055 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smithad762fc2011-04-14 22:09:26 +00002056 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002057
Reid Spencer5f016e22007-07-11 17:01:13 +00002058 //===--------------------------------------------------------------------===//
2059 // LValue Expression Emission
2060 //===--------------------------------------------------------------------===//
2061
Daniel Dunbar13e81732009-02-05 07:09:07 +00002062 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2063 RValue GetUndefRValue(QualType Ty);
2064
Daniel Dunbarce1d38b2009-01-09 16:50:52 +00002065 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2066 /// and issue an ErrorUnsupported style diagnostic (using the
2067 /// provided Name).
2068 RValue EmitUnsupportedRValue(const Expr *E,
2069 const char *Name);
2070
Mike Stump0dd9e882009-02-08 23:14:22 +00002071 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2072 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbar6ba82a42008-08-25 20:45:57 +00002073 LValue EmitUnsupportedLValue(const Expr *E,
2074 const char *Name);
2075
Reid Spencer5f016e22007-07-11 17:01:13 +00002076 /// EmitLValue - Emit code to compute a designator that specifies the location
2077 /// of the expression.
2078 ///
2079 /// This can return one of two things: a simple address or a bitfield
2080 /// reference. In either case, the LLVM Value* in the LValue structure is
2081 /// guaranteed to be an LLVM pointer type.
2082 ///
2083 /// If this returns a bitfield reference, nothing about the pointee type of
2084 /// the LLVM value is known: For example, it may not be a pointer to an
2085 /// integer.
2086 ///
2087 /// If this returns a normal address, and if the lvalue's C type is fixed
2088 /// size, this method guarantees that the returned pointer type will point to
2089 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2090 /// variable length type, this is not possible.
2091 ///
2092 LValue EmitLValue(const Expr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002093
Richard Smith7ac9ef12012-09-08 02:08:36 +00002094 /// \brief Same as EmitLValue but additionally we generate checking code to
2095 /// guard against undefined behavior. This is only suitable when we know
2096 /// that the address will be used to access the object.
2097 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stumpb14e62d2009-12-16 02:57:00 +00002098
John McCall26815d92010-10-27 20:58:56 +00002099 /// EmitToMemory - Change a scalar value from its value
2100 /// representation to its in-memory representation.
2101 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2102
2103 /// EmitFromMemory - Change a scalar value from its memory
2104 /// representation to its value representation.
2105 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2106
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002107 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2108 /// care to appropriately convert from the memory representation to
2109 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002110 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002111 unsigned Alignment, QualType Ty,
2112 llvm::MDNode *TBAAInfo = 0);
John McCall545d9962011-06-25 02:11:03 +00002113
2114 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2115 /// care to appropriately convert from the memory representation to
2116 /// the LLVM value representation. The l-value must be a simple
2117 /// l-value.
John McCalla07398e2011-06-16 04:16:24 +00002118 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002119
2120 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2121 /// care to appropriately convert from the memory representation to
2122 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002123 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002124 bool Volatile, unsigned Alignment, QualType Ty,
David Chisnall7a7ee302012-01-16 17:27:18 +00002125 llvm::MDNode *TBAAInfo = 0, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00002126
2127 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2128 /// care to appropriately convert from the memory representation to
2129 /// the LLVM value representation. The l-value must be a simple
David Chisnall7a7ee302012-01-16 17:27:18 +00002130 /// l-value. The isInit flag indicates whether this is an initialization.
2131 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2132 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002133
Reid Spencer5f016e22007-07-11 17:01:13 +00002134 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2135 /// this method emits the address of the lvalue, then loads the result as an
2136 /// rvalue, returning the rvalue.
John McCall545d9962011-06-25 02:11:03 +00002137 RValue EmitLoadOfLValue(LValue V);
2138 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2139 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stump0dd9e882009-02-08 23:14:22 +00002140
Reid Spencer5f016e22007-07-11 17:01:13 +00002141 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2142 /// lvalue, where both are guaranteed to the have the same type, and that type
2143 /// is 'Ty'.
David Chisnall7a7ee302012-01-16 17:27:18 +00002144 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00002145 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbared3849b2008-11-19 09:36:46 +00002146
Mike Stump0dd9e882009-02-08 23:14:22 +00002147 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2148 /// EmitStoreThroughLValue.
Daniel Dunbared3849b2008-11-19 09:36:46 +00002149 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00002150 /// \param Result [out] - If non-null, this will be set to a Value* for the
2151 /// bit-field contents after the store, appropriate for use as the result of
2152 /// an assignment to the bit-field.
John McCall545d9962011-06-25 02:11:03 +00002153 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbared3849b2008-11-19 09:36:46 +00002154 llvm::Value **Result=0);
Mike Stump0dd9e882009-02-08 23:14:22 +00002155
John McCall83ce9d42010-11-16 23:07:28 +00002156 /// Emit an l-value for an assignment (simple or compound) of complex type.
2157 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002158 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall83ce9d42010-11-16 23:07:28 +00002159
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00002160 // Note: only available for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +00002161 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002162 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002163 // Note: only available for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +00002164 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002165 // Note: only available for agg return types
2166 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002167 LValue EmitDeclRefLValue(const DeclRefExpr *E);
2168 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnereaf2bb82009-02-24 22:18:39 +00002169 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattnerd9f69102008-08-10 01:53:14 +00002170 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002171 LValue EmitUnaryOpLValue(const UnaryOperator *E);
2172 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begeman213541a2008-04-18 23:10:10 +00002173 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +00002174 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian820bca42009-12-09 23:35:29 +00002175 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +00002176 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smith13ec9102012-05-14 21:57:21 +00002177 LValue EmitInitListLValue(const InitListExpr *E);
John McCall56ca35d2011-02-17 10:25:35 +00002178 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner75dfeda2009-03-18 18:28:57 +00002179 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregored8abf12010-07-08 06:14:04 +00002180 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregor03e80032011-06-21 17:03:29 +00002181 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCalle996ffd2011-02-16 08:02:54 +00002182 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002183
Eli Friedman377ecc72012-04-16 03:54:45 +00002184 RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
Anton Korobeynikoveaf856d2012-04-13 11:22:00 +00002185
John McCalldd2ecee2012-03-10 03:05:10 +00002186 class ConstantEmission {
2187 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2188 ConstantEmission(llvm::Constant *C, bool isReference)
2189 : ValueAndIsReference(C, isReference) {}
2190 public:
2191 ConstantEmission() {}
2192 static ConstantEmission forReference(llvm::Constant *C) {
2193 return ConstantEmission(C, true);
2194 }
2195 static ConstantEmission forValue(llvm::Constant *C) {
2196 return ConstantEmission(C, false);
2197 }
2198
2199 operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
2200
2201 bool isReference() const { return ValueAndIsReference.getInt(); }
2202 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2203 assert(isReference());
2204 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2205 refExpr->getType());
2206 }
2207
2208 llvm::Constant *getValue() const {
2209 assert(!isReference());
2210 return ValueAndIsReference.getPointer();
2211 }
2212 };
2213
John McCallf4b88a42012-03-10 09:33:50 +00002214 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCalldd2ecee2012-03-10 03:05:10 +00002215
John McCall4b9c2d22011-11-06 09:01:30 +00002216 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2217 AggValueSlot slot = AggValueSlot::ignored());
2218 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2219
Daniel Dunbar2a031922009-04-22 05:08:15 +00002220 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002221 const ObjCIvarDecl *Ivar);
Eli Friedman377ecc72012-04-16 03:54:45 +00002222 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002223
Anders Carlsson06a29702010-01-29 05:24:29 +00002224 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2225 /// if the Field is a reference, this will return the address of the reference
2226 /// and not the address of the value stored in the reference.
Eli Friedman377ecc72012-04-16 03:54:45 +00002227 LValue EmitLValueForFieldInitialization(LValue Base,
2228 const FieldDecl* Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002229
Fariborz Jahanian45012a72009-02-03 00:09:52 +00002230 LValue EmitLValueForIvar(QualType ObjectTy,
2231 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002232 unsigned CVRQualifiers);
2233
Anders Carlssonb58d0172009-05-30 23:23:33 +00002234 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssone61c9e82009-05-30 23:30:54 +00002235 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman31a37022012-02-08 05:34:55 +00002236 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002237 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Weberc5f80462012-10-11 10:13:44 +00002238 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002239
Daniel Dunbar0a04d772008-08-23 10:51:21 +00002240 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +00002241 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattner65459942009-04-25 19:35:26 +00002242 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanian8bfd31f2009-10-22 22:57:31 +00002243 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian03b29602010-06-17 19:56:20 +00002244 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCall189d6ef2010-10-09 01:34:31 +00002245 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCall56ca35d2011-02-17 10:25:35 +00002246
Reid Spencer5f016e22007-07-11 17:01:13 +00002247 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +00002248 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +00002249 //===--------------------------------------------------------------------===//
2250
Mike Stump0dd9e882009-02-08 23:14:22 +00002251 /// EmitCall - Generate a call of the given function, expecting the given
2252 /// result type, and using the given argument list which specifies both the
2253 /// LLVM arguments and the types they were derived from.
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002254 ///
Mike Stumpf71d2322009-11-30 20:08:49 +00002255 /// \param TargetDecl - If given, the decl of the function in a direct call;
2256 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbar88b53962009-02-02 22:03:45 +00002257 RValue EmitCall(const CGFunctionInfo &FnInfo,
2258 llvm::Value *Callee,
Anders Carlssonf3c47c92009-12-24 19:25:24 +00002259 ReturnValueSlot ReturnValue,
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002260 const CallArgList &Args,
David Chisnalldd5c98f2010-05-01 11:15:56 +00002261 const Decl *TargetDecl = 0,
David Chisnall4b02afc2010-05-02 13:41:58 +00002262 llvm::Instruction **callOrInvoke = 0);
Mike Stump1eb44332009-09-09 15:08:12 +00002263
Anders Carlsson31777a22009-12-24 19:08:58 +00002264 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlssond2490a92009-12-24 20:40:36 +00002265 ReturnValueSlot ReturnValue,
Anders Carlsson98647712009-05-27 01:22:39 +00002266 CallExpr::const_arg_iterator ArgBeg,
2267 CallExpr::const_arg_iterator ArgEnd,
2268 const Decl *TargetDecl = 0);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002269 RValue EmitCallExpr(const CallExpr *E,
Anders Carlssond2490a92009-12-24 20:40:36 +00002270 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump1eb44332009-09-09 15:08:12 +00002271
John McCallf1549f62010-07-06 01:34:17 +00002272 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner2d3ba4f2011-07-23 17:14:25 +00002273 ArrayRef<llvm::Value *> Args,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002274 const Twine &Name = "");
Jay Foad4c7d9f12011-07-15 08:37:34 +00002275 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002276 const Twine &Name = "");
John McCallf1549f62010-07-06 01:34:17 +00002277
Anders Carlsson566abee2009-11-13 04:45:41 +00002278 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002279 llvm::Type *Ty);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002280 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002281 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian27262672011-01-20 17:19:02 +00002282 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2283 NestedNameSpecifier *Qual,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002284 llvm::Type *Ty);
Fariborz Jahanianccd52592011-02-01 23:22:34 +00002285
2286 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2287 CXXDtorType Type,
Fariborz Jahanian771c6782011-02-03 19:27:17 +00002288 const CXXRecordDecl *RD);
Anders Carlsson566abee2009-11-13 04:45:41 +00002289
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002290 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
Richard Smith4def70d2012-10-09 19:52:38 +00002291 SourceLocation CallLoc,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002292 llvm::Value *Callee,
Anders Carlssona1736c02009-12-24 21:13:40 +00002293 ReturnValueSlot ReturnValue,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002294 llvm::Value *This,
Anders Carlssonc997d422010-01-02 01:01:18 +00002295 llvm::Value *VTT,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002296 CallExpr::const_arg_iterator ArgBeg,
2297 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssona1736c02009-12-24 21:13:40 +00002298 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2299 ReturnValueSlot ReturnValue);
2300 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2301 ReturnValueSlot ReturnValue);
Ted Kremenek55499762008-06-17 02:43:46 +00002302
Anders Carlssona2447e02011-05-08 20:32:23 +00002303 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2304 const CXXMethodDecl *MD,
2305 llvm::Value *This);
Anders Carlsson0f294632009-05-27 04:18:27 +00002306 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssona1736c02009-12-24 21:13:40 +00002307 const CXXMethodDecl *MD,
2308 ReturnValueSlot ReturnValue);
Mike Stump1eb44332009-09-09 15:08:12 +00002309
Peter Collingbourne6c0aa5f2011-10-06 18:29:37 +00002310 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2311 ReturnValueSlot ReturnValue);
2312
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002313
Mike Stump1eb44332009-09-09 15:08:12 +00002314 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbaref2abfe2009-02-16 22:43:43 +00002315 unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002316
Anders Carlssona1736c02009-12-24 21:13:40 +00002317 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stump09429b92009-02-17 17:00:02 +00002318
Mike Stump0dd9e882009-02-08 23:14:22 +00002319 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2320 /// is unhandled by the current target.
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +00002321 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2322
Chris Lattner2752c012010-03-03 19:03:45 +00002323 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002324 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner686775d2011-07-20 06:58:45 +00002325 SmallVectorImpl<llvm::Value*> &O,
Bob Wilsondb3d4d02010-12-08 22:37:56 +00002326 const char *name,
Nate Begeman61eecf52010-06-14 05:21:25 +00002327 unsigned shift = 0, bool rightshift = false);
Bob Wilsoncf556522010-12-07 22:40:02 +00002328 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2acc6e32011-07-18 04:24:23 +00002329 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman61eecf52010-06-14 05:21:25 +00002330 bool negateForRightShift);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002331
Bill Wendling795b1002012-02-22 09:30:11 +00002332 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002333 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2334 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002335
Daniel Dunbared7c6182008-08-20 00:28:19 +00002336 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +00002337 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beardeb382ec2012-04-19 00:25:12 +00002338 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremenekebcb57a2012-03-06 20:05:56 +00002339 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2340 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2341 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2342 const ObjCMethodDecl *MethodWithObjects);
Chris Lattner8fdf3282008-06-24 17:04:18 +00002343 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCallef072fd2010-05-22 01:48:05 +00002344 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2345 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattner8fdf3282008-06-24 17:04:18 +00002346
John McCallf85e1932011-06-15 23:02:42 +00002347 /// Retrieves the default cleanup kind for an ARC cleanup.
2348 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2349 CleanupKind getARCCleanupKind() {
2350 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2351 ? NormalAndEHCleanup : NormalCleanup;
2352 }
2353
2354 // ARC primitives.
2355 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2356 void EmitARCDestroyWeak(llvm::Value *addr);
2357 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2358 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2359 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2360 bool ignored);
2361 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2362 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2363 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2364 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall545d9962011-06-25 02:11:03 +00002365 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
2366 bool ignored);
John McCallf85e1932011-06-15 23:02:42 +00002367 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
2368 bool ignored);
2369 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2370 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCall348f16f2011-10-04 06:23:45 +00002371 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall015f33b2012-10-17 02:28:37 +00002372 void EmitARCDestroyStrong(llvm::Value *addr, bool precise);
John McCallf85e1932011-06-15 23:02:42 +00002373 void EmitARCRelease(llvm::Value *value, bool precise);
2374 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2375 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2376 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2377 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2378
2379 std::pair<LValue,llvm::Value*>
2380 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2381 std::pair<LValue,llvm::Value*>
2382 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2383
John McCall2b014d62011-10-01 10:32:24 +00002384 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2385
John McCallf85e1932011-06-15 23:02:42 +00002386 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2387 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2388 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2389
John McCall348f16f2011-10-04 06:23:45 +00002390 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCallf85e1932011-06-15 23:02:42 +00002391 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2392 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2393
John McCallbdc4d802011-07-09 01:37:26 +00002394 static Destroyer destroyARCStrongImprecise;
2395 static Destroyer destroyARCStrongPrecise;
2396 static Destroyer destroyARCWeak;
2397
John McCallf85e1932011-06-15 23:02:42 +00002398 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2399 llvm::Value *EmitObjCAutoreleasePoolPush();
2400 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2401 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2402 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2403
Anders Carlsson4029ca72009-05-20 00:24:07 +00002404 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2405 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002406 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson32f36ba2010-06-26 16:35:32 +00002407 const NamedDecl *InitializedDecl);
Anders Carlsson3aba0932010-01-31 18:34:51 +00002408
Chris Lattner883f6a72007-08-11 00:04:45 +00002409 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002410 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +00002411 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002412
2413 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stump0dd9e882009-02-08 23:14:22 +00002414
2415 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2416 /// scalar type, returning the result.
Anders Carlsson14c5cbf2009-08-16 07:36:22 +00002417 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002418
Chris Lattner3707b252007-08-26 06:48:56 +00002419 /// EmitScalarConversion - Emit a conversion from the specified type to the
2420 /// specified destination type, both of which are LLVM scalar types.
2421 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2422 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002423
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002424 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stump0dd9e882009-02-08 23:14:22 +00002425 /// complex type to the specified destination type, where the destination type
2426 /// is an LLVM scalar type.
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002427 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2428 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002429
2430
John McCall558d2ab2010-09-15 10:14:12 +00002431 /// EmitAggExpr - Emit the computation of the specified expression
2432 /// of aggregate type. The result is computed into the given slot,
2433 /// which may be null to indicate that the value is not needed.
John McCalle0c11682012-07-02 23:58:38 +00002434 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stump0dd9e882009-02-08 23:14:22 +00002435
Daniel Dunbar18aba0d2010-02-05 19:38:31 +00002436 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2437 /// aggregate type into a temporary LValue.
2438 LValue EmitAggExprToLValue(const Expr *E);
2439
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002440 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2441 /// pointers.
2442 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian08c32132009-08-31 19:33:16 +00002443 QualType Ty);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002444
John McCall0c24c802011-06-24 23:21:27 +00002445 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2446 /// make sure it survives garbage collection until this point.
2447 void EmitExtendGCLifetime(llvm::Value *object);
2448
Chris Lattnerb6ef18a2007-08-21 05:54:00 +00002449 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002450 /// complex type, returning the result.
John McCallb418d742010-11-16 10:08:07 +00002451 ComplexPairTy EmitComplexExpr(const Expr *E,
2452 bool IgnoreReal = false,
2453 bool IgnoreImag = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002454
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002455 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
2456 /// of complex type, storing into the specified Value*.
Chris Lattner190dbe22007-08-26 16:22:13 +00002457 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
2458 bool DestIsVolatile);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00002459
2460 /// StoreComplexToAddr - Store a complex number into the specified address.
2461 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
2462 bool DestIsVolatile);
Chris Lattner9b655512007-08-31 22:49:20 +00002463 /// LoadComplexFromAddr - Load a complex number from the specified address.
2464 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattner2621fd12008-05-08 05:58:21 +00002465
John McCallb6bbcc92010-10-15 04:57:14 +00002466 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2467 /// a static local variable.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002468 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2469 const char *Separator,
2470 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002471
Chandler Carruth0f30a122012-03-30 19:44:53 +00002472 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2473 /// global variable that has already been created for it. If the initializer
2474 /// has a different type than GV does, this may free GV and return a different
2475 /// one. Otherwise it just returns GV.
2476 llvm::GlobalVariable *
2477 AddInitializerToStaticVarDecl(const VarDecl &D,
2478 llvm::GlobalVariable *GV);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002479
Daniel Dunbar0096acf2009-02-25 19:24:29 +00002480
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002481 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2482 /// variable with global storage.
Richard Smith7ca48502012-02-13 22:16:19 +00002483 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2484 bool PerformInit);
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002485
John McCall20bb1752012-05-01 06:13:13 +00002486 /// Call atexit() with a function that passes the given argument to
2487 /// the given function.
2488 void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr);
Mike Stump1eb44332009-09-09 15:08:12 +00002489
John McCall3030eb82010-11-06 09:44:32 +00002490 /// Emit code in this function to perform a guarded variable
2491 /// initialization. Guarded initializations are used when it's not
2492 /// possible to prove that an initialization will be done exactly
2493 /// once, e.g. with a static local variable or a static data member
2494 /// of a class template.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002495 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith7ca48502012-02-13 22:16:19 +00002496 bool PerformInit);
John McCall5cd91b52010-09-08 01:44:27 +00002497
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002498 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2499 /// variables.
2500 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2501 llvm::Constant **Decls,
2502 unsigned NumDecls);
2503
John McCall3f88f682012-04-06 18:21:03 +00002504 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002505 /// variables.
John McCall3f88f682012-04-06 18:21:03 +00002506 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2507 const std::vector<std::pair<llvm::WeakVH,
2508 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002509
John McCalld26bc762011-03-09 04:27:21 +00002510 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2511 const VarDecl *D,
Richard Smith7ca48502012-02-13 22:16:19 +00002512 llvm::GlobalVariable *Addr,
2513 bool PerformInit);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002514
John McCall558d2ab2010-09-15 10:14:12 +00002515 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002516
2517 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian830937b2010-12-02 17:02:11 +00002518 const Expr *Exp);
Mike Stump1eb44332009-09-09 15:08:12 +00002519
John McCall1a343eb2011-11-10 08:15:53 +00002520 void enterFullExpression(const ExprWithCleanups *E) {
2521 if (E->getNumObjects() == 0) return;
2522 enterNonTrivialFullExpression(E);
2523 }
2524 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump1eb44332009-09-09 15:08:12 +00002525
Anders Carlsson756b5c42009-10-30 01:42:31 +00002526 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregor1eb2e592010-05-16 00:44:00 +00002527
Eli Friedman4c5d8af2012-02-09 03:32:31 +00002528 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2529
Eli Friedman276b0612011-10-11 02:20:01 +00002530 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2531
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002532 //===--------------------------------------------------------------------===//
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002533 // Annotations Emission
2534 //===--------------------------------------------------------------------===//
2535
2536 /// Emit an annotation call (intrinsic or builtin).
2537 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2538 llvm::Value *AnnotatedVal,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002539 StringRef AnnotationStr,
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002540 SourceLocation Location);
2541
2542 /// Emit local annotations for the local variable V, declared by D.
2543 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2544
2545 /// Emit field annotations for the given field & value. Returns the
2546 /// annotation result.
2547 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2548
2549 //===--------------------------------------------------------------------===//
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002550 // Internal Helpers
2551 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002552
Chris Lattner0946ccd2008-11-11 07:41:27 +00002553 /// ContainsLabel - Return true if the statement contains a label in it. If
2554 /// this statement is not executed normally, it not containing a label means
2555 /// that we can just remove the code.
2556 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002557
Chris Lattneref425a62011-02-28 00:18:40 +00002558 /// containsBreak - Return true if the statement contains a break out of it.
2559 /// If the statement (recursively) contains a switch or loop with a break
2560 /// inside of it, this is fine.
2561 static bool containsBreak(const Stmt *S);
2562
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002563 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnerc2c90012011-02-27 23:02:32 +00002564 /// to a constant, or if it does but contains a label, return false. If it
2565 /// constant folds return true and set the boolean result in Result.
2566 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stump0dd9e882009-02-08 23:14:22 +00002567
Chris Lattneref425a62011-02-28 00:18:40 +00002568 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2569 /// to a constant, or if it does but contains a label, return false. If it
2570 /// constant folds return true and set the folded value.
Richard Trieue1ecdc12012-07-23 20:21:35 +00002571 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattneref425a62011-02-28 00:18:40 +00002572
Chris Lattner31a09842008-11-12 08:04:58 +00002573 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2574 /// if statement) to the specified blocks. Based on the condition, this might
2575 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattner9bc47e22008-11-12 07:46:33 +00002576 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002577 llvm::BasicBlock *FalseBlock);
Mike Stumpbe07f602009-12-14 21:58:14 +00002578
Richard Smith4def70d2012-10-09 19:52:38 +00002579 /// \brief Emit a description of a type in a format suitable for passing to
2580 /// a runtime sanitizer handler.
2581 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2582
2583 /// \brief Convert a value into a format suitable for passing to a runtime
2584 /// sanitizer handler.
2585 llvm::Value *EmitCheckValue(llvm::Value *V);
2586
2587 /// \brief Emit a description of a source location in a format suitable for
2588 /// passing to a runtime sanitizer handler.
2589 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2590
Will Dietzad954812012-12-02 19:50:33 +00002591 /// \brief Specify under what conditions this check can be recovered
2592 enum CheckRecoverableKind {
2593 /// Always terminate program execution if this check fails
2594 CRK_Unrecoverable,
2595 /// Check supports recovering, allows user to specify which
2596 CRK_Recoverable,
2597 /// Runtime conditionally aborts, always need to support recovery.
2598 CRK_AlwaysRecoverable
2599 };
2600
Richard Smithcc305612012-11-01 22:15:34 +00002601 /// \brief Create a basic block that will call a handler function in a
2602 /// sanitizer runtime with the provided arguments, and create a conditional
2603 /// branch to it.
Richard Smith4def70d2012-10-09 19:52:38 +00002604 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002605 ArrayRef<llvm::Constant *> StaticArgs,
2606 ArrayRef<llvm::Value *> DynamicArgs,
Will Dietzad954812012-12-02 19:50:33 +00002607 CheckRecoverableKind Recoverable);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002608
Richard Smithcc305612012-11-01 22:15:34 +00002609 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2610 /// conditional branch to it, for the -ftrapv checks.
Chad Rosier78d85b12013-01-29 23:31:22 +00002611 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithcc305612012-11-01 22:15:34 +00002612
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002613 /// EmitCallArg - Emit a single call argument.
John McCall413ebdb2011-03-11 20:59:21 +00002614 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002615
John McCall27360712010-05-26 22:34:26 +00002616 /// EmitDelegateCallArg - We are performing a delegate call; that
2617 /// is, the current function is delegating to another one. Produce
2618 /// a r-value suitable for passing the given parameter.
John McCall413ebdb2011-03-11 20:59:21 +00002619 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall27360712010-05-26 22:34:26 +00002620
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002621 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2622 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sands82500162012-04-10 08:23:07 +00002623 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002624
Chris Lattner31a09842008-11-12 08:04:58 +00002625private:
Rafael Espindolac3f89552012-03-24 16:50:34 +00002626 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002627 void EmitReturnOfRValue(RValue RV, QualType Ty);
2628
Daniel Dunbar56273772008-09-17 00:51:38 +00002629 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2630 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2631 ///
2632 /// \param AI - The first function argument of the expansion.
2633 /// \return The argument following the last expanded function
2634 /// argument.
Mike Stump0dd9e882009-02-08 23:14:22 +00002635 llvm::Function::arg_iterator
Daniel Dunbar56273772008-09-17 00:51:38 +00002636 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2637 llvm::Function::arg_iterator AI);
2638
Mike Stump0dd9e882009-02-08 23:14:22 +00002639 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2640 /// Ty, into individual arguments on the provided vector \arg Args. See
2641 /// ABIArgInfo::Expand.
2642 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner686775d2011-07-20 06:58:45 +00002643 SmallVector<llvm::Value*, 16> &Args,
Chris Lattner811bf362011-07-12 06:29:11 +00002644 llvm::FunctionType *IRFuncTy);
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002645
Chad Rosier42b60552012-08-23 20:00:18 +00002646 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002647 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stump0dd9e882009-02-08 23:14:22 +00002648
Chad Rosier42b60552012-08-23 20:00:18 +00002649 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedman6d7cfd72010-07-16 00:55:21 +00002650 LValue InputValue, QualType InputType,
2651 std::string &ConstraintStr);
2652
Anders Carlsson0139bb92009-04-08 20:47:54 +00002653 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump1eb44332009-09-09 15:08:12 +00002654 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlssonaf23f692009-04-18 20:20:22 +00002655 /// argument types of the function being called.
2656 template<typename T>
2657 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson0139bb92009-04-08 20:47:54 +00002658 CallExpr::const_arg_iterator ArgBeg,
Anders Carlssonaf23f692009-04-18 20:20:22 +00002659 CallExpr::const_arg_iterator ArgEnd) {
2660 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson0139bb92009-04-08 20:47:54 +00002661
Anders Carlssonaf23f692009-04-18 20:20:22 +00002662 // First, use the argument types that the type info knows about
2663 if (CallArgTypeInfo) {
2664 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2665 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman44b0a3e2009-11-18 03:42:04 +00002666 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlssonaf23f692009-04-18 20:20:22 +00002667 QualType ArgType = *I;
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002668#ifndef NDEBUG
2669 QualType ActualArgType = Arg->getType();
2670 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002671 QualType ActualBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002672 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002673 QualType ArgBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002674 ArgType->getAs<PointerType>()->getPointeeType();
2675 if (ArgBaseType->isVariableArrayType()) {
2676 if (const VariableArrayType *VAT =
2677 getContext().getAsVariableArrayType(ActualBaseType)) {
2678 if (!VAT->getSizeExpr())
2679 ActualArgType = ArgType;
2680 }
2681 }
2682 }
Anders Carlssonaf23f692009-04-18 20:20:22 +00002683 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump1eb44332009-09-09 15:08:12 +00002684 getTypePtr() ==
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002685 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002686 "type mismatch in call argument!");
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002687#endif
John McCall413ebdb2011-03-11 20:59:21 +00002688 EmitCallArg(Args, *Arg, ArgType);
Anders Carlssonaf23f692009-04-18 20:20:22 +00002689 }
Mike Stump1eb44332009-09-09 15:08:12 +00002690
2691 // Either we've emitted all the call args, or we have a call to a
Anders Carlssonaf23f692009-04-18 20:20:22 +00002692 // variadic function.
Mike Stump1eb44332009-09-09 15:08:12 +00002693 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002694 "Extra arguments in non-variadic function!");
Mike Stump1eb44332009-09-09 15:08:12 +00002695
Anders Carlssonaf23f692009-04-18 20:20:22 +00002696 }
Mike Stump1eb44332009-09-09 15:08:12 +00002697
Anders Carlssonaf23f692009-04-18 20:20:22 +00002698 // If we still have any arguments, emit them using the type of the argument.
John McCall413ebdb2011-03-11 20:59:21 +00002699 for (; Arg != ArgEnd; ++Arg)
2700 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlssonaf23f692009-04-18 20:20:22 +00002701 }
John McCall492c4f92010-03-03 04:15:11 +00002702
2703 const TargetCodeGenInfo &getTargetHooks() const {
2704 return CGM.getTargetCodeGenInfo();
2705 }
John McCall744016d2010-07-06 23:57:41 +00002706
2707 void EmitDeclMetadata();
John McCallf0c11f72011-03-31 08:03:29 +00002708
2709 CodeGenModule::ByrefHelpers *
Chris Lattner2acc6e32011-07-18 04:24:23 +00002710 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf0c11f72011-03-31 08:03:29 +00002711 const AutoVarEmission &emission);
Dan Gohmanb49bd272012-02-16 00:57:37 +00002712
2713 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadf4c3db12012-03-02 18:34:30 +00002714
Eli Friedmanea93e402012-08-23 03:10:17 +00002715 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2716 /// value and compute our best estimate of the alignment of the pointee.
2717 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Reid Spencer5f016e22007-07-11 17:01:13 +00002718};
Mike Stump1eb44332009-09-09 15:08:12 +00002719
John McCall150b4622011-01-26 04:00:11 +00002720/// Helper class with most of the code for saving a value for a
2721/// conditional expression cleanup.
John McCall804b8072011-01-28 10:53:53 +00002722struct DominatingLLVMValue {
John McCall150b4622011-01-26 04:00:11 +00002723 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2724
2725 /// Answer whether the given value needs extra work to be saved.
2726 static bool needsSaving(llvm::Value *value) {
2727 // If it's not an instruction, we don't need to save.
2728 if (!isa<llvm::Instruction>(value)) return false;
2729
2730 // If it's an instruction in the entry block, we don't need to save.
2731 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2732 return (block != &block->getParent()->getEntryBlock());
2733 }
2734
2735 /// Try to save the given value.
2736 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2737 if (!needsSaving(value)) return saved_type(value, false);
2738
2739 // Otherwise we need an alloca.
2740 llvm::Value *alloca =
2741 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2742 CGF.Builder.CreateStore(value, alloca);
2743
2744 return saved_type(alloca, true);
2745 }
2746
2747 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2748 if (!value.getInt()) return value.getPointer();
2749 return CGF.Builder.CreateLoad(value.getPointer());
2750 }
2751};
2752
John McCall804b8072011-01-28 10:53:53 +00002753/// A partial specialization of DominatingValue for llvm::Values that
2754/// might be llvm::Instructions.
2755template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2756 typedef T *type;
John McCall150b4622011-01-26 04:00:11 +00002757 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCall804b8072011-01-28 10:53:53 +00002758 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2759 }
2760};
2761
2762/// A specialization of DominatingValue for RValue.
2763template <> struct DominatingValue<RValue> {
2764 typedef RValue type;
2765 class saved_type {
2766 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2767 AggregateAddress, ComplexAddress };
2768
2769 llvm::Value *Value;
2770 Kind K;
2771 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2772
2773 public:
2774 static bool needsSaving(RValue value);
2775 static saved_type save(CodeGenFunction &CGF, RValue value);
2776 RValue restore(CodeGenFunction &CGF);
2777
2778 // implementations in CGExprCXX.cpp
2779 };
2780
2781 static bool needsSaving(type value) {
2782 return saved_type::needsSaving(value);
2783 }
2784 static saved_type save(CodeGenFunction &CGF, type value) {
2785 return saved_type::save(CGF, value);
2786 }
2787 static type restore(CodeGenFunction &CGF, saved_type value) {
2788 return value.restore(CGF);
John McCall150b4622011-01-26 04:00:11 +00002789 }
2790};
2791
Reid Spencer5f016e22007-07-11 17:01:13 +00002792} // end namespace CodeGen
2793} // end namespace clang
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00002794
Reid Spencer5f016e22007-07-11 17:01:13 +00002795#endif