blob: 5a7c305c6462872402399ccab9a72152148852b6 [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"
Ben Langmuir524387a2013-05-09 19:17:11 +000026#include "clang/Basic/CapturedStmt.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000027#include "clang/Basic/TargetInfo.h"
28#include "clang/Frontend/CodeGenOptions.h"
29#include "llvm/ADT/ArrayRef.h"
30#include "llvm/ADT/DenseMap.h"
31#include "llvm/ADT/SmallVector.h"
32#include "llvm/Support/Debug.h"
33#include "llvm/Support/ValueHandle.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000034
Reid Spencer5f016e22007-07-11 17:01:13 +000035namespace llvm {
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000036 class BasicBlock;
Benjamin Kramerf21efe92009-08-11 17:46:57 +000037 class LLVMContext;
David Chisnalldd5c98f2010-05-01 11:15:56 +000038 class MDNode;
Reid Spencer5f016e22007-07-11 17:01:13 +000039 class Module;
Daniel Dunbar898d5082008-09-30 01:06:03 +000040 class SwitchInst;
Daniel Dunbar259e9cc2009-10-19 01:21:05 +000041 class Twine;
Daniel Dunbared3849b2008-11-19 09:36:46 +000042 class Value;
John McCallf1549f62010-07-06 01:34:17 +000043 class CallSite;
Reid Spencer5f016e22007-07-11 17:01:13 +000044}
45
46namespace clang {
47 class ASTContext;
John McCall1a343eb2011-11-10 08:15:53 +000048 class BlockDecl;
Anders Carlsson7267c162009-05-29 21:03:38 +000049 class CXXDestructorDecl;
Richard Smithad762fc2011-04-14 22:09:26 +000050 class CXXForRangeStmt;
Anders Carlsson6815e942009-09-27 18:58:34 +000051 class CXXTryStmt;
Reid Spencer5f016e22007-07-11 17:01:13 +000052 class Decl;
Chris Lattnerad8dcf42011-02-17 07:39:24 +000053 class LabelDecl;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000054 class EnumConstantDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000055 class FunctionDecl;
Douglas Gregor72564e72009-02-26 23:50:07 +000056 class FunctionProtoType;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000057 class LabelStmt;
Fariborz Jahanian679a5022009-01-10 21:06:09 +000058 class ObjCContainerDecl;
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +000059 class ObjCInterfaceDecl;
60 class ObjCIvarDecl;
Chris Lattner391d77a2008-03-30 23:03:07 +000061 class ObjCMethodDecl;
Fariborz Jahanianfef30b52008-12-09 20:23:04 +000062 class ObjCImplementationDecl;
Daniel Dunbaraf05bb92008-08-26 08:29:31 +000063 class ObjCPropertyImplDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000064 class TargetInfo;
John McCall492c4f92010-03-03 04:15:11 +000065 class TargetCodeGenInfo;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000066 class VarDecl;
Chris Lattner16f00492009-04-26 01:32:48 +000067 class ObjCForCollectionStmt;
68 class ObjCAtTryStmt;
69 class ObjCAtThrowStmt;
70 class ObjCAtSynchronizedStmt;
John McCallf85e1932011-06-15 23:02:42 +000071 class ObjCAutoreleasePoolStmt;
Devang Patelb84a06e2007-10-23 02:10:49 +000072
Reid Spencer5f016e22007-07-11 17:01:13 +000073namespace CodeGen {
Devang Patelb84a06e2007-10-23 02:10:49 +000074 class CodeGenTypes;
Daniel Dunbarbb36d332009-02-02 21:43:58 +000075 class CGFunctionInfo;
Mike Stump0dd9e882009-02-08 23:14:22 +000076 class CGRecordLayout;
John McCallee504292010-05-21 04:11:14 +000077 class CGBlockInfo;
John McCall4c40d982010-08-31 07:33:07 +000078 class CGCXXABI;
John McCalld16c2cf2011-02-08 08:22:06 +000079 class BlockFlags;
80 class BlockFieldFlags;
Mike Stump0dd9e882009-02-08 23:14:22 +000081
John McCall9d232c82013-03-07 21:37:08 +000082/// The kind of evaluation to perform on values of a particular
83/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
84/// CGExprAgg?
85///
86/// TODO: should vectors maybe be split out into their own thing?
87enum TypeEvaluationKind {
88 TEK_Scalar,
89 TEK_Complex,
90 TEK_Aggregate
91};
92
John McCallf1549f62010-07-06 01:34:17 +000093/// A branch fixup. These are required when emitting a goto to a
94/// label which hasn't been emitted yet. The goto is optimistically
95/// emitted as a branch to the basic block for the label, and (if it
96/// occurs in a scope with non-trivial cleanups) a fixup is added to
97/// the innermost cleanup. When a (normal) cleanup is popped, any
98/// unresolved fixups in that scope are threaded through the cleanup.
99struct BranchFixup {
John McCallff8e1152010-07-23 21:56:41 +0000100 /// The block containing the terminator which needs to be modified
101 /// into a switch if this fixup is resolved into the current scope.
102 /// If null, LatestBranch points directly to the destination.
103 llvm::BasicBlock *OptimisticBranchBlock;
John McCallf1549f62010-07-06 01:34:17 +0000104
John McCallff8e1152010-07-23 21:56:41 +0000105 /// The ultimate destination of the branch.
John McCallf1549f62010-07-06 01:34:17 +0000106 ///
107 /// This can be set to null to indicate that this fixup was
108 /// successfully resolved.
109 llvm::BasicBlock *Destination;
110
John McCallff8e1152010-07-23 21:56:41 +0000111 /// The destination index value.
112 unsigned DestinationIndex;
113
114 /// The initial branch of the fixup.
115 llvm::BranchInst *InitialBranch;
John McCallf1549f62010-07-06 01:34:17 +0000116};
117
John McCall804b8072011-01-28 10:53:53 +0000118template <class T> struct InvariantValue {
John McCall150b4622011-01-26 04:00:11 +0000119 typedef T type;
120 typedef T saved_type;
121 static bool needsSaving(type value) { return false; }
122 static saved_type save(CodeGenFunction &CGF, type value) { return value; }
123 static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
124};
John McCall804b8072011-01-28 10:53:53 +0000125
126/// A metaprogramming class for ensuring that a value will dominate an
127/// arbitrary position in a function.
128template <class T> struct DominatingValue : InvariantValue<T> {};
129
130template <class T, bool mightBeInstruction =
131 llvm::is_base_of<llvm::Value, T>::value &&
132 !llvm::is_base_of<llvm::Constant, T>::value &&
133 !llvm::is_base_of<llvm::BasicBlock, T>::value>
134struct DominatingPointer;
135template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
136// template <class T> struct DominatingPointer<T,true> at end of file
137
138template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
John McCall150b4622011-01-26 04:00:11 +0000139
John McCallcd2d2b72010-08-13 21:20:51 +0000140enum CleanupKind {
141 EHCleanup = 0x1,
142 NormalCleanup = 0x2,
143 NormalAndEHCleanup = EHCleanup | NormalCleanup,
144
145 InactiveCleanup = 0x4,
146 InactiveEHCleanup = EHCleanup | InactiveCleanup,
147 InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
148 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
149};
John McCallda65ea82010-07-13 20:32:21 +0000150
John McCallf1549f62010-07-06 01:34:17 +0000151/// A stack of scopes which respond to exceptions, including cleanups
152/// and catch blocks.
153class EHScopeStack {
154public:
155 /// A saved depth on the scope stack. This is necessary because
156 /// pushing scopes onto the stack invalidates iterators.
157 class stable_iterator {
158 friend class EHScopeStack;
159
160 /// Offset from StartOfData to EndOfBuffer.
161 ptrdiff_t Size;
162
163 stable_iterator(ptrdiff_t Size) : Size(Size) {}
164
165 public:
166 static stable_iterator invalid() { return stable_iterator(-1); }
167 stable_iterator() : Size(-1) {}
168
169 bool isValid() const { return Size >= 0; }
170
John McCall838d7962010-08-14 07:46:19 +0000171 /// Returns true if this scope encloses I.
172 /// Returns false if I is invalid.
173 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000174 bool encloses(stable_iterator I) const { return Size <= I.Size; }
John McCall838d7962010-08-14 07:46:19 +0000175
176 /// Returns true if this scope strictly encloses I: that is,
177 /// if it encloses I and is not I.
178 /// Returns false is I is invalid.
179 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000180 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
John McCall1bda6622010-07-21 00:40:03 +0000181
John McCallf1549f62010-07-06 01:34:17 +0000182 friend bool operator==(stable_iterator A, stable_iterator B) {
183 return A.Size == B.Size;
184 }
185 friend bool operator!=(stable_iterator A, stable_iterator B) {
186 return A.Size != B.Size;
187 }
188 };
189
John McCall1f0fca52010-07-21 07:22:38 +0000190 /// Information for lazily generating a cleanup. Subclasses must be
191 /// POD-like: cleanups will not be destructed, and they will be
192 /// allocated on the cleanup stack and freely copied and moved
193 /// around.
John McCallda65ea82010-07-13 20:32:21 +0000194 ///
John McCall1f0fca52010-07-21 07:22:38 +0000195 /// Cleanup implementations should generally be declared in an
John McCallda65ea82010-07-13 20:32:21 +0000196 /// anonymous namespace.
John McCall1f0fca52010-07-21 07:22:38 +0000197 class Cleanup {
John McCallc4a1a842011-07-12 00:15:30 +0000198 // Anchor the construction vtable.
199 virtual void anchor();
John McCallda65ea82010-07-13 20:32:21 +0000200 public:
John McCallad346f42011-07-12 20:27:29 +0000201 /// Generation flags.
202 class Flags {
203 enum {
204 F_IsForEH = 0x1,
205 F_IsNormalCleanupKind = 0x2,
206 F_IsEHCleanupKind = 0x4
207 };
208 unsigned flags;
209
210 public:
211 Flags() : flags(0) {}
212
213 /// isForEH - true if the current emission is for an EH cleanup.
214 bool isForEHCleanup() const { return flags & F_IsForEH; }
215 bool isForNormalCleanup() const { return !isForEHCleanup(); }
216 void setIsForEHCleanup() { flags |= F_IsForEH; }
217
218 bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; }
219 void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; }
220
221 /// isEHCleanupKind - true if the cleanup was pushed as an EH
222 /// cleanup.
223 bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; }
224 void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; }
225 };
226
John McCallc4a1a842011-07-12 00:15:30 +0000227 // Provide a virtual destructor to suppress a very common warning
228 // that unfortunately cannot be suppressed without this. Cleanups
229 // should not rely on this destructor ever being called.
230 virtual ~Cleanup() {}
John McCall3e29f962010-07-13 23:19:49 +0000231
John McCallda65ea82010-07-13 20:32:21 +0000232 /// Emit the cleanup. For normal cleanups, this is run in the
233 /// same EH context as when the cleanup was pushed, i.e. the
234 /// immediately-enclosing context of the cleanup scope. For
235 /// EH cleanups, this is run in a terminate context.
236 ///
Dmitri Gribenko70517ca2012-08-23 17:58:28 +0000237 // \param flags cleanup kind.
John McCallad346f42011-07-12 20:27:29 +0000238 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
John McCallda65ea82010-07-13 20:32:21 +0000239 };
240
John McCall150b4622011-01-26 04:00:11 +0000241 /// ConditionalCleanupN stores the saved form of its N parameters,
242 /// then restores them and performs the cleanup.
John McCall3ad32c82011-01-28 08:37:24 +0000243 template <class T, class A0>
244 class ConditionalCleanup1 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000245 typedef typename DominatingValue<A0>::saved_type A0_saved;
John McCall3ad32c82011-01-28 08:37:24 +0000246 A0_saved a0_saved;
247
John McCallad346f42011-07-12 20:27:29 +0000248 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000249 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
John McCallad346f42011-07-12 20:27:29 +0000250 T(a0).Emit(CGF, flags);
John McCall3ad32c82011-01-28 08:37:24 +0000251 }
252
253 public:
254 ConditionalCleanup1(A0_saved a0)
255 : a0_saved(a0) {}
256 };
257
John McCall150b4622011-01-26 04:00:11 +0000258 template <class T, class A0, class A1>
John McCall3ad32c82011-01-28 08:37:24 +0000259 class ConditionalCleanup2 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000260 typedef typename DominatingValue<A0>::saved_type A0_saved;
261 typedef typename DominatingValue<A1>::saved_type A1_saved;
John McCall4bbcbda2011-01-26 19:15:39 +0000262 A0_saved a0_saved;
263 A1_saved a1_saved;
John McCall150b4622011-01-26 04:00:11 +0000264
John McCallad346f42011-07-12 20:27:29 +0000265 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000266 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
267 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
John McCallad346f42011-07-12 20:27:29 +0000268 T(a0, a1).Emit(CGF, flags);
John McCall150b4622011-01-26 04:00:11 +0000269 }
270
271 public:
John McCall3ad32c82011-01-28 08:37:24 +0000272 ConditionalCleanup2(A0_saved a0, A1_saved a1)
273 : a0_saved(a0), a1_saved(a1) {}
John McCall150b4622011-01-26 04:00:11 +0000274 };
275
Douglas Gregord7b23162011-06-22 16:12:01 +0000276 template <class T, class A0, class A1, class A2>
277 class ConditionalCleanup3 : public Cleanup {
278 typedef typename DominatingValue<A0>::saved_type A0_saved;
279 typedef typename DominatingValue<A1>::saved_type A1_saved;
280 typedef typename DominatingValue<A2>::saved_type A2_saved;
281 A0_saved a0_saved;
282 A1_saved a1_saved;
283 A2_saved a2_saved;
284
John McCallad346f42011-07-12 20:27:29 +0000285 void Emit(CodeGenFunction &CGF, Flags flags) {
Douglas Gregord7b23162011-06-22 16:12:01 +0000286 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
287 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
288 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
John McCallad346f42011-07-12 20:27:29 +0000289 T(a0, a1, a2).Emit(CGF, flags);
Douglas Gregord7b23162011-06-22 16:12:01 +0000290 }
291
292 public:
293 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
John McCallc4a1a842011-07-12 00:15:30 +0000294 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
Douglas Gregord7b23162011-06-22 16:12:01 +0000295 };
296
John McCall9928c482011-07-12 16:41:08 +0000297 template <class T, class A0, class A1, class A2, class A3>
298 class ConditionalCleanup4 : public Cleanup {
299 typedef typename DominatingValue<A0>::saved_type A0_saved;
300 typedef typename DominatingValue<A1>::saved_type A1_saved;
301 typedef typename DominatingValue<A2>::saved_type A2_saved;
302 typedef typename DominatingValue<A3>::saved_type A3_saved;
303 A0_saved a0_saved;
304 A1_saved a1_saved;
305 A2_saved a2_saved;
306 A3_saved a3_saved;
307
John McCallad346f42011-07-12 20:27:29 +0000308 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall9928c482011-07-12 16:41:08 +0000309 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
310 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
311 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
312 A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved);
John McCallad346f42011-07-12 20:27:29 +0000313 T(a0, a1, a2, a3).Emit(CGF, flags);
John McCall9928c482011-07-12 16:41:08 +0000314 }
315
316 public:
317 ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3)
318 : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {}
319 };
320
John McCallf1549f62010-07-06 01:34:17 +0000321private:
322 // The implementation for this class is in CGException.h and
323 // CGException.cpp; the definition is here because it's used as a
324 // member of CodeGenFunction.
325
326 /// The start of the scope-stack buffer, i.e. the allocated pointer
327 /// for the buffer. All of these pointers are either simultaneously
328 /// null or simultaneously valid.
329 char *StartOfBuffer;
330
331 /// The end of the buffer.
332 char *EndOfBuffer;
333
334 /// The first valid entry in the buffer.
335 char *StartOfData;
336
337 /// The innermost normal cleanup on the stack.
338 stable_iterator InnermostNormalCleanup;
339
John McCall777d6e52011-08-11 02:22:43 +0000340 /// The innermost EH scope on the stack.
341 stable_iterator InnermostEHScope;
John McCallff8e1152010-07-23 21:56:41 +0000342
John McCallf1549f62010-07-06 01:34:17 +0000343 /// The current set of branch fixups. A branch fixup is a jump to
344 /// an as-yet unemitted label, i.e. a label for which we don't yet
345 /// know the EH stack depth. Whenever we pop a cleanup, we have
346 /// to thread all the current branch fixups through it.
347 ///
348 /// Fixups are recorded as the Use of the respective branch or
349 /// switch statement. The use points to the final destination.
350 /// When popping out of a cleanup, these uses are threaded through
351 /// the cleanup and adjusted to point to the new cleanup.
352 ///
353 /// Note that branches are allowed to jump into protected scopes
354 /// in certain situations; e.g. the following code is legal:
355 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
356 /// goto foo;
357 /// A a;
358 /// foo:
359 /// bar();
Chris Lattner686775d2011-07-20 06:58:45 +0000360 SmallVector<BranchFixup, 8> BranchFixups;
John McCallf1549f62010-07-06 01:34:17 +0000361
362 char *allocate(size_t Size);
363
John McCall1f0fca52010-07-21 07:22:38 +0000364 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCallda65ea82010-07-13 20:32:21 +0000365
John McCallf1549f62010-07-06 01:34:17 +0000366public:
367 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
368 InnermostNormalCleanup(stable_end()),
John McCall777d6e52011-08-11 02:22:43 +0000369 InnermostEHScope(stable_end()) {}
John McCallf1549f62010-07-06 01:34:17 +0000370 ~EHScopeStack() { delete[] StartOfBuffer; }
371
John McCallda65ea82010-07-13 20:32:21 +0000372 // Variadic templates would make this not terrible.
373
374 /// Push a lazily-created cleanup on the stack.
John McCall8e3f8612010-07-13 22:12:14 +0000375 template <class T>
John McCall1f0fca52010-07-21 07:22:38 +0000376 void pushCleanup(CleanupKind Kind) {
377 void *Buffer = pushCleanup(Kind, sizeof(T));
378 Cleanup *Obj = new(Buffer) T();
John McCall8e3f8612010-07-13 22:12:14 +0000379 (void) Obj;
380 }
381
382 /// Push a lazily-created cleanup on the stack.
383 template <class T, class A0>
John McCall1f0fca52010-07-21 07:22:38 +0000384 void pushCleanup(CleanupKind Kind, A0 a0) {
385 void *Buffer = pushCleanup(Kind, sizeof(T));
386 Cleanup *Obj = new(Buffer) T(a0);
John McCall8e3f8612010-07-13 22:12:14 +0000387 (void) Obj;
388 }
389
390 /// Push a lazily-created cleanup on the stack.
John McCallda65ea82010-07-13 20:32:21 +0000391 template <class T, class A0, class A1>
John McCall1f0fca52010-07-21 07:22:38 +0000392 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
393 void *Buffer = pushCleanup(Kind, sizeof(T));
394 Cleanup *Obj = new(Buffer) T(a0, a1);
John McCallda65ea82010-07-13 20:32:21 +0000395 (void) Obj;
396 }
397
398 /// Push a lazily-created cleanup on the stack.
399 template <class T, class A0, class A1, class A2>
John McCall1f0fca52010-07-21 07:22:38 +0000400 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
401 void *Buffer = pushCleanup(Kind, sizeof(T));
402 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
John McCallda65ea82010-07-13 20:32:21 +0000403 (void) Obj;
404 }
405
406 /// Push a lazily-created cleanup on the stack.
407 template <class T, class A0, class A1, class A2, class A3>
John McCall1f0fca52010-07-21 07:22:38 +0000408 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
409 void *Buffer = pushCleanup(Kind, sizeof(T));
410 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
John McCallda65ea82010-07-13 20:32:21 +0000411 (void) Obj;
412 }
413
John McCall77199712010-07-21 05:47:49 +0000414 /// Push a lazily-created cleanup on the stack.
415 template <class T, class A0, class A1, class A2, class A3, class A4>
John McCall1f0fca52010-07-21 07:22:38 +0000416 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
417 void *Buffer = pushCleanup(Kind, sizeof(T));
418 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
John McCall77199712010-07-21 05:47:49 +0000419 (void) Obj;
420 }
421
John McCall7d8647f2010-09-14 07:57:04 +0000422 // Feel free to add more variants of the following:
423
424 /// Push a cleanup with non-constant storage requirements on the
425 /// stack. The cleanup type must provide an additional static method:
426 /// static size_t getExtraSize(size_t);
427 /// The argument to this method will be the value N, which will also
428 /// be passed as the first argument to the constructor.
429 ///
430 /// The data stored in the extra storage must obey the same
431 /// restrictions as normal cleanup member data.
432 ///
433 /// The pointer returned from this method is valid until the cleanup
434 /// stack is modified.
435 template <class T, class A0, class A1, class A2>
436 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
437 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
438 return new (Buffer) T(N, a0, a1, a2);
439 }
440
John McCall777d6e52011-08-11 02:22:43 +0000441 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000442 void popCleanup();
443
444 /// Push a set of catch handlers on the stack. The catch is
445 /// uninitialized and will need to have the given number of handlers
446 /// set on it.
447 class EHCatchScope *pushCatch(unsigned NumHandlers);
448
John McCall777d6e52011-08-11 02:22:43 +0000449 /// Pops a catch scope off the stack. This is private to CGException.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000450 void popCatch();
451
452 /// Push an exceptions filter on the stack.
453 class EHFilterScope *pushFilter(unsigned NumFilters);
454
455 /// Pops an exceptions filter off the stack.
456 void popFilter();
457
458 /// Push a terminate handler on the stack.
459 void pushTerminate();
460
461 /// Pops a terminate handler off the stack.
462 void popTerminate();
463
464 /// Determines whether the exception-scopes stack is empty.
465 bool empty() const { return StartOfData == EndOfBuffer; }
466
467 bool requiresLandingPad() const {
John McCall777d6e52011-08-11 02:22:43 +0000468 return InnermostEHScope != stable_end();
John McCallf1549f62010-07-06 01:34:17 +0000469 }
470
471 /// Determines whether there are any normal cleanups on the stack.
472 bool hasNormalCleanups() const {
473 return InnermostNormalCleanup != stable_end();
474 }
475
476 /// Returns the innermost normal cleanup on the stack, or
477 /// stable_end() if there are no normal cleanups.
478 stable_iterator getInnermostNormalCleanup() const {
479 return InnermostNormalCleanup;
480 }
John McCall777d6e52011-08-11 02:22:43 +0000481 stable_iterator getInnermostActiveNormalCleanup() const;
John McCallf1549f62010-07-06 01:34:17 +0000482
John McCall777d6e52011-08-11 02:22:43 +0000483 stable_iterator getInnermostEHScope() const {
484 return InnermostEHScope;
John McCallf1549f62010-07-06 01:34:17 +0000485 }
486
John McCall777d6e52011-08-11 02:22:43 +0000487 stable_iterator getInnermostActiveEHScope() const;
John McCallf1549f62010-07-06 01:34:17 +0000488
489 /// An unstable reference to a scope-stack depth. Invalidated by
490 /// pushes but not pops.
491 class iterator;
492
493 /// Returns an iterator pointing to the innermost EH scope.
494 iterator begin() const;
495
496 /// Returns an iterator pointing to the outermost EH scope.
497 iterator end() const;
498
499 /// Create a stable reference to the top of the EH stack. The
500 /// returned reference is valid until that scope is popped off the
501 /// stack.
502 stable_iterator stable_begin() const {
503 return stable_iterator(EndOfBuffer - StartOfData);
504 }
505
506 /// Create a stable reference to the bottom of the EH stack.
507 static stable_iterator stable_end() {
508 return stable_iterator(0);
509 }
510
511 /// Translates an iterator into a stable_iterator.
512 stable_iterator stabilize(iterator it) const;
513
John McCallf1549f62010-07-06 01:34:17 +0000514 /// Turn a stable reference to a scope depth into a unstable pointer
515 /// to the EH stack.
516 iterator find(stable_iterator save) const;
517
518 /// Removes the cleanup pointed to by the given stable_iterator.
519 void removeCleanup(stable_iterator save);
520
521 /// Add a branch fixup to the current cleanup scope.
522 BranchFixup &addBranchFixup() {
523 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
524 BranchFixups.push_back(BranchFixup());
525 return BranchFixups.back();
526 }
527
528 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
529 BranchFixup &getBranchFixup(unsigned I) {
530 assert(I < getNumBranchFixups());
531 return BranchFixups[I];
532 }
533
John McCallff8e1152010-07-23 21:56:41 +0000534 /// Pops lazily-removed fixups from the end of the list. This
535 /// should only be called by procedures which have just popped a
536 /// cleanup or resolved one or more fixups.
537 void popNullFixups();
538
539 /// Clears the branch-fixups list. This should only be called by
John McCall8abdbd82010-09-18 02:24:39 +0000540 /// ResolveAllBranchFixups.
John McCallff8e1152010-07-23 21:56:41 +0000541 void clearFixups() { BranchFixups.clear(); }
John McCallf1549f62010-07-06 01:34:17 +0000542};
543
Reid Spencer5f016e22007-07-11 17:01:13 +0000544/// CodeGenFunction - This class organizes the per-function state that is used
545/// while generating LLVM code.
John McCall5936e332011-02-15 09:22:45 +0000546class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000547 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
548 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall4c40d982010-08-31 07:33:07 +0000549
550 friend class CGCXXABI;
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000551public:
John McCallff8e1152010-07-23 21:56:41 +0000552 /// A jump destination is an abstract label, branching to which may
553 /// require a jump out through normal cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000554 struct JumpDest {
John McCallff8e1152010-07-23 21:56:41 +0000555 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
556 JumpDest(llvm::BasicBlock *Block,
557 EHScopeStack::stable_iterator Depth,
558 unsigned Index)
559 : Block(Block), ScopeDepth(Depth), Index(Index) {}
560
561 bool isValid() const { return Block != 0; }
562 llvm::BasicBlock *getBlock() const { return Block; }
563 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
564 unsigned getDestIndex() const { return Index; }
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000565
Nadav Rotem495cfa42013-03-23 06:43:35 +0000566 // This should be used cautiously.
567 void setScopeDepth(EHScopeStack::stable_iterator depth) {
568 ScopeDepth = depth;
569 }
570
John McCallff8e1152010-07-23 21:56:41 +0000571 private:
John McCallf1549f62010-07-06 01:34:17 +0000572 llvm::BasicBlock *Block;
573 EHScopeStack::stable_iterator ScopeDepth;
John McCallff8e1152010-07-23 21:56:41 +0000574 unsigned Index;
575 };
576
Reid Spencer5f016e22007-07-11 17:01:13 +0000577 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar444be732009-11-13 05:51:54 +0000578 const TargetInfo &Target;
Mike Stump0dd9e882009-02-08 23:14:22 +0000579
Chris Lattner58dee102007-08-21 16:57:55 +0000580 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000581 CGBuilderTy Builder;
Mike Stump0dd9e882009-02-08 23:14:22 +0000582
John McCallf5ebf9b2013-05-03 07:33:41 +0000583 /// CurFuncDecl - Holds the Decl for the current outermost
584 /// non-closure context.
Chris Lattner41110242008-06-17 18:05:57 +0000585 const Decl *CurFuncDecl;
Chris Lattnerb5437d22009-04-23 05:30:27 +0000586 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
587 const Decl *CurCodeDecl;
Daniel Dunbar88b53962009-02-02 22:03:45 +0000588 const CGFunctionInfo *CurFnInfo;
Chris Lattner391d77a2008-03-30 23:03:07 +0000589 QualType FnRetTy;
Reid Spencer5f016e22007-07-11 17:01:13 +0000590 llvm::Function *CurFn;
591
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000592 /// CurGD - The GlobalDecl for the current function being compiled.
593 GlobalDecl CurGD;
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000594
John McCallf85e1932011-06-15 23:02:42 +0000595 /// PrologueCleanupDepth - The cleanup depth enclosing all the
596 /// cleanups associated with the parameters.
597 EHScopeStack::stable_iterator PrologueCleanupDepth;
598
Daniel Dunbar5ca20842008-09-09 21:00:17 +0000599 /// ReturnBlock - Unified return block.
John McCallf1549f62010-07-06 01:34:17 +0000600 JumpDest ReturnBlock;
601
Mike Stump0dd9e882009-02-08 23:14:22 +0000602 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledruf3477c12012-09-27 10:16:10 +0000603 /// iff the function has no return value.
Eli Friedmanb17daf92009-12-04 02:43:40 +0000604 llvm::Value *ReturnValue;
Mike Stump0dd9e882009-02-08 23:14:22 +0000605
Reid Spencer5f016e22007-07-11 17:01:13 +0000606 /// AllocaInsertPoint - This is an instruction in the entry block before which
607 /// we prefer to insert allocas.
Chris Lattner481769b2009-03-31 22:17:44 +0000608 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000609
Ben Langmuir524387a2013-05-09 19:17:11 +0000610 /// \brief API for captured statement code generation.
611 class CGCapturedStmtInfo {
612 public:
613 explicit CGCapturedStmtInfo(const CapturedStmt &S,
614 CapturedRegionKind K = CR_Default)
615 : Kind(K), ThisValue(0), CXXThisFieldDecl(0) {
616
617 RecordDecl::field_iterator Field =
618 S.getCapturedRecordDecl()->field_begin();
619 for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
620 E = S.capture_end();
621 I != E; ++I, ++Field) {
622 if (I->capturesThis())
623 CXXThisFieldDecl = *Field;
624 else
625 CaptureFields[I->getCapturedVar()] = *Field;
626 }
627 }
628
629 virtual ~CGCapturedStmtInfo();
630
631 CapturedRegionKind getKind() const { return Kind; }
632
633 void setContextValue(llvm::Value *V) { ThisValue = V; }
634 // \brief Retrieve the value of the context parameter.
635 llvm::Value *getContextValue() const { return ThisValue; }
636
637 /// \brief Lookup the captured field decl for a variable.
638 const FieldDecl *lookup(const VarDecl *VD) const {
639 return CaptureFields.lookup(VD);
640 }
641
642 bool isCXXThisExprCaptured() const { return CXXThisFieldDecl != 0; }
643 FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
644
645 /// \brief Emit the captured statement body.
646 virtual void EmitBody(CodeGenFunction &CGF, Stmt *S) {
647 CGF.EmitStmt(S);
648 }
649
650 /// \brief Get the name of the capture helper.
651 virtual StringRef getHelperName() const { return "__captured_stmt"; }
652
653 private:
654 /// \brief The kind of captured statement being generated.
655 CapturedRegionKind Kind;
656
657 /// \brief Keep the map between VarDecl and FieldDecl.
658 llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
659
660 /// \brief The base address of the captured record, passed in as the first
661 /// argument of the parallel region function.
662 llvm::Value *ThisValue;
663
664 /// \brief Captured 'this' type.
665 FieldDecl *CXXThisFieldDecl;
666 };
667 CGCapturedStmtInfo *CapturedStmtInfo;
668
Nuno Lopesb3198a82012-05-08 22:10:46 +0000669 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
670 /// potentially higher performance penalties.
671 unsigned char BoundsChecking;
672
Richard Smithd6396a62012-11-05 22:21:05 +0000673 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
674 /// calls to EmitTypeCheck can be skipped.
675 bool SanitizePerformTypeCheck;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000676
Will Dietz4f45bc02013-01-18 11:30:38 +0000677 /// \brief Sanitizer options to use for this function.
678 const SanitizerOptions *SanOpts;
679
John McCallf85e1932011-06-15 23:02:42 +0000680 /// In ARC, whether we should autorelease the return value.
681 bool AutoreleaseResult;
682
John McCalld16c2cf2011-02-08 08:22:06 +0000683 const CodeGen::CGBlockInfo *BlockInfo;
684 llvm::Value *BlockPointer;
685
Eli Friedmancec5ebd2012-02-11 02:57:39 +0000686 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
687 FieldDecl *LambdaThisCaptureField;
688
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000689 /// \brief A mapping from NRVO variables to the flags used to indicate
690 /// when the NRVO has been applied to this variable.
691 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000692
John McCallf1549f62010-07-06 01:34:17 +0000693 EHScopeStack EHStack;
694
John McCallff8e1152010-07-23 21:56:41 +0000695 /// i32s containing the indexes of the cleanup destinations.
696 llvm::AllocaInst *NormalCleanupDest;
John McCallff8e1152010-07-23 21:56:41 +0000697
698 unsigned NextCleanupDestIndex;
699
John McCall1a343eb2011-11-10 08:15:53 +0000700 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
701 CGBlockInfo *FirstBlockInfo;
702
John McCall777d6e52011-08-11 02:22:43 +0000703 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
704 llvm::BasicBlock *EHResumeBlock;
705
Bill Wendling285cfd82011-09-19 20:31:14 +0000706 /// The exception slot. All landing pads write the current exception pointer
707 /// into this alloca.
John McCallf1549f62010-07-06 01:34:17 +0000708 llvm::Value *ExceptionSlot;
709
Bill Wendling285cfd82011-09-19 20:31:14 +0000710 /// The selector slot. Under the MandatoryCleanup model, all landing pads
711 /// write the current selector value into this alloca.
John McCall93c332a2011-05-28 21:13:02 +0000712 llvm::AllocaInst *EHSelectorSlot;
713
John McCallf1549f62010-07-06 01:34:17 +0000714 /// Emits a landing pad for the current EH stack.
715 llvm::BasicBlock *EmitLandingPad();
716
717 llvm::BasicBlock *getInvokeDestImpl();
718
John McCall150b4622011-01-26 04:00:11 +0000719 template <class T>
John McCall804b8072011-01-28 10:53:53 +0000720 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
721 return DominatingValue<T>::save(*this, value);
John McCall150b4622011-01-26 04:00:11 +0000722 }
723
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000724public:
Anders Carlssonfa1f7562009-02-10 06:07:49 +0000725 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
726 /// rethrows.
Chris Lattner686775d2011-07-20 06:58:45 +0000727 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stump0dd9e882009-02-08 23:14:22 +0000728
John McCalld768e9d2011-06-22 02:32:12 +0000729 /// A class controlling the emission of a finally block.
730 class FinallyInfo {
731 /// Where the catchall's edge through the cleanup should go.
732 JumpDest RethrowDest;
Anders Carlssonbb66f9f2009-02-08 07:46:24 +0000733
John McCalld768e9d2011-06-22 02:32:12 +0000734 /// A function to call to enter the catch.
735 llvm::Constant *BeginCatchFn;
736
737 /// An i1 variable indicating whether or not the @finally is
738 /// running for an exception.
739 llvm::AllocaInst *ForEHVar;
740
741 /// An i8* variable into which the exception pointer to rethrow
742 /// has been saved.
743 llvm::AllocaInst *SavedExnVar;
744
745 public:
746 void enter(CodeGenFunction &CGF, const Stmt *Finally,
747 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
748 llvm::Constant *rethrowFn);
749 void exit(CodeGenFunction &CGF);
750 };
Mike Stumpd88ea562009-12-09 03:35:49 +0000751
John McCall150b4622011-01-26 04:00:11 +0000752 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
753 /// current full-expression. Safe against the possibility that
754 /// we're currently inside a conditionally-evaluated expression.
John McCall3ad32c82011-01-28 08:37:24 +0000755 template <class T, class A0>
756 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
757 // If we're not in a conditional branch, or if none of the
758 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000759 if (!isInConditionalBranch())
760 return EHStack.pushCleanup<T>(kind, a0);
John McCall3ad32c82011-01-28 08:37:24 +0000761
John McCall804b8072011-01-28 10:53:53 +0000762 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCall3ad32c82011-01-28 08:37:24 +0000763
764 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
765 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
766 initFullExprCleanup();
767 }
768
769 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
770 /// current full-expression. Safe against the possibility that
771 /// we're currently inside a conditionally-evaluated expression.
John McCall150b4622011-01-26 04:00:11 +0000772 template <class T, class A0, class A1>
773 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
774 // If we're not in a conditional branch, or if none of the
775 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000776 if (!isInConditionalBranch())
777 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCall150b4622011-01-26 04:00:11 +0000778
John McCall804b8072011-01-28 10:53:53 +0000779 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
780 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCall150b4622011-01-26 04:00:11 +0000781
782 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCall3ad32c82011-01-28 08:37:24 +0000783 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
784 initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000785 }
786
Douglas Gregord7b23162011-06-22 16:12:01 +0000787 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
788 /// current full-expression. Safe against the possibility that
789 /// we're currently inside a conditionally-evaluated expression.
790 template <class T, class A0, class A1, class A2>
791 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
792 // If we're not in a conditional branch, or if none of the
793 // arguments requires saving, then use the unconditional cleanup.
794 if (!isInConditionalBranch()) {
John McCallc4a1a842011-07-12 00:15:30 +0000795 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregord7b23162011-06-22 16:12:01 +0000796 }
797
798 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
799 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
800 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
801
802 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
803 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
804 initFullExprCleanup();
805 }
806
John McCall9928c482011-07-12 16:41:08 +0000807 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
808 /// current full-expression. Safe against the possibility that
809 /// we're currently inside a conditionally-evaluated expression.
810 template <class T, class A0, class A1, class A2, class A3>
811 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
812 // If we're not in a conditional branch, or if none of the
813 // arguments requires saving, then use the unconditional cleanup.
814 if (!isInConditionalBranch()) {
815 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
816 }
817
818 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
819 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
820 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
821 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
822
823 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
824 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
825 a2_saved, a3_saved);
826 initFullExprCleanup();
827 }
828
John McCall6f103ba2011-11-10 10:43:54 +0000829 /// Set up the last cleaup that was pushed as a conditional
830 /// full-expression cleanup.
831 void initFullExprCleanup();
832
John McCallf1549f62010-07-06 01:34:17 +0000833 /// PushDestructorCleanup - Push a cleanup to call the
834 /// complete-object destructor of an object of the given type at the
835 /// given address. Does nothing if T is not a C++ class type with a
836 /// non-trivial destructor.
837 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
838
John McCall81407d42010-07-21 06:29:51 +0000839 /// PushDestructorCleanup - Push a cleanup to call the
840 /// complete-object variant of the given destructor on the object at
841 /// the given address.
842 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
843 llvm::Value *Addr);
844
John McCallf1549f62010-07-06 01:34:17 +0000845 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
846 /// process all branch fixups.
Adrian Prantld072e592013-05-03 20:11:48 +0000847 /// \param EHLoc - Optional debug location for EH code.
848 void PopCleanupBlock(bool FallThroughIsBranchThrough = false,
849 SourceLocation EHLoc=SourceLocation());
John McCallf1549f62010-07-06 01:34:17 +0000850
John McCall7d8647f2010-09-14 07:57:04 +0000851 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
852 /// The block cannot be reactivated. Pops it if it's the top of the
853 /// stack.
John McCall6f103ba2011-11-10 10:43:54 +0000854 ///
855 /// \param DominatingIP - An instruction which is known to
856 /// dominate the current IP (if set) and which lies along
857 /// all paths of execution between the current IP and the
858 /// the point at which the cleanup comes into scope.
859 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
860 llvm::Instruction *DominatingIP);
John McCall7d8647f2010-09-14 07:57:04 +0000861
862 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
863 /// Cannot be used to resurrect a deactivated cleanup.
John McCall6f103ba2011-11-10 10:43:54 +0000864 ///
865 /// \param DominatingIP - An instruction which is known to
866 /// dominate the current IP (if set) and which lies along
867 /// all paths of execution between the current IP and the
868 /// the point at which the cleanup comes into scope.
869 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
870 llvm::Instruction *DominatingIP);
John McCallcd2d2b72010-08-13 21:20:51 +0000871
John McCallf1549f62010-07-06 01:34:17 +0000872 /// \brief Enters a new scope for capturing cleanups, all of which
873 /// will be executed once the scope is exited.
874 class RunCleanupsScope {
John McCallf1549f62010-07-06 01:34:17 +0000875 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000876 bool OldDidCallStackSave;
John McCalled383132013-03-01 01:24:35 +0000877 protected:
Douglas Gregor5656e142009-11-24 21:15:44 +0000878 bool PerformCleanup;
John McCalled383132013-03-01 01:24:35 +0000879 private:
Douglas Gregor01234bb2009-11-24 16:43:22 +0000880
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000881 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
882 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000883
Eric Christopherc3287792011-10-19 00:43:52 +0000884 protected:
885 CodeGenFunction& CGF;
Will Dietz4f45bc02013-01-18 11:30:38 +0000886
Douglas Gregor01234bb2009-11-24 16:43:22 +0000887 public:
888 /// \brief Enter a new cleanup scope.
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000889 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christopherc3287792011-10-19 00:43:52 +0000890 : PerformCleanup(true), CGF(CGF)
Douglas Gregor5656e142009-11-24 21:15:44 +0000891 {
John McCallf1549f62010-07-06 01:34:17 +0000892 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor01234bb2009-11-24 16:43:22 +0000893 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis4ada2ca2010-09-14 00:42:34 +0000894 CGF.DidCallStackSave = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000895 }
896
897 /// \brief Exit this cleanup scope, emitting any accumulated
898 /// cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000899 ~RunCleanupsScope() {
Douglas Gregor5656e142009-11-24 21:15:44 +0000900 if (PerformCleanup) {
901 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000902 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000903 }
904 }
905
906 /// \brief Determine whether this scope requires any cleanups.
907 bool requiresCleanups() const {
John McCallf1549f62010-07-06 01:34:17 +0000908 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor5656e142009-11-24 21:15:44 +0000909 }
910
911 /// \brief Force the emission of cleanups now, instead of waiting
912 /// until this object is destroyed.
913 void ForceCleanup() {
914 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor01234bb2009-11-24 16:43:22 +0000915 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000916 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000917 PerformCleanup = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000918 }
919 };
920
Eric Christopherc3287792011-10-19 00:43:52 +0000921 class LexicalScope: protected RunCleanupsScope {
922 SourceRange Range;
Nadav Rotem495cfa42013-03-23 06:43:35 +0000923 SmallVector<const LabelDecl*, 4> Labels;
924 LexicalScope *ParentScope;
Eric Christopherc3287792011-10-19 00:43:52 +0000925
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000926 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
927 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christopherc3287792011-10-19 00:43:52 +0000928
929 public:
930 /// \brief Enter a new cleanup scope.
931 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem495cfa42013-03-23 06:43:35 +0000932 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
933 CGF.CurLexicalScope = this;
Eric Christopherc3287792011-10-19 00:43:52 +0000934 if (CGDebugInfo *DI = CGF.getDebugInfo())
935 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
936 }
937
Nadav Rotem495cfa42013-03-23 06:43:35 +0000938 void addLabel(const LabelDecl *label) {
939 assert(PerformCleanup && "adding label to dead scope?");
940 Labels.push_back(label);
941 }
942
Eric Christopherc3287792011-10-19 00:43:52 +0000943 /// \brief Exit this cleanup scope, emitting any accumulated
944 /// cleanups.
945 ~LexicalScope() {
Adrian Prantlefb72ad2013-04-01 19:02:06 +0000946 if (CGDebugInfo *DI = CGF.getDebugInfo())
947 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
948
Nadav Rotem495cfa42013-03-23 06:43:35 +0000949 // If we should perform a cleanup, force them now. Note that
950 // this ends the cleanup scope before rescoping any labels.
951 if (PerformCleanup) ForceCleanup();
Eric Christopherc3287792011-10-19 00:43:52 +0000952 }
953
954 /// \brief Force the emission of cleanups now, instead of waiting
955 /// until this object is destroyed.
956 void ForceCleanup() {
Nadav Rotem495cfa42013-03-23 06:43:35 +0000957 CGF.CurLexicalScope = ParentScope;
Adrian Prantlefb72ad2013-04-01 19:02:06 +0000958 RunCleanupsScope::ForceCleanup();
959
Nadav Rotem495cfa42013-03-23 06:43:35 +0000960 if (!Labels.empty())
961 rescopeLabels();
Eric Christopherc3287792011-10-19 00:43:52 +0000962 }
Nadav Rotem495cfa42013-03-23 06:43:35 +0000963
964 void rescopeLabels();
Eric Christopherc3287792011-10-19 00:43:52 +0000965 };
966
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000967
John McCallf1549f62010-07-06 01:34:17 +0000968 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
969 /// the cleanup blocks that have been added.
Adrian Prantld072e592013-05-03 20:11:48 +0000970 /// \param EHLoc - Optional debug location for EH code.
971 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
972 SourceLocation EHLoc=SourceLocation());
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000973
John McCallff8e1152010-07-23 21:56:41 +0000974 void ResolveBranchFixups(llvm::BasicBlock *Target);
975
John McCallf1549f62010-07-06 01:34:17 +0000976 /// The given basic block lies in the current EH scope, but may be a
977 /// target of a potentially scope-crossing jump; get a stable handle
978 /// to which we can perform this jump later.
John McCallff8e1152010-07-23 21:56:41 +0000979 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCall413e6772010-07-28 01:07:35 +0000980 return JumpDest(Target,
981 EHStack.getInnermostNormalCleanup(),
982 NextCleanupDestIndex++);
John McCallf1549f62010-07-06 01:34:17 +0000983 }
Anders Carlssonc71c8452009-02-07 23:50:39 +0000984
John McCallf1549f62010-07-06 01:34:17 +0000985 /// The given basic block lies in the current EH scope, but may be a
986 /// target of a potentially scope-crossing jump; get a stable handle
987 /// to which we can perform this jump later.
Chris Lattner686775d2011-07-20 06:58:45 +0000988 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallff8e1152010-07-23 21:56:41 +0000989 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallf1549f62010-07-06 01:34:17 +0000990 }
991
992 /// EmitBranchThroughCleanup - Emit a branch from the current insert
993 /// block through the normal cleanup handling code (if any) and then
994 /// on to \arg Dest.
995 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerb11f9192011-04-17 00:54:30 +0000996
997 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
998 /// specified destination obviously has no cleanups to run. 'false' is always
999 /// a conservatively correct answer for this method.
1000 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallf1549f62010-07-06 01:34:17 +00001001
John McCall777d6e52011-08-11 02:22:43 +00001002 /// popCatchScope - Pops the catch scope at the top of the EHScope
1003 /// stack, emitting any required code (other than the catch handlers
1004 /// themselves).
1005 void popCatchScope();
John McCallff8e1152010-07-23 21:56:41 +00001006
David Chisnallc6860042012-11-07 16:50:40 +00001007 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall777d6e52011-08-11 02:22:43 +00001008 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stump0dd9e882009-02-08 23:14:22 +00001009
John McCall150b4622011-01-26 04:00:11 +00001010 /// An object to manage conditionally-evaluated expressions.
1011 class ConditionalEvaluation {
1012 llvm::BasicBlock *StartBB;
Mike Stump1eb44332009-09-09 15:08:12 +00001013
John McCall150b4622011-01-26 04:00:11 +00001014 public:
1015 ConditionalEvaluation(CodeGenFunction &CGF)
1016 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001017
John McCall150b4622011-01-26 04:00:11 +00001018 void begin(CodeGenFunction &CGF) {
1019 assert(CGF.OutermostConditional != this);
1020 if (!CGF.OutermostConditional)
1021 CGF.OutermostConditional = this;
1022 }
1023
1024 void end(CodeGenFunction &CGF) {
1025 assert(CGF.OutermostConditional != 0);
1026 if (CGF.OutermostConditional == this)
1027 CGF.OutermostConditional = 0;
1028 }
1029
1030 /// Returns a block which will be executed prior to each
1031 /// evaluation of the conditional code.
1032 llvm::BasicBlock *getStartingBlock() const {
1033 return StartBB;
1034 }
1035 };
Mike Stump1eb44332009-09-09 15:08:12 +00001036
John McCall3019c442010-09-17 00:50:28 +00001037 /// isInConditionalBranch - Return true if we're currently emitting
1038 /// one branch or the other of a conditional expression.
John McCall150b4622011-01-26 04:00:11 +00001039 bool isInConditionalBranch() const { return OutermostConditional != 0; }
1040
John McCall6f103ba2011-11-10 10:43:54 +00001041 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
1042 assert(isInConditionalBranch());
1043 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
1044 new llvm::StoreInst(value, addr, &block->back());
1045 }
1046
John McCall150b4622011-01-26 04:00:11 +00001047 /// An RAII object to record that we're evaluating a statement
1048 /// expression.
1049 class StmtExprEvaluation {
1050 CodeGenFunction &CGF;
1051
1052 /// We have to save the outermost conditional: cleanups in a
1053 /// statement expression aren't conditional just because the
1054 /// StmtExpr is.
1055 ConditionalEvaluation *SavedOutermostConditional;
1056
1057 public:
1058 StmtExprEvaluation(CodeGenFunction &CGF)
1059 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
1060 CGF.OutermostConditional = 0;
1061 }
1062
1063 ~StmtExprEvaluation() {
1064 CGF.OutermostConditional = SavedOutermostConditional;
1065 CGF.EnsureInsertPoint();
1066 }
1067 };
John McCalle996ffd2011-02-16 08:02:54 +00001068
John McCall56ca35d2011-02-17 10:25:35 +00001069 /// An object which temporarily prevents a value from being
1070 /// destroyed by aggressive peephole optimizations that assume that
1071 /// all uses of a value have been realized in the IR.
1072 class PeepholeProtection {
1073 llvm::Instruction *Inst;
1074 friend class CodeGenFunction;
1075
1076 public:
1077 PeepholeProtection() : Inst(0) {}
John McCall4b9c2d22011-11-06 09:01:30 +00001078 };
John McCall56ca35d2011-02-17 10:25:35 +00001079
John McCall4b9c2d22011-11-06 09:01:30 +00001080 /// A non-RAII class containing all the information about a bound
1081 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1082 /// this which makes individual mappings very simple; using this
1083 /// class directly is useful when you have a variable number of
1084 /// opaque values or don't want the RAII functionality for some
1085 /// reason.
1086 class OpaqueValueMappingData {
John McCalle996ffd2011-02-16 08:02:54 +00001087 const OpaqueValueExpr *OpaqueValue;
John McCall56ca35d2011-02-17 10:25:35 +00001088 bool BoundLValue;
1089 CodeGenFunction::PeepholeProtection Protection;
John McCalle996ffd2011-02-16 08:02:54 +00001090
John McCall4b9c2d22011-11-06 09:01:30 +00001091 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1092 bool boundLValue)
1093 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCalle996ffd2011-02-16 08:02:54 +00001094 public:
John McCall4b9c2d22011-11-06 09:01:30 +00001095 OpaqueValueMappingData() : OpaqueValue(0) {}
1096
John McCall56ca35d2011-02-17 10:25:35 +00001097 static bool shouldBindAsLValue(const Expr *expr) {
John McCalla5493f82011-11-08 22:54:08 +00001098 // gl-values should be bound as l-values for obvious reasons.
1099 // Records should be bound as l-values because IR generation
1100 // always keeps them in memory. Expressions of function type
1101 // act exactly like l-values but are formally required to be
1102 // r-values in C.
1103 return expr->isGLValue() ||
1104 expr->getType()->isRecordType() ||
1105 expr->getType()->isFunctionType();
John McCall56ca35d2011-02-17 10:25:35 +00001106 }
1107
John McCall4b9c2d22011-11-06 09:01:30 +00001108 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1109 const OpaqueValueExpr *ov,
1110 const Expr *e) {
1111 if (shouldBindAsLValue(ov))
1112 return bind(CGF, ov, CGF.EmitLValue(e));
1113 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1114 }
1115
1116 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1117 const OpaqueValueExpr *ov,
1118 const LValue &lv) {
1119 assert(shouldBindAsLValue(ov));
1120 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1121 return OpaqueValueMappingData(ov, true);
1122 }
1123
1124 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1125 const OpaqueValueExpr *ov,
1126 const RValue &rv) {
1127 assert(!shouldBindAsLValue(ov));
1128 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1129
1130 OpaqueValueMappingData data(ov, false);
1131
1132 // Work around an extremely aggressive peephole optimization in
1133 // EmitScalarConversion which assumes that all other uses of a
1134 // value are extant.
1135 data.Protection = CGF.protectFromPeepholes(rv);
1136
1137 return data;
1138 }
1139
1140 bool isValid() const { return OpaqueValue != 0; }
1141 void clear() { OpaqueValue = 0; }
1142
1143 void unbind(CodeGenFunction &CGF) {
1144 assert(OpaqueValue && "no data to unbind!");
1145
1146 if (BoundLValue) {
1147 CGF.OpaqueLValues.erase(OpaqueValue);
1148 } else {
1149 CGF.OpaqueRValues.erase(OpaqueValue);
1150 CGF.unprotectFromPeepholes(Protection);
1151 }
1152 }
1153 };
1154
1155 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1156 class OpaqueValueMapping {
1157 CodeGenFunction &CGF;
1158 OpaqueValueMappingData Data;
1159
1160 public:
1161 static bool shouldBindAsLValue(const Expr *expr) {
1162 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1163 }
1164
John McCall56ca35d2011-02-17 10:25:35 +00001165 /// Build the opaque value mapping for the given conditional
1166 /// operator if it's the GNU ?: extension. This is a common
1167 /// enough pattern that the convenience operator is really
1168 /// helpful.
1169 ///
1170 OpaqueValueMapping(CodeGenFunction &CGF,
1171 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCall4b9c2d22011-11-06 09:01:30 +00001172 if (isa<ConditionalOperator>(op))
1173 // Leave Data empty.
John McCall56ca35d2011-02-17 10:25:35 +00001174 return;
John McCall56ca35d2011-02-17 10:25:35 +00001175
1176 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCall4b9c2d22011-11-06 09:01:30 +00001177 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1178 e->getCommon());
John McCall56ca35d2011-02-17 10:25:35 +00001179 }
1180
John McCalle996ffd2011-02-16 08:02:54 +00001181 OpaqueValueMapping(CodeGenFunction &CGF,
1182 const OpaqueValueExpr *opaqueValue,
John McCall56ca35d2011-02-17 10:25:35 +00001183 LValue lvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001184 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCall56ca35d2011-02-17 10:25:35 +00001185 }
1186
1187 OpaqueValueMapping(CodeGenFunction &CGF,
1188 const OpaqueValueExpr *opaqueValue,
1189 RValue rvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001190 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCalle996ffd2011-02-16 08:02:54 +00001191 }
1192
1193 void pop() {
John McCall4b9c2d22011-11-06 09:01:30 +00001194 Data.unbind(CGF);
1195 Data.clear();
John McCalle996ffd2011-02-16 08:02:54 +00001196 }
1197
1198 ~OpaqueValueMapping() {
John McCall4b9c2d22011-11-06 09:01:30 +00001199 if (Data.isValid()) Data.unbind(CGF);
John McCalle996ffd2011-02-16 08:02:54 +00001200 }
1201 };
Fariborz Jahaniane2204552010-11-16 19:29:39 +00001202
1203 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1204 /// number that holds the value.
1205 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian52a80e12011-01-26 23:08:27 +00001206
1207 /// BuildBlockByrefAddress - Computes address location of the
1208 /// variable which is declared as __block.
1209 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1210 const VarDecl *V);
Chris Lattner7f02f722007-08-24 05:35:26 +00001211private:
Chris Lattnerd9becd12009-10-28 23:59:40 +00001212 CGDebugInfo *DebugInfo;
Devang Patelaa112892011-03-07 18:45:56 +00001213 bool DisableDebugInfo;
Mike Stump09429b92009-02-17 17:00:02 +00001214
Manman Ren63fd4082013-03-20 16:59:38 +00001215 /// If the current function returns 'this', use the field to keep track of
1216 /// the callee that returns 'this'.
1217 llvm::Value *CalleeWithThisReturn;
1218
John McCall93c332a2011-05-28 21:13:02 +00001219 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1220 /// calling llvm.stacksave for multiple VLAs in the same scope.
1221 bool DidCallStackSave;
1222
Mike Stumpf71d2322009-11-30 20:08:49 +00001223 /// IndirectBranch - The first time an indirect goto is seen we create a block
1224 /// with an indirect branch. Every time we see the address of a label taken,
1225 /// we add the label to the indirect goto. Every subsequent indirect goto is
1226 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattnerd9becd12009-10-28 23:59:40 +00001227 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001228
Mike Stump0dd9e882009-02-08 23:14:22 +00001229 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1230 /// decls.
John McCall6b5a61b2011-02-07 10:33:21 +00001231 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1232 DeclMapTy LocalDeclMap;
Reid Spencer5f016e22007-07-11 17:01:13 +00001233
1234 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001235 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001236
Mike Stump0dd9e882009-02-08 23:14:22 +00001237 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone4b6d342009-02-10 05:52:02 +00001238 // statements should jump to.
Chris Lattnerda138702007-07-16 21:28:45 +00001239 struct BreakContinue {
John McCallf1549f62010-07-06 01:34:17 +00001240 BreakContinue(JumpDest Break, JumpDest Continue)
1241 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stump0dd9e882009-02-08 23:14:22 +00001242
John McCallf1549f62010-07-06 01:34:17 +00001243 JumpDest BreakBlock;
1244 JumpDest ContinueBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001245 };
Chris Lattner686775d2011-07-20 06:58:45 +00001246 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +00001247
Zhongxing Xu170fd492012-01-14 09:08:15 +00001248 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stump0dd9e882009-02-08 23:14:22 +00001249 /// current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +00001250 llvm::SwitchInst *SwitchInsn;
1251
Mike Stump0dd9e882009-02-08 23:14:22 +00001252 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel80fd5f92007-10-09 17:08:50 +00001253 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +00001254 llvm::BasicBlock *CaseRangeBlock;
1255
John McCall56ca35d2011-02-17 10:25:35 +00001256 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCalle996ffd2011-02-16 08:02:54 +00001257 /// expressions.
John McCall56ca35d2011-02-17 10:25:35 +00001258 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1259 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCalle996ffd2011-02-16 08:02:54 +00001260
Mike Stump0dd9e882009-02-08 23:14:22 +00001261 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001262 // We track this by the size expression rather than the type itself because
1263 // in certain situations, like a const qualifier applied to an VLA typedef,
1264 // multiple VLA types can share the same size expression.
Mike Stump0dd9e882009-02-08 23:14:22 +00001265 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1266 // enter/leave scopes.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001267 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001268
John McCallf1549f62010-07-06 01:34:17 +00001269 /// A block containing a single 'unreachable' instruction. Created
1270 /// lazily by getUnreachableBlock().
1271 llvm::BasicBlock *UnreachableBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001272
Adrian Prantld072e592013-05-03 20:11:48 +00001273 /// Counts of the number return expressions in the function.
1274 unsigned NumReturnExprs;
Adrian Prantlfa6b0792013-05-02 17:30:20 +00001275
1276 /// Count the number of simple (constant) return expressions in the function.
1277 unsigned NumSimpleReturnExprs;
1278
Adrian Prantld072e592013-05-03 20:11:48 +00001279 /// The last regular (non-return) debug location (breakpoint) in the function.
1280 SourceLocation LastStopPoint;
Adrian Prantlfa6b0792013-05-02 17:30:20 +00001281
Richard Smithc3bf52c2013-04-20 22:23:05 +00001282public:
1283 /// A scope within which we are constructing the fields of an object which
1284 /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
1285 /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
1286 class FieldConstructionScope {
1287 public:
1288 FieldConstructionScope(CodeGenFunction &CGF, llvm::Value *This)
1289 : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
1290 CGF.CXXDefaultInitExprThis = This;
1291 }
1292 ~FieldConstructionScope() {
1293 CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
1294 }
1295
1296 private:
1297 CodeGenFunction &CGF;
1298 llvm::Value *OldCXXDefaultInitExprThis;
1299 };
1300
1301 /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
1302 /// is overridden to be the object under construction.
1303 class CXXDefaultInitExprScope {
1304 public:
1305 CXXDefaultInitExprScope(CodeGenFunction &CGF)
1306 : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue) {
1307 CGF.CXXThisValue = CGF.CXXDefaultInitExprThis;
1308 }
1309 ~CXXDefaultInitExprScope() {
1310 CGF.CXXThisValue = OldCXXThisValue;
1311 }
1312
1313 public:
1314 CodeGenFunction &CGF;
1315 llvm::Value *OldCXXThisValue;
1316 };
1317
1318private:
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001319 /// CXXThisDecl - When generating code for a C++ member function,
1320 /// this will hold the implicit 'this' declaration.
Eli Friedmancec5ebd2012-02-11 02:57:39 +00001321 ImplicitParamDecl *CXXABIThisDecl;
1322 llvm::Value *CXXABIThisValue;
John McCall25049412010-02-16 22:04:33 +00001323 llvm::Value *CXXThisValue;
Mike Stump1eb44332009-09-09 15:08:12 +00001324
Richard Smithc3bf52c2013-04-20 22:23:05 +00001325 /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
1326 /// this expression.
1327 llvm::Value *CXXDefaultInitExprThis;
1328
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001329 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1330 /// destructor, this will hold the implicit argument (e.g. VTT).
1331 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1332 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001333
John McCall150b4622011-01-26 04:00:11 +00001334 /// OutermostConditional - Points to the outermost active
1335 /// conditional control. This is used so that we know if a
1336 /// temporary should be destroyed conditionally.
1337 ConditionalEvaluation *OutermostConditional;
Mike Stump1eb44332009-09-09 15:08:12 +00001338
Nadav Rotem495cfa42013-03-23 06:43:35 +00001339 /// The current lexical scope.
1340 LexicalScope *CurLexicalScope;
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001341
1342 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1343 /// type as well as the field number that contains the actual data.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001344 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001345 unsigned> > ByRefValueInfo;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001346
John McCallf1549f62010-07-06 01:34:17 +00001347 llvm::BasicBlock *TerminateLandingPad;
Mike Stump182f3832009-12-10 00:02:42 +00001348 llvm::BasicBlock *TerminateHandler;
Chris Lattner83252dc2010-07-20 21:07:09 +00001349 llvm::BasicBlock *TrapBB;
Eli Friedman94067052009-12-10 02:21:21 +00001350
Tanya Lattner0df579e2012-07-09 22:06:01 +00001351 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1352 /// In the kernel metadata node, reference the kernel function and metadata
1353 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Gouly37453b92013-03-08 09:42:32 +00001354 /// - A node for the vec_type_hint(<type>) qualifier contains string
1355 /// "vec_type_hint", an undefined value of the <type> data type,
1356 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattner0df579e2012-07-09 22:06:01 +00001357 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1358 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1359 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1360 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1361 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1362 llvm::Function *Fn);
1363
Reid Spencer5f016e22007-07-11 17:01:13 +00001364public:
Fariborz Jahanian4904bf42012-06-26 16:06:38 +00001365 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall1a343eb2011-11-10 08:15:53 +00001366 ~CodeGenFunction();
Mike Stump0dd9e882009-02-08 23:14:22 +00001367
John McCall1e7fe752010-09-02 09:58:18 +00001368 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCallf2aac842011-05-15 02:34:36 +00001369 ASTContext &getContext() const { return CGM.getContext(); }
Alexey Samsonova240df22012-10-16 07:22:28 +00001370 /// Returns true if DebugInfo is actually initialized.
1371 bool maybeInitializeDebugInfo() {
1372 if (CGM.getModuleDebugInfo()) {
1373 DebugInfo = CGM.getModuleDebugInfo();
1374 return true;
1375 }
1376 return false;
1377 }
Devang Patelaa112892011-03-07 18:45:56 +00001378 CGDebugInfo *getDebugInfo() {
1379 if (DisableDebugInfo)
1380 return NULL;
1381 return DebugInfo;
1382 }
1383 void disableDebugInfo() { DisableDebugInfo = true; }
1384 void enableDebugInfo() { DisableDebugInfo = false; }
1385
John McCallf85e1932011-06-15 23:02:42 +00001386 bool shouldUseFusedARCCalls() {
1387 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1388 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001389
David Blaikie4e4d0842012-03-11 07:00:24 +00001390 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCalld16c2cf2011-02-08 08:22:06 +00001391
Bill Wendling285cfd82011-09-19 20:31:14 +00001392 /// Returns a pointer to the function's exception object and selector slot,
1393 /// which is assigned in every landing pad.
John McCallf1549f62010-07-06 01:34:17 +00001394 llvm::Value *getExceptionSlot();
John McCall93c332a2011-05-28 21:13:02 +00001395 llvm::Value *getEHSelectorSlot();
John McCallf1549f62010-07-06 01:34:17 +00001396
Bill Wendlingae270592011-09-15 18:57:19 +00001397 /// Returns the contents of the function's exception object and selector
1398 /// slots.
1399 llvm::Value *getExceptionFromSlot();
1400 llvm::Value *getSelectorFromSlot();
1401
John McCallff8e1152010-07-23 21:56:41 +00001402 llvm::Value *getNormalCleanupDestSlot();
John McCallff8e1152010-07-23 21:56:41 +00001403
John McCallf1549f62010-07-06 01:34:17 +00001404 llvm::BasicBlock *getUnreachableBlock() {
1405 if (!UnreachableBlock) {
1406 UnreachableBlock = createBasicBlock("unreachable");
1407 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1408 }
1409 return UnreachableBlock;
1410 }
1411
1412 llvm::BasicBlock *getInvokeDest() {
1413 if (!EHStack.requiresLandingPad()) return 0;
1414 return getInvokeDestImpl();
1415 }
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001416
John McCall64aa4b32013-04-16 22:48:15 +00001417 const TargetInfo &getTarget() const { return Target; }
John McCalld16c2cf2011-02-08 08:22:06 +00001418 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Anderson69243822009-07-13 04:10:07 +00001419
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001420 //===--------------------------------------------------------------------===//
John McCallbdc4d802011-07-09 01:37:26 +00001421 // Cleanups
1422 //===--------------------------------------------------------------------===//
1423
1424 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1425
John McCall2673c682011-07-11 08:38:19 +00001426 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1427 llvm::Value *arrayEndPointer,
1428 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001429 Destroyer *destroyer);
John McCall2673c682011-07-11 08:38:19 +00001430 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1431 llvm::Value *arrayEnd,
1432 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001433 Destroyer *destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001434
John McCall9928c482011-07-12 16:41:08 +00001435 void pushDestroy(QualType::DestructionKind dtorKind,
1436 llvm::Value *addr, QualType type);
John McCall074cae02013-02-01 05:11:40 +00001437 void pushEHDestroy(QualType::DestructionKind dtorKind,
1438 llvm::Value *addr, QualType type);
John McCallbdc4d802011-07-09 01:37:26 +00001439 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001440 Destroyer *destroyer, bool useEHCleanupForArray);
1441 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001442 bool useEHCleanupForArray);
John McCalla91f6662011-07-13 03:01:35 +00001443 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1444 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001445 Destroyer *destroyer,
John McCalla91f6662011-07-13 03:01:35 +00001446 bool useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001447 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001448 QualType type, Destroyer *destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001449 bool checkZeroLength, bool useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001450
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001451 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall9928c482011-07-12 16:41:08 +00001452
John McCallbdc4d802011-07-09 01:37:26 +00001453 /// Determines whether an EH cleanup is required to destroy a type
1454 /// with the given destruction kind.
1455 bool needsEHCleanup(QualType::DestructionKind kind) {
1456 switch (kind) {
1457 case QualType::DK_none:
1458 return false;
1459 case QualType::DK_cxx_destructor:
1460 case QualType::DK_objc_weak_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001461 return getLangOpts().Exceptions;
John McCallbdc4d802011-07-09 01:37:26 +00001462 case QualType::DK_objc_strong_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001463 return getLangOpts().Exceptions &&
John McCallbdc4d802011-07-09 01:37:26 +00001464 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1465 }
1466 llvm_unreachable("bad destruction kind");
1467 }
1468
John McCall9928c482011-07-12 16:41:08 +00001469 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1470 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1471 }
1472
John McCallbdc4d802011-07-09 01:37:26 +00001473 //===--------------------------------------------------------------------===//
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001474 // Objective-C
1475 //===--------------------------------------------------------------------===//
1476
Chris Lattner391d77a2008-03-30 23:03:07 +00001477 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001478
Mike Stump0dd9e882009-02-08 23:14:22 +00001479 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patel8d3f8972011-05-19 23:37:41 +00001480 const ObjCContainerDecl *CD,
1481 SourceLocation StartLoc);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001482
Mike Stump0dd9e882009-02-08 23:14:22 +00001483 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001484 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1485 const ObjCPropertyImplDecl *PID);
John McCall1e1f4872011-09-13 03:34:09 +00001486 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001487 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanian490a52b2012-05-29 19:56:01 +00001488 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001489 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian2846b972011-02-18 19:15:13 +00001490
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001491 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1492 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001493
Mike Stump0dd9e882009-02-08 23:14:22 +00001494 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1495 /// for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001496 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1497 const ObjCPropertyImplDecl *PID);
John McCall71c758d2011-09-10 09:17:20 +00001498 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001499 const ObjCPropertyImplDecl *propImpl,
1500 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001501 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001502 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001503
Mike Stump4e7a1f72009-02-21 20:00:35 +00001504 //===--------------------------------------------------------------------===//
1505 // Block Bits
1506 //===--------------------------------------------------------------------===//
1507
John McCall6b5a61b2011-02-07 10:33:21 +00001508 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall1a343eb2011-11-10 08:15:53 +00001509 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1510 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garst2a7eb282010-02-23 21:51:17 +00001511 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00001512 const CGBlockInfo &Info,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001513 llvm::StructType *,
John McCalld16c2cf2011-02-08 08:22:06 +00001514 llvm::Constant *BlockVarLayout);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001515
Fariborz Jahanian564360b2010-06-24 00:08:06 +00001516 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall6b5a61b2011-02-07 10:33:21 +00001517 const CGBlockInfo &Info,
Eli Friedman64bee652012-02-25 02:48:22 +00001518 const DeclMapTy &ldm,
1519 bool IsLambdaConversionToBlock);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001520
John McCalld16c2cf2011-02-08 08:22:06 +00001521 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1522 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00001523 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1524 const ObjCPropertyImplDecl *PID);
1525 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1526 const ObjCPropertyImplDecl *PID);
Eli Friedmancae40c42012-02-28 01:08:45 +00001527 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCalld16c2cf2011-02-08 08:22:06 +00001528
John McCalld16c2cf2011-02-08 08:22:06 +00001529 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1530
John McCall5af02db2011-03-31 01:59:53 +00001531 class AutoVarEmission;
1532
1533 void emitByrefStructureInit(const AutoVarEmission &emission);
1534 void enterByrefCleanup(const AutoVarEmission &emission);
1535
John McCall6b5a61b2011-02-07 10:33:21 +00001536 llvm::Value *LoadBlockStruct() {
1537 assert(BlockPointer && "no block pointer set!");
1538 return BlockPointer;
1539 }
Mike Stump4e7a1f72009-02-21 20:00:35 +00001540
John McCallea1471e2010-05-20 01:18:31 +00001541 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCallf4b88a42012-03-10 09:33:50 +00001542 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall6b5a61b2011-02-07 10:33:21 +00001543 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001544 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stumpdab514f2009-03-04 03:23:46 +00001545
John McCalld26bc762011-03-09 04:27:21 +00001546 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1547 const CGFunctionInfo &FnInfo);
John McCallf5ebf9b2013-05-03 07:33:41 +00001548 void StartFunction(GlobalDecl GD,
1549 QualType RetTy,
Daniel Dunbar7c086512008-09-09 23:14:03 +00001550 llvm::Function *Fn,
John McCalld26bc762011-03-09 04:27:21 +00001551 const CGFunctionInfo &FnInfo,
Daniel Dunbar2284ac92008-10-18 18:22:23 +00001552 const FunctionArgList &Args,
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00001553 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001554
John McCall9fc6a772010-02-19 09:25:03 +00001555 void EmitConstructorBody(FunctionArgList &Args);
1556 void EmitDestructorBody(FunctionArgList &Args);
Lang Hames56c00c42013-02-17 07:22:09 +00001557 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
John McCall9fc6a772010-02-19 09:25:03 +00001558 void EmitFunctionBody(FunctionArgList &Args);
John McCalla355e072010-02-18 03:17:58 +00001559
Eli Friedman64bee652012-02-25 02:48:22 +00001560 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1561 CallArgList &CallArgs);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001562 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman64bee652012-02-25 02:48:22 +00001563 void EmitLambdaBlockInvokeBody();
Douglas Gregor27dd7d92012-02-17 03:02:34 +00001564 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1565 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001566
Mike Stump0dd9e882009-02-08 23:14:22 +00001567 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1568 /// emission when possible.
David Blaikie0a0f93c2013-02-01 19:09:49 +00001569 void EmitReturnBlock();
Daniel Dunbar1c1d6072009-01-26 23:27:52 +00001570
Mike Stump0dd9e882009-02-08 23:14:22 +00001571 /// FinishFunction - Complete IR generation of the current function. It is
1572 /// legal to call this function even if there is no current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001573 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001574
Anders Carlsson519c3282010-03-24 00:39:18 +00001575 /// GenerateThunk - Generate a thunk for the given method.
John McCalld26bc762011-03-09 04:27:21 +00001576 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1577 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001578
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00001579 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1580 GlobalDecl GD, const ThunkInfo &Thunk);
1581
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001582 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1583 FunctionArgList &Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001584
Eli Friedmanb74ed082012-02-14 02:31:03 +00001585 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1586 ArrayRef<VarDecl *> ArrayIndexes);
1587
Anders Carlssond103f9f2010-03-28 19:40:00 +00001588 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1589 /// subobject.
1590 ///
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001591 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001592 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001593 CharUnits OffsetFromNearestVBase,
Anders Carlssond103f9f2010-03-28 19:40:00 +00001594 llvm::Constant *VTable,
1595 const CXXRecordDecl *VTableClass);
1596
1597 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001598 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001599 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001600 CharUnits OffsetFromNearestVBase,
Anders Carlsson603d6d12010-03-28 21:07:49 +00001601 bool BaseIsNonVirtualPrimaryBase,
1602 llvm::Constant *VTable,
1603 const CXXRecordDecl *VTableClass,
1604 VisitedVirtualBasesSetTy& VBases);
Eli Friedman77a259c2009-12-08 06:46:18 +00001605
Anders Carlsson603d6d12010-03-28 21:07:49 +00001606 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001607
Dan Gohman043fb9a2010-10-26 18:44:08 +00001608 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1609 /// to by This.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001610 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001611
John McCall50da2ca2010-07-21 05:30:47 +00001612 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1613 /// given phase of destruction for a destructor. The end result
1614 /// should call destructors on members and base classes in reverse
1615 /// order of their construction.
1616 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001617
Chris Lattner7255a2d2010-06-22 00:03:40 +00001618 /// ShouldInstrumentFunction - Return true if the current function should be
1619 /// instrumented with __cyg_profile_func_* calls
1620 bool ShouldInstrumentFunction();
1621
1622 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1623 /// instrumentation function with the current function and the call site, if
1624 /// function instrumentation is enabled.
1625 void EmitFunctionInstrumentation(const char *Fn);
1626
Roman Divackybe4c8702011-02-10 16:52:03 +00001627 /// EmitMCountInstrumentation - Emit call to .mcount.
1628 void EmitMCountInstrumentation();
1629
Mike Stump0dd9e882009-02-08 23:14:22 +00001630 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1631 /// arguments for the given function. This is also responsible for naming the
1632 /// LLVM function arguments.
Daniel Dunbar88b53962009-02-02 22:03:45 +00001633 void EmitFunctionProlog(const CGFunctionInfo &FI,
1634 llvm::Function *Fn,
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001635 const FunctionArgList &Args);
1636
Mike Stump0dd9e882009-02-08 23:14:22 +00001637 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1638 /// given temporary.
Adrian Prantlfa6b0792013-05-02 17:30:20 +00001639 void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc);
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001640
Mike Stumpcce3d4f2009-12-07 23:38:24 +00001641 /// EmitStartEHSpec - Emit the start of the exception spec.
1642 void EmitStartEHSpec(const Decl *D);
1643
1644 /// EmitEndEHSpec - Emit the end of the exception spec.
1645 void EmitEndEHSpec(const Decl *D);
1646
John McCallf1549f62010-07-06 01:34:17 +00001647 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1648 llvm::BasicBlock *getTerminateLandingPad();
1649
1650 /// getTerminateHandler - Return a handler (not a landing pad, just
1651 /// a catch handler) that just calls terminate. This is used when
1652 /// a terminate scope encloses a try.
Mike Stump9b39c512009-12-09 22:59:31 +00001653 llvm::BasicBlock *getTerminateHandler();
1654
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001655 llvm::Type *ConvertTypeForMem(QualType T);
1656 llvm::Type *ConvertType(QualType T);
1657 llvm::Type *ConvertType(const TypeDecl *T) {
John McCallbff225e2010-02-16 04:15:37 +00001658 return ConvertType(getContext().getTypeDeclType(T));
1659 }
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001660
Mike Stump0dd9e882009-02-08 23:14:22 +00001661 /// LoadObjCSelf - Load the value of self. This function is only valid while
1662 /// generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001663 llvm::Value *LoadObjCSelf();
Mike Stump0dd9e882009-02-08 23:14:22 +00001664
1665 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001666 QualType TypeOfSelfObject();
Chris Lattner41110242008-06-17 18:05:57 +00001667
Reid Spencer5f016e22007-07-11 17:01:13 +00001668 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1669 /// an aggregate LLVM type or is void.
John McCall9d232c82013-03-07 21:37:08 +00001670 static TypeEvaluationKind getEvaluationKind(QualType T);
1671
1672 static bool hasScalarEvaluationKind(QualType T) {
1673 return getEvaluationKind(T) == TEK_Scalar;
1674 }
1675
1676 static bool hasAggregateEvaluationKind(QualType T) {
1677 return getEvaluationKind(T) == TEK_Aggregate;
1678 }
Daniel Dunbar55e87422008-11-11 02:29:29 +00001679
1680 /// createBasicBlock - Create an LLVM basic block.
Richard Smith4def70d2012-10-09 19:52:38 +00001681 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
John McCalld16c2cf2011-02-08 08:22:06 +00001682 llvm::Function *parent = 0,
1683 llvm::BasicBlock *before = 0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001684#ifdef NDEBUG
John McCalld16c2cf2011-02-08 08:22:06 +00001685 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001686#else
John McCalld16c2cf2011-02-08 08:22:06 +00001687 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001688#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +00001689 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001690
Reid Spencer5f016e22007-07-11 17:01:13 +00001691 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1692 /// label maps to.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001693 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001694
Mike Stumpf71d2322009-11-30 20:08:49 +00001695 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1696 /// another basic block, simplify it. This assumes that no other code could
1697 /// potentially reference the basic block.
Daniel Dunbaraa5bd872009-04-01 04:37:47 +00001698 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1699
Mike Stump0dd9e882009-02-08 23:14:22 +00001700 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1701 /// adding a fall-through branch from the current insert block if
1702 /// necessary. It is legal to call this function even if there is no current
1703 /// insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001704 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001705 /// IsFinished - If true, indicates that the caller has finished emitting
1706 /// branches to the given block and does not expect to emit code into it. This
1707 /// means the block can be ignored if it is unreachable.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001708 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +00001709
John McCall777d6e52011-08-11 02:22:43 +00001710 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1711 /// near its uses, and leave the insertion point in it.
1712 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1713
Mike Stump0dd9e882009-02-08 23:14:22 +00001714 /// EmitBranch - Emit a branch to the specified basic block from the current
1715 /// insert block, taking care to avoid creation of branches from dummy
1716 /// blocks. It is legal to call this function even if there is no current
1717 /// insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +00001718 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001719 /// This function clears the current insertion point. The caller should follow
1720 /// calls to this function with calls to Emit*Block prior to generation new
1721 /// code.
Daniel Dunbard57a8712008-11-11 09:41:28 +00001722 void EmitBranch(llvm::BasicBlock *Block);
1723
Mike Stump0dd9e882009-02-08 23:14:22 +00001724 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1725 /// indicates that the current code being emitted is unreachable.
1726 bool HaveInsertPoint() const {
Daniel Dunbara448fb22008-11-11 23:11:34 +00001727 return Builder.GetInsertBlock() != 0;
1728 }
1729
Mike Stump0dd9e882009-02-08 23:14:22 +00001730 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1731 /// emitted IR has a place to go. Note that by definition, if this function
1732 /// creates a block then that block is unreachable; callers may do better to
1733 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001734 void EnsureInsertPoint() {
1735 if (!HaveInsertPoint())
1736 EmitBlock(createBasicBlock());
1737 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001738
Daniel Dunbar488e9932008-08-16 00:56:44 +00001739 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +00001740 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +00001741 void ErrorUnsupported(const Stmt *S, const char *Type,
1742 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +00001743
1744 //===--------------------------------------------------------------------===//
1745 // Helpers
1746 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001747
Eli Friedman6da2c712011-12-03 04:14:32 +00001748 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1749 CharUnits Alignment = CharUnits()) {
Dan Gohman3d5aff52010-10-14 23:06:10 +00001750 return LValue::MakeAddr(V, T, Alignment, getContext(),
1751 CGM.getTBAAInfo(T));
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001752 }
John McCalle0c11682012-07-02 23:58:38 +00001753
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001754 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001755 CharUnits Alignment;
1756 if (!T->isIncompleteType())
1757 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001758 return LValue::MakeAddr(V, T, Alignment, getContext(),
1759 CGM.getTBAAInfo(T));
1760 }
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001761
Reid Spencer5f016e22007-07-11 17:01:13 +00001762 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbar195337d2010-02-09 02:48:28 +00001763 /// block. The caller is responsible for setting an appropriate alignment on
1764 /// the alloca.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001765 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner8cc488f2011-07-20 07:06:53 +00001766 const Twine &Name = "tmp");
Mike Stump0dd9e882009-02-08 23:14:22 +00001767
John McCallac418162010-04-22 01:10:34 +00001768 /// InitTempAlloca - Provide an initial value for the given alloca.
1769 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1770
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001771 /// CreateIRTemp - Create a temporary IR object of the given type, with
1772 /// appropriate alignment. This routine should only be used when an temporary
1773 /// value needs to be stored into an alloca (for example, to avoid explicit
1774 /// PHI construction), but the type is the IR type, not the type appropriate
1775 /// for storing in memory.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001776 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001777
Daniel Dunbar195337d2010-02-09 02:48:28 +00001778 /// CreateMemTemp - Create a temporary memory object of the given type, with
1779 /// appropriate alignment.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001780 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar195337d2010-02-09 02:48:28 +00001781
John McCall558d2ab2010-09-15 10:14:12 +00001782 /// CreateAggTemp - Create a temporary memory object for the given
1783 /// aggregate type.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001784 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedmand7722d92011-12-03 02:13:40 +00001785 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanf3940782011-12-03 00:54:26 +00001786 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1787 T.getQualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +00001788 AggValueSlot::IsNotDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001789 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00001790 AggValueSlot::IsNotAliased);
John McCall558d2ab2010-09-15 10:14:12 +00001791 }
1792
John McCalld16c2cf2011-02-08 08:22:06 +00001793 /// Emit a cast to void* in the appropriate address space.
1794 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1795
Reid Spencer5f016e22007-07-11 17:01:13 +00001796 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1797 /// expression and compare the result against zero, returning an Int1Ty value.
1798 llvm::Value *EvaluateExprAsBool(const Expr *E);
1799
John McCall2a416372010-12-05 02:00:02 +00001800 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1801 void EmitIgnoredExpr(const Expr *E);
1802
Chris Lattner9b655512007-08-31 22:49:20 +00001803 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1804 /// any type. The result is returned as an RValue struct. If this is an
1805 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1806 /// the result should be returned.
Mike Stump49d1cd52009-05-26 22:03:21 +00001807 ///
Dmitri Gribenko70517ca2012-08-23 17:58:28 +00001808 /// \param ignoreResult True if the resulting value isn't used.
John McCall558d2ab2010-09-15 10:14:12 +00001809 RValue EmitAnyExpr(const Expr *E,
John McCalle0c11682012-07-02 23:58:38 +00001810 AggValueSlot aggSlot = AggValueSlot::ignored(),
1811 bool ignoreResult = false);
Devang Pateld9363c32007-09-28 21:49:18 +00001812
Mike Stump0dd9e882009-02-08 23:14:22 +00001813 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1814 // or the value of the expression, depending on how va_list is defined.
Eli Friedman4fd0aa52009-01-20 17:46:04 +00001815 llvm::Value *EmitVAListRef(const Expr *E);
1816
Mike Stump0dd9e882009-02-08 23:14:22 +00001817 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1818 /// always be accessible even if no aggregate location is provided.
John McCall558d2ab2010-09-15 10:14:12 +00001819 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar46f45b92008-09-09 01:06:48 +00001820
John McCall60d33652011-03-08 09:11:50 +00001821 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier649b4a12012-03-29 17:37:10 +00001822 /// arbitrary expression into the given memory location.
John McCall3d3ec1c2010-04-21 10:05:39 +00001823 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier649b4a12012-03-29 17:37:10 +00001824 Qualifiers Quals, bool IsInitializer);
John McCall3d3ec1c2010-04-21 10:05:39 +00001825
John McCall60d33652011-03-08 09:11:50 +00001826 /// EmitExprAsInit - Emits the code necessary to initialize a
1827 /// location in memory with the given initializer.
John McCallf85e1932011-06-15 23:02:42 +00001828 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001829 LValue lvalue, bool capturedByInit);
John McCall60d33652011-03-08 09:11:50 +00001830
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001831 /// hasVolatileMember - returns true if aggregate type has a volatile
1832 /// member.
1833 bool hasVolatileMember(QualType T) {
1834 if (const RecordType *RT = T->getAs<RecordType>()) {
1835 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1836 return RD->hasVolatileMember();
1837 }
1838 return false;
1839 }
Arnaud A. de Grandmaison8fcbb8d2013-02-05 09:06:17 +00001840 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001841 ///
1842 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1843 /// This is required for correctness when assigning non-POD structures in C++.
1844 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001845 QualType EltTy) {
1846 bool IsVolatile = hasVolatileMember(EltTy);
1847 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1848 true);
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001849 }
1850
Arnaud A. de Grandmaison8fcbb8d2013-02-05 09:06:17 +00001851 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump27fe2e62009-05-23 22:29:41 +00001852 ///
Sylvestre Ledruf3477c12012-09-27 10:16:10 +00001853 /// \param isVolatile - True iff either the source or the destination is
Mike Stump27fe2e62009-05-23 22:29:41 +00001854 /// volatile.
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001855 /// \param isAssignment - If false, allow padding to be copied. This often
1856 /// yields more efficient.
Daniel Dunbar7482d122008-09-09 20:49:46 +00001857 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedmanbd7d8282011-12-05 22:23:28 +00001858 QualType EltTy, bool isVolatile=false,
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001859 CharUnits Alignment = CharUnits::Zero(),
1860 bool isAssignment = false);
Daniel Dunbar7482d122008-09-09 20:49:46 +00001861
Devang Patel51b09f22007-10-04 23:45:31 +00001862 /// StartBlock - Start new block named N. If insert block is a dummy block
1863 /// then reuse it.
1864 void StartBlock(const char *N);
1865
Anders Carlssondde0a942008-09-11 09:15:33 +00001866 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall4c40d982010-08-31 07:33:07 +00001867 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1868 llvm::Value *Res = LocalDeclMap[VD];
1869 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1870 return Res;
1871 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001872
John McCall56ca35d2011-02-17 10:25:35 +00001873 /// getOpaqueLValueMapping - Given an opaque value expression (which
1874 /// must be mapped to an l-value), return its mapping.
1875 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1876 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1877
1878 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1879 it = OpaqueLValues.find(e);
1880 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1881 return it->second;
1882 }
1883
1884 /// getOpaqueRValueMapping - Given an opaque value expression (which
1885 /// must be mapped to an r-value), return its mapping.
1886 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1887 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1888
1889 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1890 it = OpaqueRValues.find(e);
1891 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCalle996ffd2011-02-16 08:02:54 +00001892 return it->second;
1893 }
1894
Dan Gohman4f8d1232008-05-22 00:50:06 +00001895 /// getAccessedFieldNo - Given an encoded value and a result number, return
1896 /// the input field number being accessed.
1897 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1898
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001899 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner3d00fdc2009-10-13 06:55:33 +00001900 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001901
Anders Carlsson1884eb02010-05-22 17:35:42 +00001902 /// EmitNullInitialization - Generate code to set a value of the given type to
1903 /// null, If the type contains data member pointers, they will be initialized
1904 /// to -1 in accordance with the Itanium C++ ABI.
1905 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001906
1907 // EmitVAArg - Generate code to get an argument from the passed in pointer
1908 // and update it accordingly. The return value is a pointer to the argument.
1909 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stump0dd9e882009-02-08 23:14:22 +00001910 // instruction in LLVM instead once it works well enough.
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001911 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +00001912
John McCallbdc4d802011-07-09 01:37:26 +00001913 /// emitArrayLength - Compute the length of an array, even if it's a
1914 /// VLA, and drill down to the base element type.
1915 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1916 QualType &baseType,
1917 llvm::Value *&addr);
1918
John McCallbc8d40d2011-06-24 21:55:10 +00001919 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1920 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbard286f052009-07-19 06:58:07 +00001921 ///
1922 /// This function can be called with a null (unreachable) insert point.
John McCallbc8d40d2011-06-24 21:55:10 +00001923 void EmitVariablyModifiedType(QualType Ty);
Mike Stump0dd9e882009-02-08 23:14:22 +00001924
John McCallbc8d40d2011-06-24 21:55:10 +00001925 /// getVLASize - Returns an LLVM value that corresponds to the size,
1926 /// in non-variably-sized elements, of a variable length array type,
1927 /// plus that largest non-variably-sized element type. Assumes that
1928 /// the type has already been emitted with EmitVariablyModifiedType.
1929 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1930 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssondcc90d82008-12-12 07:19:02 +00001931
Anders Carlsson5f4307b2009-04-14 16:58:56 +00001932 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1933 /// generating code for an C++ member function.
John McCall25049412010-02-16 22:04:33 +00001934 llvm::Value *LoadCXXThis() {
1935 assert(CXXThisValue && "no 'this' value for this function");
1936 return CXXThisValue;
1937 }
Mike Stump1eb44332009-09-09 15:08:12 +00001938
Anders Carlssonc997d422010-01-02 01:01:18 +00001939 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1940 /// virtual bases.
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001941 // FIXME: Every place that calls LoadCXXVTT is something
1942 // that needs to be abstracted properly.
John McCall25049412010-02-16 22:04:33 +00001943 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001944 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1945 return CXXStructorImplicitParamValue;
1946 }
1947
1948 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1949 /// for a constructor/destructor.
1950 llvm::Value *LoadCXXStructorImplicitParam() {
1951 assert(CXXStructorImplicitParamValue &&
1952 "no implicit argument value for this function");
1953 return CXXStructorImplicitParamValue;
John McCall25049412010-02-16 22:04:33 +00001954 }
John McCallbff225e2010-02-16 04:15:37 +00001955
1956 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlsson8561a862010-04-24 23:01:49 +00001957 /// complete class to the given direct base.
1958 llvm::Value *
1959 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1960 const CXXRecordDecl *Derived,
1961 const CXXRecordDecl *Base,
1962 bool BaseIsVirtual);
Anders Carlssona88ad562010-04-24 21:51:08 +00001963
Mike Stumpf71d2322009-11-30 20:08:49 +00001964 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1965 /// load of 'this' and returns address of the base class.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001966 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001967 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001968 CastExpr::path_const_iterator PathBegin,
1969 CastExpr::path_const_iterator PathEnd,
Anders Carlsson34a2d382010-04-24 21:06:20 +00001970 bool NullCheckValue);
1971
Anders Carlssona3697c92009-11-23 17:57:54 +00001972 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001973 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001974 CastExpr::path_const_iterator PathBegin,
1975 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +00001976 bool NullCheckValue);
1977
Anders Carlssonbb7e17b2010-01-31 01:36:53 +00001978 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1979 const CXXRecordDecl *ClassDecl,
1980 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001981
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001982 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1983 /// base constructor/destructor with virtual bases.
1984 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1985 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1986 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1987 bool Delegating);
1988
John McCallc0bf4622010-02-23 00:48:20 +00001989 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1990 CXXCtorType CtorType,
1991 const FunctionArgList &Args);
Sean Hunt059ce0d2011-05-01 07:04:31 +00001992 // It's important not to confuse this and the previous function. Delegating
1993 // constructors are the C++0x feature. The constructor delegate optimization
1994 // is used to reduce duplication in the base and complete consturctors where
1995 // they are substantially the same.
1996 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1997 const FunctionArgList &Args);
Anders Carlsson155ed4a2010-05-02 23:20:53 +00001998 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00001999 bool ForVirtualBase, bool Delegating,
2000 llvm::Value *This,
Anders Carlssonb14095a2009-04-17 00:06:03 +00002001 CallExpr::const_arg_iterator ArgBeg,
2002 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002003
2004 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
2005 llvm::Value *This, llvm::Value *Src,
2006 CallExpr::const_arg_iterator ArgBeg,
2007 CallExpr::const_arg_iterator ArgEnd);
Mike Stump1eb44332009-09-09 15:08:12 +00002008
Fariborz Jahanian288dcaf2009-08-19 20:55:16 +00002009 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlsson569c1f42009-09-23 02:45:36 +00002010 const ConstantArrayType *ArrayTy,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00002011 llvm::Value *ArrayPtr,
2012 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00002013 CallExpr::const_arg_iterator ArgEnd,
2014 bool ZeroInitialization = false);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002015
Anders Carlsson569c1f42009-09-23 02:45:36 +00002016 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
2017 llvm::Value *NumElements,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00002018 llvm::Value *ArrayPtr,
2019 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00002020 CallExpr::const_arg_iterator ArgEnd,
2021 bool ZeroInitialization = false);
Anders Carlssonb14095a2009-04-17 00:06:03 +00002022
John McCallbdc4d802011-07-09 01:37:26 +00002023 static Destroyer destroyCXXObject;
2024
Anders Carlsson7267c162009-05-29 21:03:38 +00002025 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00002026 bool ForVirtualBase, bool Delegating,
2027 llvm::Value *This);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002028
John McCall19705672011-09-15 06:49:18 +00002029 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
2030 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump1eb44332009-09-09 15:08:12 +00002031
Peter Collingbourne86811602011-11-27 22:09:22 +00002032 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
2033 llvm::Value *Ptr);
Mike Stump1eb44332009-09-09 15:08:12 +00002034
Anders Carlssona00703d2009-05-31 01:40:14 +00002035 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson60e282c2009-08-16 21:13:42 +00002036 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump1eb44332009-09-09 15:08:12 +00002037
Eli Friedman4bf81522009-11-18 00:57:03 +00002038 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
2039 QualType DeleteTy);
2040
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002041 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stumpc849c052009-11-16 06:50:58 +00002042 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Weberc5f80462012-10-11 10:13:44 +00002043 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002044
Sebastian Redl972edf02012-02-19 16:03:09 +00002045 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
Sebastian Redlaf130fd2012-02-19 12:28:02 +00002046 void EmitStdInitializerListCleanup(llvm::Value *loc,
2047 const InitListExpr *init);
Sebastian Redl32cf1f22012-02-17 08:42:25 +00002048
Richard Smith2c9f87c2012-08-24 00:54:33 +00002049 /// \brief Situations in which we might emit a check for the suitability of a
2050 /// pointer or glvalue.
Richard Smith7ac9ef12012-09-08 02:08:36 +00002051 enum TypeCheckKind {
Richard Smith2c9f87c2012-08-24 00:54:33 +00002052 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00002053 TCK_Load,
Richard Smith2c9f87c2012-08-24 00:54:33 +00002054 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00002055 TCK_Store,
Richard Smith2c9f87c2012-08-24 00:54:33 +00002056 /// Checking the bound value in a reference binding. Must be suitably sized
2057 /// and aligned, but is not required to refer to an object (until the
2058 /// reference is used), per core issue 453.
Richard Smith7ac9ef12012-09-08 02:08:36 +00002059 TCK_ReferenceBinding,
Richard Smith2c9f87c2012-08-24 00:54:33 +00002060 /// Checking the object expression in a non-static data member access. Must
2061 /// be an object within its lifetime.
Richard Smith7ac9ef12012-09-08 02:08:36 +00002062 TCK_MemberAccess,
Richard Smith2c9f87c2012-08-24 00:54:33 +00002063 /// Checking the 'this' pointer for a call to a non-static member function.
2064 /// Must be an object within its lifetime.
Richard Smith8e1cee62012-10-25 02:14:12 +00002065 TCK_MemberCall,
2066 /// Checking the 'this' pointer for a constructor call.
Richard Smithc7648302013-02-13 21:18:23 +00002067 TCK_ConstructorCall,
2068 /// Checking the operand of a static_cast to a derived pointer type. Must be
2069 /// null or an object within its lifetime.
2070 TCK_DowncastPointer,
2071 /// Checking the operand of a static_cast to a derived reference type. Must
2072 /// be an object within its lifetime.
2073 TCK_DowncastReference
Richard Smith2c9f87c2012-08-24 00:54:33 +00002074 };
2075
Richard Smith7ac9ef12012-09-08 02:08:36 +00002076 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith2c9f87c2012-08-24 00:54:33 +00002077 /// appropriate size and alignment for an object of type \p Type.
Richard Smith4def70d2012-10-09 19:52:38 +00002078 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Richard Smith7ac9ef12012-09-08 02:08:36 +00002079 QualType Type, CharUnits Alignment = CharUnits::Zero());
Mike Stumpb14e62d2009-12-16 02:57:00 +00002080
Richard Smitha0a628f2013-02-23 02:53:19 +00002081 /// \brief Emit a check that \p Base points into an array object, which
2082 /// we can access at index \p Index. \p Accessed should be \c false if we
2083 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
2084 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
2085 QualType IndexType, bool Accessed);
2086
Chris Lattnerdd36d322010-01-09 21:40:03 +00002087 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
2088 bool isInc, bool isPre);
2089 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
2090 bool isInc, bool isPre);
Reid Spencer5f016e22007-07-11 17:01:13 +00002091 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +00002092 // Declaration Emission
2093 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002094
Daniel Dunbard286f052009-07-19 06:58:07 +00002095 /// EmitDecl - Emit a declaration.
2096 ///
2097 /// This function can be called with a null (unreachable) insert point.
Reid Spencer5f016e22007-07-11 17:01:13 +00002098 void EmitDecl(const Decl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00002099
John McCallb6bbcc92010-10-15 04:57:14 +00002100 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00002101 ///
2102 /// This function can be called with a null (unreachable) insert point.
John McCallb6bbcc92010-10-15 04:57:14 +00002103 void EmitVarDecl(const VarDecl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00002104
John McCallf85e1932011-06-15 23:02:42 +00002105 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00002106 LValue lvalue, bool capturedByInit);
John McCall7acddac2011-06-17 06:42:21 +00002107 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCallf85e1932011-06-15 23:02:42 +00002108
John McCallf1549f62010-07-06 01:34:17 +00002109 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
2110 llvm::Value *Address);
2111
John McCallb6bbcc92010-10-15 04:57:14 +00002112 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00002113 ///
2114 /// This function can be called with a null (unreachable) insert point.
John McCall34695852011-02-22 06:44:22 +00002115 void EmitAutoVarDecl(const VarDecl &D);
2116
2117 class AutoVarEmission {
2118 friend class CodeGenFunction;
2119
John McCall57b3b6a2011-02-22 07:16:58 +00002120 const VarDecl *Variable;
John McCall34695852011-02-22 06:44:22 +00002121
2122 /// The alignment of the variable.
2123 CharUnits Alignment;
2124
2125 /// The address of the alloca. Null if the variable was emitted
2126 /// as a global constant.
2127 llvm::Value *Address;
2128
2129 llvm::Value *NRVOFlag;
2130
2131 /// True if the variable is a __block variable.
2132 bool IsByRef;
2133
2134 /// True if the variable is of aggregate type and has a constant
2135 /// initializer.
2136 bool IsConstantAggregate;
2137
Nadav Rotem495cfa42013-03-23 06:43:35 +00002138 /// Non-null if we should use lifetime annotations.
2139 llvm::Value *SizeForLifetimeMarkers;
2140
John McCall57b3b6a2011-02-22 07:16:58 +00002141 struct Invalid {};
2142 AutoVarEmission(Invalid) : Variable(0) {}
2143
John McCall34695852011-02-22 06:44:22 +00002144 AutoVarEmission(const VarDecl &variable)
John McCall57b3b6a2011-02-22 07:16:58 +00002145 : Variable(&variable), Address(0), NRVOFlag(0),
Nadav Rotem495cfa42013-03-23 06:43:35 +00002146 IsByRef(false), IsConstantAggregate(false),
2147 SizeForLifetimeMarkers(0) {}
John McCall34695852011-02-22 06:44:22 +00002148
2149 bool wasEmittedAsGlobal() const { return Address == 0; }
2150
2151 public:
John McCall57b3b6a2011-02-22 07:16:58 +00002152 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2153
Nadav Rotem495cfa42013-03-23 06:43:35 +00002154 bool useLifetimeMarkers() const { return SizeForLifetimeMarkers != 0; }
2155 llvm::Value *getSizeForLifetimeMarkers() const {
2156 assert(useLifetimeMarkers());
2157 return SizeForLifetimeMarkers;
2158 }
2159
2160 /// Returns the raw, allocated address, which is not necessarily
2161 /// the address of the object itself.
2162 llvm::Value *getAllocatedAddress() const {
2163 return Address;
2164 }
2165
John McCall34695852011-02-22 06:44:22 +00002166 /// Returns the address of the object within this declaration.
2167 /// Note that this does not chase the forwarding pointer for
2168 /// __block decls.
2169 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
2170 if (!IsByRef) return Address;
2171
2172 return CGF.Builder.CreateStructGEP(Address,
John McCall57b3b6a2011-02-22 07:16:58 +00002173 CGF.getByRefValueLLVMField(Variable),
2174 Variable->getNameAsString());
John McCall34695852011-02-22 06:44:22 +00002175 }
2176 };
2177 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2178 void EmitAutoVarInit(const AutoVarEmission &emission);
2179 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCallbdc4d802011-07-09 01:37:26 +00002180 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2181 QualType::DestructionKind dtorKind);
Daniel Dunbard286f052009-07-19 06:58:07 +00002182
John McCallb6bbcc92010-10-15 04:57:14 +00002183 void EmitStaticVarDecl(const VarDecl &D,
2184 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00002185
2186 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel093ac462011-03-03 20:13:15 +00002187 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stump0dd9e882009-02-08 23:14:22 +00002188
John McCall56ca35d2011-02-17 10:25:35 +00002189 /// protectFromPeepholes - Protect a value that we're intending to
2190 /// store to the side, but which will probably be used later, from
2191 /// aggressive peepholing optimizations that might delete it.
2192 ///
2193 /// Pass the result to unprotectFromPeepholes to declare that
2194 /// protection is no longer required.
2195 ///
2196 /// There's no particular reason why this shouldn't apply to
2197 /// l-values, it's just that no existing peepholes work on pointers.
2198 PeepholeProtection protectFromPeepholes(RValue rvalue);
2199 void unprotectFromPeepholes(PeepholeProtection protection);
2200
Reid Spencer5f016e22007-07-11 17:01:13 +00002201 //===--------------------------------------------------------------------===//
2202 // Statement Emission
2203 //===--------------------------------------------------------------------===//
2204
Mike Stump0dd9e882009-02-08 23:14:22 +00002205 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar09124252008-11-12 08:21:33 +00002206 void EmitStopPoint(const Stmt *S);
2207
Mike Stump0dd9e882009-02-08 23:14:22 +00002208 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2209 /// this function even if there is no current insertion point.
2210 ///
2211 /// This function may clear the current insertion point; callers should use
2212 /// EnsureInsertPoint if they wish to subsequently generate code without first
2213 /// calling EmitBlock, EmitBranch, or EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +00002214 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +00002215
Daniel Dunbar09124252008-11-12 08:21:33 +00002216 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stump0dd9e882009-02-08 23:14:22 +00002217 /// necessarily require an insertion point or debug information; typically
2218 /// because the statement amounts to a jump or a container of other
2219 /// statements.
Daniel Dunbar09124252008-11-12 08:21:33 +00002220 ///
2221 /// \return True if the statement was handled.
2222 bool EmitSimpleStmt(const Stmt *S);
2223
Chris Lattner9b655512007-08-31 22:49:20 +00002224 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall558d2ab2010-09-15 10:14:12 +00002225 AggValueSlot AVS = AggValueSlot::ignored());
David Blaikiea6504852013-01-26 22:16:26 +00002226 RValue EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2227 bool GetLast = false, AggValueSlot AVS =
2228 AggValueSlot::ignored());
Daniel Dunbara448fb22008-11-11 23:11:34 +00002229
Mike Stump0dd9e882009-02-08 23:14:22 +00002230 /// EmitLabel - Emit the block for the given label. It is legal to call this
2231 /// function even if there is no current insertion point.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00002232 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +00002233
Reid Spencer5f016e22007-07-11 17:01:13 +00002234 void EmitLabelStmt(const LabelStmt &S);
Richard Smith534986f2012-04-14 00:33:13 +00002235 void EmitAttributedStmt(const AttributedStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00002236 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002237 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00002238 void EmitIfStmt(const IfStmt &S);
2239 void EmitWhileStmt(const WhileStmt &S);
2240 void EmitDoStmt(const DoStmt &S);
2241 void EmitForStmt(const ForStmt &S);
2242 void EmitReturnStmt(const ReturnStmt &S);
2243 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +00002244 void EmitBreakStmt(const BreakStmt &S);
2245 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +00002246 void EmitSwitchStmt(const SwitchStmt &S);
2247 void EmitDefaultStmt(const DefaultStmt &S);
2248 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +00002249 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosiera23b91d2012-08-28 18:54:39 +00002250 void EmitAsmStmt(const AsmStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00002251
Anders Carlsson3d8400d2008-08-30 19:51:14 +00002252 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00002253 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2254 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00002255 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCallf85e1932011-06-15 23:02:42 +00002256 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00002257
John McCall93c332a2011-05-28 21:13:02 +00002258 llvm::Constant *getUnwindResumeFn();
Douglas Gregor86a3a032010-05-16 01:24:12 +00002259 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCall59a70002010-07-07 06:56:46 +00002260 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2261 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCall9fc6a772010-02-19 09:25:03 +00002262
Anders Carlsson6815e942009-09-27 18:58:34 +00002263 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smithad762fc2011-04-14 22:09:26 +00002264 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002265
Ben Langmuir524387a2013-05-09 19:17:11 +00002266 llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
2267 llvm::Function *GenerateCapturedStmtFunction(const CapturedDecl *CD,
2268 const RecordDecl *RD);
2269
Reid Spencer5f016e22007-07-11 17:01:13 +00002270 //===--------------------------------------------------------------------===//
2271 // LValue Expression Emission
2272 //===--------------------------------------------------------------------===//
2273
Daniel Dunbar13e81732009-02-05 07:09:07 +00002274 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2275 RValue GetUndefRValue(QualType Ty);
2276
Daniel Dunbarce1d38b2009-01-09 16:50:52 +00002277 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2278 /// and issue an ErrorUnsupported style diagnostic (using the
2279 /// provided Name).
2280 RValue EmitUnsupportedRValue(const Expr *E,
2281 const char *Name);
2282
Mike Stump0dd9e882009-02-08 23:14:22 +00002283 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2284 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbar6ba82a42008-08-25 20:45:57 +00002285 LValue EmitUnsupportedLValue(const Expr *E,
2286 const char *Name);
2287
Reid Spencer5f016e22007-07-11 17:01:13 +00002288 /// EmitLValue - Emit code to compute a designator that specifies the location
2289 /// of the expression.
2290 ///
2291 /// This can return one of two things: a simple address or a bitfield
2292 /// reference. In either case, the LLVM Value* in the LValue structure is
2293 /// guaranteed to be an LLVM pointer type.
2294 ///
2295 /// If this returns a bitfield reference, nothing about the pointee type of
2296 /// the LLVM value is known: For example, it may not be a pointer to an
2297 /// integer.
2298 ///
2299 /// If this returns a normal address, and if the lvalue's C type is fixed
2300 /// size, this method guarantees that the returned pointer type will point to
2301 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2302 /// variable length type, this is not possible.
2303 ///
2304 LValue EmitLValue(const Expr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002305
Richard Smith7ac9ef12012-09-08 02:08:36 +00002306 /// \brief Same as EmitLValue but additionally we generate checking code to
2307 /// guard against undefined behavior. This is only suitable when we know
2308 /// that the address will be used to access the object.
2309 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stumpb14e62d2009-12-16 02:57:00 +00002310
John McCall9d232c82013-03-07 21:37:08 +00002311 RValue convertTempToRValue(llvm::Value *addr, QualType type);
2312
John McCall9eda3ab2013-03-07 21:37:17 +00002313 void EmitAtomicInit(Expr *E, LValue lvalue);
2314
2315 RValue EmitAtomicLoad(LValue lvalue,
2316 AggValueSlot slot = AggValueSlot::ignored());
2317
2318 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2319
John McCall26815d92010-10-27 20:58:56 +00002320 /// EmitToMemory - Change a scalar value from its value
2321 /// representation to its in-memory representation.
2322 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2323
2324 /// EmitFromMemory - Change a scalar value from its memory
2325 /// representation to its value representation.
2326 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2327
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002328 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2329 /// care to appropriately convert from the memory representation to
2330 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002331 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002332 unsigned Alignment, QualType Ty,
Manman Renb37a73d2013-04-04 21:53:22 +00002333 llvm::MDNode *TBAAInfo = 0,
2334 QualType TBAABaseTy = QualType(),
2335 uint64_t TBAAOffset = 0);
John McCall545d9962011-06-25 02:11:03 +00002336
2337 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2338 /// care to appropriately convert from the memory representation to
2339 /// the LLVM value representation. The l-value must be a simple
2340 /// l-value.
John McCalla07398e2011-06-16 04:16:24 +00002341 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002342
2343 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2344 /// care to appropriately convert from the memory representation to
2345 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002346 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002347 bool Volatile, unsigned Alignment, QualType Ty,
Manman Renb37a73d2013-04-04 21:53:22 +00002348 llvm::MDNode *TBAAInfo = 0, bool isInit = false,
2349 QualType TBAABaseTy = QualType(),
2350 uint64_t TBAAOffset = 0);
John McCall545d9962011-06-25 02:11:03 +00002351
2352 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2353 /// care to appropriately convert from the memory representation to
2354 /// the LLVM value representation. The l-value must be a simple
David Chisnall7a7ee302012-01-16 17:27:18 +00002355 /// l-value. The isInit flag indicates whether this is an initialization.
2356 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2357 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002358
Reid Spencer5f016e22007-07-11 17:01:13 +00002359 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2360 /// this method emits the address of the lvalue, then loads the result as an
2361 /// rvalue, returning the rvalue.
John McCall545d9962011-06-25 02:11:03 +00002362 RValue EmitLoadOfLValue(LValue V);
2363 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2364 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stump0dd9e882009-02-08 23:14:22 +00002365
Reid Spencer5f016e22007-07-11 17:01:13 +00002366 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2367 /// lvalue, where both are guaranteed to the have the same type, and that type
2368 /// is 'Ty'.
David Chisnall7a7ee302012-01-16 17:27:18 +00002369 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00002370 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbared3849b2008-11-19 09:36:46 +00002371
Mike Stump0dd9e882009-02-08 23:14:22 +00002372 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2373 /// EmitStoreThroughLValue.
Daniel Dunbared3849b2008-11-19 09:36:46 +00002374 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00002375 /// \param Result [out] - If non-null, this will be set to a Value* for the
2376 /// bit-field contents after the store, appropriate for use as the result of
2377 /// an assignment to the bit-field.
John McCall545d9962011-06-25 02:11:03 +00002378 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbared3849b2008-11-19 09:36:46 +00002379 llvm::Value **Result=0);
Mike Stump0dd9e882009-02-08 23:14:22 +00002380
John McCall83ce9d42010-11-16 23:07:28 +00002381 /// Emit an l-value for an assignment (simple or compound) of complex type.
2382 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002383 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall83ce9d42010-11-16 23:07:28 +00002384
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00002385 // Note: only available for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +00002386 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002387 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002388 // Note: only available for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +00002389 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002390 // Note: only available for agg return types
2391 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002392 LValue EmitDeclRefLValue(const DeclRefExpr *E);
2393 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnereaf2bb82009-02-24 22:18:39 +00002394 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattnerd9f69102008-08-10 01:53:14 +00002395 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002396 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smitha0a628f2013-02-23 02:53:19 +00002397 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2398 bool Accessed = false);
Nate Begeman213541a2008-04-18 23:10:10 +00002399 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +00002400 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian820bca42009-12-09 23:35:29 +00002401 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +00002402 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smith13ec9102012-05-14 21:57:21 +00002403 LValue EmitInitListLValue(const InitListExpr *E);
John McCall56ca35d2011-02-17 10:25:35 +00002404 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner75dfeda2009-03-18 18:28:57 +00002405 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregored8abf12010-07-08 06:14:04 +00002406 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregor03e80032011-06-21 17:03:29 +00002407 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCalle996ffd2011-02-16 08:02:54 +00002408 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002409
Eli Friedman377ecc72012-04-16 03:54:45 +00002410 RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
Anton Korobeynikoveaf856d2012-04-13 11:22:00 +00002411
John McCalldd2ecee2012-03-10 03:05:10 +00002412 class ConstantEmission {
2413 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2414 ConstantEmission(llvm::Constant *C, bool isReference)
2415 : ValueAndIsReference(C, isReference) {}
2416 public:
2417 ConstantEmission() {}
2418 static ConstantEmission forReference(llvm::Constant *C) {
2419 return ConstantEmission(C, true);
2420 }
2421 static ConstantEmission forValue(llvm::Constant *C) {
2422 return ConstantEmission(C, false);
2423 }
2424
David Blaikie7247c882013-05-15 07:37:26 +00002425 LLVM_EXPLICIT operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
John McCalldd2ecee2012-03-10 03:05:10 +00002426
2427 bool isReference() const { return ValueAndIsReference.getInt(); }
2428 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2429 assert(isReference());
2430 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2431 refExpr->getType());
2432 }
2433
2434 llvm::Constant *getValue() const {
2435 assert(!isReference());
2436 return ValueAndIsReference.getPointer();
2437 }
2438 };
2439
John McCallf4b88a42012-03-10 09:33:50 +00002440 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCalldd2ecee2012-03-10 03:05:10 +00002441
John McCall4b9c2d22011-11-06 09:01:30 +00002442 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2443 AggValueSlot slot = AggValueSlot::ignored());
2444 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2445
Daniel Dunbar2a031922009-04-22 05:08:15 +00002446 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002447 const ObjCIvarDecl *Ivar);
Eli Friedman377ecc72012-04-16 03:54:45 +00002448 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
John McCallf5ebf9b2013-05-03 07:33:41 +00002449 LValue EmitLValueForLambdaField(const FieldDecl *Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002450
Anders Carlsson06a29702010-01-29 05:24:29 +00002451 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2452 /// if the Field is a reference, this will return the address of the reference
2453 /// and not the address of the value stored in the reference.
Eli Friedman377ecc72012-04-16 03:54:45 +00002454 LValue EmitLValueForFieldInitialization(LValue Base,
2455 const FieldDecl* Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002456
Fariborz Jahanian45012a72009-02-03 00:09:52 +00002457 LValue EmitLValueForIvar(QualType ObjectTy,
2458 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002459 unsigned CVRQualifiers);
2460
Anders Carlssonb58d0172009-05-30 23:23:33 +00002461 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssone61c9e82009-05-30 23:30:54 +00002462 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman31a37022012-02-08 05:34:55 +00002463 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002464 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Weberc5f80462012-10-11 10:13:44 +00002465 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002466
Daniel Dunbar0a04d772008-08-23 10:51:21 +00002467 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +00002468 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattner65459942009-04-25 19:35:26 +00002469 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanian8bfd31f2009-10-22 22:57:31 +00002470 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian03b29602010-06-17 19:56:20 +00002471 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCall189d6ef2010-10-09 01:34:31 +00002472 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCall56ca35d2011-02-17 10:25:35 +00002473
Reid Spencer5f016e22007-07-11 17:01:13 +00002474 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +00002475 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +00002476 //===--------------------------------------------------------------------===//
2477
Mike Stump0dd9e882009-02-08 23:14:22 +00002478 /// EmitCall - Generate a call of the given function, expecting the given
2479 /// result type, and using the given argument list which specifies both the
2480 /// LLVM arguments and the types they were derived from.
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002481 ///
Mike Stumpf71d2322009-11-30 20:08:49 +00002482 /// \param TargetDecl - If given, the decl of the function in a direct call;
2483 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbar88b53962009-02-02 22:03:45 +00002484 RValue EmitCall(const CGFunctionInfo &FnInfo,
2485 llvm::Value *Callee,
Anders Carlssonf3c47c92009-12-24 19:25:24 +00002486 ReturnValueSlot ReturnValue,
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002487 const CallArgList &Args,
David Chisnalldd5c98f2010-05-01 11:15:56 +00002488 const Decl *TargetDecl = 0,
David Chisnall4b02afc2010-05-02 13:41:58 +00002489 llvm::Instruction **callOrInvoke = 0);
Mike Stump1eb44332009-09-09 15:08:12 +00002490
Anders Carlsson31777a22009-12-24 19:08:58 +00002491 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlssond2490a92009-12-24 20:40:36 +00002492 ReturnValueSlot ReturnValue,
Anders Carlsson98647712009-05-27 01:22:39 +00002493 CallExpr::const_arg_iterator ArgBeg,
2494 CallExpr::const_arg_iterator ArgEnd,
2495 const Decl *TargetDecl = 0);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002496 RValue EmitCallExpr(const CallExpr *E,
Anders Carlssond2490a92009-12-24 20:40:36 +00002497 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump1eb44332009-09-09 15:08:12 +00002498
John McCallbd7370a2013-02-28 19:01:20 +00002499 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2500 const Twine &name = "");
2501 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2502 ArrayRef<llvm::Value*> args,
2503 const Twine &name = "");
2504 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2505 const Twine &name = "");
2506 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2507 ArrayRef<llvm::Value*> args,
2508 const Twine &name = "");
2509
John McCallf1549f62010-07-06 01:34:17 +00002510 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner2d3ba4f2011-07-23 17:14:25 +00002511 ArrayRef<llvm::Value *> Args,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002512 const Twine &Name = "");
Jay Foad4c7d9f12011-07-15 08:37:34 +00002513 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002514 const Twine &Name = "");
John McCallbd7370a2013-02-28 19:01:20 +00002515 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2516 ArrayRef<llvm::Value*> args,
2517 const Twine &name = "");
2518 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2519 const Twine &name = "");
2520 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2521 ArrayRef<llvm::Value*> args);
John McCallf1549f62010-07-06 01:34:17 +00002522
Anders Carlsson566abee2009-11-13 04:45:41 +00002523 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002524 llvm::Type *Ty);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002525 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002526 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian27262672011-01-20 17:19:02 +00002527 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2528 NestedNameSpecifier *Qual,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002529 llvm::Type *Ty);
Fariborz Jahanianccd52592011-02-01 23:22:34 +00002530
2531 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2532 CXXDtorType Type,
Fariborz Jahanian771c6782011-02-03 19:27:17 +00002533 const CXXRecordDecl *RD);
Anders Carlsson566abee2009-11-13 04:45:41 +00002534
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002535 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
Richard Smith4def70d2012-10-09 19:52:38 +00002536 SourceLocation CallLoc,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002537 llvm::Value *Callee,
Anders Carlssona1736c02009-12-24 21:13:40 +00002538 ReturnValueSlot ReturnValue,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002539 llvm::Value *This,
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00002540 llvm::Value *ImplicitParam,
2541 QualType ImplicitParamTy,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002542 CallExpr::const_arg_iterator ArgBeg,
2543 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssona1736c02009-12-24 21:13:40 +00002544 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2545 ReturnValueSlot ReturnValue);
2546 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2547 ReturnValueSlot ReturnValue);
Ted Kremenek55499762008-06-17 02:43:46 +00002548
Anders Carlssona2447e02011-05-08 20:32:23 +00002549 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2550 const CXXMethodDecl *MD,
2551 llvm::Value *This);
Anders Carlsson0f294632009-05-27 04:18:27 +00002552 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssona1736c02009-12-24 21:13:40 +00002553 const CXXMethodDecl *MD,
2554 ReturnValueSlot ReturnValue);
Mike Stump1eb44332009-09-09 15:08:12 +00002555
Peter Collingbourne6c0aa5f2011-10-06 18:29:37 +00002556 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2557 ReturnValueSlot ReturnValue);
2558
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002559
Mike Stump1eb44332009-09-09 15:08:12 +00002560 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbaref2abfe2009-02-16 22:43:43 +00002561 unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002562
Anders Carlssona1736c02009-12-24 21:13:40 +00002563 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stump09429b92009-02-17 17:00:02 +00002564
Mike Stump0dd9e882009-02-08 23:14:22 +00002565 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2566 /// is unhandled by the current target.
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +00002567 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2568
Tim Northoverff920ee2013-05-04 07:15:13 +00002569 llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Chris Lattner2752c012010-03-03 19:03:45 +00002570 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002571 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner686775d2011-07-20 06:58:45 +00002572 SmallVectorImpl<llvm::Value*> &O,
Bob Wilsondb3d4d02010-12-08 22:37:56 +00002573 const char *name,
Nate Begeman61eecf52010-06-14 05:21:25 +00002574 unsigned shift = 0, bool rightshift = false);
Bob Wilsoncf556522010-12-07 22:40:02 +00002575 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2acc6e32011-07-18 04:24:23 +00002576 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman61eecf52010-06-14 05:21:25 +00002577 bool negateForRightShift);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002578
Bill Wendling795b1002012-02-22 09:30:11 +00002579 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002580 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2581 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002582
Daniel Dunbared7c6182008-08-20 00:28:19 +00002583 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +00002584 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beardeb382ec2012-04-19 00:25:12 +00002585 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremenekebcb57a2012-03-06 20:05:56 +00002586 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2587 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2588 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2589 const ObjCMethodDecl *MethodWithObjects);
Chris Lattner8fdf3282008-06-24 17:04:18 +00002590 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCallef072fd2010-05-22 01:48:05 +00002591 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2592 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattner8fdf3282008-06-24 17:04:18 +00002593
John McCallf85e1932011-06-15 23:02:42 +00002594 /// Retrieves the default cleanup kind for an ARC cleanup.
2595 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2596 CleanupKind getARCCleanupKind() {
2597 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2598 ? NormalAndEHCleanup : NormalCleanup;
2599 }
2600
2601 // ARC primitives.
2602 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2603 void EmitARCDestroyWeak(llvm::Value *addr);
2604 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2605 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2606 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2607 bool ignored);
2608 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2609 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2610 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2611 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall545d9962011-06-25 02:11:03 +00002612 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCall5b07e802013-03-13 03:10:54 +00002613 bool resultIgnored);
John McCallf85e1932011-06-15 23:02:42 +00002614 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCall5b07e802013-03-13 03:10:54 +00002615 bool resultIgnored);
John McCallf85e1932011-06-15 23:02:42 +00002616 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2617 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCall348f16f2011-10-04 06:23:45 +00002618 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall5b07e802013-03-13 03:10:54 +00002619 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2620 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCallf85e1932011-06-15 23:02:42 +00002621 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2622 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2623 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2624 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2625
2626 std::pair<LValue,llvm::Value*>
2627 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2628 std::pair<LValue,llvm::Value*>
2629 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2630
John McCall2b014d62011-10-01 10:32:24 +00002631 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2632
John McCallf85e1932011-06-15 23:02:42 +00002633 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2634 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2635 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2636
John McCall348f16f2011-10-04 06:23:45 +00002637 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCallf85e1932011-06-15 23:02:42 +00002638 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2639 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2640
John McCallb6a60792013-03-23 02:35:54 +00002641 void EmitARCIntrinsicUse(llvm::ArrayRef<llvm::Value*> values);
2642
John McCallbdc4d802011-07-09 01:37:26 +00002643 static Destroyer destroyARCStrongImprecise;
2644 static Destroyer destroyARCStrongPrecise;
2645 static Destroyer destroyARCWeak;
2646
John McCallf85e1932011-06-15 23:02:42 +00002647 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2648 llvm::Value *EmitObjCAutoreleasePoolPush();
2649 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2650 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2651 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2652
Anders Carlsson4029ca72009-05-20 00:24:07 +00002653 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2654 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002655 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson32f36ba2010-06-26 16:35:32 +00002656 const NamedDecl *InitializedDecl);
Anders Carlsson3aba0932010-01-31 18:34:51 +00002657
Chris Lattner883f6a72007-08-11 00:04:45 +00002658 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002659 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +00002660 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002661
2662 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stump0dd9e882009-02-08 23:14:22 +00002663
2664 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2665 /// scalar type, returning the result.
Anders Carlsson14c5cbf2009-08-16 07:36:22 +00002666 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002667
Chris Lattner3707b252007-08-26 06:48:56 +00002668 /// EmitScalarConversion - Emit a conversion from the specified type to the
2669 /// specified destination type, both of which are LLVM scalar types.
2670 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2671 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002672
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002673 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stump0dd9e882009-02-08 23:14:22 +00002674 /// complex type to the specified destination type, where the destination type
2675 /// is an LLVM scalar type.
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002676 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2677 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002678
2679
John McCall558d2ab2010-09-15 10:14:12 +00002680 /// EmitAggExpr - Emit the computation of the specified expression
2681 /// of aggregate type. The result is computed into the given slot,
2682 /// which may be null to indicate that the value is not needed.
John McCalle0c11682012-07-02 23:58:38 +00002683 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stump0dd9e882009-02-08 23:14:22 +00002684
Daniel Dunbar18aba0d2010-02-05 19:38:31 +00002685 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2686 /// aggregate type into a temporary LValue.
2687 LValue EmitAggExprToLValue(const Expr *E);
2688
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002689 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2690 /// pointers.
2691 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian08c32132009-08-31 19:33:16 +00002692 QualType Ty);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002693
John McCall0c24c802011-06-24 23:21:27 +00002694 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2695 /// make sure it survives garbage collection until this point.
2696 void EmitExtendGCLifetime(llvm::Value *object);
2697
Chris Lattnerb6ef18a2007-08-21 05:54:00 +00002698 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002699 /// complex type, returning the result.
John McCallb418d742010-11-16 10:08:07 +00002700 ComplexPairTy EmitComplexExpr(const Expr *E,
2701 bool IgnoreReal = false,
2702 bool IgnoreImag = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002703
John McCall9d232c82013-03-07 21:37:08 +00002704 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2705 /// type and place its result into the specified l-value.
2706 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00002707
John McCall9d232c82013-03-07 21:37:08 +00002708 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
2709 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
2710
2711 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
2712 ComplexPairTy EmitLoadOfComplex(LValue src);
Chris Lattner2621fd12008-05-08 05:58:21 +00002713
John McCallb6bbcc92010-10-15 04:57:14 +00002714 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2715 /// a static local variable.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002716 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2717 const char *Separator,
2718 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002719
Chandler Carruth0f30a122012-03-30 19:44:53 +00002720 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2721 /// global variable that has already been created for it. If the initializer
2722 /// has a different type than GV does, this may free GV and return a different
2723 /// one. Otherwise it just returns GV.
2724 llvm::GlobalVariable *
2725 AddInitializerToStaticVarDecl(const VarDecl &D,
2726 llvm::GlobalVariable *GV);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002727
Daniel Dunbar0096acf2009-02-25 19:24:29 +00002728
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002729 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2730 /// variable with global storage.
Richard Smith7ca48502012-02-13 22:16:19 +00002731 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2732 bool PerformInit);
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002733
John McCall20bb1752012-05-01 06:13:13 +00002734 /// Call atexit() with a function that passes the given argument to
2735 /// the given function.
2736 void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr);
Mike Stump1eb44332009-09-09 15:08:12 +00002737
John McCall3030eb82010-11-06 09:44:32 +00002738 /// Emit code in this function to perform a guarded variable
2739 /// initialization. Guarded initializations are used when it's not
2740 /// possible to prove that an initialization will be done exactly
2741 /// once, e.g. with a static local variable or a static data member
2742 /// of a class template.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002743 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith7ca48502012-02-13 22:16:19 +00002744 bool PerformInit);
John McCall5cd91b52010-09-08 01:44:27 +00002745
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002746 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2747 /// variables.
2748 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
Benjamin Kramerc7b5f382013-04-26 21:32:52 +00002749 ArrayRef<llvm::Constant *> Decls,
Richard Smithb80a16e2013-04-19 16:42:07 +00002750 llvm::GlobalVariable *Guard = 0);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002751
John McCall3f88f682012-04-06 18:21:03 +00002752 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002753 /// variables.
John McCall3f88f682012-04-06 18:21:03 +00002754 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2755 const std::vector<std::pair<llvm::WeakVH,
2756 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002757
John McCalld26bc762011-03-09 04:27:21 +00002758 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2759 const VarDecl *D,
Richard Smith7ca48502012-02-13 22:16:19 +00002760 llvm::GlobalVariable *Addr,
2761 bool PerformInit);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002762
John McCall558d2ab2010-09-15 10:14:12 +00002763 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002764
2765 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian830937b2010-12-02 17:02:11 +00002766 const Expr *Exp);
Mike Stump1eb44332009-09-09 15:08:12 +00002767
John McCall1a343eb2011-11-10 08:15:53 +00002768 void enterFullExpression(const ExprWithCleanups *E) {
2769 if (E->getNumObjects() == 0) return;
2770 enterNonTrivialFullExpression(E);
2771 }
2772 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump1eb44332009-09-09 15:08:12 +00002773
Richard Smith4c71b8c2013-05-07 21:53:22 +00002774 void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
Douglas Gregor1eb2e592010-05-16 00:44:00 +00002775
Eli Friedman4c5d8af2012-02-09 03:32:31 +00002776 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2777
Eli Friedman276b0612011-10-11 02:20:01 +00002778 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2779
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002780 //===--------------------------------------------------------------------===//
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002781 // Annotations Emission
2782 //===--------------------------------------------------------------------===//
2783
2784 /// Emit an annotation call (intrinsic or builtin).
2785 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2786 llvm::Value *AnnotatedVal,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002787 StringRef AnnotationStr,
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002788 SourceLocation Location);
2789
2790 /// Emit local annotations for the local variable V, declared by D.
2791 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2792
2793 /// Emit field annotations for the given field & value. Returns the
2794 /// annotation result.
2795 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2796
2797 //===--------------------------------------------------------------------===//
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002798 // Internal Helpers
2799 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002800
Chris Lattner0946ccd2008-11-11 07:41:27 +00002801 /// ContainsLabel - Return true if the statement contains a label in it. If
2802 /// this statement is not executed normally, it not containing a label means
2803 /// that we can just remove the code.
2804 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002805
Chris Lattneref425a62011-02-28 00:18:40 +00002806 /// containsBreak - Return true if the statement contains a break out of it.
2807 /// If the statement (recursively) contains a switch or loop with a break
2808 /// inside of it, this is fine.
2809 static bool containsBreak(const Stmt *S);
2810
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002811 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnerc2c90012011-02-27 23:02:32 +00002812 /// to a constant, or if it does but contains a label, return false. If it
2813 /// constant folds return true and set the boolean result in Result.
2814 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stump0dd9e882009-02-08 23:14:22 +00002815
Chris Lattneref425a62011-02-28 00:18:40 +00002816 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2817 /// to a constant, or if it does but contains a label, return false. If it
2818 /// constant folds return true and set the folded value.
Richard Trieue1ecdc12012-07-23 20:21:35 +00002819 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattneref425a62011-02-28 00:18:40 +00002820
Chris Lattner31a09842008-11-12 08:04:58 +00002821 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2822 /// if statement) to the specified blocks. Based on the condition, this might
2823 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattner9bc47e22008-11-12 07:46:33 +00002824 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002825 llvm::BasicBlock *FalseBlock);
Mike Stumpbe07f602009-12-14 21:58:14 +00002826
Richard Smith4def70d2012-10-09 19:52:38 +00002827 /// \brief Emit a description of a type in a format suitable for passing to
2828 /// a runtime sanitizer handler.
2829 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2830
2831 /// \brief Convert a value into a format suitable for passing to a runtime
2832 /// sanitizer handler.
2833 llvm::Value *EmitCheckValue(llvm::Value *V);
2834
2835 /// \brief Emit a description of a source location in a format suitable for
2836 /// passing to a runtime sanitizer handler.
2837 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2838
Will Dietzad954812012-12-02 19:50:33 +00002839 /// \brief Specify under what conditions this check can be recovered
2840 enum CheckRecoverableKind {
2841 /// Always terminate program execution if this check fails
2842 CRK_Unrecoverable,
2843 /// Check supports recovering, allows user to specify which
2844 CRK_Recoverable,
2845 /// Runtime conditionally aborts, always need to support recovery.
2846 CRK_AlwaysRecoverable
2847 };
2848
Richard Smithcc305612012-11-01 22:15:34 +00002849 /// \brief Create a basic block that will call a handler function in a
2850 /// sanitizer runtime with the provided arguments, and create a conditional
2851 /// branch to it.
Richard Smith4def70d2012-10-09 19:52:38 +00002852 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002853 ArrayRef<llvm::Constant *> StaticArgs,
2854 ArrayRef<llvm::Value *> DynamicArgs,
Will Dietzad954812012-12-02 19:50:33 +00002855 CheckRecoverableKind Recoverable);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002856
Richard Smithcc305612012-11-01 22:15:34 +00002857 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2858 /// conditional branch to it, for the -ftrapv checks.
Chad Rosier78d85b12013-01-29 23:31:22 +00002859 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithcc305612012-11-01 22:15:34 +00002860
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002861 /// EmitCallArg - Emit a single call argument.
John McCall413ebdb2011-03-11 20:59:21 +00002862 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002863
John McCall27360712010-05-26 22:34:26 +00002864 /// EmitDelegateCallArg - We are performing a delegate call; that
2865 /// is, the current function is delegating to another one. Produce
2866 /// a r-value suitable for passing the given parameter.
John McCall413ebdb2011-03-11 20:59:21 +00002867 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall27360712010-05-26 22:34:26 +00002868
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002869 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2870 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sands82500162012-04-10 08:23:07 +00002871 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002872
Chris Lattner31a09842008-11-12 08:04:58 +00002873private:
Rafael Espindolac3f89552012-03-24 16:50:34 +00002874 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002875 void EmitReturnOfRValue(RValue RV, QualType Ty);
2876
Daniel Dunbar56273772008-09-17 00:51:38 +00002877 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2878 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2879 ///
2880 /// \param AI - The first function argument of the expansion.
2881 /// \return The argument following the last expanded function
2882 /// argument.
Mike Stump0dd9e882009-02-08 23:14:22 +00002883 llvm::Function::arg_iterator
Daniel Dunbar56273772008-09-17 00:51:38 +00002884 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2885 llvm::Function::arg_iterator AI);
2886
Mike Stump0dd9e882009-02-08 23:14:22 +00002887 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2888 /// Ty, into individual arguments on the provided vector \arg Args. See
2889 /// ABIArgInfo::Expand.
2890 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner686775d2011-07-20 06:58:45 +00002891 SmallVector<llvm::Value*, 16> &Args,
Chris Lattner811bf362011-07-12 06:29:11 +00002892 llvm::FunctionType *IRFuncTy);
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002893
Chad Rosier42b60552012-08-23 20:00:18 +00002894 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002895 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stump0dd9e882009-02-08 23:14:22 +00002896
Chad Rosier42b60552012-08-23 20:00:18 +00002897 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedman6d7cfd72010-07-16 00:55:21 +00002898 LValue InputValue, QualType InputType,
2899 std::string &ConstraintStr);
2900
Anders Carlsson0139bb92009-04-08 20:47:54 +00002901 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump1eb44332009-09-09 15:08:12 +00002902 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlssonaf23f692009-04-18 20:20:22 +00002903 /// argument types of the function being called.
2904 template<typename T>
2905 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson0139bb92009-04-08 20:47:54 +00002906 CallExpr::const_arg_iterator ArgBeg,
Anders Carlssonaf23f692009-04-18 20:20:22 +00002907 CallExpr::const_arg_iterator ArgEnd) {
2908 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson0139bb92009-04-08 20:47:54 +00002909
Anders Carlssonaf23f692009-04-18 20:20:22 +00002910 // First, use the argument types that the type info knows about
2911 if (CallArgTypeInfo) {
2912 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2913 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman44b0a3e2009-11-18 03:42:04 +00002914 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlssonaf23f692009-04-18 20:20:22 +00002915 QualType ArgType = *I;
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002916#ifndef NDEBUG
2917 QualType ActualArgType = Arg->getType();
2918 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002919 QualType ActualBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002920 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002921 QualType ArgBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002922 ArgType->getAs<PointerType>()->getPointeeType();
2923 if (ArgBaseType->isVariableArrayType()) {
2924 if (const VariableArrayType *VAT =
2925 getContext().getAsVariableArrayType(ActualBaseType)) {
2926 if (!VAT->getSizeExpr())
2927 ActualArgType = ArgType;
2928 }
2929 }
2930 }
Anders Carlssonaf23f692009-04-18 20:20:22 +00002931 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump1eb44332009-09-09 15:08:12 +00002932 getTypePtr() ==
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002933 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002934 "type mismatch in call argument!");
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002935#endif
John McCall413ebdb2011-03-11 20:59:21 +00002936 EmitCallArg(Args, *Arg, ArgType);
Anders Carlssonaf23f692009-04-18 20:20:22 +00002937 }
Mike Stump1eb44332009-09-09 15:08:12 +00002938
2939 // Either we've emitted all the call args, or we have a call to a
Anders Carlssonaf23f692009-04-18 20:20:22 +00002940 // variadic function.
Mike Stump1eb44332009-09-09 15:08:12 +00002941 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002942 "Extra arguments in non-variadic function!");
Mike Stump1eb44332009-09-09 15:08:12 +00002943
Anders Carlssonaf23f692009-04-18 20:20:22 +00002944 }
Mike Stump1eb44332009-09-09 15:08:12 +00002945
Anders Carlssonaf23f692009-04-18 20:20:22 +00002946 // If we still have any arguments, emit them using the type of the argument.
John McCall413ebdb2011-03-11 20:59:21 +00002947 for (; Arg != ArgEnd; ++Arg)
2948 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlssonaf23f692009-04-18 20:20:22 +00002949 }
John McCall492c4f92010-03-03 04:15:11 +00002950
2951 const TargetCodeGenInfo &getTargetHooks() const {
2952 return CGM.getTargetCodeGenInfo();
2953 }
John McCall744016d2010-07-06 23:57:41 +00002954
2955 void EmitDeclMetadata();
John McCallf0c11f72011-03-31 08:03:29 +00002956
2957 CodeGenModule::ByrefHelpers *
Chris Lattner2acc6e32011-07-18 04:24:23 +00002958 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf0c11f72011-03-31 08:03:29 +00002959 const AutoVarEmission &emission);
Dan Gohmanb49bd272012-02-16 00:57:37 +00002960
2961 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadf4c3db12012-03-02 18:34:30 +00002962
Eli Friedmanea93e402012-08-23 03:10:17 +00002963 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2964 /// value and compute our best estimate of the alignment of the pointee.
2965 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Reid Spencer5f016e22007-07-11 17:01:13 +00002966};
Mike Stump1eb44332009-09-09 15:08:12 +00002967
John McCall150b4622011-01-26 04:00:11 +00002968/// Helper class with most of the code for saving a value for a
2969/// conditional expression cleanup.
John McCall804b8072011-01-28 10:53:53 +00002970struct DominatingLLVMValue {
John McCall150b4622011-01-26 04:00:11 +00002971 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2972
2973 /// Answer whether the given value needs extra work to be saved.
2974 static bool needsSaving(llvm::Value *value) {
2975 // If it's not an instruction, we don't need to save.
2976 if (!isa<llvm::Instruction>(value)) return false;
2977
2978 // If it's an instruction in the entry block, we don't need to save.
2979 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2980 return (block != &block->getParent()->getEntryBlock());
2981 }
2982
2983 /// Try to save the given value.
2984 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2985 if (!needsSaving(value)) return saved_type(value, false);
2986
2987 // Otherwise we need an alloca.
2988 llvm::Value *alloca =
2989 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2990 CGF.Builder.CreateStore(value, alloca);
2991
2992 return saved_type(alloca, true);
2993 }
2994
2995 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2996 if (!value.getInt()) return value.getPointer();
2997 return CGF.Builder.CreateLoad(value.getPointer());
2998 }
2999};
3000
John McCall804b8072011-01-28 10:53:53 +00003001/// A partial specialization of DominatingValue for llvm::Values that
3002/// might be llvm::Instructions.
3003template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
3004 typedef T *type;
John McCall150b4622011-01-26 04:00:11 +00003005 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCall804b8072011-01-28 10:53:53 +00003006 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
3007 }
3008};
3009
3010/// A specialization of DominatingValue for RValue.
3011template <> struct DominatingValue<RValue> {
3012 typedef RValue type;
3013 class saved_type {
3014 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
3015 AggregateAddress, ComplexAddress };
3016
3017 llvm::Value *Value;
3018 Kind K;
3019 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
3020
3021 public:
3022 static bool needsSaving(RValue value);
3023 static saved_type save(CodeGenFunction &CGF, RValue value);
3024 RValue restore(CodeGenFunction &CGF);
3025
3026 // implementations in CGExprCXX.cpp
3027 };
3028
3029 static bool needsSaving(type value) {
3030 return saved_type::needsSaving(value);
3031 }
3032 static saved_type save(CodeGenFunction &CGF, type value) {
3033 return saved_type::save(CGF, value);
3034 }
3035 static type restore(CodeGenFunction &CGF, saved_type value) {
3036 return value.restore(CGF);
John McCall150b4622011-01-26 04:00:11 +00003037 }
3038};
3039
Reid Spencer5f016e22007-07-11 17:01:13 +00003040} // end namespace CodeGen
3041} // end namespace clang
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00003042
Reid Spencer5f016e22007-07-11 17:01:13 +00003043#endif