blob: 46848ae2d7ee7c8b7c06d024b2308f990d57380e [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Chris Lattnerbed31442007-05-28 01:07:47 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stumpfc496822009-02-08 23:14:22 +000010// This is the internal per-function state used for llvm translation.
Chris Lattnerbed31442007-05-28 01:07:47 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattnerc18bfbb2008-02-29 17:10:38 +000014#ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15#define CLANG_CODEGEN_CODEGENFUNCTION_H
Chris Lattnerbed31442007-05-28 01:07:47 +000016
Daniel Dunbarcb463852008-11-01 01:53:16 +000017#include "CGBuilder.h"
Eric Christophera9d34972011-10-19 00:43:52 +000018#include "CGDebugInfo.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000019#include "CGValue.h"
Chandler Carruth3a022472012-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 Dunbar97db84c2008-08-23 03:46:30 +000033
Chris Lattnerbed31442007-05-28 01:07:47 +000034namespace llvm {
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000035 class BasicBlock;
Benjamin Kramer9cd050a2009-08-11 17:46:57 +000036 class LLVMContext;
David Chisnall9eecafa2010-05-01 11:15:56 +000037 class MDNode;
Chris Lattnerbed31442007-05-28 01:07:47 +000038 class Module;
Daniel Dunbar2efd5382008-09-30 01:06:03 +000039 class SwitchInst;
Daniel Dunbarb5aacc22009-10-19 01:21:05 +000040 class Twine;
Daniel Dunbar9b1335e2008-11-19 09:36:46 +000041 class Value;
John McCallbd309292010-07-06 01:34:17 +000042 class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000043}
44
Chris Lattnerbed31442007-05-28 01:07:47 +000045namespace clang {
46 class ASTContext;
John McCall08ef4662011-11-10 08:15:53 +000047 class BlockDecl;
Anders Carlsson0a637412009-05-29 21:03:38 +000048 class CXXDestructorDecl;
Richard Smith02e85f32011-04-14 22:09:26 +000049 class CXXForRangeStmt;
Anders Carlsson52d78a52009-09-27 18:58:34 +000050 class CXXTryStmt;
Chris Lattner84915fa2007-06-02 04:16:21 +000051 class Decl;
Chris Lattnerc8e630e2011-02-17 07:39:24 +000052 class LabelDecl;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000053 class EnumConstantDecl;
Chris Lattnerbed31442007-05-28 01:07:47 +000054 class FunctionDecl;
Douglas Gregordeaad8c2009-02-26 23:50:07 +000055 class FunctionProtoType;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000056 class LabelStmt;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +000057 class ObjCContainerDecl;
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +000058 class ObjCInterfaceDecl;
59 class ObjCIvarDecl;
Chris Lattner4bd55962008-03-30 23:03:07 +000060 class ObjCMethodDecl;
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +000061 class ObjCImplementationDecl;
Daniel Dunbar89654ee2008-08-26 08:29:31 +000062 class ObjCPropertyImplDecl;
Chris Lattner2ccb73b2007-06-16 00:16:26 +000063 class TargetInfo;
John McCalld4f4b7f2010-03-03 04:15:11 +000064 class TargetCodeGenInfo;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000065 class VarDecl;
Chris Lattnerf0b64d72009-04-26 01:32:48 +000066 class ObjCForCollectionStmt;
67 class ObjCAtTryStmt;
68 class ObjCAtThrowStmt;
69 class ObjCAtSynchronizedStmt;
John McCall31168b02011-06-15 23:02:42 +000070 class ObjCAutoreleasePoolStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000071
Chris Lattnerbed31442007-05-28 01:07:47 +000072namespace CodeGen {
Devang Patel3e11cce2007-10-23 02:10:49 +000073 class CodeGenTypes;
Daniel Dunbar7633cbf2009-02-02 21:43:58 +000074 class CGFunctionInfo;
Mike Stumpfc496822009-02-08 23:14:22 +000075 class CGRecordLayout;
John McCall9d42f0f2010-05-21 04:11:14 +000076 class CGBlockInfo;
John McCall5d865c322010-08-31 07:33:07 +000077 class CGCXXABI;
John McCallad7c5c12011-02-08 08:22:06 +000078 class BlockFlags;
79 class BlockFieldFlags;
Mike Stumpfc496822009-02-08 23:14:22 +000080
John McCall47fb9502013-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 McCallbd309292010-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 McCallad5d61e2010-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 McCallbd309292010-07-06 01:34:17 +0000103
John McCallad5d61e2010-07-23 21:56:41 +0000104 /// The ultimate destination of the branch.
John McCallbd309292010-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 McCallad5d61e2010-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 McCallbd309292010-07-06 01:34:17 +0000115};
116
John McCallcb5f77f2011-01-28 10:53:53 +0000117template <class T> struct InvariantValue {
John McCallce1de612011-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 McCallcb5f77f2011-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 McCallce1de612011-01-26 04:00:11 +0000138
John McCall612942d2010-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 McCall2b7fc382010-07-13 20:32:21 +0000149
John McCallbd309292010-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 McCall324277852010-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 McCallad5d61e2010-07-23 21:56:41 +0000173 bool encloses(stable_iterator I) const { return Size <= I.Size; }
John McCall324277852010-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 McCallad5d61e2010-07-23 21:56:41 +0000179 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
John McCall8f510412010-07-21 00:40:03 +0000180
John McCallbd309292010-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 McCallcda666c2010-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 McCall2b7fc382010-07-13 20:32:21 +0000193 ///
John McCallcda666c2010-07-21 07:22:38 +0000194 /// Cleanup implementations should generally be declared in an
John McCall2b7fc382010-07-13 20:32:21 +0000195 /// anonymous namespace.
John McCallcda666c2010-07-21 07:22:38 +0000196 class Cleanup {
John McCall5fcf8da2011-07-12 00:15:30 +0000197 // Anchor the construction vtable.
198 virtual void anchor();
John McCall2b7fc382010-07-13 20:32:21 +0000199 public:
John McCall30317fd2011-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 McCall5fcf8da2011-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 McCall11e577b2010-07-13 23:19:49 +0000230
John McCall2b7fc382010-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 Gribenkoadba9be2012-08-23 17:58:28 +0000236 // \param flags cleanup kind.
John McCall30317fd2011-07-12 20:27:29 +0000237 virtual void Emit(CodeGenFunction &CGF, Flags flags) = 0;
John McCall2b7fc382010-07-13 20:32:21 +0000238 };
239
John McCallce1de612011-01-26 04:00:11 +0000240 /// ConditionalCleanupN stores the saved form of its N parameters,
241 /// then restores them and performs the cleanup.
John McCalle4df6c82011-01-28 08:37:24 +0000242 template <class T, class A0>
243 class ConditionalCleanup1 : public Cleanup {
John McCallcb5f77f2011-01-28 10:53:53 +0000244 typedef typename DominatingValue<A0>::saved_type A0_saved;
John McCalle4df6c82011-01-28 08:37:24 +0000245 A0_saved a0_saved;
246
John McCall30317fd2011-07-12 20:27:29 +0000247 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallcb5f77f2011-01-28 10:53:53 +0000248 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
John McCall30317fd2011-07-12 20:27:29 +0000249 T(a0).Emit(CGF, flags);
John McCalle4df6c82011-01-28 08:37:24 +0000250 }
251
252 public:
253 ConditionalCleanup1(A0_saved a0)
254 : a0_saved(a0) {}
255 };
256
John McCallce1de612011-01-26 04:00:11 +0000257 template <class T, class A0, class A1>
John McCalle4df6c82011-01-28 08:37:24 +0000258 class ConditionalCleanup2 : public Cleanup {
John McCallcb5f77f2011-01-28 10:53:53 +0000259 typedef typename DominatingValue<A0>::saved_type A0_saved;
260 typedef typename DominatingValue<A1>::saved_type A1_saved;
John McCallf256eb52011-01-26 19:15:39 +0000261 A0_saved a0_saved;
262 A1_saved a1_saved;
John McCallce1de612011-01-26 04:00:11 +0000263
John McCall30317fd2011-07-12 20:27:29 +0000264 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallcb5f77f2011-01-28 10:53:53 +0000265 A0 a0 = DominatingValue<A0>::restore(CGF, a0_saved);
266 A1 a1 = DominatingValue<A1>::restore(CGF, a1_saved);
John McCall30317fd2011-07-12 20:27:29 +0000267 T(a0, a1).Emit(CGF, flags);
John McCallce1de612011-01-26 04:00:11 +0000268 }
269
270 public:
John McCalle4df6c82011-01-28 08:37:24 +0000271 ConditionalCleanup2(A0_saved a0, A1_saved a1)
272 : a0_saved(a0), a1_saved(a1) {}
John McCallce1de612011-01-26 04:00:11 +0000273 };
274
Douglas Gregor58df5092011-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 McCall30317fd2011-07-12 20:27:29 +0000284 void Emit(CodeGenFunction &CGF, Flags flags) {
Douglas Gregor58df5092011-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 McCall30317fd2011-07-12 20:27:29 +0000288 T(a0, a1, a2).Emit(CGF, flags);
Douglas Gregor58df5092011-06-22 16:12:01 +0000289 }
290
291 public:
292 ConditionalCleanup3(A0_saved a0, A1_saved a1, A2_saved a2)
John McCall5fcf8da2011-07-12 00:15:30 +0000293 : a0_saved(a0), a1_saved(a1), a2_saved(a2) {}
Douglas Gregor58df5092011-06-22 16:12:01 +0000294 };
295
John McCall4bd0fb12011-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 McCall30317fd2011-07-12 20:27:29 +0000307 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall4bd0fb12011-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 McCall30317fd2011-07-12 20:27:29 +0000312 T(a0, a1, a2, a3).Emit(CGF, flags);
John McCall4bd0fb12011-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 McCallbd309292010-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 McCall8e4c74b2011-08-11 02:22:43 +0000339 /// The innermost EH scope on the stack.
340 stable_iterator InnermostEHScope;
John McCallad5d61e2010-07-23 21:56:41 +0000341
John McCallbd309292010-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 Lattner01cf8db2011-07-20 06:58:45 +0000359 SmallVector<BranchFixup, 8> BranchFixups;
John McCallbd309292010-07-06 01:34:17 +0000360
361 char *allocate(size_t Size);
362
John McCallcda666c2010-07-21 07:22:38 +0000363 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCall2b7fc382010-07-13 20:32:21 +0000364
John McCallbd309292010-07-06 01:34:17 +0000365public:
366 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
367 InnermostNormalCleanup(stable_end()),
John McCall8e4c74b2011-08-11 02:22:43 +0000368 InnermostEHScope(stable_end()) {}
John McCallbd309292010-07-06 01:34:17 +0000369 ~EHScopeStack() { delete[] StartOfBuffer; }
370
John McCall2b7fc382010-07-13 20:32:21 +0000371 // Variadic templates would make this not terrible.
372
373 /// Push a lazily-created cleanup on the stack.
John McCall5c08ab92010-07-13 22:12:14 +0000374 template <class T>
John McCallcda666c2010-07-21 07:22:38 +0000375 void pushCleanup(CleanupKind Kind) {
376 void *Buffer = pushCleanup(Kind, sizeof(T));
377 Cleanup *Obj = new(Buffer) T();
John McCall5c08ab92010-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 McCallcda666c2010-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 McCall5c08ab92010-07-13 22:12:14 +0000386 (void) Obj;
387 }
388
389 /// Push a lazily-created cleanup on the stack.
John McCall2b7fc382010-07-13 20:32:21 +0000390 template <class T, class A0, class A1>
John McCallcda666c2010-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 McCall2b7fc382010-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 McCallcda666c2010-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 McCall2b7fc382010-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 McCallcda666c2010-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 McCall2b7fc382010-07-13 20:32:21 +0000410 (void) Obj;
411 }
412
John McCall906da4b2010-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 McCallcda666c2010-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 McCall906da4b2010-07-21 05:47:49 +0000418 (void) Obj;
419 }
420
John McCall824c2f52010-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 McCall8e4c74b2011-08-11 02:22:43 +0000440 /// Pops a cleanup scope off the stack. This is private to CGCleanup.cpp.
John McCallbd309292010-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 McCall8e4c74b2011-08-11 02:22:43 +0000448 /// Pops a catch scope off the stack. This is private to CGException.cpp.
John McCallbd309292010-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 McCall8e4c74b2011-08-11 02:22:43 +0000467 return InnermostEHScope != stable_end();
John McCallbd309292010-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 McCall8e4c74b2011-08-11 02:22:43 +0000480 stable_iterator getInnermostActiveNormalCleanup() const;
John McCallbd309292010-07-06 01:34:17 +0000481
John McCall8e4c74b2011-08-11 02:22:43 +0000482 stable_iterator getInnermostEHScope() const {
483 return InnermostEHScope;
John McCallbd309292010-07-06 01:34:17 +0000484 }
485
John McCall8e4c74b2011-08-11 02:22:43 +0000486 stable_iterator getInnermostActiveEHScope() const;
John McCallbd309292010-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 McCallbd309292010-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 McCallad5d61e2010-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 McCallf09d96f2010-09-18 02:24:39 +0000539 /// ResolveAllBranchFixups.
John McCallad5d61e2010-07-23 21:56:41 +0000540 void clearFixups() { BranchFixups.clear(); }
John McCallbd309292010-07-06 01:34:17 +0000541};
542
Chris Lattnerbed31442007-05-28 01:07:47 +0000543/// CodeGenFunction - This class organizes the per-function state that is used
544/// while generating LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000545class CodeGenFunction : public CodeGenTypeCache {
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000546 CodeGenFunction(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
547 void operator=(const CodeGenFunction &) LLVM_DELETED_FUNCTION;
John McCall5d865c322010-08-31 07:33:07 +0000548
549 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000550public:
John McCallad5d61e2010-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 McCallbd309292010-07-06 01:34:17 +0000553 struct JumpDest {
John McCallad5d61e2010-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. Spencerf5a1fbc2010-10-19 06:39:39 +0000564
John McCallad5d61e2010-07-23 21:56:41 +0000565 private:
John McCallbd309292010-07-06 01:34:17 +0000566 llvm::BasicBlock *Block;
567 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000568 unsigned Index;
569 };
570
Chris Lattnerbed31442007-05-28 01:07:47 +0000571 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000572 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000573
Chris Lattner96d72562007-08-21 16:57:55 +0000574 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000575 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000576
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000577 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
578 /// This excludes BlockDecls.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000579 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000580 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
581 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000582 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000583 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000584 llvm::Function *CurFn;
585
Mike Stumpbee78dd2009-12-04 23:26:17 +0000586 /// CurGD - The GlobalDecl for the current function being compiled.
587 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000588
John McCall31168b02011-06-15 23:02:42 +0000589 /// PrologueCleanupDepth - The cleanup depth enclosing all the
590 /// cleanups associated with the parameters.
591 EHScopeStack::stable_iterator PrologueCleanupDepth;
592
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000593 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000594 JumpDest ReturnBlock;
595
Mike Stumpfc496822009-02-08 23:14:22 +0000596 /// ReturnValue - The temporary alloca to hold the return value. This is null
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000597 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000598 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000599
Chris Lattner03df1222007-06-02 04:53:11 +0000600 /// AllocaInsertPoint - This is an instruction in the entry block before which
601 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000602 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000603
Nuno Lopes3d6311d2012-05-08 22:10:46 +0000604 /// BoundsChecking - Emit run-time bounds checks. Higher values mean
605 /// potentially higher performance penalties.
606 unsigned char BoundsChecking;
607
Richard Smithb1b0ab42012-11-05 22:21:05 +0000608 /// \brief Whether any type-checking sanitizers are enabled. If \c false,
609 /// calls to EmitTypeCheck can be skipped.
610 bool SanitizePerformTypeCheck;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000611
Will Dietzf54319c2013-01-18 11:30:38 +0000612 /// \brief Sanitizer options to use for this function.
613 const SanitizerOptions *SanOpts;
614
John McCall31168b02011-06-15 23:02:42 +0000615 /// In ARC, whether we should autorelease the return value.
616 bool AutoreleaseResult;
617
John McCallad7c5c12011-02-08 08:22:06 +0000618 const CodeGen::CGBlockInfo *BlockInfo;
619 llvm::Value *BlockPointer;
620
Eli Friedman9fbeba02012-02-11 02:57:39 +0000621 llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
622 FieldDecl *LambdaThisCaptureField;
623
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000624 /// \brief A mapping from NRVO variables to the flags used to indicate
625 /// when the NRVO has been applied to this variable.
626 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000627
John McCallbd309292010-07-06 01:34:17 +0000628 EHScopeStack EHStack;
629
John McCallad5d61e2010-07-23 21:56:41 +0000630 /// i32s containing the indexes of the cleanup destinations.
631 llvm::AllocaInst *NormalCleanupDest;
John McCallad5d61e2010-07-23 21:56:41 +0000632
633 unsigned NextCleanupDestIndex;
634
John McCall08ef4662011-11-10 08:15:53 +0000635 /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
636 CGBlockInfo *FirstBlockInfo;
637
John McCall8e4c74b2011-08-11 02:22:43 +0000638 /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
639 llvm::BasicBlock *EHResumeBlock;
640
Bill Wendlingf0724e82011-09-19 20:31:14 +0000641 /// The exception slot. All landing pads write the current exception pointer
642 /// into this alloca.
John McCallbd309292010-07-06 01:34:17 +0000643 llvm::Value *ExceptionSlot;
644
Bill Wendlingf0724e82011-09-19 20:31:14 +0000645 /// The selector slot. Under the MandatoryCleanup model, all landing pads
646 /// write the current selector value into this alloca.
John McCall9b382dd2011-05-28 21:13:02 +0000647 llvm::AllocaInst *EHSelectorSlot;
648
John McCallbd309292010-07-06 01:34:17 +0000649 /// Emits a landing pad for the current EH stack.
650 llvm::BasicBlock *EmitLandingPad();
651
652 llvm::BasicBlock *getInvokeDestImpl();
653
John McCallce1de612011-01-26 04:00:11 +0000654 template <class T>
John McCallcb5f77f2011-01-28 10:53:53 +0000655 typename DominatingValue<T>::saved_type saveValueInCond(T value) {
656 return DominatingValue<T>::save(*this, value);
John McCallce1de612011-01-26 04:00:11 +0000657 }
658
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000659public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000660 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
661 /// rethrows.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000662 SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000663
John McCall6b0feb72011-06-22 02:32:12 +0000664 /// A class controlling the emission of a finally block.
665 class FinallyInfo {
666 /// Where the catchall's edge through the cleanup should go.
667 JumpDest RethrowDest;
Anders Carlsson66c384a2009-02-08 07:46:24 +0000668
John McCall6b0feb72011-06-22 02:32:12 +0000669 /// A function to call to enter the catch.
670 llvm::Constant *BeginCatchFn;
671
672 /// An i1 variable indicating whether or not the @finally is
673 /// running for an exception.
674 llvm::AllocaInst *ForEHVar;
675
676 /// An i8* variable into which the exception pointer to rethrow
677 /// has been saved.
678 llvm::AllocaInst *SavedExnVar;
679
680 public:
681 void enter(CodeGenFunction &CGF, const Stmt *Finally,
682 llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
683 llvm::Constant *rethrowFn);
684 void exit(CodeGenFunction &CGF);
685 };
Mike Stumpaff69af2009-12-09 03:35:49 +0000686
John McCallce1de612011-01-26 04:00:11 +0000687 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
688 /// current full-expression. Safe against the possibility that
689 /// we're currently inside a conditionally-evaluated expression.
John McCalle4df6c82011-01-28 08:37:24 +0000690 template <class T, class A0>
691 void pushFullExprCleanup(CleanupKind kind, A0 a0) {
692 // If we're not in a conditional branch, or if none of the
693 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000694 if (!isInConditionalBranch())
695 return EHStack.pushCleanup<T>(kind, a0);
John McCalle4df6c82011-01-28 08:37:24 +0000696
John McCallcb5f77f2011-01-28 10:53:53 +0000697 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
John McCalle4df6c82011-01-28 08:37:24 +0000698
699 typedef EHScopeStack::ConditionalCleanup1<T, A0> CleanupType;
700 EHStack.pushCleanup<CleanupType>(kind, a0_saved);
701 initFullExprCleanup();
702 }
703
704 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
705 /// current full-expression. Safe against the possibility that
706 /// we're currently inside a conditionally-evaluated expression.
John McCallce1de612011-01-26 04:00:11 +0000707 template <class T, class A0, class A1>
708 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
709 // If we're not in a conditional branch, or if none of the
710 // arguments requires saving, then use the unconditional cleanup.
John McCall5fcf8da2011-07-12 00:15:30 +0000711 if (!isInConditionalBranch())
712 return EHStack.pushCleanup<T>(kind, a0, a1);
John McCallce1de612011-01-26 04:00:11 +0000713
John McCallcb5f77f2011-01-28 10:53:53 +0000714 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
715 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
John McCallce1de612011-01-26 04:00:11 +0000716
717 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
John McCalle4df6c82011-01-28 08:37:24 +0000718 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved);
719 initFullExprCleanup();
John McCallce1de612011-01-26 04:00:11 +0000720 }
721
Douglas Gregor58df5092011-06-22 16:12:01 +0000722 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
723 /// current full-expression. Safe against the possibility that
724 /// we're currently inside a conditionally-evaluated expression.
725 template <class T, class A0, class A1, class A2>
726 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2) {
727 // If we're not in a conditional branch, or if none of the
728 // arguments requires saving, then use the unconditional cleanup.
729 if (!isInConditionalBranch()) {
John McCall5fcf8da2011-07-12 00:15:30 +0000730 return EHStack.pushCleanup<T>(kind, a0, a1, a2);
Douglas Gregor58df5092011-06-22 16:12:01 +0000731 }
732
733 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
734 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
735 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
736
737 typedef EHScopeStack::ConditionalCleanup3<T, A0, A1, A2> CleanupType;
738 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved, a2_saved);
739 initFullExprCleanup();
740 }
741
John McCall4bd0fb12011-07-12 16:41:08 +0000742 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
743 /// current full-expression. Safe against the possibility that
744 /// we're currently inside a conditionally-evaluated expression.
745 template <class T, class A0, class A1, class A2, class A3>
746 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1, A2 a2, A3 a3) {
747 // If we're not in a conditional branch, or if none of the
748 // arguments requires saving, then use the unconditional cleanup.
749 if (!isInConditionalBranch()) {
750 return EHStack.pushCleanup<T>(kind, a0, a1, a2, a3);
751 }
752
753 typename DominatingValue<A0>::saved_type a0_saved = saveValueInCond(a0);
754 typename DominatingValue<A1>::saved_type a1_saved = saveValueInCond(a1);
755 typename DominatingValue<A2>::saved_type a2_saved = saveValueInCond(a2);
756 typename DominatingValue<A3>::saved_type a3_saved = saveValueInCond(a3);
757
758 typedef EHScopeStack::ConditionalCleanup4<T, A0, A1, A2, A3> CleanupType;
759 EHStack.pushCleanup<CleanupType>(kind, a0_saved, a1_saved,
760 a2_saved, a3_saved);
761 initFullExprCleanup();
762 }
763
John McCallf4beacd2011-11-10 10:43:54 +0000764 /// Set up the last cleaup that was pushed as a conditional
765 /// full-expression cleanup.
766 void initFullExprCleanup();
767
John McCallbd309292010-07-06 01:34:17 +0000768 /// PushDestructorCleanup - Push a cleanup to call the
769 /// complete-object destructor of an object of the given type at the
770 /// given address. Does nothing if T is not a C++ class type with a
771 /// non-trivial destructor.
772 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
773
John McCall8680f872010-07-21 06:29:51 +0000774 /// PushDestructorCleanup - Push a cleanup to call the
775 /// complete-object variant of the given destructor on the object at
776 /// the given address.
777 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
778 llvm::Value *Addr);
779
John McCallbd309292010-07-06 01:34:17 +0000780 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
781 /// process all branch fixups.
John McCallad5d61e2010-07-23 21:56:41 +0000782 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000783
John McCall824c2f52010-09-14 07:57:04 +0000784 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
785 /// The block cannot be reactivated. Pops it if it's the top of the
786 /// stack.
John McCallf4beacd2011-11-10 10:43:54 +0000787 ///
788 /// \param DominatingIP - An instruction which is known to
789 /// dominate the current IP (if set) and which lies along
790 /// all paths of execution between the current IP and the
791 /// the point at which the cleanup comes into scope.
792 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
793 llvm::Instruction *DominatingIP);
John McCall824c2f52010-09-14 07:57:04 +0000794
795 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
796 /// Cannot be used to resurrect a deactivated cleanup.
John McCallf4beacd2011-11-10 10:43:54 +0000797 ///
798 /// \param DominatingIP - An instruction which is known to
799 /// dominate the current IP (if set) and which lies along
800 /// all paths of execution between the current IP and the
801 /// the point at which the cleanup comes into scope.
802 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
803 llvm::Instruction *DominatingIP);
John McCall612942d2010-08-13 21:20:51 +0000804
John McCallbd309292010-07-06 01:34:17 +0000805 /// \brief Enters a new scope for capturing cleanups, all of which
806 /// will be executed once the scope is exited.
807 class RunCleanupsScope {
John McCallbd309292010-07-06 01:34:17 +0000808 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000809 bool OldDidCallStackSave;
John McCall07e60262013-03-01 01:24:35 +0000810 protected:
Douglas Gregor680f8612009-11-24 21:15:44 +0000811 bool PerformCleanup;
John McCall07e60262013-03-01 01:24:35 +0000812 private:
Douglas Gregor965f4502009-11-24 16:43:22 +0000813
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000814 RunCleanupsScope(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
815 void operator=(const RunCleanupsScope &) LLVM_DELETED_FUNCTION;
Douglas Gregor965f4502009-11-24 16:43:22 +0000816
Eric Christophera9d34972011-10-19 00:43:52 +0000817 protected:
818 CodeGenFunction& CGF;
Will Dietzf54319c2013-01-18 11:30:38 +0000819
Douglas Gregor965f4502009-11-24 16:43:22 +0000820 public:
821 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000822 explicit RunCleanupsScope(CodeGenFunction &CGF)
Eric Christophera9d34972011-10-19 00:43:52 +0000823 : PerformCleanup(true), CGF(CGF)
Douglas Gregor680f8612009-11-24 21:15:44 +0000824 {
John McCallbd309292010-07-06 01:34:17 +0000825 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor965f4502009-11-24 16:43:22 +0000826 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000827 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000828 }
829
830 /// \brief Exit this cleanup scope, emitting any accumulated
831 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000832 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000833 if (PerformCleanup) {
834 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallbd309292010-07-06 01:34:17 +0000835 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor680f8612009-11-24 21:15:44 +0000836 }
837 }
838
839 /// \brief Determine whether this scope requires any cleanups.
840 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000841 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000842 }
843
844 /// \brief Force the emission of cleanups now, instead of waiting
845 /// until this object is destroyed.
846 void ForceCleanup() {
847 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000848 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallbd309292010-07-06 01:34:17 +0000849 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor680f8612009-11-24 21:15:44 +0000850 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000851 }
852 };
853
Eric Christophera9d34972011-10-19 00:43:52 +0000854 class LexicalScope: protected RunCleanupsScope {
855 SourceRange Range;
Eric Christophera9d34972011-10-19 00:43:52 +0000856
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000857 LexicalScope(const LexicalScope &) LLVM_DELETED_FUNCTION;
858 void operator=(const LexicalScope &) LLVM_DELETED_FUNCTION;
Eric Christophera9d34972011-10-19 00:43:52 +0000859
860 public:
861 /// \brief Enter a new cleanup scope.
862 explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
John McCall07e60262013-03-01 01:24:35 +0000863 : RunCleanupsScope(CGF), Range(Range) {
Eric Christophera9d34972011-10-19 00:43:52 +0000864 if (CGDebugInfo *DI = CGF.getDebugInfo())
865 DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
866 }
867
868 /// \brief Exit this cleanup scope, emitting any accumulated
869 /// cleanups.
870 ~LexicalScope() {
John McCall07e60262013-03-01 01:24:35 +0000871 if (PerformCleanup) endLexicalScope();
Eric Christophera9d34972011-10-19 00:43:52 +0000872 }
873
874 /// \brief Force the emission of cleanups now, instead of waiting
875 /// until this object is destroyed.
876 void ForceCleanup() {
877 RunCleanupsScope::ForceCleanup();
John McCalle739a492013-03-01 01:38:54 +0000878 endLexicalScope();
John McCall07e60262013-03-01 01:24:35 +0000879 }
880
881 private:
882 void endLexicalScope() {
883 if (CGDebugInfo *DI = CGF.getDebugInfo())
Eric Christophera9d34972011-10-19 00:43:52 +0000884 DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
Eric Christophera9d34972011-10-19 00:43:52 +0000885 }
886 };
887
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000888
John McCallbd309292010-07-06 01:34:17 +0000889 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
890 /// the cleanup blocks that have been added.
891 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000892
John McCallad5d61e2010-07-23 21:56:41 +0000893 void ResolveBranchFixups(llvm::BasicBlock *Target);
894
John McCallbd309292010-07-06 01:34:17 +0000895 /// The given basic block lies in the current EH scope, but may be a
896 /// target of a potentially scope-crossing jump; get a stable handle
897 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000898 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000899 return JumpDest(Target,
900 EHStack.getInnermostNormalCleanup(),
901 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000902 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000903
John McCallbd309292010-07-06 01:34:17 +0000904 /// The given basic block lies in the current EH scope, but may be a
905 /// target of a potentially scope-crossing jump; get a stable handle
906 /// to which we can perform this jump later.
Chris Lattner01cf8db2011-07-20 06:58:45 +0000907 JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
John McCallad5d61e2010-07-23 21:56:41 +0000908 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000909 }
910
911 /// EmitBranchThroughCleanup - Emit a branch from the current insert
912 /// block through the normal cleanup handling code (if any) and then
913 /// on to \arg Dest.
914 void EmitBranchThroughCleanup(JumpDest Dest);
Chris Lattnerbc204c82011-04-17 00:54:30 +0000915
916 /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
917 /// specified destination obviously has no cleanups to run. 'false' is always
918 /// a conservatively correct answer for this method.
919 bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
John McCallbd309292010-07-06 01:34:17 +0000920
John McCall8e4c74b2011-08-11 02:22:43 +0000921 /// popCatchScope - Pops the catch scope at the top of the EHScope
922 /// stack, emitting any required code (other than the catch handlers
923 /// themselves).
924 void popCatchScope();
John McCallad5d61e2010-07-23 21:56:41 +0000925
David Chisnall9a837be2012-11-07 16:50:40 +0000926 llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
John McCall8e4c74b2011-08-11 02:22:43 +0000927 llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
Mike Stumpfc496822009-02-08 23:14:22 +0000928
John McCallce1de612011-01-26 04:00:11 +0000929 /// An object to manage conditionally-evaluated expressions.
930 class ConditionalEvaluation {
931 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000932
John McCallce1de612011-01-26 04:00:11 +0000933 public:
934 ConditionalEvaluation(CodeGenFunction &CGF)
935 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000936
John McCallce1de612011-01-26 04:00:11 +0000937 void begin(CodeGenFunction &CGF) {
938 assert(CGF.OutermostConditional != this);
939 if (!CGF.OutermostConditional)
940 CGF.OutermostConditional = this;
941 }
942
943 void end(CodeGenFunction &CGF) {
944 assert(CGF.OutermostConditional != 0);
945 if (CGF.OutermostConditional == this)
946 CGF.OutermostConditional = 0;
947 }
948
949 /// Returns a block which will be executed prior to each
950 /// evaluation of the conditional code.
951 llvm::BasicBlock *getStartingBlock() const {
952 return StartBB;
953 }
954 };
Mike Stump11289f42009-09-09 15:08:12 +0000955
John McCall7f9c92a2010-09-17 00:50:28 +0000956 /// isInConditionalBranch - Return true if we're currently emitting
957 /// one branch or the other of a conditional expression.
John McCallce1de612011-01-26 04:00:11 +0000958 bool isInConditionalBranch() const { return OutermostConditional != 0; }
959
John McCallf4beacd2011-11-10 10:43:54 +0000960 void setBeforeOutermostConditional(llvm::Value *value, llvm::Value *addr) {
961 assert(isInConditionalBranch());
962 llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
963 new llvm::StoreInst(value, addr, &block->back());
964 }
965
John McCallce1de612011-01-26 04:00:11 +0000966 /// An RAII object to record that we're evaluating a statement
967 /// expression.
968 class StmtExprEvaluation {
969 CodeGenFunction &CGF;
970
971 /// We have to save the outermost conditional: cleanups in a
972 /// statement expression aren't conditional just because the
973 /// StmtExpr is.
974 ConditionalEvaluation *SavedOutermostConditional;
975
976 public:
977 StmtExprEvaluation(CodeGenFunction &CGF)
978 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
979 CGF.OutermostConditional = 0;
980 }
981
982 ~StmtExprEvaluation() {
983 CGF.OutermostConditional = SavedOutermostConditional;
984 CGF.EnsureInsertPoint();
985 }
986 };
John McCall1bf58462011-02-16 08:02:54 +0000987
John McCallc07a0c72011-02-17 10:25:35 +0000988 /// An object which temporarily prevents a value from being
989 /// destroyed by aggressive peephole optimizations that assume that
990 /// all uses of a value have been realized in the IR.
991 class PeepholeProtection {
992 llvm::Instruction *Inst;
993 friend class CodeGenFunction;
994
995 public:
996 PeepholeProtection() : Inst(0) {}
John McCallfe96e0b2011-11-06 09:01:30 +0000997 };
John McCallc07a0c72011-02-17 10:25:35 +0000998
John McCallfe96e0b2011-11-06 09:01:30 +0000999 /// A non-RAII class containing all the information about a bound
1000 /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
1001 /// this which makes individual mappings very simple; using this
1002 /// class directly is useful when you have a variable number of
1003 /// opaque values or don't want the RAII functionality for some
1004 /// reason.
1005 class OpaqueValueMappingData {
John McCall1bf58462011-02-16 08:02:54 +00001006 const OpaqueValueExpr *OpaqueValue;
John McCallc07a0c72011-02-17 10:25:35 +00001007 bool BoundLValue;
1008 CodeGenFunction::PeepholeProtection Protection;
John McCall1bf58462011-02-16 08:02:54 +00001009
John McCallfe96e0b2011-11-06 09:01:30 +00001010 OpaqueValueMappingData(const OpaqueValueExpr *ov,
1011 bool boundLValue)
1012 : OpaqueValue(ov), BoundLValue(boundLValue) {}
John McCall1bf58462011-02-16 08:02:54 +00001013 public:
John McCallfe96e0b2011-11-06 09:01:30 +00001014 OpaqueValueMappingData() : OpaqueValue(0) {}
1015
John McCallc07a0c72011-02-17 10:25:35 +00001016 static bool shouldBindAsLValue(const Expr *expr) {
John McCall9a549612011-11-08 22:54:08 +00001017 // gl-values should be bound as l-values for obvious reasons.
1018 // Records should be bound as l-values because IR generation
1019 // always keeps them in memory. Expressions of function type
1020 // act exactly like l-values but are formally required to be
1021 // r-values in C.
1022 return expr->isGLValue() ||
1023 expr->getType()->isRecordType() ||
1024 expr->getType()->isFunctionType();
John McCallc07a0c72011-02-17 10:25:35 +00001025 }
1026
John McCallfe96e0b2011-11-06 09:01:30 +00001027 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1028 const OpaqueValueExpr *ov,
1029 const Expr *e) {
1030 if (shouldBindAsLValue(ov))
1031 return bind(CGF, ov, CGF.EmitLValue(e));
1032 return bind(CGF, ov, CGF.EmitAnyExpr(e));
1033 }
1034
1035 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1036 const OpaqueValueExpr *ov,
1037 const LValue &lv) {
1038 assert(shouldBindAsLValue(ov));
1039 CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
1040 return OpaqueValueMappingData(ov, true);
1041 }
1042
1043 static OpaqueValueMappingData bind(CodeGenFunction &CGF,
1044 const OpaqueValueExpr *ov,
1045 const RValue &rv) {
1046 assert(!shouldBindAsLValue(ov));
1047 CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
1048
1049 OpaqueValueMappingData data(ov, false);
1050
1051 // Work around an extremely aggressive peephole optimization in
1052 // EmitScalarConversion which assumes that all other uses of a
1053 // value are extant.
1054 data.Protection = CGF.protectFromPeepholes(rv);
1055
1056 return data;
1057 }
1058
1059 bool isValid() const { return OpaqueValue != 0; }
1060 void clear() { OpaqueValue = 0; }
1061
1062 void unbind(CodeGenFunction &CGF) {
1063 assert(OpaqueValue && "no data to unbind!");
1064
1065 if (BoundLValue) {
1066 CGF.OpaqueLValues.erase(OpaqueValue);
1067 } else {
1068 CGF.OpaqueRValues.erase(OpaqueValue);
1069 CGF.unprotectFromPeepholes(Protection);
1070 }
1071 }
1072 };
1073
1074 /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
1075 class OpaqueValueMapping {
1076 CodeGenFunction &CGF;
1077 OpaqueValueMappingData Data;
1078
1079 public:
1080 static bool shouldBindAsLValue(const Expr *expr) {
1081 return OpaqueValueMappingData::shouldBindAsLValue(expr);
1082 }
1083
John McCallc07a0c72011-02-17 10:25:35 +00001084 /// Build the opaque value mapping for the given conditional
1085 /// operator if it's the GNU ?: extension. This is a common
1086 /// enough pattern that the convenience operator is really
1087 /// helpful.
1088 ///
1089 OpaqueValueMapping(CodeGenFunction &CGF,
1090 const AbstractConditionalOperator *op) : CGF(CGF) {
John McCallfe96e0b2011-11-06 09:01:30 +00001091 if (isa<ConditionalOperator>(op))
1092 // Leave Data empty.
John McCallc07a0c72011-02-17 10:25:35 +00001093 return;
John McCallc07a0c72011-02-17 10:25:35 +00001094
1095 const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
John McCallfe96e0b2011-11-06 09:01:30 +00001096 Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
1097 e->getCommon());
John McCallc07a0c72011-02-17 10:25:35 +00001098 }
1099
John McCall1bf58462011-02-16 08:02:54 +00001100 OpaqueValueMapping(CodeGenFunction &CGF,
1101 const OpaqueValueExpr *opaqueValue,
John McCallc07a0c72011-02-17 10:25:35 +00001102 LValue lvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001103 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
John McCallc07a0c72011-02-17 10:25:35 +00001104 }
1105
1106 OpaqueValueMapping(CodeGenFunction &CGF,
1107 const OpaqueValueExpr *opaqueValue,
1108 RValue rvalue)
John McCallfe96e0b2011-11-06 09:01:30 +00001109 : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
John McCall1bf58462011-02-16 08:02:54 +00001110 }
1111
1112 void pop() {
John McCallfe96e0b2011-11-06 09:01:30 +00001113 Data.unbind(CGF);
1114 Data.clear();
John McCall1bf58462011-02-16 08:02:54 +00001115 }
1116
1117 ~OpaqueValueMapping() {
John McCallfe96e0b2011-11-06 09:01:30 +00001118 if (Data.isValid()) Data.unbind(CGF);
John McCall1bf58462011-02-16 08:02:54 +00001119 }
1120 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +00001121
1122 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
1123 /// number that holds the value.
1124 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +00001125
1126 /// BuildBlockByrefAddress - Computes address location of the
1127 /// variable which is declared as __block.
1128 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
1129 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +00001130private:
Chris Lattner6c4d2552009-10-28 23:59:40 +00001131 CGDebugInfo *DebugInfo;
Devang Pateld6ffebb2011-03-07 18:45:56 +00001132 bool DisableDebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001133
Manman Ren01754612013-03-20 16:59:38 +00001134 /// If the current function returns 'this', use the field to keep track of
1135 /// the callee that returns 'this'.
1136 llvm::Value *CalleeWithThisReturn;
1137
John McCall9b382dd2011-05-28 21:13:02 +00001138 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
1139 /// calling llvm.stacksave for multiple VLAs in the same scope.
1140 bool DidCallStackSave;
1141
Mike Stumpe5311b02009-11-30 20:08:49 +00001142 /// IndirectBranch - The first time an indirect goto is seen we create a block
1143 /// with an indirect branch. Every time we see the address of a label taken,
1144 /// we add the label to the indirect goto. Every subsequent indirect goto is
1145 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +00001146 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001147
Mike Stumpfc496822009-02-08 23:14:22 +00001148 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
1149 /// decls.
John McCall351762c2011-02-07 10:33:21 +00001150 typedef llvm::DenseMap<const Decl*, llvm::Value*> DeclMapTy;
1151 DeclMapTy LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +00001152
Chris Lattnerac248202007-05-30 00:13:02 +00001153 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001154 llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001155
Mike Stumpfc496822009-02-08 23:14:22 +00001156 // BreakContinueStack - This keeps track of where break and continue
Anders Carlsson33747b62009-02-10 05:52:02 +00001157 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +00001158 struct BreakContinue {
John McCallbd309292010-07-06 01:34:17 +00001159 BreakContinue(JumpDest Break, JumpDest Continue)
1160 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +00001161
John McCallbd309292010-07-06 01:34:17 +00001162 JumpDest BreakBlock;
1163 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001164 };
Chris Lattner01cf8db2011-07-20 06:58:45 +00001165 SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00001166
Zhongxing Xu82846ea2012-01-14 09:08:15 +00001167 /// SwitchInsn - This is nearest current switch instruction. It is null if
Mike Stumpfc496822009-02-08 23:14:22 +00001168 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +00001169 llvm::SwitchInst *SwitchInsn;
1170
Mike Stumpfc496822009-02-08 23:14:22 +00001171 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +00001172 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +00001173 llvm::BasicBlock *CaseRangeBlock;
1174
John McCallc07a0c72011-02-17 10:25:35 +00001175 /// OpaqueLValues - Keeps track of the current set of opaque value
John McCall1bf58462011-02-16 08:02:54 +00001176 /// expressions.
John McCallc07a0c72011-02-17 10:25:35 +00001177 llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
1178 llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
John McCall1bf58462011-02-16 08:02:54 +00001179
Mike Stumpfc496822009-02-08 23:14:22 +00001180 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +00001181 // We track this by the size expression rather than the type itself because
1182 // in certain situations, like a const qualifier applied to an VLA typedef,
1183 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +00001184 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
1185 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +00001186 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +00001187
John McCallbd309292010-07-06 01:34:17 +00001188 /// A block containing a single 'unreachable' instruction. Created
1189 /// lazily by getUnreachableBlock().
1190 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +00001191
Anders Carlsson82ba57c2009-11-25 03:15:49 +00001192 /// CXXThisDecl - When generating code for a C++ member function,
1193 /// this will hold the implicit 'this' declaration.
Eli Friedman9fbeba02012-02-11 02:57:39 +00001194 ImplicitParamDecl *CXXABIThisDecl;
1195 llvm::Value *CXXABIThisValue;
John McCall347132b2010-02-16 22:04:33 +00001196 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +00001197
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001198 /// CXXStructorImplicitParamDecl - When generating code for a constructor or
1199 /// destructor, this will hold the implicit argument (e.g. VTT).
1200 ImplicitParamDecl *CXXStructorImplicitParamDecl;
1201 llvm::Value *CXXStructorImplicitParamValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001202
John McCallce1de612011-01-26 04:00:11 +00001203 /// OutermostConditional - Points to the outermost active
1204 /// conditional control. This is used so that we know if a
1205 /// temporary should be destroyed conditionally.
1206 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +00001207
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001208
1209 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
1210 /// type as well as the field number that contains the actual data.
Chris Lattner2192fe52011-07-18 04:24:23 +00001211 llvm::DenseMap<const ValueDecl *, std::pair<llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +00001212 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001213
John McCallbd309292010-07-06 01:34:17 +00001214 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +00001215 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +00001216 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +00001217
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001218 /// Add a kernel metadata node to the named metadata node 'opencl.kernels'.
1219 /// In the kernel metadata node, reference the kernel function and metadata
1220 /// nodes for its optional attribute qualifiers (OpenCL 1.1 6.7.2):
Joey Goulyaba589c2013-03-08 09:42:32 +00001221 /// - A node for the vec_type_hint(<type>) qualifier contains string
1222 /// "vec_type_hint", an undefined value of the <type> data type,
1223 /// and a Boolean that is true if the <type> is integer and signed.
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +00001224 /// - A node for the work_group_size_hint(X,Y,Z) qualifier contains string
1225 /// "work_group_size_hint", and three 32-bit integers X, Y and Z.
1226 /// - A node for the reqd_work_group_size(X,Y,Z) qualifier contains string
1227 /// "reqd_work_group_size", and three 32-bit integers X, Y and Z.
1228 void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
1229 llvm::Function *Fn);
1230
Chris Lattnerbed31442007-05-28 01:07:47 +00001231public:
Fariborz Jahanian63628032012-06-26 16:06:38 +00001232 CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
John McCall08ef4662011-11-10 08:15:53 +00001233 ~CodeGenFunction();
Mike Stumpfc496822009-02-08 23:14:22 +00001234
John McCall8ed55a52010-09-02 09:58:18 +00001235 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
John McCall745ae282011-05-15 02:34:36 +00001236 ASTContext &getContext() const { return CGM.getContext(); }
Alexey Samsonov38e24962012-10-16 07:22:28 +00001237 /// Returns true if DebugInfo is actually initialized.
1238 bool maybeInitializeDebugInfo() {
1239 if (CGM.getModuleDebugInfo()) {
1240 DebugInfo = CGM.getModuleDebugInfo();
1241 return true;
1242 }
1243 return false;
1244 }
Devang Pateld6ffebb2011-03-07 18:45:56 +00001245 CGDebugInfo *getDebugInfo() {
1246 if (DisableDebugInfo)
1247 return NULL;
1248 return DebugInfo;
1249 }
1250 void disableDebugInfo() { DisableDebugInfo = true; }
1251 void enableDebugInfo() { DisableDebugInfo = false; }
1252
John McCall31168b02011-06-15 23:02:42 +00001253 bool shouldUseFusedARCCalls() {
1254 return CGM.getCodeGenOpts().OptimizationLevel == 0;
1255 }
Chris Lattner6db1fb82007-06-02 22:49:07 +00001256
David Blaikiebbafb8a2012-03-11 07:00:24 +00001257 const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
John McCallad7c5c12011-02-08 08:22:06 +00001258
Bill Wendlingf0724e82011-09-19 20:31:14 +00001259 /// Returns a pointer to the function's exception object and selector slot,
1260 /// which is assigned in every landing pad.
John McCallbd309292010-07-06 01:34:17 +00001261 llvm::Value *getExceptionSlot();
John McCall9b382dd2011-05-28 21:13:02 +00001262 llvm::Value *getEHSelectorSlot();
John McCallbd309292010-07-06 01:34:17 +00001263
Bill Wendling79a70e42011-09-15 18:57:19 +00001264 /// Returns the contents of the function's exception object and selector
1265 /// slots.
1266 llvm::Value *getExceptionFromSlot();
1267 llvm::Value *getSelectorFromSlot();
1268
John McCallad5d61e2010-07-23 21:56:41 +00001269 llvm::Value *getNormalCleanupDestSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001270
John McCallbd309292010-07-06 01:34:17 +00001271 llvm::BasicBlock *getUnreachableBlock() {
1272 if (!UnreachableBlock) {
1273 UnreachableBlock = createBasicBlock("unreachable");
1274 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
1275 }
1276 return UnreachableBlock;
1277 }
1278
1279 llvm::BasicBlock *getInvokeDest() {
1280 if (!EHStack.requiresLandingPad()) return 0;
1281 return getInvokeDestImpl();
1282 }
Daniel Dunbar12347492009-02-23 17:26:39 +00001283
John McCallad7c5c12011-02-08 08:22:06 +00001284 llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
Owen Andersonae86c192009-07-13 04:10:07 +00001285
Daniel Dunbar12347492009-02-23 17:26:39 +00001286 //===--------------------------------------------------------------------===//
John McCall82fe67b2011-07-09 01:37:26 +00001287 // Cleanups
1288 //===--------------------------------------------------------------------===//
1289
1290 typedef void Destroyer(CodeGenFunction &CGF, llvm::Value *addr, QualType ty);
1291
John McCall178360e2011-07-11 08:38:19 +00001292 void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
1293 llvm::Value *arrayEndPointer,
1294 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001295 Destroyer *destroyer);
John McCall178360e2011-07-11 08:38:19 +00001296 void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
1297 llvm::Value *arrayEnd,
1298 QualType elementType,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001299 Destroyer *destroyer);
John McCall82fe67b2011-07-09 01:37:26 +00001300
John McCall4bd0fb12011-07-12 16:41:08 +00001301 void pushDestroy(QualType::DestructionKind dtorKind,
1302 llvm::Value *addr, QualType type);
John McCall12cc42a2013-02-01 05:11:40 +00001303 void pushEHDestroy(QualType::DestructionKind dtorKind,
1304 llvm::Value *addr, QualType type);
John McCall82fe67b2011-07-09 01:37:26 +00001305 void pushDestroy(CleanupKind kind, llvm::Value *addr, QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001306 Destroyer *destroyer, bool useEHCleanupForArray);
1307 void emitDestroy(llvm::Value *addr, QualType type, Destroyer *destroyer,
John McCall178360e2011-07-11 08:38:19 +00001308 bool useEHCleanupForArray);
John McCall98de3d72011-07-13 03:01:35 +00001309 llvm::Function *generateDestroyHelper(llvm::Constant *addr,
1310 QualType type,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001311 Destroyer *destroyer,
John McCall98de3d72011-07-13 03:01:35 +00001312 bool useEHCleanupForArray);
John McCall82fe67b2011-07-09 01:37:26 +00001313 void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
Peter Collingbourne1425b452012-01-26 03:33:36 +00001314 QualType type, Destroyer *destroyer,
John McCall97eab0a2011-07-13 08:09:46 +00001315 bool checkZeroLength, bool useEHCleanup);
John McCall82fe67b2011-07-09 01:37:26 +00001316
Peter Collingbourne1425b452012-01-26 03:33:36 +00001317 Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
John McCall4bd0fb12011-07-12 16:41:08 +00001318
John McCall82fe67b2011-07-09 01:37:26 +00001319 /// Determines whether an EH cleanup is required to destroy a type
1320 /// with the given destruction kind.
1321 bool needsEHCleanup(QualType::DestructionKind kind) {
1322 switch (kind) {
1323 case QualType::DK_none:
1324 return false;
1325 case QualType::DK_cxx_destructor:
1326 case QualType::DK_objc_weak_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001327 return getLangOpts().Exceptions;
John McCall82fe67b2011-07-09 01:37:26 +00001328 case QualType::DK_objc_strong_lifetime:
David Blaikiebbafb8a2012-03-11 07:00:24 +00001329 return getLangOpts().Exceptions &&
John McCall82fe67b2011-07-09 01:37:26 +00001330 CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
1331 }
1332 llvm_unreachable("bad destruction kind");
1333 }
1334
John McCall4bd0fb12011-07-12 16:41:08 +00001335 CleanupKind getCleanupKind(QualType::DestructionKind kind) {
1336 return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
1337 }
1338
John McCall82fe67b2011-07-09 01:37:26 +00001339 //===--------------------------------------------------------------------===//
Daniel Dunbar12347492009-02-23 17:26:39 +00001340 // Objective-C
1341 //===--------------------------------------------------------------------===//
1342
Chris Lattner4bd55962008-03-30 23:03:07 +00001343 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001344
Mike Stumpfc496822009-02-08 23:14:22 +00001345 void StartObjCMethod(const ObjCMethodDecl *MD,
Devang Patele7ce5402011-05-19 23:37:41 +00001346 const ObjCContainerDecl *CD,
1347 SourceLocation StartLoc);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001348
Mike Stumpfc496822009-02-08 23:14:22 +00001349 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001350 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
1351 const ObjCPropertyImplDecl *PID);
John McCallf4528ae2011-09-13 03:34:09 +00001352 void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001353 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001354 const ObjCMethodDecl *GetterMothodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001355 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001356
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001357 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1358 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001359
Mike Stumpfc496822009-02-08 23:14:22 +00001360 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
1361 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001362 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
1363 const ObjCPropertyImplDecl *PID);
John McCall7f16c422011-09-10 09:17:20 +00001364 void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001365 const ObjCPropertyImplDecl *propImpl,
1366 llvm::Constant *AtomicHelperFn);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001367 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001368 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001369
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001370 //===--------------------------------------------------------------------===//
1371 // Block Bits
1372 //===--------------------------------------------------------------------===//
1373
John McCall351762c2011-02-07 10:33:21 +00001374 llvm::Value *EmitBlockLiteral(const BlockExpr *);
John McCall08ef4662011-11-10 08:15:53 +00001375 llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info);
1376 static void destroyBlockInfos(CGBlockInfo *info);
Blaine Garstfc83aa02010-02-23 21:51:17 +00001377 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001378 const CGBlockInfo &Info,
Chris Lattner2192fe52011-07-18 04:24:23 +00001379 llvm::StructType *,
John McCallad7c5c12011-02-08 08:22:06 +00001380 llvm::Constant *BlockVarLayout);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001381
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +00001382 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
John McCall351762c2011-02-07 10:33:21 +00001383 const CGBlockInfo &Info,
Mike Stump692c6e32009-03-20 21:53:12 +00001384 const Decl *OuterFuncDecl,
Eli Friedman2495ab02012-02-25 02:48:22 +00001385 const DeclMapTy &ldm,
1386 bool IsLambdaConversionToBlock);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001387
John McCallad7c5c12011-02-08 08:22:06 +00001388 llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
1389 llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001390 llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
1391 const ObjCPropertyImplDecl *PID);
1392 llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
1393 const ObjCPropertyImplDecl *PID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00001394 llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
John McCallad7c5c12011-02-08 08:22:06 +00001395
John McCallad7c5c12011-02-08 08:22:06 +00001396 void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
1397
John McCall73064872011-03-31 01:59:53 +00001398 class AutoVarEmission;
1399
1400 void emitByrefStructureInit(const AutoVarEmission &emission);
1401 void enterByrefCleanup(const AutoVarEmission &emission);
1402
John McCall351762c2011-02-07 10:33:21 +00001403 llvm::Value *LoadBlockStruct() {
1404 assert(BlockPointer && "no block pointer set!");
1405 return BlockPointer;
1406 }
Mike Stumpcb2fbcb2009-02-21 20:00:35 +00001407
John McCall87fe5d52010-05-20 01:18:31 +00001408 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
John McCall113bee02012-03-10 09:33:50 +00001409 void AllocateBlockDecl(const DeclRefExpr *E);
John McCall351762c2011-02-07 10:33:21 +00001410 llvm::Value *GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
Chris Lattner2192fe52011-07-18 04:24:23 +00001411 llvm::Type *BuildByRefType(const VarDecl *var);
Mike Stump97d01d52009-03-04 03:23:46 +00001412
John McCalla738c252011-03-09 04:27:21 +00001413 void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1414 const CGFunctionInfo &FnInfo);
Anders Carlsson73fcc952009-09-11 00:07:24 +00001415 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001416 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +00001417 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +00001418 const FunctionArgList &Args,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +00001419 SourceLocation StartLoc);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001420
John McCallb81884d2010-02-19 09:25:03 +00001421 void EmitConstructorBody(FunctionArgList &Args);
1422 void EmitDestructorBody(FunctionArgList &Args);
Lang Hamesbf122742013-02-17 07:22:09 +00001423 void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
John McCallb81884d2010-02-19 09:25:03 +00001424 void EmitFunctionBody(FunctionArgList &Args);
John McCall89b12b32010-02-18 03:17:58 +00001425
Eli Friedman2495ab02012-02-25 02:48:22 +00001426 void EmitForwardingCallToLambda(const CXXRecordDecl *Lambda,
1427 CallArgList &CallArgs);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001428 void EmitLambdaToBlockPointerBody(FunctionArgList &Args);
Eli Friedman2495ab02012-02-25 02:48:22 +00001429 void EmitLambdaBlockInvokeBody();
Douglas Gregor355efbb2012-02-17 03:02:34 +00001430 void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
1431 void EmitLambdaStaticInvokeFunction(const CXXMethodDecl *MD);
Eli Friedman5a6d5072012-02-16 01:37:33 +00001432
Mike Stumpfc496822009-02-08 23:14:22 +00001433 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
1434 /// emission when possible.
David Blaikie357aafb2013-02-01 19:09:49 +00001435 void EmitReturnBlock();
Daniel Dunbarfd346a32009-01-26 23:27:52 +00001436
Mike Stumpfc496822009-02-08 23:14:22 +00001437 /// FinishFunction - Complete IR generation of the current function. It is
1438 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001439 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +00001440
Anders Carlssonbad991d2010-03-24 00:39:18 +00001441 /// GenerateThunk - Generate a thunk for the given method.
John McCalla738c252011-03-09 04:27:21 +00001442 void GenerateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1443 GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001444
Eli Friedman49a94b12011-05-06 17:27:27 +00001445 void GenerateVarArgsThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
1446 GlobalDecl GD, const ThunkInfo &Thunk);
1447
Douglas Gregor94f9a482010-05-05 05:51:00 +00001448 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
1449 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +00001450
Eli Friedman5f1a04f2012-02-14 02:31:03 +00001451 void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init,
1452 ArrayRef<VarDecl *> ArrayIndexes);
1453
Anders Carlssone87fae92010-03-28 19:40:00 +00001454 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1455 /// subobject.
1456 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001457 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001458 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001459 CharUnits OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001460 llvm::Constant *VTable,
1461 const CXXRecordDecl *VTableClass);
1462
1463 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001464 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001465 const CXXRecordDecl *NearestVBase,
Ken Dyck3fb4c892011-03-23 01:04:18 +00001466 CharUnits OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001467 bool BaseIsNonVirtualPrimaryBase,
1468 llvm::Constant *VTable,
1469 const CXXRecordDecl *VTableClass,
1470 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001471
Anders Carlssond5895932010-03-28 21:07:49 +00001472 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001473
Dan Gohman8fc50c22010-10-26 18:44:08 +00001474 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1475 /// to by This.
Chris Lattner2192fe52011-07-18 04:24:23 +00001476 llvm::Value *GetVTablePtr(llvm::Value *This, llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001477
John McCallf99a6312010-07-21 05:30:47 +00001478 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1479 /// given phase of destruction for a destructor. The end result
1480 /// should call destructors on members and base classes in reverse
1481 /// order of their construction.
1482 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001483
Chris Lattner3c77a352010-06-22 00:03:40 +00001484 /// ShouldInstrumentFunction - Return true if the current function should be
1485 /// instrumented with __cyg_profile_func_* calls
1486 bool ShouldInstrumentFunction();
1487
1488 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1489 /// instrumentation function with the current function and the call site, if
1490 /// function instrumentation is enabled.
1491 void EmitFunctionInstrumentation(const char *Fn);
1492
Roman Divacky178e01602011-02-10 16:52:03 +00001493 /// EmitMCountInstrumentation - Emit call to .mcount.
1494 void EmitMCountInstrumentation();
1495
Mike Stumpfc496822009-02-08 23:14:22 +00001496 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1497 /// arguments for the given function. This is also responsible for naming the
1498 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001499 void EmitFunctionProlog(const CGFunctionInfo &FI,
1500 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001501 const FunctionArgList &Args);
1502
Mike Stumpfc496822009-02-08 23:14:22 +00001503 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1504 /// given temporary.
Chris Lattner3fcc7902010-06-27 01:06:27 +00001505 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001506
Mike Stump1d849212009-12-07 23:38:24 +00001507 /// EmitStartEHSpec - Emit the start of the exception spec.
1508 void EmitStartEHSpec(const Decl *D);
1509
1510 /// EmitEndEHSpec - Emit the end of the exception spec.
1511 void EmitEndEHSpec(const Decl *D);
1512
John McCallbd309292010-07-06 01:34:17 +00001513 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1514 llvm::BasicBlock *getTerminateLandingPad();
1515
1516 /// getTerminateHandler - Return a handler (not a landing pad, just
1517 /// a catch handler) that just calls terminate. This is used when
1518 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001519 llvm::BasicBlock *getTerminateHandler();
1520
Chris Lattnera5f58b02011-07-09 17:41:47 +00001521 llvm::Type *ConvertTypeForMem(QualType T);
1522 llvm::Type *ConvertType(QualType T);
1523 llvm::Type *ConvertType(const TypeDecl *T) {
John McCall6ce74722010-02-16 04:15:37 +00001524 return ConvertType(getContext().getTypeDeclType(T));
1525 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001526
Mike Stumpfc496822009-02-08 23:14:22 +00001527 /// LoadObjCSelf - Load the value of self. This function is only valid while
1528 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001529 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001530
1531 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001532 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001533
Chris Lattner54fb19e2007-06-22 22:02:34 +00001534 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1535 /// an aggregate LLVM type or is void.
John McCall47fb9502013-03-07 21:37:08 +00001536 static TypeEvaluationKind getEvaluationKind(QualType T);
1537
1538 static bool hasScalarEvaluationKind(QualType T) {
1539 return getEvaluationKind(T) == TEK_Scalar;
1540 }
1541
1542 static bool hasAggregateEvaluationKind(QualType T) {
1543 return getEvaluationKind(T) == TEK_Aggregate;
1544 }
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001545
1546 /// createBasicBlock - Create an LLVM basic block.
Richard Smithe30752c2012-10-09 19:52:38 +00001547 llvm::BasicBlock *createBasicBlock(const Twine &name = "",
John McCallad7c5c12011-02-08 08:22:06 +00001548 llvm::Function *parent = 0,
1549 llvm::BasicBlock *before = 0) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001550#ifdef NDEBUG
John McCallad7c5c12011-02-08 08:22:06 +00001551 return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001552#else
John McCallad7c5c12011-02-08 08:22:06 +00001553 return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001554#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001555 }
Mike Stumpfc496822009-02-08 23:14:22 +00001556
Chris Lattnerac248202007-05-30 00:13:02 +00001557 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1558 /// label maps to.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001559 JumpDest getJumpDestForLabel(const LabelDecl *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001560
Mike Stumpe5311b02009-11-30 20:08:49 +00001561 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1562 /// another basic block, simplify it. This assumes that no other code could
1563 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001564 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1565
Mike Stumpfc496822009-02-08 23:14:22 +00001566 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1567 /// adding a fall-through branch from the current insert block if
1568 /// necessary. It is legal to call this function even if there is no current
1569 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001570 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001571 /// IsFinished - If true, indicates that the caller has finished emitting
1572 /// branches to the given block and does not expect to emit code into it. This
1573 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001574 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001575
John McCall8e4c74b2011-08-11 02:22:43 +00001576 /// EmitBlockAfterUses - Emit the given block somewhere hopefully
1577 /// near its uses, and leave the insertion point in it.
1578 void EmitBlockAfterUses(llvm::BasicBlock *BB);
1579
Mike Stumpfc496822009-02-08 23:14:22 +00001580 /// EmitBranch - Emit a branch to the specified basic block from the current
1581 /// insert block, taking care to avoid creation of branches from dummy
1582 /// blocks. It is legal to call this function even if there is no current
1583 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001584 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001585 /// This function clears the current insertion point. The caller should follow
1586 /// calls to this function with calls to Emit*Block prior to generation new
1587 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001588 void EmitBranch(llvm::BasicBlock *Block);
1589
Mike Stumpfc496822009-02-08 23:14:22 +00001590 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1591 /// indicates that the current code being emitted is unreachable.
1592 bool HaveInsertPoint() const {
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001593 return Builder.GetInsertBlock() != 0;
1594 }
1595
Mike Stumpfc496822009-02-08 23:14:22 +00001596 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1597 /// emitted IR has a place to go. Note that by definition, if this function
1598 /// creates a block then that block is unreachable; callers may do better to
1599 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001600 void EnsureInsertPoint() {
1601 if (!HaveInsertPoint())
1602 EmitBlock(createBasicBlock());
1603 }
Mike Stumpfc496822009-02-08 23:14:22 +00001604
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001605 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001606 /// specified stmt yet.
Daniel Dunbarf2cf6d12008-09-04 03:43:08 +00001607 void ErrorUnsupported(const Stmt *S, const char *Type,
1608 bool OmitOnError=false);
Chris Lattner84915fa2007-06-02 04:16:21 +00001609
Chris Lattnere9a64532007-06-22 21:44:33 +00001610 //===--------------------------------------------------------------------===//
1611 // Helpers
1612 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001613
Eli Friedmana0544d62011-12-03 04:14:32 +00001614 LValue MakeAddrLValue(llvm::Value *V, QualType T,
1615 CharUnits Alignment = CharUnits()) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001616 return LValue::MakeAddr(V, T, Alignment, getContext(),
1617 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001618 }
John McCall4e8ca4f2012-07-02 23:58:38 +00001619
Eli Friedmand20adbd2011-11-16 00:42:57 +00001620 LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Eli Friedmana0544d62011-12-03 04:14:32 +00001621 CharUnits Alignment;
1622 if (!T->isIncompleteType())
1623 Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmand20adbd2011-11-16 00:42:57 +00001624 return LValue::MakeAddr(V, T, Alignment, getContext(),
1625 CGM.getTBAAInfo(T));
1626 }
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001627
Chris Lattnere9a64532007-06-22 21:44:33 +00001628 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001629 /// block. The caller is responsible for setting an appropriate alignment on
1630 /// the alloca.
Chris Lattner2192fe52011-07-18 04:24:23 +00001631 llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty,
Chris Lattner62ff6e82011-07-20 07:06:53 +00001632 const Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001633
John McCall2e6567a2010-04-22 01:10:34 +00001634 /// InitTempAlloca - Provide an initial value for the given alloca.
1635 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1636
Daniel Dunbard0049182010-02-16 19:44:13 +00001637 /// CreateIRTemp - Create a temporary IR object of the given type, with
1638 /// appropriate alignment. This routine should only be used when an temporary
1639 /// value needs to be stored into an alloca (for example, to avoid explicit
1640 /// PHI construction), but the type is the IR type, not the type appropriate
1641 /// for storing in memory.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001642 llvm::AllocaInst *CreateIRTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001643
Daniel Dunbara7566f12010-02-09 02:48:28 +00001644 /// CreateMemTemp - Create a temporary memory object of the given type, with
1645 /// appropriate alignment.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001646 llvm::AllocaInst *CreateMemTemp(QualType T, const Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001647
John McCall7a626f62010-09-15 10:14:12 +00001648 /// CreateAggTemp - Create a temporary memory object for the given
1649 /// aggregate type.
Chris Lattner62ff6e82011-07-20 07:06:53 +00001650 AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
Eli Friedman38cd36d2011-12-03 02:13:40 +00001651 CharUnits Alignment = getContext().getTypeAlignInChars(T);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001652 return AggValueSlot::forAddr(CreateMemTemp(T, Name), Alignment,
1653 T.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +00001654 AggValueSlot::IsNotDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001655 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001656 AggValueSlot::IsNotAliased);
John McCall7a626f62010-09-15 10:14:12 +00001657 }
1658
John McCallad7c5c12011-02-08 08:22:06 +00001659 /// Emit a cast to void* in the appropriate address space.
1660 llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
1661
Chris Lattner8394d792007-06-05 20:53:16 +00001662 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1663 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001664 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001665
John McCalla2342eb2010-12-05 02:00:02 +00001666 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1667 void EmitIgnoredExpr(const Expr *E);
1668
Chris Lattner4647a212007-08-31 22:49:20 +00001669 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1670 /// any type. The result is returned as an RValue struct. If this is an
1671 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1672 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001673 ///
Dmitri Gribenkoadba9be2012-08-23 17:58:28 +00001674 /// \param ignoreResult True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001675 RValue EmitAnyExpr(const Expr *E,
John McCall4e8ca4f2012-07-02 23:58:38 +00001676 AggValueSlot aggSlot = AggValueSlot::ignored(),
1677 bool ignoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001678
Mike Stumpfc496822009-02-08 23:14:22 +00001679 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1680 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001681 llvm::Value *EmitVAListRef(const Expr *E);
1682
Mike Stumpfc496822009-02-08 23:14:22 +00001683 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1684 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001685 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001686
John McCall91ca10f2011-03-08 09:11:50 +00001687 /// EmitAnyExprToMem - Emits the code necessary to evaluate an
Chad Rosier615ed1a2012-03-29 17:37:10 +00001688 /// arbitrary expression into the given memory location.
John McCall21886962010-04-21 10:05:39 +00001689 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001690 Qualifiers Quals, bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001691
John McCall91ca10f2011-03-08 09:11:50 +00001692 /// EmitExprAsInit - Emits the code necessary to initialize a
1693 /// location in memory with the given initializer.
John McCall31168b02011-06-15 23:02:42 +00001694 void EmitExprAsInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001695 LValue lvalue, bool capturedByInit);
John McCall91ca10f2011-03-08 09:11:50 +00001696
Fariborz Jahanian78652202013-01-25 23:57:05 +00001697 /// hasVolatileMember - returns true if aggregate type has a volatile
1698 /// member.
1699 bool hasVolatileMember(QualType T) {
1700 if (const RecordType *RT = T->getAs<RecordType>()) {
1701 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
1702 return RD->hasVolatileMember();
1703 }
1704 return false;
1705 }
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001706 /// EmitAggregateCopy - Emit an aggregate assignment.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001707 ///
1708 /// The difference to EmitAggregateCopy is that tail padding is not copied.
1709 /// This is required for correctness when assigning non-POD structures in C++.
1710 void EmitAggregateAssign(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian78652202013-01-25 23:57:05 +00001711 QualType EltTy) {
1712 bool IsVolatile = hasVolatileMember(EltTy);
1713 EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, CharUnits::Zero(),
1714 true);
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001715 }
1716
Arnaud A. de Grandmaison49c04462013-02-05 09:06:17 +00001717 /// EmitAggregateCopy - Emit an aggregate copy.
Mike Stump5e9e61b2009-05-23 22:29:41 +00001718 ///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001719 /// \param isVolatile - True iff either the source or the destination is
Mike Stump5e9e61b2009-05-23 22:29:41 +00001720 /// volatile.
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001721 /// \param isAssignment - If false, allow padding to be copied. This often
1722 /// yields more efficient.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001723 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Eli Friedman6d694a32011-12-05 22:23:28 +00001724 QualType EltTy, bool isVolatile=false,
Benjamin Kramer1ca66912012-09-30 12:43:37 +00001725 CharUnits Alignment = CharUnits::Zero(),
1726 bool isAssignment = false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001727
Devang Patelda5d6bb2007-10-04 23:45:31 +00001728 /// StartBlock - Start new block named N. If insert block is a dummy block
1729 /// then reuse it.
1730 void StartBlock(const char *N);
1731
Anders Carlsson9396a892008-09-11 09:15:33 +00001732 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001733 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1734 llvm::Value *Res = LocalDeclMap[VD];
1735 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1736 return Res;
1737 }
Mike Stumpfc496822009-02-08 23:14:22 +00001738
John McCallc07a0c72011-02-17 10:25:35 +00001739 /// getOpaqueLValueMapping - Given an opaque value expression (which
1740 /// must be mapped to an l-value), return its mapping.
1741 const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
1742 assert(OpaqueValueMapping::shouldBindAsLValue(e));
1743
1744 llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
1745 it = OpaqueLValues.find(e);
1746 assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
1747 return it->second;
1748 }
1749
1750 /// getOpaqueRValueMapping - Given an opaque value expression (which
1751 /// must be mapped to an r-value), return its mapping.
1752 const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
1753 assert(!OpaqueValueMapping::shouldBindAsLValue(e));
1754
1755 llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
1756 it = OpaqueRValues.find(e);
1757 assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
John McCall1bf58462011-02-16 08:02:54 +00001758 return it->second;
1759 }
1760
Dan Gohman75d69da2008-05-22 00:50:06 +00001761 /// getAccessedFieldNo - Given an encoded value and a result number, return
1762 /// the input field number being accessed.
1763 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1764
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001765 llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001766 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001767
Anders Carlssonc0964b62010-05-22 17:35:42 +00001768 /// EmitNullInitialization - Generate code to set a value of the given type to
1769 /// null, If the type contains data member pointers, they will be initialized
1770 /// to -1 in accordance with the Itanium C++ ABI.
1771 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001772
1773 // EmitVAArg - Generate code to get an argument from the passed in pointer
1774 // and update it accordingly. The return value is a pointer to the argument.
1775 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001776 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001777 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001778
John McCall82fe67b2011-07-09 01:37:26 +00001779 /// emitArrayLength - Compute the length of an array, even if it's a
1780 /// VLA, and drill down to the base element type.
1781 llvm::Value *emitArrayLength(const ArrayType *arrayType,
1782 QualType &baseType,
1783 llvm::Value *&addr);
1784
John McCall23c29fe2011-06-24 21:55:10 +00001785 /// EmitVLASize - Capture all the sizes for the VLA expressions in
1786 /// the given variably-modified type and store them in the VLASizeMap.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001787 ///
1788 /// This function can be called with a null (unreachable) insert point.
John McCall23c29fe2011-06-24 21:55:10 +00001789 void EmitVariablyModifiedType(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001790
John McCall23c29fe2011-06-24 21:55:10 +00001791 /// getVLASize - Returns an LLVM value that corresponds to the size,
1792 /// in non-variably-sized elements, of a variable length array type,
1793 /// plus that largest non-variably-sized element type. Assumes that
1794 /// the type has already been emitted with EmitVariablyModifiedType.
1795 std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
1796 std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
Anders Carlssonccbe9202008-12-12 07:19:02 +00001797
Anders Carlssona5d077d2009-04-14 16:58:56 +00001798 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1799 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001800 llvm::Value *LoadCXXThis() {
1801 assert(CXXThisValue && "no 'this' value for this function");
1802 return CXXThisValue;
1803 }
Mike Stump11289f42009-09-09 15:08:12 +00001804
Anders Carlssone36a6b32010-01-02 01:01:18 +00001805 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1806 /// virtual bases.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001807 // FIXME: Every place that calls LoadCXXVTT is something
1808 // that needs to be abstracted properly.
John McCall347132b2010-02-16 22:04:33 +00001809 llvm::Value *LoadCXXVTT() {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001810 assert(CXXStructorImplicitParamValue && "no VTT value for this function");
1811 return CXXStructorImplicitParamValue;
1812 }
1813
1814 /// LoadCXXStructorImplicitParam - Load the implicit parameter
1815 /// for a constructor/destructor.
1816 llvm::Value *LoadCXXStructorImplicitParam() {
1817 assert(CXXStructorImplicitParamValue &&
1818 "no implicit argument value for this function");
1819 return CXXStructorImplicitParamValue;
John McCall347132b2010-02-16 22:04:33 +00001820 }
John McCall6ce74722010-02-16 04:15:37 +00001821
1822 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001823 /// complete class to the given direct base.
1824 llvm::Value *
1825 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1826 const CXXRecordDecl *Derived,
1827 const CXXRecordDecl *Base,
1828 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001829
Mike Stumpe5311b02009-11-30 20:08:49 +00001830 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1831 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001832 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001833 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001834 CastExpr::path_const_iterator PathBegin,
1835 CastExpr::path_const_iterator PathEnd,
Anders Carlssond829a022010-04-24 21:06:20 +00001836 bool NullCheckValue);
1837
Anders Carlsson8c793172009-11-23 17:57:54 +00001838 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001839 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001840 CastExpr::path_const_iterator PathBegin,
1841 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001842 bool NullCheckValue);
1843
Anders Carlsson84673e22010-01-31 01:36:53 +00001844 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1845 const CXXRecordDecl *ClassDecl,
1846 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001847
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001848 /// GetVTTParameter - Return the VTT parameter that should be passed to a
1849 /// base constructor/destructor with virtual bases.
1850 /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
1851 /// to ItaniumCXXABI.cpp together with all the references to VTT.
1852 llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
1853 bool Delegating);
1854
John McCallf8ff7b92010-02-23 00:48:20 +00001855 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1856 CXXCtorType CtorType,
1857 const FunctionArgList &Args);
Alexis Hunt61bc1732011-05-01 07:04:31 +00001858 // It's important not to confuse this and the previous function. Delegating
1859 // constructors are the C++0x feature. The constructor delegate optimization
1860 // is used to reduce duplication in the base and complete consturctors where
1861 // they are substantially the same.
1862 void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
1863 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001864 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001865 bool ForVirtualBase, bool Delegating,
1866 llvm::Value *This,
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001867 CallExpr::const_arg_iterator ArgBeg,
1868 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001869
1870 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1871 llvm::Value *This, llvm::Value *Src,
1872 CallExpr::const_arg_iterator ArgBeg,
1873 CallExpr::const_arg_iterator ArgEnd);
Mike Stump11289f42009-09-09 15:08:12 +00001874
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001875 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001876 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001877 llvm::Value *ArrayPtr,
1878 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001879 CallExpr::const_arg_iterator ArgEnd,
1880 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001881
Anders Carlssond49844b2009-09-23 02:45:36 +00001882 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1883 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001884 llvm::Value *ArrayPtr,
1885 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001886 CallExpr::const_arg_iterator ArgEnd,
1887 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001888
John McCall82fe67b2011-07-09 01:37:26 +00001889 static Destroyer destroyCXXObject;
1890
Anders Carlsson0a637412009-05-29 21:03:38 +00001891 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Douglas Gregor61535002013-01-31 05:50:40 +00001892 bool ForVirtualBase, bool Delegating,
1893 llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001894
John McCall99210dc2011-09-15 06:49:18 +00001895 void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
1896 llvm::Value *NewPtr, llvm::Value *NumElements);
Mike Stump11289f42009-09-09 15:08:12 +00001897
Peter Collingbourne702b2842011-11-27 22:09:22 +00001898 void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
1899 llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001900
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001901 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001902 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001903
Eli Friedman24f55432009-11-18 00:57:03 +00001904 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1905 QualType DeleteTy);
1906
Mike Stumpc9b231c2009-11-15 08:09:41 +00001907 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001908 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Nico Webercf4ff5862012-10-11 10:13:44 +00001909 llvm::Value* EmitCXXUuidofExpr(const CXXUuidofExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001910
Sebastian Redld026dc42012-02-19 16:03:09 +00001911 void MaybeEmitStdInitializerListCleanup(llvm::Value *loc, const Expr *init);
Sebastian Redl8eb351d2012-02-19 12:28:02 +00001912 void EmitStdInitializerListCleanup(llvm::Value *loc,
1913 const InitListExpr *init);
Sebastian Redlc83ed822012-02-17 08:42:25 +00001914
Richard Smith69d0d262012-08-24 00:54:33 +00001915 /// \brief Situations in which we might emit a check for the suitability of a
1916 /// pointer or glvalue.
Richard Smith4d1458e2012-09-08 02:08:36 +00001917 enum TypeCheckKind {
Richard Smith69d0d262012-08-24 00:54:33 +00001918 /// Checking the operand of a load. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001919 TCK_Load,
Richard Smith69d0d262012-08-24 00:54:33 +00001920 /// Checking the destination of a store. Must be suitably sized and aligned.
Richard Smith4d1458e2012-09-08 02:08:36 +00001921 TCK_Store,
Richard Smith69d0d262012-08-24 00:54:33 +00001922 /// Checking the bound value in a reference binding. Must be suitably sized
1923 /// and aligned, but is not required to refer to an object (until the
1924 /// reference is used), per core issue 453.
Richard Smith4d1458e2012-09-08 02:08:36 +00001925 TCK_ReferenceBinding,
Richard Smith69d0d262012-08-24 00:54:33 +00001926 /// Checking the object expression in a non-static data member access. Must
1927 /// be an object within its lifetime.
Richard Smith4d1458e2012-09-08 02:08:36 +00001928 TCK_MemberAccess,
Richard Smith69d0d262012-08-24 00:54:33 +00001929 /// Checking the 'this' pointer for a call to a non-static member function.
1930 /// Must be an object within its lifetime.
Richard Smith4d3110a2012-10-25 02:14:12 +00001931 TCK_MemberCall,
1932 /// Checking the 'this' pointer for a constructor call.
Richard Smith2c5868c2013-02-13 21:18:23 +00001933 TCK_ConstructorCall,
1934 /// Checking the operand of a static_cast to a derived pointer type. Must be
1935 /// null or an object within its lifetime.
1936 TCK_DowncastPointer,
1937 /// Checking the operand of a static_cast to a derived reference type. Must
1938 /// be an object within its lifetime.
1939 TCK_DowncastReference
Richard Smith69d0d262012-08-24 00:54:33 +00001940 };
1941
Richard Smith4d1458e2012-09-08 02:08:36 +00001942 /// \brief Emit a check that \p V is the address of storage of the
Richard Smith69d0d262012-08-24 00:54:33 +00001943 /// appropriate size and alignment for an object of type \p Type.
Richard Smithe30752c2012-10-09 19:52:38 +00001944 void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
Richard Smith4d1458e2012-09-08 02:08:36 +00001945 QualType Type, CharUnits Alignment = CharUnits::Zero());
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001946
Richard Smith539e4a72013-02-23 02:53:19 +00001947 /// \brief Emit a check that \p Base points into an array object, which
1948 /// we can access at index \p Index. \p Accessed should be \c false if we
1949 /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
1950 void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
1951 QualType IndexType, bool Accessed);
1952
Chris Lattner116ce8f2010-01-09 21:40:03 +00001953 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1954 bool isInc, bool isPre);
1955 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1956 bool isInc, bool isPre);
Chris Lattner8394d792007-06-05 20:53:16 +00001957 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001958 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001959 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001960
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001961 /// EmitDecl - Emit a declaration.
1962 ///
1963 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001964 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001965
John McCall1c9c3fd2010-10-15 04:57:14 +00001966 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001967 ///
1968 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001969 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001970
John McCall31168b02011-06-15 23:02:42 +00001971 void EmitScalarInit(const Expr *init, const ValueDecl *D,
John McCall1553b192011-06-16 04:16:24 +00001972 LValue lvalue, bool capturedByInit);
John McCalld4631322011-06-17 06:42:21 +00001973 void EmitScalarInit(llvm::Value *init, LValue lvalue);
John McCall31168b02011-06-15 23:02:42 +00001974
John McCallbd309292010-07-06 01:34:17 +00001975 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1976 llvm::Value *Address);
1977
John McCall1c9c3fd2010-10-15 04:57:14 +00001978 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001979 ///
1980 /// This function can be called with a null (unreachable) insert point.
John McCallc533cb72011-02-22 06:44:22 +00001981 void EmitAutoVarDecl(const VarDecl &D);
1982
1983 class AutoVarEmission {
1984 friend class CodeGenFunction;
1985
John McCall9e2e22f2011-02-22 07:16:58 +00001986 const VarDecl *Variable;
John McCallc533cb72011-02-22 06:44:22 +00001987
1988 /// The alignment of the variable.
1989 CharUnits Alignment;
1990
1991 /// The address of the alloca. Null if the variable was emitted
1992 /// as a global constant.
1993 llvm::Value *Address;
1994
1995 llvm::Value *NRVOFlag;
1996
1997 /// True if the variable is a __block variable.
1998 bool IsByRef;
1999
2000 /// True if the variable is of aggregate type and has a constant
2001 /// initializer.
2002 bool IsConstantAggregate;
2003
John McCall9e2e22f2011-02-22 07:16:58 +00002004 struct Invalid {};
2005 AutoVarEmission(Invalid) : Variable(0) {}
2006
John McCallc533cb72011-02-22 06:44:22 +00002007 AutoVarEmission(const VarDecl &variable)
John McCall9e2e22f2011-02-22 07:16:58 +00002008 : Variable(&variable), Address(0), NRVOFlag(0),
John McCallc533cb72011-02-22 06:44:22 +00002009 IsByRef(false), IsConstantAggregate(false) {}
2010
2011 bool wasEmittedAsGlobal() const { return Address == 0; }
2012
2013 public:
John McCall9e2e22f2011-02-22 07:16:58 +00002014 static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
2015
John McCallc533cb72011-02-22 06:44:22 +00002016 /// Returns the address of the object within this declaration.
2017 /// Note that this does not chase the forwarding pointer for
2018 /// __block decls.
2019 llvm::Value *getObjectAddress(CodeGenFunction &CGF) const {
2020 if (!IsByRef) return Address;
2021
2022 return CGF.Builder.CreateStructGEP(Address,
John McCall9e2e22f2011-02-22 07:16:58 +00002023 CGF.getByRefValueLLVMField(Variable),
2024 Variable->getNameAsString());
John McCallc533cb72011-02-22 06:44:22 +00002025 }
2026 };
2027 AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
2028 void EmitAutoVarInit(const AutoVarEmission &emission);
2029 void EmitAutoVarCleanups(const AutoVarEmission &emission);
John McCall82fe67b2011-07-09 01:37:26 +00002030 void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
2031 QualType::DestructionKind dtorKind);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002032
John McCall1c9c3fd2010-10-15 04:57:14 +00002033 void EmitStaticVarDecl(const VarDecl &D,
2034 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00002035
2036 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
Devang Patel68a15252011-03-03 20:13:15 +00002037 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg, unsigned ArgNo);
Mike Stumpfc496822009-02-08 23:14:22 +00002038
John McCallc07a0c72011-02-17 10:25:35 +00002039 /// protectFromPeepholes - Protect a value that we're intending to
2040 /// store to the side, but which will probably be used later, from
2041 /// aggressive peepholing optimizations that might delete it.
2042 ///
2043 /// Pass the result to unprotectFromPeepholes to declare that
2044 /// protection is no longer required.
2045 ///
2046 /// There's no particular reason why this shouldn't apply to
2047 /// l-values, it's just that no existing peepholes work on pointers.
2048 PeepholeProtection protectFromPeepholes(RValue rvalue);
2049 void unprotectFromPeepholes(PeepholeProtection protection);
2050
Chris Lattner84915fa2007-06-02 04:16:21 +00002051 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00002052 // Statement Emission
2053 //===--------------------------------------------------------------------===//
2054
Mike Stumpfc496822009-02-08 23:14:22 +00002055 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002056 void EmitStopPoint(const Stmt *S);
2057
Mike Stumpfc496822009-02-08 23:14:22 +00002058 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
2059 /// this function even if there is no current insertion point.
2060 ///
2061 /// This function may clear the current insertion point; callers should use
2062 /// EnsureInsertPoint if they wish to subsequently generate code without first
2063 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00002064 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002065
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002066 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00002067 /// necessarily require an insertion point or debug information; typically
2068 /// because the statement amounts to a jump or a container of other
2069 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002070 ///
2071 /// \return True if the statement was handled.
2072 bool EmitSimpleStmt(const Stmt *S);
2073
Chris Lattner4647a212007-08-31 22:49:20 +00002074 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall7a626f62010-09-15 10:14:12 +00002075 AggValueSlot AVS = AggValueSlot::ignored());
David Blaikie0a21d0d2013-01-26 22:16:26 +00002076 RValue EmitCompoundStmtWithoutScope(const CompoundStmt &S,
2077 bool GetLast = false, AggValueSlot AVS =
2078 AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002079
Mike Stumpfc496822009-02-08 23:14:22 +00002080 /// EmitLabel - Emit the block for the given label. It is legal to call this
2081 /// function even if there is no current insertion point.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002082 void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00002083
Chris Lattnerac248202007-05-30 00:13:02 +00002084 void EmitLabelStmt(const LabelStmt &S);
Richard Smithc202b282012-04-14 00:33:13 +00002085 void EmitAttributedStmt(const AttributedStmt &S);
Chris Lattnerac248202007-05-30 00:13:02 +00002086 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002087 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00002088 void EmitIfStmt(const IfStmt &S);
Chris Lattner946aa312007-06-05 03:59:43 +00002089 void EmitWhileStmt(const WhileStmt &S);
Chris Lattner8394d792007-06-05 20:53:16 +00002090 void EmitDoStmt(const DoStmt &S);
2091 void EmitForStmt(const ForStmt &S);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00002092 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00002093 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00002094 void EmitBreakStmt(const BreakStmt &S);
2095 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00002096 void EmitSwitchStmt(const SwitchStmt &S);
2097 void EmitDefaultStmt(const DefaultStmt &S);
2098 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00002099 void EmitCaseStmtRange(const CaseStmt &S);
Chad Rosier6051bb92012-08-28 18:54:39 +00002100 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002101
Anders Carlsson2e744e82008-08-30 19:51:14 +00002102 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002103 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
2104 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00002105 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
John McCall31168b02011-06-15 23:02:42 +00002106 void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00002107
John McCall9b382dd2011-05-28 21:13:02 +00002108 llvm::Constant *getUnwindResumeFn();
Douglas Gregor51150ab2010-05-16 01:24:12 +00002109 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCallb609d3f2010-07-07 06:56:46 +00002110 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
2111 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00002112
Anders Carlsson52d78a52009-09-27 18:58:34 +00002113 void EmitCXXTryStmt(const CXXTryStmt &S);
Richard Smith02e85f32011-04-14 22:09:26 +00002114 void EmitCXXForRangeStmt(const CXXForRangeStmt &S);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002115
Chris Lattner208ae962007-05-30 17:57:17 +00002116 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00002117 // LValue Expression Emission
2118 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00002119
Daniel Dunbarc79407f2009-02-05 07:09:07 +00002120 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
2121 RValue GetUndefRValue(QualType Ty);
2122
Daniel Dunbarbb197e42009-01-09 16:50:52 +00002123 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
2124 /// and issue an ErrorUnsupported style diagnostic (using the
2125 /// provided Name).
2126 RValue EmitUnsupportedRValue(const Expr *E,
2127 const char *Name);
2128
Mike Stumpfc496822009-02-08 23:14:22 +00002129 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
2130 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00002131 LValue EmitUnsupportedLValue(const Expr *E,
2132 const char *Name);
2133
Chris Lattner8394d792007-06-05 20:53:16 +00002134 /// EmitLValue - Emit code to compute a designator that specifies the location
2135 /// of the expression.
2136 ///
2137 /// This can return one of two things: a simple address or a bitfield
2138 /// reference. In either case, the LLVM Value* in the LValue structure is
2139 /// guaranteed to be an LLVM pointer type.
2140 ///
2141 /// If this returns a bitfield reference, nothing about the pointee type of
2142 /// the LLVM value is known: For example, it may not be a pointer to an
2143 /// integer.
2144 ///
2145 /// If this returns a normal address, and if the lvalue's C type is fixed
2146 /// size, this method guarantees that the returned pointer type will point to
2147 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
2148 /// variable length type, this is not possible.
2149 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00002150 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002151
Richard Smith4d1458e2012-09-08 02:08:36 +00002152 /// \brief Same as EmitLValue but additionally we generate checking code to
2153 /// guard against undefined behavior. This is only suitable when we know
2154 /// that the address will be used to access the object.
2155 LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
Mike Stump3f6f9fe2009-12-16 02:57:00 +00002156
John McCall47fb9502013-03-07 21:37:08 +00002157 RValue convertTempToRValue(llvm::Value *addr, QualType type);
2158
John McCalla8ec7eb2013-03-07 21:37:17 +00002159 void EmitAtomicInit(Expr *E, LValue lvalue);
2160
2161 RValue EmitAtomicLoad(LValue lvalue,
2162 AggValueSlot slot = AggValueSlot::ignored());
2163
2164 void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
2165
John McCall3a7f6922010-10-27 20:58:56 +00002166 /// EmitToMemory - Change a scalar value from its value
2167 /// representation to its in-memory representation.
2168 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
2169
2170 /// EmitFromMemory - Change a scalar value from its memory
2171 /// representation to its value representation.
2172 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
2173
Daniel Dunbar1d425462009-02-10 00:57:50 +00002174 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2175 /// care to appropriately convert from the memory representation to
2176 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002177 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00002178 unsigned Alignment, QualType Ty,
2179 llvm::MDNode *TBAAInfo = 0);
John McCall55e1fbc2011-06-25 02:11:03 +00002180
2181 /// EmitLoadOfScalar - Load a scalar value from an address, taking
2182 /// care to appropriately convert from the memory representation to
2183 /// the LLVM value representation. The l-value must be a simple
2184 /// l-value.
John McCall1553b192011-06-16 04:16:24 +00002185 llvm::Value *EmitLoadOfScalar(LValue lvalue);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002186
2187 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2188 /// care to appropriately convert from the memory representation to
2189 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002190 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00002191 bool Volatile, unsigned Alignment, QualType Ty,
David Chisnallfa35df62012-01-16 17:27:18 +00002192 llvm::MDNode *TBAAInfo = 0, bool isInit=false);
John McCall55e1fbc2011-06-25 02:11:03 +00002193
2194 /// EmitStoreOfScalar - Store a scalar value to an address, taking
2195 /// care to appropriately convert from the memory representation to
2196 /// the LLVM value representation. The l-value must be a simple
David Chisnallfa35df62012-01-16 17:27:18 +00002197 /// l-value. The isInit flag indicates whether this is an initialization.
2198 /// If so, atomic qualifiers are ignored and the store is always non-atomic.
2199 void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
Daniel Dunbar1d425462009-02-10 00:57:50 +00002200
Chris Lattner8394d792007-06-05 20:53:16 +00002201 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
2202 /// this method emits the address of the lvalue, then loads the result as an
2203 /// rvalue, returning the rvalue.
John McCall55e1fbc2011-06-25 02:11:03 +00002204 RValue EmitLoadOfLValue(LValue V);
2205 RValue EmitLoadOfExtVectorElementLValue(LValue V);
2206 RValue EmitLoadOfBitfieldLValue(LValue LV);
Mike Stumpfc496822009-02-08 23:14:22 +00002207
Chris Lattner8394d792007-06-05 20:53:16 +00002208 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
2209 /// lvalue, where both are guaranteed to the have the same type, and that type
2210 /// is 'Ty'.
David Chisnallfa35df62012-01-16 17:27:18 +00002211 void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit=false);
John McCall55e1fbc2011-06-25 02:11:03 +00002212 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002213
Mike Stumpfc496822009-02-08 23:14:22 +00002214 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
2215 /// EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002216 ///
Mike Stumpfc496822009-02-08 23:14:22 +00002217 /// \param Result [out] - If non-null, this will be set to a Value* for the
2218 /// bit-field contents after the store, appropriate for use as the result of
2219 /// an assignment to the bit-field.
John McCall55e1fbc2011-06-25 02:11:03 +00002220 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00002221 llvm::Value **Result=0);
Mike Stumpfc496822009-02-08 23:14:22 +00002222
John McCall4f29b492010-11-16 23:07:28 +00002223 /// Emit an l-value for an assignment (simple or compound) of complex type.
2224 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002225 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall4f29b492010-11-16 23:07:28 +00002226
Chris Lattner57540c52011-04-15 05:22:18 +00002227 // Note: only available for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00002228 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00002229 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002230 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00002231 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00002232 // Note: only available for agg return types
2233 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00002234 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00002235 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00002236 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00002237 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002238 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Richard Smith539e4a72013-02-23 02:53:19 +00002239 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
2240 bool Accessed = false);
Nate Begemance4d7fc2008-04-18 23:10:10 +00002241 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00002242 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00002243 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00002244 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Richard Smithbb653bd2012-05-14 21:57:21 +00002245 LValue EmitInitListLValue(const InitListExpr *E);
John McCallc07a0c72011-02-17 10:25:35 +00002246 LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00002247 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregor747eb782010-07-08 06:14:04 +00002248 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Douglas Gregorfe314812011-06-21 17:03:29 +00002249 LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
John McCall1bf58462011-02-16 08:02:54 +00002250 LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002251
Eli Friedman7f1ff602012-04-16 03:54:45 +00002252 RValue EmitRValueForField(LValue LV, const FieldDecl *FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +00002253
John McCall71335052012-03-10 03:05:10 +00002254 class ConstantEmission {
2255 llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
2256 ConstantEmission(llvm::Constant *C, bool isReference)
2257 : ValueAndIsReference(C, isReference) {}
2258 public:
2259 ConstantEmission() {}
2260 static ConstantEmission forReference(llvm::Constant *C) {
2261 return ConstantEmission(C, true);
2262 }
2263 static ConstantEmission forValue(llvm::Constant *C) {
2264 return ConstantEmission(C, false);
2265 }
2266
2267 operator bool() const { return ValueAndIsReference.getOpaqueValue() != 0; }
2268
2269 bool isReference() const { return ValueAndIsReference.getInt(); }
2270 LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
2271 assert(isReference());
2272 return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
2273 refExpr->getType());
2274 }
2275
2276 llvm::Constant *getValue() const {
2277 assert(!isReference());
2278 return ValueAndIsReference.getPointer();
2279 }
2280 };
2281
John McCall113bee02012-03-10 09:33:50 +00002282 ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
John McCall71335052012-03-10 03:05:10 +00002283
John McCallfe96e0b2011-11-06 09:01:30 +00002284 RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
2285 AggValueSlot slot = AggValueSlot::ignored());
2286 LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
2287
Daniel Dunbar722f4242009-04-22 05:08:15 +00002288 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002289 const ObjCIvarDecl *Ivar);
Eli Friedman7f1ff602012-04-16 03:54:45 +00002290 LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002291
Anders Carlssondb78f0a2010-01-29 05:24:29 +00002292 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
2293 /// if the Field is a reference, this will return the address of the reference
2294 /// and not the address of the value stored in the reference.
Eli Friedman7f1ff602012-04-16 03:54:45 +00002295 LValue EmitLValueForFieldInitialization(LValue Base,
2296 const FieldDecl* Field);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002297
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00002298 LValue EmitLValueForIvar(QualType ObjectTy,
2299 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002300 unsigned CVRQualifiers);
2301
Anders Carlsson3be22e22009-05-30 23:23:33 +00002302 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00002303 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
Eli Friedman5bc17122012-02-08 05:34:55 +00002304 LValue EmitLambdaLValue(const LambdaExpr *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002305 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Nico Webercf4ff5862012-10-11 10:13:44 +00002306 LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002307
Daniel Dunbarc8317a42008-08-23 10:51:21 +00002308 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00002309 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00002310 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00002311 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00002312 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCalla2fabff2010-10-09 01:34:31 +00002313 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
John McCallc07a0c72011-02-17 10:25:35 +00002314
Chris Lattnerd7f58862007-06-02 05:24:33 +00002315 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00002316 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00002317 //===--------------------------------------------------------------------===//
2318
Mike Stumpfc496822009-02-08 23:14:22 +00002319 /// EmitCall - Generate a call of the given function, expecting the given
2320 /// result type, and using the given argument list which specifies both the
2321 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002322 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00002323 /// \param TargetDecl - If given, the decl of the function in a direct call;
2324 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00002325 RValue EmitCall(const CGFunctionInfo &FnInfo,
2326 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00002327 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00002328 const CallArgList &Args,
David Chisnall9eecafa2010-05-01 11:15:56 +00002329 const Decl *TargetDecl = 0,
David Chisnallff5f88c2010-05-02 13:41:58 +00002330 llvm::Instruction **callOrInvoke = 0);
Mike Stump11289f42009-09-09 15:08:12 +00002331
Anders Carlsson0435ed52009-12-24 19:08:58 +00002332 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlsson17490832009-12-24 20:40:36 +00002333 ReturnValueSlot ReturnValue,
Anders Carlsson3a9463b2009-05-27 01:22:39 +00002334 CallExpr::const_arg_iterator ArgBeg,
2335 CallExpr::const_arg_iterator ArgEnd,
2336 const Decl *TargetDecl = 0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002337 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00002338 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00002339
John McCall882987f2013-02-28 19:01:20 +00002340 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2341 const Twine &name = "");
2342 llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
2343 ArrayRef<llvm::Value*> args,
2344 const Twine &name = "");
2345 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2346 const Twine &name = "");
2347 llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
2348 ArrayRef<llvm::Value*> args,
2349 const Twine &name = "");
2350
John McCallbd309292010-07-06 01:34:17 +00002351 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00002352 ArrayRef<llvm::Value *> Args,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002353 const Twine &Name = "");
Jay Foad5bd375a2011-07-15 08:37:34 +00002354 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner62ff6e82011-07-20 07:06:53 +00002355 const Twine &Name = "");
John McCall882987f2013-02-28 19:01:20 +00002356 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2357 ArrayRef<llvm::Value*> args,
2358 const Twine &name = "");
2359 llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
2360 const Twine &name = "");
2361 void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
2362 ArrayRef<llvm::Value*> args);
John McCallbd309292010-07-06 01:34:17 +00002363
Anders Carlssone828c362009-11-13 04:45:41 +00002364 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Chris Lattner2192fe52011-07-18 04:24:23 +00002365 llvm::Type *Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002366 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Chris Lattner2192fe52011-07-18 04:24:23 +00002367 llvm::Value *This, llvm::Type *Ty);
Fariborz Jahanian47609b02011-01-20 17:19:02 +00002368 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
2369 NestedNameSpecifier *Qual,
Chris Lattner2192fe52011-07-18 04:24:23 +00002370 llvm::Type *Ty);
Fariborz Jahanian265c3252011-02-01 23:22:34 +00002371
2372 llvm::Value *BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
2373 CXXDtorType Type,
Fariborz Jahanian7f6f81b2011-02-03 19:27:17 +00002374 const CXXRecordDecl *RD);
Anders Carlssone828c362009-11-13 04:45:41 +00002375
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002376 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
Richard Smithe30752c2012-10-09 19:52:38 +00002377 SourceLocation CallLoc,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002378 llvm::Value *Callee,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002379 ReturnValueSlot ReturnValue,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002380 llvm::Value *This,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002381 llvm::Value *ImplicitParam,
2382 QualType ImplicitParamTy,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00002383 CallExpr::const_arg_iterator ArgBeg,
2384 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssonbfb36712009-12-24 21:13:40 +00002385 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
2386 ReturnValueSlot ReturnValue);
2387 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
2388 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00002389
Anders Carlssonc36783e2011-05-08 20:32:23 +00002390 llvm::Value *EmitCXXOperatorMemberCallee(const CXXOperatorCallExpr *E,
2391 const CXXMethodDecl *MD,
2392 llvm::Value *This);
Anders Carlsson4034a952009-05-27 04:18:27 +00002393 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00002394 const CXXMethodDecl *MD,
2395 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00002396
Peter Collingbournefe883422011-10-06 18:29:37 +00002397 RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
2398 ReturnValueSlot ReturnValue);
2399
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002400
Mike Stump11289f42009-09-09 15:08:12 +00002401 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbar8eb018a2009-02-16 22:43:43 +00002402 unsigned BuiltinID, const CallExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00002403
Anders Carlssonbfb36712009-12-24 21:13:40 +00002404 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00002405
Mike Stumpfc496822009-02-08 23:14:22 +00002406 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
2407 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00002408 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2409
Chris Lattner5cc15e02010-03-03 19:03:45 +00002410 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002411 llvm::Value *EmitNeonCall(llvm::Function *F,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002412 SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00002413 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002414 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00002415 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Chris Lattner2192fe52011-07-18 04:24:23 +00002416 llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00002417 bool negateForRightShift);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002418
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002419 llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00002420 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
2421 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00002422
Daniel Dunbar66912a12008-08-20 00:28:19 +00002423 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00002424 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Patrick Beard0caa3942012-04-19 00:25:12 +00002425 llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
Ted Kremeneke65b0862012-03-06 20:05:56 +00002426 llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
2427 llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
2428 llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
2429 const ObjCMethodDecl *MethodWithObjects);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002430 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00002431 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
2432 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00002433
John McCall31168b02011-06-15 23:02:42 +00002434 /// Retrieves the default cleanup kind for an ARC cleanup.
2435 /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
2436 CleanupKind getARCCleanupKind() {
2437 return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
2438 ? NormalAndEHCleanup : NormalCleanup;
2439 }
2440
2441 // ARC primitives.
2442 void EmitARCInitWeak(llvm::Value *value, llvm::Value *addr);
2443 void EmitARCDestroyWeak(llvm::Value *addr);
2444 llvm::Value *EmitARCLoadWeak(llvm::Value *addr);
2445 llvm::Value *EmitARCLoadWeakRetained(llvm::Value *addr);
2446 llvm::Value *EmitARCStoreWeak(llvm::Value *value, llvm::Value *addr,
2447 bool ignored);
2448 void EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src);
2449 void EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src);
2450 llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
2451 llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
John McCall55e1fbc2011-06-25 02:11:03 +00002452 llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002453 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002454 llvm::Value *EmitARCStoreStrongCall(llvm::Value *addr, llvm::Value *value,
John McCallcdda29c2013-03-13 03:10:54 +00002455 bool resultIgnored);
John McCall31168b02011-06-15 23:02:42 +00002456 llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
2457 llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
John McCallff613032011-10-04 06:23:45 +00002458 llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
John McCallcdda29c2013-03-13 03:10:54 +00002459 void EmitARCDestroyStrong(llvm::Value *addr, ARCPreciseLifetime_t precise);
2460 void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
John McCall31168b02011-06-15 23:02:42 +00002461 llvm::Value *EmitARCAutorelease(llvm::Value *value);
2462 llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
2463 llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
2464 llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
2465
2466 std::pair<LValue,llvm::Value*>
2467 EmitARCStoreAutoreleasing(const BinaryOperator *e);
2468 std::pair<LValue,llvm::Value*>
2469 EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
2470
John McCall248512a2011-10-01 10:32:24 +00002471 llvm::Value *EmitObjCThrowOperand(const Expr *expr);
2472
John McCall31168b02011-06-15 23:02:42 +00002473 llvm::Value *EmitObjCProduceObject(QualType T, llvm::Value *Ptr);
2474 llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
2475 llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
2476
John McCallff613032011-10-04 06:23:45 +00002477 llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
John McCall31168b02011-06-15 23:02:42 +00002478 llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
2479 llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
2480
John McCalleff18842013-03-23 02:35:54 +00002481 void EmitARCIntrinsicUse(llvm::ArrayRef<llvm::Value*> values);
2482
John McCall82fe67b2011-07-09 01:37:26 +00002483 static Destroyer destroyARCStrongImprecise;
2484 static Destroyer destroyARCStrongPrecise;
2485 static Destroyer destroyARCWeak;
2486
John McCall31168b02011-06-15 23:02:42 +00002487 void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
2488 llvm::Value *EmitObjCAutoreleasePoolPush();
2489 llvm::Value *EmitObjCMRRAutoreleasePoolPush();
2490 void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
2491 void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
2492
Anders Carlsson6f5a0152009-05-20 00:24:07 +00002493 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
2494 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002495 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson04775f82010-06-26 16:35:32 +00002496 const NamedDecl *InitializedDecl);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00002497
Chris Lattner6278e6a2007-08-11 00:04:45 +00002498 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002499 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00002500 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00002501
2502 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00002503
2504 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
2505 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00002506 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002507
Chris Lattner3474c202007-08-26 06:48:56 +00002508 /// EmitScalarConversion - Emit a conversion from the specified type to the
2509 /// specified destination type, both of which are LLVM scalar types.
2510 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
2511 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002512
Chris Lattner42e6b812007-08-26 16:34:22 +00002513 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00002514 /// complex type to the specified destination type, where the destination type
2515 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00002516 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
2517 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00002518
2519
John McCall7a626f62010-09-15 10:14:12 +00002520 /// EmitAggExpr - Emit the computation of the specified expression
2521 /// of aggregate type. The result is computed into the given slot,
2522 /// which may be null to indicate that the value is not needed.
John McCall4e8ca4f2012-07-02 23:58:38 +00002523 void EmitAggExpr(const Expr *E, AggValueSlot AS);
Mike Stumpfc496822009-02-08 23:14:22 +00002524
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00002525 /// EmitAggExprToLValue - Emit the computation of the specified expression of
2526 /// aggregate type into a temporary LValue.
2527 LValue EmitAggExprToLValue(const Expr *E);
2528
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002529 /// EmitGCMemmoveCollectable - Emit special API for structs with object
2530 /// pointers.
2531 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00002532 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002533
John McCall1bd25562011-06-24 23:21:27 +00002534 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2535 /// make sure it survives garbage collection until this point.
2536 void EmitExtendGCLifetime(llvm::Value *object);
2537
Chris Lattnercbfc73b2007-08-21 05:54:00 +00002538 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00002539 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00002540 ComplexPairTy EmitComplexExpr(const Expr *E,
2541 bool IgnoreReal = false,
2542 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002543
John McCall47fb9502013-03-07 21:37:08 +00002544 /// EmitComplexExprIntoLValue - Emit the given expression of complex
2545 /// type and place its result into the specified l-value.
2546 void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002547
John McCall47fb9502013-03-07 21:37:08 +00002548 /// EmitStoreOfComplex - Store a complex number into the specified l-value.
2549 void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
2550
2551 /// EmitLoadOfComplex - Load a complex number from the specified l-value.
2552 ComplexPairTy EmitLoadOfComplex(LValue src);
Chris Lattnerb781dc792008-05-08 05:58:21 +00002553
John McCall1c9c3fd2010-10-15 04:57:14 +00002554 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
2555 /// a static local variable.
Chandler Carruth84537952012-03-30 19:44:53 +00002556 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
2557 const char *Separator,
2558 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002559
Chandler Carruth84537952012-03-30 19:44:53 +00002560 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
2561 /// global variable that has already been created for it. If the initializer
2562 /// has a different type than GV does, this may free GV and return a different
2563 /// one. Otherwise it just returns GV.
2564 llvm::GlobalVariable *
2565 AddInitializerToStaticVarDecl(const VarDecl &D,
2566 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002567
Daniel Dunbar22a87f92009-02-25 19:24:29 +00002568
Anders Carlssonf40886a2009-08-08 21:45:14 +00002569 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
2570 /// variable with global storage.
Richard Smith6331c402012-02-13 22:16:19 +00002571 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
2572 bool PerformInit);
Anders Carlssonf40886a2009-08-08 21:45:14 +00002573
John McCallc84ed6a2012-05-01 06:13:13 +00002574 /// Call atexit() with a function that passes the given argument to
2575 /// the given function.
2576 void registerGlobalDtorWithAtExit(llvm::Constant *fn, llvm::Constant *addr);
Mike Stump11289f42009-09-09 15:08:12 +00002577
John McCallcdf7ef52010-11-06 09:44:32 +00002578 /// Emit code in this function to perform a guarded variable
2579 /// initialization. Guarded initializations are used when it's not
2580 /// possible to prove that an initialization will be done exactly
2581 /// once, e.g. with a static local variable or a static data member
2582 /// of a class template.
Chandler Carruth84537952012-03-30 19:44:53 +00002583 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
Richard Smith6331c402012-02-13 22:16:19 +00002584 bool PerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002585
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002586 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
2587 /// variables.
2588 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
2589 llvm::Constant **Decls,
2590 unsigned NumDecls);
2591
John McCallee08c532012-04-06 18:21:03 +00002592 /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002593 /// variables.
John McCallee08c532012-04-06 18:21:03 +00002594 void GenerateCXXGlobalDtorsFunc(llvm::Function *Fn,
2595 const std::vector<std::pair<llvm::WeakVH,
2596 llvm::Constant*> > &DtorsAndObjects);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002597
John McCalla738c252011-03-09 04:27:21 +00002598 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
2599 const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00002600 llvm::GlobalVariable *Addr,
2601 bool PerformInit);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00002602
John McCall7a626f62010-09-15 10:14:12 +00002603 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00002604
2605 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00002606 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00002607
John McCall08ef4662011-11-10 08:15:53 +00002608 void enterFullExpression(const ExprWithCleanups *E) {
2609 if (E->getNumObjects() == 0) return;
2610 enterNonTrivialFullExpression(E);
2611 }
2612 void enterNonTrivialFullExpression(const ExprWithCleanups *E);
Mike Stump11289f42009-09-09 15:08:12 +00002613
Anders Carlsson4b08db72009-10-30 01:42:31 +00002614 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00002615
Eli Friedmanc370a7e2012-02-09 03:32:31 +00002616 void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
2617
Eli Friedmandf14b3a2011-10-11 02:20:01 +00002618 RValue EmitAtomicExpr(AtomicExpr *E, llvm::Value *Dest = 0);
2619
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002620 //===--------------------------------------------------------------------===//
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002621 // Annotations Emission
2622 //===--------------------------------------------------------------------===//
2623
2624 /// Emit an annotation call (intrinsic or builtin).
2625 llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
2626 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002627 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002628 SourceLocation Location);
2629
2630 /// Emit local annotations for the local variable V, declared by D.
2631 void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
2632
2633 /// Emit field annotations for the given field & value. Returns the
2634 /// annotation result.
2635 llvm::Value *EmitFieldAnnotations(const FieldDecl *D, llvm::Value *V);
2636
2637 //===--------------------------------------------------------------------===//
Daniel Dunbar88402ce2008-08-04 16:51:22 +00002638 // Internal Helpers
2639 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00002640
Chris Lattner5b1964b2008-11-11 07:41:27 +00002641 /// ContainsLabel - Return true if the statement contains a label in it. If
2642 /// this statement is not executed normally, it not containing a label means
2643 /// that we can just remove the code.
2644 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00002645
Chris Lattner29911cc2011-02-28 00:18:40 +00002646 /// containsBreak - Return true if the statement contains a break out of it.
2647 /// If the statement (recursively) contains a switch or loop with a break
2648 /// inside of it, this is fine.
2649 static bool containsBreak(const Stmt *S);
2650
Daniel Dunbar682712c2008-11-12 10:12:14 +00002651 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner41c6ab52011-02-27 23:02:32 +00002652 /// to a constant, or if it does but contains a label, return false. If it
2653 /// constant folds return true and set the boolean result in Result.
2654 bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result);
Mike Stumpfc496822009-02-08 23:14:22 +00002655
Chris Lattner29911cc2011-02-28 00:18:40 +00002656 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
2657 /// to a constant, or if it does but contains a label, return false. If it
2658 /// constant folds return true and set the folded value.
Richard Trieuc320c742012-07-23 20:21:35 +00002659 bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result);
Chris Lattner29911cc2011-02-28 00:18:40 +00002660
Chris Lattnercd439292008-11-12 08:04:58 +00002661 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
2662 /// if statement) to the specified blocks. Based on the condition, this might
2663 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00002664 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar682712c2008-11-12 10:12:14 +00002665 llvm::BasicBlock *FalseBlock);
Mike Stumpba6a0c42009-12-14 21:58:14 +00002666
Richard Smithe30752c2012-10-09 19:52:38 +00002667 /// \brief Emit a description of a type in a format suitable for passing to
2668 /// a runtime sanitizer handler.
2669 llvm::Constant *EmitCheckTypeDescriptor(QualType T);
2670
2671 /// \brief Convert a value into a format suitable for passing to a runtime
2672 /// sanitizer handler.
2673 llvm::Value *EmitCheckValue(llvm::Value *V);
2674
2675 /// \brief Emit a description of a source location in a format suitable for
2676 /// passing to a runtime sanitizer handler.
2677 llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
2678
Will Dietz88e02332012-12-02 19:50:33 +00002679 /// \brief Specify under what conditions this check can be recovered
2680 enum CheckRecoverableKind {
2681 /// Always terminate program execution if this check fails
2682 CRK_Unrecoverable,
2683 /// Check supports recovering, allows user to specify which
2684 CRK_Recoverable,
2685 /// Runtime conditionally aborts, always need to support recovery.
2686 CRK_AlwaysRecoverable
2687 };
2688
Richard Smithde670682012-11-01 22:15:34 +00002689 /// \brief Create a basic block that will call a handler function in a
2690 /// sanitizer runtime with the provided arguments, and create a conditional
2691 /// branch to it.
Richard Smithe30752c2012-10-09 19:52:38 +00002692 void EmitCheck(llvm::Value *Checked, StringRef CheckName,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002693 ArrayRef<llvm::Constant *> StaticArgs,
2694 ArrayRef<llvm::Value *> DynamicArgs,
Will Dietz88e02332012-12-02 19:50:33 +00002695 CheckRecoverableKind Recoverable);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002696
Richard Smithde670682012-11-01 22:15:34 +00002697 /// \brief Create a basic block that will call the trap intrinsic, and emit a
2698 /// conditional branch to it, for the -ftrapv checks.
Chad Rosierae229d52013-01-29 23:31:22 +00002699 void EmitTrapCheck(llvm::Value *Checked);
Richard Smithde670682012-11-01 22:15:34 +00002700
Anders Carlsson093bdff2010-03-30 03:27:09 +00002701 /// EmitCallArg - Emit a single call argument.
John McCall32ea9692011-03-11 20:59:21 +00002702 void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
Anders Carlsson093bdff2010-03-30 03:27:09 +00002703
John McCall23f66262010-05-26 22:34:26 +00002704 /// EmitDelegateCallArg - We are performing a delegate call; that
2705 /// is, the current function is delegating to another one. Produce
2706 /// a r-value suitable for passing the given parameter.
John McCall32ea9692011-03-11 20:59:21 +00002707 void EmitDelegateCallArg(CallArgList &args, const VarDecl *param);
John McCall23f66262010-05-26 22:34:26 +00002708
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002709 /// SetFPAccuracy - Set the minimum required accuracy of the given floating
2710 /// point operation, expressed as the maximum relative error in ulp.
Duncan Sandse81111c2012-04-10 08:23:07 +00002711 void SetFPAccuracy(llvm::Value *Val, float Accuracy);
Peter Collingbourne95fd2ca2011-10-27 19:19:51 +00002712
Chris Lattnercd439292008-11-12 08:04:58 +00002713private:
Rafael Espindola5c0034a2012-03-24 16:50:34 +00002714 llvm::MDNode *getRangeForLoadFromType(QualType Ty);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00002715 void EmitReturnOfRValue(RValue RV, QualType Ty);
2716
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002717 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
2718 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
2719 ///
2720 /// \param AI - The first function argument of the expansion.
2721 /// \return The argument following the last expanded function
2722 /// argument.
Mike Stumpfc496822009-02-08 23:14:22 +00002723 llvm::Function::arg_iterator
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00002724 ExpandTypeFromArgs(QualType Ty, LValue Dst,
2725 llvm::Function::arg_iterator AI);
2726
Mike Stumpfc496822009-02-08 23:14:22 +00002727 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
2728 /// Ty, into individual arguments on the provided vector \arg Args. See
2729 /// ABIArgInfo::Expand.
2730 void ExpandTypeToArgs(QualType Ty, RValue Src,
Chris Lattner01cf8db2011-07-20 06:58:45 +00002731 SmallVector<llvm::Value*, 16> &Args,
Chris Lattnerd59d8672011-07-12 06:29:11 +00002732 llvm::FunctionType *IRFuncTy);
Anders Carlsson03aaf112009-01-11 19:40:10 +00002733
Chad Rosier59df25b2012-08-23 20:00:18 +00002734 llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00002735 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00002736
Chad Rosier59df25b2012-08-23 20:00:18 +00002737 llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
Eli Friedmaneca55af2010-07-16 00:55:21 +00002738 LValue InputValue, QualType InputType,
2739 std::string &ConstraintStr);
2740
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002741 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump11289f42009-09-09 15:08:12 +00002742 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlsson603d6af2009-04-18 20:20:22 +00002743 /// argument types of the function being called.
2744 template<typename T>
2745 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002746 CallExpr::const_arg_iterator ArgBeg,
Anders Carlsson603d6af2009-04-18 20:20:22 +00002747 CallExpr::const_arg_iterator ArgEnd) {
2748 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00002749
Anders Carlsson603d6af2009-04-18 20:20:22 +00002750 // First, use the argument types that the type info knows about
2751 if (CallArgTypeInfo) {
2752 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
2753 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman794290c2009-11-18 03:42:04 +00002754 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlsson603d6af2009-04-18 20:20:22 +00002755 QualType ArgType = *I;
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002756#ifndef NDEBUG
2757 QualType ActualArgType = Arg->getType();
2758 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002759 QualType ActualBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002760 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002761 QualType ArgBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002762 ArgType->getAs<PointerType>()->getPointeeType();
2763 if (ArgBaseType->isVariableArrayType()) {
2764 if (const VariableArrayType *VAT =
2765 getContext().getAsVariableArrayType(ActualBaseType)) {
2766 if (!VAT->getSizeExpr())
2767 ActualArgType = ArgType;
2768 }
2769 }
2770 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00002771 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump11289f42009-09-09 15:08:12 +00002772 getTypePtr() ==
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002773 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlsson603d6af2009-04-18 20:20:22 +00002774 "type mismatch in call argument!");
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00002775#endif
John McCall32ea9692011-03-11 20:59:21 +00002776 EmitCallArg(Args, *Arg, ArgType);
Anders Carlsson603d6af2009-04-18 20:20:22 +00002777 }
Mike Stump11289f42009-09-09 15:08:12 +00002778
2779 // Either we've emitted all the call args, or we have a call to a
Anders Carlsson603d6af2009-04-18 20:20:22 +00002780 // variadic function.
Mike Stump11289f42009-09-09 15:08:12 +00002781 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlsson603d6af2009-04-18 20:20:22 +00002782 "Extra arguments in non-variadic function!");
Mike Stump11289f42009-09-09 15:08:12 +00002783
Anders Carlsson603d6af2009-04-18 20:20:22 +00002784 }
Mike Stump11289f42009-09-09 15:08:12 +00002785
Anders Carlsson603d6af2009-04-18 20:20:22 +00002786 // If we still have any arguments, emit them using the type of the argument.
John McCall32ea9692011-03-11 20:59:21 +00002787 for (; Arg != ArgEnd; ++Arg)
2788 EmitCallArg(Args, *Arg, Arg->getType());
Anders Carlsson603d6af2009-04-18 20:20:22 +00002789 }
John McCalld4f4b7f2010-03-03 04:15:11 +00002790
2791 const TargetCodeGenInfo &getTargetHooks() const {
2792 return CGM.getTargetCodeGenInfo();
2793 }
John McCall09ae0322010-07-06 23:57:41 +00002794
2795 void EmitDeclMetadata();
John McCallf9b056b2011-03-31 08:03:29 +00002796
2797 CodeGenModule::ByrefHelpers *
Chris Lattner2192fe52011-07-18 04:24:23 +00002798 buildByrefHelpers(llvm::StructType &byrefType,
John McCallf9b056b2011-03-31 08:03:29 +00002799 const AutoVarEmission &emission);
Dan Gohman515a60d2012-02-16 00:57:37 +00002800
2801 void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
Jay Foadb0f33442012-03-02 18:34:30 +00002802
Eli Friedmana5dd5682012-08-23 03:10:17 +00002803 /// GetPointeeAlignment - Given an expression with a pointer type, emit the
2804 /// value and compute our best estimate of the alignment of the pointee.
2805 std::pair<llvm::Value*, unsigned> EmitPointerWithAlignment(const Expr *Addr);
Chris Lattnerbed31442007-05-28 01:07:47 +00002806};
Mike Stump11289f42009-09-09 15:08:12 +00002807
John McCallce1de612011-01-26 04:00:11 +00002808/// Helper class with most of the code for saving a value for a
2809/// conditional expression cleanup.
John McCallcb5f77f2011-01-28 10:53:53 +00002810struct DominatingLLVMValue {
John McCallce1de612011-01-26 04:00:11 +00002811 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
2812
2813 /// Answer whether the given value needs extra work to be saved.
2814 static bool needsSaving(llvm::Value *value) {
2815 // If it's not an instruction, we don't need to save.
2816 if (!isa<llvm::Instruction>(value)) return false;
2817
2818 // If it's an instruction in the entry block, we don't need to save.
2819 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
2820 return (block != &block->getParent()->getEntryBlock());
2821 }
2822
2823 /// Try to save the given value.
2824 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
2825 if (!needsSaving(value)) return saved_type(value, false);
2826
2827 // Otherwise we need an alloca.
2828 llvm::Value *alloca =
2829 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
2830 CGF.Builder.CreateStore(value, alloca);
2831
2832 return saved_type(alloca, true);
2833 }
2834
2835 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
2836 if (!value.getInt()) return value.getPointer();
2837 return CGF.Builder.CreateLoad(value.getPointer());
2838 }
2839};
2840
John McCallcb5f77f2011-01-28 10:53:53 +00002841/// A partial specialization of DominatingValue for llvm::Values that
2842/// might be llvm::Instructions.
2843template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
2844 typedef T *type;
John McCallce1de612011-01-26 04:00:11 +00002845 static type restore(CodeGenFunction &CGF, saved_type value) {
John McCallcb5f77f2011-01-28 10:53:53 +00002846 return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
2847 }
2848};
2849
2850/// A specialization of DominatingValue for RValue.
2851template <> struct DominatingValue<RValue> {
2852 typedef RValue type;
2853 class saved_type {
2854 enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
2855 AggregateAddress, ComplexAddress };
2856
2857 llvm::Value *Value;
2858 Kind K;
2859 saved_type(llvm::Value *v, Kind k) : Value(v), K(k) {}
2860
2861 public:
2862 static bool needsSaving(RValue value);
2863 static saved_type save(CodeGenFunction &CGF, RValue value);
2864 RValue restore(CodeGenFunction &CGF);
2865
2866 // implementations in CGExprCXX.cpp
2867 };
2868
2869 static bool needsSaving(type value) {
2870 return saved_type::needsSaving(value);
2871 }
2872 static saved_type save(CodeGenFunction &CGF, type value) {
2873 return saved_type::save(CGF, value);
2874 }
2875 static type restore(CodeGenFunction &CGF, saved_type value) {
2876 return value.restore(CGF);
John McCallce1de612011-01-26 04:00:11 +00002877 }
2878};
2879
Chris Lattnerbed31442007-05-28 01:07:47 +00002880} // end namespace CodeGen
2881} // end namespace clang
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00002882
Chris Lattnerbed31442007-05-28 01:07:47 +00002883#endif