blob: e40a731825beb167a0d2a8502a96811b00625d7c [file] [log] [blame]
Daniel Dunbarbd012ff2008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Reid Spencer5f016e22007-07-11 17:01:13 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stump0dd9e882009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Reid Spencer5f016e22007-07-11 17:01:13 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattneref52a2f2008-02-29 17:10:38 +000014#ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15#define CLANG_CODEGEN_CODEGENFUNCTION_H
Reid Spencer5f016e22007-07-11 17:01:13 +000016
Daniel Dunbar45d196b2008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christopherc3287792011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000019#include "CGValue.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000020#include "CodeGenModule.h"
21#include "clang/AST/CharUnits.h"
22#include "clang/AST/ExprCXX.h"
23#include "clang/AST/ExprObjC.h"
24#include "clang/AST/Type.h"
25#include "clang/Basic/ABI.h"
26#include "clang/Basic/TargetInfo.h"
27#include "clang/Frontend/CodeGenOptions.h"
28#include "llvm/ADT/ArrayRef.h"
29#include "llvm/ADT/DenseMap.h"
30#include "llvm/ADT/SmallVector.h"
31#include "llvm/Support/Debug.h"
32#include "llvm/Support/ValueHandle.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000033
Reid Spencer5f016e22007-07-11 17:01:13 +000034namespace llvm {
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000035 class BasicBlock;
Benjamin Kramerf21efe92009-08-11 17:46:57 +000036 class LLVMContext;
David Chisnalldd5c98f2010-05-01 11:15:56 +000037 class MDNode;
Reid Spencer5f016e22007-07-11 17:01:13 +000038 class Module;
Daniel Dunbar898d5082008-09-30 01:06:03 +000039 class SwitchInst;
Daniel Dunbar259e9cc2009-10-19 01:21:05 +000040 class Twine;
Daniel Dunbared3849b2008-11-19 09:36:46 +000041 class Value;
John McCallf1549f62010-07-06 01:34:17 +000042 class CallSite;
Reid Spencer5f016e22007-07-11 17:01:13 +000043}
44
45namespace clang {
46 class ASTContext;
John McCall1a343eb2011-11-10 08:15:53 +000047 class BlockDecl;
Anders Carlsson7267c162009-05-29 21:03:38 +000048 class CXXDestructorDecl;
Richard Smithad762fc2011-04-14 22:09:26 +000049 class CXXForRangeStmt;
Anders Carlsson6815e942009-09-27 18:58:34 +000050 class CXXTryStmt;
Reid Spencer5f016e22007-07-11 17:01:13 +000051 class Decl;
Chris Lattnerad8dcf42011-02-17 07:39:24 +000052 class LabelDecl;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000053 class EnumConstantDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000054 class FunctionDecl;
Douglas Gregor72564e72009-02-26 23:50:07 +000055 class FunctionProtoType;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000056 class LabelStmt;
Fariborz Jahanian679a5022009-01-10 21:06:09 +000057 class ObjCContainerDecl;
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +000058 class ObjCInterfaceDecl;
59 class ObjCIvarDecl;
Chris Lattner391d77a2008-03-30 23:03:07 +000060 class ObjCMethodDecl;
Fariborz Jahanianfef30b52008-12-09 20:23:04 +000061 class ObjCImplementationDecl;
Daniel Dunbaraf05bb92008-08-26 08:29:31 +000062 class ObjCPropertyImplDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000063 class TargetInfo;
John McCall492c4f92010-03-03 04:15:11 +000064 class TargetCodeGenInfo;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000065 class VarDecl;
Chris Lattner16f00492009-04-26 01:32:48 +000066 class ObjCForCollectionStmt;
67 class ObjCAtTryStmt;
68 class ObjCAtThrowStmt;
69 class ObjCAtSynchronizedStmt;
John McCallf85e1932011-06-15 23:02:42 +000070 class ObjCAutoreleasePoolStmt;
Devang Patelb84a06e2007-10-23 02:10:49 +000071
Reid Spencer5f016e22007-07-11 17:01:13 +000072namespace CodeGen {
Devang Patelb84a06e2007-10-23 02:10:49 +000073 class CodeGenTypes;
Daniel Dunbarbb36d332009-02-02 21:43:58 +000074 class CGFunctionInfo;
Mike Stump0dd9e882009-02-08 23:14:22 +000075 class CGRecordLayout;
John McCallee504292010-05-21 04:11:14 +000076 class CGBlockInfo;
John McCall4c40d982010-08-31 07:33:07 +000077 class CGCXXABI;
John McCalld16c2cf2011-02-08 08:22:06 +000078 class BlockFlags;
79 class BlockFieldFlags;
Mike Stump0dd9e882009-02-08 23:14:22 +000080
John McCall9d232c82013-03-07 21:37:08 +000081/// The kind of evaluation to perform on values of a particular
82/// type. Basically, is the code in CGExprScalar, CGExprComplex, or
83/// CGExprAgg?
84///
85/// TODO: should vectors maybe be split out into their own thing?
86enum TypeEvaluationKind {
87 TEK_Scalar,
88 TEK_Complex,
89 TEK_Aggregate
90};
91
John McCallf1549f62010-07-06 01:34:17 +000092/// A branch fixup. These are required when emitting a goto to a
93/// label which hasn't been emitted yet. The goto is optimistically
94/// emitted as a branch to the basic block for the label, and (if it
95/// occurs in a scope with non-trivial cleanups) a fixup is added to
96/// the innermost cleanup. When a (normal) cleanup is popped, any
97/// unresolved fixups in that scope are threaded through the cleanup.
98struct BranchFixup {
John McCallff8e1152010-07-23 21:56:41 +000099 /// The block containing the terminator which needs to be modified
100 /// into a switch if this fixup is resolved into the current scope.
101 /// If null, LatestBranch points directly to the destination.
102 llvm::BasicBlock *OptimisticBranchBlock;
John McCallf1549f62010-07-06 01:34:17 +0000103
John McCallff8e1152010-07-23 21:56:41 +0000104 /// The ultimate destination of the branch.
John McCallf1549f62010-07-06 01:34:17 +0000105 ///
106 /// This can be set to null to indicate that this fixup was
107 /// successfully resolved.
108 llvm::BasicBlock *Destination;
109
John McCallff8e1152010-07-23 21:56:41 +0000110 /// The destination index value.
111 unsigned DestinationIndex;
112
113 /// The initial branch of the fixup.
114 llvm::BranchInst *InitialBranch;
John McCallf1549f62010-07-06 01:34:17 +0000115};
116
John McCall804b8072011-01-28 10:53:53 +0000117template <class T> struct InvariantValue {
John McCall150b4622011-01-26 04:00:11 +0000118 typedef T type;
119 typedef T saved_type;
120 static bool needsSaving(type value) { return false; }
121 static saved_type save(CodeGenFunction &CGF, type value) { return value; }
122 static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
123};
John McCall804b8072011-01-28 10:53:53 +0000124
125/// A metaprogramming class for ensuring that a value will dominate an
126/// arbitrary position in a function.
127template <class T> struct DominatingValue : InvariantValue<T> {};
128
129template <class T, bool mightBeInstruction =
130 llvm::is_base_of<llvm::Value, T>::value &&
131 !llvm::is_base_of<llvm::Constant, T>::value &&
132 !llvm::is_base_of<llvm::BasicBlock, T>::value>
133struct DominatingPointer;
134template <class T> struct DominatingPointer<T,false> : InvariantValue<T*> {};
135// template <class T> struct DominatingPointer<T,true> at end of file
136
137template <class T> struct DominatingValue<T*> : DominatingPointer<T> {};
John McCall150b4622011-01-26 04:00:11 +0000138
John McCallcd2d2b72010-08-13 21:20:51 +0000139enum CleanupKind {
140 EHCleanup = 0x1,
141 NormalCleanup = 0x2,
142 NormalAndEHCleanup = EHCleanup | NormalCleanup,
143
144 InactiveCleanup = 0x4,
145 InactiveEHCleanup = EHCleanup | InactiveCleanup,
146 InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
147 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
148};
John McCallda65ea82010-07-13 20:32:21 +0000149
John McCallf1549f62010-07-06 01:34:17 +0000150/// A stack of scopes which respond to exceptions, including cleanups
151/// and catch blocks.
152class EHScopeStack {
153public:
154 /// A saved depth on the scope stack. This is necessary because
155 /// pushing scopes onto the stack invalidates iterators.
156 class stable_iterator {
157 friend class EHScopeStack;
158
159 /// Offset from StartOfData to EndOfBuffer.
160 ptrdiff_t Size;
161
162 stable_iterator(ptrdiff_t Size) : Size(Size) {}
163
164 public:
165 static stable_iterator invalid() { return stable_iterator(-1); }
166 stable_iterator() : Size(-1) {}
167
168 bool isValid() const { return Size >= 0; }
169
John McCall838d7962010-08-14 07:46:19 +0000170 /// Returns true if this scope encloses I.
171 /// Returns false if I is invalid.
172 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000173 bool encloses(stable_iterator I) const { return Size <= I.Size; }
John McCall838d7962010-08-14 07:46:19 +0000174
175 /// Returns true if this scope strictly encloses I: that is,
176 /// if it encloses I and is not I.
177 /// Returns false is I is invalid.
178 /// This scope must be valid.
John McCallff8e1152010-07-23 21:56:41 +0000179 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
John McCall1bda6622010-07-21 00:40:03 +0000180
John McCallf1549f62010-07-06 01:34:17 +0000181 friend bool operator==(stable_iterator A, stable_iterator B) {
182 return A.Size == B.Size;
183 }
184 friend bool operator!=(stable_iterator A, stable_iterator B) {
185 return A.Size != B.Size;
186 }
187 };
188
John McCall1f0fca52010-07-21 07:22:38 +0000189 /// Information for lazily generating a cleanup. Subclasses must be
190 /// POD-like: cleanups will not be destructed, and they will be
191 /// allocated on the cleanup stack and freely copied and moved
192 /// around.
John McCallda65ea82010-07-13 20:32:21 +0000193 ///
John McCall1f0fca52010-07-21 07:22:38 +0000194 /// Cleanup implementations should generally be declared in an
John McCallda65ea82010-07-13 20:32:21 +0000195 /// anonymous namespace.
John McCall1f0fca52010-07-21 07:22:38 +0000196 class Cleanup {
John McCallc4a1a842011-07-12 00:15:30 +0000197 // Anchor the construction vtable.
198 virtual void anchor();
John McCallda65ea82010-07-13 20:32:21 +0000199 public:
John McCallad346f42011-07-12 20:27:29 +0000200 /// Generation flags.
201 class Flags {
202 enum {
203 F_IsForEH = 0x1,
204 F_IsNormalCleanupKind = 0x2,
205 F_IsEHCleanupKind = 0x4
206 };
207 unsigned flags;
208
209 public:
210 Flags() : flags(0) {}
211
212 /// isForEH - true if the current emission is for an EH cleanup.
213 bool isForEHCleanup() const { return flags & F_IsForEH; }
214 bool isForNormalCleanup() const { return !isForEHCleanup(); }
215 void setIsForEHCleanup() { flags |= F_IsForEH; }
216
217 bool isNormalCleanupKind() const { return flags & F_IsNormalCleanupKind; }
218 void setIsNormalCleanupKind() { flags |= F_IsNormalCleanupKind; }
219
220 /// isEHCleanupKind - true if the cleanup was pushed as an EH
221 /// cleanup.
222 bool isEHCleanupKind() const { return flags & F_IsEHCleanupKind; }
223 void setIsEHCleanupKind() { flags |= F_IsEHCleanupKind; }
224 };
225
John McCallc4a1a842011-07-12 00:15:30 +0000226 // Provide a virtual destructor to suppress a very common warning
227 // that unfortunately cannot be suppressed without this. Cleanups
228 // should not rely on this destructor ever being called.
229 virtual ~Cleanup() {}
John McCall3e29f962010-07-13 23:19:49 +0000230
John McCallda65ea82010-07-13 20:32:21 +0000231 /// Emit the cleanup. For normal cleanups, this is run in the
232 /// same EH context as when the cleanup was pushed, i.e. the
233 /// immediately-enclosing context of the cleanup scope. For
234 /// EH cleanups, this is run in a terminate context.
235 ///
Dmitri Gribenko70517ca2012-08-23 17:58:28 +0000236 // \param flags cleanup kind.
John McCallad346f42011-07-12 20:27:29 +0000237 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
John McCallda65ea82010-07-13 20:32:21 +0000238 };
239
John McCall150b4622011-01-26 04:00:11 +0000240 /// ConditionalCleanupN stores the saved form of its N parameters,
241 /// then restores them and performs the cleanup.
John McCall3ad32c82011-01-28 08:37:24 +0000242 template <class T, class A0>
243 class ConditionalCleanup1 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000244 typedef typename DominatingValue<A0>::saved_type A0_saved;
John McCall3ad32c82011-01-28 08:37:24 +0000245 A0_saved a0_saved;
246
John McCallad346f42011-07-12 20:27:29 +0000247 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000248 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
John McCallad346f42011-07-12 20:27:29 +0000249 T(a0).Emit(CGF, flags);
John McCall3ad32c82011-01-28 08:37:24 +0000250 }
251
252 public:
253 ConditionalCleanup1(A0_saved a0)
254 : a0_saved(a0) {}
255 };
256
John McCall150b4622011-01-26 04:00:11 +0000257 template <class T, class A0, class A1>
John McCall3ad32c82011-01-28 08:37:24 +0000258 class ConditionalCleanup2 : public Cleanup {
John McCall804b8072011-01-28 10:53:53 +0000259 typedef typename DominatingValue<A0>::saved_type A0_saved;
260 typedef typename DominatingValue<A1>::saved_type A1_saved;
John McCall4bbcbda2011-01-26 19:15:39 +0000261 A0_saved a0_saved;
262 A1_saved a1_saved;
John McCall150b4622011-01-26 04:00:11 +0000263
John McCallad346f42011-07-12 20:27:29 +0000264 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall804b8072011-01-28 10:53:53 +0000265 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
266 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
John McCallad346f42011-07-12 20:27:29 +0000267 T(a0, a1).Emit(CGF, flags);
John McCall150b4622011-01-26 04:00:11 +0000268 }
269
270 public:
John McCall3ad32c82011-01-28 08:37:24 +0000271 ConditionalCleanup2(A0_saved a0, A1_saved a1)
272 : a0_saved(a0), a1_saved(a1) {}
John McCall150b4622011-01-26 04:00:11 +0000273 };
274
Douglas Gregord7b23162011-06-22 16:12:01 +0000275 template <class T, class A0, class A1, class A2>
276 class ConditionalCleanup3 : public Cleanup {
277 typedef typename DominatingValue<A0>::saved_type A0_saved;
278 typedef typename DominatingValue<A1>::saved_type A1_saved;
279 typedef typename DominatingValue<A2>::saved_type A2_saved;
280 A0_saved a0_saved;
281 A1_saved a1_saved;
282 A2_saved a2_saved;
283
John McCallad346f42011-07-12 20:27:29 +0000284 void Emit(CodeGenFunction &CGF, Flags flags) {
Douglas Gregord7b23162011-06-22 16:12:01 +0000285 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
286 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
287 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
John McCallad346f42011-07-12 20:27:29 +0000288 T(a0, a1, a2).Emit(CGF, flags);
Douglas Gregord7b23162011-06-22 16:12:01 +0000289 }
290
291 public:
292 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
John McCallc4a1a842011-07-12 00:15:30 +0000293 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
Douglas Gregord7b23162011-06-22 16:12:01 +0000294 };
295
John McCall9928c482011-07-12 16:41:08 +0000296 template <class T, class A0, class A1, class A2, class A3>
297 class ConditionalCleanup4 : public Cleanup {
298 typedef typename DominatingValue<A0>::saved_type A0_saved;
299 typedef typename DominatingValue<A1>::saved_type A1_saved;
300 typedef typename DominatingValue<A2>::saved_type A2_saved;
301 typedef typename DominatingValue<A3>::saved_type A3_saved;
302 A0_saved a0_saved;
303 A1_saved a1_saved;
304 A2_saved a2_saved;
305 A3_saved a3_saved;
306
John McCallad346f42011-07-12 20:27:29 +0000307 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall9928c482011-07-12 16:41:08 +0000308 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
309 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
310 A2 a2 = DominatingValue<A2>::restore(CGF, a2_saved);
311 A3 a3 = DominatingValue<A3>::restore(CGF, a3_saved);
John McCallad346f42011-07-12 20:27:29 +0000312 T(a0, a1, a2, a3).Emit(CGF, flags);
John McCall9928c482011-07-12 16:41:08 +0000313 }
314
315 public:
316 ConditionalCleanup4(A0_saved a0, A1_saved a1, A2_saved a2, A3_saved a3)
317 : a0_saved(a0), a1_saved(a1), a2_saved(a2), a3_saved(a3) {}
318 };
319
John McCallf1549f62010-07-06 01:34:17 +0000320private:
321 // The implementation for this class is in CGException.h and
322 // CGException.cpp; the definition is here because it's used as a
323 // member of CodeGenFunction.
324
325 /// The start of the scope-stack buffer, i.e. the allocated pointer
326 /// for the buffer. All of these pointers are either simultaneously
327 /// null or simultaneously valid.
328 char *StartOfBuffer;
329
330 /// The end of the buffer.
331 char *EndOfBuffer;
332
333 /// The first valid entry in the buffer.
334 char *StartOfData;
335
336 /// The innermost normal cleanup on the stack.
337 stable_iterator InnermostNormalCleanup;
338
John McCall777d6e52011-08-11 02:22:43 +0000339 /// The innermost EH scope on the stack.
340 stable_iterator InnermostEHScope;
John McCallff8e1152010-07-23 21:56:41 +0000341
John McCallf1549f62010-07-06 01:34:17 +0000342 /// The current set of branch fixups. A branch fixup is a jump to
343 /// an as-yet unemitted label, i.e. a label for which we don't yet
344 /// know the EH stack depth. Whenever we pop a cleanup, we have
345 /// to thread all the current branch fixups through it.
346 ///
347 /// Fixups are recorded as the Use of the respective branch or
348 /// switch statement. The use points to the final destination.
349 /// When popping out of a cleanup, these uses are threaded through
350 /// the cleanup and adjusted to point to the new cleanup.
351 ///
352 /// Note that branches are allowed to jump into protected scopes
353 /// in certain situations; e.g. the following code is legal:
354 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
355 /// goto foo;
356 /// A a;
357 /// foo:
358 /// bar();
Chris Lattner686775d2011-07-20 06:58:45 +0000359 SmallVector<BranchFixup, 8> BranchFixups;
John McCallf1549f62010-07-06 01:34:17 +0000360
361 char *allocate(size_t Size);
362
John McCall1f0fca52010-07-21 07:22:38 +0000363 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCallda65ea82010-07-13 20:32:21 +0000364
John McCallf1549f62010-07-06 01:34:17 +0000365public:
366 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
367 InnermostNormalCleanup(stable_end()),
John McCall777d6e52011-08-11 02:22:43 +0000368 InnermostEHScope(stable_end()) {}
John McCallf1549f62010-07-06 01:34:17 +0000369 ~EHScopeStack() { delete[] StartOfBuffer; }
370
John McCallda65ea82010-07-13 20:32:21 +0000371 // Variadic templates would make this not terrible.
372
373 /// Push a lazily-created cleanup on the stack.
John McCall8e3f8612010-07-13 22:12:14 +0000374 template <class T>
John McCall1f0fca52010-07-21 07:22:38 +0000375 void pushCleanup(CleanupKind Kind) {
376 void *Buffer = pushCleanup(Kind, sizeof(T));
377 Cleanup *Obj = new(Buffer) T();
John McCall8e3f8612010-07-13 22:12:14 +0000378 (void) Obj;
379 }
380
381 /// Push a lazily-created cleanup on the stack.
382 template <class T, class A0>
John McCall1f0fca52010-07-21 07:22:38 +0000383 void pushCleanup(CleanupKind Kind, A0 a0) {
384 void *Buffer = pushCleanup(Kind, sizeof(T));
385 Cleanup *Obj = new(Buffer) T(a0);
John McCall8e3f8612010-07-13 22:12:14 +0000386 (void) Obj;
387 }
388
389 /// Push a lazily-created cleanup on the stack.
John McCallda65ea82010-07-13 20:32:21 +0000390 template <class T, class A0, class A1>
John McCall1f0fca52010-07-21 07:22:38 +0000391 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
392 void *Buffer = pushCleanup(Kind, sizeof(T));
393 Cleanup *Obj = new(Buffer) T(a0, a1);
John McCallda65ea82010-07-13 20:32:21 +0000394 (void) Obj;
395 }
396
397 /// Push a lazily-created cleanup on the stack.
398 template <class T, class A0, class A1, class A2>
John McCall1f0fca52010-07-21 07:22:38 +0000399 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
400 void *Buffer = pushCleanup(Kind, sizeof(T));
401 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
John McCallda65ea82010-07-13 20:32:21 +0000402 (void) Obj;
403 }
404
405 /// Push a lazily-created cleanup on the stack.
406 template <class T, class A0, class A1, class A2, class A3>
John McCall1f0fca52010-07-21 07:22:38 +0000407 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
408 void *Buffer = pushCleanup(Kind, sizeof(T));
409 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
John McCallda65ea82010-07-13 20:32:21 +0000410 (void) Obj;
411 }
412
John McCall77199712010-07-21 05:47:49 +0000413 /// Push a lazily-created cleanup on the stack.
414 template <class T, class A0, class A1, class A2, class A3, class A4>
John McCall1f0fca52010-07-21 07:22:38 +0000415 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
416 void *Buffer = pushCleanup(Kind, sizeof(T));
417 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
John McCall77199712010-07-21 05:47:49 +0000418 (void) Obj;
419 }
420
John McCall7d8647f2010-09-14 07:57:04 +0000421 // Feel free to add more variants of the following:
422
423 /// Push a cleanup with non-constant storage requirements on the
424 /// stack. The cleanup type must provide an additional static method:
425 /// static size_t getExtraSize(size_t);
426 /// The argument to this method will be the value N, which will also
427 /// be passed as the first argument to the constructor.
428 ///
429 /// The data stored in the extra storage must obey the same
430 /// restrictions as normal cleanup member data.
431 ///
432 /// The pointer returned from this method is valid until the cleanup
433 /// stack is modified.
434 template <class T, class A0, class A1, class A2>
435 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
436 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
437 return new (Buffer) T(N, a0, a1, a2);
438 }
439
John McCall777d6e52011-08-11 02:22:43 +0000440 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000441 void popCleanup();
442
443 /// Push a set of catch handlers on the stack. The catch is
444 /// uninitialized and will need to have the given number of handlers
445 /// set on it.
446 class EHCatchScope *pushCatch(unsigned NumHandlers);
447
John McCall777d6e52011-08-11 02:22:43 +0000448 /// Pops a catch scope off the stack. This is private to CGException.cpp.
John McCallf1549f62010-07-06 01:34:17 +0000449 void popCatch();
450
451 /// Push an exceptions filter on the stack.
452 class EHFilterScope *pushFilter(unsigned NumFilters);
453
454 /// Pops an exceptions filter off the stack.
455 void popFilter();
456
457 /// Push a terminate handler on the stack.
458 void pushTerminate();
459
460 /// Pops a terminate handler off the stack.
461 void popTerminate();
462
463 /// Determines whether the exception-scopes stack is empty.
464 bool empty() const { return StartOfData == EndOfBuffer; }
465
466 bool requiresLandingPad() const {
John McCall777d6e52011-08-11 02:22:43 +0000467 return InnermostEHScope != stable_end();
John McCallf1549f62010-07-06 01:34:17 +0000468 }
469
470 /// Determines whether there are any normal cleanups on the stack.
471 bool hasNormalCleanups() const {
472 return InnermostNormalCleanup != stable_end();
473 }
474
475 /// Returns the innermost normal cleanup on the stack, or
476 /// stable_end() if there are no normal cleanups.
477 stable_iterator getInnermostNormalCleanup() const {
478 return InnermostNormalCleanup;
479 }
John McCall777d6e52011-08-11 02:22:43 +0000480 stable_iterator getInnermostActiveNormalCleanup() const;
John McCallf1549f62010-07-06 01:34:17 +0000481
John McCall777d6e52011-08-11 02:22:43 +0000482 stable_iterator getInnermostEHScope() const {
483 return InnermostEHScope;
John McCallf1549f62010-07-06 01:34:17 +0000484 }
485
John McCall777d6e52011-08-11 02:22:43 +0000486 stable_iterator getInnermostActiveEHScope() const;
John McCallf1549f62010-07-06 01:34:17 +0000487
488 /// An unstable reference to a scope-stack depth. Invalidated by
489 /// pushes but not pops.
490 class iterator;
491
492 /// Returns an iterator pointing to the innermost EH scope.
493 iterator begin() const;
494
495 /// Returns an iterator pointing to the outermost EH scope.
496 iterator end() const;
497
498 /// Create a stable reference to the top of the EH stack. The
499 /// returned reference is valid until that scope is popped off the
500 /// stack.
501 stable_iterator stable_begin() const {
502 return stable_iterator(EndOfBuffer - StartOfData);
503 }
504
505 /// Create a stable reference to the bottom of the EH stack.
506 static stable_iterator stable_end() {
507 return stable_iterator(0);
508 }
509
510 /// Translates an iterator into a stable_iterator.
511 stable_iterator stabilize(iterator it) const;
512
John McCallf1549f62010-07-06 01:34:17 +0000513 /// Turn a stable reference to a scope depth into a unstable pointer
514 /// to the EH stack.
515 iterator find(stable_iterator save) const;
516
517 /// Removes the cleanup pointed to by the given stable_iterator.
518 void removeCleanup(stable_iterator save);
519
520 /// Add a branch fixup to the current cleanup scope.
521 BranchFixup &addBranchFixup() {
522 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
523 BranchFixups.push_back(BranchFixup());
524 return BranchFixups.back();
525 }
526
527 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
528 BranchFixup &getBranchFixup(unsigned I) {
529 assert(I < getNumBranchFixups());
530 return BranchFixups[I];
531 }
532
John McCallff8e1152010-07-23 21:56:41 +0000533 /// Pops lazily-removed fixups from the end of the list. This
534 /// should only be called by procedures which have just popped a
535 /// cleanup or resolved one or more fixups.
536 void popNullFixups();
537
538 /// Clears the branch-fixups list. This should only be called by
John McCall8abdbd82010-09-18 02:24:39 +0000539 /// ResolveAllBranchFixups.
John McCallff8e1152010-07-23 21:56:41 +0000540 void clearFixups() { BranchFixups.clear(); }
John McCallf1549f62010-07-06 01:34:17 +0000541};
542
Reid Spencer5f016e22007-07-11 17:01:13 +0000543/// CodeGenFunction - This class organizes the per-function state that is used
544/// while generating LLVM code.
John McCall5936e332011-02-15 09:22:45 +0000545class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000546 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
547 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall4c40d982010-08-31 07:33:07 +0000548
549 friend class CGCXXABI;
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000550public:
John McCallff8e1152010-07-23 21:56:41 +0000551 /// A jump destination is an abstract label, branching to which may
552 /// require a jump out through normal cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000553 struct JumpDest {
John McCallff8e1152010-07-23 21:56:41 +0000554 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
555 JumpDest(llvm::BasicBlock *Block,
556 EHScopeStack::stable_iterator Depth,
557 unsigned Index)
558 : Block(Block), ScopeDepth(Depth), Index(Index) {}
559
560 bool isValid() const { return Block != 0; }
561 llvm::BasicBlock *getBlock() const { return Block; }
562 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
563 unsigned getDestIndex() const { return Index; }
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000564
Nadav Rotem495cfa42013-03-23 06:43:35 +0000565 // This should be used cautiously.
566 void setScopeDepth(EHScopeStack::stable_iterator depth) {
567 ScopeDepth = depth;
568 }
569
John McCallff8e1152010-07-23 21:56:41 +0000570 private:
John McCallf1549f62010-07-06 01:34:17 +0000571 llvm::BasicBlock *Block;
572 EHScopeStack::stable_iterator ScopeDepth;
John McCallff8e1152010-07-23 21:56:41 +0000573 unsigned Index;
574 };
575
Reid Spencer5f016e22007-07-11 17:01:13 +0000576 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar444be732009-11-13 05:51:54 +0000577 const TargetInfo &Target;
Mike Stump0dd9e882009-02-08 23:14:22 +0000578
Chris Lattner58dee102007-08-21 16:57:55 +0000579 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000580 CGBuilderTy Builder;
Mike Stump0dd9e882009-02-08 23:14:22 +0000581
Chris Lattnerb5437d22009-04-23 05:30:27 +0000582 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
583 /// This excludes BlockDecls.
Chris Lattner41110242008-06-17 18:05:57 +0000584 const Decl *CurFuncDecl;
Chris Lattnerb5437d22009-04-23 05:30:27 +0000585 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
586 const Decl *CurCodeDecl;
Daniel Dunbar88b53962009-02-02 22:03:45 +0000587 const CGFunctionInfo *CurFnInfo;
Chris Lattner391d77a2008-03-30 23:03:07 +0000588 QualType FnRetTy;
Reid Spencer5f016e22007-07-11 17:01:13 +0000589 llvm::Function *CurFn;
590
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000591 /// CurGD - The GlobalDecl for the current function being compiled.
592 GlobalDecl CurGD;
Mike Stump6a1e0eb2009-12-04 23:26:17 +0000593
John McCallf85e1932011-06-15 23:02:42 +0000594 /// PrologueCleanupDepth - The cleanup depth enclosing all the
595 /// cleanups associated with the parameters.
596 EHScopeStack::stable_iterator PrologueCleanupDepth;
597
Daniel Dunbar5ca20842008-09-09 21:00:17 +0000598 /// ReturnBlock - Unified return block.
John McCallf1549f62010-07-06 01:34:17 +0000599 JumpDest ReturnBlock;
600
Mike Stump0dd9e882009-02-08 23:14:22 +0000601 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledruf3477c12012-09-27 10:16:10 +0000602 /// iff the function has no return value.
Eli Friedmanb17daf92009-12-04 02:43:40 +0000603 llvm::Value *ReturnValue;
Mike Stump0dd9e882009-02-08 23:14:22 +0000604
Reid Spencer5f016e22007-07-11 17:01:13 +0000605 /// AllocaInsertPoint - This is an instruction in the entry block before which
606 /// we prefer to insert allocas.
Chris Lattner481769b2009-03-31 22:17:44 +0000607 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000608
Nuno Lopesb3198a82012-05-08 22:10:46 +0000609 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
610 /// potentially higher performance penalties.
611 unsigned char BoundsChecking;
612
Richard Smithd6396a62012-11-05 22:21:05 +0000613 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
614 /// calls to EmitTypeCheck can be skipped.
615 bool SanitizePerformTypeCheck;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000616
Will Dietz4f45bc02013-01-18 11:30:38 +0000617 /// \brief Sanitizer options to use for this function.
618 const SanitizerOptions *SanOpts;
619
John McCallf85e1932011-06-15 23:02:42 +0000620 /// In ARC, whether we should autorelease the return value.
621 bool AutoreleaseResult;
622
John McCalld16c2cf2011-02-08 08:22:06 +0000623 const CodeGen::CGBlockInfo *BlockInfo;
624 llvm::Value *BlockPointer;
625
Eli Friedmancec5ebd2012-02-11 02:57:39 +0000626 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
627 FieldDecl *LambdaThisCaptureField;
628
Douglas Gregor3d91bbc2010-05-17 15:52:46 +0000629 /// \brief A mapping from NRVO variables to the flags used to indicate
630 /// when the NRVO has been applied to this variable.
631 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000632
John McCallf1549f62010-07-06 01:34:17 +0000633 EHScopeStack EHStack;
634
John McCallff8e1152010-07-23 21:56:41 +0000635 /// i32s containing the indexes of the cleanup destinations.
636 llvm::AllocaInst *NormalCleanupDest;
John McCallff8e1152010-07-23 21:56:41 +0000637
638 unsigned NextCleanupDestIndex;
639
John McCall1a343eb2011-11-10 08:15:53 +0000640 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
641 CGBlockInfo *FirstBlockInfo;
642
John McCall777d6e52011-08-11 02:22:43 +0000643 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
644 llvm::BasicBlock *EHResumeBlock;
645
Bill Wendling285cfd82011-09-19 20:31:14 +0000646 /// The exception slot. All landing pads write the current exception pointer
647 /// into this alloca.
John McCallf1549f62010-07-06 01:34:17 +0000648 llvm::Value *ExceptionSlot;
649
Bill Wendling285cfd82011-09-19 20:31:14 +0000650 /// The selector slot. Under the MandatoryCleanup model, all landing pads
651 /// write the current selector value into this alloca.
John McCall93c332a2011-05-28 21:13:02 +0000652 llvm::AllocaInst *EHSelectorSlot;
653
John McCallf1549f62010-07-06 01:34:17 +0000654 /// Emits a landing pad for the current EH stack.
655 llvm::BasicBlock *EmitLandingPad();
656
657 llvm::BasicBlock *getInvokeDestImpl();
658
John McCall150b4622011-01-26 04:00:11 +0000659 template <class T>
John McCall804b8072011-01-28 10:53:53 +0000660 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
661 return DominatingValue<T>::save(*this, value);
John McCall150b4622011-01-26 04:00:11 +0000662 }
663
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000664public:
Anders Carlssonfa1f7562009-02-10 06:07:49 +0000665 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
666 /// rethrows.
Chris Lattner686775d2011-07-20 06:58:45 +0000667 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stump0dd9e882009-02-08 23:14:22 +0000668
John McCalld768e9d2011-06-22 02:32:12 +0000669 /// A class controlling the emission of a finally block.
670 class FinallyInfo {
671 /// Where the catchall's edge through the cleanup should go.
672 JumpDest RethrowDest;
Anders Carlssonbb66f9f2009-02-08 07:46:24 +0000673
John McCalld768e9d2011-06-22 02:32:12 +0000674 /// A function to call to enter the catch.
675 llvm::Constant *BeginCatchFn;
676
677 /// An i1 variable indicating whether or not the @finally is
678 /// running for an exception.
679 llvm::AllocaInst *ForEHVar;
680
681 /// An i8* variable into which the exception pointer to rethrow
682 /// has been saved.
683 llvm::AllocaInst *SavedExnVar;
684
685 public:
686 void enter(CodeGenFunction &CGF, const Stmt *Finally,
687 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
688 llvm::Constant *rethrowFn);
689 void exit(CodeGenFunction &CGF);
690 };
Mike Stumpd88ea562009-12-09 03:35:49 +0000691
John McCall150b4622011-01-26 04:00:11 +0000692 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
693 /// current full-expression. Safe against the possibility that
694 /// we're currently inside a conditionally-evaluated expression.
John McCall3ad32c82011-01-28 08:37:24 +0000695 template <class T, class A0>
696 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
697 // If we're not in a conditional branch, or if none of the
698 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000699 if (!isInConditionalBranch())
700 return EHStack.pushCleanup<T>(kind, a0);
John McCall3ad32c82011-01-28 08:37:24 +0000701
John McCall804b8072011-01-28 10:53:53 +0000702 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCall3ad32c82011-01-28 08:37:24 +0000703
704 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
705 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
706 initFullExprCleanup();
707 }
708
709 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
710 /// current full-expression. Safe against the possibility that
711 /// we're currently inside a conditionally-evaluated expression.
John McCall150b4622011-01-26 04:00:11 +0000712 template <class T, class A0, class A1>
713 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
714 // If we're not in a conditional branch, or if none of the
715 // arguments requires saving, then use the unconditional cleanup.
John McCallc4a1a842011-07-12 00:15:30 +0000716 if (!isInConditionalBranch())
717 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCall150b4622011-01-26 04:00:11 +0000718
John McCall804b8072011-01-28 10:53:53 +0000719 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
720 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCall150b4622011-01-26 04:00:11 +0000721
722 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCall3ad32c82011-01-28 08:37:24 +0000723 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
724 initFullExprCleanup();
John McCall150b4622011-01-26 04:00:11 +0000725 }
726
Douglas Gregord7b23162011-06-22 16:12:01 +0000727 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
728 /// current full-expression. Safe against the possibility that
729 /// we're currently inside a conditionally-evaluated expression.
730 template <class T, class A0, class A1, class A2>
731 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
732 // If we're not in a conditional branch, or if none of the
733 // arguments requires saving, then use the unconditional cleanup.
734 if (!isInConditionalBranch()) {
John McCallc4a1a842011-07-12 00:15:30 +0000735 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregord7b23162011-06-22 16:12:01 +0000736 }
737
738 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
739 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
740 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
741
742 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
743 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
744 initFullExprCleanup();
745 }
746
John McCall9928c482011-07-12 16:41:08 +0000747 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
748 /// current full-expression. Safe against the possibility that
749 /// we're currently inside a conditionally-evaluated expression.
750 template <class T, class A0, class A1, class A2, class A3>
751 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
752 // If we're not in a conditional branch, or if none of the
753 // arguments requires saving, then use the unconditional cleanup.
754 if (!isInConditionalBranch()) {
755 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
756 }
757
758 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
759 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
760 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
761 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
762
763 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
764 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
765 a2_saved, a3_saved);
766 initFullExprCleanup();
767 }
768
John McCall6f103ba2011-11-10 10:43:54 +0000769 /// Set up the last cleaup that was pushed as a conditional
770 /// full-expression cleanup.
771 void initFullExprCleanup();
772
John McCallf1549f62010-07-06 01:34:17 +0000773 /// PushDestructorCleanup - Push a cleanup to call the
774 /// complete-object destructor of an object of the given type at the
775 /// given address. Does nothing if T is not a C++ class type with a
776 /// non-trivial destructor.
777 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
778
John McCall81407d42010-07-21 06:29:51 +0000779 /// PushDestructorCleanup - Push a cleanup to call the
780 /// complete-object variant of the given destructor on the object at
781 /// the given address.
782 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
783 llvm::Value *Addr);
784
John McCallf1549f62010-07-06 01:34:17 +0000785 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
786 /// process all branch fixups.
John McCallff8e1152010-07-23 21:56:41 +0000787 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallf1549f62010-07-06 01:34:17 +0000788
John McCall7d8647f2010-09-14 07:57:04 +0000789 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
790 /// The block cannot be reactivated. Pops it if it's the top of the
791 /// stack.
John McCall6f103ba2011-11-10 10:43:54 +0000792 ///
793 /// \param DominatingIP - An instruction which is known to
794 /// dominate the current IP (if set) and which lies along
795 /// all paths of execution between the current IP and the
796 /// the point at which the cleanup comes into scope.
797 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
798 llvm::Instruction *DominatingIP);
John McCall7d8647f2010-09-14 07:57:04 +0000799
800 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
801 /// Cannot be used to resurrect a deactivated cleanup.
John McCall6f103ba2011-11-10 10:43:54 +0000802 ///
803 /// \param DominatingIP - An instruction which is known to
804 /// dominate the current IP (if set) and which lies along
805 /// all paths of execution between the current IP and the
806 /// the point at which the cleanup comes into scope.
807 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
808 llvm::Instruction *DominatingIP);
John McCallcd2d2b72010-08-13 21:20:51 +0000809
John McCallf1549f62010-07-06 01:34:17 +0000810 /// \brief Enters a new scope for capturing cleanups, all of which
811 /// will be executed once the scope is exited.
812 class RunCleanupsScope {
John McCallf1549f62010-07-06 01:34:17 +0000813 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000814 bool OldDidCallStackSave;
John McCalled383132013-03-01 01:24:35 +0000815 protected:
Douglas Gregor5656e142009-11-24 21:15:44 +0000816 bool PerformCleanup;
John McCalled383132013-03-01 01:24:35 +0000817 private:
Douglas Gregor01234bb2009-11-24 16:43:22 +0000818
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000819 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
820 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000821
Eric Christopherc3287792011-10-19 00:43:52 +0000822 protected:
823 CodeGenFunction& CGF;
Will Dietz4f45bc02013-01-18 11:30:38 +0000824
Douglas Gregor01234bb2009-11-24 16:43:22 +0000825 public:
826 /// \brief Enter a new cleanup scope.
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000827 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christopherc3287792011-10-19 00:43:52 +0000828 : PerformCleanup(true), CGF(CGF)
Douglas Gregor5656e142009-11-24 21:15:44 +0000829 {
John McCallf1549f62010-07-06 01:34:17 +0000830 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor01234bb2009-11-24 16:43:22 +0000831 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis4ada2ca2010-09-14 00:42:34 +0000832 CGF.DidCallStackSave = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000833 }
834
835 /// \brief Exit this cleanup scope, emitting any accumulated
836 /// cleanups.
John McCallf1549f62010-07-06 01:34:17 +0000837 ~RunCleanupsScope() {
Douglas Gregor5656e142009-11-24 21:15:44 +0000838 if (PerformCleanup) {
839 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000840 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000841 }
842 }
843
844 /// \brief Determine whether this scope requires any cleanups.
845 bool requiresCleanups() const {
John McCallf1549f62010-07-06 01:34:17 +0000846 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor5656e142009-11-24 21:15:44 +0000847 }
848
849 /// \brief Force the emission of cleanups now, instead of waiting
850 /// until this object is destroyed.
851 void ForceCleanup() {
852 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor01234bb2009-11-24 16:43:22 +0000853 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallf1549f62010-07-06 01:34:17 +0000854 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor5656e142009-11-24 21:15:44 +0000855 PerformCleanup = false;
Douglas Gregor01234bb2009-11-24 16:43:22 +0000856 }
857 };
858
Eric Christopherc3287792011-10-19 00:43:52 +0000859 class LexicalScope: protected RunCleanupsScope {
860 SourceRange Range;
Nadav Rotem495cfa42013-03-23 06:43:35 +0000861 SmallVector<const LabelDecl*, 4> Labels;
862 LexicalScope *ParentScope;
Eric Christopherc3287792011-10-19 00:43:52 +0000863
Dmitri Gribenkof56faa02012-09-15 20:20:27 +0000864 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
865 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christopherc3287792011-10-19 00:43:52 +0000866
867 public:
868 /// \brief Enter a new cleanup scope.
869 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
Nadav Rotem495cfa42013-03-23 06:43:35 +0000870 : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
871 CGF.CurLexicalScope = this;
Eric Christopherc3287792011-10-19 00:43:52 +0000872 if (CGDebugInfo *DI = CGF.getDebugInfo())
873 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
874 }
875
Nadav Rotem495cfa42013-03-23 06:43:35 +0000876 void addLabel(const LabelDecl *label) {
877 assert(PerformCleanup && "adding label to dead scope?");
878 Labels.push_back(label);
879 }
880
Eric Christopherc3287792011-10-19 00:43:52 +0000881 /// \brief Exit this cleanup scope, emitting any accumulated
882 /// cleanups.
883 ~LexicalScope() {
Nadav Rotem495cfa42013-03-23 06:43:35 +0000884 // If we should perform a cleanup, force them now. Note that
885 // this ends the cleanup scope before rescoping any labels.
886 if (PerformCleanup) ForceCleanup();
Eric Christopherc3287792011-10-19 00:43:52 +0000887 }
888
889 /// \brief Force the emission of cleanups now, instead of waiting
890 /// until this object is destroyed.
891 void ForceCleanup() {
892 RunCleanupsScope::ForceCleanup();
John McCall4a68c7b2013-03-01 01:38:54 +0000893 endLexicalScope();
John McCalled383132013-03-01 01:24:35 +0000894 }
895
896 private:
897 void endLexicalScope() {
Nadav Rotem495cfa42013-03-23 06:43:35 +0000898 CGF.CurLexicalScope = ParentScope;
John McCalled383132013-03-01 01:24:35 +0000899 if (CGDebugInfo *DI = CGF.getDebugInfo())
Eric Christopherc3287792011-10-19 00:43:52 +0000900 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
Nadav Rotem495cfa42013-03-23 06:43:35 +0000901 if (!Labels.empty())
902 rescopeLabels();
Eric Christopherc3287792011-10-19 00:43:52 +0000903 }
Nadav Rotem495cfa42013-03-23 06:43:35 +0000904
905 void rescopeLabels();
Eric Christopherc3287792011-10-19 00:43:52 +0000906 };
907
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000908
John McCallf1549f62010-07-06 01:34:17 +0000909 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
910 /// the cleanup blocks that have been added.
911 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlsson44ec82b2010-03-30 03:14:41 +0000912
John McCallff8e1152010-07-23 21:56:41 +0000913 void ResolveBranchFixups(llvm::BasicBlock *Target);
914
John McCallf1549f62010-07-06 01:34:17 +0000915 /// The given basic block lies in the current EH scope, but may be a
916 /// target of a potentially scope-crossing jump; get a stable handle
917 /// to which we can perform this jump later.
John McCallff8e1152010-07-23 21:56:41 +0000918 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCall413e6772010-07-28 01:07:35 +0000919 return JumpDest(Target,
920 EHStack.getInnermostNormalCleanup(),
921 NextCleanupDestIndex++);
John McCallf1549f62010-07-06 01:34:17 +0000922 }
Anders Carlssonc71c8452009-02-07 23:50:39 +0000923
John McCallf1549f62010-07-06 01:34:17 +0000924 /// The given basic block lies in the current EH scope, but may be a
925 /// target of a potentially scope-crossing jump; get a stable handle
926 /// to which we can perform this jump later.
Chris Lattner686775d2011-07-20 06:58:45 +0000927 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallff8e1152010-07-23 21:56:41 +0000928 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallf1549f62010-07-06 01:34:17 +0000929 }
930
931 /// EmitBranchThroughCleanup - Emit a branch from the current insert
932 /// block through the normal cleanup handling code (if any) and then
933 /// on to \arg Dest.
934 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerb11f9192011-04-17 00:54:30 +0000935
936 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
937 /// specified destination obviously has no cleanups to run. 'false' is always
938 /// a conservatively correct answer for this method.
939 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallf1549f62010-07-06 01:34:17 +0000940
John McCall777d6e52011-08-11 02:22:43 +0000941 /// popCatchScope - Pops the catch scope at the top of the EHScope
942 /// stack, emitting any required code (other than the catch handlers
943 /// themselves).
944 void popCatchScope();
John McCallff8e1152010-07-23 21:56:41 +0000945
David Chisnallc6860042012-11-07 16:50:40 +0000946 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall777d6e52011-08-11 02:22:43 +0000947 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stump0dd9e882009-02-08 23:14:22 +0000948
John McCall150b4622011-01-26 04:00:11 +0000949 /// An object to manage conditionally-evaluated expressions.
950 class ConditionalEvaluation {
951 llvm::BasicBlock *StartBB;
Mike Stump1eb44332009-09-09 15:08:12 +0000952
John McCall150b4622011-01-26 04:00:11 +0000953 public:
954 ConditionalEvaluation(CodeGenFunction &CGF)
955 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencer9cac4942010-10-19 06:39:39 +0000956
John McCall150b4622011-01-26 04:00:11 +0000957 void begin(CodeGenFunction &CGF) {
958 assert(CGF.OutermostConditional != this);
959 if (!CGF.OutermostConditional)
960 CGF.OutermostConditional = this;
961 }
962
963 void end(CodeGenFunction &CGF) {
964 assert(CGF.OutermostConditional != 0);
965 if (CGF.OutermostConditional == this)
966 CGF.OutermostConditional = 0;
967 }
968
969 /// Returns a block which will be executed prior to each
970 /// evaluation of the conditional code.
971 llvm::BasicBlock *getStartingBlock() const {
972 return StartBB;
973 }
974 };
Mike Stump1eb44332009-09-09 15:08:12 +0000975
John McCall3019c442010-09-17 00:50:28 +0000976 /// isInConditionalBranch - Return true if we're currently emitting
977 /// one branch or the other of a conditional expression.
John McCall150b4622011-01-26 04:00:11 +0000978 bool isInConditionalBranch() const { return OutermostConditional != 0; }
979
John McCall6f103ba2011-11-10 10:43:54 +0000980 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
981 assert(isInConditionalBranch());
982 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
983 new llvm::StoreInst(value, addr, &block->back());
984 }
985
John McCall150b4622011-01-26 04:00:11 +0000986 /// An RAII object to record that we're evaluating a statement
987 /// expression.
988 class StmtExprEvaluation {
989 CodeGenFunction &CGF;
990
991 /// We have to save the outermost conditional: cleanups in a
992 /// statement expression aren't conditional just because the
993 /// StmtExpr is.
994 ConditionalEvaluation *SavedOutermostConditional;
995
996 public:
997 StmtExprEvaluation(CodeGenFunction &CGF)
998 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
999 CGF.OutermostConditional = 0;
1000 }
1001
1002 ~StmtExprEvaluation() {
1003 CGF.OutermostConditional = SavedOutermostConditional;
1004 CGF.EnsureInsertPoint();
1005 }
1006 };
John McCalle996ffd2011-02-16 08:02:54 +00001007
John McCall56ca35d2011-02-17 10:25:35 +00001008 /// An object which temporarily prevents a value from being
1009 /// destroyed by aggressive peephole optimizations that assume that
1010 /// all uses of a value have been realized in the IR.
1011 class PeepholeProtection {
1012 llvm::Instruction *Inst;
1013 friend class CodeGenFunction;
1014
1015 public:
1016 PeepholeProtection() : Inst(0) {}
John McCall4b9c2d22011-11-06 09:01:30 +00001017 };
John McCall56ca35d2011-02-17 10:25:35 +00001018
John McCall4b9c2d22011-11-06 09:01:30 +00001019 /// A non-RAII class containing all the information about a bound
1020 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1021 /// this which makes individual mappings very simple; using this
1022 /// class directly is useful when you have a variable number of
1023 /// opaque values or don't want the RAII functionality for some
1024 /// reason.
1025 class OpaqueValueMappingData {
John McCalle996ffd2011-02-16 08:02:54 +00001026 const OpaqueValueExpr *OpaqueValue;
John McCall56ca35d2011-02-17 10:25:35 +00001027 bool BoundLValue;
1028 CodeGenFunction::PeepholeProtection Protection;
John McCalle996ffd2011-02-16 08:02:54 +00001029
John McCall4b9c2d22011-11-06 09:01:30 +00001030 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1031 bool boundLValue)
1032 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCalle996ffd2011-02-16 08:02:54 +00001033 public:
John McCall4b9c2d22011-11-06 09:01:30 +00001034 OpaqueValueMappingData() : OpaqueValue(0) {}
1035
John McCall56ca35d2011-02-17 10:25:35 +00001036 static bool shouldBindAsLValue(const Expr *expr) {
John McCalla5493f82011-11-08 22:54:08 +00001037 // gl-values should be bound as l-values for obvious reasons.
1038 // Records should be bound as l-values because IR generation
1039 // always keeps them in memory. Expressions of function type
1040 // act exactly like l-values but are formally required to be
1041 // r-values in C.
1042 return expr->isGLValue() ||
1043 expr->getType()->isRecordType() ||
1044 expr->getType()->isFunctionType();
John McCall56ca35d2011-02-17 10:25:35 +00001045 }
1046
John McCall4b9c2d22011-11-06 09:01:30 +00001047 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1048 const OpaqueValueExpr *ov,
1049 const Expr *e) {
1050 if (shouldBindAsLValue(ov))
1051 return bind(CGF, ov, CGF.EmitLValue(e));
1052 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1053 }
1054
1055 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1056 const OpaqueValueExpr *ov,
1057 const LValue &lv) {
1058 assert(shouldBindAsLValue(ov));
1059 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1060 return OpaqueValueMappingData(ov, true);
1061 }
1062
1063 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1064 const OpaqueValueExpr *ov,
1065 const RValue &rv) {
1066 assert(!shouldBindAsLValue(ov));
1067 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1068
1069 OpaqueValueMappingData data(ov, false);
1070
1071 // Work around an extremely aggressive peephole optimization in
1072 // EmitScalarConversion which assumes that all other uses of a
1073 // value are extant.
1074 data.Protection = CGF.protectFromPeepholes(rv);
1075
1076 return data;
1077 }
1078
1079 bool isValid() const { return OpaqueValue != 0; }
1080 void clear() { OpaqueValue = 0; }
1081
1082 void unbind(CodeGenFunction &CGF) {
1083 assert(OpaqueValue && "no data to unbind!");
1084
1085 if (BoundLValue) {
1086 CGF.OpaqueLValues.erase(OpaqueValue);
1087 } else {
1088 CGF.OpaqueRValues.erase(OpaqueValue);
1089 CGF.unprotectFromPeepholes(Protection);
1090 }
1091 }
1092 };
1093
1094 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1095 class OpaqueValueMapping {
1096 CodeGenFunction &CGF;
1097 OpaqueValueMappingData Data;
1098
1099 public:
1100 static bool shouldBindAsLValue(const Expr *expr) {
1101 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1102 }
1103
John McCall56ca35d2011-02-17 10:25:35 +00001104 /// Build the opaque value mapping for the given conditional
1105 /// operator if it's the GNU ?: extension. This is a common
1106 /// enough pattern that the convenience operator is really
1107 /// helpful.
1108 ///
1109 OpaqueValueMapping(CodeGenFunction &CGF,
1110 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCall4b9c2d22011-11-06 09:01:30 +00001111 if (isa<ConditionalOperator>(op))
1112 // Leave Data empty.
John McCall56ca35d2011-02-17 10:25:35 +00001113 return;
John McCall56ca35d2011-02-17 10:25:35 +00001114
1115 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCall4b9c2d22011-11-06 09:01:30 +00001116 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1117 e->getCommon());
John McCall56ca35d2011-02-17 10:25:35 +00001118 }
1119
John McCalle996ffd2011-02-16 08:02:54 +00001120 OpaqueValueMapping(CodeGenFunction &CGF,
1121 const OpaqueValueExpr *opaqueValue,
John McCall56ca35d2011-02-17 10:25:35 +00001122 LValue lvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001123 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCall56ca35d2011-02-17 10:25:35 +00001124 }
1125
1126 OpaqueValueMapping(CodeGenFunction &CGF,
1127 const OpaqueValueExpr *opaqueValue,
1128 RValue rvalue)
John McCall4b9c2d22011-11-06 09:01:30 +00001129 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCalle996ffd2011-02-16 08:02:54 +00001130 }
1131
1132 void pop() {
John McCall4b9c2d22011-11-06 09:01:30 +00001133 Data.unbind(CGF);
1134 Data.clear();
John McCalle996ffd2011-02-16 08:02:54 +00001135 }
1136
1137 ~OpaqueValueMapping() {
John McCall4b9c2d22011-11-06 09:01:30 +00001138 if (Data.isValid()) Data.unbind(CGF);
John McCalle996ffd2011-02-16 08:02:54 +00001139 }
1140 };
Fariborz Jahaniane2204552010-11-16 19:29:39 +00001141
1142 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1143 /// number that holds the value.
1144 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian52a80e12011-01-26 23:08:27 +00001145
1146 /// BuildBlockByrefAddress - Computes address location of the
1147 /// variable which is declared as __block.
1148 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1149 const VarDecl *V);
Chris Lattner7f02f722007-08-24 05:35:26 +00001150private:
Chris Lattnerd9becd12009-10-28 23:59:40 +00001151 CGDebugInfo *DebugInfo;
Devang Patelaa112892011-03-07 18:45:56 +00001152 bool DisableDebugInfo;
Mike Stump09429b92009-02-17 17:00:02 +00001153
Manman Ren63fd4082013-03-20 16:59:38 +00001154 /// If the current function returns 'this', use the field to keep track of
1155 /// the callee that returns 'this'.
1156 llvm::Value *CalleeWithThisReturn;
1157
John McCall93c332a2011-05-28 21:13:02 +00001158 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1159 /// calling llvm.stacksave for multiple VLAs in the same scope.
1160 bool DidCallStackSave;
1161
Mike Stumpf71d2322009-11-30 20:08:49 +00001162 /// IndirectBranch - The first time an indirect goto is seen we create a block
1163 /// with an indirect branch. Every time we see the address of a label taken,
1164 /// we add the label to the indirect goto. Every subsequent indirect goto is
1165 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattnerd9becd12009-10-28 23:59:40 +00001166 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001167
Mike Stump0dd9e882009-02-08 23:14:22 +00001168 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1169 /// decls.
John McCall6b5a61b2011-02-07 10:33:21 +00001170 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1171 DeclMapTy LocalDeclMap;
Reid Spencer5f016e22007-07-11 17:01:13 +00001172
1173 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001174 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001175
Mike Stump0dd9e882009-02-08 23:14:22 +00001176 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone4b6d342009-02-10 05:52:02 +00001177 // statements should jump to.
Chris Lattnerda138702007-07-16 21:28:45 +00001178 struct BreakContinue {
John McCallf1549f62010-07-06 01:34:17 +00001179 BreakContinue(JumpDest Break, JumpDest Continue)
1180 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stump0dd9e882009-02-08 23:14:22 +00001181
John McCallf1549f62010-07-06 01:34:17 +00001182 JumpDest BreakBlock;
1183 JumpDest ContinueBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001184 };
Chris Lattner686775d2011-07-20 06:58:45 +00001185 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +00001186
Zhongxing Xu170fd492012-01-14 09:08:15 +00001187 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stump0dd9e882009-02-08 23:14:22 +00001188 /// current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +00001189 llvm::SwitchInst *SwitchInsn;
1190
Mike Stump0dd9e882009-02-08 23:14:22 +00001191 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel80fd5f92007-10-09 17:08:50 +00001192 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +00001193 llvm::BasicBlock *CaseRangeBlock;
1194
John McCall56ca35d2011-02-17 10:25:35 +00001195 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCalle996ffd2011-02-16 08:02:54 +00001196 /// expressions.
John McCall56ca35d2011-02-17 10:25:35 +00001197 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1198 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCalle996ffd2011-02-16 08:02:54 +00001199
Mike Stump0dd9e882009-02-08 23:14:22 +00001200 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001201 // We track this by the size expression rather than the type itself because
1202 // in certain situations, like a const qualifier applied to an VLA typedef,
1203 // multiple VLA types can share the same size expression.
Mike Stump0dd9e882009-02-08 23:14:22 +00001204 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1205 // enter/leave scopes.
Eli Friedmanbbed6b92009-08-15 02:50:32 +00001206 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stump0dd9e882009-02-08 23:14:22 +00001207
John McCallf1549f62010-07-06 01:34:17 +00001208 /// A block containing a single 'unreachable' instruction. Created
1209 /// lazily by getUnreachableBlock().
1210 llvm::BasicBlock *UnreachableBlock;
Mike Stump0dd9e882009-02-08 23:14:22 +00001211
Anders Carlssonf6c56e22009-11-25 03:15:49 +00001212 /// CXXThisDecl - When generating code for a C++ member function,
1213 /// this will hold the implicit 'this' declaration.
Eli Friedmancec5ebd2012-02-11 02:57:39 +00001214 ImplicitParamDecl *CXXABIThisDecl;
1215 llvm::Value *CXXABIThisValue;
John McCall25049412010-02-16 22:04:33 +00001216 llvm::Value *CXXThisValue;
Mike Stump1eb44332009-09-09 15:08:12 +00001217
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001218 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1219 /// destructor, this will hold the implicit argument (e.g. VTT).
1220 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1221 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001222
John McCall150b4622011-01-26 04:00:11 +00001223 /// OutermostConditional - Points to the outermost active
1224 /// conditional control. This is used so that we know if a
1225 /// temporary should be destroyed conditionally.
1226 ConditionalEvaluation *OutermostConditional;
Mike Stump1eb44332009-09-09 15:08:12 +00001227
Nadav Rotem495cfa42013-03-23 06:43:35 +00001228 /// The current lexical scope.
1229 LexicalScope *CurLexicalScope;
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001230
1231 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1232 /// type as well as the field number that contains the actual data.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001233 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson7dfa4072009-09-12 02:14:24 +00001234 unsigned> > ByRefValueInfo;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001235
John McCallf1549f62010-07-06 01:34:17 +00001236 llvm::BasicBlock *TerminateLandingPad;
Mike Stump182f3832009-12-10 00:02:42 +00001237 llvm::BasicBlock *TerminateHandler;
Chris Lattner83252dc2010-07-20 21:07:09 +00001238 llvm::BasicBlock *TrapBB;
Eli Friedman94067052009-12-10 02:21:21 +00001239
Tanya Lattner0df579e2012-07-09 22:06:01 +00001240 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1241 /// In the kernel metadata node, reference the kernel function and metadata
1242 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Gouly37453b92013-03-08 09:42:32 +00001243 /// - A node for the vec_type_hint(<type>) qualifier contains string
1244 /// "vec_type_hint", an undefined value of the <type> data type,
1245 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattner0df579e2012-07-09 22:06:01 +00001246 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1247 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1248 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1249 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1250 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1251 llvm::Function *Fn);
1252
Reid Spencer5f016e22007-07-11 17:01:13 +00001253public:
Fariborz Jahanian4904bf42012-06-26 16:06:38 +00001254 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall1a343eb2011-11-10 08:15:53 +00001255 ~CodeGenFunction();
Mike Stump0dd9e882009-02-08 23:14:22 +00001256
John McCall1e7fe752010-09-02 09:58:18 +00001257 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCallf2aac842011-05-15 02:34:36 +00001258 ASTContext &getContext() const { return CGM.getContext(); }
Alexey Samsonova240df22012-10-16 07:22:28 +00001259 /// Returns true if DebugInfo is actually initialized.
1260 bool maybeInitializeDebugInfo() {
1261 if (CGM.getModuleDebugInfo()) {
1262 DebugInfo = CGM.getModuleDebugInfo();
1263 return true;
1264 }
1265 return false;
1266 }
Devang Patelaa112892011-03-07 18:45:56 +00001267 CGDebugInfo *getDebugInfo() {
1268 if (DisableDebugInfo)
1269 return NULL;
1270 return DebugInfo;
1271 }
1272 void disableDebugInfo() { DisableDebugInfo = true; }
1273 void enableDebugInfo() { DisableDebugInfo = false; }
1274
John McCallf85e1932011-06-15 23:02:42 +00001275 bool shouldUseFusedARCCalls() {
1276 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1277 }
Reid Spencer5f016e22007-07-11 17:01:13 +00001278
David Blaikie4e4d0842012-03-11 07:00:24 +00001279 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCalld16c2cf2011-02-08 08:22:06 +00001280
Bill Wendling285cfd82011-09-19 20:31:14 +00001281 /// Returns a pointer to the function's exception object and selector slot,
1282 /// which is assigned in every landing pad.
John McCallf1549f62010-07-06 01:34:17 +00001283 llvm::Value *getExceptionSlot();
John McCall93c332a2011-05-28 21:13:02 +00001284 llvm::Value *getEHSelectorSlot();
John McCallf1549f62010-07-06 01:34:17 +00001285
Bill Wendlingae270592011-09-15 18:57:19 +00001286 /// Returns the contents of the function's exception object and selector
1287 /// slots.
1288 llvm::Value *getExceptionFromSlot();
1289 llvm::Value *getSelectorFromSlot();
1290
John McCallff8e1152010-07-23 21:56:41 +00001291 llvm::Value *getNormalCleanupDestSlot();
John McCallff8e1152010-07-23 21:56:41 +00001292
John McCallf1549f62010-07-06 01:34:17 +00001293 llvm::BasicBlock *getUnreachableBlock() {
1294 if (!UnreachableBlock) {
1295 UnreachableBlock = createBasicBlock("unreachable");
1296 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1297 }
1298 return UnreachableBlock;
1299 }
1300
1301 llvm::BasicBlock *getInvokeDest() {
1302 if (!EHStack.requiresLandingPad()) return 0;
1303 return getInvokeDestImpl();
1304 }
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001305
John McCalld16c2cf2011-02-08 08:22:06 +00001306 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Anderson69243822009-07-13 04:10:07 +00001307
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001308 //===--------------------------------------------------------------------===//
John McCallbdc4d802011-07-09 01:37:26 +00001309 // Cleanups
1310 //===--------------------------------------------------------------------===//
1311
1312 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1313
John McCall2673c682011-07-11 08:38:19 +00001314 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1315 llvm::Value *arrayEndPointer,
1316 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001317 Destroyer *destroyer);
John McCall2673c682011-07-11 08:38:19 +00001318 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1319 llvm::Value *arrayEnd,
1320 QualType elementType,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001321 Destroyer *destroyer);
John McCallbdc4d802011-07-09 01:37:26 +00001322
John McCall9928c482011-07-12 16:41:08 +00001323 void pushDestroy(QualType::DestructionKind dtorKind,
1324 llvm::Value *addr, QualType type);
John McCall074cae02013-02-01 05:11:40 +00001325 void pushEHDestroy(QualType::DestructionKind dtorKind,
1326 llvm::Value *addr, QualType type);
John McCallbdc4d802011-07-09 01:37:26 +00001327 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001328 Destroyer *destroyer, bool useEHCleanupForArray);
1329 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall2673c682011-07-11 08:38:19 +00001330 bool useEHCleanupForArray);
John McCalla91f6662011-07-13 03:01:35 +00001331 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1332 QualType type,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001333 Destroyer *destroyer,
John McCalla91f6662011-07-13 03:01:35 +00001334 bool useEHCleanupForArray);
John McCallbdc4d802011-07-09 01:37:26 +00001335 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001336 QualType type, Destroyer *destroyer,
John McCallfbf780a2011-07-13 08:09:46 +00001337 bool checkZeroLength, bool useEHCleanup);
John McCallbdc4d802011-07-09 01:37:26 +00001338
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001339 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall9928c482011-07-12 16:41:08 +00001340
John McCallbdc4d802011-07-09 01:37:26 +00001341 /// Determines whether an EH cleanup is required to destroy a type
1342 /// with the given destruction kind.
1343 bool needsEHCleanup(QualType::DestructionKind kind) {
1344 switch (kind) {
1345 case QualType::DK_none:
1346 return false;
1347 case QualType::DK_cxx_destructor:
1348 case QualType::DK_objc_weak_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001349 return getLangOpts().Exceptions;
John McCallbdc4d802011-07-09 01:37:26 +00001350 case QualType::DK_objc_strong_lifetime:
David Blaikie4e4d0842012-03-11 07:00:24 +00001351 return getLangOpts().Exceptions &&
John McCallbdc4d802011-07-09 01:37:26 +00001352 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1353 }
1354 llvm_unreachable("bad destruction kind");
1355 }
1356
John McCall9928c482011-07-12 16:41:08 +00001357 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1358 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1359 }
1360
John McCallbdc4d802011-07-09 01:37:26 +00001361 //===--------------------------------------------------------------------===//
Daniel Dunbar9834ffb2009-02-23 17:26:39 +00001362 // Objective-C
1363 //===--------------------------------------------------------------------===//
1364
Chris Lattner391d77a2008-03-30 23:03:07 +00001365 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001366
Mike Stump0dd9e882009-02-08 23:14:22 +00001367 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patel8d3f8972011-05-19 23:37:41 +00001368 const ObjCContainerDecl *CD,
1369 SourceLocation StartLoc);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001370
Mike Stump0dd9e882009-02-08 23:14:22 +00001371 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001372 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1373 const ObjCPropertyImplDecl *PID);
John McCall1e1f4872011-09-13 03:34:09 +00001374 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001375 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanian490a52b2012-05-29 19:56:01 +00001376 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001377 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian2846b972011-02-18 19:15:13 +00001378
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001379 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1380 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001381
Mike Stump0dd9e882009-02-08 23:14:22 +00001382 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1383 /// for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001384 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1385 const ObjCPropertyImplDecl *PID);
John McCall71c758d2011-09-10 09:17:20 +00001386 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001387 const ObjCPropertyImplDecl *propImpl,
1388 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001389 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001390 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001391
Mike Stump4e7a1f72009-02-21 20:00:35 +00001392 //===--------------------------------------------------------------------===//
1393 // Block Bits
1394 //===--------------------------------------------------------------------===//
1395
John McCall6b5a61b2011-02-07 10:33:21 +00001396 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall1a343eb2011-11-10 08:15:53 +00001397 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1398 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garst2a7eb282010-02-23 21:51:17 +00001399 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00001400 const CGBlockInfo &Info,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001401 llvm::StructType *,
John McCalld16c2cf2011-02-08 08:22:06 +00001402 llvm::Constant *BlockVarLayout);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001403
Fariborz Jahanian564360b2010-06-24 00:08:06 +00001404 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall6b5a61b2011-02-07 10:33:21 +00001405 const CGBlockInfo &Info,
Mike Stump6cc88f72009-03-20 21:53:12 +00001406 const Decl *OuterFuncDecl,
Eli Friedman64bee652012-02-25 02:48:22 +00001407 const DeclMapTy &ldm,
1408 bool IsLambdaConversionToBlock);
Mike Stump4e7a1f72009-02-21 20:00:35 +00001409
John McCalld16c2cf2011-02-08 08:22:06 +00001410 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1411 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00001412 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1413 const ObjCPropertyImplDecl *PID);
1414 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1415 const ObjCPropertyImplDecl *PID);
Eli Friedmancae40c42012-02-28 01:08:45 +00001416 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCalld16c2cf2011-02-08 08:22:06 +00001417
John McCalld16c2cf2011-02-08 08:22:06 +00001418 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1419
John McCall5af02db2011-03-31 01:59:53 +00001420 class AutoVarEmission;
1421
1422 void emitByrefStructureInit(const AutoVarEmission &emission);
1423 void enterByrefCleanup(const AutoVarEmission &emission);
1424
John McCall6b5a61b2011-02-07 10:33:21 +00001425 llvm::Value *LoadBlockStruct() {
1426 assert(BlockPointer && "no block pointer set!");
1427 return BlockPointer;
1428 }
Mike Stump4e7a1f72009-02-21 20:00:35 +00001429
John McCallea1471e2010-05-20 01:18:31 +00001430 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCallf4b88a42012-03-10 09:33:50 +00001431 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall6b5a61b2011-02-07 10:33:21 +00001432 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001433 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stumpdab514f2009-03-04 03:23:46 +00001434
John McCalld26bc762011-03-09 04:27:21 +00001435 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1436 const CGFunctionInfo &FnInfo);
Anders Carlsson0ff8baf2009-09-11 00:07:24 +00001437 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbar7c086512008-09-09 23:14:03 +00001438 llvm::Function *Fn,
John McCalld26bc762011-03-09 04:27:21 +00001439 const CGFunctionInfo &FnInfo,
Daniel Dunbar2284ac92008-10-18 18:22:23 +00001440 const FunctionArgList &Args,
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00001441 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +00001442
John McCall9fc6a772010-02-19 09:25:03 +00001443 void EmitConstructorBody(FunctionArgList &Args);
1444 void EmitDestructorBody(FunctionArgList &Args);
Lang Hames56c00c42013-02-17 07:22:09 +00001445 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
John McCall9fc6a772010-02-19 09:25:03 +00001446 void EmitFunctionBody(FunctionArgList &Args);
John McCalla355e072010-02-18 03:17:58 +00001447
Eli Friedman64bee652012-02-25 02:48:22 +00001448 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1449 CallArgList &CallArgs);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001450 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman64bee652012-02-25 02:48:22 +00001451 void EmitLambdaBlockInvokeBody();
Douglas Gregor27dd7d92012-02-17 03:02:34 +00001452 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1453 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Eli Friedmanbd89f8c2012-02-16 01:37:33 +00001454
Mike Stump0dd9e882009-02-08 23:14:22 +00001455 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1456 /// emission when possible.
David Blaikie0a0f93c2013-02-01 19:09:49 +00001457 void EmitReturnBlock();
Daniel Dunbar1c1d6072009-01-26 23:27:52 +00001458
Mike Stump0dd9e882009-02-08 23:14:22 +00001459 /// FinishFunction - Complete IR generation of the current function. It is
1460 /// legal to call this function even if there is no current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001461 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001462
Anders Carlsson519c3282010-03-24 00:39:18 +00001463 /// GenerateThunk - Generate a thunk for the given method.
John McCalld26bc762011-03-09 04:27:21 +00001464 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1465 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001466
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00001467 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1468 GlobalDecl GD, const ThunkInfo &Thunk);
1469
Douglas Gregorfb8cc252010-05-05 05:51:00 +00001470 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1471 FunctionArgList &Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001472
Eli Friedmanb74ed082012-02-14 02:31:03 +00001473 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1474 ArrayRef<VarDecl *> ArrayIndexes);
1475
Anders Carlssond103f9f2010-03-28 19:40:00 +00001476 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1477 /// subobject.
1478 ///
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001479 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001480 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001481 CharUnits OffsetFromNearestVBase,
Anders Carlssond103f9f2010-03-28 19:40:00 +00001482 llvm::Constant *VTable,
1483 const CXXRecordDecl *VTableClass);
1484
1485 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001486 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlssonb3b772e2010-04-20 05:22:15 +00001487 const CXXRecordDecl *NearestVBase,
Ken Dyckd6fb21f2011-03-23 01:04:18 +00001488 CharUnits OffsetFromNearestVBase,
Anders Carlsson603d6d12010-03-28 21:07:49 +00001489 bool BaseIsNonVirtualPrimaryBase,
1490 llvm::Constant *VTable,
1491 const CXXRecordDecl *VTableClass,
1492 VisitedVirtualBasesSetTy& VBases);
Eli Friedman77a259c2009-12-08 06:46:18 +00001493
Anders Carlsson603d6d12010-03-28 21:07:49 +00001494 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001495
Dan Gohman043fb9a2010-10-26 18:44:08 +00001496 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1497 /// to by This.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001498 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssond103f9f2010-03-28 19:40:00 +00001499
John McCall50da2ca2010-07-21 05:30:47 +00001500 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1501 /// given phase of destruction for a destructor. The end result
1502 /// should call destructors on members and base classes in reverse
1503 /// order of their construction.
1504 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001505
Chris Lattner7255a2d2010-06-22 00:03:40 +00001506 /// ShouldInstrumentFunction - Return true if the current function should be
1507 /// instrumented with __cyg_profile_func_* calls
1508 bool ShouldInstrumentFunction();
1509
1510 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1511 /// instrumentation function with the current function and the call site, if
1512 /// function instrumentation is enabled.
1513 void EmitFunctionInstrumentation(const char *Fn);
1514
Roman Divackybe4c8702011-02-10 16:52:03 +00001515 /// EmitMCountInstrumentation - Emit call to .mcount.
1516 void EmitMCountInstrumentation();
1517
Mike Stump0dd9e882009-02-08 23:14:22 +00001518 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1519 /// arguments for the given function. This is also responsible for naming the
1520 /// LLVM function arguments.
Daniel Dunbar88b53962009-02-02 22:03:45 +00001521 void EmitFunctionProlog(const CGFunctionInfo &FI,
1522 llvm::Function *Fn,
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001523 const FunctionArgList &Args);
1524
Mike Stump0dd9e882009-02-08 23:14:22 +00001525 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1526 /// given temporary.
Chris Lattner35b21b82010-06-27 01:06:27 +00001527 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar17b708d2008-09-09 23:27:19 +00001528
Mike Stumpcce3d4f2009-12-07 23:38:24 +00001529 /// EmitStartEHSpec - Emit the start of the exception spec.
1530 void EmitStartEHSpec(const Decl *D);
1531
1532 /// EmitEndEHSpec - Emit the end of the exception spec.
1533 void EmitEndEHSpec(const Decl *D);
1534
John McCallf1549f62010-07-06 01:34:17 +00001535 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1536 llvm::BasicBlock *getTerminateLandingPad();
1537
1538 /// getTerminateHandler - Return a handler (not a landing pad, just
1539 /// a catch handler) that just calls terminate. This is used when
1540 /// a terminate scope encloses a try.
Mike Stump9b39c512009-12-09 22:59:31 +00001541 llvm::BasicBlock *getTerminateHandler();
1542
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001543 llvm::Type *ConvertTypeForMem(QualType T);
1544 llvm::Type *ConvertType(QualType T);
1545 llvm::Type *ConvertType(const TypeDecl *T) {
John McCallbff225e2010-02-16 04:15:37 +00001546 return ConvertType(getContext().getTypeDeclType(T));
1547 }
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001548
Mike Stump0dd9e882009-02-08 23:14:22 +00001549 /// LoadObjCSelf - Load the value of self. This function is only valid while
1550 /// generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +00001551 llvm::Value *LoadObjCSelf();
Mike Stump0dd9e882009-02-08 23:14:22 +00001552
1553 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001554 QualType TypeOfSelfObject();
Chris Lattner41110242008-06-17 18:05:57 +00001555
Reid Spencer5f016e22007-07-11 17:01:13 +00001556 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1557 /// an aggregate LLVM type or is void.
John McCall9d232c82013-03-07 21:37:08 +00001558 static TypeEvaluationKind getEvaluationKind(QualType T);
1559
1560 static bool hasScalarEvaluationKind(QualType T) {
1561 return getEvaluationKind(T) == TEK_Scalar;
1562 }
1563
1564 static bool hasAggregateEvaluationKind(QualType T) {
1565 return getEvaluationKind(T) == TEK_Aggregate;
1566 }
Daniel Dunbar55e87422008-11-11 02:29:29 +00001567
1568 /// createBasicBlock - Create an LLVM basic block.
Richard Smith4def70d2012-10-09 19:52:38 +00001569 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
John McCalld16c2cf2011-02-08 08:22:06 +00001570 llvm::Function *parent = 0,
1571 llvm::BasicBlock *before = 0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001572#ifdef NDEBUG
John McCalld16c2cf2011-02-08 08:22:06 +00001573 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001574#else
John McCalld16c2cf2011-02-08 08:22:06 +00001575 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar29ea6722008-11-12 00:01:12 +00001576#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +00001577 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001578
Reid Spencer5f016e22007-07-11 17:01:13 +00001579 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1580 /// label maps to.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001581 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stump0dd9e882009-02-08 23:14:22 +00001582
Mike Stumpf71d2322009-11-30 20:08:49 +00001583 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1584 /// another basic block, simplify it. This assumes that no other code could
1585 /// potentially reference the basic block.
Daniel Dunbaraa5bd872009-04-01 04:37:47 +00001586 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1587
Mike Stump0dd9e882009-02-08 23:14:22 +00001588 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1589 /// adding a fall-through branch from the current insert block if
1590 /// necessary. It is legal to call this function even if there is no current
1591 /// insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001592 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001593 /// IsFinished - If true, indicates that the caller has finished emitting
1594 /// branches to the given block and does not expect to emit code into it. This
1595 /// means the block can be ignored if it is unreachable.
Daniel Dunbara0c21a82008-11-13 01:24:05 +00001596 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +00001597
John McCall777d6e52011-08-11 02:22:43 +00001598 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1599 /// near its uses, and leave the insertion point in it.
1600 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1601
Mike Stump0dd9e882009-02-08 23:14:22 +00001602 /// EmitBranch - Emit a branch to the specified basic block from the current
1603 /// insert block, taking care to avoid creation of branches from dummy
1604 /// blocks. It is legal to call this function even if there is no current
1605 /// insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +00001606 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00001607 /// This function clears the current insertion point. The caller should follow
1608 /// calls to this function with calls to Emit*Block prior to generation new
1609 /// code.
Daniel Dunbard57a8712008-11-11 09:41:28 +00001610 void EmitBranch(llvm::BasicBlock *Block);
1611
Mike Stump0dd9e882009-02-08 23:14:22 +00001612 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1613 /// indicates that the current code being emitted is unreachable.
1614 bool HaveInsertPoint() const {
Daniel Dunbara448fb22008-11-11 23:11:34 +00001615 return Builder.GetInsertBlock() != 0;
1616 }
1617
Mike Stump0dd9e882009-02-08 23:14:22 +00001618 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1619 /// emitted IR has a place to go. Note that by definition, if this function
1620 /// creates a block then that block is unreachable; callers may do better to
1621 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbara448fb22008-11-11 23:11:34 +00001622 void EnsureInsertPoint() {
1623 if (!HaveInsertPoint())
1624 EmitBlock(createBasicBlock());
1625 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001626
Daniel Dunbar488e9932008-08-16 00:56:44 +00001627 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +00001628 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +00001629 void ErrorUnsupported(const Stmt *S, const char *Type,
1630 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +00001631
1632 //===--------------------------------------------------------------------===//
1633 // Helpers
1634 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001635
Eli Friedman6da2c712011-12-03 04:14:32 +00001636 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1637 CharUnits Alignment = CharUnits()) {
Dan Gohman3d5aff52010-10-14 23:06:10 +00001638 return LValue::MakeAddr(V, T, Alignment, getContext(),
1639 CGM.getTBAAInfo(T));
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001640 }
John McCalle0c11682012-07-02 23:58:38 +00001641
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001642 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedman6da2c712011-12-03 04:14:32 +00001643 CharUnits Alignment;
1644 if (!T->isIncompleteType())
1645 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedman2f77b3d2011-11-16 00:42:57 +00001646 return LValue::MakeAddr(V, T, Alignment, getContext(),
1647 CGM.getTBAAInfo(T));
1648 }
Daniel Dunbar5cf8bfe2010-08-21 02:53:44 +00001649
Reid Spencer5f016e22007-07-11 17:01:13 +00001650 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbar195337d2010-02-09 02:48:28 +00001651 /// block. The caller is responsible for setting an appropriate alignment on
1652 /// the alloca.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001653 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner8cc488f2011-07-20 07:06:53 +00001654 const Twine &Name = "tmp");
Mike Stump0dd9e882009-02-08 23:14:22 +00001655
John McCallac418162010-04-22 01:10:34 +00001656 /// InitTempAlloca - Provide an initial value for the given alloca.
1657 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1658
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001659 /// CreateIRTemp - Create a temporary IR object of the given type, with
1660 /// appropriate alignment. This routine should only be used when an temporary
1661 /// value needs to be stored into an alloca (for example, to avoid explicit
1662 /// PHI construction), but the type is the IR type, not the type appropriate
1663 /// for storing in memory.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001664 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar9bd4da22010-02-16 19:44:13 +00001665
Daniel Dunbar195337d2010-02-09 02:48:28 +00001666 /// CreateMemTemp - Create a temporary memory object of the given type, with
1667 /// appropriate alignment.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001668 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbar195337d2010-02-09 02:48:28 +00001669
John McCall558d2ab2010-09-15 10:14:12 +00001670 /// CreateAggTemp - Create a temporary memory object for the given
1671 /// aggregate type.
Chris Lattner8cc488f2011-07-20 07:06:53 +00001672 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedmand7722d92011-12-03 02:13:40 +00001673 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanf3940782011-12-03 00:54:26 +00001674 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1675 T.getQualifiers(),
John McCall7c2349b2011-08-25 20:40:09 +00001676 AggValueSlot::IsNotDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001677 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00001678 AggValueSlot::IsNotAliased);
John McCall558d2ab2010-09-15 10:14:12 +00001679 }
1680
John McCalld16c2cf2011-02-08 08:22:06 +00001681 /// Emit a cast to void* in the appropriate address space.
1682 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1683
Reid Spencer5f016e22007-07-11 17:01:13 +00001684 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1685 /// expression and compare the result against zero, returning an Int1Ty value.
1686 llvm::Value *EvaluateExprAsBool(const Expr *E);
1687
John McCall2a416372010-12-05 02:00:02 +00001688 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1689 void EmitIgnoredExpr(const Expr *E);
1690
Chris Lattner9b655512007-08-31 22:49:20 +00001691 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1692 /// any type. The result is returned as an RValue struct. If this is an
1693 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1694 /// the result should be returned.
Mike Stump49d1cd52009-05-26 22:03:21 +00001695 ///
Dmitri Gribenko70517ca2012-08-23 17:58:28 +00001696 /// \param ignoreResult True if the resulting value isn't used.
John McCall558d2ab2010-09-15 10:14:12 +00001697 RValue EmitAnyExpr(const Expr *E,
John McCalle0c11682012-07-02 23:58:38 +00001698 AggValueSlot aggSlot = AggValueSlot::ignored(),
1699 bool ignoreResult = false);
Devang Pateld9363c32007-09-28 21:49:18 +00001700
Mike Stump0dd9e882009-02-08 23:14:22 +00001701 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1702 // or the value of the expression, depending on how va_list is defined.
Eli Friedman4fd0aa52009-01-20 17:46:04 +00001703 llvm::Value *EmitVAListRef(const Expr *E);
1704
Mike Stump0dd9e882009-02-08 23:14:22 +00001705 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1706 /// always be accessible even if no aggregate location is provided.
John McCall558d2ab2010-09-15 10:14:12 +00001707 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar46f45b92008-09-09 01:06:48 +00001708
John McCall60d33652011-03-08 09:11:50 +00001709 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier649b4a12012-03-29 17:37:10 +00001710 /// arbitrary expression into the given memory location.
John McCall3d3ec1c2010-04-21 10:05:39 +00001711 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier649b4a12012-03-29 17:37:10 +00001712 Qualifiers Quals, bool IsInitializer);
John McCall3d3ec1c2010-04-21 10:05:39 +00001713
John McCall60d33652011-03-08 09:11:50 +00001714 /// EmitExprAsInit - Emits the code necessary to initialize a
1715 /// location in memory with the given initializer.
John McCallf85e1932011-06-15 23:02:42 +00001716 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001717 LValue lvalue, bool capturedByInit);
John McCall60d33652011-03-08 09:11:50 +00001718
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001719 /// hasVolatileMember - returns true if aggregate type has a volatile
1720 /// member.
1721 bool hasVolatileMember(QualType T) {
1722 if (const RecordType *RT = T->getAs<RecordType>()) {
1723 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1724 return RD->hasVolatileMember();
1725 }
1726 return false;
1727 }
Arnaud A. de Grandmaison8fcbb8d2013-02-05 09:06:17 +00001728 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001729 ///
1730 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1731 /// This is required for correctness when assigning non-POD structures in C++.
1732 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian3ac83d62013-01-25 23:57:05 +00001733 QualType EltTy) {
1734 bool IsVolatile = hasVolatileMember(EltTy);
1735 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1736 true);
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001737 }
1738
Arnaud A. de Grandmaison8fcbb8d2013-02-05 09:06:17 +00001739 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump27fe2e62009-05-23 22:29:41 +00001740 ///
Sylvestre Ledruf3477c12012-09-27 10:16:10 +00001741 /// \param isVolatile - True iff either the source or the destination is
Mike Stump27fe2e62009-05-23 22:29:41 +00001742 /// volatile.
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001743 /// \param isAssignment - If false, allow padding to be copied. This often
1744 /// yields more efficient.
Daniel Dunbar7482d122008-09-09 20:49:46 +00001745 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedmanbd7d8282011-12-05 22:23:28 +00001746 QualType EltTy, bool isVolatile=false,
Benjamin Kramer6cacae82012-09-30 12:43:37 +00001747 CharUnits Alignment = CharUnits::Zero(),
1748 bool isAssignment = false);
Daniel Dunbar7482d122008-09-09 20:49:46 +00001749
Devang Patel51b09f22007-10-04 23:45:31 +00001750 /// StartBlock - Start new block named N. If insert block is a dummy block
1751 /// then reuse it.
1752 void StartBlock(const char *N);
1753
Anders Carlssondde0a942008-09-11 09:15:33 +00001754 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall4c40d982010-08-31 07:33:07 +00001755 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1756 llvm::Value *Res = LocalDeclMap[VD];
1757 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1758 return Res;
1759 }
Mike Stump0dd9e882009-02-08 23:14:22 +00001760
John McCall56ca35d2011-02-17 10:25:35 +00001761 /// getOpaqueLValueMapping - Given an opaque value expression (which
1762 /// must be mapped to an l-value), return its mapping.
1763 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1764 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1765
1766 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1767 it = OpaqueLValues.find(e);
1768 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1769 return it->second;
1770 }
1771
1772 /// getOpaqueRValueMapping - Given an opaque value expression (which
1773 /// must be mapped to an r-value), return its mapping.
1774 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1775 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1776
1777 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1778 it = OpaqueRValues.find(e);
1779 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCalle996ffd2011-02-16 08:02:54 +00001780 return it->second;
1781 }
1782
Dan Gohman4f8d1232008-05-22 00:50:06 +00001783 /// getAccessedFieldNo - Given an encoded value and a result number, return
1784 /// the input field number being accessed.
1785 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1786
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001787 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner3d00fdc2009-10-13 06:55:33 +00001788 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00001789
Anders Carlsson1884eb02010-05-22 17:35:42 +00001790 /// EmitNullInitialization - Generate code to set a value of the given type to
1791 /// null, If the type contains data member pointers, they will be initialized
1792 /// to -1 in accordance with the Itanium C++ ABI.
1793 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001794
1795 // EmitVAArg - Generate code to get an argument from the passed in pointer
1796 // and update it accordingly. The return value is a pointer to the argument.
1797 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stump0dd9e882009-02-08 23:14:22 +00001798 // instruction in LLVM instead once it works well enough.
Anders Carlssonddf7cac2008-11-04 05:30:00 +00001799 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +00001800
John McCallbdc4d802011-07-09 01:37:26 +00001801 /// emitArrayLength - Compute the length of an array, even if it's a
1802 /// VLA, and drill down to the base element type.
1803 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1804 QualType &baseType,
1805 llvm::Value *&addr);
1806
John McCallbc8d40d2011-06-24 21:55:10 +00001807 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1808 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbard286f052009-07-19 06:58:07 +00001809 ///
1810 /// This function can be called with a null (unreachable) insert point.
John McCallbc8d40d2011-06-24 21:55:10 +00001811 void EmitVariablyModifiedType(QualType Ty);
Mike Stump0dd9e882009-02-08 23:14:22 +00001812
John McCallbc8d40d2011-06-24 21:55:10 +00001813 /// getVLASize - Returns an LLVM value that corresponds to the size,
1814 /// in non-variably-sized elements, of a variable length array type,
1815 /// plus that largest non-variably-sized element type. Assumes that
1816 /// the type has already been emitted with EmitVariablyModifiedType.
1817 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1818 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssondcc90d82008-12-12 07:19:02 +00001819
Anders Carlsson5f4307b2009-04-14 16:58:56 +00001820 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1821 /// generating code for an C++ member function.
John McCall25049412010-02-16 22:04:33 +00001822 llvm::Value *LoadCXXThis() {
1823 assert(CXXThisValue && "no 'this' value for this function");
1824 return CXXThisValue;
1825 }
Mike Stump1eb44332009-09-09 15:08:12 +00001826
Anders Carlssonc997d422010-01-02 01:01:18 +00001827 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1828 /// virtual bases.
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001829 // FIXME: Every place that calls LoadCXXVTT is something
1830 // that needs to be abstracted properly.
John McCall25049412010-02-16 22:04:33 +00001831 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00001832 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1833 return CXXStructorImplicitParamValue;
1834 }
1835
1836 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1837 /// for a constructor/destructor.
1838 llvm::Value *LoadCXXStructorImplicitParam() {
1839 assert(CXXStructorImplicitParamValue &&
1840 "no implicit argument value for this function");
1841 return CXXStructorImplicitParamValue;
John McCall25049412010-02-16 22:04:33 +00001842 }
John McCallbff225e2010-02-16 04:15:37 +00001843
1844 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlsson8561a862010-04-24 23:01:49 +00001845 /// complete class to the given direct base.
1846 llvm::Value *
1847 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1848 const CXXRecordDecl *Derived,
1849 const CXXRecordDecl *Base,
1850 bool BaseIsVirtual);
Anders Carlssona88ad562010-04-24 21:51:08 +00001851
Mike Stumpf71d2322009-11-30 20:08:49 +00001852 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1853 /// load of 'this' and returns address of the base class.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001854 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001855 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001856 CastExpr::path_const_iterator PathBegin,
1857 CastExpr::path_const_iterator PathEnd,
Anders Carlsson34a2d382010-04-24 21:06:20 +00001858 bool NullCheckValue);
1859
Anders Carlssona3697c92009-11-23 17:57:54 +00001860 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlsson8561a862010-04-24 23:01:49 +00001861 const CXXRecordDecl *Derived,
John McCallf871d0c2010-08-07 06:22:56 +00001862 CastExpr::path_const_iterator PathBegin,
1863 CastExpr::path_const_iterator PathEnd,
Anders Carlssona3697c92009-11-23 17:57:54 +00001864 bool NullCheckValue);
1865
Anders Carlssonbb7e17b2010-01-31 01:36:53 +00001866 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1867 const CXXRecordDecl *ClassDecl,
1868 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001869
Timur Iskhodzhanov1d4fff52013-02-27 13:46:31 +00001870 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1871 /// base constructor/destructor with virtual bases.
1872 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1873 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1874 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1875 bool Delegating);
1876
John McCallc0bf4622010-02-23 00:48:20 +00001877 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1878 CXXCtorType CtorType,
1879 const FunctionArgList &Args);
Sean Hunt059ce0d2011-05-01 07:04:31 +00001880 // It's important not to confuse this and the previous function. Delegating
1881 // constructors are the C++0x feature. The constructor delegate optimization
1882 // is used to reduce duplication in the base and complete consturctors where
1883 // they are substantially the same.
1884 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1885 const FunctionArgList &Args);
Anders Carlsson155ed4a2010-05-02 23:20:53 +00001886 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00001887 bool ForVirtualBase, bool Delegating,
1888 llvm::Value *This,
Anders Carlssonb14095a2009-04-17 00:06:03 +00001889 CallExpr::const_arg_iterator ArgBeg,
1890 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahanian34999872010-11-13 21:53:34 +00001891
1892 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1893 llvm::Value *This, llvm::Value *Src,
1894 CallExpr::const_arg_iterator ArgBeg,
1895 CallExpr::const_arg_iterator ArgEnd);
Mike Stump1eb44332009-09-09 15:08:12 +00001896
Fariborz Jahanian288dcaf2009-08-19 20:55:16 +00001897 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlsson569c1f42009-09-23 02:45:36 +00001898 const ConstantArrayType *ArrayTy,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001899 llvm::Value *ArrayPtr,
1900 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001901 CallExpr::const_arg_iterator ArgEnd,
1902 bool ZeroInitialization = false);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001903
Anders Carlsson569c1f42009-09-23 02:45:36 +00001904 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1905 llvm::Value *NumElements,
Anders Carlsson5d4d9462009-11-24 18:43:52 +00001906 llvm::Value *ArrayPtr,
1907 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor59174c02010-07-21 01:10:17 +00001908 CallExpr::const_arg_iterator ArgEnd,
1909 bool ZeroInitialization = false);
Anders Carlssonb14095a2009-04-17 00:06:03 +00001910
John McCallbdc4d802011-07-09 01:37:26 +00001911 static Destroyer destroyCXXObject;
1912
Anders Carlsson7267c162009-05-29 21:03:38 +00001913 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor378e1e72013-01-31 05:50:40 +00001914 bool ForVirtualBase, bool Delegating,
1915 llvm::Value *This);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00001916
John McCall19705672011-09-15 06:49:18 +00001917 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1918 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump1eb44332009-09-09 15:08:12 +00001919
Peter Collingbourne86811602011-11-27 22:09:22 +00001920 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1921 llvm::Value *Ptr);
Mike Stump1eb44332009-09-09 15:08:12 +00001922
Anders Carlssona00703d2009-05-31 01:40:14 +00001923 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson60e282c2009-08-16 21:13:42 +00001924 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump1eb44332009-09-09 15:08:12 +00001925
Eli Friedman4bf81522009-11-18 00:57:03 +00001926 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1927 QualType DeleteTy);
1928
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001929 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stumpc849c052009-11-16 06:50:58 +00001930 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Weberc5f80462012-10-11 10:13:44 +00001931 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001932
Sebastian Redl972edf02012-02-19 16:03:09 +00001933 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
Sebastian Redlaf130fd2012-02-19 12:28:02 +00001934 void EmitStdInitializerListCleanup(llvm::Value *loc,
1935 const InitListExpr *init);
Sebastian Redl32cf1f22012-02-17 08:42:25 +00001936
Richard Smith2c9f87c2012-08-24 00:54:33 +00001937 /// \brief Situations in which we might emit a check for the suitability of a
1938 /// pointer or glvalue.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001939 enum TypeCheckKind {
Richard Smith2c9f87c2012-08-24 00:54:33 +00001940 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001941 TCK_Load,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001942 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001943 TCK_Store,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001944 /// Checking the bound value in a reference binding. Must be suitably sized
1945 /// and aligned, but is not required to refer to an object (until the
1946 /// reference is used), per core issue 453.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001947 TCK_ReferenceBinding,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001948 /// Checking the object expression in a non-static data member access. Must
1949 /// be an object within its lifetime.
Richard Smith7ac9ef12012-09-08 02:08:36 +00001950 TCK_MemberAccess,
Richard Smith2c9f87c2012-08-24 00:54:33 +00001951 /// Checking the 'this' pointer for a call to a non-static member function.
1952 /// Must be an object within its lifetime.
Richard Smith8e1cee62012-10-25 02:14:12 +00001953 TCK_MemberCall,
1954 /// Checking the 'this' pointer for a constructor call.
Richard Smithc7648302013-02-13 21:18:23 +00001955 TCK_ConstructorCall,
1956 /// Checking the operand of a static_cast to a derived pointer type. Must be
1957 /// null or an object within its lifetime.
1958 TCK_DowncastPointer,
1959 /// Checking the operand of a static_cast to a derived reference type. Must
1960 /// be an object within its lifetime.
1961 TCK_DowncastReference
Richard Smith2c9f87c2012-08-24 00:54:33 +00001962 };
1963
Richard Smith7ac9ef12012-09-08 02:08:36 +00001964 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith2c9f87c2012-08-24 00:54:33 +00001965 /// appropriate size and alignment for an object of type \p Type.
Richard Smith4def70d2012-10-09 19:52:38 +00001966 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Richard Smith7ac9ef12012-09-08 02:08:36 +00001967 QualType Type, CharUnits Alignment = CharUnits::Zero());
Mike Stumpb14e62d2009-12-16 02:57:00 +00001968
Richard Smitha0a628f2013-02-23 02:53:19 +00001969 /// \brief Emit a check that \p Base points into an array object, which
1970 /// we can access at index \p Index. \p Accessed should be \c false if we
1971 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1972 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1973 QualType IndexType, bool Accessed);
1974
Chris Lattnerdd36d322010-01-09 21:40:03 +00001975 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1976 bool isInc, bool isPre);
1977 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1978 bool isInc, bool isPre);
Reid Spencer5f016e22007-07-11 17:01:13 +00001979 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +00001980 // Declaration Emission
1981 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00001982
Daniel Dunbard286f052009-07-19 06:58:07 +00001983 /// EmitDecl - Emit a declaration.
1984 ///
1985 /// This function can be called with a null (unreachable) insert point.
Reid Spencer5f016e22007-07-11 17:01:13 +00001986 void EmitDecl(const Decl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001987
John McCallb6bbcc92010-10-15 04:57:14 +00001988 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00001989 ///
1990 /// This function can be called with a null (unreachable) insert point.
John McCallb6bbcc92010-10-15 04:57:14 +00001991 void EmitVarDecl(const VarDecl &D);
Daniel Dunbard286f052009-07-19 06:58:07 +00001992
John McCallf85e1932011-06-15 23:02:42 +00001993 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCalla07398e2011-06-16 04:16:24 +00001994 LValue lvalue, bool capturedByInit);
John McCall7acddac2011-06-17 06:42:21 +00001995 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCallf85e1932011-06-15 23:02:42 +00001996
John McCallf1549f62010-07-06 01:34:17 +00001997 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1998 llvm::Value *Address);
1999
John McCallb6bbcc92010-10-15 04:57:14 +00002000 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbard286f052009-07-19 06:58:07 +00002001 ///
2002 /// This function can be called with a null (unreachable) insert point.
John McCall34695852011-02-22 06:44:22 +00002003 void EmitAutoVarDecl(const VarDecl &D);
2004
2005 class AutoVarEmission {
2006 friend class CodeGenFunction;
2007
John McCall57b3b6a2011-02-22 07:16:58 +00002008 const VarDecl *Variable;
John McCall34695852011-02-22 06:44:22 +00002009
2010 /// The alignment of the variable.
2011 CharUnits Alignment;
2012
2013 /// The address of the alloca. Null if the variable was emitted
2014 /// as a global constant.
2015 llvm::Value *Address;
2016
2017 llvm::Value *NRVOFlag;
2018
2019 /// True if the variable is a __block variable.
2020 bool IsByRef;
2021
2022 /// True if the variable is of aggregate type and has a constant
2023 /// initializer.
2024 bool IsConstantAggregate;
2025
Nadav Rotem495cfa42013-03-23 06:43:35 +00002026 /// Non-null if we should use lifetime annotations.
2027 llvm::Value *SizeForLifetimeMarkers;
2028
John McCall57b3b6a2011-02-22 07:16:58 +00002029 struct Invalid {};
2030 AutoVarEmission(Invalid) : Variable(0) {}
2031
John McCall34695852011-02-22 06:44:22 +00002032 AutoVarEmission(const VarDecl &variable)
John McCall57b3b6a2011-02-22 07:16:58 +00002033 : Variable(&variable), Address(0), NRVOFlag(0),
Nadav Rotem495cfa42013-03-23 06:43:35 +00002034 IsByRef(false), IsConstantAggregate(false),
2035 SizeForLifetimeMarkers(0) {}
John McCall34695852011-02-22 06:44:22 +00002036
2037 bool wasEmittedAsGlobal() const { return Address == 0; }
2038
2039 public:
John McCall57b3b6a2011-02-22 07:16:58 +00002040 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2041
Nadav Rotem495cfa42013-03-23 06:43:35 +00002042 bool useLifetimeMarkers() const { return SizeForLifetimeMarkers != 0; }
2043 llvm::Value *getSizeForLifetimeMarkers() const {
2044 assert(useLifetimeMarkers());
2045 return SizeForLifetimeMarkers;
2046 }
2047
2048 /// Returns the raw, allocated address, which is not necessarily
2049 /// the address of the object itself.
2050 llvm::Value *getAllocatedAddress() const {
2051 return Address;
2052 }
2053
John McCall34695852011-02-22 06:44:22 +00002054 /// Returns the address of the object within this declaration.
2055 /// Note that this does not chase the forwarding pointer for
2056 /// __block decls.
2057 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
2058 if (!IsByRef) return Address;
2059
2060 return CGF.Builder.CreateStructGEP(Address,
John McCall57b3b6a2011-02-22 07:16:58 +00002061 CGF.getByRefValueLLVMField(Variable),
2062 Variable->getNameAsString());
John McCall34695852011-02-22 06:44:22 +00002063 }
2064 };
2065 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2066 void EmitAutoVarInit(const AutoVarEmission &emission);
2067 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCallbdc4d802011-07-09 01:37:26 +00002068 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2069 QualType::DestructionKind dtorKind);
Daniel Dunbard286f052009-07-19 06:58:07 +00002070
John McCallb6bbcc92010-10-15 04:57:14 +00002071 void EmitStaticVarDecl(const VarDecl &D,
2072 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00002073
2074 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel093ac462011-03-03 20:13:15 +00002075 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stump0dd9e882009-02-08 23:14:22 +00002076
John McCall56ca35d2011-02-17 10:25:35 +00002077 /// protectFromPeepholes - Protect a value that we're intending to
2078 /// store to the side, but which will probably be used later, from
2079 /// aggressive peepholing optimizations that might delete it.
2080 ///
2081 /// Pass the result to unprotectFromPeepholes to declare that
2082 /// protection is no longer required.
2083 ///
2084 /// There's no particular reason why this shouldn't apply to
2085 /// l-values, it's just that no existing peepholes work on pointers.
2086 PeepholeProtection protectFromPeepholes(RValue rvalue);
2087 void unprotectFromPeepholes(PeepholeProtection protection);
2088
Reid Spencer5f016e22007-07-11 17:01:13 +00002089 //===--------------------------------------------------------------------===//
2090 // Statement Emission
2091 //===--------------------------------------------------------------------===//
2092
Mike Stump0dd9e882009-02-08 23:14:22 +00002093 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar09124252008-11-12 08:21:33 +00002094 void EmitStopPoint(const Stmt *S);
2095
Mike Stump0dd9e882009-02-08 23:14:22 +00002096 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2097 /// this function even if there is no current insertion point.
2098 ///
2099 /// This function may clear the current insertion point; callers should use
2100 /// EnsureInsertPoint if they wish to subsequently generate code without first
2101 /// calling EmitBlock, EmitBranch, or EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +00002102 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +00002103
Daniel Dunbar09124252008-11-12 08:21:33 +00002104 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stump0dd9e882009-02-08 23:14:22 +00002105 /// necessarily require an insertion point or debug information; typically
2106 /// because the statement amounts to a jump or a container of other
2107 /// statements.
Daniel Dunbar09124252008-11-12 08:21:33 +00002108 ///
2109 /// \return True if the statement was handled.
2110 bool EmitSimpleStmt(const Stmt *S);
2111
Chris Lattner9b655512007-08-31 22:49:20 +00002112 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall558d2ab2010-09-15 10:14:12 +00002113 AggValueSlot AVS = AggValueSlot::ignored());
David Blaikiea6504852013-01-26 22:16:26 +00002114 RValue EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2115 bool GetLast = false, AggValueSlot AVS =
2116 AggValueSlot::ignored());
Daniel Dunbara448fb22008-11-11 23:11:34 +00002117
Mike Stump0dd9e882009-02-08 23:14:22 +00002118 /// EmitLabel - Emit the block for the given label. It is legal to call this
2119 /// function even if there is no current insertion point.
Chris Lattnerad8dcf42011-02-17 07:39:24 +00002120 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +00002121
Reid Spencer5f016e22007-07-11 17:01:13 +00002122 void EmitLabelStmt(const LabelStmt &S);
Richard Smith534986f2012-04-14 00:33:13 +00002123 void EmitAttributedStmt(const AttributedStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00002124 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002125 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +00002126 void EmitIfStmt(const IfStmt &S);
2127 void EmitWhileStmt(const WhileStmt &S);
2128 void EmitDoStmt(const DoStmt &S);
2129 void EmitForStmt(const ForStmt &S);
2130 void EmitReturnStmt(const ReturnStmt &S);
2131 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +00002132 void EmitBreakStmt(const BreakStmt &S);
2133 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +00002134 void EmitSwitchStmt(const SwitchStmt &S);
2135 void EmitDefaultStmt(const DefaultStmt &S);
2136 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +00002137 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosiera23b91d2012-08-28 18:54:39 +00002138 void EmitAsmStmt(const AsmStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00002139
Anders Carlsson3d8400d2008-08-30 19:51:14 +00002140 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00002141 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2142 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00002143 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCallf85e1932011-06-15 23:02:42 +00002144 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stump0dd9e882009-02-08 23:14:22 +00002145
John McCall93c332a2011-05-28 21:13:02 +00002146 llvm::Constant *getUnwindResumeFn();
Douglas Gregor86a3a032010-05-16 01:24:12 +00002147 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCall59a70002010-07-07 06:56:46 +00002148 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2149 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCall9fc6a772010-02-19 09:25:03 +00002150
Anders Carlsson6815e942009-09-27 18:58:34 +00002151 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smithad762fc2011-04-14 22:09:26 +00002152 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002153
Reid Spencer5f016e22007-07-11 17:01:13 +00002154 //===--------------------------------------------------------------------===//
2155 // LValue Expression Emission
2156 //===--------------------------------------------------------------------===//
2157
Daniel Dunbar13e81732009-02-05 07:09:07 +00002158 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2159 RValue GetUndefRValue(QualType Ty);
2160
Daniel Dunbarce1d38b2009-01-09 16:50:52 +00002161 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2162 /// and issue an ErrorUnsupported style diagnostic (using the
2163 /// provided Name).
2164 RValue EmitUnsupportedRValue(const Expr *E,
2165 const char *Name);
2166
Mike Stump0dd9e882009-02-08 23:14:22 +00002167 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2168 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbar6ba82a42008-08-25 20:45:57 +00002169 LValue EmitUnsupportedLValue(const Expr *E,
2170 const char *Name);
2171
Reid Spencer5f016e22007-07-11 17:01:13 +00002172 /// EmitLValue - Emit code to compute a designator that specifies the location
2173 /// of the expression.
2174 ///
2175 /// This can return one of two things: a simple address or a bitfield
2176 /// reference. In either case, the LLVM Value* in the LValue structure is
2177 /// guaranteed to be an LLVM pointer type.
2178 ///
2179 /// If this returns a bitfield reference, nothing about the pointee type of
2180 /// the LLVM value is known: For example, it may not be a pointer to an
2181 /// integer.
2182 ///
2183 /// If this returns a normal address, and if the lvalue's C type is fixed
2184 /// size, this method guarantees that the returned pointer type will point to
2185 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2186 /// variable length type, this is not possible.
2187 ///
2188 LValue EmitLValue(const Expr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002189
Richard Smith7ac9ef12012-09-08 02:08:36 +00002190 /// \brief Same as EmitLValue but additionally we generate checking code to
2191 /// guard against undefined behavior. This is only suitable when we know
2192 /// that the address will be used to access the object.
2193 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stumpb14e62d2009-12-16 02:57:00 +00002194
John McCall9d232c82013-03-07 21:37:08 +00002195 RValue convertTempToRValue(llvm::Value *addr, QualType type);
2196
John McCall9eda3ab2013-03-07 21:37:17 +00002197 void EmitAtomicInit(Expr *E, LValue lvalue);
2198
2199 RValue EmitAtomicLoad(LValue lvalue,
2200 AggValueSlot slot = AggValueSlot::ignored());
2201
2202 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2203
John McCall26815d92010-10-27 20:58:56 +00002204 /// EmitToMemory - Change a scalar value from its value
2205 /// representation to its in-memory representation.
2206 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2207
2208 /// EmitFromMemory - Change a scalar value from its memory
2209 /// representation to its value representation.
2210 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2211
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002212 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2213 /// care to appropriately convert from the memory representation to
2214 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002215 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002216 unsigned Alignment, QualType Ty,
2217 llvm::MDNode *TBAAInfo = 0);
John McCall545d9962011-06-25 02:11:03 +00002218
2219 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2220 /// care to appropriately convert from the memory representation to
2221 /// the LLVM value representation. The l-value must be a simple
2222 /// l-value.
John McCalla07398e2011-06-16 04:16:24 +00002223 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002224
2225 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2226 /// care to appropriately convert from the memory representation to
2227 /// the LLVM value representation.
Mike Stump09429b92009-02-17 17:00:02 +00002228 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman3d5aff52010-10-14 23:06:10 +00002229 bool Volatile, unsigned Alignment, QualType Ty,
David Chisnall7a7ee302012-01-16 17:27:18 +00002230 llvm::MDNode *TBAAInfo = 0, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00002231
2232 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2233 /// care to appropriately convert from the memory representation to
2234 /// the LLVM value representation. The l-value must be a simple
David Chisnall7a7ee302012-01-16 17:27:18 +00002235 /// l-value. The isInit flag indicates whether this is an initialization.
2236 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2237 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar9d9cc872009-02-10 00:57:50 +00002238
Reid Spencer5f016e22007-07-11 17:01:13 +00002239 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2240 /// this method emits the address of the lvalue, then loads the result as an
2241 /// rvalue, returning the rvalue.
John McCall545d9962011-06-25 02:11:03 +00002242 RValue EmitLoadOfLValue(LValue V);
2243 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2244 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stump0dd9e882009-02-08 23:14:22 +00002245
Reid Spencer5f016e22007-07-11 17:01:13 +00002246 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2247 /// lvalue, where both are guaranteed to the have the same type, and that type
2248 /// is 'Ty'.
David Chisnall7a7ee302012-01-16 17:27:18 +00002249 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall545d9962011-06-25 02:11:03 +00002250 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbared3849b2008-11-19 09:36:46 +00002251
Mike Stump0dd9e882009-02-08 23:14:22 +00002252 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2253 /// EmitStoreThroughLValue.
Daniel Dunbared3849b2008-11-19 09:36:46 +00002254 ///
Mike Stump0dd9e882009-02-08 23:14:22 +00002255 /// \param Result [out] - If non-null, this will be set to a Value* for the
2256 /// bit-field contents after the store, appropriate for use as the result of
2257 /// an assignment to the bit-field.
John McCall545d9962011-06-25 02:11:03 +00002258 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbared3849b2008-11-19 09:36:46 +00002259 llvm::Value **Result=0);
Mike Stump0dd9e882009-02-08 23:14:22 +00002260
John McCall83ce9d42010-11-16 23:07:28 +00002261 /// Emit an l-value for an assignment (simple or compound) of complex type.
2262 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002263 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall83ce9d42010-11-16 23:07:28 +00002264
Chris Lattnerfc8f0e12011-04-15 05:22:18 +00002265 // Note: only available for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +00002266 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCall2a416372010-12-05 02:00:02 +00002267 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002268 // Note: only available for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +00002269 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar5b5c9ef2009-02-11 20:59:32 +00002270 // Note: only available for agg return types
2271 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002272 LValue EmitDeclRefLValue(const DeclRefExpr *E);
2273 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnereaf2bb82009-02-24 22:18:39 +00002274 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattnerd9f69102008-08-10 01:53:14 +00002275 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002276 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smitha0a628f2013-02-23 02:53:19 +00002277 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2278 bool Accessed = false);
Nate Begeman213541a2008-04-18 23:10:10 +00002279 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +00002280 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian820bca42009-12-09 23:35:29 +00002281 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +00002282 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smith13ec9102012-05-14 21:57:21 +00002283 LValue EmitInitListLValue(const InitListExpr *E);
John McCall56ca35d2011-02-17 10:25:35 +00002284 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner75dfeda2009-03-18 18:28:57 +00002285 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregored8abf12010-07-08 06:14:04 +00002286 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregor03e80032011-06-21 17:03:29 +00002287 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCalle996ffd2011-02-16 08:02:54 +00002288 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002289
Eli Friedman377ecc72012-04-16 03:54:45 +00002290 RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
Anton Korobeynikoveaf856d2012-04-13 11:22:00 +00002291
John McCalldd2ecee2012-03-10 03:05:10 +00002292 class ConstantEmission {
2293 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2294 ConstantEmission(llvm::Constant *C, bool isReference)
2295 : ValueAndIsReference(C, isReference) {}
2296 public:
2297 ConstantEmission() {}
2298 static ConstantEmission forReference(llvm::Constant *C) {
2299 return ConstantEmission(C, true);
2300 }
2301 static ConstantEmission forValue(llvm::Constant *C) {
2302 return ConstantEmission(C, false);
2303 }
2304
2305 operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
2306
2307 bool isReference() const { return ValueAndIsReference.getInt(); }
2308 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2309 assert(isReference());
2310 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2311 refExpr->getType());
2312 }
2313
2314 llvm::Constant *getValue() const {
2315 assert(!isReference());
2316 return ValueAndIsReference.getPointer();
2317 }
2318 };
2319
John McCallf4b88a42012-03-10 09:33:50 +00002320 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCalldd2ecee2012-03-10 03:05:10 +00002321
John McCall4b9c2d22011-11-06 09:01:30 +00002322 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2323 AggValueSlot slot = AggValueSlot::ignored());
2324 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2325
Daniel Dunbar2a031922009-04-22 05:08:15 +00002326 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002327 const ObjCIvarDecl *Ivar);
Eli Friedman377ecc72012-04-16 03:54:45 +00002328 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002329
Anders Carlsson06a29702010-01-29 05:24:29 +00002330 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2331 /// if the Field is a reference, this will return the address of the reference
2332 /// and not the address of the value stored in the reference.
Eli Friedman377ecc72012-04-16 03:54:45 +00002333 LValue EmitLValueForFieldInitialization(LValue Base,
2334 const FieldDecl* Field);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002335
Fariborz Jahanian45012a72009-02-03 00:09:52 +00002336 LValue EmitLValueForIvar(QualType ObjectTy,
2337 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002338 unsigned CVRQualifiers);
2339
Anders Carlssonb58d0172009-05-30 23:23:33 +00002340 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssone61c9e82009-05-30 23:30:54 +00002341 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman31a37022012-02-08 05:34:55 +00002342 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc2e84ae2009-11-15 08:09:41 +00002343 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Weberc5f80462012-10-11 10:13:44 +00002344 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002345
Daniel Dunbar0a04d772008-08-23 10:51:21 +00002346 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +00002347 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattner65459942009-04-25 19:35:26 +00002348 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanian8bfd31f2009-10-22 22:57:31 +00002349 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian03b29602010-06-17 19:56:20 +00002350 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCall189d6ef2010-10-09 01:34:31 +00002351 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCall56ca35d2011-02-17 10:25:35 +00002352
Reid Spencer5f016e22007-07-11 17:01:13 +00002353 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +00002354 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +00002355 //===--------------------------------------------------------------------===//
2356
Mike Stump0dd9e882009-02-08 23:14:22 +00002357 /// EmitCall - Generate a call of the given function, expecting the given
2358 /// result type, and using the given argument list which specifies both the
2359 /// LLVM arguments and the types they were derived from.
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002360 ///
Mike Stumpf71d2322009-11-30 20:08:49 +00002361 /// \param TargetDecl - If given, the decl of the function in a direct call;
2362 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbar88b53962009-02-02 22:03:45 +00002363 RValue EmitCall(const CGFunctionInfo &FnInfo,
2364 llvm::Value *Callee,
Anders Carlssonf3c47c92009-12-24 19:25:24 +00002365 ReturnValueSlot ReturnValue,
Daniel Dunbarc0ef9f52009-02-20 18:06:48 +00002366 const CallArgList &Args,
David Chisnalldd5c98f2010-05-01 11:15:56 +00002367 const Decl *TargetDecl = 0,
David Chisnall4b02afc2010-05-02 13:41:58 +00002368 llvm::Instruction **callOrInvoke = 0);
Mike Stump1eb44332009-09-09 15:08:12 +00002369
Anders Carlsson31777a22009-12-24 19:08:58 +00002370 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlssond2490a92009-12-24 20:40:36 +00002371 ReturnValueSlot ReturnValue,
Anders Carlsson98647712009-05-27 01:22:39 +00002372 CallExpr::const_arg_iterator ArgBeg,
2373 CallExpr::const_arg_iterator ArgEnd,
2374 const Decl *TargetDecl = 0);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002375 RValue EmitCallExpr(const CallExpr *E,
Anders Carlssond2490a92009-12-24 20:40:36 +00002376 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump1eb44332009-09-09 15:08:12 +00002377
John McCallbd7370a2013-02-28 19:01:20 +00002378 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2379 const Twine &name = "");
2380 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2381 ArrayRef<llvm::Value*> args,
2382 const Twine &name = "");
2383 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2384 const Twine &name = "");
2385 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2386 ArrayRef<llvm::Value*> args,
2387 const Twine &name = "");
2388
John McCallf1549f62010-07-06 01:34:17 +00002389 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner2d3ba4f2011-07-23 17:14:25 +00002390 ArrayRef<llvm::Value *> Args,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002391 const Twine &Name = "");
Jay Foad4c7d9f12011-07-15 08:37:34 +00002392 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner8cc488f2011-07-20 07:06:53 +00002393 const Twine &Name = "");
John McCallbd7370a2013-02-28 19:01:20 +00002394 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2395 ArrayRef<llvm::Value*> args,
2396 const Twine &name = "");
2397 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2398 const Twine &name = "");
2399 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2400 ArrayRef<llvm::Value*> args);
John McCallf1549f62010-07-06 01:34:17 +00002401
Anders Carlsson566abee2009-11-13 04:45:41 +00002402 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002403 llvm::Type *Ty);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002404 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002405 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian27262672011-01-20 17:19:02 +00002406 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2407 NestedNameSpecifier *Qual,
Chris Lattner2acc6e32011-07-18 04:24:23 +00002408 llvm::Type *Ty);
Fariborz Jahanianccd52592011-02-01 23:22:34 +00002409
2410 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2411 CXXDtorType Type,
Fariborz Jahanian771c6782011-02-03 19:27:17 +00002412 const CXXRecordDecl *RD);
Anders Carlsson566abee2009-11-13 04:45:41 +00002413
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002414 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
Richard Smith4def70d2012-10-09 19:52:38 +00002415 SourceLocation CallLoc,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002416 llvm::Value *Callee,
Anders Carlssona1736c02009-12-24 21:13:40 +00002417 ReturnValueSlot ReturnValue,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002418 llvm::Value *This,
Timur Iskhodzhanov59660c22013-02-13 08:37:51 +00002419 llvm::Value *ImplicitParam,
2420 QualType ImplicitParamTy,
Anders Carlssonb9de2c52009-05-11 23:37:08 +00002421 CallExpr::const_arg_iterator ArgBeg,
2422 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssona1736c02009-12-24 21:13:40 +00002423 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2424 ReturnValueSlot ReturnValue);
2425 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2426 ReturnValueSlot ReturnValue);
Ted Kremenek55499762008-06-17 02:43:46 +00002427
Anders Carlssona2447e02011-05-08 20:32:23 +00002428 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2429 const CXXMethodDecl *MD,
2430 llvm::Value *This);
Anders Carlsson0f294632009-05-27 04:18:27 +00002431 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssona1736c02009-12-24 21:13:40 +00002432 const CXXMethodDecl *MD,
2433 ReturnValueSlot ReturnValue);
Mike Stump1eb44332009-09-09 15:08:12 +00002434
Peter Collingbourne6c0aa5f2011-10-06 18:29:37 +00002435 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2436 ReturnValueSlot ReturnValue);
2437
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002438
Mike Stump1eb44332009-09-09 15:08:12 +00002439 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbaref2abfe2009-02-16 22:43:43 +00002440 unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +00002441
Anders Carlssona1736c02009-12-24 21:13:40 +00002442 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stump09429b92009-02-17 17:00:02 +00002443
Mike Stump0dd9e882009-02-08 23:14:22 +00002444 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2445 /// is unhandled by the current target.
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +00002446 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2447
Chris Lattner2752c012010-03-03 19:03:45 +00002448 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002449 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner686775d2011-07-20 06:58:45 +00002450 SmallVectorImpl<llvm::Value*> &O,
Bob Wilsondb3d4d02010-12-08 22:37:56 +00002451 const char *name,
Nate Begeman61eecf52010-06-14 05:21:25 +00002452 unsigned shift = 0, bool rightshift = false);
Bob Wilsoncf556522010-12-07 22:40:02 +00002453 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2acc6e32011-07-18 04:24:23 +00002454 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman61eecf52010-06-14 05:21:25 +00002455 bool negateForRightShift);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002456
Bill Wendling795b1002012-02-22 09:30:11 +00002457 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson564f1de2007-12-09 23:17:02 +00002458 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2459 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stump0dd9e882009-02-08 23:14:22 +00002460
Daniel Dunbared7c6182008-08-20 00:28:19 +00002461 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +00002462 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beardeb382ec2012-04-19 00:25:12 +00002463 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremenekebcb57a2012-03-06 20:05:56 +00002464 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2465 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2466 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2467 const ObjCMethodDecl *MethodWithObjects);
Chris Lattner8fdf3282008-06-24 17:04:18 +00002468 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCallef072fd2010-05-22 01:48:05 +00002469 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2470 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattner8fdf3282008-06-24 17:04:18 +00002471
John McCallf85e1932011-06-15 23:02:42 +00002472 /// Retrieves the default cleanup kind for an ARC cleanup.
2473 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2474 CleanupKind getARCCleanupKind() {
2475 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2476 ? NormalAndEHCleanup : NormalCleanup;
2477 }
2478
2479 // ARC primitives.
2480 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2481 void EmitARCDestroyWeak(llvm::Value *addr);
2482 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2483 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2484 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2485 bool ignored);
2486 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2487 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2488 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2489 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall545d9962011-06-25 02:11:03 +00002490 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCall5b07e802013-03-13 03:10:54 +00002491 bool resultIgnored);
John McCallf85e1932011-06-15 23:02:42 +00002492 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCall5b07e802013-03-13 03:10:54 +00002493 bool resultIgnored);
John McCallf85e1932011-06-15 23:02:42 +00002494 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2495 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCall348f16f2011-10-04 06:23:45 +00002496 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCall5b07e802013-03-13 03:10:54 +00002497 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2498 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCallf85e1932011-06-15 23:02:42 +00002499 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2500 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2501 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2502 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2503
2504 std::pair<LValue,llvm::Value*>
2505 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2506 std::pair<LValue,llvm::Value*>
2507 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2508
John McCall2b014d62011-10-01 10:32:24 +00002509 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2510
John McCallf85e1932011-06-15 23:02:42 +00002511 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2512 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2513 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2514
John McCall348f16f2011-10-04 06:23:45 +00002515 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCallf85e1932011-06-15 23:02:42 +00002516 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2517 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2518
John McCallb6a60792013-03-23 02:35:54 +00002519 void EmitARCIntrinsicUse(llvm::ArrayRef<llvm::Value*> values);
2520
John McCallbdc4d802011-07-09 01:37:26 +00002521 static Destroyer destroyARCStrongImprecise;
2522 static Destroyer destroyARCStrongPrecise;
2523 static Destroyer destroyARCWeak;
2524
John McCallf85e1932011-06-15 23:02:42 +00002525 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2526 llvm::Value *EmitObjCAutoreleasePoolPush();
2527 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2528 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2529 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2530
Anders Carlsson4029ca72009-05-20 00:24:07 +00002531 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2532 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002533 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson32f36ba2010-06-26 16:35:32 +00002534 const NamedDecl *InitializedDecl);
Anders Carlsson3aba0932010-01-31 18:34:51 +00002535
Chris Lattner883f6a72007-08-11 00:04:45 +00002536 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002537 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +00002538 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +00002539
2540 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stump0dd9e882009-02-08 23:14:22 +00002541
2542 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2543 /// scalar type, returning the result.
Anders Carlsson14c5cbf2009-08-16 07:36:22 +00002544 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002545
Chris Lattner3707b252007-08-26 06:48:56 +00002546 /// EmitScalarConversion - Emit a conversion from the specified type to the
2547 /// specified destination type, both of which are LLVM scalar types.
2548 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2549 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002550
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002551 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stump0dd9e882009-02-08 23:14:22 +00002552 /// complex type to the specified destination type, where the destination type
2553 /// is an LLVM scalar type.
Chris Lattner4f1a7b32007-08-26 16:34:22 +00002554 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2555 QualType DstTy);
Mike Stump0dd9e882009-02-08 23:14:22 +00002556
2557
John McCall558d2ab2010-09-15 10:14:12 +00002558 /// EmitAggExpr - Emit the computation of the specified expression
2559 /// of aggregate type. The result is computed into the given slot,
2560 /// which may be null to indicate that the value is not needed.
John McCalle0c11682012-07-02 23:58:38 +00002561 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stump0dd9e882009-02-08 23:14:22 +00002562
Daniel Dunbar18aba0d2010-02-05 19:38:31 +00002563 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2564 /// aggregate type into a temporary LValue.
2565 LValue EmitAggExprToLValue(const Expr *E);
2566
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002567 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2568 /// pointers.
2569 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian08c32132009-08-31 19:33:16 +00002570 QualType Ty);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00002571
John McCall0c24c802011-06-24 23:21:27 +00002572 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2573 /// make sure it survives garbage collection until this point.
2574 void EmitExtendGCLifetime(llvm::Value *object);
2575
Chris Lattnerb6ef18a2007-08-21 05:54:00 +00002576 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +00002577 /// complex type, returning the result.
John McCallb418d742010-11-16 10:08:07 +00002578 ComplexPairTy EmitComplexExpr(const Expr *E,
2579 bool IgnoreReal = false,
2580 bool IgnoreImag = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002581
John McCall9d232c82013-03-07 21:37:08 +00002582 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2583 /// type and place its result into the specified l-value.
2584 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00002585
John McCall9d232c82013-03-07 21:37:08 +00002586 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
2587 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
2588
2589 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
2590 ComplexPairTy EmitLoadOfComplex(LValue src);
Chris Lattner2621fd12008-05-08 05:58:21 +00002591
John McCallb6bbcc92010-10-15 04:57:14 +00002592 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2593 /// a static local variable.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002594 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2595 const char *Separator,
2596 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002597
Chandler Carruth0f30a122012-03-30 19:44:53 +00002598 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2599 /// global variable that has already been created for it. If the initializer
2600 /// has a different type than GV does, this may free GV and return a different
2601 /// one. Otherwise it just returns GV.
2602 llvm::GlobalVariable *
2603 AddInitializerToStaticVarDecl(const VarDecl &D,
2604 llvm::GlobalVariable *GV);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002605
Daniel Dunbar0096acf2009-02-25 19:24:29 +00002606
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002607 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2608 /// variable with global storage.
Richard Smith7ca48502012-02-13 22:16:19 +00002609 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2610 bool PerformInit);
Anders Carlsson3b2e16b2009-08-08 21:45:14 +00002611
John McCall20bb1752012-05-01 06:13:13 +00002612 /// Call atexit() with a function that passes the given argument to
2613 /// the given function.
2614 void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr);
Mike Stump1eb44332009-09-09 15:08:12 +00002615
John McCall3030eb82010-11-06 09:44:32 +00002616 /// Emit code in this function to perform a guarded variable
2617 /// initialization. Guarded initializations are used when it's not
2618 /// possible to prove that an initialization will be done exactly
2619 /// once, e.g. with a static local variable or a static data member
2620 /// of a class template.
Chandler Carruth0f30a122012-03-30 19:44:53 +00002621 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith7ca48502012-02-13 22:16:19 +00002622 bool PerformInit);
John McCall5cd91b52010-09-08 01:44:27 +00002623
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002624 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2625 /// variables.
2626 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2627 llvm::Constant **Decls,
2628 unsigned NumDecls);
2629
John McCall3f88f682012-04-06 18:21:03 +00002630 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002631 /// variables.
John McCall3f88f682012-04-06 18:21:03 +00002632 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2633 const std::vector<std::pair<llvm::WeakVH,
2634 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002635
John McCalld26bc762011-03-09 04:27:21 +00002636 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2637 const VarDecl *D,
Richard Smith7ca48502012-02-13 22:16:19 +00002638 llvm::GlobalVariable *Addr,
2639 bool PerformInit);
Daniel Dunbarefb0fa92010-03-20 04:15:41 +00002640
John McCall558d2ab2010-09-15 10:14:12 +00002641 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahanian34999872010-11-13 21:53:34 +00002642
2643 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian830937b2010-12-02 17:02:11 +00002644 const Expr *Exp);
Mike Stump1eb44332009-09-09 15:08:12 +00002645
John McCall1a343eb2011-11-10 08:15:53 +00002646 void enterFullExpression(const ExprWithCleanups *E) {
2647 if (E->getNumObjects() == 0) return;
2648 enterNonTrivialFullExpression(E);
2649 }
2650 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump1eb44332009-09-09 15:08:12 +00002651
Anders Carlsson756b5c42009-10-30 01:42:31 +00002652 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregor1eb2e592010-05-16 00:44:00 +00002653
Eli Friedman4c5d8af2012-02-09 03:32:31 +00002654 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2655
Eli Friedman276b0612011-10-11 02:20:01 +00002656 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2657
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002658 //===--------------------------------------------------------------------===//
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002659 // Annotations Emission
2660 //===--------------------------------------------------------------------===//
2661
2662 /// Emit an annotation call (intrinsic or builtin).
2663 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2664 llvm::Value *AnnotatedVal,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002665 StringRef AnnotationStr,
Julien Lerouge77f68bb2011-09-09 22:41:49 +00002666 SourceLocation Location);
2667
2668 /// Emit local annotations for the local variable V, declared by D.
2669 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2670
2671 /// Emit field annotations for the given field & value. Returns the
2672 /// annotation result.
2673 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2674
2675 //===--------------------------------------------------------------------===//
Daniel Dunbar0ffb1252008-08-04 16:51:22 +00002676 // Internal Helpers
2677 //===--------------------------------------------------------------------===//
Mike Stump0dd9e882009-02-08 23:14:22 +00002678
Chris Lattner0946ccd2008-11-11 07:41:27 +00002679 /// ContainsLabel - Return true if the statement contains a label in it. If
2680 /// this statement is not executed normally, it not containing a label means
2681 /// that we can just remove the code.
2682 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stump0dd9e882009-02-08 23:14:22 +00002683
Chris Lattneref425a62011-02-28 00:18:40 +00002684 /// containsBreak - Return true if the statement contains a break out of it.
2685 /// If the statement (recursively) contains a switch or loop with a break
2686 /// inside of it, this is fine.
2687 static bool containsBreak(const Stmt *S);
2688
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002689 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnerc2c90012011-02-27 23:02:32 +00002690 /// to a constant, or if it does but contains a label, return false. If it
2691 /// constant folds return true and set the boolean result in Result.
2692 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stump0dd9e882009-02-08 23:14:22 +00002693
Chris Lattneref425a62011-02-28 00:18:40 +00002694 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2695 /// to a constant, or if it does but contains a label, return false. If it
2696 /// constant folds return true and set the folded value.
Richard Trieue1ecdc12012-07-23 20:21:35 +00002697 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattneref425a62011-02-28 00:18:40 +00002698
Chris Lattner31a09842008-11-12 08:04:58 +00002699 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2700 /// if statement) to the specified blocks. Based on the condition, this might
2701 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattner9bc47e22008-11-12 07:46:33 +00002702 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +00002703 llvm::BasicBlock *FalseBlock);
Mike Stumpbe07f602009-12-14 21:58:14 +00002704
Richard Smith4def70d2012-10-09 19:52:38 +00002705 /// \brief Emit a description of a type in a format suitable for passing to
2706 /// a runtime sanitizer handler.
2707 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2708
2709 /// \brief Convert a value into a format suitable for passing to a runtime
2710 /// sanitizer handler.
2711 llvm::Value *EmitCheckValue(llvm::Value *V);
2712
2713 /// \brief Emit a description of a source location in a format suitable for
2714 /// passing to a runtime sanitizer handler.
2715 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2716
Will Dietzad954812012-12-02 19:50:33 +00002717 /// \brief Specify under what conditions this check can be recovered
2718 enum CheckRecoverableKind {
2719 /// Always terminate program execution if this check fails
2720 CRK_Unrecoverable,
2721 /// Check supports recovering, allows user to specify which
2722 CRK_Recoverable,
2723 /// Runtime conditionally aborts, always need to support recovery.
2724 CRK_AlwaysRecoverable
2725 };
2726
Richard Smithcc305612012-11-01 22:15:34 +00002727 /// \brief Create a basic block that will call a handler function in a
2728 /// sanitizer runtime with the provided arguments, and create a conditional
2729 /// branch to it.
Richard Smith4def70d2012-10-09 19:52:38 +00002730 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002731 ArrayRef<llvm::Constant *> StaticArgs,
2732 ArrayRef<llvm::Value *> DynamicArgs,
Will Dietzad954812012-12-02 19:50:33 +00002733 CheckRecoverableKind Recoverable);
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002734
Richard Smithcc305612012-11-01 22:15:34 +00002735 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2736 /// conditional branch to it, for the -ftrapv checks.
Chad Rosier78d85b12013-01-29 23:31:22 +00002737 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithcc305612012-11-01 22:15:34 +00002738
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002739 /// EmitCallArg - Emit a single call argument.
John McCall413ebdb2011-03-11 20:59:21 +00002740 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson21c9ad92010-03-30 03:27:09 +00002741
John McCall27360712010-05-26 22:34:26 +00002742 /// EmitDelegateCallArg - We are performing a delegate call; that
2743 /// is, the current function is delegating to another one. Produce
2744 /// a r-value suitable for passing the given parameter.
John McCall413ebdb2011-03-11 20:59:21 +00002745 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall27360712010-05-26 22:34:26 +00002746
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002747 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2748 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sands82500162012-04-10 08:23:07 +00002749 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbournec5096cb2011-10-27 19:19:51 +00002750
Chris Lattner31a09842008-11-12 08:04:58 +00002751private:
Rafael Espindolac3f89552012-03-24 16:50:34 +00002752 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +00002753 void EmitReturnOfRValue(RValue RV, QualType Ty);
2754
Daniel Dunbar56273772008-09-17 00:51:38 +00002755 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2756 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2757 ///
2758 /// \param AI - The first function argument of the expansion.
2759 /// \return The argument following the last expanded function
2760 /// argument.
Mike Stump0dd9e882009-02-08 23:14:22 +00002761 llvm::Function::arg_iterator
Daniel Dunbar56273772008-09-17 00:51:38 +00002762 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2763 llvm::Function::arg_iterator AI);
2764
Mike Stump0dd9e882009-02-08 23:14:22 +00002765 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2766 /// Ty, into individual arguments on the provided vector \arg Args. See
2767 /// ABIArgInfo::Expand.
2768 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner686775d2011-07-20 06:58:45 +00002769 SmallVector<llvm::Value*, 16> &Args,
Chris Lattner811bf362011-07-12 06:29:11 +00002770 llvm::FunctionType *IRFuncTy);
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002771
Chad Rosier42b60552012-08-23 20:00:18 +00002772 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlssonc8c7b182009-01-11 19:40:10 +00002773 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stump0dd9e882009-02-08 23:14:22 +00002774
Chad Rosier42b60552012-08-23 20:00:18 +00002775 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedman6d7cfd72010-07-16 00:55:21 +00002776 LValue InputValue, QualType InputType,
2777 std::string &ConstraintStr);
2778
Anders Carlsson0139bb92009-04-08 20:47:54 +00002779 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump1eb44332009-09-09 15:08:12 +00002780 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlssonaf23f692009-04-18 20:20:22 +00002781 /// argument types of the function being called.
2782 template<typename T>
2783 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson0139bb92009-04-08 20:47:54 +00002784 CallExpr::const_arg_iterator ArgBeg,
Anders Carlssonaf23f692009-04-18 20:20:22 +00002785 CallExpr::const_arg_iterator ArgEnd) {
2786 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson0139bb92009-04-08 20:47:54 +00002787
Anders Carlssonaf23f692009-04-18 20:20:22 +00002788 // First, use the argument types that the type info knows about
2789 if (CallArgTypeInfo) {
2790 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2791 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman44b0a3e2009-11-18 03:42:04 +00002792 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlssonaf23f692009-04-18 20:20:22 +00002793 QualType ArgType = *I;
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002794#ifndef NDEBUG
2795 QualType ActualArgType = Arg->getType();
2796 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002797 QualType ActualBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002798 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencer9cac4942010-10-19 06:39:39 +00002799 QualType ArgBaseType =
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002800 ArgType->getAs<PointerType>()->getPointeeType();
2801 if (ArgBaseType->isVariableArrayType()) {
2802 if (const VariableArrayType *VAT =
2803 getContext().getAsVariableArrayType(ActualBaseType)) {
2804 if (!VAT->getSizeExpr())
2805 ActualArgType = ArgType;
2806 }
2807 }
2808 }
Anders Carlssonaf23f692009-04-18 20:20:22 +00002809 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump1eb44332009-09-09 15:08:12 +00002810 getTypePtr() ==
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002811 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002812 "type mismatch in call argument!");
Fariborz Jahanian745da3a2010-09-24 17:30:16 +00002813#endif
John McCall413ebdb2011-03-11 20:59:21 +00002814 EmitCallArg(Args, *Arg, ArgType);
Anders Carlssonaf23f692009-04-18 20:20:22 +00002815 }
Mike Stump1eb44332009-09-09 15:08:12 +00002816
2817 // Either we've emitted all the call args, or we have a call to a
Anders Carlssonaf23f692009-04-18 20:20:22 +00002818 // variadic function.
Mike Stump1eb44332009-09-09 15:08:12 +00002819 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlssonaf23f692009-04-18 20:20:22 +00002820 "Extra arguments in non-variadic function!");
Mike Stump1eb44332009-09-09 15:08:12 +00002821
Anders Carlssonaf23f692009-04-18 20:20:22 +00002822 }
Mike Stump1eb44332009-09-09 15:08:12 +00002823
Anders Carlssonaf23f692009-04-18 20:20:22 +00002824 // If we still have any arguments, emit them using the type of the argument.
John McCall413ebdb2011-03-11 20:59:21 +00002825 for (; Arg != ArgEnd; ++Arg)
2826 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlssonaf23f692009-04-18 20:20:22 +00002827 }
John McCall492c4f92010-03-03 04:15:11 +00002828
2829 const TargetCodeGenInfo &getTargetHooks() const {
2830 return CGM.getTargetCodeGenInfo();
2831 }
John McCall744016d2010-07-06 23:57:41 +00002832
2833 void EmitDeclMetadata();
John McCallf0c11f72011-03-31 08:03:29 +00002834
2835 CodeGenModule::ByrefHelpers *
Chris Lattner2acc6e32011-07-18 04:24:23 +00002836 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf0c11f72011-03-31 08:03:29 +00002837 const AutoVarEmission &emission);
Dan Gohmanb49bd272012-02-16 00:57:37 +00002838
2839 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadf4c3db12012-03-02 18:34:30 +00002840
Eli Friedmanea93e402012-08-23 03:10:17 +00002841 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2842 /// value and compute our best estimate of the alignment of the pointee.
2843 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Reid Spencer5f016e22007-07-11 17:01:13 +00002844};
Mike Stump1eb44332009-09-09 15:08:12 +00002845
John McCall150b4622011-01-26 04:00:11 +00002846/// Helper class with most of the code for saving a value for a
2847/// conditional expression cleanup.
John McCall804b8072011-01-28 10:53:53 +00002848struct DominatingLLVMValue {
John McCall150b4622011-01-26 04:00:11 +00002849 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2850
2851 /// Answer whether the given value needs extra work to be saved.
2852 static bool needsSaving(llvm::Value *value) {
2853 // If it's not an instruction, we don't need to save.
2854 if (!isa<llvm::Instruction>(value)) return false;
2855
2856 // If it's an instruction in the entry block, we don't need to save.
2857 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2858 return (block != &block->getParent()->getEntryBlock());
2859 }
2860
2861 /// Try to save the given value.
2862 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2863 if (!needsSaving(value)) return saved_type(value, false);
2864
2865 // Otherwise we need an alloca.
2866 llvm::Value *alloca =
2867 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2868 CGF.Builder.CreateStore(value, alloca);
2869
2870 return saved_type(alloca, true);
2871 }
2872
2873 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2874 if (!value.getInt()) return value.getPointer();
2875 return CGF.Builder.CreateLoad(value.getPointer());
2876 }
2877};
2878
John McCall804b8072011-01-28 10:53:53 +00002879/// A partial specialization of DominatingValue for llvm::Values that
2880/// might be llvm::Instructions.
2881template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2882 typedef T *type;
John McCall150b4622011-01-26 04:00:11 +00002883 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCall804b8072011-01-28 10:53:53 +00002884 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2885 }
2886};
2887
2888/// A specialization of DominatingValue for RValue.
2889template <> struct DominatingValue<RValue> {
2890 typedef RValue type;
2891 class saved_type {
2892 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2893 AggregateAddress, ComplexAddress };
2894
2895 llvm::Value *Value;
2896 Kind K;
2897 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2898
2899 public:
2900 static bool needsSaving(RValue value);
2901 static saved_type save(CodeGenFunction &CGF, RValue value);
2902 RValue restore(CodeGenFunction &CGF);
2903
2904 // implementations in CGExprCXX.cpp
2905 };
2906
2907 static bool needsSaving(type value) {
2908 return saved_type::needsSaving(value);
2909 }
2910 static saved_type save(CodeGenFunction &CGF, type value) {
2911 return saved_type::save(CGF, value);
2912 }
2913 static type restore(CodeGenFunction &CGF, saved_type value) {
2914 return value.restore(CGF);
John McCall150b4622011-01-26 04:00:11 +00002915 }
2916};
2917
Reid Spencer5f016e22007-07-11 17:01:13 +00002918} // end namespace CodeGen
2919} // end namespace clang
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00002920
Reid Spencer5f016e22007-07-11 17:01:13 +00002921#endif